simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-19 10:17:35 +03:00
Code Issues Projects Releases Wiki Activity

;doc: update command help

Browse Source
This commit is contained in:
Simon Michael 2023-04-07 09:52:31 -10:00
parent 2bdba319b1
commit c2288f8143
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
hledger/Hledger/Cli/Commands/Help.txt
View File

@ -12,12 +12,20 @@ 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
$ 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