;doc: update manuals

This commit is contained in:
Simon Michael 2021-11-21 23:44:35 -10:00
parent f6b10df50b
commit 1d0fa5a96b
3 changed files with 727 additions and 729 deletions

View File

@ -6689,8 +6689,9 @@ indented below the parent directive.
output: symbol side and spacing, digit groups, decimal mark, and number
of decimal places.
.PP
Here are all the directives and their precise effects, with links to
more detailed docs below:
Directives are not required when starting out with hledger, but you will
probably add some as your needs grow.
Here are all the directives and their precise effects:
.PP
.TS
tab(@);
@ -6817,7 +6818,7 @@ And here is an overview of which directives are useful for what:
.PP
.TS
tab(@);
lw(31.0n) lw(21.8n) lw(17.2n).
lw(30.6n) lw(22.0n) lw(17.4n).
T{
purpose
T}@T{
@ -6832,14 +6833,14 @@ T}@T{
T}@T{
T}
T{
Declaring a commodity\[aq]s or file\[aq]s decimal mark to help parse
Declare a commodity\[aq]s or file\[aq]s decimal mark to help parse
amounts accurately
T}@T{
\f[C]commodity\f[R], \f[C]D\f[R], \f[C]decimal-mark\f[R]
T}@T{
T}
T{
Applying changes to the data while parsing
Apply changes to the data while parsing
T}@T{
\f[C]alias\f[R], \f[C]apply account\f[R], \f[C]comment\f[R],
\f[C]D\f[R], \f[C]Y\f[R]
@ -6847,20 +6848,20 @@ T}@T{
\f[C]--alias\f[R]
T}
T{
Inlining or concatenating extra data files
Inline or concatenate extra data files
T}@T{
\f[C]include\f[R]
T}@T{
multiple \f[C]-f/--file\f[R]\[aq]s
T}
T{
Generating extra transactions or budget goals
Generate extra transactions or budget goals
T}@T{
\f[C]\[ti]\f[R]
T}@T{
T}
T{
Generating extra postings
Generate extra postings
T}@T{
\f[C]=\f[R]
T}@T{
@ -6871,7 +6872,7 @@ T}@T{
T}@T{
T}
T{
Defining valid entities to allow stricter error checking
Define valid entities to allow stricter error checking
T}@T{
\f[C]account\f[R], \f[C]commodity\f[R], \f[C]payee\f[R]
T}@T{
@ -6882,22 +6883,18 @@ T}@T{
T}@T{
T}
T{
Defining accounts\[aq] display order and accounting type
Declare accounts\[aq] display order and accounting type
T}@T{
\f[C]account\f[R]
T}@T{
T}
T{
Defining commodity display styles
Declare commodity display styles
T}@T{
\f[C]commodity\f[R], \f[C]D\f[R]
T}@T{
\f[C]-c/--commodity-style\f[R]
T}
T{
T}@T{
T}@T{
T}
.TE
.SS Directives and multiple files
.PP

View File

@ -5814,8 +5814,9 @@ hledger versions. Here are some more definitions:
symbol side and spacing, digit groups, decimal mark, and number of
decimal places.
Here are all the directives and their precise effects, with links to
more detailed docs below:
Directives are not required when starting out with hledger, but you
will probably add some as your needs grow. Here are all the directives
and their precise effects:
directiveeffects ends
at
@ -5866,24 +5867,24 @@ purpose directives command line
similar effect
---------------------------------------------------------------------------
*READING/GENERATING DATA:*
Declaring a commodity's or 'commodity', 'D',
Declare a commodity's or 'commodity', 'D',
file's decimal mark to help 'decimal-mark'
parse amounts accurately
Applying changes to the data 'alias', 'apply '--alias'
Apply changes to the data 'alias', 'apply '--alias'
while parsing account', 'comment',
'D', 'Y'
Inlining or concatenating 'include' multiple
extra data files '-f/--file''s
Generating extra transactions '~'
or budget goals
Generating extra postings '='
Inline or concatenate extra 'include' multiple
data files '-f/--file''s
Generate extra transactions or '~'
budget goals
Generate extra postings '='
*CHECKING FOR ERRORS:*
Defining valid entities to 'account',
allow stricter error checking 'commodity', 'payee'
Define valid entities to allow 'account',
stricter error checking 'commodity', 'payee'
*DISPLAYING REPORTS:*
Defining accounts' display 'account'
Declare accounts' display 'account'
order and accounting type
Defining commodity display 'commodity', 'D' '-c/--commodity-style'
Declare commodity display 'commodity', 'D' '-c/--commodity-style'
styles

