;doc: update manuals

This commit is contained in:
Simon Michael 2021-11-21 23:06:55 -10:00
parent 6225db6b36
commit 7b59821378
3 changed files with 778 additions and 746 deletions

View File

@ -6694,52 +6694,66 @@ more detailed docs below:
.PP .PP
.TS .TS
tab(@); tab(@);
lw(5.2n) lw(64.8n). lw(4.9n) lw(61.1n) lw(4.0n).
T{ T{
directive directive
T}@T{ T}@T{
effects effects
T}@T{
ends at file end?
T} T}
_ _
T{ T{
\f[B]\f[CB]account\f[B]\f[R] \f[B]\f[CB]account\f[B]\f[R]
T}@T{ T}@T{
Declare an account, for checking all entries in all files;and its Declare an account, for checking all entries in all files; and its
display order and type, for reports.Subdirectives: any text, ignored. display order and type, for reports.
Subdirectives: any text, ignored.
T}@T{
T} T}
T{ T{
\f[B]\f[CB]alias\f[B]\f[R] \f[B]\f[CB]alias\f[B]\f[R]
T}@T{ T}@T{
Rewrites account names, in following entries until end of current file Rewrites account names, in following entries until end of current file
or \f[C]end aliases\f[R]. or \f[C]end aliases\f[R].
T}@T{
Y
T} T}
T{ T{
\f[B]\f[CB]apply account\f[B]\f[R] \f[B]\f[CB]apply account\f[B]\f[R]
T}@T{ T}@T{
Prepends a common parent account to all account names, in following Prepends a common parent account to all account names, in following
entries until end of current file or \f[C]end apply account\f[R]. entries until end of current file or \f[C]end apply account\f[R].
T}@T{
Y
T} T}
T{ T{
\f[B]\f[CB]comment\f[B]\f[R] \f[B]\f[CB]comment\f[B]\f[R]
T}@T{ T}@T{
Ignores part of the journal file, until end of current file or Ignores part of the journal file, until end of current file or
\f[C]end comment\f[R]. \f[C]end comment\f[R].
T}@T{
Y
T} T}
T{ T{
\f[B]\f[CB]commodity\f[B]\f[R] \f[B]\f[CB]commodity\f[B]\f[R]
T}@T{ T}@T{
Declares a commodity, for checking all entries in all files;the decimal Declares a commodity, for checking all entries in all files; the decimal
mark for parsing amounts of this commodity, for following entries until mark for parsing amounts of this commodity, for following entries until
end of current file;and its display style, for reports. end of current file; and its display style, for reports.
Takes precedence over \f[C]D\f[R].Subdirectives: \f[C]format\f[R] Takes precedence over \f[C]D\f[R].
(alternate syntax). Subdirectives: \f[C]format\f[R] (alternate syntax).
T}@T{
N, Y
T} T}
T{ T{
\f[B]\f[CB]D\f[B]\f[R] \f[B]\f[CB]D\f[B]\f[R]
T}@T{ T}@T{
Sets a default commodity to use for no-symbol amounts,and its decimal Sets a default commodity to use for no-symbol amounts, and its decimal
mark for parsing amounts of this commodity in following entries until mark for parsing amounts of this commodity in following entries until
end of current file;and its display style, for reports. end of current file; and its display style, for reports.
T}@T{
Y
T} T}
T{ T{
\f[B]\f[CB]decimal-mark\f[B]\f[R] \f[B]\f[CB]decimal-mark\f[B]\f[R]
@ -6749,29 +6763,36 @@ following entries until next \f[C]decimal-mark\f[R] or end of current
file. file.
Included files can override. Included files can override.
Takes precedence over \f[C]commodity\f[R] and \f[C]D\f[R]. Takes precedence over \f[C]commodity\f[R] and \f[C]D\f[R].
T}@T{
Y
T} T}
T{ T{
\f[B]\f[CB]include\f[B]\f[R] \f[B]\f[CB]include\f[B]\f[R]
T}@T{ T}@T{
Includes entries and directives from another file, as if they were Includes entries and directives from another file, as if they were
written inline. written inline.
T}@T{
T} T}
T{ T{
\f[B]\f[CB]payee\f[B]\f[R] \f[B]\f[CB]payee\f[B]\f[R]
T}@T{ T}@T{
Declares a payee name, for checking all entries in all files. Declares a payee name, for checking all entries in all files.
T}@T{
T} T}
T{ T{
\f[B]\f[CB]P\f[B]\f[R] \f[B]\f[CB]P\f[B]\f[R]
T}@T{ T}@T{
Declares a market price for a commodity on some date, for valuation Declares a market price for a commodity on some date, for valuation
reports. reports.
T}@T{
T} T}
T{ T{
\f[B]\f[CB]Y\f[B]\f[R] \f[B]\f[CB]Y\f[B]\f[R]
T}@T{ T}@T{
Declares a year for yearless dates, for following entries until end of Declares a year for yearless dates, for following entries until end of
current file. current file.
T}@T{
Y
T} T}
T{ T{
\f[B]\f[CB]\[ti]\f[B]\f[R] (tilde) \f[B]\f[CB]\[ti]\f[B]\f[R] (tilde)
@ -6779,6 +6800,7 @@ T}@T{
Declares a periodic transaction rule that generates future transactions Declares a periodic transaction rule that generates future transactions
with \f[C]--forecast\f[R] and budget goals with with \f[C]--forecast\f[R] and budget goals with
\f[C]balance --budget\f[R]. \f[C]balance --budget\f[R].
T}@T{
T} T}
T{ T{
\f[B]\f[CB]=\f[B]\f[R] (equals) \f[B]\f[CB]=\f[B]\f[R] (equals)
@ -6786,6 +6808,8 @@ T}@T{
Declares an auto posting rule that generates extra postings on matched Declares an auto posting rule that generates extra postings on matched
transactions with \f[C]--auto\f[R], in current, parent, and child files transactions with \f[C]--auto\f[R], in current, parent, and child files
(but not sibling files, see #1212). (but not sibling files, see #1212).
T}@T{
partly
T} T}
.TE .TE
.PP .PP
@ -6849,7 +6873,7 @@ T}@T{
T}@T{ T}@T{
T} T}
T{ T{
Defining commodity display styles for output Defining commodity display styles
T}@T{ T}@T{
\f[C]commodity\f[R], \f[C]D\f[R] \f[C]commodity\f[R], \f[C]D\f[R]
T}@T{ T}@T{

View File

@ -5817,44 +5817,47 @@ hledger versions. Here are some more definitions:
Here are all the directives and their precise effects, with links to Here are all the directives and their precise effects, with links to
more detailed docs below: more detailed docs below:
directiveeffects directiveeffects ends
-------------------------------------------------------------------------- at
*'account'*Declare an account, for checking all entries in all files;and its file
display order and type, for reports.Subdirectives: any text, end?
ignored. ---------------------------------------------------------------------------
*'alias'*Rewrites account names, in following entries until end of current *'account'*Declare an account, for checking all entries in all files;
file or 'end aliases'. and its display order and type, for reports. Subdirectives:
*'applyPrepends a common parent account to all account names, in any text, ignored.
*'alias'*Rewrites account names, in following entries until end of Y
current file or 'end aliases'.
*'applyPrepends a common parent account to all account names, in Y
account'*following entries until end of current file or 'end apply account'*following entries until end of current file or 'end apply
account'. account'.
*'comment'*Ignores part of the journal file, until end of current file or *'comment'*Ignores part of the journal file, until end of current fileY
'end comment'. or 'end comment'.
*'commodity'*Declares a commodity, for checking all entries in all files;the *'commodity'*Declares a commodity, for checking all entries in all files;N,
decimal mark for parsing amounts of this commodity, for following the decimal mark for parsing amounts of this commodity, for Y
entries until end of current file;and its display style, for following entries until end of current file; and its display
reports. Takes precedence over 'D'.Subdirectives: 'format' style, for reports. Takes precedence over 'D'.
(alternate syntax). Subdirectives: 'format' (alternate syntax).
*'D'* Sets a default commodity to use for no-symbol amounts,and its *'D'* Sets a default commodity to use for no-symbol amounts, and Y
decimal mark for parsing amounts of this commodity in following its decimal mark for parsing amounts of this commodity in
entries until end of current file;and its display style, for following entries until end of current file; and its display
reports. style, for reports.
*'decimal-mark'*Declares the decimal mark, for parsing amounts of all commodities *'decimal-mark'*Declares the decimal mark, for parsing amounts of all Y
in following entries until next 'decimal-mark' or end of current commodities in following entries until next 'decimal-mark' or
file. Included files can override. Takes precedence over end of current file. Included files can override. Takes
'commodity' and 'D'. precedence over 'commodity' and 'D'.
*'include'*Includes entries and directives from another file, as if they *'include'*Includes entries and directives from another file, as if they
were written inline. were written inline.
*'payee'*Declares a payee name, for checking all entries in all files. *'payee'*Declares a payee name, for checking all entries in all files.
*'P'* Declares a market price for a commodity on some date, for *'P'* Declares a market price for a commodity on some date, for
valuation reports. valuation reports.
*'Y'* Declares a year for yearless dates, for following entries until *'Y'* Declares a year for yearless dates, for following entries Y
end of current file. until end of current file.
*'~'* Declares a periodic transaction rule that generates future *'~'* Declares a periodic transaction rule that generates future
(tilde)transactions with '--forecast' and budget goals with 'balance (tilde)transactions with '--forecast' and budget goals with 'balance
--budget'. --budget'.
*'='* Declares an auto posting rule that generates extra postings on *'='* Declares an auto posting rule that generates extra postings partly
(equals)matched transactions with '--auto', in current, parent, and child (equals)on matched transactions with '--auto', in current, parent,
files (but not sibling files, see #1212). and child files (but not sibling files, see #1212).
And here is an overview of which directives are useful for what: And here is an overview of which directives are useful for what:
@ -5880,7 +5883,6 @@ error checking 'commodity',
Defining accounts' display order 'account' Defining accounts' display order 'account'
and accounting type and accounting type
Defining commodity display styles 'commodity', 'D' '-c/--commodity-style' Defining commodity display styles 'commodity', 'D' '-c/--commodity-style'
for output
 
File: hledger.info, Node: Directives and multiple files, Next: Comment blocks, Prev: Directives, Up: JOURNAL FORMAT File: hledger.info, Node: Directives and multiple files, Next: Comment blocks, Prev: Directives, Up: JOURNAL FORMAT
@ -9332,196 +9334,196 @@ Node: Balance assignments and prices211022
Ref: #balance-assignments-and-prices211188 Ref: #balance-assignments-and-prices211188
Node: Directives211412 Node: Directives211412
Ref: #directives211575 Ref: #directives211575
Node: Directives and multiple files215697 Node: Directives and multiple files216025
Ref: #directives-and-multiple-files215893 Ref: #directives-and-multiple-files216221
Node: Comment blocks216585 Node: Comment blocks216913
Ref: #comment-blocks216762 Ref: #comment-blocks217090
Node: Including other files216938 Node: Including other files217266
Ref: #including-other-files217112 Ref: #including-other-files217440
Node: Default year218036 Node: Default year218364
Ref: #default-year218194 Ref: #default-year218522
Node: Declaring payees218601 Node: Declaring payees218929
Ref: #declaring-payees218772 Ref: #declaring-payees219100
Node: Declaring the decimal mark219018 Node: Declaring the decimal mark219346
Ref: #declaring-the-decimal-mark219218 Ref: #declaring-the-decimal-mark219546
Node: Declaring commodities219615 Node: Declaring commodities219943
Ref: #declaring-commodities219806 Ref: #declaring-commodities220134
Node: Commodity error checking222324 Node: Commodity error checking222652
Ref: #commodity-error-checking222474 Ref: #commodity-error-checking222802
Node: Default commodity222731 Node: Default commodity223059
Ref: #default-commodity222911 Ref: #default-commodity223239
Node: Declaring market prices224027 Node: Declaring market prices224355
Ref: #declaring-market-prices224216 Ref: #declaring-market-prices224544
Node: Declaring accounts225029 Node: Declaring accounts225357
Ref: #declaring-accounts225209 Ref: #declaring-accounts225537
Node: Account error checking226411 Node: Account error checking226739
Ref: #account-error-checking226577 Ref: #account-error-checking226905
Node: Account comments227756 Node: Account comments228084
Ref: #account-comments227940 Ref: #account-comments228268
Node: Account subdirectives228364 Node: Account subdirectives228692
Ref: #account-subdirectives228549 Ref: #account-subdirectives228877
Node: Account types228862 Node: Account types229190
Ref: #account-types229036 Ref: #account-types229364
Node: Declaring account types229694 Node: Declaring account types230022
Ref: #declaring-account-types229873 Ref: #declaring-account-types230201
Node: Auto-detected account types230927 Node: Auto-detected account types231255
Ref: #auto-detected-account-types231114 Ref: #auto-detected-account-types231442
Node: Account display order233132 Node: Account display order233460
Ref: #account-display-order233292 Ref: #account-display-order233620
Node: Rewriting accounts234443 Node: Rewriting accounts234771
Ref: #rewriting-accounts234622 Ref: #rewriting-accounts234950
Node: Basic aliases235379 Node: Basic aliases235707
Ref: #basic-aliases235515 Ref: #basic-aliases235843
Node: Regex aliases236259 Node: Regex aliases236587
Ref: #regex-aliases236421 Ref: #regex-aliases236749
Node: Combining aliases237140 Node: Combining aliases237468
Ref: #combining-aliases237323 Ref: #combining-aliases237651
Node: Aliases and multiple files238599 Node: Aliases and multiple files238927
Ref: #aliases-and-multiple-files238798 Ref: #aliases-and-multiple-files239126
Node: end aliases239377 Node: end aliases239705
Ref: #end-aliases239524 Ref: #end-aliases239852
Node: Default parent account239673 Node: Default parent account240001
Ref: #default-parent-account239863 Ref: #default-parent-account240191
Node: Periodic transactions240747 Node: Periodic transactions241075
Ref: #periodic-transactions240930 Ref: #periodic-transactions241258
Node: Periodic rule syntax242847 Node: Periodic rule syntax243175
Ref: #periodic-rule-syntax243047 Ref: #periodic-rule-syntax243375
Node: Two spaces between period expression and description!243751 Node: Two spaces between period expression and description!244079
Ref: #two-spaces-between-period-expression-and-description244064 Ref: #two-spaces-between-period-expression-and-description244392
Node: Forecasting with periodic transactions244748 Node: Forecasting with periodic transactions245076
Ref: #forecasting-with-periodic-transactions245047 Ref: #forecasting-with-periodic-transactions245375
Node: Budgeting with periodic transactions247818 Node: Budgeting with periodic transactions248146
Ref: #budgeting-with-periodic-transactions248051 Ref: #budgeting-with-periodic-transactions248379
Node: Auto postings248460 Node: Auto postings248788
Ref: #auto-postings248596 Ref: #auto-postings248924
Node: Auto postings and multiple files250775 Node: Auto postings and multiple files251103
Ref: #auto-postings-and-multiple-files250973 Ref: #auto-postings-and-multiple-files251301
Node: Auto postings and dates251182 Node: Auto postings and dates251510
Ref: #auto-postings-and-dates251450 Ref: #auto-postings-and-dates251778
Node: Auto postings and transaction balancing / inferred amounts / balance assertions251625 Node: Auto postings and transaction balancing / inferred amounts / balance assertions251953
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions251970 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions252298
Node: Auto posting tags252473 Node: Auto posting tags252801
Ref: #auto-posting-tags252682 Ref: #auto-posting-tags253010
Node: CSV FORMAT253318 Node: CSV FORMAT253646
Ref: #csv-format253446 Ref: #csv-format253774
Node: Examples256075 Node: Examples256403
Ref: #examples256178 Ref: #examples256506
Node: Basic256386 Node: Basic256714
Ref: #basic256488 Ref: #basic256816
Node: Bank of Ireland257030 Node: Bank of Ireland257358
Ref: #bank-of-ireland257167 Ref: #bank-of-ireland257495
Node: Amazon258629 Node: Amazon258957
Ref: #amazon258749 Ref: #amazon259077
Node: Paypal260468 Node: Paypal260796
Ref: #paypal260564 Ref: #paypal260892
Node: CSV rules268208 Node: CSV rules268536
Ref: #csv-rules268326 Ref: #csv-rules268654
Node: skip268659 Node: skip268987
Ref: #skip268759 Ref: #skip269087
Node: fields list269134 Node: fields list269462
Ref: #fields-list269273 Ref: #fields-list269601
Node: field assignment270776 Node: field assignment271104
Ref: #field-assignment270928 Ref: #field-assignment271256
Node: Field names271963 Node: Field names272291
Ref: #field-names272103 Ref: #field-names272431
Node: date field272483 Node: date field272811
Ref: #date-field272603 Ref: #date-field272931
Node: date2 field272651 Node: date2 field272979
Ref: #date2-field272794 Ref: #date2-field273122
Node: status field272850 Node: status field273178
Ref: #status-field272995 Ref: #status-field273323
Node: code field273044 Node: code field273372
Ref: #code-field273191 Ref: #code-field273519
Node: description field273236 Node: description field273564
Ref: #description-field273398 Ref: #description-field273726
Node: comment field273457 Node: comment field273785
Ref: #comment-field273614 Ref: #comment-field273942
Node: account field273914 Node: account field274242
Ref: #account-field274066 Ref: #account-field274394
Node: amount field274641 Node: amount field274969
Ref: #amount-field274792 Ref: #amount-field275120
Node: currency field276037 Node: currency field276365
Ref: #currency-field276192 Ref: #currency-field276520
Node: balance field276449 Node: balance field276777
Ref: #balance-field276583 Ref: #balance-field276911
Node: separator276955 Node: separator277283
Ref: #separator277087 Ref: #separator277415
Node: if block277627 Node: if block277955
Ref: #if-block277754 Ref: #if-block278082
Node: Matching the whole record278155 Node: Matching the whole record278483
Ref: #matching-the-whole-record278332 Ref: #matching-the-whole-record278660
Node: Matching individual fields279135 Node: Matching individual fields279463
Ref: #matching-individual-fields279341 Ref: #matching-individual-fields279669
Node: Combining matchers279565 Node: Combining matchers279893
Ref: #combining-matchers279763 Ref: #combining-matchers280091
Node: Rules applied on successful match280076 Node: Rules applied on successful match280404
Ref: #rules-applied-on-successful-match280269 Ref: #rules-applied-on-successful-match280597
Node: if table280923 Node: if table281251
Ref: #if-table281044 Ref: #if-table281372
Node: end282782 Node: end283110
Ref: #end282896 Ref: #end283224
Node: date-format283120 Node: date-format283448
Ref: #date-format283254 Ref: #date-format283582
Node: decimal-mark284250 Node: decimal-mark284578
Ref: #decimal-mark284397 Ref: #decimal-mark284725
Node: newest-first284736 Node: newest-first285064
Ref: #newest-first284879 Ref: #newest-first285207
Node: include285562 Node: include285890
Ref: #include285695 Ref: #include286023
Node: balance-type286139 Node: balance-type286467
Ref: #balance-type286261 Ref: #balance-type286589
Node: Tips286961 Node: Tips287289
Ref: #tips287052 Ref: #tips287380
Node: Rapid feedback287351 Node: Rapid feedback287679
Ref: #rapid-feedback287470 Ref: #rapid-feedback287798
Node: Valid CSV287922 Node: Valid CSV288250
Ref: #valid-csv288054 Ref: #valid-csv288382
Node: File Extension288246 Node: File Extension288574
Ref: #file-extension288400 Ref: #file-extension288728
Node: Reading multiple CSV files288829 Node: Reading multiple CSV files289157
Ref: #reading-multiple-csv-files289016 Ref: #reading-multiple-csv-files289344
Node: Valid transactions289257 Node: Valid transactions289585
Ref: #valid-transactions289437 Ref: #valid-transactions289765
Node: Deduplicating importing290065 Node: Deduplicating importing290393
Ref: #deduplicating-importing290246 Ref: #deduplicating-importing290574
Node: Setting amounts291279 Node: Setting amounts291607
Ref: #setting-amounts291436 Ref: #setting-amounts291764
Node: Amount signs293877 Node: Amount signs294205
Ref: #amount-signs294031 Ref: #amount-signs294359
Node: Setting currency/commodity294718 Node: Setting currency/commodity295046
Ref: #setting-currencycommodity294906 Ref: #setting-currencycommodity295234
Node: Amount decimal places296080 Node: Amount decimal places296408
Ref: #amount-decimal-places296272 Ref: #amount-decimal-places296600
Node: Referencing other fields296584 Node: Referencing other fields296912
Ref: #referencing-other-fields296783 Ref: #referencing-other-fields297111
Node: How CSV rules are evaluated297680 Node: How CSV rules are evaluated298008
Ref: #how-csv-rules-are-evaluated297855 Ref: #how-csv-rules-are-evaluated298183
Node: TIMECLOCK FORMAT299306 Node: TIMECLOCK FORMAT299634
Ref: #timeclock-format299446 Ref: #timeclock-format299774
Node: TIMEDOT FORMAT301507 Node: TIMEDOT FORMAT301835
Ref: #timedot-format301645 Ref: #timedot-format301973
Node: COMMON TASKS306207 Node: COMMON TASKS306535
Ref: #common-tasks306336 Ref: #common-tasks306664
Node: Getting help306743 Node: Getting help307071
Ref: #getting-help306877 Ref: #getting-help307205
Node: Constructing command lines307430 Node: Constructing command lines307758
Ref: #constructing-command-lines307624 Ref: #constructing-command-lines307952
Node: Starting a journal file308321 Node: Starting a journal file308649
Ref: #starting-a-journal-file308521 Ref: #starting-a-journal-file308849
Node: Setting opening balances309709 Node: Setting opening balances310037
Ref: #setting-opening-balances309907 Ref: #setting-opening-balances310235
Node: Recording transactions313048 Node: Recording transactions313376
Ref: #recording-transactions313230 Ref: #recording-transactions313558
Node: Reconciling313786 Node: Reconciling314114
Ref: #reconciling313931 Ref: #reconciling314259
Node: Reporting316188 Node: Reporting316516
Ref: #reporting316330 Ref: #reporting316658
Node: Migrating to a new file320329 Node: Migrating to a new file320657
Ref: #migrating-to-a-new-file320479 Ref: #migrating-to-a-new-file320807
Node: LIMITATIONS320778 Node: LIMITATIONS321106
Ref: #limitations320906 Ref: #limitations321234
Node: TROUBLESHOOTING321649 Node: TROUBLESHOOTING321977
Ref: #troubleshooting321764 Ref: #troubleshooting322092
 
End Tag Table End Tag Table

File diff suppressed because it is too large Load Diff