Commit Graph

9265 Commits

Author SHA1 Message Date
Simon Michael
b66d8f0f3c ;update manuals 2020-12-26 17:29:02 -08:00
Simon Michael
cee1c69ac0 ;update CLI usage texts 2020-12-26 17:28:47 -08:00
Simon Michael
4330427f6b cli: make --help/--version always CMD-specific
This simplifies the --help/-h and --version flags by making them
position independent: no matter where they appear in the command line,
if there is a command argument they will show the command's help or
version (where applicable), instead of the hledger executable's.
2020-12-26 17:27:28 -08:00
Simon Michael
12447ffab7 ;lib: restore list of hledger debug levels 2020-12-26 17:27:28 -08: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
54af71a0b1 cli: general --man, --info flags show the manual 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
28bcd9aadc ;doc: reference manuals -> user manuals 2020-12-26 17:27:27 -08:00
Simon Michael
201ea210fb ;cli: doc: intro wording 2020-12-26 17:27:27 -08:00
Simon Michael
8a16b2b1b0 ;update CLI usage texts 2020-12-26 08:21:45 -08:00
Simon Michael
45a5658396 cli: drop deprecated command aliases a, b, p, r, txns 2020-12-26 08:21:45 -08:00
Simon Michael
8d320bc1fe ;update manuals 2020-12-24 17:26:17 -08:00
Simon Michael
9824c9683a ;doc: drop some old man page stuff 2020-12-24 17:25:49 -08:00
Simon Michael
fbe30a73b9 ;doc: mention version in all manual formats 2020-12-24 17:25:11 -08:00
Simon Michael
f79cd78179 ;doc: update links 2020-12-24 13:02:02 -08:00
Simon Michael
27ab7a1745 ;doc: update links 2020-12-24 12:57:14 -08:00
Simon Michael
fbf9418756 ;doc: update links to journal manual 2020-12-24 12:49:04 -08:00
Simon Michael
62660577c3 ;update cabal files 2020-12-24 10:22:16 -08:00
Simon Michael
ff3a05f891 ;update manuals 2020-12-24 10:22:05 -08:00
Simon Michael
ef55f9faf3 ;update CLI usage texts 2020-12-24 10:22:05 -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
a950d49e18 cli: hide deprecated aliases in command list
(a, b, p, r, equity, txns)
2020-12-23 12:00:42 -08:00
Simon Michael
0a36823094 ;update manuals 2020-12-23 10:29:57 -08:00
Simon Michael
69a7325f91 ;update CLI usage texts 2020-12-23 10:29:30 -08:00
Simon Michael
9c7a87da57 cli: doc: sync/update manual & cli command lists 2020-12-23 10:28:31 -08:00
Simon Michael
f43ab0029d cli: doc: reorganise/flatten hledger manual, rewrite commands section 2020-12-23 10:25:43 -08:00
Simon Michael
65a003c8ee ;doc: refactor, keep commands.m4 in Commands dir 2020-12-22 17:05:28 -08:00
Simon Michael
2d6ccd616e ;journal: doc: commodity display style examples 2020-12-22 15:38:13 -08:00
Simon Michael
630347e0e8 ;bs/bse/cf/is: describe in terms of balance command 2020-12-22 09:22:10 -08:00
Simon Michael
324dfaee49 ;update manuals 2020-12-20 20:11:35 -08:00
Simon Michael
a024ac14a9 Merge branch 'manuals' into master 2020-12-20 20:09:08 -08:00
Simon Michael
3d6dab7683 journal: doc: raise all headings, improving info structure 2020-12-20 20:08:35 -08:00
Simon Michael
753ee5f50f ;doc: note dependency between shake targets 2020-12-20 20:08:35 -08:00
Simon Michael
4639522d9c ui: doc: fix decapitalisation in manual, present since 1.19
Added accidentally by 847fc23 on 2020-07-17.
2020-12-20 20:08:35 -08:00
Simon Michael
63876a4186 ;cli: doc: commands glue text 2020-12-20 20:08:35 -08:00
Simon Michael
0ff65456fa ;doc: info: tweak first/top heading again to improve structure 2020-12-20 20:08:35 -08:00
Simon Michael
9daaabeda2 ;doc: simplify manuals' title metadata to fit man/info better 2020-12-20 20:08:35 -08:00
Simon Michael
a424541e38 ;doc: man: show program name in upper case, per man-page(7) 2020-12-20 20:08:35 -08:00
Simon Michael
24fad7ce35 ;doc: man: show program name & version in footer 2020-12-20 20:08:35 -08:00
Simon Michael
006db6136c ;doc: info: consistent indenting of synopsis command lines 2020-12-20 20:08:35 -08:00
Simon Michael
57a176193d ;doc: commands: include in man pages again; simplify headings
Simplify things for now.
2020-12-20 20:08:35 -08:00
Simon Michael
f42d2e2b61 ;doc: info: drop standalone headers again, they break things 2020-12-20 20:08:35 -08:00
Simon Michael
18303bd3d2 ;doc: tweak man pages' See also 2020-12-20 20:08:35 -08:00
Simon Michael
11b787e8ec ;doc: info: drop areg/bal's "Output format" heading to fix node loops
These were making it impossible to page through the entier manual with
the space key.
2020-12-20 20:08:35 -08:00
Simon Michael
c92c27d565 doc: tweak manuals' top heading to improve info structure 2020-12-20 20:08:35 -08:00
Simon Michael
6e1a9f83e1 ;doc: info: add standalone headers, incl. text encoding 2020-12-20 20:08:29 -08:00
Simon Michael
ad3b5ef2fb ;doc: cli: reorder command docs; clean up includes 2020-12-20 07:57:57 -08:00