;doc: regen manuals

[ci skip]
This commit is contained in:
Simon Michael 2020-06-21 10:36:21 -07:00
parent 24996caaeb
commit ce4de7aeb9
21 changed files with 1066 additions and 1064 deletions

View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "hledger_csv" "5" "June 2020" "hledger 1.18" "hledger User Manuals" .TH "hledger_csv" "5" "June 2020" "hledger 1.18.99" "hledger User Manuals"

View File

@ -3,8 +3,8 @@ This is hledger_csv.info, produced by makeinfo version 6.7 from stdin.
 
File: hledger_csv.info, Node: Top, Next: EXAMPLES, Up: (dir) File: hledger_csv.info, Node: Top, Next: EXAMPLES, Up: (dir)
hledger_csv(5) hledger 1.18 hledger_csv(5) hledger 1.18.99
*************************** ******************************
CSV - how hledger reads CSV data, and the CSV rules file format CSV - how hledger reads CSV data, and the CSV rules file format
@ -1036,74 +1036,74 @@ command the user specified.
 
Tag Table: Tag Table:
Node: Top72 Node: Top72
Node: EXAMPLES2174 Node: EXAMPLES2180
Ref: #examples2280 Ref: #examples2286
Node: Basic2488 Node: Basic2494
Ref: #basic2588 Ref: #basic2594
Node: Bank of Ireland3130 Node: Bank of Ireland3136
Ref: #bank-of-ireland3265 Ref: #bank-of-ireland3271
Node: Amazon4727 Node: Amazon4733
Ref: #amazon4845 Ref: #amazon4851
Node: Paypal6564 Node: Paypal6570
Ref: #paypal6658 Ref: #paypal6664
Node: CSV RULES14302 Node: CSV RULES14308
Ref: #csv-rules14411 Ref: #csv-rules14417
Node: skip14687 Node: skip14693
Ref: #skip14780 Ref: #skip14786
Node: fields15155 Node: fields15161
Ref: #fields15277 Ref: #fields15283
Node: Transaction field names16442 Node: Transaction field names16448
Ref: #transaction-field-names16602 Ref: #transaction-field-names16608
Node: Posting field names16713 Node: Posting field names16719
Ref: #posting-field-names16865 Ref: #posting-field-names16871
Node: account16935 Node: account16941
Ref: #account17051 Ref: #account17057
Node: amount17588 Node: amount17594
Ref: #amount17719 Ref: #amount17725
Node: currency18826 Node: currency18832
Ref: #currency18961 Ref: #currency18967
Node: balance19167 Node: balance19173
Ref: #balance19301 Ref: #balance19307
Node: comment19618 Node: comment19624
Ref: #comment19735 Ref: #comment19741
Node: field assignment19898 Node: field assignment19904
Ref: #field-assignment20041 Ref: #field-assignment20047
Node: separator20859 Node: separator20865
Ref: #separator20988 Ref: #separator20994
Node: if21399 Node: if21405
Ref: #if21501 Ref: #if21507
Node: end23657 Node: end23663
Ref: #end23763 Ref: #end23769
Node: date-format23987 Node: date-format23993
Ref: #date-format24119 Ref: #date-format24125
Node: newest-first24868 Node: newest-first24874
Ref: #newest-first25006 Ref: #newest-first25012
Node: include25689 Node: include25695
Ref: #include25818 Ref: #include25824
Node: balance-type26262 Node: balance-type26268
Ref: #balance-type26382 Ref: #balance-type26388
Node: TIPS27082 Node: TIPS27088
Ref: #tips27164 Ref: #tips27170
Node: Rapid feedback27420 Node: Rapid feedback27426
Ref: #rapid-feedback27537 Ref: #rapid-feedback27543
Node: Valid CSV27997 Node: Valid CSV28003
Ref: #valid-csv28127 Ref: #valid-csv28133
Node: File Extension28319 Node: File Extension28325
Ref: #file-extension28471 Ref: #file-extension28477
Node: Reading multiple CSV files28881 Node: Reading multiple CSV files28887
Ref: #reading-multiple-csv-files29066 Ref: #reading-multiple-csv-files29072
Node: Valid transactions29307 Node: Valid transactions29313
Ref: #valid-transactions29485 Ref: #valid-transactions29491
Node: Deduplicating importing30113 Node: Deduplicating importing30119
Ref: #deduplicating-importing30292 Ref: #deduplicating-importing30298
Node: Setting amounts31325 Node: Setting amounts31331
Ref: #setting-amounts31494 Ref: #setting-amounts31500
Node: Setting currency/commodity32481 Node: Setting currency/commodity32487
Ref: #setting-currencycommodity32673 Ref: #setting-currencycommodity32679
Node: Referencing other fields33476 Node: Referencing other fields33482
Ref: #referencing-other-fields33676 Ref: #referencing-other-fields33682
Node: How CSV rules are evaluated34573 Node: How CSV rules are evaluated34579
Ref: #how-csv-rules-are-evaluated34746 Ref: #how-csv-rules-are-evaluated34752
 
End Tag Table End Tag Table

View File

@ -852,4 +852,4 @@ SEE ALSO
hledger 1.18 June 2020 hledger_csv(5) hledger 1.18.99 June 2020 hledger_csv(5)

View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "hledger_journal" "5" "June 2020" "hledger 1.18" "hledger User Manuals" .TH "hledger_journal" "5" "June 2020" "hledger 1.18.99" "hledger User Manuals"
@ -1143,15 +1143,20 @@ files can be included (not CSV files, currently).
If the file path does not begin with a slash, it is relative to the If the file path does not begin with a slash, it is relative to the
current file\[aq]s folder. current file\[aq]s folder.
.PP .PP
It may contain glob patterns to match multiple files, eg: A tilde means home directory, eg: \f[C]include \[ti]/main.journal\f[R].
.PP
The path may contain glob patterns to match multiple files, eg:
\f[C]include *.journal\f[R]. \f[C]include *.journal\f[R].
.PP .PP
Or a tilde, meaning home directory: There is limited support for recursive wildcards: \f[C]**/\f[R] (the
\f[C]include \[ti]/main.journal\f[R]. slash is required) matches 0 or more subdirectories.
It\[aq]s not super convenient since you have to avoid include cycles and
including directories, but this can be done, eg:
\f[C]include */**/*.journal\f[R].
.PP .PP
It may also be prefixed to force a specific file format, overriding the The path may also be prefixed to force a specific file format,
file extension (as described in hledger.1 -> Input files): overriding the file extension (as described in hledger.1 -> Input
\f[C]include timedot:\[ti]/notes/2020*.md\f[R]. files): \f[C]include timedot:\[ti]/notes/2020*.md\f[R].
.SS Default year .SS Default year
.PP .PP
You can set a default year to be used for subsequent dates which You can set a default year to be used for subsequent dates which

