slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2021-11-21 23:52:17 -10:00
parent 508b180b63
commit df472b6cc5
3 changed files with 809 additions and 808 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

168
hledger/hledger.1
View File

@ -6691,7 +6691,90 @@ of decimal places.
.PP .PP
Directives are not required when starting out with hledger, but you will Directives are not required when starting out with hledger, but you will
probably add some as your needs grow. probably add some as your needs grow.
Here are all the directives and their precise effects: Here is an overview of directives by purpose:
.PP
.TS
tab(@);
lw(30.6n) lw(22.0n) lw(17.4n).
T{
purpose
T}@T{
directives
T}@T{
command line options with similar effect
T}
_
T{
\f[B]READING/GENERATING DATA:\f[R]
T}@T{
T}@T{
T}
T{
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{
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]
T}@T{
\f[C]--alias\f[R]
T}
T{
Inline extra data files
T}@T{
\f[C]include\f[R]
T}@T{
multiple \f[C]-f/--file\f[R]\[aq]s
T}
T{
Generate extra transactions or budget goals
T}@T{
\f[C]\[ti]\f[R]
T}@T{
T}
T{
Generate extra postings
T}@T{
\f[C]=\f[R]
T}@T{
T}
T{
\f[B]CHECKING FOR ERRORS:\f[R]
T}@T{
T}@T{
T}
T{
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{
T}
T{
\f[B]DISPLAYING REPORTS:\f[R]
T}@T{
T}@T{
T}
T{
Declare accounts\[aq] display order and accounting type
T}@T{
\f[C]account\f[R]
T}@T{
T}
T{
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}
.TE
.PP
And here are all the directives and their precise effects:
.PP .PP
.TS .TS
tab(@); tab(@);
@ -6813,89 +6896,6 @@ T}@T{
partly partly
T} T}
.TE .TE
.PP
And here is an overview of which directives are useful for what:
.PP
.TS
tab(@);
lw(30.6n) lw(22.0n) lw(17.4n).
T{
purpose
T}@T{
directives
T}@T{
command line options with similar effect
T}
_
T{
\f[B]READING/GENERATING DATA:\f[R]
T}@T{
T}@T{
T}
T{
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{
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]
T}@T{
\f[C]--alias\f[R]
T}
T{
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{
Generate extra transactions or budget goals
T}@T{
\f[C]\[ti]\f[R]
T}@T{
T}
T{
Generate extra postings
T}@T{
\f[C]=\f[R]
T}@T{
T}
T{
\f[B]CHECKING FOR ERRORS:\f[R]
T}@T{
T}@T{
T}
T{
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{
T}
T{
\f[B]DISPLAYING REPORTS:\f[R]
T}@T{
T}@T{
T}
T{
Declare accounts\[aq] display order and accounting type
T}@T{
\f[C]account\f[R]
T}@T{
T}
T{
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}
.TE
.SS Directives and multiple files .SS Directives and multiple files
.PP .PP
If you use multiple \f[C]-f\f[R]/\f[C]--file\f[R] options, or the If you use multiple \f[C]-f\f[R]/\f[C]--file\f[R] options, or the

438
hledger/hledger.info
View File

@ -5815,8 +5815,35 @@ hledger versions. Here are some more definitions:
decimal places. decimal places.
Directives are not required when starting out with hledger, but you Directives are not required when starting out with hledger, but you
will probably add some as your needs grow. Here are all the directives will probably add some as your needs grow. Here is an overview of
and their precise effects: directives by purpose:
purpose directives command line
options with
similar effect
---------------------------------------------------------------------------
*READING/GENERATING DATA:*
Declare a commodity's or 'commodity', 'D',
file's decimal mark to help 'decimal-mark'
parse amounts accurately
Apply changes to the data 'alias', 'apply '--alias'
while parsing account', 'comment',
'D', 'Y'
Inline extra data files 'include' multiple
'-f/--file''s
Generate extra transactions or '~'
budget goals
Generate extra postings '='
*CHECKING FOR ERRORS:*
Define valid entities to allow 'account',
stricter error checking 'commodity', 'payee'
*DISPLAYING REPORTS:*
Declare accounts' display 'account'
order and accounting type
Declare commodity display 'commodity', 'D' '-c/--commodity-style'
styles
And here are all the directives and their precise effects:
directiveeffects ends directiveeffects ends
at at
@ -5860,33 +5887,6 @@ account'*following entries until end of current file or 'end apply
(equals)on matched transactions with '--auto', in current, parent, (equals)on matched transactions with '--auto', in current, parent,
and child 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:
purpose directives command line
options with
similar effect
---------------------------------------------------------------------------
*READING/GENERATING DATA:*
Declare a commodity's or 'commodity', 'D',
file's decimal mark to help 'decimal-mark'
parse amounts accurately
Apply changes to the data 'alias', 'apply '--alias'
while parsing account', 'comment',
'D', 'Y'
Inline or concatenate extra 'include' multiple
data files '-f/--file''s
Generate extra transactions or '~'
budget goals
Generate extra postings '='
*CHECKING FOR ERRORS:*
Define valid entities to allow 'account',
stricter error checking 'commodity', 'payee'
*DISPLAYING REPORTS:*
Declare accounts' display 'account'
order and accounting type
Declare commodity display 'commodity', 'D' '-c/--commodity-style'
styles
 
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
@ -9337,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 files216081 Node: Directives and multiple files216066
Ref: #directives-and-multiple-files216277 Ref: #directives-and-multiple-files216262
Node: Comment blocks216969 Node: Comment blocks216954
Ref: #comment-blocks217146 Ref: #comment-blocks217131
Node: Including other files217322 Node: Including other files217307
Ref: #including-other-files217496 Ref: #including-other-files217481
Node: Default year218420 Node: Default year218405
Ref: #default-year218578 Ref: #default-year218563
Node: Declaring payees218985 Node: Declaring payees218970
Ref: #declaring-payees219156 Ref: #declaring-payees219141
Node: Declaring the decimal mark219402 Node: Declaring the decimal mark219387
Ref: #declaring-the-decimal-mark219602 Ref: #declaring-the-decimal-mark219587
Node: Declaring commodities219999 Node: Declaring commodities219984
Ref: #declaring-commodities220190 Ref: #declaring-commodities220175
Node: Commodity error checking222708 Node: Commodity error checking222693
Ref: #commodity-error-checking222858 Ref: #commodity-error-checking222843
Node: Default commodity223115 Node: Default commodity223100
Ref: #default-commodity223295 Ref: #default-commodity223280
Node: Declaring market prices224411 Node: Declaring market prices224396
Ref: #declaring-market-prices224600 Ref: #declaring-market-prices224585
Node: Declaring accounts225413 Node: Declaring accounts225398
Ref: #declaring-accounts225593 Ref: #declaring-accounts225578
Node: Account error checking226795 Node: Account error checking226780
Ref: #account-error-checking226961 Ref: #account-error-checking226946
Node: Account comments228140 Node: Account comments228125
Ref: #account-comments228324 Ref: #account-comments228309
Node: Account subdirectives228748 Node: Account subdirectives228733
Ref: #account-subdirectives228933 Ref: #account-subdirectives228918
Node: Account types229246 Node: Account types229231
Ref: #account-types229420 Ref: #account-types229405
Node: Declaring account types230078 Node: Declaring account types230063
Ref: #declaring-account-types230257 Ref: #declaring-account-types230242
Node: Auto-detected account types231311 Node: Auto-detected account types231296
Ref: #auto-detected-account-types231498 Ref: #auto-detected-account-types231483
Node: Account display order233516 Node: Account display order233501
Ref: #account-display-order233676 Ref: #account-display-order233661
Node: Rewriting accounts234827 Node: Rewriting accounts234812
Ref: #rewriting-accounts235006 Ref: #rewriting-accounts234991
Node: Basic aliases235763 Node: Basic aliases235748
Ref: #basic-aliases235899 Ref: #basic-aliases235884
Node: Regex aliases236643 Node: Regex aliases236628
Ref: #regex-aliases236805 Ref: #regex-aliases236790
Node: Combining aliases237524 Node: Combining aliases237509
Ref: #combining-aliases237707 Ref: #combining-aliases237692
Node: Aliases and multiple files238983 Node: Aliases and multiple files238968
Ref: #aliases-and-multiple-files239182 Ref: #aliases-and-multiple-files239167
Node: end aliases239761 Node: end aliases239746
Ref: #end-aliases239908 Ref: #end-aliases239893
Node: Default parent account240057 Node: Default parent account240042
Ref: #default-parent-account240247 Ref: #default-parent-account240232
Node: Periodic transactions241131 Node: Periodic transactions241116
Ref: #periodic-transactions241314 Ref: #periodic-transactions241299
Node: Periodic rule syntax243231 Node: Periodic rule syntax243216
Ref: #periodic-rule-syntax243431 Ref: #periodic-rule-syntax243416
Node: Two spaces between period expression and description!244135 Node: Two spaces between period expression and description!244120
Ref: #two-spaces-between-period-expression-and-description244448 Ref: #two-spaces-between-period-expression-and-description244433
Node: Forecasting with periodic transactions245132 Node: Forecasting with periodic transactions245117
Ref: #forecasting-with-periodic-transactions245431 Ref: #forecasting-with-periodic-transactions245416
Node: Budgeting with periodic transactions248202 Node: Budgeting with periodic transactions248187
Ref: #budgeting-with-periodic-transactions248435 Ref: #budgeting-with-periodic-transactions248420
Node: Auto postings248844 Node: Auto postings248829
Ref: #auto-postings248980 Ref: #auto-postings248965
Node: Auto postings and multiple files251159 Node: Auto postings and multiple files251144
Ref: #auto-postings-and-multiple-files251357 Ref: #auto-postings-and-multiple-files251342
Node: Auto postings and dates251566 Node: Auto postings and dates251551
Ref: #auto-postings-and-dates251834 Ref: #auto-postings-and-dates251819
Node: Auto postings and transaction balancing / inferred amounts / balance assertions252009 Node: Auto postings and transaction balancing / inferred amounts / balance assertions251994
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions252354 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions252339
Node: Auto posting tags252857 Node: Auto posting tags252842
Ref: #auto-posting-tags253066 Ref: #auto-posting-tags253051
Node: CSV FORMAT253702 Node: CSV FORMAT253687
Ref: #csv-format253830 Ref: #csv-format253815
Node: Examples256459 Node: Examples256444
Ref: #examples256562 Ref: #examples256547
Node: Basic256770 Node: Basic256755
Ref: #basic256872 Ref: #basic256857
Node: Bank of Ireland257414 Node: Bank of Ireland257399
Ref: #bank-of-ireland257551 Ref: #bank-of-ireland257536
Node: Amazon259013 Node: Amazon258998
Ref: #amazon259133 Ref: #amazon259118
Node: Paypal260852 Node: Paypal260837
Ref: #paypal260948 Ref: #paypal260933
Node: CSV rules268592 Node: CSV rules268577
Ref: #csv-rules268710 Ref: #csv-rules268695
Node: skip269043 Node: skip269028
Ref: #skip269143 Ref: #skip269128
Node: fields list269518 Node: fields list269503
Ref: #fields-list269657 Ref: #fields-list269642
Node: field assignment271160 Node: field assignment271145
Ref: #field-assignment271312 Ref: #field-assignment271297
Node: Field names272347 Node: Field names272332
Ref: #field-names272487 Ref: #field-names272472
Node: date field272867 Node: date field272852
Ref: #date-field272987 Ref: #date-field272972
Node: date2 field273035 Node: date2 field273020
Ref: #date2-field273178 Ref: #date2-field273163
Node: status field273234 Node: status field273219
Ref: #status-field273379 Ref: #status-field273364
Node: code field273428 Node: code field273413
Ref: #code-field273575 Ref: #code-field273560
Node: description field273620 Node: description field273605
Ref: #description-field273782 Ref: #description-field273767
Node: comment field273841 Node: comment field273826
Ref: #comment-field273998 Ref: #comment-field273983
Node: account field274298 Node: account field274283
Ref: #account-field274450 Ref: #account-field274435
Node: amount field275025 Node: amount field275010
Ref: #amount-field275176 Ref: #amount-field275161
Node: currency field276421 Node: currency field276406
Ref: #currency-field276576 Ref: #currency-field276561
Node: balance field276833 Node: balance field276818
Ref: #balance-field276967 Ref: #balance-field276952
Node: separator277339 Node: separator277324
Ref: #separator277471 Ref: #separator277456
Node: if block278011 Node: if block277996
Ref: #if-block278138 Ref: #if-block278123
Node: Matching the whole record278539 Node: Matching the whole record278524
Ref: #matching-the-whole-record278716 Ref: #matching-the-whole-record278701
Node: Matching individual fields279519 Node: Matching individual fields279504
Ref: #matching-individual-fields279725 Ref: #matching-individual-fields279710
Node: Combining matchers279949 Node: Combining matchers279934
Ref: #combining-matchers280147 Ref: #combining-matchers280132
Node: Rules applied on successful match280460 Node: Rules applied on successful match280445
Ref: #rules-applied-on-successful-match280653 Ref: #rules-applied-on-successful-match280638
Node: if table281307 Node: if table281292
Ref: #if-table281428 Ref: #if-table281413
Node: end283166 Node: end283151
Ref: #end283280 Ref: #end283265
Node: date-format283504 Node: date-format283489
Ref: #date-format283638 Ref: #date-format283623
Node: decimal-mark284634 Node: decimal-mark284619
Ref: #decimal-mark284781 Ref: #decimal-mark284766
Node: newest-first285120 Node: newest-first285105
Ref: #newest-first285263 Ref: #newest-first285248
Node: include285946 Node: include285931
Ref: #include286079 Ref: #include286064
Node: balance-type286523 Node: balance-type286508
Ref: #balance-type286645 Ref: #balance-type286630
Node: Tips287345 Node: Tips287330
Ref: #tips287436 Ref: #tips287421
Node: Rapid feedback287735 Node: Rapid feedback287720
Ref: #rapid-feedback287854 Ref: #rapid-feedback287839
Node: Valid CSV288306 Node: Valid CSV288291
Ref: #valid-csv288438 Ref: #valid-csv288423
Node: File Extension288630 Node: File Extension288615
Ref: #file-extension288784 Ref: #file-extension288769
Node: Reading multiple CSV files289213 Node: Reading multiple CSV files289198
Ref: #reading-multiple-csv-files289400 Ref: #reading-multiple-csv-files289385
Node: Valid transactions289641 Node: Valid transactions289626
Ref: #valid-transactions289821 Ref: #valid-transactions289806
Node: Deduplicating importing290449 Node: Deduplicating importing290434
Ref: #deduplicating-importing290630 Ref: #deduplicating-importing290615
Node: Setting amounts291663 Node: Setting amounts291648
Ref: #setting-amounts291820 Ref: #setting-amounts291805
Node: Amount signs294261 Node: Amount signs294246
Ref: #amount-signs294415 Ref: #amount-signs294400
Node: Setting currency/commodity295102 Node: Setting currency/commodity295087
Ref: #setting-currencycommodity295290 Ref: #setting-currencycommodity295275
Node: Amount decimal places296464 Node: Amount decimal places296449
Ref: #amount-decimal-places296656 Ref: #amount-decimal-places296641
Node: Referencing other fields296968 Node: Referencing other fields296953
Ref: #referencing-other-fields297167 Ref: #referencing-other-fields297152
Node: How CSV rules are evaluated298064 Node: How CSV rules are evaluated298049
Ref: #how-csv-rules-are-evaluated298239 Ref: #how-csv-rules-are-evaluated298224
Node: TIMECLOCK FORMAT299690 Node: TIMECLOCK FORMAT299675
Ref: #timeclock-format299830 Ref: #timeclock-format299815
Node: TIMEDOT FORMAT301891 Node: TIMEDOT FORMAT301876
Ref: #timedot-format302029 Ref: #timedot-format302014
Node: COMMON TASKS306591 Node: COMMON TASKS306576
Ref: #common-tasks306720 Ref: #common-tasks306705
Node: Getting help307127 Node: Getting help307112
Ref: #getting-help307261 Ref: #getting-help307246
Node: Constructing command lines307814 Node: Constructing command lines307799
Ref: #constructing-command-lines308008 Ref: #constructing-command-lines307993
Node: Starting a journal file308705 Node: Starting a journal file308690
Ref: #starting-a-journal-file308905 Ref: #starting-a-journal-file308890
Node: Setting opening balances310093 Node: Setting opening balances310078
Ref: #setting-opening-balances310291 Ref: #setting-opening-balances310276
Node: Recording transactions313432 Node: Recording transactions313417
Ref: #recording-transactions313614 Ref: #recording-transactions313599
Node: Reconciling314170 Node: Reconciling314155
Ref: #reconciling314315 Ref: #reconciling314300
Node: Reporting316572 Node: Reporting316557
Ref: #reporting316714 Ref: #reporting316699
Node: Migrating to a new file320713 Node: Migrating to a new file320698
Ref: #migrating-to-a-new-file320863 Ref: #migrating-to-a-new-file320848
Node: LIMITATIONS321162 Node: LIMITATIONS321147
Ref: #limitations321290 Ref: #limitations321275
Node: TROUBLESHOOTING322033 Node: TROUBLESHOOTING322018
Ref: #troubleshooting322148 Ref: #troubleshooting322133
 
End Tag Table End Tag Table

1011
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff