mirror of
https://github.com/simonmichael/hledger.git
synced 2024-12-29 13:22:27 +03:00
doc: update some docs mentioning --help
This commit is contained in:
parent
b73bcda52a
commit
2931bd6085
@ -503,7 +503,7 @@ hledger will detect these and include them in the command list and let
|
|||||||
you invoke them with `hledger ADDONCMD`. However there are some limitations:
|
you invoke them with `hledger ADDONCMD`. However there are some limitations:
|
||||||
|
|
||||||
- Options appearing before ADDONCMD will be visible only to hledger and will not be passed to the add-on.
|
- Options appearing before ADDONCMD will be visible only to hledger and will not be passed to the add-on.
|
||||||
Eg: `hledger --help web` shows hledger's help, `hledger web --help` shows hledger-web's help.
|
Eg: `hledger -h web` shows hledger's usage, `hledger web -h` shows hledger-web's usage.
|
||||||
- Options understood only by the add-on must go after a `--` argument to hide them from hledger, which would otherwise reject them.
|
- Options understood only by the add-on must go after a `--` argument to hide them from hledger, which would otherwise reject them.
|
||||||
Eg: `hledger web -- --server`.
|
Eg: `hledger web -- --server`.
|
||||||
|
|
||||||
|
@ -142,11 +142,10 @@ $\ hledger\ activity\ \-W\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ #\ show\ tran
|
|||||||
.fi
|
.fi
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
.PP
|
.PP
|
||||||
To see general help and the command list: \f[C]hledger\ \-\-help\f[] or
|
To see general usage and the command list: \f[C]hledger\ \-h\f[] or just
|
||||||
\f[C]hledger\f[]
|
\f[C]hledger\f[]
|
||||||
.PP
|
.PP
|
||||||
To see all options available with a command:
|
To see usage for a specific command: \f[C]hledger\ COMMAND\ \-h\f[]
|
||||||
\f[C]hledger\ COMMAND\ \-\-help\f[]
|
|
||||||
.PP
|
.PP
|
||||||
Except for the General options below, options must be written after
|
Except for the General options below, options must be written after
|
||||||
COMMAND, not before it.
|
COMMAND, not before it.
|
||||||
@ -170,8 +169,13 @@ There are three kinds of options.
|
|||||||
General options are always available and can appear anywhere in the
|
General options are always available and can appear anywhere in the
|
||||||
command line:
|
command line:
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]\-h\ \-\-help\f[]
|
.B \f[C]\-h\f[]
|
||||||
show general help or (after command) command help
|
show general usage or (after command) command usage
|
||||||
|
.RS
|
||||||
|
.RE
|
||||||
|
.TP
|
||||||
|
.B \f[C]\-\-help\f[]
|
||||||
|
show detailed help
|
||||||
.RS
|
.RS
|
||||||
.RE
|
.RE
|
||||||
.TP
|
.TP
|
||||||
@ -1625,8 +1629,8 @@ However there are some limitations:
|
|||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
Options appearing before ADDONCMD will be visible only to hledger and
|
Options appearing before ADDONCMD will be visible only to hledger and
|
||||||
will not be passed to the add\-on.
|
will not be passed to the add\-on.
|
||||||
Eg: \f[C]hledger\ \-\-help\ web\f[] shows hledger\[aq]s help,
|
Eg: \f[C]hledger\ \-h\ web\f[] shows hledger\[aq]s usage,
|
||||||
\f[C]hledger\ web\ \-\-help\f[] shows hledger\-web\[aq]s help.
|
\f[C]hledger\ web\ \-h\f[] shows hledger\-web\[aq]s usage.
|
||||||
.IP \[bu] 2
|
.IP \[bu] 2
|
||||||
Options understood only by the add\-on must go after a \f[C]\-\-\f[]
|
Options understood only by the add\-on must go after a \f[C]\-\-\f[]
|
||||||
argument to hide them from hledger, which would otherwise reject them.
|
argument to hide them from hledger, which would otherwise reject them.
|
||||||
|
@ -102,9 +102,9 @@ EEXXAAMMPPLLEESS
|
|||||||
$ hledger activity -W # show transaction counts per week as a bar chart
|
$ hledger activity -W # show transaction counts per week as a bar chart
|
||||||
|
|
||||||
OOPPTTIIOONNSS
|
OOPPTTIIOONNSS
|
||||||
To see general help and the command list: hledger --help or hledger
|
To see general usage and the command list: hledger -h or just hledger
|
||||||
|
|
||||||
To see all options available with a command: hledger COMMAND --help
|
To see usage for a specific command: hledger COMMAND -h
|
||||||
|
|
||||||
Except for the General options below, options must be written after
|
Except for the General options below, options must be written after
|
||||||
COMMAND, not before it.
|
COMMAND, not before it.
|
||||||
@ -122,8 +122,9 @@ OOPPTTIIOONNSS
|
|||||||
There are three kinds of options. General options are always available
|
There are three kinds of options. General options are always available
|
||||||
and can appear anywhere in the command line:
|
and can appear anywhere in the command line:
|
||||||
|
|
||||||
--hh ----hheellpp
|
--hh show general usage or (after command) command usage
|
||||||
show general help or (after command) command help
|
|
||||||
|
----hheellpp show detailed help
|
||||||
|
|
||||||
----vveerrssiioonn
|
----vveerrssiioonn
|
||||||
show version information
|
show version information
|
||||||
@ -1181,8 +1182,8 @@ AADDDD--OONN CCOOMMMMAANNDDSS
|
|||||||
tions:
|
tions:
|
||||||
|
|
||||||
+o Options appearing before ADDONCMD will be visible only to hledger and
|
+o Options appearing before ADDONCMD will be visible only to hledger and
|
||||||
will not be passed to the add-on. Eg: hledger --help web shows
|
will not be passed to the add-on. Eg: hledger -h web shows hledger's
|
||||||
hledger's help, hledger web --help shows hledger-web's help.
|
usage, hledger web -h shows hledger-web's usage.
|
||||||
|
|
||||||
+o Options understood only by the add-on must go after a -- argument to
|
+o Options understood only by the add-on must go after a -- argument to
|
||||||
hide them from hledger, which would otherwise reject them. Eg:
|
hide them from hledger, which would otherwise reject them. Eg:
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
# OPTIONS
|
# OPTIONS
|
||||||
|
|
||||||
To see general help and the command list: `hledger --help` or `hledger`
|
To see general usage and the command list: `hledger -h` or just `hledger`
|
||||||
|
|
||||||
To see all options available with a command: `hledger COMMAND --help`
|
To see usage for a specific command: `hledger COMMAND -h`
|
||||||
|
|
||||||
Except for the General options below, options must be written after
|
Except for the General options below, options must be written after
|
||||||
COMMAND, not before it.
|
COMMAND, not before it.
|
||||||
@ -21,8 +21,11 @@ interpreted as a search query which filters the data, see QUERIES.
|
|||||||
There are three kinds of options.
|
There are three kinds of options.
|
||||||
General options are always available and can appear anywhere in the command line:
|
General options are always available and can appear anywhere in the command line:
|
||||||
|
|
||||||
`-h --help`
|
`-h`
|
||||||
: show general help or (after command) command help
|
: show general usage or (after command) command usage
|
||||||
|
|
||||||
|
`--help`
|
||||||
|
: show detailed help
|
||||||
|
|
||||||
`--version`
|
`--version`
|
||||||
: show version information
|
: show version information
|
||||||
|
Loading…
Reference in New Issue
Block a user