View File

@ -4,8 +4,8 @@ stdin.
 
File: hledger_journal.info, Node: Top, Up: (dir) File: hledger_journal.info, Node: Top, Up: (dir)
hledger_journal(5) hledger 1.18 hledger_journal(5) hledger 1.18.99
******************************* **********************************
Journal - hledger's default file format, representing a General Journal Journal - hledger's default file format, representing a General Journal
@ -1023,14 +1023,19 @@ timedot files can be included (not CSV files, currently).
If the file path does not begin with a slash, it is relative to the If the file path does not begin with a slash, it is relative to the
current file's folder. current file's folder.
It may contain glob patterns to match multiple files, eg: 'include A tilde means home directory, eg: 'include ~/main.journal'.
*.journal'.
Or a tilde, meaning home directory: 'include ~/main.journal'. The path may contain glob patterns to match multiple files, eg:
'include *.journal'.
It may also be prefixed to force a specific file format, overriding There is limited support for recursive wildcards: '**/' (the slash is
the file extension (as described in hledger.1 -> Input files): 'include required) matches 0 or more subdirectories. It's not super convenient
timedot:~/notes/2020*.md'. since you have to avoid include cycles and including directories, but
this can be done, eg: 'include */**/*.journal'.
The path may also be prefixed to force a specific file format,
overriding the file extension (as described in hledger.1 -> Input
files): 'include timedot:~/notes/2020*.md'.
 
File: hledger_journal.info, Node: Default year, Next: Declaring commodities, Prev: Including other files, Up: Directives File: hledger_journal.info, Node: Default year, Next: Declaring commodities, Prev: Including other files, Up: Directives
@ -1823,124 +1828,124 @@ will have these tags added:
 
Tag Table: Tag Table:
Node: Top76 Node: Top76
Node: Transactions1869 Node: Transactions1875
Ref: #transactions1961 Ref: #transactions1967
Node: Dates3245 Node: Dates3251
Ref: #dates3344 Ref: #dates3350
Node: Simple dates3409 Node: Simple dates3415
Ref: #simple-dates3535 Ref: #simple-dates3541
Node: Secondary dates4044 Node: Secondary dates4050
Ref: #secondary-dates4198 Ref: #secondary-dates4204
Node: Posting dates5534 Node: Posting dates5540
Ref: #posting-dates5663 Ref: #posting-dates5669
Node: Status7035 Node: Status7041
Ref: #status7156 Ref: #status7162
Node: Description8864 Node: Description8870
Ref: #description8998 Ref: #description9004
Node: Payee and note9318 Node: Payee and note9324
Ref: #payee-and-note9432 Ref: #payee-and-note9438
Node: Comments9767 Node: Comments9773
Ref: #comments9893 Ref: #comments9899
Node: Tags11087 Node: Tags11093
Ref: #tags11202 Ref: #tags11208
Node: Postings12595 Node: Postings12601
Ref: #postings12723 Ref: #postings12729
Node: Virtual postings13749 Node: Virtual postings13755
Ref: #virtual-postings13866 Ref: #virtual-postings13872
Node: Account names15171 Node: Account names15177
Ref: #account-names15312 Ref: #account-names15318
Node: Amounts15799 Node: Amounts15805
Ref: #amounts15938 Ref: #amounts15944
Node: Digit group marks17046 Node: Digit group marks17052
Ref: #digit-group-marks17194 Ref: #digit-group-marks17200
Node: Amount display style18132 Node: Amount display style18138
Ref: #amount-display-style18286 Ref: #amount-display-style18292
Node: Transaction prices19723 Node: Transaction prices19729
Ref: #transaction-prices19895 Ref: #transaction-prices19901
Node: Lot prices and lot dates22227 Node: Lot prices and lot dates22233
Ref: #lot-prices-and-lot-dates22424 Ref: #lot-prices-and-lot-dates22430
Node: Balance assertions22912 Node: Balance assertions22918
Ref: #balance-assertions23098 Ref: #balance-assertions23104
Node: Assertions and ordering24131 Node: Assertions and ordering24137
Ref: #assertions-and-ordering24319 Ref: #assertions-and-ordering24325
Node: Assertions and included files25019 Node: Assertions and included files25025
Ref: #assertions-and-included-files25262 Ref: #assertions-and-included-files25268
Node: Assertions and multiple -f options25595 Node: Assertions and multiple -f options25601
Ref: #assertions-and-multiple--f-options25851 Ref: #assertions-and-multiple--f-options25857
Node: Assertions and commodities25983 Node: Assertions and commodities25989
Ref: #assertions-and-commodities26215 Ref: #assertions-and-commodities26221
Node: Assertions and prices27372 Node: Assertions and prices27378
Ref: #assertions-and-prices27586 Ref: #assertions-and-prices27592
Node: Assertions and subaccounts28026 Node: Assertions and subaccounts28032
Ref: #assertions-and-subaccounts28255 Ref: #assertions-and-subaccounts28261
Node: Assertions and virtual postings28579 Node: Assertions and virtual postings28585
Ref: #assertions-and-virtual-postings28821 Ref: #assertions-and-virtual-postings28827
Node: Assertions and precision28963 Node: Assertions and precision28969
Ref: #assertions-and-precision29156 Ref: #assertions-and-precision29162
Node: Balance assignments29423 Node: Balance assignments29429
Ref: #balance-assignments29597 Ref: #balance-assignments29603
Node: Balance assignments and prices30761 Node: Balance assignments and prices30767
Ref: #balance-assignments-and-prices30933 Ref: #balance-assignments-and-prices30939
Node: Directives31157 Node: Directives31163
Ref: #directives31316 Ref: #directives31322
Node: Directives and multiple files37007 Node: Directives and multiple files37013
Ref: #directives-and-multiple-files37190 Ref: #directives-and-multiple-files37196
Node: Comment blocks37854 Node: Comment blocks37860
Ref: #comment-blocks38037 Ref: #comment-blocks38043
Node: Including other files38213 Node: Including other files38219
Ref: #including-other-files38393 Ref: #including-other-files38399
Node: Default year39044 Node: Default year39323
Ref: #default-year39213 Ref: #default-year39492
Node: Declaring commodities39620 Node: Declaring commodities39899
Ref: #declaring-commodities39803 Ref: #declaring-commodities40082
Node: Default commodity41609 Node: Default commodity41888
Ref: #default-commodity41795 Ref: #default-commodity42074
Node: Declaring market prices42684 Node: Declaring market prices42963
Ref: #declaring-market-prices42879 Ref: #declaring-market-prices43158
Node: Declaring accounts43736 Node: Declaring accounts44015
Ref: #declaring-accounts43922 Ref: #declaring-accounts44201
Node: Account comments44847 Node: Account comments45126
Ref: #account-comments45010 Ref: #account-comments45289
Node: Account subdirectives45434 Node: Account subdirectives45713
Ref: #account-subdirectives45629 Ref: #account-subdirectives45908
Node: Account types45942 Node: Account types46221
Ref: #account-types46126 Ref: #account-types46405
Node: Account display order47765 Node: Account display order48044
Ref: #account-display-order47935 Ref: #account-display-order48214
Node: Rewriting accounts49086 Node: Rewriting accounts49365
Ref: #rewriting-accounts49271 Ref: #rewriting-accounts49550
Node: Basic aliases50028 Node: Basic aliases50307
Ref: #basic-aliases50174 Ref: #basic-aliases50453
Node: Regex aliases50878 Node: Regex aliases51157
Ref: #regex-aliases51050 Ref: #regex-aliases51329
Node: Combining aliases51768 Node: Combining aliases52047
Ref: #combining-aliases51961 Ref: #combining-aliases52240
Node: Aliases and multiple files53237 Node: Aliases and multiple files53516
Ref: #aliases-and-multiple-files53446 Ref: #aliases-and-multiple-files53725
Node: end aliases54025 Node: end aliases54304
Ref: #end-aliases54182 Ref: #end-aliases54461
Node: Default parent account54283 Node: Default parent account54562
Ref: #default-parent-account54451 Ref: #default-parent-account54730
Node: Periodic transactions55335 Node: Periodic transactions55614
Ref: #periodic-transactions55510 Ref: #periodic-transactions55789
Node: Periodic rule syntax57382 Node: Periodic rule syntax57661
Ref: #periodic-rule-syntax57588 Ref: #periodic-rule-syntax57867
Node: Two spaces between period expression and description!58292 Node: Two spaces between period expression and description!58571
Ref: #two-spaces-between-period-expression-and-description58611 Ref: #two-spaces-between-period-expression-and-description58890
Node: Forecasting with periodic transactions59295 Node: Forecasting with periodic transactions59574
Ref: #forecasting-with-periodic-transactions59600 Ref: #forecasting-with-periodic-transactions59879
Node: Budgeting with periodic transactions61655 Node: Budgeting with periodic transactions61934
Ref: #budgeting-with-periodic-transactions61894 Ref: #budgeting-with-periodic-transactions62173
Node: Auto postings62343 Node: Auto postings62622
Ref: #auto-postings62483 Ref: #auto-postings62762
Node: Auto postings and multiple files64662 Node: Auto postings and multiple files64941
Ref: #auto-postings-and-multiple-files64866 Ref: #auto-postings-and-multiple-files65145
Node: Auto postings and dates65075 Node: Auto postings and dates65354
Ref: #auto-postings-and-dates65349 Ref: #auto-postings-and-dates65628
Node: Auto postings and transaction balancing / inferred amounts / balance assertions65524 Node: Auto postings and transaction balancing / inferred amounts / balance assertions65803
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions65875 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions66154
Node: Auto posting tags66217 Node: Auto posting tags66496
Ref: #auto-posting-tags66432 Ref: #auto-posting-tags66711
 
End Tag Table End Tag Table

View File

@ -792,14 +792,19 @@ FILE FORMAT
If the file path does not begin with a slash, it is relative to the If the file path does not begin with a slash, it is relative to the
current file's folder. current file's folder.
It may contain glob patterns to match multiple files, eg: include A tilde means home directory, eg: include ~/main.journal.
The path may contain glob patterns to match multiple files, eg: include
*.journal. *.journal.
Or a tilde, meaning home directory: include ~/main.journal. There is limited support for recursive wildcards: **/ (the slash is re-
quired) matches 0 or more subdirectories. It's not super convenient
since you have to avoid include cycles and including directories, but
this can be done, eg: include */**/*.journal.
It may also be prefixed to force a specific file format, overriding the The path may also be prefixed to force a specific file format, overrid-
file extension (as described in hledger.1 -> Input files): include ing the file extension (as described in hledger.1 -> Input files): in-
timedot:~/notes/2020*.md. clude timedot:~/notes/2020*.md.
Default year Default year
You can set a default year to be used for subsequent dates which don't You can set a default year to be used for subsequent dates which don't
@ -1480,4 +1485,4 @@ SEE ALSO
hledger 1.18 June 2020 hledger_journal(5) hledger 1.18.99 June 2020 hledger_journal(5)

View File

@ -1,5 +1,5 @@
.TH "hledger_timeclock" "5" "June 2020" "hledger 1.18" "hledger User Manuals" .TH "hledger_timeclock" "5" "June 2020" "hledger 1.18.99" "hledger User Manuals"

View File

@ -4,8 +4,8 @@ stdin.
 
File: hledger_timeclock.info, Node: Top, Up: (dir) File: hledger_timeclock.info, Node: Top, Up: (dir)
hledger_timeclock(5) hledger 1.18 hledger_timeclock(5) hledger 1.18.99
********************************* ************************************
Timeclock - the time logging format of timeclock.el, as read by hledger Timeclock - the time logging format of timeclock.el, as read by hledger

View File

@ -78,4 +78,4 @@ SEE ALSO
hledger 1.18 June 2020 hledger_timeclock(5) hledger 1.18.99 June 2020 hledger_timeclock(5)

View File

@ -1,5 +1,5 @@
.TH "hledger_timedot" "5" "June 2020" "hledger 1.18" "hledger User Manuals" .TH "hledger_timedot" "5" "June 2020" "hledger 1.18.99" "hledger User Manuals"

View File

@ -4,8 +4,8 @@ stdin.
 
File: hledger_timedot.info, Node: Top, Up: (dir) File: hledger_timedot.info, Node: Top, Up: (dir)
hledger_timedot(5) hledger 1.18 hledger_timedot(5) hledger 1.18.99
******************************* **********************************
Timedot - hledger's human-friendly time logging format Timedot - hledger's human-friendly time logging format

View File

@ -161,4 +161,4 @@ SEE ALSO
hledger 1.18 June 2020 hledger_timedot(5) hledger 1.18.99 June 2020 hledger_timedot(5)

View File

@ -1,5 +1,5 @@
.TH "hledger-ui" "1" "June 2020" "hledger-ui 1.18" "hledger User Manuals" .TH "hledger-ui" "1" "June 2020" "hledger-ui 1.18.99" "hledger User Manuals"

View File

@ -3,8 +3,8 @@ This is hledger-ui.info, produced by makeinfo version 6.7 from stdin.
 
File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir) File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-ui(1) hledger-ui 1.18 hledger-ui(1) hledger-ui 1.18.99
***************************** ********************************
hledger-ui - terminal interface for the hledger accounting tool hledger-ui - terminal interface for the hledger accounting tool
@ -508,26 +508,26 @@ program is restarted.
 
