| 1 |
help |
| 2 |
|
| 3 |
Show the hledger user manual with info, man, or a pager. With a (case |
| 4 |
insensitive) TOPIC argument, try to open it at that section heading. |
| 5 |
|
| 6 |
Flags: |
| 7 |
-i show the manual with info |
| 8 |
-m show the manual with man |
| 9 |
-p show the manual with $PAGER or less |
| 10 |
(less is always used if TOPIC is specified) |
| 11 |
|
| 12 |
This command shows the hledger manual built in to your hledger |
| 13 |
executable. It can be useful when offline, or when you prefer the |
| 14 |
terminal to a web browser, or when the appropriate hledger manual or |
| 15 |
viewers are not installed properly on your system. |
| 16 |
|
| 17 |
By default it chooses the best viewer found in $PATH, trying in this |
| 18 |
order: info, man, $PAGER, less, more, stdout. (If a TOPIC is specified, |
| 19 |
$PAGER and more are not tried.) You can force the use of info, man, or a |
| 20 |
pager with the -i, -m, or -p flags. If no viewer can be found, or if |
| 21 |
running non-interactively, it just prints the manual to stdout. |
| 22 |
|
| 23 |
When using info, TOPIC can match either the full heading or a prefix. If |
| 24 |
your info --version is < 6, you'll need to upgrade it, eg with |
| 25 |
'brew install texinfo' on mac. |
| 26 |
|
| 27 |
When using man or less, TOPIC must match the full heading. For a prefix |
| 28 |
match, you can write 'TOPIC.*'. |
| 29 |
|
| 30 |
Examples |
| 31 |
|
| 32 |
$ hledger help -h # show the help command's usage |
| 33 |
$ hledger help # show the manual with info, man or $PAGER |
| 34 |
$ hledger help 'time periods' # show the manual's "Time periods" topic |
| 35 |
$ hledger help 'time periods' -m # use man, even if info is installed |