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

;doc: regen manuals

Browse Source
This commit is contained in:
Simon Michael 2019-09-05 15:35:44 -07:00
parent cd5af48165
commit 7ae75022bf
15 changed files with 1139 additions and 974 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-lib/hledger_csv.5
View File

@ -1,5 +1,5 @@
.TH "hledger_csv" "5" "August 2019" "hledger 1.15" "hledger User Manuals" .TH "hledger_csv" "5" "September 2019" "hledger 1.15.2" "hledger User Manuals"

64
hledger-lib/hledger_csv.info
View File

@ -3,8 +3,8 @@ This is hledger_csv.info, produced by makeinfo version 6.5 from stdin.
 
File: hledger_csv.info, Node: Top, Next: CSV RULES, Up: (dir) File: hledger_csv.info, Node: Top, Next: CSV RULES, Up: (dir)
hledger_csv(5) hledger 1.15 hledger_csv(5) hledger 1.15.2
*************************** *****************************
hledger can read CSV (comma-separated value) files as if they were hledger can read CSV (comma-separated value) files as if they were
journal files, automatically converting each CSV record into a journal files, automatically converting each CSV record into a
@ -350,35 +350,35 @@ character.
 
Tag Table: Tag Table:
Node: Top72 Node: Top72
Node: CSV RULES2161 Node: CSV RULES2165
Ref: #csv-rules2269 Ref: #csv-rules2273
Node: skip2532 Node: skip2536
Ref: #skip2626 Ref: #skip2630
Node: date-format2798 Node: date-format2802
Ref: #date-format2925 Ref: #date-format2929
Node: field list3475 Node: field list3479
Ref: #field-list3612 Ref: #field-list3616
Node: field assignment4342 Node: field assignment4346
Ref: #field-assignment4497 Ref: #field-assignment4501
Node: conditional block5121 Node: conditional block5125
Ref: #conditional-block5275 Ref: #conditional-block5279
Node: include6171 Node: include6175
Ref: #include6301 Ref: #include6305
Node: newest-first6532 Node: newest-first6536
Ref: #newest-first6646 Ref: #newest-first6650
Node: CSV TIPS7057 Node: CSV TIPS7061
Ref: #csv-tips7151 Ref: #csv-tips7155
Node: CSV ordering7295 Node: CSV ordering7299
Ref: #csv-ordering7413 Ref: #csv-ordering7417
Node: CSV accounts7594 Node: CSV accounts7598
Ref: #csv-accounts7732 Ref: #csv-accounts7736
Node: CSV amounts7986 Node: CSV amounts7990
Ref: #csv-amounts8144 Ref: #csv-amounts8148
Node: CSV balance assertions/assignments9224 Node: CSV balance assertions/assignments9228
Ref: #csv-balance-assertionsassignments9442 Ref: #csv-balance-assertionsassignments9446
Node: Reading multiple CSV files9763 Node: Reading multiple CSV files9767
Ref: #reading-multiple-csv-files9963 Ref: #reading-multiple-csv-files9967
Node: Valid CSV10237 Node: Valid CSV10241
Ref: #valid-csv10360 Ref: #valid-csv10364
 
End Tag Table End Tag Table

2
hledger-lib/hledger_csv.txt
View File

@ -276,4 +276,4 @@ SEE ALSO
hledger 1.15 August 2019 hledger_csv(5) hledger 1.15.2 September 2019 hledger_csv(5)

2
hledger-lib/hledger_journal.5
View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "hledger_journal" "5" "August 2019" "hledger 1.15" "hledger User Manuals" .TH "hledger_journal" "5" "September 2019" "hledger 1.15.2" "hledger User Manuals"

220
hledger-lib/hledger_journal.info
View File

@ -4,8 +4,8 @@ stdin.
 
File: hledger_journal.info, Node: Top, Next: FILE FORMAT, Up: (dir) File: hledger_journal.info, Node: Top, Next: FILE FORMAT, Up: (dir)
hledger_journal(5) hledger 1.15 hledger_journal(5) hledger 1.15.2
******************************* *********************************
hledger's usual data source is a plain text file containing journal hledger's usual data source is a plain text file containing journal
entries in hledger journal format. This file represents a standard entries in hledger journal format. This file represents a standard
@ -1668,113 +1668,113 @@ See the [[Cookbook]] at hledger.org for the latest information.
 