Tag Table: Tag Table:
Node: Top71 Node: Top71
Node: OPTIONS1470 Node: OPTIONS1476
Ref: #options1567 Ref: #options1573
Node: KEYS5182 Node: KEYS5188
Ref: #keys5277 Ref: #keys5283
Node: SCREENS9553 Node: SCREENS9559
Ref: #screens9658 Ref: #screens9664
Node: Accounts screen9748 Node: Accounts screen9754
Ref: #accounts-screen9876 Ref: #accounts-screen9882
Node: Register screen12092 Node: Register screen12098
Ref: #register-screen12247 Ref: #register-screen12253
Node: Transaction screen14244 Node: Transaction screen14250
Ref: #transaction-screen14402 Ref: #transaction-screen14408
Node: Error screen15272 Node: Error screen15278
Ref: #error-screen15394 Ref: #error-screen15400
Node: ENVIRONMENT15638 Node: ENVIRONMENT15644
Ref: #environment15752 Ref: #environment15758
Node: FILES16559 Node: FILES16565
Ref: #files16658 Ref: #files16664
Node: BUGS16871 Node: BUGS16877
Ref: #bugs16948 Ref: #bugs16954
 
End Tag Table End Tag Table

View File

@ -450,4 +450,4 @@ SEE ALSO
hledger-ui 1.18 June 2020 hledger-ui(1) hledger-ui 1.18.99 June 2020 hledger-ui(1)

