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

doc: manual: document balance -V/--value

Browse Source
This commit is contained in:
Simon Michael 2015-08-09 16:45:43 -07:00
parent 94094252be
commit 2dc9926fd4
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/manual.md
View File

@ -494,7 +494,7 @@ hledger parses that syntax, and (currently) ignores it.
##### Market prices ##### Market prices
hledger also parses, and currently ignores, ledger-style historical price directives (which we call market prices): You can record market prices for commodities with a P directive (Ledger calls these historical prices). These will be used by the `-V/--value` option supported by certain commands ([balance](#balance)).
<!-- (A time and numeric time zone are allowed but ignored, like ledger.) --> <!-- (A time and numeric time zone are allowed but ignored, like ledger.) -->
```journal ```journal
; Market price directives look like: P DATE COMMODITYSYMBOL UNITPRICE ; Market price directives look like: P DATE COMMODITYSYMBOL UNITPRICE
@ -1541,6 +1541,24 @@ for each row. The `-A/--average` flag adds a column showing the
average value in each row. Note in `--H/--historical` mode only the average value in each row. Note in `--H/--historical` mode only the
average is useful, and in `--cumulative` mode neither is useful. average is useful, and in `--cumulative` mode neither is useful.
##### Market value
The `-V/--value` flag converts all the reported amounts to their
"current market value" using their default market price. That is the
latest [market price](#market-prices) (P directive) found in the
journal (or an included file), for the amount's commodity, dated on or
before the report end date.
Unlike Ledger, hledger's -V only uses the market prices recorded with
P directives, ignoring transaction prices recorded as part of posting
amounts (which -B/--cost uses). Using -B and -V together is allowed.
<!--
``` {.shell .right}
$ hledger balance -V ...
```
-->
##### Custom balance output ##### Custom balance output
``` {.shell .right} ``` {.shell .right}