Tag Table: Tag Table:
Node: Top76 Node: Top76
Node: FILE FORMAT2352 Node: FILE FORMAT2356
Ref: #file-format2476 Ref: #file-format2480
Node: Transactions2779 Node: Transactions2783
Ref: #transactions2900 Ref: #transactions2904
Node: Postings3584 Node: Postings3588
Ref: #postings3711 Ref: #postings3715
Node: Dates4706 Node: Dates4710
Ref: #dates4821 Ref: #dates4825
Node: Simple dates4886 Node: Simple dates4890
Ref: #simple-dates5012 Ref: #simple-dates5016
Node: Secondary dates5378 Node: Secondary dates5382
Ref: #secondary-dates5532 Ref: #secondary-dates5536
Node: Posting dates7095 Node: Posting dates7099
Ref: #posting-dates7224 Ref: #posting-dates7228
Node: Status8596 Node: Status8600
Ref: #status8716 Ref: #status8720
Node: Description10424 Node: Description10428
Ref: #description10562 Ref: #description10566
Node: Payee and note10882 Node: Payee and note10886
Ref: #payee-and-note10996 Ref: #payee-and-note11000
Node: Account names11331 Node: Account names11335
Ref: #account-names11474 Ref: #account-names11478
Node: Amounts11961 Node: Amounts11965
Ref: #amounts12097 Ref: #amounts12101
Node: Virtual Postings15114 Node: Virtual Postings15118
Ref: #virtual-postings15273 Ref: #virtual-postings15277
Node: Balance Assertions16493 Node: Balance Assertions16497
Ref: #balance-assertions16668 Ref: #balance-assertions16672
Node: Assertions and ordering17627 Node: Assertions and ordering17631
Ref: #assertions-and-ordering17813 Ref: #assertions-and-ordering17817
Node: Assertions and included files18513 Node: Assertions and included files18517
Ref: #assertions-and-included-files18754 Ref: #assertions-and-included-files18758
Node: Assertions and multiple -f options19087 Node: Assertions and multiple -f options19091
Ref: #assertions-and-multiple--f-options19341 Ref: #assertions-and-multiple--f-options19345
Node: Assertions and commodities19473 Node: Assertions and commodities19477
Ref: #assertions-and-commodities19703 Ref: #assertions-and-commodities19707
Node: Assertions and prices20859 Node: Assertions and prices20863
Ref: #assertions-and-prices21071 Ref: #assertions-and-prices21075
Node: Assertions and subaccounts21511 Node: Assertions and subaccounts21515
Ref: #assertions-and-subaccounts21738 Ref: #assertions-and-subaccounts21742
Node: Assertions and virtual postings22062 Node: Assertions and virtual postings22066
Ref: #assertions-and-virtual-postings22302 Ref: #assertions-and-virtual-postings22306
Node: Assertions and precision22444 Node: Assertions and precision22448
Ref: #assertions-and-precision22635 Ref: #assertions-and-precision22639
Node: Balance Assignments22902 Node: Balance Assignments22906
Ref: #balance-assignments23083 Ref: #balance-assignments23087
Node: Balance assignments and prices24248 Node: Balance assignments and prices24252
Ref: #balance-assignments-and-prices24420 Ref: #balance-assignments-and-prices24424
Node: Transaction prices24644 Node: Transaction prices24648
Ref: #transaction-prices24813 Ref: #transaction-prices24817
Node: Comments27079 Node: Comments27083
Ref: #comments27213 Ref: #comments27217
Node: Tags28383 Node: Tags28387
Ref: #tags28501 Ref: #tags28505
Node: Directives29894 Node: Directives29898
Ref: #directives30037 Ref: #directives30041
Node: Comment blocks35645 Node: Comment blocks35649
Ref: #comment-blocks35790 Ref: #comment-blocks35794
Node: Including other files35966 Node: Including other files35970
Ref: #including-other-files36146 Ref: #including-other-files36150
Node: Default year36554 Node: Default year36558
Ref: #default-year36723 Ref: #default-year36727
Node: Declaring commodities37130 Node: Declaring commodities37134
Ref: #declaring-commodities37313 Ref: #declaring-commodities37317
Node: Default commodity38742 Node: Default commodity38746
Ref: #default-commodity38918 Ref: #default-commodity38922
Node: Market prices39552 Node: Market prices39556
Ref: #market-prices39717 Ref: #market-prices39721
Node: Declaring accounts40558 Node: Declaring accounts40562
Ref: #declaring-accounts40734 Ref: #declaring-accounts40738
Node: Account comments41659 Node: Account comments41663
Ref: #account-comments41822 Ref: #account-comments41826
Node: Account subdirectives42217 Node: Account subdirectives42221
Ref: #account-subdirectives42412 Ref: #account-subdirectives42416
Node: Account types42725 Node: Account types42729
Ref: #account-types42909 Ref: #account-types42913
Node: Account display order44551 Node: Account display order44555
Ref: #account-display-order44721 Ref: #account-display-order44725
Node: Rewriting accounts45850 Node: Rewriting accounts45854
Ref: #rewriting-accounts46035 Ref: #rewriting-accounts46039
Node: Basic aliases46771 Node: Basic aliases46775
Ref: #basic-aliases46917 Ref: #basic-aliases46921
Node: Regex aliases47621 Node: Regex aliases47625
Ref: #regex-aliases47793 Ref: #regex-aliases47797
Node: Combining aliases48511 Node: Combining aliases48515
Ref: #combining-aliases48689 Ref: #combining-aliases48693
Node: end aliases49965 Node: end aliases49969
Ref: #end-aliases50113 Ref: #end-aliases50117
Node: Default parent account50214 Node: Default parent account50218
Ref: #default-parent-account50380 Ref: #default-parent-account50384
Node: Periodic transactions51264 Node: Periodic transactions51268
Ref: #periodic-transactions51462 Ref: #periodic-transactions51466
Node: Two spaces after the period expression52588 Node: Two spaces after the period expression52592
Ref: #two-spaces-after-the-period-expression52833 Ref: #two-spaces-after-the-period-expression52837
Node: Forecasting with periodic transactions53318 Node: Forecasting with periodic transactions53322
Ref: #forecasting-with-periodic-transactions53608 Ref: #forecasting-with-periodic-transactions53612
Node: Budgeting with periodic transactions55634 Node: Budgeting with periodic transactions55638
Ref: #budgeting-with-periodic-transactions55873 Ref: #budgeting-with-periodic-transactions55877
Node: Auto postings / transaction modifiers56332 Node: Auto postings / transaction modifiers56336
Ref: #auto-postings-transaction-modifiers56543 Ref: #auto-postings-transaction-modifiers56547
Node: Auto postings and dates58772 Node: Auto postings and dates58776
Ref: #auto-postings-and-dates59029 Ref: #auto-postings-and-dates59033
Node: Auto postings and transaction balancing / inferred amounts / balance assertions59204 Node: Auto postings and transaction balancing / inferred amounts / balance assertions59208
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions59579 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions59583
Node: Auto posting tags59957 Node: Auto posting tags59961
Ref: #auto-posting-tags60196 Ref: #auto-posting-tags60200
Node: EDITOR SUPPORT60861 Node: EDITOR SUPPORT60865
Ref: #editor-support60979 Ref: #editor-support60983
 
End Tag Table End Tag Table

2
hledger-lib/hledger_journal.txt
View File

@ -1362,4 +1362,4 @@ SEE ALSO
hledger 1.15 August 2019 hledger_journal(5) hledger 1.15.2 September 2019 hledger_journal(5)

2
hledger-lib/hledger_timeclock.5
View File

@ -1,5 +1,5 @@
.TH "hledger_timeclock" "5" "August 2019" "hledger 1.15" "hledger User Manuals" .TH "hledger_timeclock" "5" "September 2019" "hledger 1.15.2" "hledger User Manuals"