View File

@ -1,5 +1,5 @@
.TH "hledger-web" "1" "June 2020" "hledger-web 1.18" "hledger User Manuals" .TH "hledger-web" "1" "June 2020" "hledger-web 1.18.99" "hledger User Manuals"

View File

@ -3,8 +3,8 @@ This is hledger-web.info, produced by makeinfo version 6.7 from stdin.
 
File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir) File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-web(1) hledger-web 1.18 hledger-web(1) hledger-web 1.18.99
******************************* **********************************
hledger-web - web interface for the hledger accounting tool hledger-web - web interface for the hledger accounting tool
@ -573,22 +573,22 @@ awkward.
 
Tag Table: Tag Table:
Node: Top72 Node: Top72
Node: OPTIONS1746 Node: OPTIONS1752
Ref: #options1851 Ref: #options1857
Node: PERMISSIONS8379 Node: PERMISSIONS8385
Ref: #permissions8518 Ref: #permissions8524
Node: EDITING UPLOADING DOWNLOADING9730 Node: EDITING UPLOADING DOWNLOADING9736
Ref: #editing-uploading-downloading9911 Ref: #editing-uploading-downloading9917
Node: RELOADING10745 Node: RELOADING10751
Ref: #reloading10879 Ref: #reloading10885
Node: JSON API11312 Node: JSON API11318
Ref: #json-api11426 Ref: #json-api11432
Node: ENVIRONMENT16907 Node: ENVIRONMENT16913
Ref: #environment17023 Ref: #environment17029
Node: FILES17756 Node: FILES17762
Ref: #files17856 Ref: #files17862
Node: BUGS18069 Node: BUGS18075
Ref: #bugs18147 Ref: #bugs18153
 
End Tag Table End Tag Table

View File

@ -538,4 +538,4 @@ SEE ALSO
hledger-web 1.18 June 2020 hledger-web(1) hledger-web 1.18.99 June 2020 hledger-web(1)

