;doc: regen manuals

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

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"

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)
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
journal files, automatically converting each CSV record into a
@ -350,35 +350,35 @@ character.

Tag Table:
Node: Top72
Node: CSV RULES2161
Ref: #csv-rules2269
Node: skip2532
Ref: #skip2626
Node: date-format2798
Ref: #date-format2925
Node: field list3475
Ref: #field-list3612
Node: field assignment4342
Ref: #field-assignment4497
Node: conditional block5121
Ref: #conditional-block5275
Node: include6171
Ref: #include6301
Node: newest-first6532
Ref: #newest-first6646
Node: CSV TIPS7057
Ref: #csv-tips7151
Node: CSV ordering7295
Ref: #csv-ordering7413
Node: CSV accounts7594
Ref: #csv-accounts7732
Node: CSV amounts7986
Ref: #csv-amounts8144
Node: CSV balance assertions/assignments9224
Ref: #csv-balance-assertionsassignments9442
Node: Reading multiple CSV files9763
Ref: #reading-multiple-csv-files9963
Node: Valid CSV10237
Ref: #valid-csv10360
Node: CSV RULES2165
Ref: #csv-rules2273
Node: skip2536
Ref: #skip2630
Node: date-format2802
Ref: #date-format2929
Node: field list3479
Ref: #field-list3616
Node: field assignment4346
Ref: #field-assignment4501
Node: conditional block5125
Ref: #conditional-block5279
Node: include6175
Ref: #include6305
Node: newest-first6536
Ref: #newest-first6650
Node: CSV TIPS7061
Ref: #csv-tips7155
Node: CSV ordering7299
Ref: #csv-ordering7417
Node: CSV accounts7598
Ref: #csv-accounts7736
Node: CSV amounts7990
Ref: #csv-amounts8148
Node: CSV balance assertions/assignments9228
Ref: #csv-balance-assertionsassignments9446
Node: Reading multiple CSV files9767
Ref: #reading-multiple-csv-files9967
Node: Valid CSV10241
Ref: #valid-csv10364

End Tag Table

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)

View File

@ -1,6 +1,6 @@
.\"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"

View File

@ -4,8 +4,8 @@ stdin.

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

End Tag Table

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)

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"

View File

@ -4,8 +4,8 @@ stdin.

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
of) timeclock.el's format, containing clock-in and clock-out entries as

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)

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"

View File

@ -4,8 +4,8 @@ stdin.

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
(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:
Node: Top76
Node: FILE FORMAT808
Ref: #file-format909
Node: FILE FORMAT812
Ref: #file-format913

End Tag Table

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)

View File