4
hledger-lib/hledger_timeclock.info
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.15 hledger_timeclock(5) hledger 1.15.2
********************************* ***********************************
hledger can read timeclock files. As with Ledger, these are (a subset hledger can read timeclock files. As with Ledger, these are (a subset
of) timeclock.el's format, containing clock-in and clock-out entries as of) timeclock.el's format, containing clock-in and clock-out entries as

2
hledger-lib/hledger_timeclock.txt
View File

@ -78,4 +78,4 @@ SEE ALSO
hledger 1.15 August 2019 hledger_timeclock(5) hledger 1.15.2 September 2019 hledger_timeclock(5)

2
hledger-lib/hledger_timedot.5
View File

@ -1,5 +1,5 @@
.TH "hledger_timedot" "5" "August 2019" "hledger 1.15" "hledger User Manuals" .TH "hledger_timedot" "5" "September 2019" "hledger 1.15.2" "hledger User Manuals"

8
hledger-lib/hledger_timedot.info
View File

@ -4,8 +4,8 @@ stdin.
 
File: hledger_timedot.info, Node: Top, Next: FILE FORMAT, Up: (dir) File: hledger_timedot.info, Node: Top, Next: FILE FORMAT, Up: (dir)
hledger_timedot(5) hledger 1.15 hledger_timedot(5) hledger 1.15.2
******************************* *********************************
Timedot is a plain text format for logging dated, categorised quantities Timedot is a plain text format for logging dated, categorised quantities
(of time, usually), supported by hledger. It is convenient for (of time, usually), supported by hledger. It is convenient for
@ -111,7 +111,7 @@ $ hledger -f t.timedot --alias /\\./=: bal date:2016/2/4
 
Tag Table: Tag Table:
Node: Top76 Node: Top76
Node: FILE FORMAT808 Node: FILE FORMAT812
Ref: #file-format909 Ref: #file-format913
 
End Tag Table End Tag Table

2
hledger-lib/hledger_timedot.txt
View File

@ -124,4 +124,4 @@ SEE ALSO
hledger 1.15 August 2019 hledger_timedot(5) hledger 1.15.2 September 2019 hledger_timedot(5)

313
hledger/hledger.1
View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "hledger" "1" "August 2019" "hledger 1.15" "hledger User Manuals" .TH "hledger" "1" "September 2019" "hledger 1.15.2" "hledger User Manuals"
@ -1015,10 +1015,9 @@ This flag is equivalent to \f[C]--value=cost\f[R], described below.
The \f[C]-V/--market\f[R] flag converts reported amounts to their market The \f[C]-V/--market\f[R] flag converts reported amounts to their market
value in a default valuation commodity, using the market prices in value in a default valuation commodity, using the market prices in
effect on a default valuation date. effect on a default valuation date.
For single period reports, the valuation date is today; for multiperiod For single period reports, the valuation date is today (equivalent to
reports, it is the last day of each subperiod. \f[C]--value=now\f[R]); for multiperiod reports, it is the last day of
It is equivalent to \f[C]--value=now\f[R] or \f[C]--value=end\f[R] (see each subperiod (equivalent to \f[C]--value=end\f[R]).
below).
.PP .PP
The default valuation commodity is the one referenced in the latest The default valuation commodity is the one referenced in the latest
applicable market price dated on or before the valuation date. applicable market price dated on or before the valuation date.
@ -1026,7 +1025,11 @@ If most of your P declarations lead to a single home currency, this will
usually be what you want. usually be what you want.
(To specify the commodity, see -X below.) (To specify the commodity, see -X below.)
.PP .PP
Here\[aq]s a quick example: Note that in hledger, market prices are always declared explicitly with
P directives; we do not infer them from transaction prices as Ledger
does.
.PP
Here\[aq]s a quick example of -V:
.IP .IP
.nf .nf
\f[C] \f[C]
@ -1070,20 +1073,13 @@ $ hledger -f t.j bal -N euros -V
$103.00 assets:euros $103.00 assets:euros
\f[R] \f[R]
.fi .fi
.PP
Note that in hledger, market prices are always declared explicitly with
P directives; we do not infer them from transaction prices as Ledger
does.
.SS -X: Market value in specified commodity .SS -X: Market value in specified commodity
.PP .PP
The \f[C]-X/--exchange\f[R] option is like \f[C]-V/--market\f[R] except The \f[C]-X/--exchange\f[R] option is like \f[C]-V\f[R], except it
it takes a commodity symbol argument, so that you can select a different specifies the target commodity you would like to convert to.
target commodity.
It is similar to the same option in Ledger, with the same caveat
mentioned above.
It is equivalent to \f[C]--value=now,COMM\f[R] or It is equivalent to \f[C]--value=now,COMM\f[R] or
\f[C]--value=end,COMM\f[R]. \f[C]--value=end,COMM\f[R].
.SS --value .SS --value: Flexible valuation
.PP .PP
\f[I](experimental, added 201905)\f[R] \f[I](experimental, added 201905)\f[R]
.PP .PP
@ -1101,43 +1097,36 @@ more general \f[C]--value\f[R] option:
- default valuation commodity (or COMM) using market prices at some date - default valuation commodity (or COMM) using market prices at some date
\f[R] \f[R]
.fi .fi
.SS Valuation type
.PP .PP
TYPE is one of these keywords, or their first letter, or a date (which The TYPE part basically selects either \[dq]cost\[dq], or \[dq]market
must be 8 digits with \f[C]-\f[R] or \f[C]/\f[R] or \f[C].\f[R] value\[dq] plus a valuation date:
separators):
.TP .TP
.B \f[C]--value=cost\f[R] .B \f[C]--value=cost\f[R]
Convert amounts to cost, using the prices recorded in transactions. Convert amounts to cost, using the prices recorded in transactions.
\f[C]-B\f[R]/\f[C]--cost\f[R] is equivalent to this.
.TP .TP
.B \f[C]--value=end\f[R] .B \f[C]--value=end\f[R]
Convert amounts to their value in default valuation commodity using Convert amounts to their value in a default valuation commodity, using
market prices on the last day of the report period (or of each subperiod market prices on the last day of the report period (or if unspecified,
in a multiperiod report). the journal\[aq]s end date); or in multiperiod reports, market prices on
When no report period is specified, uses the journal\[aq]s last the last day of each subperiod.
transaction date.
.TP .TP
.B \f[C]--value=now\f[R] .B \f[C]--value=now\f[R]
Convert amounts to their value in default valuation commodity using Convert amounts to their value in default valuation commodity using
current market prices (as of when report is generated). current market prices (as of when report is generated).
\f[C]-V\f[R]/\f[C]--market\f[R] is equivalent to this.
.TP .TP
.B \f[C]--value=YYYY-MM-DD\f[R] .B \f[C]--value=YYYY-MM-DD\f[R]
Convert amounts to their value in default valuation commodity using Convert amounts to their value in default valuation commodity using
market prices on this date. market prices on this date.
Eg \f[C]--value=2019-04-25\f[R].
.SS Valuation commodity
.PP .PP
The default valuation commodity is the commodity mentioned in the most The default valuation commodity is the commodity mentioned in the most
recent applicable market price declaration. recent applicable market price declaration.
When all your price declarations lead to a single home currency, this When all your price declarations lead to a single home currency, this
will usually do what you want. will usually do what you want.
.PP .PP
To select a different valuation commodity: write the commodity symbol To select a different valuation commodity, add the optional
after the valuation type, separated by a comma (eg: \f[C],COMM\f[R] part: a comma, then the target commodity\[aq]s symbol.
\f[B]\f[CB]--value=now,EUR\f[B]\f[R]). Eg: \f[B]\f[CB]--value=now,EUR\f[B]\f[R].
This will use, in this preferred order: hledger will do its best to convert amounts to this commodity, using:
.IP \[bu] 2 .IP \[bu] 2
declared prices (from source commodity to valuation commodity) declared prices (from source commodity to valuation commodity)
.IP \[bu] 2 .IP \[bu] 2
@ -1145,10 +1134,12 @@ reverse prices (declared prices from valuation to source commodity,
inverted) inverted)
.IP \[bu] 2 .IP \[bu] 2
indirect prices (prices calculated from the shortest chain of declared indirect prices (prices calculated from the shortest chain of declared
or reverse prices from source to valuation commodity). or reverse prices from source to valuation commodity)
.SS --value examples
.PP .PP
Here are the effects of \f[C]--value\f[R] as seen with \f[C]print\f[R]: in that order.
.PP
Here are some examples showing the effect of \f[C]--value\f[R] as seen
with \f[C]print\f[R]:
.IP .IP
.nf .nf
\f[C] \f[C]
@ -1297,25 +1288,28 @@ $ hledger print -X A
.fi .fi
.SS Effect of --value on reports .SS Effect of --value on reports
.PP .PP
Below is how \f[C]--value\f[R] affects each of hledger\[aq]s reports, Here is a reference for how \f[C]--value\f[R] currently affects each
currently. part of hledger\[aq]s reports.
You\[aq]re not expected to remember all this, but when troubleshooting a It\[aq]s work in progress, but may be useful for troubleshooting or
report, look here. reporting bugs.
If you find problems - useless reports, misbehaving reports, or error See also the definitions and notes below.
messages being printed - please report them (with reproducible examples) If you find problems, please report them, ideally with a reproducible
eg at #329. example.
Related: #329, #1083.
.PP .PP
.TS .TS
tab(@); tab(@);
lw(12.5n) lw(13.6n) lw(25.4n) lw(18.4n). lw(14.4n) lw(13.8n) lw(14.6n) lw(15.2n) lw(12.0n).
T{ T{
Report type Report type
T}@T{ T}@T{
\f[C]--value\f[R] \f[C]cost\f[R]\ \f[C]-B\f[R], \f[C]--value=cost\f[R]
T}@T{ T}@T{
\f[C]--value\f[R] \f[C]end\f[R]\ \f[C]-V\f[R], \f[C]-X\f[R]
T}@T{ T}@T{
\f[C]--value\f[R] \f[C]DATE\f[R]/\f[C]now\f[R]\ \f[C]--value=end\f[R]
T}@T{
\f[C]--value=DATE\f[R], \f[C]--value=now\f[R]
T} T}
_ _
T{ T{
@ -1323,119 +1317,224 @@ T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}
T{
posting amounts
T}@T{ T}@T{
cost, as recorded in transaction
T}@T{
market value at report end
T}@T{
market value at DATE
T}
T{
balance assertions/assignments
T}@T{
show unvalued
T}@T{
show unvalued
T}@T{
show unvalued
T}
T{
\f[B]register\f[R]
T}@T{
T}@T{
T}@T{
T}
T{
starting balance with -H
T}@T{
cost of starting balance
T}@T{
market value at day before report start
T}@T{
market value at DATE
T} T}
T{ T{
posting amounts posting amounts
T}@T{ T}@T{
cost cost
T}@T{ T}@T{
market value at report end value at report end or today
T}@T{ T}@T{
market value at DATE value at report or journal end
T}@T{
value at DATE/today
T} T}
T{ T{
posting amounts, multiperiod balance assertions / assignments
T}@T{
unchanged
T}@T{
unchanged
T}@T{
unchanged
T}@T{
unchanged
T}
T{
T}@T{
T}@T{
T}@T{
T}@T{
T}
T{
\f[B]register\f[R]
T}@T{
T}@T{
T}@T{
T}@T{
T}
T{
starting balance (with -H)
T}@T{
cost
T}@T{
value at day before report or journal start
T}@T{
value at day before report or journal start
T}@T{
value at DATE/today
T}
T{
posting amounts (no report interval)
T}@T{
cost
T}@T{
value at report end or today
T}@T{
value at report or journal end
T}@T{
value at DATE/today
T}
T{
summary posting amounts (with report interval)
T}@T{ T}@T{
summarised cost summarised cost
T}@T{ T}@T{
market value each summary posting at period end value at period ends
T}@T{ T}@T{
market value each summary posting at DATE value at period ends
T}@T{
value at DATE/today
T} T}
T{ T{
running total/average running total/average
T}@T{ T}@T{
sum/average of the displayed values sum/average of displayed values
T}@T{ T}@T{
sum/average of the displayed values sum/average of displayed values
T}@T{ T}@T{
sum/average of the displayed values sum/average of displayed values
T}@T{
sum/average of displayed values
T} T}
T{ T{
\f[B]balance (bs, cf, is..)\f[R] T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T} T}
T{ T{
starting balances with -H \f[B]balance (bs, bse, cf, is..)\f[R]
T}@T{
T}@T{ T}@T{
costs of starting balances
T}@T{ T}@T{
market value at day before report start of sum of previous postings
T}@T{ T}@T{
market value at DATE of sum of previous postings
T} T}
T{ T{
balances, simple balance report balances (no report interval)
T}@T{ T}@T{
summed costs sums of costs
T}@T{ T}@T{
market value at period end of sum of postings value at report end or today of sums of postings
T}@T{ T}@T{
market value at DATE of sum of postings value at report or journal end of sums of postings
T}@T{
value at DATE/today of sums of postings
T} T}
T{ T{
balances, multiperiod report balances (with report interval)
T}@T{ T}@T{
summed costs sums of costs
T}@T{ T}@T{
market value at period end of sum of postings value at period ends of sums of postings
T}@T{ T}@T{
market value at DATE of sum of postings value at period ends of sums of postings
T}@T{
value at DATE/today of sums of postings
T}
T{
starting balances (with report interval and -H)
T}@T{
sums of costs of postings before report start
T}@T{
sums of postings before report start
T}@T{
sums of postings before report start
T}@T{
sums of postings before report start
T} T}
T{ T{
budget amounts with --budget budget amounts with --budget
T}@T{ T}@T{
costs of budget amounts like balances
T}@T{ T}@T{
budget-setting periodic txns are valued at period end like balances
T}@T{ T}@T{
budget-setting periodic txns are valued at DATE like balances
T}@T{
like balances
T} T}
T{ T{
column/row/grand totals/averages grand total (no report interval)
T}@T{
sum of displayed values
T}@T{
sum of displayed values
T}@T{
sum of displayed values
T}@T{
sum of displayed values
T}
T{
row totals/averages (with report interval)
T}@T{
sums/averages of displayed values
T}@T{
sums/averages of displayed values
T}@T{
sums/averages of displayed values
T}@T{
sums/averages of displayed values
T}
T{
column totals
T}@T{
sums of displayed values
T}@T{
sums of displayed values
T}@T{
sums of displayed values
T}@T{
sums of displayed values
T}
T{
grand total/average
T}@T{
sum/average of column totals
T}@T{
sum/average of column totals
T}@T{
sum/average of column totals
T}@T{
sum/average of column totals
T}
T{
T}@T{
T}@T{ T}@T{
sum/average of the displayed values
T}@T{ T}@T{
market value at period end of sum/average of postings
T}@T{ T}@T{
market value at DATE of sum/average of postings
T} T}
.TE .TE
.PP
\f[B]Additional notes\f[R]
.TP
.B \f[I]cost\f[R]
calculated using price(s) recorded in the transaction(s).
.TP
.B \f[I]value\f[R]
market value using available market price declarations, or the unchanged
amount if no conversion rate can be found.
.TP
.B \f[I]report start\f[R]
the first day of the report period specified with -b or -p or date:,
otherwise today.
.TP
.B \f[I]report or journal start\f[R]
the first day of the report period specified with -b or -p or date:,
otherwise the earliest transaction date in the journal, otherwise today.
.TP
.B \f[I]report end\f[R]
the last day of the report period specified with -e or -p or date:,
otherwise today.
.TP
.B \f[I]report or journal end\f[R]
the last day of the report period specified with -e or -p or date:,
otherwise the latest transaction date in the journal, otherwise today.
.TP
.B \f[I]report interval\f[R]
a flag (-D/-W/-M/-Q/-Y) or period expression that activates the
report\[aq]s multi-period mode (whether showing one or many subperiods).
.SS Combining -B, -V, -X, --value .SS Combining -B, -V, -X, --value
.PP .PP
The rightmost of these flags wins. The rightmost of these flags wins.

