update README with added options
This commit is contained in:
parent
3395739932
commit
710fc9fe81
16
README.md
16
README.md
|
@ -37,7 +37,7 @@ use responsibly.
|
|||
|
||||
```
|
||||
usage: impatient [-h] [-f FINAL] [-i INTERVAL] [-w WINDOW] [-d DECAY]
|
||||
(-p PATH | -c COMMAND)
|
||||
[-V FRACTION] [-I COUNT] [-l PATH] (-p PATH | -c COMMAND)
|
||||
|
||||
Display progress and time estimates for arbitrary tasks
|
||||
|
||||
|
@ -55,6 +55,20 @@ optional arguments:
|
|||
Decay coefficient for older samples (default 1). Must
|
||||
be between 0 and 1 inclusive. The lower this is, the
|
||||
more responsive/swingy the estimate will be.
|
||||
-V FRACTION, --termination-value-threshold FRACTION
|
||||
Fraction of the expected final value that must be
|
||||
reached in order to terminate (default 0.95). Reaching
|
||||
this threshold is necessary but not sufficient, see
|
||||
also -I
|
||||
-I COUNT, --termination-inactivity-threshold COUNT
|
||||
Number of consecutive unchanged samples that must be
|
||||
observed in order to terminate (default 10). Reaching
|
||||
this threshold is necessary but not sufficient, see
|
||||
also -V
|
||||
-l PATH, --log-file PATH
|
||||
File to log the time series to. Will be saved as a
|
||||
csv, with columns for timestamp and for value. Will
|
||||
append data if the file already exists.
|
||||
-p PATH, --path PATH Track total disk usage of a given path
|
||||
-c COMMAND, --command COMMAND
|
||||
Track value returned by a shell command; this should
|
||||
|
|
Loading…
Reference in a new issue