;doc: update manuals

This commit is contained in:
Simon Michael 2023-04-07 09:52:29 -10:00
parent ed2ff1e0c4
commit 2bdba319b1
5 changed files with 371 additions and 346 deletions

View File

@ -1,4 +1,4 @@
This is hledger-ui.info, produced by makeinfo version 7.0.1 from stdin.
This is hledger-ui.info, produced by makeinfo version 7.0.3 from stdin.
INFO-DIR-SECTION User Applications
START-INFO-DIR-ENTRY

View File

@ -1,4 +1,4 @@
This is hledger-web.info, produced by makeinfo version 7.0.1 from stdin.
This is hledger-web.info, produced by makeinfo version 7.0.3 from stdin.
INFO-DIR-SECTION User Applications
START-INFO-DIR-ENTRY

View File

@ -10348,18 +10348,27 @@ 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.
.PP
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 \f[V]-i\f[R], \f[V]-m\f[R],
or \f[V]-p\f[R] flags.
By default it chooses the best viewer found in $PATH, trying (in this
order): \f[V]info\f[R], \f[V]man\f[R], \f[V]$PAGER\f[R], \f[V]less\f[R],
\f[V]more\f[R].
You can force the use of info, man, or a pager with the \f[V]-i\f[R],
\f[V]-m\f[R], or \f[V]-p\f[R] flags, If no viewer can be found, or the
command is run non-interactively, it just prints the manual to stdout.
.PP
If using \f[V]info\f[R], 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 \f[V]brew install texinfo\f[R]
(#1770).
.PP
Examples
.IP
.nf
\f[C]
$ 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
\f[R]
.fi
.SS import

View File

@ -1,4 +1,4 @@
This is hledger.info, produced by makeinfo version 7.0.1 from stdin.
This is hledger.info, produced by makeinfo version 7.0.3 from stdin.
INFO-DIR-SECTION User Applications
START-INFO-DIR-ENTRY
@ -9058,15 +9058,23 @@ 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
$ 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

File: hledger.info, Node: import, Next: incomestatement, Prev: help, Up: PART 4 COMMANDS
@ -10976,70 +10984,70 @@ Node: files323101
Ref: #files323210
Node: help323351
Ref: #help-1323460
Node: import324406
Ref: #import324529
Node: Deduplication325615
Ref: #deduplication325740
Node: Import testing327634
Ref: #import-testing327799
Node: Importing balance assignments328642
Ref: #importing-balance-assignments328848
Node: Commodity display styles329497
Ref: #commodity-display-styles329670
Node: incomestatement329799
Ref: #incomestatement329941
Node: notes331262
Ref: #notes331384
Node: payees331746
Ref: #payees331861
Node: prices332380
Ref: #prices332495
Node: print332793
Ref: #print332908
Node: register338246
Ref: #register338368
Node: Custom register output343399
Ref: #custom-register-output343530
Node: rewrite344867
Ref: #rewrite344985
Node: Re-write rules in a file346883
Ref: #re-write-rules-in-a-file347046
Node: Diff output format348195
Ref: #diff-output-format348378
Node: rewrite vs print --auto349470
Ref: #rewrite-vs.-print---auto349630
Node: roi350186
Ref: #roi350293
Node: Spaces and special characters in --inv and --pnl352014
Ref: #spaces-and-special-characters-in---inv-and---pnl352254
Node: Semantics of --inv and --pnl352742
Ref: #semantics-of---inv-and---pnl352981
Node: IRR and TWR explained354831
Ref: #irr-and-twr-explained354991
Node: stats358077
Ref: #stats358185
Node: tags359572
Ref: #tags-1359679
Node: test360688
Ref: #test360781
Node: PART 5 COMMON TASKS361523
Ref: #part-5-common-tasks361656
Node: Getting help361930
Ref: #getting-help362071
Node: Constructing command lines362831
Ref: #constructing-command-lines363032
Node: Starting a journal file363689
Ref: #starting-a-journal-file363896
Node: Setting opening balances365084
Ref: #setting-opening-balances365289
Node: Recording transactions368430
Ref: #recording-transactions368619
Node: Reconciling369175
Ref: #reconciling369327
Node: Reporting371584
Ref: #reporting371733
Node: Migrating to a new file375718
Ref: #migrating-to-a-new-file375875
Node: import324833
Ref: #import324956
Node: Deduplication326042
Ref: #deduplication326167
Node: Import testing328061
Ref: #import-testing328226
Node: Importing balance assignments329069
Ref: #importing-balance-assignments329275
Node: Commodity display styles329924
Ref: #commodity-display-styles330097
Node: incomestatement330226
Ref: #incomestatement330368
Node: notes331689
Ref: #notes331811
Node: payees332173
Ref: #payees332288
Node: prices332807
Ref: #prices332922
Node: print333220
Ref: #print333335
Node: register338673
Ref: #register338795
Node: Custom register output343826
Ref: #custom-register-output343957
Node: rewrite345294
Ref: #rewrite345412
Node: Re-write rules in a file347310
Ref: #re-write-rules-in-a-file347473
Node: Diff output format348622
Ref: #diff-output-format348805
Node: rewrite vs print --auto349897
Ref: #rewrite-vs.-print---auto350057
Node: roi350613
Ref: #roi350720
Node: Spaces and special characters in --inv and --pnl352441
Ref: #spaces-and-special-characters-in---inv-and---pnl352681
Node: Semantics of --inv and --pnl353169
Ref: #semantics-of---inv-and---pnl353408
Node: IRR and TWR explained355258
Ref: #irr-and-twr-explained355418
Node: stats358504
Ref: #stats358612
Node: tags359999
Ref: #tags-1360106
Node: test361115
Ref: #test361208
Node: PART 5 COMMON TASKS361950
Ref: #part-5-common-tasks362083
Node: Getting help362357
Ref: #getting-help362498
Node: Constructing command lines363258
Ref: #constructing-command-lines363459
Node: Starting a journal file364116
Ref: #starting-a-journal-file364323
Node: Setting opening balances365511
Ref: #setting-opening-balances365716
Node: Recording transactions368857
Ref: #recording-transactions369046
Node: Reconciling369602
Ref: #reconciling369754
Node: Reporting372011
Ref: #reporting372160
Node: Migrating to a new file376145
Ref: #migrating-to-a-new-file376302

End Tag Table

File diff suppressed because it is too large Load Diff