597
hledger/hledger.info
View File

@ -3,8 +3,8 @@ This is hledger.info, produced by makeinfo version 6.5 from stdin.
 
File: hledger.info, Node: Top, Next: EXAMPLES, Up: (dir) File: hledger.info, Node: Top, Next: EXAMPLES, Up: (dir)
hledger(1) hledger 1.15 hledger(1) hledger 1.15.2
*********************** *************************
This is hledger's command-line interface (there are also curses and web This is hledger's command-line interface (there are also curses and web
interfaces). Its basic function is to read a plain text file describing interfaces). Its basic function is to read a plain text file describing
@ -753,7 +753,8 @@ File: hledger.info, Node: Valuation, Next: Output destination, Prev: Pivoting
* -B Cost:: * -B Cost::
* -V Market value:: * -V Market value::
* -X Market value in specified commodity:: * -X Market value in specified commodity::
* --value:: * --value Flexible valuation::
* Effect of --value on reports::
* Combining -B -V -X --value:: * Combining -B -V -X --value::
 
@ -775,15 +776,19 @@ File: hledger.info, Node: -V Market value, Next: -X Market value in specified
The '-V/--market' flag converts reported amounts to their market value The '-V/--market' flag converts reported amounts to their market value
in a default valuation commodity, using the market prices in effect on a in a default valuation commodity, using the market prices in effect on a
default valuation date. For single period reports, the valuation date default valuation date. For single period reports, the valuation date
is today; for multiperiod reports, it is the last day of each subperiod. is today (equivalent to '--value=now'); for multiperiod reports, it is
It is equivalent to '--value=now' or '--value=end' (see below). the last day of each subperiod (equivalent to '--value=end').
The default valuation commodity is the one referenced in the latest The default valuation commodity is the one referenced in the latest
applicable market price dated on or before the valuation date. If most applicable market price dated on or before the valuation date. If most
of your P declarations lead to a single home currency, this will usually of your P declarations lead to a single home currency, this will usually
be what you want. (To specify the commodity, see -X below.) be what you want. (To specify the commodity, see -X below.)
Here's a quick example: Note that in hledger, market prices are always declared explicitly
with P directives; we do not infer them from transaction prices as
Ledger does.
Here's a quick example of -V:
; one euro is worth this many dollars from nov 1 ; one euro is worth this many dollars from nov 1
P 2016/11/01 € $1.10 P 2016/11/01 € $1.10
@ -812,27 +817,21 @@ specified, defaults to today)
$ hledger -f t.j bal -N euros -V $ hledger -f t.j bal -N euros -V
$103.00 assets:euros $103.00 assets:euros
Note that in hledger, market prices are always declared explicitly
with P directives; we do not infer them from transaction prices as
Ledger does.
 
