doc: update manuals

This commit is contained in:
Simon Michael 2022-08-23 01:12:15 +01:00
parent 8f65f8a096
commit a0e31091fc
3 changed files with 1276 additions and 1269 deletions

View File

@ -5161,7 +5161,8 @@ help
.PD 0 .PD 0
.P .P
.PD .PD
Show the hledger user manual with info, man, or a pager if possible. Show the hledger user manual in the terminal, with \f[C]info\f[R],
\f[C]man\f[R], or a pager.
With a TOPIC argument, open it at that topic if possible. With a TOPIC argument, open it at that topic if possible.
TOPIC can be any heading in the manual, or a heading prefix, case TOPIC can be any heading in the manual, or a heading prefix, case
insensitive. insensitive.
@ -5173,8 +5174,8 @@ 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 browser, or when the appropriate hledger manual or viewing tools are not
installed on your system. installed on your system.
.PP .PP
By default it chooses the best viewer found in $PATH, preferring info By default it chooses the best viewer found in $PATH (preferring info
since the hledger manual is large. since the hledger manual is large).
You can select a particular viewer with the \f[C]-i\f[R], \f[C]-m\f[R], You can select a particular viewer with the \f[C]-i\f[R], \f[C]-m\f[R],
or \f[C]-p\f[R] flags. or \f[C]-p\f[R] flags.
.PP .PP
@ -8157,7 +8158,7 @@ If account\[aq]s name contains this (CI) regular expression: | its ty
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
If you declare any account types, it\[aq]s a good idea to declare an If you declare any account types, it\[aq]s a good idea to declare an
account for each of them, because a mixture of declared and account for all of the account types, because a mixture of declared and
name-inferred types can disrupt certain reports. name-inferred types can disrupt certain reports.
.IP \[bu] 2 .IP \[bu] 2
Certain uses of account aliases can disrupt account types. Certain uses of account aliases can disrupt account types.

View File

