Code

Fixed --help output (Ask Bjoern Hansen - #1714823)
[nagiosplug.git] / plugins / utils.h
index 282f299eb3daa1ee716cf81776efe3f639fec75d..f15a7b161de69541a59629198f622fa30e89d30e 100644 (file)
@@ -1,22 +1,28 @@
-/* header file for nagios plugins utils.c */
+#ifndef NP_UTILS_H
+#define NP_UTILS_H
+/* Header file for nagios plugins utils.c */
 
-/* this file should be included in all plugins */
+/* This file should be included in all plugins */
 
-/* The purpose of this package is to provide safer alternantives to C
+/* The purpose of this package is to provide safer alternatives to C
 functions that might otherwise be vulnerable to hacking. This
 currently includes a standard suite of validation routines to be sure
 that an string argument acually converts to its intended type and a
 suite of string handling routine that do their own memory management
 in order to resist overflow attacks. In addition, a few functions are
-provided to standardize version and error reporting accross the entire
+provided to standardize version and error reporting across the entire
 suite of plugins. */
 
+/* now some functions etc are being defined in ../lib/utils_base.c */
+#include "utils_base.h"
+
 /* Standardize version information, termination */
 
+/* $Id$ */
+
 void support (void);
-char *clean_revstring (const char *revstring);
+char *clean_revstring (const char *);
 void print_revision (const char *, const char *);
-void die (int result, const char *fmt, ...) __attribute__((noreturn,format(printf, 2, 3)));
 
 /* Handle timeouts */
 
@@ -46,7 +52,7 @@ int is_percentage (char *);
 
 int is_option (char *);
 
-/* generalized timer that will do milliseconds if available */
+/* Generalized timer that will do milliseconds if available */
 #ifndef HAVE_STRUCT_TIMEVAL
 struct timeval {
        long tv_sec;        /* seconds */
@@ -55,7 +61,7 @@ struct timeval {
 #endif
 
 #ifndef HAVE_GETTIMEOFDAY
-int gettimeofday(struct timeval *tv, struct timezone *tz);
+int gettimeofday(struct timeval *, struct timezone *);
 #endif
 
 double delta_time (struct timeval tv);
@@ -63,33 +69,49 @@ long deltime (struct timeval tv);
 
 /* Handle strings safely */
 
-void strip (char *buffer);
-char *strscpy (char *dest, const char *src);
-char *strnl (char *str);
-char *strpcpy (char *dest, const char *src, const char *str);
-char *strpcat (char *dest, const char *src, const char *str);
+void strip (char *);
+char *strscpy (char *, const char *);
+char *strnl (char *);
+char *strpcpy (char *, const char *, const char *);
+char *strpcat (char *, const char *, const char *);
 
 int max_state (int a, int b);
 
-void usage (const char *msg) __attribute__((noreturn));
-void usage2(const char *msg, const char *arg) __attribute__((noreturn));
-void usage3(const char *msg, int arg) __attribute__((noreturn));
+void usage (const char *) __attribute__((noreturn));
+void usage2(const char *, const char *) __attribute__((noreturn));
+void usage3(const char *, int) __attribute__((noreturn));
+void usage4(const char *) __attribute__((noreturn));
+void usage5(void) __attribute__((noreturn));
+void usage_va(const char *fmt, ...) __attribute__((noreturn));
 
-const char *state_text (int result);
+const char *state_text (int);
 
 #define max(a,b) (((a)>(b))?(a):(b))
-
-char *perfdata (const char *label,
- long int val,
- const char *uom,
- int warnp,
- long int warn,
- int critp,
- long int crit,
- int minp,
- long int minv,
- int maxp,
- long int maxv);
+#define min(a,b) (((a)<(b))?(a):(b))
+
+char *perfdata (const char *,
+ long int,
+ const char *,
+ int,
+ long int,
+ int,
+ long int,
+ int,
+ long int,
+ int,
+ long int);
+
+char *fperfdata (const char *,
+ double,
+ const char *,
+ int,
+ double,
+ int,
+ double,
+ int,
+ double,
+ int,
+ double);
 
 /* The idea here is that, although not every plugin will use all of these, 
    most will or should.  Therefore, for consistency, these very common 
@@ -120,7 +142,7 @@ char *perfdata (const char *label,
 
 #define UT_HOST_PORT "\
  -H, --hostname=ADDRESS\n\
-    Host name or IP Address\n\
+    Host name, IP Address, or unix socket (must be an absolute path)\n\
  -%c, --port=INTEGER\n\
     Port number (default: %s)\n"
 
@@ -140,6 +162,12 @@ char *perfdata (const char *label,
  -c, --critical=DOUBLE\n\
     Response time to result in critical status (seconds)\n"
 
+#define UT_WARN_CRIT_RANGE "\
+ -w, --warning=RANGE\n\
+    Warning range (format: start:end). Alert if outside this range\n\
+ -c, --critical=RANGE\n\
+    Critical range\n"
+
 #define UT_TIMEOUT "\
  -t, --timeout=INTEGER\n\
     Seconds before connection times out (default: %d)\n"
@@ -149,7 +177,9 @@ Send email to nagios-users@lists.sourceforge.net if you have questions\n\
 regarding use of this software. To submit patches or suggest improvements,\n\
 send email to nagiosplug-devel@lists.sourceforge.net\n"
 
-#define UT_NOWARRANTY "\
+#define UT_NOWARRANTY "\n\
 The nagios plugins come with ABSOLUTELY NO WARRANTY. You may redistribute\n\
 copies of the plugins under the terms of the GNU General Public License.\n\
 For more information about these matters, see the file named COPYING.\n"
+
+#endif /* NP_UTILS_H */