File: hledger.info, Node: -X Market value in specified commodity, Next: --value, Prev: -V Market value, Up: Valuation File: hledger.info, Node: -X Market value in specified commodity, Next: --value Flexible valuation, Prev: -V Market value, Up: Valuation
2.15.3 -X: Market value in specified commodity 2.15.3 -X: Market value in specified commodity
---------------------------------------------- ----------------------------------------------
The '-X/--exchange' option is like '-V/--market' except it takes a The '-X/--exchange' option is like '-V', except it specifies the target
commodity symbol argument, so that you can select a different target commodity you would like to convert to. It is equivalent to
commodity. It is similar to the same option in Ledger, with the same '--value=now,COMM' or '--value=end,COMM'.
caveat mentioned above. It is equivalent to '--value=now,COMM' or
'--value=end,COMM'.
 
File: hledger.info, Node: --value, Next: Combining -B -V -X --value, Prev: -X Market value in specified commodity, Up: Valuation File: hledger.info, Node: --value Flexible valuation, Next: Effect of --value on reports, Prev: -X Market value in specified commodity, Up: Valuation
2.15.4 -value 2.15.4 -value: Flexible valuation
------------- ---------------------------------
_(experimental, added 201905)_ _(experimental, added 201905)_
@ -847,70 +846,47 @@ option:
- default valuation commodity (or COMM) using current market prices - default valuation commodity (or COMM) using current market prices
- default valuation commodity (or COMM) using market prices at some date - default valuation commodity (or COMM) using market prices at some date
* Menu: The TYPE part basically selects either "cost", or "market value" plus
a valuation date:
* Valuation type::
* Valuation commodity::
* --value examples::
* Effect of --value on reports::

File: hledger.info, Node: Valuation type, Next: Valuation commodity, Up: --value
2.15.4.1 Valuation type
.......................
TYPE is one of these keywords, or their first letter, or a date (which
must be 8 digits with '-' or '/' or '.' separators):
'--value=cost' '--value=cost'
Convert amounts to cost, using the prices recorded in transactions. Convert amounts to cost, using the prices recorded in transactions.
'-B'/'--cost' is equivalent to this.
'--value=end' '--value=end'
Convert amounts to their value in default valuation commodity using Convert amounts to their value in a default valuation commodity,
market prices on the last day of the report period (or of each using market prices on the last day of the report period (or if
subperiod in a multiperiod report). When no report period is unspecified, the journal's end date); or in multiperiod reports,
specified, uses the journal's last transaction date. market prices on the last day of each subperiod.
'--value=now' '--value=now'
Convert amounts to their value in default valuation commodity using Convert amounts to their value in default valuation commodity using
current market prices (as of when report is generated). current market prices (as of when report is generated).
'-V'/'--market' is equivalent to this.
'--value=YYYY-MM-DD' '--value=YYYY-MM-DD'
Convert amounts to their value in default valuation commodity using Convert amounts to their value in default valuation commodity using
market prices on this date. Eg '--value=2019-04-25'. market prices on this date.
 The default valuation commodity is the commodity mentioned in the
File: hledger.info, Node: Valuation commodity, Next: --value examples, Prev: Valuation type, Up: --value most recent applicable market price declaration. When all your price
2.15.4.2 Valuation commodity
............................
The default valuation commodity is the commodity mentioned in the most
recent applicable market price declaration. When all your price
declarations lead to a single home currency, this will usually do what declarations lead to a single home currency, this will usually do what
you want. you want.
To select a different valuation commodity: write the commodity symbol To select a different valuation commodity, add the optional ',COMM'
after the valuation type, separated by a comma (eg: part: a comma, then the target commodity's symbol. Eg:
*'--value=now,EUR'*). This will use, in this preferred order: *'--value=now,EUR'*. hledger will do its best to convert amounts to
this commodity, using:
* declared prices (from source commodity to valuation commodity) * declared prices (from source commodity to valuation commodity)
* reverse prices (declared prices from valuation to source commodity, * reverse prices (declared prices from valuation to source commodity,
inverted) inverted)
* indirect prices (prices calculated from the shortest chain of * indirect prices (prices calculated from the shortest chain of
declared or reverse prices from source to valuation commodity). declared or reverse prices from source to valuation commodity)
 in that order.
File: hledger.info, Node: --value examples, Next: Effect of --value on reports, Prev: Valuation commodity, Up: --value
2.15.4.3 -value examples Here are some examples showing the effect of '--value' as seen with
........................ 'print':
Here are the effects of '--value' as seen with 'print':
P 2000-01-01 A 1 B P 2000-01-01 A 1 B
P 2000-02-01 A 2 B P 2000-02-01 A 2 B
@ -1018,65 +994,116 @@ $ hledger print -X A
b -0.50A b -0.50A
 
File: hledger.info, Node: Effect of --value on reports, Prev: --value examples, Up: --value File: hledger.info, Node: Effect of --value on reports, Next: Combining -B -V -X --value, Prev: --value Flexible valuation, Up: Valuation
2.15.4.4 Effect of -value on reports 2.15.5 Effect of -value on reports
.................................... ----------------------------------
Below is how '--value' affects each of hledger's reports, currently. Here is a reference for how '--value' currently affects each part of
You're not expected to remember all this, but when troubleshooting a hledger's reports. It's work in progress, but may be useful for
report, look here. If you find problems - useless reports, misbehaving troubleshooting or reporting bugs. See also the definitions and notes
reports, or error messages being printed - please report them (with below. If you find problems, please report them, ideally with a
reproducible examples) eg at #329. reproducible example. Related: #329, #1083.
Report type '--value' '--value' 'end' '--value' Report type '-B', '-V', '-X' '--value=end' '--value=DATE',
'cost' 'DATE'/'now' '--value=cost' '--value=now'
---------------------------------------------------------------------------- -----------------------------------------------------------------------------
*print* *print*
posting cost, as market value at report market value at posting cost value at value at value at
amounts recorded in end DATE amounts report end or report or DATE/today
transaction today journal end
balance show show unvalued show unvalued balance unchanged unchanged unchanged unchanged
assertions/assignmentsunvalued assertions /
assignments
*register* *register*
starting cost of market value at day market value at starting cost value at day value at day value at
balance starting before report start DATE balance (with before report before report DATE/today
with -H balance -H) or journal or journal
posting cost market value at report market value at start start
amounts end DATE posting cost value at value at value at
posting summarised market value each market value each amounts (no report end or report or DATE/today
amounts, cost summary posting at summary posting report today journal end
multiperiod period end at DATE interval)
running sum/average sum/average of the sum/average of summary summarised value at value at value at
total/average of the displayed values the displayed posting cost period ends period ends DATE/today
displayed values amounts (with
values
*balance
(bs, cf,
is..)*
starting costs of market value at day market value at
balances starting before report start of DATE of sum of
with -H balances sum of previous postings previous postings
balances, summed costs market value at period market value at
simple end of sum of postings DATE of sum of
balance postings
report report
balances, summed costs market value at period market value at interval)
multiperiod end of sum of postings DATE of sum of running sum/average sum/average sum/average of sum/average
report postings total/average of displayed of displayed displayed of
budget costs of budget-setting periodic budget-setting values values values displayed
amounts budget txns are valued at periodic txns are values
with amounts period end valued at DATE *balance (bs,
bse, cf,
is..)*
balances (no sums of value at value at value at
report costs report end or report or DATE/today
interval) today of sums journal end of of sums of
of postings sums of postings
postings
balances sums of value at value at value at
(with report costs period ends period ends of DATE/today
interval) of sums of sums of of sums of
postings postings postings
starting sums of sums of sums of sums of
balances costs of postings postings postings
(with report postings before report before report before
interval and before start start report
-H) report start start
budget like like balances like balances like
amounts with balances balances
-budget -budget
column/row/grandsum/average market value at period market value at grand total sum of sum of sum of sum of
totals/averagesof the end of sum/average of DATE of (no report displayed displayed displayed displayed
displayed postings sum/average of interval) values values values values
values postings row sums/averages sums/averages sums/averages sums/averages
totals/averages of displayed of displayed of displayed of
(with report values values values displayed
interval) values
column totals sums of sums of sums of sums of
displayed displayed displayed displayed
values values values values
grand sum/average sum/average sum/average of sum/average
total/average of column of column column totals of column
totals totals totals
*Additional notes*
_cost_
calculated using price(s) recorded in the transaction(s).
_value_
market value using available market price declarations, or the
unchanged amount if no conversion rate can be found.
_report start_
the first day of the report period specified with -b or -p or
date:, otherwise today.
_report or journal start_
the first day of the report period specified with -b or -p or
date:, otherwise the earliest transaction date in the journal,
otherwise today.
_report end_
the last day of the report period specified with -e or -p or date:,
otherwise today.
_report or journal end_
the last day of the report period specified with -e or -p or date:,
otherwise the latest transaction date in the journal, otherwise
today.
_report interval_
a flag (-D/-W/-M/-Q/-Y) or period expression that activates the
report's multi-period mode (whether showing one or many
subperiods).
 
