;doc: update manuals

This commit is contained in:
Simon Michael 2022-01-21 08:32:29 -10:00
parent fbf826a813
commit 41b68714ff
3 changed files with 618 additions and 582 deletions

View File

@ -5855,9 +5855,9 @@ Either search does not converge to a solution, or converges too slowly.
Examples: Examples:
.IP \[bu] 2 .IP \[bu] 2
Using roi to compute total return of investment in stocks: Using roi to compute total return of investment in stocks:
https://github.com/simonmichael/hledger/blob/master/examples/roi-unrealised.ledger https://github.com/simonmichael/hledger/blob/master/examples/investing/roi-unrealised.ledger
.IP \[bu] 2 .IP \[bu] 2
Cookbook -> Return on Investment Cookbook > Return on Investment: https://hledger.org/roi.html
.SS Spaces and special characters in \f[C]--inv\f[R] and \f[C]--pnl\f[R] .SS Spaces and special characters in \f[C]--inv\f[R] and \f[C]--pnl\f[R]
.PP .PP
Note that \f[C]--inv\f[R] and \f[C]--pnl\f[R]\[aq]s argument is a query, Note that \f[C]--inv\f[R] and \f[C]--pnl\f[R]\[aq]s argument is a query,
@ -6008,9 +6008,16 @@ unit\[dq].
Change in \[dq]unit price\[dq] over the reporting period gives you rate Change in \[dq]unit price\[dq] over the reporting period gives you rate
of return of your investment. of return of your investment.
.PP .PP
References: * Explanation of rate of return * Explanation of IRR * References:
Explanation of TWR * Examples of computing IRR and TWR and discussion of .IP \[bu] 2
the limitations of both metrics Explanation of rate of return
.IP \[bu] 2
Explanation of IRR
.IP \[bu] 2
Explanation of TWR
.IP \[bu] 2
Examples of computing IRR and TWR and discussion of the limitations of
both metrics
.SS stats .SS stats
.PP .PP
stats stats
@ -7602,6 +7609,12 @@ hledger will report an error if a commodity symbol is used that has not
been declared by a \f[C]commodity\f[R] directive. been declared by a \f[C]commodity\f[R] directive.
This works similarly to account error checking, see the notes there for This works similarly to account error checking, see the notes there for
more details. more details.
.PP
Note, this disallows amounts without a commodity symbol, because
currently it\[aq]s not possible (?) to declare the \[dq]no-symbol\[dq]
commodity with a directive.
This is one exception for convenience: zero amounts are always allowed
to have no commodity symbol.
.SS Default commodity .SS Default commodity
.PP .PP
The \f[C]D\f[R] directive sets a default commodity, to be used for any The \f[C]D\f[R] directive sets a default commodity, to be used for any

View File

@ -4888,9 +4888,9 @@ display, regardless of the length of reporting interval.
Examples: Examples:
* Using roi to compute total return of investment in stocks: * Using roi to compute total return of investment in stocks:
https://github.com/simonmichael/hledger/blob/master/examples/roi-unrealised.ledger https://github.com/simonmichael/hledger/blob/master/examples/investing/roi-unrealised.ledger
* Cookbook -> Return on Investment * Cookbook > Return on Investment: https://hledger.org/roi.html
* Menu: * Menu:
@ -5030,9 +5030,13 @@ and changes in its value change the value of "investment unit". Change
in "unit price" over the reporting period gives you rate of return of in "unit price" over the reporting period gives you rate of return of
your investment. your investment.
References: * Explanation of rate of return * Explanation of IRR * References:
Explanation of TWR * Examples of computing IRR and TWR and discussion of
the limitations of both metrics * Explanation of rate of return
* Explanation of IRR
* Explanation of TWR
* Examples of computing IRR and TWR and discussion of the limitations
of both metrics
 
File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS
@ -6436,6 +6440,11 @@ report an error if a commodity symbol is used that has not been declared
by a 'commodity' directive. This works similarly to account error by a 'commodity' directive. This works similarly to account error
checking, see the notes there for more details. checking, see the notes there for more details.
Note, this disallows amounts without a commodity symbol, because
currently it's not possible (?) to declare the "no-symbol" commodity
with a directive. This is one exception for convenience: zero amounts
are always allowed to have no commodity symbol.
 
