Code

State that stderr should not have any output
authorTon Voon <tonvoon@users.sourceforge.net>
Mon, 24 Sep 2007 18:51:07 +0000 (18:51 +0000)
committerTon Voon <tonvoon@users.sourceforge.net>
Mon, 24 Sep 2007 18:51:07 +0000 (18:51 +0000)
git-svn-id: https://nagiosplug.svn.sourceforge.net/svnroot/nagiosplug/nagiosplug/trunk@1796 f882894a-f735-0410-b71e-b25c423dba1c

doc/developer-guidelines.sgml

index 7bfcc732ae175f846d238254d26e1e22b6b3b946..1ae419a21b2a714346ed94f1670c54bafabd546d 100644 (file)
                the entire output to appear in a pager message, which will get chopped
                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>
                <para>Nagios will only grab the first line of text from STDOUT
                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>
                <literallayout>
 
                <section><title>Screen Output</title>
                <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>
+
                <para>Code and output should try to respect the 80x25 size of a
                crt (remember when fixing stuff in the server room!)</para>
                </section>