diff options
| author |  Marc Huffnagle <marc@huffnagle.net>
| 2012-10-05 11:07:01 -0400 |
|---|---|---|
| committer |  Holger Weiss <holger@zedat.fu-berlin.de>
| 2012-10-09 09:54:03 +0200 |
| commit | 0656a0e284ed94f8c195592d62e9232e3c6d04b7 (patch) | |
| tree | aba8e79528c86d6aa1854ccff1d3211635484843 /plugins-scripts/utils.sh.in | |
| parent | b74543a61253d3cf6784e67d2f021d68eba53639 (diff) | |
| download | monitoring-plugins-0656a0e284ed94f8c195592d62e9232e3c6d04b7.tar.gz | |
Added additional documentation to the check_range function
Diffstat (limited to 'plugins-scripts/utils.sh.in')
| -rw-r--r-- | plugins-scripts/utils.sh.in | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/plugins-scripts/utils.sh.in b/plugins-scripts/utils.sh.in index 5fae6adb..4a07df89 100644 --- a/plugins-scripts/utils.sh.in +++ b/plugins-scripts/utils.sh.in @@ -23,7 +23,16 @@ support() { # # check_range takes a value and a range string, returning successfully if an -# alert should be raised based on the range. +# alert should be raised based on the range. Range values are inclusive. +# Values may be integers or floats. +# +# Example usage: +# +# Generating an exit code of 1: +# check_range 5 2:8 +# +# Generating an exit code of 0: +# check_range 1 2:8 # check_range() { local v range yes no err decimal start end cmp match |