slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
b15a634a44
hledger/hledger/Hledger/Cli/Commands/Help.md
Simon Michael ae9595c321 cli/help: --info/--man/help show CMD/topic-specific docs 
hledger CMD --info will now open CMD's info node,
hledger CMD --man will scroll the man page to CMD's section, and
hledger help -i/-m/-p TOPIC will do similar.
This is not perfectly robust but hopefully will be good enough in
practice.

Also the help command's long --info/--man/--pager flags have been
dropped in favour of -i/-m/-p.
2020-12-26 17:27:28 -08:00

726 B
Raw Blame History

help
Show the hledger user manual in one of several formats, optionally positioned at a given TOPIC (if possible). TOPIC is any heading, or heading prefix, in the manual. Some examples: commands, print, ‘auto postings’, periodic.

_FLAGS

This command shows the user manual built in to this hledger version. It can be useful if the correct version of the hledger manual, or the usual viewing tools, are not installed on your system.

By default it uses the best viewer it can find in $PATH, in this order: info, man, $PAGER (unless a topic is specified), less, or stdout. When run non-interactively, it always uses stdout. Or you can select a particular viewer with the -i (info), -m (man), or -p (pager) flags.