File: hledger.info, Node: Combining -B -V -X --value, Prev: --value, Up: Valuation File: hledger.info, Node: Combining -B -V -X --value, Prev: Effect of --value on reports, Up: Valuation
2.15.5 Combining -B, -V, -X, -value 2.15.6 Combining -B, -V, -X, -value
----------------------------------- -----------------------------------
The rightmost of these flags wins. The rightmost of these flags wins.
@ -3133,185 +3160,179 @@ hledger-check.hs checks more powerful account balance assertions.
 
Tag Table: Tag Table:
Node: Top68 Node: Top68
Node: EXAMPLES1885 Node: EXAMPLES1889
Ref: #examples1985 Ref: #examples1989
Node: OPTIONS3631 Node: OPTIONS3635
Ref: #options3733 Ref: #options3737
Node: General options4132 Node: General options4136
Ref: #general-options4257 Ref: #general-options4261
Node: Command options6911 Node: Command options6915
Ref: #command-options7062 Ref: #command-options7066
Node: Command arguments7460 Node: Command arguments7464
Ref: #command-arguments7614 Ref: #command-arguments7618
Node: Argument files7735 Node: Argument files7739
Ref: #argument-files7911 Ref: #argument-files7915
Node: Special characters in arguments and queries8177 Node: Special characters in arguments and queries8181
Ref: #special-characters-in-arguments-and-queries8411 Ref: #special-characters-in-arguments-and-queries8415
Node: More escaping8862 Node: More escaping8866
Ref: #more-escaping9024 Ref: #more-escaping9028
Node: Even more escaping9320 Node: Even more escaping9324
Ref: #even-more-escaping9514 Ref: #even-more-escaping9518
Node: Less escaping10185 Node: Less escaping10189
Ref: #less-escaping10347 Ref: #less-escaping10351
Node: Command line tips10592 Node: Command line tips10596
Ref: #command-line-tips10778 Ref: #command-line-tips10782
Node: Unicode characters11155 Node: Unicode characters11159
Ref: #unicode-characters11311 Ref: #unicode-characters11315
Node: Input files12723 Node: Input files12727
Ref: #input-files12859 Ref: #input-files12863
Node: Smart dates14788 Node: Smart dates14792
Ref: #smart-dates14929 Ref: #smart-dates14933
Node: Report start & end date16335 Node: Report start & end date16339
Ref: #report-start-end-date16507 Ref: #report-start-end-date16511
Node: Report intervals17931 Node: Report intervals17935
Ref: #report-intervals18096 Ref: #report-intervals18100
Node: Period expressions18486 Node: Period expressions18490
Ref: #period-expressions18646 Ref: #period-expressions18650
Node: Depth limiting22603 Node: Depth limiting22607
Ref: #depth-limiting22747 Ref: #depth-limiting22751
Node: Pivoting23089 Node: Pivoting23093
Ref: #pivoting23212 Ref: #pivoting23216
Node: Valuation24888 Node: Valuation24892
Ref: #valuation25017 Ref: #valuation25021
Node: -B Cost25145 Node: -B Cost25201
Ref: #b-cost25256 Ref: #b-cost25312
Node: -V Market value25454 Node: -V Market value25510
Ref: #v-market-value25628 Ref: #v-market-value25684
Node: -X Market value in specified commodity27058 Node: -X Market value in specified commodity27116
Ref: #x-market-value-in-specified-commodity27278 Ref: #x-market-value-in-specified-commodity27355
Node: --value27572 Node: --value Flexible valuation27531
Ref: #value27737 Ref: #value-flexible-valuation27757
Node: Valuation type28538 Node: Effect of --value on reports31947
Ref: #valuation-type28674 Ref: #effect-of---value-on-reports32163
Node: Valuation commodity29559 Node: Combining -B -V -X --value37094
Ref: #valuation-commodity29730 Ref: #combining--b--v--x---value37277
Node: --value examples30430 Node: Output destination37313
Ref: #value-examples30607 Ref: #output-destination37465
Node: Effect of --value on reports32590 Node: Output format37748
Ref: #effect-of---value-on-reports32763 Ref: #output-format37900
Node: Combining -B -V -X --value35454 Node: Regular expressions38285
Ref: #combining--b--v--x---value35616 Ref: #regular-expressions38422
Node: Output destination35652 Node: QUERIES39783
Ref: #output-destination35804 Ref: #queries39885
Node: Output format36087 Node: COMMANDS43847
Ref: #output-format36239 Ref: #commands43959
Node: Regular expressions36624 Node: accounts45023
Ref: #regular-expressions36761 Ref: #accounts45121
Node: QUERIES38122 Node: activity45820
Ref: #queries38224 Ref: #activity45930
Node: COMMANDS42186 Node: add46313
Ref: #commands42298 Ref: #add46412
Node: accounts43362 Node: balance49157
Ref: #accounts43460 Ref: #balance49268
Node: activity44159 Node: Classic balance report50710
Ref: #activity44269 Ref: #classic-balance-report50883
Node: add44652 Node: Customising the classic balance report52252
Ref: #add44751 Ref: #customising-the-classic-balance-report52480
Node: balance47496 Node: Colour support54556
Ref: #balance47607 Ref: #colour-support54723
Node: Classic balance report49049 Node: Flat mode54896
Ref: #classic-balance-report49222 Ref: #flat-mode55044
Node: Customising the classic balance report50591 Node: Depth limited balance reports55457
Ref: #customising-the-classic-balance-report50819 Ref: #depth-limited-balance-reports55657
Node: Colour support52895 Node: Multicolumn balance report56113
Ref: #colour-support53062 Ref: #multicolumn-balance-report56311
Node: Flat mode53235 Node: Budget report61625
Ref: #flat-mode53383 Ref: #budget-report61768
Node: Depth limited balance reports53796 Node: Nested budgets66970
Ref: #depth-limited-balance-reports53996 Ref: #nested-budgets67082
Node: Multicolumn balance report54452 Ref: #output-format-170562
Ref: #multicolumn-balance-report54650 Node: balancesheet70640
Node: Budget report59964 Ref: #balancesheet70776
Ref: #budget-report60107 Node: balancesheetequity72091
Node: Nested budgets65309 Ref: #balancesheetequity72240
Ref: #nested-budgets65421 Node: cashflow72801
Ref: #output-format-168901 Ref: #cashflow72929
Node: balancesheet68979 Node: check-dates73957
Ref: #balancesheet69115 Ref: #check-dates74084
Node: balancesheetequity70430 Node: check-dupes74363
Ref: #balancesheetequity70579 Ref: #check-dupes74487
Node: cashflow71140 Node: close74780
Ref: #cashflow71268 Ref: #close74894
Node: check-dates72296 Node: commodities78481
Ref: #check-dates72423 Ref: #commodities78608
Node: check-dupes72702 Node: descriptions78690
Ref: #check-dupes72826 Ref: #descriptions78818
Node: close73119 Node: diff78999
Ref: #close73233 Ref: #diff79105
Node: commodities76820 Node: files80152
Ref: #commodities76947 Ref: #files80252
Node: descriptions77029 Node: help80399
Ref: #descriptions77157 Ref: #help80499
Node: diff77338 Node: import81592
Ref: #diff77444 Ref: #import81706
Node: files78491 Node: Importing balance assignments82494
Ref: #files78591 Ref: #importing-balance-assignments82642
Node: help78738 Node: incomestatement83291
Ref: #help78838 Ref: #incomestatement83424
Node: import79931 Node: notes84760
Ref: #import80045 Ref: #notes84873
Node: Importing balance assignments80833 Node: payees84999
Ref: #importing-balance-assignments80981 Ref: #payees85105
Node: incomestatement81630 Node: prices85263
Ref: #incomestatement81763 Ref: #prices85369
Node: notes83099 Node: print85648
Ref: #notes83212 Ref: #print85758
Node: payees83338 Node: print-unique90251
Ref: #payees83444 Ref: #print-unique90377
Node: prices83602 Node: register90662
Ref: #prices83708 Ref: #register90789
Node: print83987 Node: Custom register output94961
Ref: #print84097 Ref: #custom-register-output95090
Node: print-unique88590 Node: register-match96352
Ref: #print-unique88716 Ref: #register-match96486
Node: register89001 Node: rewrite96837
Ref: #register89128 Ref: #rewrite96952
Node: Custom register output93300 Node: Re-write rules in a file98807
Ref: #custom-register-output93429 Ref: #re-write-rules-in-a-file98941
Node: register-match94691 Node: Diff output format100151
Ref: #register-match94825 Ref: #diff-output-format100320
Node: rewrite95176 Node: rewrite vs print --auto101412
Ref: #rewrite95291 Ref: #rewrite-vs.-print---auto101591
Node: Re-write rules in a file97146 Node: roi102147
Ref: #re-write-rules-in-a-file97280 Ref: #roi102245
Node: Diff output format98490 Node: stats103257
Ref: #diff-output-format98659 Ref: #stats103356
Node: rewrite vs print --auto99751 Node: tags104144
Ref: #rewrite-vs.-print---auto99930 Ref: #tags104242
Node: roi100486 Node: test104536
Ref: #roi100584 Ref: #test104620
Node: stats101596 Node: ADD-ON COMMANDS105381
Ref: #stats101695 Ref: #add-on-commands105491
Node: tags102483 Node: Official add-ons106779
Ref: #tags102581 Ref: #official-add-ons106919
Node: test102875 Node: api107007
Ref: #test102959 Ref: #api107096
Node: ADD-ON COMMANDS103720 Node: ui107148
Ref: #add-on-commands103830 Ref: #ui107247
Node: Official add-ons105118 Node: web107305
Ref: #official-add-ons105258 Ref: #web107394
Node: api105346 Node: Third party add-ons107440
Ref: #api105435 Ref: #third-party-add-ons107615
Node: ui105487 Ref: #diff-1107774
Ref: #ui105586 Node: iadd107873
Node: web105644 Ref: #iadd107983
Ref: #web105733 Node: interest108066
Node: Third party add-ons105779 Ref: #interest108187
Ref: #third-party-add-ons105954 Node: irr108282
Ref: #diff-1106113 Ref: #irr108380
Node: iadd106212 Node: Experimental add-ons108511
Ref: #iadd106322 Ref: #experimental-add-ons108663
Node: interest106405 Node: autosync108944
Ref: #interest106526 Ref: #autosync109055
Node: irr106621 Node: chart109294
Ref: #irr106719 Ref: #chart109413
Node: Experimental add-ons106850 Node: check109484
Ref: #experimental-add-ons107002 Ref: #check109586
Node: autosync107283
Ref: #autosync107394
Node: chart107633
Ref: #chart107752
Node: check107823
Ref: #check107925
 