View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "hledger" "1" "June 2020" "hledger 1.18" "hledger User Manuals" .TH "hledger" "1" "June 2020" "hledger 1.18.99" "hledger User Manuals"
@ -1679,18 +1679,12 @@ $ hledger balance --pivot member acct:.
.SS Valuation .SS Valuation
.PP .PP
Instead of reporting amounts in their original commodity, hledger can Instead of reporting amounts in their original commodity, hledger can
convert them to: convert them to cost/sale amount (using the conversion rate recorded in
.IP \[bu] 2 the transaction), or to market value (using some market price on a
cost (or sale amount), using the conversion rate recorded as part of the certain date).
transaction (transaction price). This is controlled by the \f[C]--value=TYPE[,COMMODITY]\f[R] option, but
.IP \[bu] 2 we also provide the simpler \f[C]-B\f[R]/\f[C]-V\f[R]/\f[C]-X\f[R]
value, using the market prices in effect on certain date(s). flags, and usually one of those is all you need.
.PP
We call this \[dq]valuation\[dq], and it is controlled in full by the
\f[C]--value=VALUATIONTYPE[,COMMODITY]\f[R] option.
But we also provide simpler, Ledger-compatible
\f[C]-B\f[R]/\f[C]-V\f[R]/\f[C]-X\f[R] flags, and usually one of these
is all you need:
.SS -B: Cost .SS -B: Cost
.PP .PP
The \f[C]-B/--cost\f[R] flag converts amounts to their cost or sale The \f[C]-B/--cost\f[R] flag converts amounts to their cost or sale
@ -1700,13 +1694,18 @@ amount at transaction time, if they have a transaction price specified.
The \f[C]-V/--market\f[R] flag converts amounts to market value in their The \f[C]-V/--market\f[R] flag converts amounts to market value in their
default \f[I]valuation commodity\f[R], using the market prices in effect default \f[I]valuation commodity\f[R], using the market prices in effect
on the \f[I]valuation date(s)\f[R], if any. on the \f[I]valuation date(s)\f[R], if any.
More on these things in a minute. More on these in a minute.
.SS -X: Value in specified commodity .SS -X: Value in specified commodity
.PP .PP
The \f[C]-X/--exchange\f[R] option is like \f[C]-V\f[R] except the The \f[C]-X/--exchange=COMM\f[R] option is like \f[C]-V\f[R], except you
desired valuation currency is specified explicitly. tell it which currency you want to convert to, and it tries to convert
everything to that.
.SS Valuation date .SS Valuation date
.PP .PP
Since market prices can change from day to day, market value reports
have a valuation date (or more than one), which determines which market
prices will be used.
.PP
For single period reports, if an explicit report end date is specified, For single period reports, if an explicit report end date is specified,
that will be used as the valuation date; otherwise the valuation date is that will be used as the valuation date; otherwise the valuation date is
\[dq]today\[dq]. \[dq]today\[dq].
@ -1751,11 +1750,10 @@ Adding the \f[C]--infer-value\f[R] flag to \f[C]-V\f[R], \f[C]-X\f[R] or
So for example, \f[C]hledger bs -V --infer-value\f[R] will get market So for example, \f[C]hledger bs -V --infer-value\f[R] will get market
prices both from P directives and from transactions. prices both from P directives and from transactions.
.PP .PP
There is a downside to this: value reports can be affected in There is a downside: value reports can sometimes be affected in
confusing/undesired ways by your journal entries. confusing/undesired ways by your journal entries.
If this happens to you, read all of this Valuation section carefully, If this happens to you, read all of this Valuation section carefully,
and try adding \f[C]--debug\f[R] or \f[C]--debug=2\f[R] to troubleshoot and try adding \f[C]--debug\f[R] or \f[C]--debug=2\f[R] to troubleshoot.
the reason.
.PP .PP
\f[C]--infer-value\f[R] can infer market prices from: \f[C]--infer-value\f[R] can infer market prices from:
.IP \[bu] 2 .IP \[bu] 2
@ -1801,17 +1799,15 @@ If there are no P directives at all (any commodity or date) and the
\f[C]--infer-value\f[R] flag is used: the price commodity from the \f[C]--infer-value\f[R] flag is used: the price commodity from the
latest transaction-inferred price for A on or before valuation date. latest transaction-inferred price for A on or before valuation date.
.PP .PP
Amounts for which no valuation commodity can be found are not converted.
.PP
This means: This means:
.IP \[bu] 2 .IP \[bu] 2
If you have any P directives, they alone determine which commodities If you have P directives, they determine which commodities \f[C]-V\f[R]
\f[C]-V\f[R] will convert, and to what. will convert, and to what.
.IP \[bu] 2 .IP \[bu] 2
If you have no P directives, and you add the \f[C]--infer-value\f[R] If you have no P directives, and use the \f[C]--infer-value\f[R] flag,
flag, transaction prices determine what \f[C]-V\f[R] converts. transaction prices determine it.
.IP \[bu] 2 .PP
\f[C]-X\f[R] tries harder to convert everything to just one commodity. Amounts for which no valuation commodity can be found are not converted.
.SS Simple valuation examples .SS Simple valuation examples
.PP .PP
Here are some quick examples of \f[C]-V\f[R]: Here are some quick examples of \f[C]-V\f[R]:

View File

@ -3,8 +3,8 @@ This is hledger.info, produced by makeinfo version 6.7 from stdin.
 
File: hledger.info, Node: Top, Next: COMMON TASKS, Up: (dir) File: hledger.info, Node: Top, Next: COMMON TASKS, Up: (dir)
hledger(1) hledger 1.18 hledger(1) hledger 1.18.99
*********************** **************************
hledger - a command-line accounting tool hledger - a command-line accounting tool
@ -1373,17 +1373,11 @@ File: hledger.info, Node: Valuation, Prev: Pivoting, Up: OPTIONS
============== ==============
Instead of reporting amounts in their original commodity, hledger can Instead of reporting amounts in their original commodity, hledger can
convert them to: convert them to cost/sale amount (using the conversion rate recorded in
the transaction), or to market value (using some market price on a
* cost (or sale amount), using the conversion rate recorded as part certain date). This is controlled by the '--value=TYPE[,COMMODITY]'
of the transaction (transaction price). option, but we also provide the simpler '-B'/'-V'/'-X' flags, and
usually one of those is all you need.
* value, using the market prices in effect on certain date(s).
We call this "valuation", and it is controlled in full by the
'--value=VALUATIONTYPE[,COMMODITY]' option. But we also provide
simpler, Ledger-compatible '-B'/'-V'/'-X' flags, and usually one of
these is all you need:
* Menu: * Menu:
@ -1416,7 +1410,7 @@ File: hledger.info, Node: -V Value, Next: -X Value in specified commodity, Pr
The '-V/--market' flag converts amounts to market value in their default The '-V/--market' flag converts amounts to market value in their default
_valuation commodity_, using the market prices in effect on the _valuation commodity_, using the market prices in effect on the
_valuation date(s)_, if any. More on these things in a minute. _valuation date(s)_, if any. More on these in a minute.
 
File: hledger.info, Node: -X Value in specified commodity, Next: Valuation date, Prev: -V Value, Up: Valuation File: hledger.info, Node: -X Value in specified commodity, Next: Valuation date, Prev: -V Value, Up: Valuation
@ -1424,8 +1418,9 @@ File: hledger.info, Node: -X Value in specified commodity, Next: Valuation dat
2.17.3 -X: Value in specified commodity 2.17.3 -X: Value in specified commodity
--------------------------------------- ---------------------------------------
The '-X/--exchange' option is like '-V' except the desired valuation The '-X/--exchange=COMM' option is like '-V', except you tell it which
currency is specified explicitly. currency you want to convert to, and it tries to convert everything to
that.
 
