Simon Michael
c787286844
imp: doc: show flags help in manuals
...
Each CMD.md file now contains a snapshot of the flags help as rendered
by --help. For now these must be updated manually.
2024-06-07 06:55:33 -07:00
Simon Michael
d4dcbbd4c8
fix: help, --man: fix jumping to TOPIC when viewing a man page
...
And clarify exact/prefix matching behaviour.
2024-05-29 09:37:20 -10:00
Simon Michael
0c85b48d2c
;doc: use ``cli not ``shell for command-line examples
2023-11-26 08:30:04 -10:00
Simon Michael
3e3c3c8355
imp: help: doc: warn about old info on mac ( fix #1770 )
2023-04-06 15:36:00 -10:00
Simon Michael
0567935e4b
cli: simplify command doc inclusion, give them normal heading structure
2023-02-20 16:24:54 -10:00
Simon Michael
efa1879a11
;doc: cli: help: more updates
2022-08-22 08:26:32 +01:00
Simon Michael
9d2c9bd85f
;doc: cli: help: more updates
2022-08-22 08:21:01 +01:00
Simon Michael
8eb1e0883a
;doc: cli: help, common tasks: update
2022-08-22 07:45:23 +01:00
Simon Michael
b74aa78345
;help: doc: clarify
2021-08-08 10:15:21 -10:00
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
Simon Michael
f20cd2b112
help: show only the hledger manual, for now
2020-12-26 17:27:27 -08:00
Simon Michael
7d3f05b16a
help: add -i/-m/-p short flags
2020-12-26 17:27:27 -08:00
Simon Michael
9beff54b27
help: drop --cat
2020-12-26 17:27:27 -08:00
Simon Michael
ab55be6d64
;doc: link updates
2020-12-26 17:27:27 -08:00
Simon Michael
a7e9e9ac0e
doc: merge file format manuals into the hledger manual
...
Also flatten the journal manual topics a bit.
There are pros and cons to this, but I believe the pros outweigh the
cons.
2020-12-24 10:22:05 -08:00
Simon Michael
4a7a700d93
;doc: fix flags marker appearing in manuals
...
$FLAGS$ didn't work (nor =FLAGS=); _FLAGS it is..
[ci skip]
2020-01-05 07:41:01 -08:00
Simon Michael
c186eb6084
;doc: change flags marker in command helps to suit latest pandoc
...
From _FLAGS_ to $FLAGS$, since latest pandoc strips the underscores
at a certain point in our docs rendering.
2020-01-04 21:17:51 -08:00
Simon Michael
4db14ef70f
;api: another round of hledger-api purging; fix the build
2019-09-11 14:49:22 -07:00
Simon Michael
4ee39e039b
doc: integrate CLI help & manual for remaining commands
...
& rename HelpTemplate -> CommandDoc
2019-01-28 05:43:49 -08:00
