simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-16 00:37:33 +03:00
Code Issues Projects Releases Wiki Activity

imp: help: doc: warn about old info on mac (fix #1770)

Browse Source
This commit is contained in:
Simon Michael 2023-04-06 14:53:37 -10:00
parent 1c5dee2339
commit 3e3c3c8355
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
hledger/Hledger/Cli/Commands/Help.md
View File

@ -11,13 +11,20 @@ This command shows the hledger manual built in to your hledger version.
It can be useful when offline, or when you prefer the terminal to a web browser,
or when the appropriate hledger manual or viewing tools are not installed on your system.
By default it chooses the best viewer found in $PATH
(preferring info since the hledger manual is large).
You can select a particular viewer with the `-i`, `-m`, or `-p` flags.
By default it chooses the best viewer found in $PATH, trying (in this order):
`info`, `man`, `$PAGER`, `less`, `more`.
You can force the use of info, man, or a pager with the `-i`, `-m`, or `-p` flags,
If no viewer can be found, or the command is run non-interactively, it just prints
the manual to stdout.
If using `info`, note that version 6 or greater is needed for TOPIC lookup. If you are
on mac you will likely have info 4.8, and should consider installing a newer version,
eg with `brew install texinfo` (#1770).
Examples
```shell
$ hledger help --help # show how the help command works
$ hledger help # show the hledger manual with info, man or $PAGER
$ hledger help journal # show the journal topic in the hledger manual
$ hledger help --help # show how the help command works
$ hledger help # show the hledger manual with info, man or $PAGER
$ hledger help journal # show the journal topic in the hledger manual
$ hledger help -m journal # show it with man, even if info is installed
```