;doc:options:update --value-at support

This commit is contained in:
Simon Michael 2019-05-05 11:12:01 -07:00
parent 2ba0281335
commit 4c56baf842

View File

@ -600,22 +600,24 @@ $ hledger -f- print --value-at=2000-01-15
### Reports supporting --value-at
Not all combinations of valuation date and hledger report modes are
supported or well understood at present
([#329](https://github.com/simonmichael/hledger/issues/329)).
Here are the ones currently supported
("print", "register", and "balance" here mean all commands of that general type):
All report/--value-at combinations are expected to do the right
thing, or at least a reasonable thing. If you find problems, please
report them (with reproducible examples) eg at
[#329](https://github.com/simonmichael/hledger/issues/329).
The table below shows the current status as far as we know it.
(Here "print", "register", "balance" mean all commands of those
general types, and "-M" means any report interval):
| Report type | `--value-at=` `transaction`  | `--value-at=` `period`  | `--value-at=` `DATE`/`now`  |
|---------------------------------------------------------|:---------------------------------:|:----------------------------:|:--------------------------------:|
| print | Y | Y | Y |
| register | Y | Y | Y |
| register, multiperiod | Y | Y | Y |
| balance | Y | Y | Y |
| balance, multiperiod | Y | Y | Y |
| balance, multiperiod, -T/-A | Y | Y | Y |
| register/balance, multiperiod, -T/-A, -H | ? | ? | ? |
| balance, --budget | ? | ? | ? |
| Report type | `--value-at=` `transaction`  | `--value-at=` `period`  | `--value-at=` `DATE`/`now`  |
|----------------------------|:---------------------------------:|:----------------------------:|:--------------------------------:|
| print | Y | Y | Y |
| register | Y | Y | Y |
| register -M | Y | Y | Y |
| register -H | ? | ? | ? |
| balance | Y | Y | Y |
| balance -M -T/-A | Y | Y | Y |
| balance -M -H | - | - | - |
| balance --budget | ? | ? | ? |
## Combining -B and -V