Selaa lähdekoodia

State that stderr should not have any output

git-svn-id: https://nagiosplug.svn.sourceforge.net/svnroot/nagiosplug/nagiosplug/trunk@1796 f882894a-f735-0410-b71e-b25c423dba1c
Ton Voon 19 vuotta sitten
vanhempi
commit
b99d735795
1 muutettua tiedostoa jossa 7 lisäystä ja 3 poistoa
  1. 7 3
      doc/developer-guidelines.sgml

+ 7 - 3
doc/developer-guidelines.sgml

@@ -87,11 +87,14 @@
 		the entire output to appear in a pager message, which will get chopped
 		the entire output to appear in a pager message, which will get chopped
 		off after a certain length.</para>
 		off after a certain length.</para>
 
 
+		<para>As Nagios does not capture stderr output, you should only output to 
+		STDOUT and not print to STDERR.</para>
+
 		<section><title>Print only one line of text</title>
 		<section><title>Print only one line of text</title>
 		<para>Nagios will only grab the first line of text from STDOUT
 		<para>Nagios will only grab the first line of text from STDOUT
 		when it notifies contacts about potential problems. If you print
 		when it notifies contacts about potential problems. If you print
-		multiple lines, you're out of luck. Remember, keep it short and
-		to the point.</para>
+		multiple lines, you're out of luck (though this will be a feature of 
+		Nagios 3). Remember, keep your output short and to the point.</para>
 
 
 		<para>Output should be in the format:</para>
 		<para>Output should be in the format:</para>
 		<literallayout>
 		<literallayout>
@@ -139,8 +142,9 @@
 
 
 		<section><title>Screen Output</title>
 		<section><title>Screen Output</title>
 		<para>The plug-in should print the diagnostic and just the
 		<para>The plug-in should print the diagnostic and just the
-		synopsis part of the help message.  A well written plugin would
+		usage part of the help message.  A well written plugin would
 		then have --help as a way to get the verbose help.</para>
 		then have --help as a way to get the verbose help.</para>
+
 		<para>Code and output should try to respect the 80x25 size of a
 		<para>Code and output should try to respect the 80x25 size of a
 		crt (remember when fixing stuff in the server room!)</para>
 		crt (remember when fixing stuff in the server room!)</para>
 		</section>
 		</section>