File: hledger.info, Node: Valuation date, Next: Market prices, Prev: -X Value in specified commodity, Up: Valuation File: hledger.info, Node: Valuation date, Next: Market prices, Prev: -X Value in specified commodity, Up: Valuation
@ -1433,9 +1428,13 @@ File: hledger.info, Node: Valuation date, Next: Market prices, Prev: -X Value
2.17.4 Valuation date 2.17.4 Valuation date
--------------------- ---------------------
For single period reports, if an explicit report end date is specified, Since market prices can change from day to day, market value reports
that will be used as the valuation date; otherwise the valuation date is have a valuation date (or more than one), which determines which market
"today". prices will be used.
For single period reports, if an explicit report end date is
specified, that will be used as the valuation date; otherwise the
valuation date is "today".
For multiperiod reports, each column/period is valued on the last day For multiperiod reports, each column/period is valued on the last day
of the period. of the period.
@ -1486,10 +1485,10 @@ needing P directives at all.
this. So for example, 'hledger bs -V --infer-value' will get market this. So for example, 'hledger bs -V --infer-value' will get market
prices both from P directives and from transactions. prices both from P directives and from transactions.
There is a downside to this: value reports can be affected in There is a downside: value reports can sometimes be affected in
confusing/undesired ways by your journal entries. If this happens to confusing/undesired ways by your journal entries. If this happens to
you, read all of this Valuation section carefully, and try adding you, read all of this Valuation section carefully, and try adding
'--debug' or '--debug=2' to troubleshoot the reason. '--debug' or '--debug=2' to troubleshoot.
'--infer-value' can infer market prices from: '--infer-value' can infer market prices from:
@ -1531,18 +1530,16 @@ follows, in this order of preference:
'--infer-value' flag is used: the price commodity from the latest '--infer-value' flag is used: the price commodity from the latest
transaction-inferred price for A on or before valuation date. transaction-inferred price for A on or before valuation date.
Amounts for which no valuation commodity can be found are not
converted.
This means: This means:
* If you have any P directives, they alone determine which * If you have P directives, they determine which commodities '-V'
commodities '-V' will convert, and to what. will convert, and to what.
* If you have no P directives, and you add the '--infer-value' flag, * If you have no P directives, and use the '--infer-value' flag,
transaction prices determine what '-V' converts. transaction prices determine it.
* '-X' tries harder to convert everything to just one commodity. Amounts for which no valuation commodity can be found are not
converted.
 
File: hledger.info, Node: Simple valuation examples, Next: --value Flexible valuation, Prev: Valuation commodity, Up: Valuation File: hledger.info, Node: Simple valuation examples, Next: --value Flexible valuation, Prev: Valuation commodity, Up: Valuation
@ -3861,197 +3858,197 @@ $ LANG=en_US.UTF-8 hledger -f my.journal print
 
