README format improvements
This commit is contained in:
parent
c7c75b0496
commit
fa1ae4670b
1 changed files with 14 additions and 14 deletions
28
README.md
28
README.md
|
@ -25,23 +25,23 @@ Features
|
||||||
Usage
|
Usage
|
||||||
=====
|
=====
|
||||||
|
|
||||||
Usage: periodic [ARGS] [COMMAND]
|
Usage: periodic [ARGS] [COMMAND]
|
||||||
|
|
||||||
It counts upward (incrementing by 1, default) or downward (decrementing by 1,
|
It counts upward (incrementing by 1, default) or downward (decrementing by 1,
|
||||||
-d) starting at integer BEGIN (-b, default: 0) with a configurable floating
|
`-d`) starting at integer `BEGIN` (`-b`, default: 0) with a configurable
|
||||||
point interval of SECS seconds (-n, default 1.0) until infinity (default) or up
|
floating point interval of `SECS` seconds (`-n`, default 1.0) until infinity
|
||||||
to a maximum number of COUNT intervals (-c). It can operate silently and not
|
(default) or up to a maximum number of `COUNT` intervals (`-c`). It can operate
|
||||||
print this counter (-s). It optionally executes a COMMAND per interval which it
|
silently and not print this counter (`-s`). It optionally executes a `COMMAND`
|
||||||
can also fork (-f) in case the command is expected to take longer than SECS
|
per interval which it can also fork (`-f`) in case the command is expected to
|
||||||
seconds.
|
take longer than `SECS` seconds.
|
||||||
|
|
||||||
-f fork COMMAND
|
-f fork COMMAND
|
||||||
-s silent, do not print counter
|
-s silent, do not print counter
|
||||||
-d count downward (default: upward)
|
-d count downward (default: upward)
|
||||||
-n SECS interval of SECS in floating point (default: 1.0)
|
-n SECS interval of SECS in floating point (default: 1.0)
|
||||||
-c COUNT only run for COUNT interval(s) (default: -1 = infinity)
|
-c COUNT only run for COUNT interval(s) (default: -1 = infinity)
|
||||||
-b BEGIN start counting at BEGIN (default: 0)
|
-b BEGIN start counting at BEGIN (default: 0)
|
||||||
-h print this help message
|
-h print this help message
|
||||||
|
|
||||||
History
|
History
|
||||||
=======
|
=======
|
||||||
|
|
Loading…
Reference in a new issue