From f94e9dea444879300d2bf0c9f442ef696d530687 Mon Sep 17 00:00:00 2001 From: Johan Thoren Date: Wed, 6 Mar 2024 11:06:24 +0100 Subject: [PATCH] Update README with new help text. --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 36d1ee4..67827e2 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,34 @@ # check_macos_updates -A Nagios compatible plugin to check if macOS system updates are available. - ``` sh +$ check_macos_updates -h +A Nagios compatible plugin that checks for available MacOS updates. + +Thresholds are defined using Nagios range syntax. Examples: ++------------------+-------------------------------------------------+ +| Range definition | Generate an alert if x... | ++------------------+-------------------------------------------------+ +| 10 | < 0 or > 10, (outside the range of {0 .. 10}) | ++------------------+-------------------------------------------------+ +| 10: | < 10, (outside {10 .. ∞}) | ++------------------+-------------------------------------------------+ +| ~:10 | > 10, (outside the range of {-∞ .. 10}) | ++------------------+-------------------------------------------------+ +| 10:20 | < 10 or > 20, (outside the range of {10 .. 20}) | ++------------------+-------------------------------------------------+ +| @10:20 | ≥ 10 and ≤ 20, (inside the range of {10 .. 20}) | ++------------------+-------------------------------------------------+ + + Usage: check_macos_updates [OPTIONS] Options: -f, --force-manual Force manual check with `softwareupdate -l` (slow) + -w, --warning Warning limit for number of updates available [default: 0] + -c, --critical Critical limit for number of updates available -h, --help Print help -V, --version Print version + ``` -Use together with nrpe or similar, preferably with [Opsview](https://www.itrsgroup.com/products/infrastructure-monitoring). +Use together with NRPE or similar, preferably with [Opsview](https://www.itrsgroup.com/products/infrastructure-monitoring).