Tag Table: Tag Table:
Node: Top68 Node: Top68
Node: COMMON TASKS2315 Node: COMMON TASKS2321
Ref: #common-tasks2427 Ref: #common-tasks2433
Node: Getting help2834 Node: Getting help2840
Ref: #getting-help2966 Ref: #getting-help2972
Node: Constructing command lines3519 Node: Constructing command lines3525
Ref: #constructing-command-lines3711 Ref: #constructing-command-lines3717
Node: Starting a journal file4408 Node: Starting a journal file4414
Ref: #starting-a-journal-file4606 Ref: #starting-a-journal-file4612
Node: Setting opening balances5794 Node: Setting opening balances5800
Ref: #setting-opening-balances5990 Ref: #setting-opening-balances5996
Node: Recording transactions9131 Node: Recording transactions9137
Ref: #recording-transactions9311 Ref: #recording-transactions9317
Node: Reconciling9867 Node: Reconciling9873
Ref: #reconciling10010 Ref: #reconciling10016
Node: Reporting12267 Node: Reporting12273
Ref: #reporting12407 Ref: #reporting12413
Node: Migrating to a new file16406 Node: Migrating to a new file16412
Ref: #migrating-to-a-new-file16554 Ref: #migrating-to-a-new-file16560
Node: OPTIONS16853 Node: OPTIONS16859
Ref: #options16960 Ref: #options16966
Node: General options17330 Node: General options17336
Ref: #general-options17455 Ref: #general-options17461
Node: Command options20409 Node: Command options20415
Ref: #command-options20560 Ref: #command-options20566
Node: Command arguments20958 Node: Command arguments20964
Ref: #command-arguments21105 Ref: #command-arguments21111
Node: Queries21985 Node: Queries21991
Ref: #queries22140 Ref: #queries22146
Node: Special characters in arguments and queries26102 Node: Special characters in arguments and queries26108
Ref: #special-characters-in-arguments-and-queries26330 Ref: #special-characters-in-arguments-and-queries26336
Node: More escaping26781 Node: More escaping26787
Ref: #more-escaping26943 Ref: #more-escaping26949
Node: Even more escaping27239 Node: Even more escaping27245
Ref: #even-more-escaping27433 Ref: #even-more-escaping27439
Node: Less escaping28104 Node: Less escaping28110
Ref: #less-escaping28266 Ref: #less-escaping28272
Node: Unicode characters28511 Node: Unicode characters28517
Ref: #unicode-characters28693 Ref: #unicode-characters28699
Node: Input files30105 Node: Input files30111
Ref: #input-files30248 Ref: #input-files30254
Node: Output destination32177 Node: Output destination32183
Ref: #output-destination32329 Ref: #output-destination32335
Node: Output format32754 Node: Output format32760
Ref: #output-format32904 Ref: #output-format32910
Node: Regular expressions34486 Node: Regular expressions34492
Ref: #regular-expressions34643 Ref: #regular-expressions34649
Node: Smart dates36379 Node: Smart dates36385
Ref: #smart-dates36530 Ref: #smart-dates36536
Node: Report start & end date37891 Node: Report start & end date37897
Ref: #report-start-end-date38063 Ref: #report-start-end-date38069
Node: Report intervals39560 Node: Report intervals39566
Ref: #report-intervals39725 Ref: #report-intervals39731
Node: Period expressions40115 Node: Period expressions40121
Ref: #period-expressions40275 Ref: #period-expressions40281
Node: Depth limiting44411 Node: Depth limiting44417
Ref: #depth-limiting44555 Ref: #depth-limiting44561
Node: Pivoting44887 Node: Pivoting44893
Ref: #pivoting45010 Ref: #pivoting45016
Node: Valuation46686 Node: Valuation46692
Ref: #valuation46788 Ref: #valuation46794
Node: -B Cost47588 Node: -B Cost47483
Ref: #b-cost47692 Ref: #b-cost47587
Node: -V Value47825 Node: -V Value47720
Ref: #v-value47971 Ref: #v-value47866
Node: -X Value in specified commodity48173 Node: -X Value in specified commodity48061
Ref: #x-value-in-specified-commodity48372 Ref: #x-value-in-specified-commodity48260
Node: Valuation date48476 Node: Valuation date48409
Ref: #valuation-date48644 Ref: #valuation-date48577
Node: Market prices48888 Node: Market prices48987
Ref: #market-prices49068 Ref: #market-prices49167
Node: --infer-value market prices from transactions49845 Node: --infer-value market prices from transactions49944
Ref: #infer-value-market-prices-from-transactions50094 Ref: #infer-value-market-prices-from-transactions50193
Node: Valuation commodity51385 Node: Valuation commodity51475
Ref: #valuation-commodity51594 Ref: #valuation-commodity51684
Node: Simple valuation examples52919 Node: Simple valuation examples52910
Ref: #simple-valuation-examples53121 Ref: #simple-valuation-examples53112
Node: --value Flexible valuation53780 Node: --value Flexible valuation53771
Ref: #value-flexible-valuation53988 Ref: #value-flexible-valuation53979
Node: More valuation examples55935 Node: More valuation examples55926
Ref: #more-valuation-examples56144 Ref: #more-valuation-examples56135
Node: Effect of valuation on reports58149 Node: Effect of valuation on reports58140
Ref: #effect-of-valuation-on-reports58337 Ref: #effect-of-valuation-on-reports58328
Node: COMMANDS63858 Node: COMMANDS63849
Ref: #commands63966 Ref: #commands63957
Node: accounts65050 Node: accounts65041
Ref: #accounts65148 Ref: #accounts65139
Node: activity65847 Node: activity65838
Ref: #activity65957 Ref: #activity65948
Node: add66340 Node: add66331
Ref: #add66439 Ref: #add66430
Node: balance69178 Node: balance69169
Ref: #balance69289 Ref: #balance69280
Node: Classic balance report70747 Node: Classic balance report70738
Ref: #classic-balance-report70920 Ref: #classic-balance-report70911
Node: Customising the classic balance report72289 Node: Customising the classic balance report72280
Ref: #customising-the-classic-balance-report72517 Ref: #customising-the-classic-balance-report72508
Node: Colour support74593 Node: Colour support74584
Ref: #colour-support74760 Ref: #colour-support74751
Node: Flat mode74933 Node: Flat mode74924
Ref: #flat-mode75081 Ref: #flat-mode75072
Node: Depth limited balance reports75494 Node: Depth limited balance reports75485
Ref: #depth-limited-balance-reports75679 Ref: #depth-limited-balance-reports75670
Node: Percentages76135 Node: Percentages76126
Ref: #percentages76301 Ref: #percentages76292
Node: Multicolumn balance report77438 Node: Multicolumn balance report77429
Ref: #multicolumn-balance-report77618 Ref: #multicolumn-balance-report77609
Node: Budget report82880 Node: Budget report82871
Ref: #budget-report83023 Ref: #budget-report83014
Node: Nested budgets88289 Node: Nested budgets88280
Ref: #nested-budgets88401 Ref: #nested-budgets88392
Ref: #output-format-191882 Ref: #output-format-191873
Node: balancesheet92079 Node: balancesheet92070
Ref: #balancesheet92215 Ref: #balancesheet92206
Node: balancesheetequity93681 Node: balancesheetequity93672
Ref: #balancesheetequity93830 Ref: #balancesheetequity93821
Node: cashflow94553 Node: cashflow94544
Ref: #cashflow94681 Ref: #cashflow94672
Node: check-dates95860 Node: check-dates95851
Ref: #check-dates95987 Ref: #check-dates95978
Node: check-dupes96266 Node: check-dupes96257
Ref: #check-dupes96390 Ref: #check-dupes96381
Node: close96683 Node: close96674
Ref: #close96797 Ref: #close96788
Node: close usage98319 Node: close usage98310
Ref: #close-usage98412 Ref: #close-usage98403
Node: commodities101225 Node: commodities101216
Ref: #commodities101352 Ref: #commodities101343
Node: descriptions101434 Node: descriptions101425
Ref: #descriptions101562 Ref: #descriptions101553
Node: diff101743 Node: diff101734
Ref: #diff101849 Ref: #diff101840
Node: files102896 Node: files102887
Ref: #files102996 Ref: #files102987
Node: help103143 Node: help103134
Ref: #help103243 Ref: #help103234
Node: import104324 Node: import104315
Ref: #import104438 Ref: #import104429
Node: Importing balance assignments105331 Node: Importing balance assignments105322
Ref: #importing-balance-assignments105479 Ref: #importing-balance-assignments105470
Node: incomestatement106128 Node: incomestatement106119
Ref: #incomestatement106261 Ref: #incomestatement106252
Node: notes107748 Node: notes107739
Ref: #notes107861 Ref: #notes107852
Node: payees107987 Node: payees107978
Ref: #payees108093 Ref: #payees108084
Node: prices108251 Node: prices108242
Ref: #prices108357 Ref: #prices108348
Node: print108698 Node: print108689
Ref: #print108808 Ref: #print108799
Node: print-unique113594 Node: print-unique113585
Ref: #print-unique113720 Ref: #print-unique113711
Node: register114005 Node: register113996
Ref: #register114132 Ref: #register114123
Node: Custom register output118304 Node: Custom register output118295
Ref: #custom-register-output118433 Ref: #custom-register-output118424
Node: register-match119770 Node: register-match119761
Ref: #register-match119904 Ref: #register-match119895
Node: rewrite120255 Node: rewrite120246
Ref: #rewrite120370 Ref: #rewrite120361
Node: Re-write rules in a file122225 Node: Re-write rules in a file122216
Ref: #re-write-rules-in-a-file122359 Ref: #re-write-rules-in-a-file122350
Node: Diff output format123569 Node: Diff output format123560
Ref: #diff-output-format123738 Ref: #diff-output-format123729
Node: rewrite vs print --auto124830 Node: rewrite vs print --auto124821
Ref: #rewrite-vs.-print---auto125009 Ref: #rewrite-vs.-print---auto125000
Node: roi125565 Node: roi125556
Ref: #roi125663 Ref: #roi125654
Node: stats126675 Node: stats126666
Ref: #stats126774 Ref: #stats126765
Node: tags127562 Node: tags127553
Ref: #tags127660 Ref: #tags127651
Node: test127954 Node: test127945
Ref: #test128062 Ref: #test128053
Node: Add-on commands128809 Node: Add-on commands128800
Ref: #add-on-commands128926 Ref: #add-on-commands128917
Node: ui130269 Node: ui130260
Ref: #ui130357 Ref: #ui130348
Node: web130411 Node: web130402
Ref: #web130514 Ref: #web130505
Node: iadd130630 Node: iadd130621
Ref: #iadd130741 Ref: #iadd130732
Node: interest130823 Node: interest130814
Ref: #interest130930 Ref: #interest130921
Node: ENVIRONMENT131170 Node: ENVIRONMENT131161
Ref: #environment131282 Ref: #environment131273
Node: FILES132111 Node: FILES132102
Ref: #files-1132214 Ref: #files-1132205
Node: LIMITATIONS132427 Node: LIMITATIONS132418
Ref: #limitations132546 Ref: #limitations132537
Node: TROUBLESHOOTING133288 Node: TROUBLESHOOTING133279
Ref: #troubleshooting133401 Ref: #troubleshooting133392
 
