doc: update all docs mentioning -h and --help

This commit is contained in:
Simon Michael 2016-04-18 17:00:54 -07:00
parent df4b82740b
commit 25e2534794
10 changed files with 39 additions and 21 deletions

View File

@ -69,8 +69,13 @@ commodity (accounts screen only)
.RS
.RE
.TP
.B \f[C]\-h\ \-\-help\f[]
show help
.B \f[C]\-h\f[]
show usage
.RS
.RE
.TP
.B \f[C]\-\-help\f[]
show detailed help
.RS
.RE
.TP

View File

@ -74,8 +74,11 @@ Any QUERYARGS are interpreted as a hledger search query which filters the data.
: show amounts as their current market value in their default valuation commodity
(accounts screen only)
`-h --help`
: show help
`-h`
: show usage
`--help`
: show detailed help
`--version`
: show version information

View File

@ -54,8 +54,9 @@ OOPPTTIIOONNSS
show amounts as their current market value in their default val-
uation commodity (accounts screen only)
--hh ----hheellpp
show help
--hh show usage
----hheellpp show detailed help
----vveerrssiioonn
show version information

View File

@ -108,8 +108,13 @@ with this.
.RS
.RE
.TP
.B \f[C]\-h\ \-\-help\f[]
show help
.B \f[C]\-h\f[]
show usage
.RS
.RE
.TP
.B \f[C]\-\-help\f[]
show detailed help
.RS
.RE
.TP

View File

@ -117,8 +117,11 @@ You would change this when sharing over the network, or integrating within a lar
hledger-web normally serves static files itself, but if you wanted to
serve them from another server for efficiency, you would set the url with this.
`-h --help`
: show help
`-h`
: show usage
`--help`
: show detailed help
`--version`
: show version information

View File

@ -88,8 +88,9 @@ OOPPTTIIOONNSS
them from another server for efficiency, you would set the url
with this.
--hh ----hheellpp
show help
--hh show usage
----hheellpp show detailed help
----vveerrssiioonn
show version information

View File

@ -56,7 +56,7 @@ More commands:
$ hledger # show available commands
$ hledger add # add more transactions to the journal file
$ hledger balance # all accounts with aggregated balances
$ hledger balance --help # show help for balance command
$ hledger balance --help # show detailed help for balance command
$ hledger balance --depth 1 # only top-level accounts
$ hledger register # show account postings, with running total
$ hledger reg income # show postings to/from income accounts

View File

@ -133,7 +133,7 @@ More commands:
$\ hledger\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ available\ commands
$\ hledger\ add\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ add\ more\ transactions\ to\ the\ journal\ file
$\ hledger\ balance\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ all\ accounts\ with\ aggregated\ balances
$\ hledger\ balance\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ help\ for\ balance\ command
$\ hledger\ balance\ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ detailed\ help\ for\ balance\ command
$\ hledger\ balance\ \-\-depth\ 1\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ only\ top\-level\ accounts
$\ hledger\ register\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ account\ postings,\ with\ running\ total
$\ hledger\ reg\ income\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ postings\ to/from\ income\ accounts
@ -172,12 +172,12 @@ General options are always available and can appear anywhere in the
command line:
.TP
.B \f[C]\-h\f[]
show general usage or (after command) command usage
show general usage (or if after COMMAND, the command\[aq]s usage)
.RS
.RE
.TP
.B \f[C]\-\-help\f[]
show detailed help (man page)
show detailed help (or if after COMMAND, the command\[aq]s help)
.RS
.RE
.TP

View File

@ -95,7 +95,7 @@ EEXXAAMMPPLLEESS
$ hledger # show available commands
$ hledger add # add more transactions to the journal file
$ hledger balance # all accounts with aggregated balances
$ hledger balance --help # show help for balance command
$ hledger balance --help # show detailed help for balance command
$ hledger balance --depth 1 # only top-level accounts
$ hledger register # show account postings, with running total
$ hledger reg income # show postings to/from income accounts
@ -124,9 +124,9 @@ OOPPTTIIOONNSS
There are three kinds of options. General options are always available
and can appear anywhere in the command line:
--hh show general usage or (after command) command usage
--hh show general usage (or if after COMMAND, the command's usage)
----hheellpp show detailed help (man page)
----hheellpp show detailed help (or if after COMMAND, the command's help)
----vveerrssiioonn
show version information

View File

@ -23,10 +23,10 @@ There are three kinds of options.
General options are always available and can appear anywhere in the command line:
`-h`
: show general usage or (after command) command usage
: show general usage (or if after COMMAND, the command's usage)
`--help`
: show detailed help (man page)
: show detailed help (or if after COMMAND, the command's help)
`--version`
: show version information