;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 output: symbol side and spacing, digit groups, decimal mark, and number
of decimal places. of decimal places.
.PP .PP
Here are all the directives and their precise effects, with links to Directives are not required when starting out with hledger, but you will
more detailed docs below: probably add some as your needs grow.
Here are all the directives and their precise effects:
.PP .PP
.TS .TS
tab(@); tab(@);
@ -6817,7 +6818,7 @@ And here is an overview of which directives are useful for what:
.PP .PP
.TS .TS
tab(@); tab(@);
lw(31.0n) lw(21.8n) lw(17.2n). lw(30.6n) lw(22.0n) lw(17.4n).
T{ T{
purpose purpose
T}@T{ T}@T{
@ -6832,14 +6833,14 @@ T}@T{
T}@T{ 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 amounts accurately
T}@T{ T}@T{
\f[C]commodity\f[R], \f[C]D\f[R], \f[C]decimal-mark\f[R] \f[C]commodity\f[R], \f[C]D\f[R], \f[C]decimal-mark\f[R]
T}@T{ T}@T{
T} T}
T{ T{
Applying changes to the data while parsing Apply changes to the data while parsing
T}@T{ T}@T{
\f[C]alias\f[R], \f[C]apply account\f[R], \f[C]comment\f[R], \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] \f[C]D\f[R], \f[C]Y\f[R]
@ -6847,20 +6848,20 @@ T}@T{
\f[C]--alias\f[R] \f[C]--alias\f[R]
T} T}
T{ T{
Inlining or concatenating extra data files Inline or concatenate extra data files
T}@T{ T}@T{
\f[C]include\f[R] \f[C]include\f[R]
T}@T{ T}@T{
multiple \f[C]-f/--file\f[R]\[aq]s multiple \f[C]-f/--file\f[R]\[aq]s
T} T}
T{ T{
Generating extra transactions or budget goals Generate extra transactions or budget goals
T}@T{ T}@T{
\f[C]\[ti]\f[R] \f[C]\[ti]\f[R]
T}@T{ T}@T{
T} T}
T{ T{
Generating extra postings Generate extra postings
T}@T{ T}@T{
\f[C]=\f[R] \f[C]=\f[R]
T}@T{ T}@T{
@ -6871,7 +6872,7 @@ T}@T{
T}@T{ T}@T{
T} T}
T{ T{
Defining valid entities to allow stricter error checking Define valid entities to allow stricter error checking
T}@T{ T}@T{
\f[C]account\f[R], \f[C]commodity\f[R], \f[C]payee\f[R] \f[C]account\f[R], \f[C]commodity\f[R], \f[C]payee\f[R]
T}@T{ T}@T{
@ -6882,22 +6883,18 @@ T}@T{
T}@T{ T}@T{
T} T}
T{ T{
Defining accounts\[aq] display order and accounting type Declare accounts\[aq] display order and accounting type
T}@T{ T}@T{
\f[C]account\f[R] \f[C]account\f[R]
T}@T{ T}@T{
T} T}
T{ T{
Defining commodity display styles Declare 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{
\f[C]-c/--commodity-style\f[R] \f[C]-c/--commodity-style\f[R]
T} T}
T{
T}@T{
T}@T{
T}
.TE .TE
.SS Directives and multiple files .SS Directives and multiple files
.PP .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 symbol side and spacing, digit groups, decimal mark, and number of
decimal places. decimal places.
Here are all the directives and their precise effects, with links to Directives are not required when starting out with hledger, but you
more detailed docs below: will probably add some as your needs grow. Here are all the directives
and their precise effects:
directiveeffects ends directiveeffects ends
at at
@ -5866,24 +5867,24 @@ purpose directives command line
similar effect similar effect
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
*READING/GENERATING DATA:* *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' file's decimal mark to help 'decimal-mark'
parse amounts accurately parse amounts accurately
Applying changes to the data 'alias', 'apply '--alias' Apply changes to the data 'alias', 'apply '--alias'
while parsing account', 'comment', while parsing account', 'comment',
'D', 'Y' 'D', 'Y'
Inlining or concatenating 'include' multiple Inline or concatenate extra 'include' multiple
extra data files '-f/--file''s data files '-f/--file''s
Generating extra transactions '~' Generate extra transactions or '~'
or budget goals budget goals
Generating extra postings '=' Generate extra postings '='
*CHECKING FOR ERRORS:* *CHECKING FOR ERRORS:*
Defining valid entities to 'account', Define valid entities to allow 'account',
allow stricter error checking 'commodity', 'payee' stricter error checking 'commodity', 'payee'
*DISPLAYING REPORTS:* *DISPLAYING REPORTS:*
Defining accounts' display 'account' Declare accounts' display 'account'
order and accounting type order and accounting type
Defining commodity display 'commodity', 'D' '-c/--commodity-style' Declare commodity display 'commodity', 'D' '-c/--commodity-style'
styles styles
 
@ -9336,196 +9337,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 files216012 Node: Directives and multiple files216081
Ref: #directives-and-multiple-files216208 Ref: #directives-and-multiple-files216277
Node: Comment blocks216900 Node: Comment blocks216969
Ref: #comment-blocks217077 Ref: #comment-blocks217146
Node: Including other files217253 Node: Including other files217322
Ref: #including-other-files217427 Ref: #including-other-files217496
Node: Default year218351 Node: Default year218420
Ref: #default-year218509 Ref: #default-year218578
Node: Declaring payees218916 Node: Declaring payees218985
Ref: #declaring-payees219087 Ref: #declaring-payees219156
Node: Declaring the decimal mark219333 Node: Declaring the decimal mark219402
Ref: #declaring-the-decimal-mark219533 Ref: #declaring-the-decimal-mark219602
Node: Declaring commodities219930 Node: Declaring commodities219999
Ref: #declaring-commodities220121 Ref: #declaring-commodities220190
Node: Commodity error checking222639 Node: Commodity error checking222708
Ref: #commodity-error-checking222789 Ref: #commodity-error-checking222858
Node: Default commodity223046 Node: Default commodity223115
Ref: #default-commodity223226 Ref: #default-commodity223295
Node: Declaring market prices224342 Node: Declaring market prices224411
Ref: #declaring-market-prices224531 Ref: #declaring-market-prices224600
Node: Declaring accounts225344 Node: Declaring accounts225413
Ref: #declaring-accounts225524 Ref: #declaring-accounts225593
Node: Account error checking226726 Node: Account error checking226795
Ref: #account-error-checking226892 Ref: #account-error-checking226961
Node: Account comments228071 Node: Account comments228140
Ref: #account-comments228255 Ref: #account-comments228324
Node: Account subdirectives228679 Node: Account subdirectives228748
Ref: #account-subdirectives228864 Ref: #account-subdirectives228933
Node: Account types229177 Node: Account types229246
Ref: #account-types229351 Ref: #account-types229420
Node: Declaring account types230009 Node: Declaring account types230078
Ref: #declaring-account-types230188 Ref: #declaring-account-types230257
Node: Auto-detected account types231242 Node: Auto-detected account types231311
Ref: #auto-detected-account-types231429 Ref: #auto-detected-account-types231498
Node: Account display order233447 Node: Account display order233516
Ref: #account-display-order233607 Ref: #account-display-order233676
Node: Rewriting accounts234758 Node: Rewriting accounts234827
Ref: #rewriting-accounts234937 Ref: #rewriting-accounts235006
Node: Basic aliases235694 Node: Basic aliases235763
Ref: #basic-aliases235830 Ref: #basic-aliases235899
Node: Regex aliases236574 Node: Regex aliases236643
Ref: #regex-aliases236736 Ref: #regex-aliases236805
Node: Combining aliases237455 Node: Combining aliases237524
Ref: #combining-aliases237638 Ref: #combining-aliases237707
Node: Aliases and multiple files238914 Node: Aliases and multiple files238983
Ref: #aliases-and-multiple-files239113 Ref: #aliases-and-multiple-files239182
Node: end aliases239692 Node: end aliases239761
Ref: #end-aliases239839 Ref: #end-aliases239908
Node: Default parent account239988 Node: Default parent account240057
Ref: #default-parent-account240178 Ref: #default-parent-account240247
Node: Periodic transactions241062 Node: Periodic transactions241131
Ref: #periodic-transactions241245 Ref: #periodic-transactions241314
Node: Periodic rule syntax243162 Node: Periodic rule syntax243231
Ref: #periodic-rule-syntax243362 Ref: #periodic-rule-syntax243431
Node: Two spaces between period expression and description!244066 Node: Two spaces between period expression and description!244135
Ref: #two-spaces-between-period-expression-and-description244379 Ref: #two-spaces-between-period-expression-and-description244448
Node: Forecasting with periodic transactions245063 Node: Forecasting with periodic transactions245132
Ref: #forecasting-with-periodic-transactions245362 Ref: #forecasting-with-periodic-transactions245431
Node: Budgeting with periodic transactions248133 Node: Budgeting with periodic transactions248202
Ref: #budgeting-with-periodic-transactions248366 Ref: #budgeting-with-periodic-transactions248435
Node: Auto postings248775 Node: Auto postings248844
Ref: #auto-postings248911 Ref: #auto-postings248980
Node: Auto postings and multiple files251090 Node: Auto postings and multiple files251159
Ref: #auto-postings-and-multiple-files251288 Ref: #auto-postings-and-multiple-files251357
Node: Auto postings and dates251497 Node: Auto postings and dates251566
Ref: #auto-postings-and-dates251765 Ref: #auto-postings-and-dates251834
Node: Auto postings and transaction balancing / inferred amounts / balance assertions251940 Node: Auto postings and transaction balancing / inferred amounts / balance assertions252009
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions252285 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions252354
Node: Auto posting tags252788 Node: Auto posting tags252857
Ref: #auto-posting-tags252997 Ref: #auto-posting-tags253066
Node: CSV FORMAT253633 Node: CSV FORMAT253702
Ref: #csv-format253761 Ref: #csv-format253830
Node: Examples256390 Node: Examples256459
Ref: #examples256493 Ref: #examples256562
Node: Basic256701 Node: Basic256770
Ref: #basic256803 Ref: #basic256872
Node: Bank of Ireland257345 Node: Bank of Ireland257414
Ref: #bank-of-ireland257482 Ref: #bank-of-ireland257551
Node: Amazon258944 Node: Amazon259013
Ref: #amazon259064 Ref: #amazon259133
Node: Paypal260783 Node: Paypal260852
Ref: #paypal260879 Ref: #paypal260948
Node: CSV rules268523 Node: CSV rules268592
Ref: #csv-rules268641 Ref: #csv-rules268710
Node: skip268974 Node: skip269043
Ref: #skip269074 Ref: #skip269143
Node: fields list269449 Node: fields list269518
Ref: #fields-list269588 Ref: #fields-list269657
Node: field assignment271091 Node: field assignment271160
Ref: #field-assignment271243 Ref: #field-assignment271312
Node: Field names272278 Node: Field names272347
Ref: #field-names272418 Ref: #field-names272487
Node: date field272798 Node: date field272867
Ref: #date-field272918 Ref: #date-field272987
Node: date2 field272966 Node: date2 field273035
Ref: #date2-field273109 Ref: #date2-field273178
Node: status field273165 Node: status field273234
Ref: #status-field273310 Ref: #status-field273379
Node: code field273359 Node: code field273428
Ref: #code-field273506 Ref: #code-field273575
Node: description field273551 Node: description field273620
Ref: #description-field273713 Ref: #description-field273782
Node: comment field273772 Node: comment field273841
Ref: #comment-field273929 Ref: #comment-field273998
Node: account field274229 Node: account field274298
Ref: #account-field274381 Ref: #account-field274450
Node: amount field274956 Node: amount field275025
Ref: #amount-field275107 Ref: #amount-field275176
Node: currency field276352 Node: currency field276421
Ref: #currency-field276507 Ref: #currency-field276576
Node: balance field276764 Node: balance field276833
Ref: #balance-field276898 Ref: #balance-field276967
Node: separator277270 Node: separator277339
Ref: #separator277402 Ref: #separator277471
Node: if block277942 Node: if block278011
Ref: #if-block278069 Ref: #if-block278138
Node: Matching the whole record278470 Node: Matching the whole record278539
Ref: #matching-the-whole-record278647 Ref: #matching-the-whole-record278716
Node: Matching individual fields279450 Node: Matching individual fields279519
Ref: #matching-individual-fields279656 Ref: #matching-individual-fields279725
Node: Combining matchers279880 Node: Combining matchers279949
Ref: #combining-matchers280078 Ref: #combining-matchers280147
Node: Rules applied on successful match280391 Node: Rules applied on successful match280460
Ref: #rules-applied-on-successful-match280584 Ref: #rules-applied-on-successful-match280653
Node: if table281238 Node: if table281307
Ref: #if-table281359 Ref: #if-table281428
Node: end283097 Node: end283166
Ref: #end283211 Ref: #end283280
Node: date-format283435 Node: date-format283504
Ref: #date-format283569 Ref: #date-format283638
Node: decimal-mark284565 Node: decimal-mark284634
Ref: #decimal-mark284712 Ref: #decimal-mark284781
Node: newest-first285051 Node: newest-first285120
Ref: #newest-first285194 Ref: #newest-first285263
Node: include285877 Node: include285946
Ref: #include286010 Ref: #include286079
Node: balance-type286454 Node: balance-type286523
Ref: #balance-type286576 Ref: #balance-type286645
Node: Tips287276 Node: Tips287345
Ref: #tips287367 Ref: #tips287436
Node: Rapid feedback287666 Node: Rapid feedback287735
Ref: #rapid-feedback287785 Ref: #rapid-feedback287854
Node: Valid CSV288237 Node: Valid CSV288306
Ref: #valid-csv288369 Ref: #valid-csv288438
Node: File Extension288561 Node: File Extension288630
Ref: #file-extension288715 Ref: #file-extension288784
Node: Reading multiple CSV files289144 Node: Reading multiple CSV files289213
Ref: #reading-multiple-csv-files289331 Ref: #reading-multiple-csv-files289400
Node: Valid transactions289572 Node: Valid transactions289641
Ref: #valid-transactions289752 Ref: #valid-transactions289821
Node: Deduplicating importing290380 Node: Deduplicating importing290449
Ref: #deduplicating-importing290561 Ref: #deduplicating-importing290630
Node: Setting amounts291594 Node: Setting amounts291663
Ref: #setting-amounts291751 Ref: #setting-amounts291820
Node: Amount signs294192 Node: Amount signs294261
Ref: #amount-signs294346 Ref: #amount-signs294415
Node: Setting currency/commodity295033 Node: Setting currency/commodity295102
Ref: #setting-currencycommodity295221 Ref: #setting-currencycommodity295290
Node: Amount decimal places296395 Node: Amount decimal places296464
Ref: #amount-decimal-places296587 Ref: #amount-decimal-places296656
Node: Referencing other fields296899 Node: Referencing other fields296968
Ref: #referencing-other-fields297098 Ref: #referencing-other-fields297167
Node: How CSV rules are evaluated297995 Node: How CSV rules are evaluated298064
Ref: #how-csv-rules-are-evaluated298170 Ref: #how-csv-rules-are-evaluated298239
Node: TIMECLOCK FORMAT299621 Node: TIMECLOCK FORMAT299690
Ref: #timeclock-format299761 Ref: #timeclock-format299830
Node: TIMEDOT FORMAT301822 Node: TIMEDOT FORMAT301891
Ref: #timedot-format301960 Ref: #timedot-format302029
Node: COMMON TASKS306522 Node: COMMON TASKS306591
Ref: #common-tasks306651 Ref: #common-tasks306720
Node: Getting help307058 Node: Getting help307127
Ref: #getting-help307192 Ref: #getting-help307261
Node: Constructing command lines307745 Node: Constructing command lines307814
Ref: #constructing-command-lines307939 Ref: #constructing-command-lines308008
Node: Starting a journal file308636 Node: Starting a journal file308705
Ref: #starting-a-journal-file308836 Ref: #starting-a-journal-file308905
Node: Setting opening balances310024 Node: Setting opening balances310093
Ref: #setting-opening-balances310222 Ref: #setting-opening-balances310291
Node: Recording transactions313363 Node: Recording transactions313432
Ref: #recording-transactions313545 Ref: #recording-transactions313614
Node: Reconciling314101 Node: Reconciling314170
Ref: #reconciling314246 Ref: #reconciling314315
Node: Reporting316503 Node: Reporting316572
Ref: #reporting316645 Ref: #reporting316714
Node: Migrating to a new file320644 Node: Migrating to a new file320713
Ref: #migrating-to-a-new-file320794 Ref: #migrating-to-a-new-file320863
Node: LIMITATIONS321093 Node: LIMITATIONS321162
Ref: #limitations321221 Ref: #limitations321290
Node: TROUBLESHOOTING321964 Node: TROUBLESHOOTING322033
Ref: #troubleshooting322079 Ref: #troubleshooting322148
 
End Tag Table End Tag Table

File diff suppressed because it is too large Load Diff