@ -9336,196 +9337,196 @@ Node: Balance assignments and prices211022
Ref: #balance-assignments-and-prices211188
Node: Directives211412
Ref: #directives211575
Node: Directives and multiple files216012
Ref: #directives-and-multiple-files216208
Node: Comment blocks216900
Ref: #comment-blocks217077
Node: Including other files217253
Ref: #including-other-files217427
Node: Default year218351
Ref: #default-year218509
Node: Declaring payees218916
Ref: #declaring-payees219087
Node: Declaring the decimal mark219333
Ref: #declaring-the-decimal-mark219533
Node: Declaring commodities219930
Ref: #declaring-commodities220121
Node: Commodity error checking222639
Ref: #commodity-error-checking222789
Node: Default commodity223046
Ref: #default-commodity223226
Node: Declaring market prices224342
Ref: #declaring-market-prices224531
Node: Declaring accounts225344
Ref: #declaring-accounts225524
Node: Account error checking226726
Ref: #account-error-checking226892
Node: Account comments228071
Ref: #account-comments228255
Node: Account subdirectives228679
Ref: #account-subdirectives228864
Node: Account types229177
Ref: #account-types229351
Node: Declaring account types230009
Ref: #declaring-account-types230188
Node: Auto-detected account types231242
Ref: #auto-detected-account-types231429
Node: Account display order233447
Ref: #account-display-order233607
Node: Rewriting accounts234758
Ref: #rewriting-accounts234937
Node: Basic aliases235694
Ref: #basic-aliases235830
Node: Regex aliases236574
Ref: #regex-aliases236736
Node: Combining aliases237455
Ref: #combining-aliases237638
Node: Aliases and multiple files238914
Ref: #aliases-and-multiple-files239113
Node: end aliases239692
Ref: #end-aliases239839
Node: Default parent account239988
Ref: #default-parent-account240178
Node: Periodic transactions241062
Ref: #periodic-transactions241245
Node: Periodic rule syntax243162
Ref: #periodic-rule-syntax243362
Node: Two spaces between period expression and description!244066
Ref: #two-spaces-between-period-expression-and-description244379
Node: Forecasting with periodic transactions245063
Ref: #forecasting-with-periodic-transactions245362
Node: Budgeting with periodic transactions248133
Ref: #budgeting-with-periodic-transactions248366
Node: Auto postings248775
Ref: #auto-postings248911
Node: Auto postings and multiple files251090
Ref: #auto-postings-and-multiple-files251288
Node: Auto postings and dates251497
Ref: #auto-postings-and-dates251765
Node: Auto postings and transaction balancing / inferred amounts / balance assertions251940
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions252285
Node: Auto posting tags252788
Ref: #auto-posting-tags252997
Node: CSV FORMAT253633
Ref: #csv-format253761
Node: Examples256390
Ref: #examples256493
Node: Basic256701
Ref: #basic256803
Node: Bank of Ireland257345
Ref: #bank-of-ireland257482
Node: Amazon258944
Ref: #amazon259064
Node: Paypal260783
Ref: #paypal260879
Node: CSV rules268523
Ref: #csv-rules268641
Node: skip268974
Ref: #skip269074
Node: fields list269449
Ref: #fields-list269588
Node: field assignment271091
Ref: #field-assignment271243
Node: Field names272278
Ref: #field-names272418
Node: date field272798
Ref: #date-field272918
Node: date2 field272966
Ref: #date2-field273109
Node: status field273165
Ref: #status-field273310
Node: code field273359
Ref: #code-field273506
Node: description field273551
Ref: #description-field273713
Node: comment field273772
Ref: #comment-field273929
Node: account field274229
Ref: #account-field274381
Node: amount field274956
Ref: #amount-field275107
Node: currency field276352
Ref: #currency-field276507
Node: balance field276764
Ref: #balance-field276898
Node: separator277270
Ref: #separator277402
Node: if block277942
Ref: #if-block278069
Node: Matching the whole record278470
Ref: #matching-the-whole-record278647
Node: Matching individual fields279450
Ref: #matching-individual-fields279656
Node: Combining matchers279880
Ref: #combining-matchers280078
Node: Rules applied on successful match280391
Ref: #rules-applied-on-successful-match280584
Node: if table281238
Ref: #if-table281359
Node: end283097
Ref: #end283211
Node: date-format283435
Ref: #date-format283569
Node: decimal-mark284565
Ref: #decimal-mark284712
Node: newest-first285051
Ref: #newest-first285194
Node: include285877
Ref: #include286010
Node: balance-type286454
Ref: #balance-type286576
Node: Tips287276
Ref: #tips287367
Node: Rapid feedback287666
Ref: #rapid-feedback287785
Node: Valid CSV288237
Ref: #valid-csv288369
Node: File Extension288561
Ref: #file-extension288715
Node: Reading multiple CSV files289144
Ref: #reading-multiple-csv-files289331
Node: Valid transactions289572
Ref: #valid-transactions289752
Node: Deduplicating importing290380
Ref: #deduplicating-importing290561
Node: Setting amounts291594
Ref: #setting-amounts291751
Node: Amount signs294192
Ref: #amount-signs294346
Node: Setting currency/commodity295033
Ref: #setting-currencycommodity295221
Node: Amount decimal places296395
Ref: #amount-decimal-places296587
Node: Referencing other fields296899
Ref: #referencing-other-fields297098
Node: How CSV rules are evaluated297995
Ref: #how-csv-rules-are-evaluated298170
Node: TIMECLOCK FORMAT299621
Ref: #timeclock-format299761
Node: TIMEDOT FORMAT301822
Ref: #timedot-format301960
Node: COMMON TASKS306522
Ref: #common-tasks306651
Node: Getting help307058
Ref: #getting-help307192
Node: Constructing command lines307745
Ref: #constructing-command-lines307939
Node: Starting a journal file308636
Ref: #starting-a-journal-file308836
Node: Setting opening balances310024
Ref: #setting-opening-balances310222
Node: Recording transactions313363
Ref: #recording-transactions313545
Node: Reconciling314101
Ref: #reconciling314246
Node: Reporting316503
Ref: #reporting316645
Node: Migrating to a new file320644
Ref: #migrating-to-a-new-file320794
Node: LIMITATIONS321093
Ref: #limitations321221
Node: TROUBLESHOOTING321964
Ref: #troubleshooting322079
Node: Directives and multiple files216081
Ref: #directives-and-multiple-files216277
Node: Comment blocks216969
Ref: #comment-blocks217146
Node: Including other files217322
Ref: #including-other-files217496
Node: Default year218420
Ref: #default-year218578
Node: Declaring payees218985
Ref: #declaring-payees219156
Node: Declaring the decimal mark219402
Ref: #declaring-the-decimal-mark219602
Node: Declaring commodities219999
Ref: #declaring-commodities220190
Node: Commodity error checking222708
Ref: #commodity-error-checking222858
Node: Default commodity223115
Ref: #default-commodity223295
Node: Declaring market prices224411
Ref: #declaring-market-prices224600
Node: Declaring accounts225413
Ref: #declaring-accounts225593
Node: Account error checking226795
Ref: #account-error-checking226961
Node: Account comments228140
Ref: #account-comments228324
Node: Account subdirectives228748
Ref: #account-subdirectives228933
Node: Account types229246
Ref: #account-types229420
Node: Declaring account types230078
Ref: #declaring-account-types230257
Node: Auto-detected account types231311
Ref: #auto-detected-account-types231498
Node: Account display order233516
Ref: #account-display-order233676
Node: Rewriting accounts234827
Ref: #rewriting-accounts235006
Node: Basic aliases235763
Ref: #basic-aliases235899
Node: Regex aliases236643
Ref: #regex-aliases236805
Node: Combining aliases237524
Ref: #combining-aliases237707
Node: Aliases and multiple files238983
Ref: #aliases-and-multiple-files239182
Node: end aliases239761
Ref: #end-aliases239908
Node: Default parent account240057
Ref: #default-parent-account240247
Node: Periodic transactions241131
Ref: #periodic-transactions241314
Node: Periodic rule syntax243231
Ref: #periodic-rule-syntax243431
Node: Two spaces between period expression and description!244135
Ref: #two-spaces-between-period-expression-and-description244448
Node: Forecasting with periodic transactions245132
Ref: #forecasting-with-periodic-transactions245431
Node: Budgeting with periodic transactions248202
Ref: #budgeting-with-periodic-transactions248435
Node: Auto postings248844
Ref: #auto-postings248980
Node: Auto postings and multiple files251159
Ref: #auto-postings-and-multiple-files251357
Node: Auto postings and dates251566
Ref: #auto-postings-and-dates251834
Node: Auto postings and transaction balancing / inferred amounts / balance assertions252009
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions252354
Node: Auto posting tags252857
Ref: #auto-posting-tags253066
Node: CSV FORMAT253702
Ref: #csv-format253830
Node: Examples256459
Ref: #examples256562
Node: Basic256770
Ref: #basic256872
Node: Bank of Ireland257414
Ref: #bank-of-ireland257551
Node: Amazon259013
Ref: #amazon259133
Node: Paypal260852
Ref: #paypal260948
Node: CSV rules268592
Ref: #csv-rules268710
Node: skip269043
Ref: #skip269143
Node: fields list269518
Ref: #fields-list269657
Node: field assignment271160
Ref: #field-assignment271312
Node: Field names272347
Ref: #field-names272487
Node: date field272867
Ref: #date-field272987
Node: date2 field273035
Ref: #date2-field273178
Node: status field273234
Ref: #status-field273379
Node: code field273428
Ref: #code-field273575
Node: description field273620
Ref: #description-field273782
Node: comment field273841
Ref: #comment-field273998
Node: account field274298
Ref: #account-field274450
Node: amount field275025
Ref: #amount-field275176
Node: currency field276421
Ref: #currency-field276576
Node: balance field276833
Ref: #balance-field276967
Node: separator277339
Ref: #separator277471
Node: if block278011
Ref: #if-block278138
Node: Matching the whole record278539
Ref: #matching-the-whole-record278716
Node: Matching individual fields279519
Ref: #matching-individual-fields279725
Node: Combining matchers279949
Ref: #combining-matchers280147
Node: Rules applied on successful match280460
Ref: #rules-applied-on-successful-match280653
Node: if table281307
Ref: #if-table281428
Node: end283166
Ref: #end283280
Node: date-format283504
Ref: #date-format283638
Node: decimal-mark284634
Ref: #decimal-mark284781
Node: newest-first285120
Ref: #newest-first285263
Node: include285946
Ref: #include286079
Node: balance-type286523
Ref: #balance-type286645
Node: Tips287345
Ref: #tips287436
Node: Rapid feedback287735
Ref: #rapid-feedback287854
Node: Valid CSV288306
Ref: #valid-csv288438
Node: File Extension288630
Ref: #file-extension288784
Node: Reading multiple CSV files289213
Ref: #reading-multiple-csv-files289400
Node: Valid transactions289641
Ref: #valid-transactions289821
Node: Deduplicating importing290449
Ref: #deduplicating-importing290630
Node: Setting amounts291663
Ref: #setting-amounts291820
Node: Amount signs294261
Ref: #amount-signs294415
Node: Setting currency/commodity295102
Ref: #setting-currencycommodity295290
Node: Amount decimal places296464
Ref: #amount-decimal-places296656
Node: Referencing other fields296968
Ref: #referencing-other-fields297167
Node: How CSV rules are evaluated298064
Ref: #how-csv-rules-are-evaluated298239
Node: TIMECLOCK FORMAT299690
Ref: #timeclock-format299830
Node: TIMEDOT FORMAT301891
Ref: #timedot-format302029
Node: COMMON TASKS306591
Ref: #common-tasks306720
Node: Getting help307127
Ref: #getting-help307261
Node: Constructing command lines307814
Ref: #constructing-command-lines308008
Node: Starting a journal file308705
Ref: #starting-a-journal-file308905
Node: Setting opening balances310093
Ref: #setting-opening-balances310291
Node: Recording transactions313432
Ref: #recording-transactions313614
Node: Reconciling314170
Ref: #reconciling314315
Node: Reporting316572
Ref: #reporting316714
Node: Migrating to a new file320713
Ref: #migrating-to-a-new-file320863
Node: LIMITATIONS321162
Ref: #limitations321290
Node: TROUBLESHOOTING322033
Ref: #troubleshooting322148