File: hledger.info, Node: Default commodity, Next: Declaring market prices, Prev: Declaring commodities, Up: JOURNAL FORMAT File: hledger.info, Node: Default commodity, Next: Declaring market prices, Prev: Declaring commodities, Up: JOURNAL FORMAT
@ -9629,280 +9638,280 @@ Node: rewrite vs print --auto175863
Ref: #rewrite-vs.-print---auto176023 Ref: #rewrite-vs.-print---auto176023
Node: roi176579 Node: roi176579
Ref: #roi176679 Ref: #roi176679
Node: Spaces and special characters in --inv and --pnl178365 Node: Spaces and special characters in --inv and --pnl178404
Ref: #spaces-and-special-characters-in---inv-and---pnl178605 Ref: #spaces-and-special-characters-in---inv-and---pnl178644
Node: Semantics of --inv and --pnl179093 Node: Semantics of --inv and --pnl179132
Ref: #semantics-of---inv-and---pnl179332 Ref: #semantics-of---inv-and---pnl179371
Node: IRR and TWR explained181182 Node: IRR and TWR explained181221
Ref: #irr-and-twr-explained181342 Ref: #irr-and-twr-explained181381
Node: stats184410 Node: stats184467
Ref: #stats184511 Ref: #stats184568
Node: tags185891 Node: tags185948
Ref: #tags185991 Ref: #tags186048
Node: test186510 Node: test186567
Ref: #test186626 Ref: #test186683
Node: About add-on commands187373 Node: About add-on commands187430
Ref: #about-add-on-commands187510 Ref: #about-add-on-commands187567
Node: JOURNAL FORMAT188641 Node: JOURNAL FORMAT188698
Ref: #journal-format188769 Ref: #journal-format188826
Node: Transactions190996 Node: Transactions191053
Ref: #transactions191111 Ref: #transactions191168
Node: Dates192125 Node: Dates192182
Ref: #dates192241 Ref: #dates192298
Node: Simple dates192306 Node: Simple dates192363
Ref: #simple-dates192426 Ref: #simple-dates192483
Node: Secondary dates192935 Node: Secondary dates192992
Ref: #secondary-dates193083 Ref: #secondary-dates193140
Node: Posting dates194419 Node: Posting dates194476
Ref: #posting-dates194542 Ref: #posting-dates194599
Node: Status195914 Node: Status195971
Ref: #status196024 Ref: #status196081
Node: Code197732 Node: Code197789
Ref: #code197844 Ref: #code197901
Node: Description198076 Node: Description198133
Ref: #description198204 Ref: #description198261
Node: Payee and note198524 Node: Payee and note198581
Ref: #payee-and-note198632 Ref: #payee-and-note198689
Node: Comments198967 Node: Comments199024
Ref: #comments199089 Ref: #comments199146
Node: Tags200283 Node: Tags200340
Ref: #tags-1200394 Ref: #tags-1200451
Node: Postings201787 Node: Postings201844
Ref: #postings201911 Ref: #postings201968
Node: Virtual postings202937 Node: Virtual postings202994
Ref: #virtual-postings203048 Ref: #virtual-postings203105
Node: Account names204353 Node: Account names204410
Ref: #account-names204490 Ref: #account-names204547
Node: Amounts204978 Node: Amounts205035
Ref: #amounts205115 Ref: #amounts205172
Node: Decimal marks digit group marks206100 Node: Decimal marks digit group marks206157
Ref: #decimal-marks-digit-group-marks206277 Ref: #decimal-marks-digit-group-marks206334
Node: Commodity207298 Node: Commodity207355
Ref: #commodity207487 Ref: #commodity207544
Node: Directives influencing number parsing and display208439 Node: Directives influencing number parsing and display208496
Ref: #directives-influencing-number-parsing-and-display208700 Ref: #directives-influencing-number-parsing-and-display208757
Node: Commodity display style209193 Node: Commodity display style209250
Ref: #commodity-display-style209401 Ref: #commodity-display-style209458
Node: Rounding211596 Node: Rounding211653
Ref: #rounding211716 Ref: #rounding211773
Node: Transaction prices212128 Node: Transaction prices212185
Ref: #transaction-prices212294 Ref: #transaction-prices212351
Node: Lot prices lot dates214725 Node: Lot prices lot dates214782
Ref: #lot-prices-lot-dates214908 Ref: #lot-prices-lot-dates214965
Node: Balance assertions215396 Node: Balance assertions215453
Ref: #balance-assertions215574 Ref: #balance-assertions215631
Node: Assertions and ordering216607 Node: Assertions and ordering216664
Ref: #assertions-and-ordering216789 Ref: #assertions-and-ordering216846
Node: Assertions and included files217489 Node: Assertions and included files217546
Ref: #assertions-and-included-files217726 Ref: #assertions-and-included-files217783
Node: Assertions and multiple -f options218059 Node: Assertions and multiple -f options218116
Ref: #assertions-and-multiple--f-options218309 Ref: #assertions-and-multiple--f-options218366
Node: Assertions and commodities218441 Node: Assertions and commodities218498
Ref: #assertions-and-commodities218667 Ref: #assertions-and-commodities218724
Node: Assertions and prices219824 Node: Assertions and prices219881
Ref: #assertions-and-prices220032 Ref: #assertions-and-prices220089
Node: Assertions and subaccounts220472 Node: Assertions and subaccounts220529
Ref: #assertions-and-subaccounts220695 Ref: #assertions-and-subaccounts220752
Node: Assertions and virtual postings221019 Node: Assertions and virtual postings221076
Ref: #assertions-and-virtual-postings221255 Ref: #assertions-and-virtual-postings221312
Node: Assertions and precision221397 Node: Assertions and precision221454
Ref: #assertions-and-precision221584 Ref: #assertions-and-precision221641
Node: Balance assignments221851 Node: Balance assignments221908
Ref: #balance-assignments222021 Ref: #balance-assignments222078
Node: Balance assignments and prices223185 Node: Balance assignments and prices223242
Ref: #balance-assignments-and-prices223351 Ref: #balance-assignments-and-prices223408
Node: Directives223575 Node: Directives223632
Ref: #directives223738 Ref: #directives223795
Node: Directives and multiple files228230 Node: Directives and multiple files228287
Ref: #directives-and-multiple-files228426 Ref: #directives-and-multiple-files228483
Node: Comment blocks229118 Node: Comment blocks229175
Ref: #comment-blocks229295 Ref: #comment-blocks229352
Node: Including other files229471 Node: Including other files229528
Ref: #including-other-files229645 Ref: #including-other-files229702
Node: Default year230569 Node: Default year230626
Ref: #default-year230727 Ref: #default-year230784
Node: Declaring payees231134 Node: Declaring payees231191
Ref: #declaring-payees231305 Ref: #declaring-payees231362
Node: Declaring the decimal mark231551 Node: Declaring the decimal mark231608
Ref: #declaring-the-decimal-mark231751 Ref: #declaring-the-decimal-mark231808
Node: Declaring commodities232148 Node: Declaring commodities232205
Ref: #declaring-commodities232339 Ref: #declaring-commodities232396
Node: Commodity error checking234857 Node: Commodity error checking234914
Ref: #commodity-error-checking235007 Ref: #commodity-error-checking235064
Node: Default commodity235264 Node: Default commodity235579
Ref: #default-commodity235444 Ref: #default-commodity235759
Node: Declaring market prices236560 Node: Declaring market prices236875
Ref: #declaring-market-prices236749 Ref: #declaring-market-prices237064
Node: Declaring accounts237562 Node: Declaring accounts237877
Ref: #declaring-accounts237742 Ref: #declaring-accounts238057
Node: Account error checking238944 Node: Account error checking239259
Ref: #account-error-checking239110 Ref: #account-error-checking239425
Node: Account comments240289 Node: Account comments240604
Ref: #account-comments240473 Ref: #account-comments240788
Node: Account subdirectives240897 Node: Account subdirectives241212
Ref: #account-subdirectives241082 Ref: #account-subdirectives241397
Node: Account types241395 Node: Account types241710
Ref: #account-types241569 Ref: #account-types241884
Node: Auto-detected account types242985 Node: Auto-detected account types243300
Ref: #auto-detected-account-types243140 Ref: #auto-detected-account-types243455
Node: Account display order244375 Node: Account display order244690
Ref: #account-display-order244535 Ref: #account-display-order244850
Node: Rewriting accounts245686 Node: Rewriting accounts246001
Ref: #rewriting-accounts245865 Ref: #rewriting-accounts246180
Node: Basic aliases246875 Node: Basic aliases247190
Ref: #basic-aliases247011 Ref: #basic-aliases247326
Node: Regex aliases247755 Node: Regex aliases248070
Ref: #regex-aliases247917 Ref: #regex-aliases248232
Node: Combining aliases248636 Node: Combining aliases248951
Ref: #combining-aliases248819 Ref: #combining-aliases249134
Node: Aliases and multiple files250095 Node: Aliases and multiple files250410
Ref: #aliases-and-multiple-files250294 Ref: #aliases-and-multiple-files250609
Node: end aliases250873 Node: end aliases251188
Ref: #end-aliases251067 Ref: #end-aliases251382
Node: Aliases can generate bad account names251216 Node: Aliases can generate bad account names251531
Ref: #aliases-can-generate-bad-account-names251425 Ref: #aliases-can-generate-bad-account-names251740
Node: Default parent account252010 Node: Default parent account252325
Ref: #default-parent-account252200 Ref: #default-parent-account252515
Node: Periodic transactions253084 Node: Periodic transactions253399
Ref: #periodic-transactions253267 Ref: #periodic-transactions253582
Node: Periodic rule syntax255184 Node: Periodic rule syntax255499
Ref: #periodic-rule-syntax255384 Ref: #periodic-rule-syntax255699
Node: Two spaces between period expression and description!256088 Node: Two spaces between period expression and description!256403
Ref: #two-spaces-between-period-expression-and-description256401 Ref: #two-spaces-between-period-expression-and-description256716
Node: Forecasting with periodic transactions257085 Node: Forecasting with periodic transactions257400
Ref: #forecasting-with-periodic-transactions257384 Ref: #forecasting-with-periodic-transactions257699
Node: Budgeting with periodic transactions260155 Node: Budgeting with periodic transactions260470
Ref: #budgeting-with-periodic-transactions260388 Ref: #budgeting-with-periodic-transactions260703
Node: Auto postings260797 Node: Auto postings261112
Ref: #auto-postings260933 Ref: #auto-postings261248
Node: Auto postings and multiple files263112 Node: Auto postings and multiple files263427
Ref: #auto-postings-and-multiple-files263310 Ref: #auto-postings-and-multiple-files263625
Node: Auto postings and dates263519 Node: Auto postings and dates263834
Ref: #auto-postings-and-dates263787 Ref: #auto-postings-and-dates264102
Node: Auto postings and transaction balancing / inferred amounts / balance assertions263962 Node: Auto postings and transaction balancing / inferred amounts / balance assertions264277
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions264307 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions264622
Node: Auto posting tags264810 Node: Auto posting tags265125
Ref: #auto-posting-tags265019 Ref: #auto-posting-tags265334
Node: CSV FORMAT265655 Node: CSV FORMAT265970
Ref: #csv-format265783 Ref: #csv-format266098
Node: Examples268412 Node: Examples268727
Ref: #examples268515 Ref: #examples268830
Node: Basic268723 Node: Basic269038
Ref: #basic268825 Ref: #basic269140
Node: Bank of Ireland269367 Node: Bank of Ireland269682
Ref: #bank-of-ireland269504 Ref: #bank-of-ireland269819
Node: Amazon270966 Node: Amazon271281
Ref: #amazon271086 Ref: #amazon271401
Node: Paypal272805 Node: Paypal273120
Ref: #paypal272901 Ref: #paypal273216
Node: CSV rules280545 Node: CSV rules280860
Ref: #csv-rules280663 Ref: #csv-rules280978
Node: skip280996 Node: skip281311
Ref: #skip281096 Ref: #skip281411
Node: fields list281471 Node: fields list281786
Ref: #fields-list281610 Ref: #fields-list281925
Node: field assignment283176 Node: field assignment283491
Ref: #field-assignment283328 Ref: #field-assignment283643
Node: Field names284363 Node: Field names284678
Ref: #field-names284503 Ref: #field-names284818
Node: date field284883 Node: date field285198
Ref: #date-field285003 Ref: #date-field285318
Node: date2 field285051 Node: date2 field285366
Ref: #date2-field285194 Ref: #date2-field285509
Node: status field285250 Node: status field285565
Ref: #status-field285395 Ref: #status-field285710
Node: code field285444 Node: code field285759
Ref: #code-field285591 Ref: #code-field285906
Node: description field285636 Node: description field285951
Ref: #description-field285798 Ref: #description-field286113
Node: comment field285857 Node: comment field286172
Ref: #comment-field286014 Ref: #comment-field286329
Node: account field286325 Node: account field286640
Ref: #account-field286477 Ref: #account-field286792
Node: amount field287052 Node: amount field287367
Ref: #amount-field287203 Ref: #amount-field287518
Node: currency field288448 Node: currency field288763
Ref: #currency-field288603 Ref: #currency-field288918
Node: balance field288860 Node: balance field289175
Ref: #balance-field288994 Ref: #balance-field289309
Node: separator289366 Node: separator289681
Ref: #separator289498 Ref: #separator289813
Node: if block290038 Node: if block290353
Ref: #if-block290165 Ref: #if-block290480
Node: Matching the whole record290566 Node: Matching the whole record290881
Ref: #matching-the-whole-record290743 Ref: #matching-the-whole-record291058
Node: Matching individual fields291546 Node: Matching individual fields291861
Ref: #matching-individual-fields291752 Ref: #matching-individual-fields292067
Node: Combining matchers291976 Node: Combining matchers292291
Ref: #combining-matchers292174 Ref: #combining-matchers292489
Node: Rules applied on successful match292487 Node: Rules applied on successful match292802
Ref: #rules-applied-on-successful-match292680 Ref: #rules-applied-on-successful-match292995
Node: if table293334 Node: if table293649
Ref: #if-table293455 Ref: #if-table293770
Node: end295193 Node: end295508
Ref: #end295307 Ref: #end295622
Node: date-format295531 Node: date-format295846
Ref: #date-format295665 Ref: #date-format295980
Node: decimal-mark296661 Node: decimal-mark296976
Ref: #decimal-mark296808 Ref: #decimal-mark297123
Node: newest-first297147 Node: newest-first297462
Ref: #newest-first297290 Ref: #newest-first297605
Node: include297973 Node: include298288
Ref: #include298106 Ref: #include298421
Node: balance-type298550 Node: balance-type298865
Ref: #balance-type298672 Ref: #balance-type298987
Node: Tips299372 Node: Tips299687
Ref: #tips299463 Ref: #tips299778
Node: Rapid feedback299762 Node: Rapid feedback300077
Ref: #rapid-feedback299881 Ref: #rapid-feedback300196
Node: Valid CSV300333 Node: Valid CSV300648
Ref: #valid-csv300465 Ref: #valid-csv300780
Node: File Extension300657 Node: File Extension300972
Ref: #file-extension300811 Ref: #file-extension301126
Node: Reading multiple CSV files301240 Node: Reading multiple CSV files301555
Ref: #reading-multiple-csv-files301427 Ref: #reading-multiple-csv-files301742
Node: Valid transactions301668 Node: Valid transactions301983
Ref: #valid-transactions301848 Ref: #valid-transactions302163
Node: Deduplicating importing302476 Node: Deduplicating importing302791
Ref: #deduplicating-importing302657 Ref: #deduplicating-importing302972
Node: Setting amounts303690 Node: Setting amounts304005
Ref: #setting-amounts303847 Ref: #setting-amounts304162
Node: Amount signs306291 Node: Amount signs306606
Ref: #amount-signs306445 Ref: #amount-signs306760
Node: Setting currency/commodity307132 Node: Setting currency/commodity307447
Ref: #setting-currencycommodity307320 Ref: #setting-currencycommodity307635
Node: Amount decimal places308494 Node: Amount decimal places308809
Ref: #amount-decimal-places308686 Ref: #amount-decimal-places309001
Node: Referencing other fields308998 Node: Referencing other fields309313
Ref: #referencing-other-fields309197 Ref: #referencing-other-fields309512
Node: How CSV rules are evaluated310094 Node: How CSV rules are evaluated310409
Ref: #how-csv-rules-are-evaluated310269 Ref: #how-csv-rules-are-evaluated310584
Node: TIMECLOCK FORMAT311720 Node: TIMECLOCK FORMAT312035
Ref: #timeclock-format311860 Ref: #timeclock-format312175
Node: TIMEDOT FORMAT313921 Node: TIMEDOT FORMAT314236
Ref: #timedot-format314059 Ref: #timedot-format314374
Node: COMMON TASKS318621 Node: COMMON TASKS318936
Ref: #common-tasks318750 Ref: #common-tasks319065
Node: Getting help319157 Node: Getting help319472
Ref: #getting-help319291 Ref: #getting-help319606
Node: Constructing command lines319852 Node: Constructing command lines320167
Ref: #constructing-command-lines320046 Ref: #constructing-command-lines320361
Node: Starting a journal file320743 Node: Starting a journal file321058
Ref: #starting-a-journal-file320943 Ref: #starting-a-journal-file321258
Node: Setting opening balances322131 Node: Setting opening balances322446
Ref: #setting-opening-balances322329 Ref: #setting-opening-balances322644
Node: Recording transactions325470 Node: Recording transactions325785
Ref: #recording-transactions325652 Ref: #recording-transactions325967
Node: Reconciling326208 Node: Reconciling326523
Ref: #reconciling326353 Ref: #reconciling326668
Node: Reporting328610 Node: Reporting328925
Ref: #reporting328752 Ref: #reporting329067
Node: Migrating to a new file332751 Node: Migrating to a new file333066
Ref: #migrating-to-a-new-file332901 Ref: #migrating-to-a-new-file333216
Node: LIMITATIONS333200 Node: LIMITATIONS333515
Ref: #limitations333328 Ref: #limitations333643
Node: TROUBLESHOOTING334071 Node: TROUBLESHOOTING334386
Ref: #troubleshooting334186 Ref: #troubleshooting334501
 
End Tag Table End Tag Table

File diff suppressed because it is too large Load Diff