End Tag Table End Tag Table

View File

@ -1190,17 +1190,11 @@ OPTIONS
Valuation Valuation
Instead of reporting amounts in their original commodity, hledger can Instead of reporting amounts in their original commodity, hledger can
convert them to: convert them to cost/sale amount (using the conversion rate recorded in
the transaction), or to market value (using some market price on a cer-
o cost (or sale amount), using the conversion rate recorded as part of tain date). This is controlled by the --value=TYPE[,COMMODITY] option,
the transaction (transaction price). but we also provide the simpler -B/-V/-X flags, and usually one of
those is all you need.
o value, using the market prices in effect on certain date(s).
We call this "valuation", and it is controlled in full by the
--value=VALUATIONTYPE[,COMMODITY] option. But we also provide simpler,
Ledger-compatible -B/-V/-X flags, and usually one of these is all you
need:
-B: Cost -B: Cost
The -B/--cost flag converts amounts to their cost or sale amount at The -B/--cost flag converts amounts to their cost or sale amount at
@ -1209,13 +1203,18 @@ OPTIONS
-V: Value -V: Value
The -V/--market flag converts amounts to market value in their default The -V/--market flag converts amounts to market value in their default
valuation commodity, using the market prices in effect on the valuation valuation commodity, using the market prices in effect on the valuation
date(s), if any. More on these things in a minute. date(s), if any. More on these in a minute.
-X: Value in specified commodity -X: Value in specified commodity
The -X/--exchange option is like -V except the desired valuation cur- The -X/--exchange=COMM option is like -V, except you tell it which cur-
rency is specified explicitly. rency you want to convert to, and it tries to convert everything to
that.
Valuation date Valuation date
Since market prices can change from day to day, market value reports
have a valuation date (or more than one), which determines which market
prices will be used.
For single period reports, if an explicit report end date is specified, For single period reports, if an explicit report end date is specified,
that will be used as the valuation date; otherwise the valuation date that will be used as the valuation date; otherwise the valuation date
is "today". is "today".
@ -1259,10 +1258,10 @@ OPTIONS
for example, hledger bs -V --infer-value will get market prices both for example, hledger bs -V --infer-value will get market prices both
from P directives and from transactions. from P directives and from transactions.
There is a downside to this: value reports can be affected in confus- There is a downside: value reports can sometimes be affected in confus-
ing/undesired ways by your journal entries. If this happens to you, ing/undesired ways by your journal entries. If this happens to you,
read all of this Valuation section carefully, and try adding --debug or read all of this Valuation section carefully, and try adding --debug or
--debug=2 to troubleshoot the reason. --debug=2 to troubleshoot.
--infer-value can infer market prices from: --infer-value can infer market prices from:
@ -1298,18 +1297,16 @@ OPTIONS
--infer-value flag is used: the price commodity from the latest --infer-value flag is used: the price commodity from the latest
transaction-inferred price for A on or before valuation date. transaction-inferred price for A on or before valuation date.
Amounts for which no valuation commodity can be found are not con-
verted.
This means: This means:
o If you have any P directives, they alone determine which commodities o If you have P directives, they determine which commodities -V will
-V will convert, and to what. convert, and to what.
o If you have no P directives, and you add the --infer-value flag, o If you have no P directives, and use the --infer-value flag, transac-
transaction prices determine what -V converts. tion prices determine it.
o -X tries harder to convert everything to just one commodity. Amounts for which no valuation commodity can be found are not con-
verted.
Simple valuation examples Simple valuation examples
Here are some quick examples of -V: Here are some quick examples of -V:
@ -1557,9 +1554,6 @@ OPTIONS
ages (with played val- played val- played val- values ages (with played val- played val- played val- values
report in- ues ues ues report in- ues ues ues
terval) terval)
column to- sums of dis- sums of dis- not supported sums of dis- sums of dis- column to- sums of dis- sums of dis- not supported sums of dis- sums of dis-
tals played val- played val- played val- played values tals played val- played val- played val- played values
ues ues ues ues ues ues
@ -3285,4 +3279,4 @@ SEE ALSO
hledger 1.18 June 2020 hledger(1) hledger 1.18.99 June 2020 hledger(1)