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

;doc: cli: clean up -V/-X a little

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-09-02 06:27:09 -07:00
parent 319f0e5224
commit 3654ac5239
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
hledger/hledger_options.m4.md
View File

@ -464,20 +464,15 @@ This flag is equivalent to `--value=cost`, described below.
### -V: Market value ### -V: Market value
The `-V/--market` flag converts reported amounts to their market value in a default valuation commodity, The `-V/--market` flag converts reported amounts to their market value in a default valuation commodity,
using the [historical market prices](journal.html#market-prices) in effect on a default valuation date. using the [market prices](journal.html#market-prices) in effect on a default valuation date.
For single period reports, the valuation date is today;
for [multiperiod reports](#report-intervals), it is the last day of each subperiod.
It is equivalent to `--value=now` or `--value=end` (see below).
For single period reports, the valuation date is today. The default valuation commodity is the one referenced in the latest
For [multiperiod reports](#report-intervals), it is the last day of each subperiod.
The valuation commodity will be 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.
If most of your P declarations lead to a single home currency, this will usually be what you want. 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.)
Unlike the similar flag in Ledger, it does not infer market prices
from [transaction prices](/manual.html#transaction-prices). In
hledger, -B uses transaction prices, -V and -X use market prices.
It is equivalent to `--value=now` or `--value=end`.
Here's a quick example: Here's a quick example:
@ -509,12 +504,15 @@ $ 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](/manual.html#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 The `-X/--exchange` option is like `-V/--market` except it takes a
commodity symbol argument, so that you can select a different target commodity. 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 for `-V`/`--value` above. 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`; for more details, read on. It is equivalent to `--value=now,COMM` or `--value=end,COMM`.
### --value ### --value