@ -4261,18 +4261,19 @@ File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS
========== ==========
help help
Show the hledger user manual with info, man, or a pager if possible. Show the hledger user manual in the terminal, with 'info', 'man', or a
With a TOPIC argument, open it at that topic if possible. TOPIC can be pager. With a TOPIC argument, open it at that topic if possible. TOPIC
any heading in the manual, or a heading prefix, case insensitive. Eg: can be any heading in the manual, or a heading prefix, case insensitive.
'commands', 'print', 'forecast', 'journal', 'amount', '"auto postings"'. Eg: 'commands', 'print', 'forecast', 'journal', 'amount', '"auto
postings"'.
This command shows the hledger manual built in to your hledger This command shows the hledger manual built in to your hledger
version. It can be useful when offline, or when you prefer the terminal 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 to a web browser, or when the appropriate hledger manual or viewing
tools are not installed on your system. tools are not installed on your system.
By default it chooses the best viewer found in $PATH, preferring info By default it chooses the best viewer found in $PATH (preferring info
since the hledger manual is large. You can select a particular viewer since the hledger manual is large). You can select a particular viewer
with the '-i', '-m', or '-p' flags. with the '-i', '-m', or '-p' flags.
Examples Examples
@ -6934,8 +6935,8 @@ account equity:conversion ; type: V
^expenses?(:|$) | Expense ^expenses?(:|$) | Expense
* If you declare any account types, it's a good idea to declare an * If you declare any account types, it's a good idea to declare an
account for each of them, because a mixture of declared and account for all of the account types, because a mixture of declared
name-inferred types can disrupt certain reports. and name-inferred types can disrupt certain reports.
* Certain uses of account aliases can disrupt account types. See * Certain uses of account aliases can disrupt account types. See
Rewriting accounts > Aliases and account types. Rewriting accounts > Aliases and account types.
@ -9882,324 +9883,324 @@ Node: files154054
Ref: #files154156 Ref: #files154156
Node: help154303 Node: help154303
Ref: #help154405 Ref: #help154405
Node: import155346 Node: import155356
Ref: #import155462 Ref: #import155472
Node: Deduplication156555 Node: Deduplication156565
Ref: #deduplication156680 Ref: #deduplication156690
Node: Import testing158574 Node: Import testing158584
Ref: #import-testing158739 Ref: #import-testing158749
Node: Importing balance assignments159227 Node: Importing balance assignments159237
Ref: #importing-balance-assignments159433 Ref: #importing-balance-assignments159443
Node: Commodity display styles160082 Node: Commodity display styles160092
Ref: #commodity-display-styles160255 Ref: #commodity-display-styles160265
Node: incomestatement160384 Node: incomestatement160394
Ref: #incomestatement160519 Ref: #incomestatement160529
Node: notes161851 Node: notes161861
Ref: #notes161966 Ref: #notes161976
Node: payees162334 Node: payees162344
Ref: #payees162442 Ref: #payees162452
Node: prices162968 Node: prices162978
Ref: #prices163076 Ref: #prices163086
Node: print163445 Node: print163455
Ref: #print163557 Ref: #print163567
Node: print-unique168925 Node: print-unique168935
Ref: #print-unique169053 Ref: #print-unique169063
Node: register169338 Node: register169348
Ref: #register169467 Ref: #register169477
Node: Custom register output174217 Node: Custom register output174227
Ref: #custom-register-output174348 Ref: #custom-register-output174358
Node: register-match175685 Node: register-match175695
Ref: #register-match175821 Ref: #register-match175831
Node: rewrite176172 Node: rewrite176182
Ref: #rewrite176289 Ref: #rewrite176299
Node: Re-write rules in a file178195 Node: Re-write rules in a file178205
Ref: #re-write-rules-in-a-file178358 Ref: #re-write-rules-in-a-file178368
Node: Diff output format179507 Node: Diff output format179517
Ref: #diff-output-format179690 Ref: #diff-output-format179700
Node: rewrite vs print --auto180782 Node: rewrite vs print --auto180792
Ref: #rewrite-vs.-print---auto180942 Ref: #rewrite-vs.-print---auto180952
Node: roi181498 Node: roi181508
Ref: #roi181598 Ref: #roi181608
Node: Spaces and special characters in --inv and --pnl183323 Node: Spaces and special characters in --inv and --pnl183333
Ref: #spaces-and-special-characters-in---inv-and---pnl183563 Ref: #spaces-and-special-characters-in---inv-and---pnl183573
Node: Semantics of --inv and --pnl184051 Node: Semantics of --inv and --pnl184061
Ref: #semantics-of---inv-and---pnl184290 Ref: #semantics-of---inv-and---pnl184300
Node: IRR and TWR explained186140 Node: IRR and TWR explained186150
Ref: #irr-and-twr-explained186300 Ref: #irr-and-twr-explained186310
Node: stats189386 Node: stats189396
Ref: #stats189487 Ref: #stats189497
Node: tags190867 Node: tags190877
Ref: #tags190967 Ref: #tags190977
Node: test191981 Node: test191991
Ref: #test192091 Ref: #test192101
Node: Add-on commands192838 Node: Add-on commands192848
Ref: #add-on-commands192957 Ref: #add-on-commands192967
Node: JOURNAL FORMAT194088 Node: JOURNAL FORMAT194098
Ref: #journal-format194216 Ref: #journal-format194226
Node: Transactions196443 Node: Transactions196453
Ref: #transactions196558 Ref: #transactions196568
Node: Dates197572 Node: Dates197582
Ref: #dates197688 Ref: #dates197698
Node: Simple dates197753 Node: Simple dates197763
Ref: #simple-dates197873 Ref: #simple-dates197883
Node: Secondary dates198382 Node: Secondary dates198392
Ref: #secondary-dates198530 Ref: #secondary-dates198540
Node: Posting dates199866 Node: Posting dates199876
Ref: #posting-dates199989 Ref: #posting-dates199999
Node: Status201361 Node: Status201371
Ref: #status201471 Ref: #status201481
Node: Code203179 Node: Code203189
Ref: #code203291 Ref: #code203301
Node: Description203523 Node: Description203533
Ref: #description203651 Ref: #description203661
Node: Payee and note203971 Node: Payee and note203981
Ref: #payee-and-note204079 Ref: #payee-and-note204089
Node: Comments204414 Node: Comments204424
Ref: #comments204536 Ref: #comments204546
Node: Tags205730 Node: Tags205740
Ref: #tags-1205841 Ref: #tags-1205851
Node: Postings207296 Node: Postings207306
Ref: #postings207420 Ref: #postings207430
Node: Virtual postings208446 Node: Virtual postings208456
Ref: #virtual-postings208557 Ref: #virtual-postings208567
Node: Account names209862 Node: Account names209872
Ref: #account-names209999 Ref: #account-names210009
Node: Amounts210487 Node: Amounts210497
Ref: #amounts210624 Ref: #amounts210634
Node: Decimal marks digit group marks211609 Node: Decimal marks digit group marks211619
Ref: #decimal-marks-digit-group-marks211786 Ref: #decimal-marks-digit-group-marks211796
Node: Commodity212807 Node: Commodity212817
Ref: #commodity212996 Ref: #commodity213006
Node: Directives influencing number parsing and display213948 Node: Directives influencing number parsing and display213958
Ref: #directives-influencing-number-parsing-and-display214209 Ref: #directives-influencing-number-parsing-and-display214219
Node: Commodity display style214702 Node: Commodity display style214712
Ref: #commodity-display-style214910 Ref: #commodity-display-style214920
Node: Rounding217105 Node: Rounding217115
Ref: #rounding217225 Ref: #rounding217235
Node: Transaction prices217637 Node: Transaction prices217647
Ref: #transaction-prices217803 Ref: #transaction-prices217813
Node: Equity conversion postings220275 Node: Equity conversion postings220285
Ref: #equity-conversion-postings220428 Ref: #equity-conversion-postings220438
Node: Lot prices lot dates222946 Node: Lot prices lot dates222956
Ref: #lot-prices-lot-dates223129 Ref: #lot-prices-lot-dates223139
Node: Balance assertions223617 Node: Balance assertions223627
Ref: #balance-assertions223795 Ref: #balance-assertions223805
Node: Assertions and ordering224868 Node: Assertions and ordering224878
Ref: #assertions-and-ordering225059 Ref: #assertions-and-ordering225069
Node: Assertions and multiple included files225759 Node: Assertions and multiple included files225769
Ref: #assertions-and-multiple-included-files226021 Ref: #assertions-and-multiple-included-files226031
Node: Assertions and multiple -f files226521 Node: Assertions and multiple -f files226531
Ref: #assertions-and-multiple--f-files226774 Ref: #assertions-and-multiple--f-files226784
Node: Assertions and commodities227171 Node: Assertions and commodities227181
Ref: #assertions-and-commodities227395 Ref: #assertions-and-commodities227405
Node: Assertions and prices228575 Node: Assertions and prices228585
Ref: #assertions-and-prices228783 Ref: #assertions-and-prices228793
Node: Assertions and subaccounts229223 Node: Assertions and subaccounts229233
Ref: #assertions-and-subaccounts229446 Ref: #assertions-and-subaccounts229456
Node: Assertions and virtual postings229770 Node: Assertions and virtual postings229780
Ref: #assertions-and-virtual-postings230010 Ref: #assertions-and-virtual-postings230020
Node: Assertions and auto postings230142 Node: Assertions and auto postings230152
Ref: #assertions-and-auto-postings230374 Ref: #assertions-and-auto-postings230384
Node: Assertions and precision231019 Node: Assertions and precision231029
Ref: #assertions-and-precision231203 Ref: #assertions-and-precision231213
Node: Balance assignments231470 Node: Balance assignments231480
Ref: #balance-assignments231640 Ref: #balance-assignments231650
Node: Balance assignments and prices232804 Node: Balance assignments and prices232814
Ref: #balance-assignments-and-prices232970 Ref: #balance-assignments-and-prices232980
Node: Directives233194 Node: Directives233204
Ref: #directives233357 Ref: #directives233367
Node: Directives and multiple files237849 Node: Directives and multiple files237859
Ref: #directives-and-multiple-files238045 Ref: #directives-and-multiple-files238055
Node: Comment blocks238737 Node: Comment blocks238747
Ref: #comment-blocks238914 Ref: #comment-blocks238924
Node: Including other files239090 Node: Including other files239100
Ref: #including-other-files239264 Ref: #including-other-files239274
Node: Default year240188 Node: Default year240198
Ref: #default-year240346 Ref: #default-year240356
Node: Declaring payees240753 Node: Declaring payees240763
Ref: #declaring-payees240924 Ref: #declaring-payees240934
Node: Declaring the decimal mark241170 Node: Declaring the decimal mark241180
Ref: #declaring-the-decimal-mark241370 Ref: #declaring-the-decimal-mark241380
Node: Declaring commodities241767 Node: Declaring commodities241777
Ref: #declaring-commodities241958 Ref: #declaring-commodities241968
Node: Commodity error checking244476 Node: Commodity error checking244486
Ref: #commodity-error-checking244626 Ref: #commodity-error-checking244636
Node: Default commodity245141 Node: Default commodity245151
Ref: #default-commodity245321 Ref: #default-commodity245331
Node: Declaring market prices246437 Node: Declaring market prices246447
Ref: #declaring-market-prices246626 Ref: #declaring-market-prices246636
Node: Declaring accounts247439 Node: Declaring accounts247449
Ref: #declaring-accounts247619 Ref: #declaring-accounts247629
Node: Account comments248783 Node: Account comments248793
Ref: #account-comments248936 Ref: #account-comments248946
Node: Account subdirectives249359 Node: Account subdirectives249369
Ref: #account-subdirectives249553 Ref: #account-subdirectives249563
Node: Account error checking249695 Node: Account error checking249705
Ref: #account-error-checking249896 Ref: #account-error-checking249906
Node: Account display order251085 Node: Account display order251095
Ref: #account-display-order251276 Ref: #account-display-order251286
Node: Account types252377 Node: Account types252387
Ref: #account-types252521 Ref: #account-types252531
Node: Rewriting accounts256196 Node: Rewriting accounts256218
Ref: #rewriting-accounts256375 Ref: #rewriting-accounts256397
Node: Basic aliases257415 Node: Basic aliases257437
Ref: #basic-aliases257551 Ref: #basic-aliases257573
Node: Regex aliases258295 Node: Regex aliases258317
Ref: #regex-aliases258457 Ref: #regex-aliases258479
Node: Combining aliases259347 Node: Combining aliases259369
Ref: #combining-aliases259530 Ref: #combining-aliases259552
Node: Aliases and multiple files260806 Node: Aliases and multiple files260828
Ref: #aliases-and-multiple-files261005 Ref: #aliases-and-multiple-files261027
Node: end aliases261584 Node: end aliases261606
Ref: #end-aliases261778 Ref: #end-aliases261800
Node: Aliases can generate bad account names261927 Node: Aliases can generate bad account names261949
Ref: #aliases-can-generate-bad-account-names262170 Ref: #aliases-can-generate-bad-account-names262192
Node: Aliases and account types262755 Node: Aliases and account types262777
Ref: #aliases-and-account-types262952 Ref: #aliases-and-account-types262974
Node: Default parent account263648 Node: Default parent account263670
Ref: #default-parent-account263838 Ref: #default-parent-account263860
Node: Periodic transactions264722 Node: Periodic transactions264744
Ref: #periodic-transactions264905 Ref: #periodic-transactions264927
Node: Periodic rule syntax266860 Node: Periodic rule syntax266882
Ref: #periodic-rule-syntax267040 Ref: #periodic-rule-syntax267062
Node: Periodic rules and relative dates267499 Node: Periodic rules and relative dates267521
Ref: #periodic-rules-and-relative-dates267767 Ref: #periodic-rules-and-relative-dates267789
Node: Two spaces between period expression and description!268278 Node: Two spaces between period expression and description!268300
Ref: #two-spaces-between-period-expression-and-description268604 Ref: #two-spaces-between-period-expression-and-description268626
Node: Forecasting with periodic transactions269288 Node: Forecasting with periodic transactions269310
Ref: #forecasting-with-periodic-transactions269587 Ref: #forecasting-with-periodic-transactions269609
Node: Budgeting with periodic transactions272358 Node: Budgeting with periodic transactions272380
Ref: #budgeting-with-periodic-transactions272591 Ref: #budgeting-with-periodic-transactions272613
Node: Auto postings273000 Node: Auto postings273022
Ref: #auto-postings273136 Ref: #auto-postings273158
Node: Auto postings and multiple files275315 Node: Auto postings and multiple files275337
Ref: #auto-postings-and-multiple-files275513 Ref: #auto-postings-and-multiple-files275535
Node: Auto postings and dates275722 Node: Auto postings and dates275744
Ref: #auto-postings-and-dates275990 Ref: #auto-postings-and-dates276012
Node: Auto postings and transaction balancing / inferred amounts / balance assertions276165 Node: Auto postings and transaction balancing / inferred amounts / balance assertions276187
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions276510 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions276532
Node: Auto posting tags277013 Node: Auto posting tags277035
Ref: #auto-posting-tags277222 Ref: #auto-posting-tags277244
Node: CSV FORMAT277858 Node: CSV FORMAT277880
Ref: #csv-format277986 Ref: #csv-format278008
Node: Examples280616 Node: Examples280638
Ref: #examples280719 Ref: #examples280741
Node: Basic280927 Node: Basic280949
Ref: #basic281029 Ref: #basic281051
Node: Bank of Ireland281571 Node: Bank of Ireland281593
Ref: #bank-of-ireland281708 Ref: #bank-of-ireland281730
Node: Amazon283170 Node: Amazon283192
Ref: #amazon283290 Ref: #amazon283312
Node: Paypal285009 Node: Paypal285031
Ref: #paypal285105 Ref: #paypal285127
Node: CSV rules292749 Node: CSV rules292771
Ref: #csv-rules292867 Ref: #csv-rules292889
Node: skip293200 Node: skip293222
Ref: #skip293300 Ref: #skip293322
Node: fields list293675 Node: fields list293697
Ref: #fields-list293814 Ref: #fields-list293836
Node: field assignment295380 Node: field assignment295402
Ref: #field-assignment295532 Ref: #field-assignment295554
Node: Field names296567 Node: Field names296589
Ref: #field-names296707 Ref: #field-names296729
Node: date field297087 Node: date field297109
Ref: #date-field297207 Ref: #date-field297229
Node: date2 field297255 Node: date2 field297277
Ref: #date2-field297398 Ref: #date2-field297420
Node: status field297454 Node: status field297476
Ref: #status-field297599 Ref: #status-field297621
Node: code field297648 Node: code field297670
Ref: #code-field297795 Ref: #code-field297817
Node: description field297840 Node: description field297862
Ref: #description-field298002 Ref: #description-field298024
Node: comment field298061 Node: comment field298083
Ref: #comment-field298218 Ref: #comment-field298240
Node: account field298529 Node: account field298551
Ref: #account-field298681 Ref: #account-field298703
Node: amount field299256 Node: amount field299278
Ref: #amount-field299407 Ref: #amount-field299429
Node: currency field300652 Node: currency field300674
Ref: #currency-field300807 Ref: #currency-field300829
Node: balance field301064 Node: balance field301086
Ref: #balance-field301198 Ref: #balance-field301220
Node: separator301570 Node: separator301592
Ref: #separator301702 Ref: #separator301724
Node: if block302242 Node: if block302264
Ref: #if-block302369 Ref: #if-block302391
Node: Matching the whole record302770 Node: Matching the whole record302792
Ref: #matching-the-whole-record302947 Ref: #matching-the-whole-record302969
Node: Matching individual fields303750 Node: Matching individual fields303772
Ref: #matching-individual-fields303956 Ref: #matching-individual-fields303978
Node: Combining matchers304180 Node: Combining matchers304202
Ref: #combining-matchers304378 Ref: #combining-matchers304400
Node: Rules applied on successful match304691 Node: Rules applied on successful match304713
Ref: #rules-applied-on-successful-match304884 Ref: #rules-applied-on-successful-match304906
Node: if table305538 Node: if table305560
Ref: #if-table305659 Ref: #if-table305681
Node: end307397 Node: end307419
Ref: #end307511 Ref: #end307533
Node: date-format307735 Node: date-format307757
Ref: #date-format307869 Ref: #date-format307891
Node: decimal-mark308865 Node: decimal-mark308887
Ref: #decimal-mark309012 Ref: #decimal-mark309034
Node: newest-first309351 Node: newest-first309373
Ref: #newest-first309494 Ref: #newest-first309516
Node: include310177 Node: include310199
Ref: #include310310 Ref: #include310332
Node: balance-type310754 Node: balance-type310776
Ref: #balance-type310876 Ref: #balance-type310898
Node: Tips311576 Node: Tips311598
Ref: #tips311667 Ref: #tips311689
Node: Rapid feedback311966 Node: Rapid feedback311988
Ref: #rapid-feedback312085 Ref: #rapid-feedback312107
Node: Valid CSV312537 Node: Valid CSV312559
Ref: #valid-csv312669 Ref: #valid-csv312691
Node: File Extension312861 Node: File Extension312883
Ref: #file-extension313015 Ref: #file-extension313037
Node: Reading multiple CSV files313444 Node: Reading multiple CSV files313466
Ref: #reading-multiple-csv-files313631 Ref: #reading-multiple-csv-files313653
Node: Valid transactions313872 Node: Valid transactions313894
Ref: #valid-transactions314052 Ref: #valid-transactions314074
Node: Deduplicating importing314680 Node: Deduplicating importing314702
Ref: #deduplicating-importing314861 Ref: #deduplicating-importing314883
Node: Setting amounts315897 Node: Setting amounts315919
Ref: #setting-amounts316054 Ref: #setting-amounts316076
Node: Amount signs318498 Node: Amount signs318520
Ref: #amount-signs318652 Ref: #amount-signs318674
Node: Setting currency/commodity319339 Node: Setting currency/commodity319361
Ref: #setting-currencycommodity319527 Ref: #setting-currencycommodity319549
Node: Amount decimal places320701 Node: Amount decimal places320723
Ref: #amount-decimal-places320893 Ref: #amount-decimal-places320915
Node: Referencing other fields321205 Node: Referencing other fields321227
Ref: #referencing-other-fields321404 Ref: #referencing-other-fields321426
Node: How CSV rules are evaluated322301 Node: How CSV rules are evaluated322323
Ref: #how-csv-rules-are-evaluated322476 Ref: #how-csv-rules-are-evaluated322498
Node: TIMECLOCK FORMAT323927 Node: TIMECLOCK FORMAT323949
Ref: #timeclock-format324067 Ref: #timeclock-format324089
Node: TIMEDOT FORMAT326128 Node: TIMEDOT FORMAT326150
Ref: #timedot-format326266 Ref: #timedot-format326288
Node: COMMON TASKS330828 Node: COMMON TASKS330850
Ref: #common-tasks330957 Ref: #common-tasks330979
Node: Getting help331231 Node: Getting help331253
Ref: #getting-help331365 Ref: #getting-help331387
Node: Constructing command lines332117 Node: Constructing command lines332139
Ref: #constructing-command-lines332311 Ref: #constructing-command-lines332333
Node: Starting a journal file333008 Node: Starting a journal file333030
Ref: #starting-a-journal-file333208 Ref: #starting-a-journal-file333230
Node: Setting opening balances334396 Node: Setting opening balances334418
Ref: #setting-opening-balances334594 Ref: #setting-opening-balances334616
Node: Recording transactions337735 Node: Recording transactions337757
Ref: #recording-transactions337917 Ref: #recording-transactions337939
Node: Reconciling338473 Node: Reconciling338495
Ref: #reconciling338618 Ref: #reconciling338640
Node: Reporting340875 Node: Reporting340897
Ref: #reporting341017 Ref: #reporting341039
Node: Migrating to a new file345016 Node: Migrating to a new file345038
Ref: #migrating-to-a-new-file345166 Ref: #migrating-to-a-new-file345188
Node: LIMITATIONS345465 Node: LIMITATIONS345487
Ref: #limitations345593 Ref: #limitations345615
Node: TROUBLESHOOTING346362 Node: TROUBLESHOOTING346384
Ref: #troubleshooting346477 Ref: #troubleshooting346499
 
End Tag Table End Tag Table

File diff suppressed because it is too large Load Diff