fix README / --help

This commit is contained in:
Patrick Stadler 2015-03-17 20:22:26 +01:00
parent 515c21d3f8
commit 639812ea2b
2 changed files with 11 additions and 8 deletions

View File

@ -5,10 +5,13 @@ metrics.sh is a metrics collection and fowarding daemon implemented in portable
## Usage
```
Usage: ./metrics.sh [-d] [-h] [-v] [-r reporter] [-i interval]
$ ./metrics.sh --help
Usage: ./metrics.sh [-d] [-h] [-v] [-m metrics] [-r reporter] [-i interval]
Options:
-m, --metrics <metrics> comma-separated list of metrics to collect
-r, --reporter <reporter> use specified reporter (default: stdout)
-i, --interval <seconds> collect metrics every n seconds (default: 2)
-v, --verbose enable verbose mode
@ -26,7 +29,7 @@ TODO: /etc/init.d
### Requirements
metrics.sh has been tested on Ubuntu and Mac OS X but is supposed to run on most *NIX-line operating systems. Some of the provided metrics require [procfs](http://en.wikipedia.org/wiki/Procfs) to be available (check with `[ -d /proc ] && echo available || echo not available`).
metrics.sh has been tested on Ubuntu and Mac OS X but is supposed to run on most *NIX-line operating systems. Some of the provided metrics require [procfs](http://en.wikipedia.org/wiki/Procfs) to be available.
## Metrics

View File

@ -20,12 +20,12 @@ help () {
echo
echo " Options: "
echo
echo " -m, --metrics <metric1,...> use specified metrics"
echo " -r, --reporter <reporter> use specified reporter (default: stdout)"
echo " -i, --interval <seconds> collect metrics every n seconds (default: 2)"
echo " -v, --verbose enable verbose mode"
echo " -d, --docs show documentation"
echo " -h, --help show this text"
echo " -m, --metrics <metrics> comma-separated list of metrics to collect"
echo " -r, --reporter <reporter> use specified reporter (default: stdout)"
echo " -i, --interval <seconds> collect metrics every n seconds (default: 2)"
echo " -v, --verbose enable verbose mode"
echo " -d, --docs show documentation"
echo " -h, --help show this text"
echo
}