slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cli: shorter help mockup updates

Browse Source
This commit is contained in:
Simon Michael 2016-02-19 22:44:24 -08:00
parent c9937db10e
commit 2b4cb6b970
1 changed files with 34 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
doc/mockups/shorter-help.txt
View File

@ -379,40 +379,54 @@ General flags (for more detail, use --help):
--cleared --pending -U --uncleared -R --real --depth=N -E --empty -B --cleared --pending -U --uncleared -R --real --depth=N -E --empty -B
--cost -h --help --debug=N --version --cost -h --help --debug=N --version
** -h shows command-specific flags in brief plus general flags in brief:
$ hledger register -h $ hledger register -h
register [OPTIONS] [PATTERNS] register [OPTIONS] [PATTERNS]
show postings and running total (reg) show postings and running total (reg)
Flags: Flags:
-H --historical include prior postings in the running total -H --historical -A --average -r --related -w --width=N
-A --average show a running average instead of the running -o --output-file=FILE[.FMT] -O --output-format=FMT
total (implies --empty)
-r --related show postings' siblings instead
-w --width=N set output width (default: terminal width or
COLUMNS. -wN,M sets description width as well)
-o --output-file=FILE[.FMT] write output to FILE instead of stdout. A
recognised FMT suffix influences the format.
-O --output-format=FMT select the output format. Supported formats:
txt, csv.
General flags (for more detail, use --help): General flags:
-f --file=FILE --rules-file=RFILE --alias=OLD=NEW --ignore-assertions -b -f --file=FILE --rules-file=RFILE --alias=OLD=NEW --ignore-assertions
--begin=DATE -e --end=DATE -D --daily -W --weekly -M --monthly -Q -b --begin=DATE -e --end=DATE -D --daily -W --weekly -M --monthly
--quarterly -Y --yearly -p --period=PERIODEXP --date2 --aux-date -C -Q --quarterly -Y --yearly -p --period=PERIODEXP --date2 --aux-date
--cleared --pending -U --uncleared -R --real --depth=N -E --empty -B -C --cleared --pending -U --uncleared -R --real --depth=N -E --empty -B
--cost -h --help --debug=N --version --cost -h --help --debug=N --version
(for more detail, use --help)
** -h shows specific flags and general flags in brief, together
$ hledger stats -h $ hledger stats -h
stats [OPTIONS] [PATTERNS] stats [OPTIONS] [PATTERNS]
show some journal statistics show some journal statistics
Flags: Flags:
-o --output-file=FILE[.FMT] write output to FILE instead of stdout. A -o --output-file=FILE[.FMT]
recognised FMT suffix influences the format.
General flags (for more detail, use --help):
-f --file=FILE --rules-file=RFILE --alias=OLD=NEW --ignore-assertions -b -f --file=FILE --rules-file=RFILE --alias=OLD=NEW --ignore-assertions -b
--begin=DATE -e --end=DATE -D --daily -W --weekly -M --monthly -Q --begin=DATE -e --end=DATE -D --daily -W --weekly -M --monthly -Q
--quarterly -Y --yearly -p --period=PERIODEXP --date2 --aux-date -C --quarterly -Y --yearly -p --period=PERIODEXP --date2 --aux-date -C
--cleared --pending -U --uncleared -R --real --depth=N -E --empty -B --cleared --pending -U --uncleared -R --real --depth=N -E --empty -B
--cost -h --help --debug=N --version --cost -h --help --debug=N --version
(for more detail, use --help)
** -h shows specific flags and general flags in brief, together, more compactly
$ hledger stats -h
stats [-o --output-file=FILE[.FMT] -f --file=FILE --rules-file=RFILE
--alias=OLD=NEW --ignore-assertions -b --begin=DATE -e
--end=DATE -D --daily -W --weekly -M --monthly -Q --quarterly -Y
--yearly -p --period=PERIODEXP --date2 --aux-date -C --cleared
--pending -U --uncleared -R --real --depth=N -E --empty -B
--cost -h --help --debug=N --version]
[PATTERNS]
show some journal statistics
(for more detail, use --help)