aboutsummaryrefslogtreecommitdiff
path: root/doc/developer-guidelines.sgml
diff options
context:
space:
mode:
authorGravatar Ton Voon <tonvoon@users.sourceforge.net> 2007-09-24 18:51:07 +0000
committerGravatar Ton Voon <tonvoon@users.sourceforge.net> 2007-09-24 18:51:07 +0000
commitb99d73579511e7b85278edb65c540ca13f12aa3c (patch)
treee0ac26b206076963baaf65f80b0927f249cca236 /doc/developer-guidelines.sgml
parent0b579a345617b0376dc3c30c09316246b9b74525 (diff)
downloadmonitoring-plugins-b99d73579511e7b85278edb65c540ca13f12aa3c.tar.gz
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
Diffstat (limited to 'doc/developer-guidelines.sgml')
-rw-r--r--doc/developer-guidelines.sgml10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index 7bfcc732..1ae419a2 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -87,11 +87,14 @@
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>
@@ -139,8 +142,9 @@
<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>