Code

More translations
[nagiosplug.git] / doc / developer-guidelines.sgml
index 44fca2437f9a0e1e1280cc70c6131c80fb25dae1..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>
@@ -731,6 +735,10 @@ setup the tests. Run "make test" to run all the tests.
 
        <para>You should use /* */ for comments and not // as some compilers
        do not handle the latter form.</para>
+
+       <para>You should also avoid using the type "bool" and its values
+       "true" and "false". Instead use the "int" type and the plugins' own
+       "TRUE"/"FALSE" values to keep the code uniformly.</para>
        </section>
 
        <section><title>Crediting sources</title>