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

End Tag Table

File diff suppressed because it is too large Load Diff