@ -1,6 +1,6 @@
.\"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
value in a default valuation commodity, using the market prices in
effect on a default valuation date.
For single period reports, the valuation date is today; for multiperiod
reports, it is the last day of each subperiod.
It is equivalent to \f[C]--value=now\f[R] or \f[C]--value=end\f[R] (see
below).
For single period reports, the valuation date is today (equivalent to
\f[C]--value=now\f[R]); for multiperiod reports, it is the last day of
each subperiod (equivalent to \f[C]--value=end\f[R]).
.PP
The default valuation commodity is the one referenced in the latest
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.
(To specify the commodity, see -X below.)
.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
.nf
\f[C]
@ -1070,20 +1073,13 @@ $ hledger -f t.j bal -N euros -V
$103.00 assets:euros
\f[R]
.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
.PP
The \f[C]-X/--exchange\f[R] option is like \f[C]-V/--market\f[R] except
it takes a commodity symbol argument, so that you can select a different
target commodity.
It is similar to the same option in Ledger, with the same caveat
mentioned above.
The \f[C]-X/--exchange\f[R] option is like \f[C]-V\f[R], except it
specifies the target commodity you would like to convert to.
It is equivalent to \f[C]--value=now,COMM\f[R] or
\f[C]--value=end,COMM\f[R].
.SS --value
.SS --value: Flexible valuation
.PP
\f[I](experimental, added 201905)\f[R]
.PP
@ -1101,43 +1097,36 @@ more general \f[C]--value\f[R] option:
- default valuation commodity (or COMM) using market prices at some date
\f[R]
.fi
.SS Valuation type
.PP
TYPE is one of these keywords, or their first letter, or a date (which
must be 8 digits with \f[C]-\f[R] or \f[C]/\f[R] or \f[C].\f[R]
separators):
The TYPE part basically selects either \[dq]cost\[dq], or \[dq]market
value\[dq] plus a valuation date:
.TP
.B \f[C]--value=cost\f[R]
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
.B \f[C]--value=end\f[R]
Convert amounts to their value in default valuation commodity using
market prices on the last day of the report period (or of each subperiod
in a multiperiod report).
When no report period is specified, uses the journal\[aq]s last
transaction date.
Convert amounts to their value in a default valuation commodity, using
market prices on the last day of the report period (or if unspecified,
the journal\[aq]s end date); or in multiperiod reports, market prices on
the last day of each subperiod.
.TP
.B \f[C]--value=now\f[R]
Convert amounts to their value in default valuation commodity using
current market prices (as of when report is generated).
\f[C]-V\f[R]/\f[C]--market\f[R] is equivalent to this.
.TP
.B \f[C]--value=YYYY-MM-DD\f[R]
Convert amounts to their value in default valuation commodity using
market prices on this date.
Eg \f[C]--value=2019-04-25\f[R].
.SS Valuation commodity
.PP
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 you want.
.PP
To select a different valuation commodity: write the commodity symbol
after the valuation type, separated by a comma (eg:
\f[B]\f[CB]--value=now,EUR\f[B]\f[R]).
This will use, in this preferred order:
To select a different valuation commodity, add the optional
\f[C],COMM\f[R] part: a comma, then the target commodity\[aq]s symbol.
Eg: \f[B]\f[CB]--value=now,EUR\f[B]\f[R].
hledger will do its best to convert amounts to this commodity, using:
.IP \[bu] 2
declared prices (from source commodity to valuation commodity)
.IP \[bu] 2
@ -1145,10 +1134,12 @@ reverse prices (declared prices from valuation to source commodity,
inverted)
.IP \[bu] 2
indirect prices (prices calculated from the shortest chain of declared
or reverse prices from source to valuation commodity).
.SS --value examples
or reverse prices from source to valuation commodity)
.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
.nf
\f[C]
@ -1297,25 +1288,28 @@ $ hledger print -X A
.fi
.SS Effect of --value on reports
.PP
Below is how \f[C]--value\f[R] affects each of hledger\[aq]s reports,
currently.
You\[aq]re not expected to remember all this, but when troubleshooting a
report, look here.
If you find problems - useless reports, misbehaving reports, or error
messages being printed - please report them (with reproducible examples)
eg at #329.
Here is a reference for how \f[C]--value\f[R] currently affects each
part of hledger\[aq]s reports.
It\[aq]s work in progress, but may be useful for troubleshooting or
reporting bugs.
See also the definitions and notes below.
If you find problems, please report them, ideally with a reproducible
example.
Related: #329, #1083.
.PP
.TS
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{
Report type
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{
\f[C]--value\f[R] \f[C]end\f[R]\
\f[C]-V\f[R], \f[C]-X\f[R]
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{
@ -1323,119 +1317,224 @@ T{
T}@T{
T}@T{
T}@T{
T}
T{
posting amounts
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{
posting amounts
T}@T{
cost
T}@T{
market value at report end
value at report end or today
T}@T{
market value at DATE
value at report or journal end
T}@T{
value at DATE/today
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{
summarised cost
T}@T{
market value each summary posting at period end
value at period ends
T}@T{
market value each summary posting at DATE
value at period ends
T}@T{
value at DATE/today
T}
T{
running total/average
T}@T{
sum/average of the displayed values
sum/average of displayed values
T}@T{
sum/average of the displayed values
sum/average of displayed values
T}@T{
sum/average of the displayed values
sum/average of displayed values
T}@T{
sum/average of displayed values
T}
T{
\f[B]balance (bs, cf, is..)\f[R]
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{
costs of starting balances
T}@T{
market value at day before report start of sum of previous postings
T}@T{
market value at DATE of sum of previous postings
T}
T{
balances, simple balance report
balances (no report interval)
T}@T{
summed costs
sums of costs
T}@T{
market value at period end of sum of postings
value at report end or today of sums of postings
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{
balances, multiperiod report
balances (with report interval)
T}@T{
summed costs
sums of costs
T}@T{
market value at period end of sum of postings
value at period ends of sums of postings
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{
budget amounts with --budget
T}@T{
costs of budget amounts
like balances
T}@T{
budget-setting periodic txns are valued at period end
like balances
T}@T{
budget-setting periodic txns are valued at DATE
like balances
T}@T{
like balances
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{
sum/average of the displayed values
T}@T{
market value at period end of sum/average of postings
T}@T{
market value at DATE of sum/average of postings
T}
.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
.PP
The rightmost of these flags wins.

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)
hledger(1) hledger 1.15
***********************
hledger(1) hledger 1.15.2
*************************
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
@ -753,7 +753,8 @@ File: hledger.info, Node: Valuation, Next: Output destination, Prev: Pivoting
* -B Cost::
* -V Market value::
* -X Market value in specified commodity::
* --value::
* --value Flexible valuation::
* Effect of --value on reports::
* 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
in a default valuation commodity, using the market prices in effect on a
default valuation date. For single period reports, the valuation date
is today; for multiperiod reports, it is the last day of each subperiod.
It is equivalent to '--value=now' or '--value=end' (see below).
is today (equivalent to '--value=now'); for multiperiod reports, it is
the last day of each subperiod (equivalent to '--value=end').
The default valuation commodity is the one referenced in the latest
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
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
P 2016/11/01 € $1.10
@ -812,27 +817,21 @@ specified, defaults to today)
$ hledger -f t.j bal -N euros -V
$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
----------------------------------------------
The '-X/--exchange' option is like '-V/--market' except it takes a
commodity symbol argument, so that you can select a different target
commodity. It is similar to the same option in Ledger, with the same
caveat mentioned above. It is equivalent to '--value=now,COMM' or
'--value=end,COMM'.
The '-X/--exchange' option is like '-V', except it specifies the target
commodity you would like to convert to. 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)_
@ -847,70 +846,47 @@ option:
- default valuation commodity (or COMM) using current market prices
- default valuation commodity (or COMM) using market prices at some date
* Menu:
* 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):
The TYPE part basically selects either "cost", or "market value" plus
a valuation date:
'--value=cost'
Convert amounts to cost, using the prices recorded in transactions.
'-B'/'--cost' is equivalent to this.
'--value=end'
Convert amounts to their value in default valuation commodity using
market prices on the last day of the report period (or of each
subperiod in a multiperiod report). When no report period is
specified, uses the journal's last transaction date.
Convert amounts to their value in a default valuation commodity,
using market prices on the last day of the report period (or if
unspecified, the journal's end date); or in multiperiod reports,
market prices on the last day of each subperiod.
'--value=now'
Convert amounts to their value in default valuation commodity using
current market prices (as of when report is generated).
'-V'/'--market' is equivalent to this.
'--value=YYYY-MM-DD'
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.

File: hledger.info, Node: Valuation commodity, Next: --value examples, Prev: Valuation type, Up: --value
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
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
you want.
To select a different valuation commodity: write the commodity symbol
after the valuation type, separated by a comma (eg:
*'--value=now,EUR'*). This will use, in this preferred order:
To select a different valuation commodity, add the optional ',COMM'
part: a comma, then the target commodity's symbol. Eg:
*'--value=now,EUR'*. hledger will do its best to convert amounts to
this commodity, using:
* declared prices (from source commodity to valuation commodity)
* reverse prices (declared prices from valuation to source commodity,
inverted)
* 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)

File: hledger.info, Node: --value examples, Next: Effect of --value on reports, Prev: Valuation commodity, Up: --value
in that order.
2.15.4.3 -value examples
........................
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-02-01 A 2 B
@ -1018,65 +994,116 @@ $ hledger print -X A
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.
You're not expected to remember all this, but when troubleshooting a
report, look here. If you find problems - useless reports, misbehaving
reports, or error messages being printed - please report them (with
reproducible examples) eg at #329.
Here is a reference for how '--value' currently affects each part of
hledger's reports. It's work in progress, but may be useful for
troubleshooting or reporting bugs. See also the definitions and notes
below. If you find problems, please report them, ideally with a
reproducible example. Related: #329, #1083.
Report type '--value' '--value' 'end' '--value'
'cost' 'DATE'/'now'
----------------------------------------------------------------------------
Report type '-B', '-V', '-X' '--value=end' '--value=DATE',
'--value=cost' '--value=now'
-----------------------------------------------------------------------------
*print*
posting cost, as market value at report market value at
amounts recorded in end DATE
transaction
balance show show unvalued show unvalued
assertions/assignmentsunvalued
posting cost value at value at value at
amounts report end or report or DATE/today
today journal end
balance unchanged unchanged unchanged unchanged
assertions /
assignments
*register*
starting cost of market value at day market value at
balance starting before report start DATE
with -H balance
posting cost market value at report market value at
amounts end DATE
posting summarised market value each market value each
amounts, cost summary posting at summary posting
multiperiod period end at DATE
running sum/average sum/average of the sum/average of
total/average of the displayed values the displayed
displayed values
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
starting cost value at day value at day value at
balance (with before report before report DATE/today
-H) or journal or journal
start start
posting cost value at value at value at
amounts (no report end or report or DATE/today
report today journal end
interval)
summary summarised value at value at value at
posting cost period ends period ends DATE/today
amounts (with
report
balances, summed costs market value at period market value at
multiperiod end of sum of postings DATE of sum of
report postings
budget costs of budget-setting periodic budget-setting
amounts budget txns are valued at periodic txns are
with amounts period end valued at DATE
interval)
running sum/average sum/average sum/average of sum/average
total/average of displayed of displayed displayed of
values values values displayed
values
*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
column/row/grandsum/average market value at period market value at
totals/averagesof the end of sum/average of DATE of
displayed postings sum/average of
values postings
grand total sum of sum of sum of sum of
(no report displayed displayed displayed displayed
interval) values values values values
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.
@ -3133,185 +3160,179 @@ hledger-check.hs checks more powerful account balance assertions.

Tag Table:
Node: Top68
Node: EXAMPLES1885
Ref: #examples1985
Node: OPTIONS3631
Ref: #options3733
Node: General options4132
Ref: #general-options4257
Node: Command options6911
Ref: #command-options7062
Node: Command arguments7460
Ref: #command-arguments7614
Node: Argument files7735
Ref: #argument-files7911
Node: Special characters in arguments and queries8177
Ref: #special-characters-in-arguments-and-queries8411
Node: More escaping8862
Ref: #more-escaping9024
Node: Even more escaping9320
Ref: #even-more-escaping9514
Node: Less escaping10185
Ref: #less-escaping10347
Node: Command line tips10592
Ref: #command-line-tips10778
Node: Unicode characters11155
Ref: #unicode-characters11311
Node: Input files12723
Ref: #input-files12859
Node: Smart dates14788
Ref: #smart-dates14929
Node: Report start & end date16335
Ref: #report-start-end-date16507
Node: Report intervals17931
Ref: #report-intervals18096
Node: Period expressions18486
Ref: #period-expressions18646
Node: Depth limiting22603
Ref: #depth-limiting22747
Node: Pivoting23089
Ref: #pivoting23212
Node: Valuation24888
Ref: #valuation25017
Node: -B Cost25145
Ref: #b-cost25256
Node: -V Market value25454
Ref: #v-market-value25628
Node: -X Market value in specified commodity27058
Ref: #x-market-value-in-specified-commodity27278
Node: --value27572
Ref: #value27737
Node: Valuation type28538
Ref: #valuation-type28674
Node: Valuation commodity29559
Ref: #valuation-commodity29730
Node: --value examples30430
Ref: #value-examples30607
Node: Effect of --value on reports32590
Ref: #effect-of---value-on-reports32763
Node: Combining -B -V -X --value35454
Ref: #combining--b--v--x---value35616
Node: Output destination35652
Ref: #output-destination35804
Node: Output format36087
Ref: #output-format36239
Node: Regular expressions36624
Ref: #regular-expressions36761
Node: QUERIES38122
Ref: #queries38224
Node: COMMANDS42186
Ref: #commands42298
Node: accounts43362
Ref: #accounts43460
Node: activity44159
Ref: #activity44269
Node: add44652
Ref: #add44751
Node: balance47496
Ref: #balance47607
Node: Classic balance report49049
Ref: #classic-balance-report49222
Node: Customising the classic balance report50591
Ref: #customising-the-classic-balance-report50819
Node: Colour support52895
Ref: #colour-support53062
Node: Flat mode53235
Ref: #flat-mode53383
Node: Depth limited balance reports53796
Ref: #depth-limited-balance-reports53996
Node: Multicolumn balance report54452
Ref: #multicolumn-balance-report54650
Node: Budget report59964
Ref: #budget-report60107
Node: Nested budgets65309
Ref: #nested-budgets65421
Ref: #output-format-168901
Node: balancesheet68979
Ref: #balancesheet69115
Node: balancesheetequity70430
Ref: #balancesheetequity70579
Node: cashflow71140
Ref: #cashflow71268
Node: check-dates72296
Ref: #check-dates72423
Node: check-dupes72702
Ref: #check-dupes72826
Node: close73119
Ref: #close73233
Node: commodities76820
Ref: #commodities76947
Node: descriptions77029
Ref: #descriptions77157
Node: diff77338
Ref: #diff77444
Node: files78491
Ref: #files78591
Node: help78738
Ref: #help78838
Node: import79931
Ref: #import80045
Node: Importing balance assignments80833
Ref: #importing-balance-assignments80981
Node: incomestatement81630
Ref: #incomestatement81763
Node: notes83099
Ref: #notes83212
Node: payees83338
Ref: #payees83444
Node: prices83602
Ref: #prices83708
Node: print83987
Ref: #print84097
Node: print-unique88590
Ref: #print-unique88716
Node: register89001
Ref: #register89128
Node: Custom register output93300
Ref: #custom-register-output93429
Node: register-match94691
Ref: #register-match94825
Node: rewrite95176
Ref: #rewrite95291
Node: Re-write rules in a file97146
Ref: #re-write-rules-in-a-file97280
Node: Diff output format98490
Ref: #diff-output-format98659
Node: rewrite vs print --auto99751
Ref: #rewrite-vs.-print---auto99930
Node: roi100486
Ref: #roi100584
Node: stats101596
Ref: #stats101695
Node: tags102483
Ref: #tags102581
Node: test102875
Ref: #test102959
Node: ADD-ON COMMANDS103720
Ref: #add-on-commands103830
Node: Official add-ons105118
Ref: #official-add-ons105258
Node: api105346
Ref: #api105435
Node: ui105487
Ref: #ui105586
Node: web105644
Ref: #web105733
Node: Third party add-ons105779
Ref: #third-party-add-ons105954
Ref: #diff-1106113
Node: iadd106212
Ref: #iadd106322
Node: interest106405
Ref: #interest106526
Node: irr106621
Ref: #irr106719
Node: Experimental add-ons106850
Ref: #experimental-add-ons107002
Node: autosync107283
Ref: #autosync107394
Node: chart107633
Ref: #chart107752
Node: check107823
Ref: #check107925
Node: EXAMPLES1889
Ref: #examples1989
Node: OPTIONS3635
Ref: #options3737
Node: General options4136
Ref: #general-options4261
Node: Command options6915
Ref: #command-options7066
Node: Command arguments7464
Ref: #command-arguments7618
Node: Argument files7739
Ref: #argument-files7915
Node: Special characters in arguments and queries8181
Ref: #special-characters-in-arguments-and-queries8415
Node: More escaping8866
Ref: #more-escaping9028
Node: Even more escaping9324
Ref: #even-more-escaping9518
Node: Less escaping10189
Ref: #less-escaping10351
Node: Command line tips10596
Ref: #command-line-tips10782
Node: Unicode characters11159
Ref: #unicode-characters11315
Node: Input files12727
Ref: #input-files12863
Node: Smart dates14792
Ref: #smart-dates14933
Node: Report start & end date16339
Ref: #report-start-end-date16511
Node: Report intervals17935
Ref: #report-intervals18100
Node: Period expressions18490
Ref: #period-expressions18650
Node: Depth limiting22607
Ref: #depth-limiting22751
Node: Pivoting23093
Ref: #pivoting23216
Node: Valuation24892
Ref: #valuation25021
Node: -B Cost25201
Ref: #b-cost25312
Node: -V Market value25510
Ref: #v-market-value25684
Node: -X Market value in specified commodity27116
Ref: #x-market-value-in-specified-commodity27355
Node: --value Flexible valuation27531
Ref: #value-flexible-valuation27757
Node: Effect of --value on reports31947
Ref: #effect-of---value-on-reports32163
Node: Combining -B -V -X --value37094
Ref: #combining--b--v--x---value37277
Node: Output destination37313
Ref: #output-destination37465
Node: Output format37748
Ref: #output-format37900
Node: Regular expressions38285
Ref: #regular-expressions38422
Node: QUERIES39783
Ref: #queries39885
Node: COMMANDS43847
Ref: #commands43959
Node: accounts45023
Ref: #accounts45121
Node: activity45820
Ref: #activity45930
Node: add46313
Ref: #add46412
Node: balance49157
Ref: #balance49268
Node: Classic balance report50710
Ref: #classic-balance-report50883
Node: Customising the classic balance report52252
Ref: #customising-the-classic-balance-report52480
Node: Colour support54556
Ref: #colour-support54723
Node: Flat mode54896
Ref: #flat-mode55044
Node: Depth limited balance reports55457
Ref: #depth-limited-balance-reports55657
Node: Multicolumn balance report56113
Ref: #multicolumn-balance-report56311
Node: Budget report61625
Ref: #budget-report61768
Node: Nested budgets66970
Ref: #nested-budgets67082
Ref: #output-format-170562
Node: balancesheet70640
Ref: #balancesheet70776
Node: balancesheetequity72091
Ref: #balancesheetequity72240
Node: cashflow72801
Ref: #cashflow72929
Node: check-dates73957
Ref: #check-dates74084
Node: check-dupes74363
Ref: #check-dupes74487
Node: close74780
Ref: #close74894
Node: commodities78481
Ref: #commodities78608
Node: descriptions78690
Ref: #descriptions78818
Node: diff78999
Ref: #diff79105
Node: files80152
Ref: #files80252
Node: help80399
Ref: #help80499
Node: import81592
Ref: #import81706
Node: Importing balance assignments82494
Ref: #importing-balance-assignments82642
Node: incomestatement83291
Ref: #incomestatement83424
Node: notes84760
Ref: #notes84873
Node: payees84999
Ref: #payees85105
Node: prices85263
Ref: #prices85369
Node: print85648
Ref: #print85758
Node: print-unique90251
Ref: #print-unique90377
Node: register90662
Ref: #register90789
Node: Custom register output94961
Ref: #custom-register-output95090
Node: register-match96352
Ref: #register-match96486
Node: rewrite96837
Ref: #rewrite96952
Node: Re-write rules in a file98807
Ref: #re-write-rules-in-a-file98941
Node: Diff output format100151
Ref: #diff-output-format100320
Node: rewrite vs print --auto101412
Ref: #rewrite-vs.-print---auto101591
Node: roi102147
Ref: #roi102245
Node: stats103257
Ref: #stats103356
Node: tags104144
Ref: #tags104242
Node: test104536
Ref: #test104620
Node: ADD-ON COMMANDS105381
Ref: #add-on-commands105491
Node: Official add-ons106779
Ref: #official-add-ons106919
Node: api107007
Ref: #api107096
Node: ui107148
Ref: #ui107247
Node: web107305
Ref: #web107394
Node: Third party add-ons107440
Ref: #third-party-add-ons107615
Ref: #diff-1107774
Node: iadd107873
Ref: #iadd107983
Node: interest108066
Ref: #interest108187
Node: irr108282
Ref: #irr108380
Node: Experimental add-ons108511
Ref: #experimental-add-ons108663
Node: autosync108944
Ref: #autosync109055
Node: chart109294
Ref: #chart109413
Node: check109484
Ref: #check109586

End Tag Table

File diff suppressed because it is too large Load Diff