End Tag Table End Tag Table

187
hledger/hledger.txt
View File

@ -688,15 +688,19 @@ OPTIONS
The -V/--market flag converts reported amounts to their market value in The -V/--market flag converts reported amounts to their market value in
a default valuation commodity, using the market prices in effect on a a default valuation commodity, using the market prices in effect on a
default valuation date. For single period reports, the valuation date default valuation date. For single period reports, the valuation date
is today; for multiperiod reports, it is the last day of each subpe- is today (equivalent to --value=now); for multiperiod reports, it is
riod. It is equivalent to --value=now or --value=end (see below). the last day of each subperiod (equivalent to --value=end).
The default valuation commodity is the one referenced in the latest ap- The default valuation commodity is the one referenced in the latest ap-
plicable market price dated on or before the valuation date. If most plicable market price dated on or before the valuation date. If most
of your P declarations lead to a single home currency, this will usu- of your P declarations lead to a single home currency, this will usu-
ally be what you want. (To specify the commodity, see -X below.) ally be what you want. (To specify the commodity, see -X below.)
Here's a quick example: Note that in hledger, market prices are always declared explicitly with
P directives; we do not infer them from transaction prices as Ledger
does.
Here's a quick example of -V:
; one euro is worth this many dollars from nov 1 ; one euro is worth this many dollars from nov 1
P 2016/11/01 EUR $1.10 P 2016/11/01 EUR $1.10
@ -725,18 +729,12 @@ OPTIONS
$ hledger -f t.j bal -N euros -V $ hledger -f t.j bal -N euros -V
$103.00 assets:euros $103.00 assets:euros
Note that in hledger, market prices are always declared explicitly with
P directives; we do not infer them from transaction prices as Ledger
does.
-X: Market value in specified commodity -X: Market value in specified commodity
The -X/--exchange option is like -V/--market except it takes a commod- The -X/--exchange option is like -V, except it specifies the target
ity symbol argument, so that you can select a different target commod- commodity you would like to convert to. It is equivalent to
ity. It is similar to the same option in Ledger, with the same caveat --value=now,COMM or --value=end,COMM.
mentioned above. It is equivalent to --value=now,COMM or
--value=end,COMM.
--value --value: Flexible valuation
(experimental, added 201905) (experimental, added 201905)
-B, -V and -X are special cases of the more general --value option: -B, -V and -X are special cases of the more general --value option:
@ -749,38 +747,35 @@ OPTIONS
- default valuation commodity (or COMM) using current market prices - default valuation commodity (or COMM) using current market prices
- default valuation commodity (or COMM) using market prices at some date - default valuation commodity (or COMM) using market prices at some date
Valuation type The TYPE part basically selects either "cost", or "market value" plus a
TYPE is one of these keywords, or their first letter, or a date (which valuation date:
must be 8 digits with - or / or . separators):
--value=cost --value=cost
Convert amounts to cost, using the prices recorded in transac- Convert amounts to cost, using the prices recorded in transac-
tions. -B/--cost is equivalent to this. tions.
--value=end --value=end
Convert amounts to their value in default valuation commodity Convert amounts to their value in a default valuation commodity,
using market prices on the last day of the report period (or of using market prices on the last day of the report period (or if
each subperiod in a multiperiod report). When no report period unspecified, the journal's end date); or in multiperiod reports,
is specified, uses the journal's last transaction date. market prices on the last day of each subperiod.
--value=now --value=now
Convert amounts to their value in default valuation commodity Convert amounts to their value in default valuation commodity
using current market prices (as of when report is generated). using current market prices (as of when report is generated).
-V/--market is equivalent to this.
--value=YYYY-MM-DD --value=YYYY-MM-DD
Convert amounts to their value in default valuation commodity Convert amounts to their value in default valuation commodity
using market prices on this date. Eg --value=2019-04-25. using market prices on this date.
Valuation commodity
The default valuation commodity is the commodity mentioned in the most The default valuation commodity is the commodity mentioned in the most
recent applicable market price declaration. When all your price decla- recent applicable market price declaration. When all your price decla-
rations lead to a single home currency, this will usually do what you rations lead to a single home currency, this will usually do what you
want. want.
To select a different valuation commodity: write the commodity symbol To select a different valuation commodity, add the optional ,COMM part:
after the valuation type, separated by a comma (eg: --value=now,EUR). a comma, then the target commodity's symbol. Eg: --value=now,EUR.
This will use, in this preferred order: hledger will do its best to convert amounts to this commodity, using:
o declared prices (from source commodity to valuation commodity) o declared prices (from source commodity to valuation commodity)
@ -788,10 +783,12 @@ OPTIONS
inverted) inverted)
o indirect prices (prices calculated from the shortest chain of de- o indirect prices (prices calculated from the shortest chain of de-
clared or reverse prices from source to valuation commodity). clared or reverse prices from source to valuation commodity)
--value examples in that order.
Here are the effects of --value as seen with print:
Here are some examples showing the effect of --value as seen with
print:
P 2000-01-01 A 1 B P 2000-01-01 A 1 B
P 2000-02-01 A 2 B P 2000-02-01 A 2 B
@ -898,51 +895,99 @@ OPTIONS
b -0.50A b -0.50A
Effect of --value on reports Effect of --value on reports
Below is how --value affects each of hledger's reports, currently. Here is a reference for how --value currently affects each part of
You're not expected to remember all this, but when troubleshooting a hledger's reports. It's work in progress, but may be useful for trou-
report, look here. If you find problems - useless reports, misbehaving bleshooting or reporting bugs. See also the definitions and notes be-
reports, or error messages being printed - please report them (with re- low. If you find problems, please report them, ideally with a repro-
producible examples) eg at #329. ducible example. Related: #329, #1083.
Report type --value cost --value end --value DATE/now Report type -B, -V, -X --value=end --value=DATE,
--------------------------------------------------------------------------------- --value=cost --value=now
-------------------------------------------------------------------------------------
print print
posting cost, as market value at report market value at posting cost value at report value at report value at
amounts recorded in end DATE amounts end or today or journal end DATE/today
transaction balance asser- unchanged unchanged unchanged unchanged
balance as- show unvalued show unvalued show unvalued tions / as-
sertions/as-
signments signments
register register
starting cost of start- market value at day be- market value at starting bal- cost value at day value at day value at
balance with ing balance fore report start DATE ance (with -H) before report before report DATE/today
-H or journal or journal
posting cost market value at report market value at start start
amounts end DATE posting cost value at report value at report value at
posting summarised market value each summary market value each amounts (no end or today or journal end DATE/today
amounts, cost posting at period end summary posting at report inter-
multiperiod DATE val)
running to- sum/average of sum/average of the dis- sum/average of the summary post- summarised value at period value at period value at
tal/average the displayed played values displayed values ing amounts cost ends ends DATE/today
values (with report
interval)
running to- sum/average of sum/average of sum/average of sum/average
tal/average displayed val- displayed val- displayed val- of displayed
ues ues ues values
balance (bs, balance (bs,
cf, is..) bse, cf, is..)
starting costs of market value at day be- market value at balances (no sums of costs value at report value at report value at
balances starting bal- fore report start of sum DATE of sum of report inter- end or today of or journal end DATE/today of
with -H ances of previous postings previous postings val) sums of post- of sums of sums of post-
balances, summed costs market value at period market value at ings postings ings
simple bal- end of sum of postings DATE of sum of balances (with sums of costs value at period value at period value at
ance report postings report inter- ends of sums of ends of sums of DATE/today of
balances, summed costs market value at period market value at val) postings postings sums of post-
multiperiod end of sum of postings DATE of sum of ings
report postings starting bal- sums of costs sums of post- sums of post- sums of post-
budget costs of bud- budget-setting periodic budget-setting pe- ances (with of postings ings before re- ings before re- ings before
amounts with get amounts txns are valued at period riodic txns are report inter- before report port start port start report start
--budget end valued at DATE val and -H) start
col- sum/average of market value at period market value at budget amounts like balances like balances like balances like balances
umn/row/grand the displayed end of sum/average of DATE of sum/aver- with --budget
totals/aver- values postings age of postings grand total sum of dis- sum of dis- sum of dis- sum of dis-
ages (no report in- played values played values played values played values
terval)
row totals/av- sums/averages sums/averages sums/averages sums/averages
erages (with of displayed of displayed of displayed of displayed
report inter- values values values values
val)
column totals sums of dis- sums of dis- sums of dis- sums of dis-
played values played values played values played values
grand to- sum/average of sum/average of sum/average of sum/average
tal/average column totals column totals column totals of column to-
tals
Additional notes
cost calculated using price(s) recorded in the transaction(s).
value market value using available market price declarations, or the
unchanged amount if no conversion rate can be found.
report start
the first day of the report period specified with -b or -p or
date:, otherwise today.
report or journal start
the first day of the report period specified with -b or -p or
date:, otherwise the earliest transaction date in the journal,
otherwise today.
report end
the last day of the report period specified with -e or -p or
date:, otherwise today.
report or journal end
the last day of the report period specified with -e or -p or
date:, otherwise the latest transaction date in the journal,
otherwise today.
report interval
a flag (-D/-W/-M/-Q/-Y) or period expression that activates the
report's multi-period mode (whether showing one or many subperi-
ods).
Combining -B, -V, -X, --value Combining -B, -V, -X, --value
The rightmost of these flags wins. The rightmost of these flags wins.
@ -2745,4 +2790,4 @@ SEE ALSO
hledger 1.15 August 2019 hledger(1) hledger 1.15.2 September 2019 hledger(1)