doc: Document new independent costing and valuation features in manual.

This commit is contained in:
Stephen Morgan 2021-01-26 15:09:42 +11:00 committed by Simon Michael
parent b619b68f71
commit e6cf2fb499

View File

@ -716,21 +716,23 @@ Some of these can also be expressed as command-line options (eg `depth:2` is equ
Generally you can mix options and query arguments, and the resulting query will be their intersection Generally you can mix options and query arguments, and the resulting query will be their intersection
(perhaps excluding the `-p/--period` option). (perhaps excluding the `-p/--period` option).
# COSTING
The `-B/--cost` flag converts amounts to their cost or sale amount at transaction time,
if they have a [transaction price](hledger.html#transaction-prices) specified.
If this flag is supplied, hledger will perform cost conversion first, and will apply
any market price valuations (if requested) afterwards.
# VALUATION # VALUATION
Instead of reporting amounts in their original commodity, Instead of reporting amounts in their original commodity,
hledger can convert them to hledger can convert them to
cost/sale amount (using the conversion rate recorded in the transaction), cost/sale amount (using the conversion rate recorded in the transaction),
or to market value (using some market price on a certain date). and/or to market value (using some market price on a certain date).
This is controlled by the `--value=TYPE[,COMMODITY]` option, This is controlled by the `--cost` and `--value=TYPE[,COMMODITY]` options,
but we also provide the simpler `-B`/`-V`/`-X` flags, but we also provide the simpler `-V`/`-X` flags,
and usually one of those is all you need. and usually one of those is all you need.
## -B: Cost
The `-B/--cost` flag converts amounts to their cost or sale amount at transaction time,
if they have a [transaction price](hledger.html#transaction-prices) specified.
## -V: Value ## -V: Value
The `-V/--market` flag converts amounts to market value in their The `-V/--market` flag converts amounts to market value in their