End Tag Table

View File

@ -4865,8 +4865,9 @@ JOURNAL FORMAT
bol side and spacing, digit groups, decimal mark, and number of deci-
mal places.
Here are all the directives and their precise effects, with links to
more detailed docs below:
Directives are not required when starting out with hledger, but you
will probably add some as your needs grow. Here are all the directives
and their precise effects:
direc- effects ends
@ -4919,27 +4920,26 @@ JOURNAL FORMAT
ilar effect
-----------------------------------------------------------------------------
READING/GENERATING DATA:
Declaring a commodity's or commodity, D, decimal-
file's decimal mark to help mark
parse amounts accurately
Applying changes to the data alias, apply account, --alias
while parsing comment, D, Y
Inlining or concatenating extra include multiple
Declare a commodity's or file's commodity, D, decimal-
decimal mark to help parse mark
amounts accurately
Apply changes to the data while alias, apply account, --alias
parsing comment, D, Y
Inline or concatenate extra include multiple
data files -f/--file's
Generating extra transactions ~
or budget goals
Generating extra postings =
Generate extra transactions or ~
budget goals
Generate extra postings =
CHECKING FOR ERRORS:
Defining valid entities to account, commodity,
allow stricter error checking payee
Define valid entities to allow account, commodity,
stricter error checking payee
DISPLAYING REPORTS:
Defining accounts' display account
order and accounting type
Defining commodity display commodity, D -c/--commodity-
Declare accounts' display order account
and accounting type
Declare commodity display commodity, D -c/--commodity-
styles style
Directives and multiple files
If you use multiple -f/--file options, or the include directive,
hledger will process multiple input files. But directives which affect