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

print: update manual, tweak help #442

Browse Source
This commit is contained in:
Simon Michael 2017-01-13 07:22:27 -08:00
parent e87906f960
commit 2f5b96b4ae
2 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger/Hledger/Cli/Print.hs
View File

@ -36,7 +36,7 @@ printmode = (defCommandMode $ ["print"] ++ aliases) {
("show the transaction whose description is most similar to "++matcharg ("show the transaction whose description is most similar to "++matcharg
++ ", and is most recent"), ++ ", and is most recent"),
flagNone ["explicit"] (setboolopt "explicit") flagNone ["explicit"] (setboolopt "explicit")
"make output more explicit than original transactions" "show all amounts explicitly"
] ]
++ outputflags ++ outputflags
,groupHidden = [] ,groupHidden = []

25
hledger/doc/commands.m4.md
View File

@ -326,6 +326,9 @@ As with [help](#help), run it with no arguments to list available topics (manual
## print ## print
Show transactions from the journal. Show transactions from the journal.
` --explicit`
: show all amounts explicitly
`-m STR --match=STR ` `-m STR --match=STR `
: show the transaction whose description is most similar to STR, and is most recent : show the transaction whose description is most similar to STR, and is most recent
@ -360,13 +363,23 @@ $ hledger print
assets:bank:checking $-1 assets:bank:checking $-1
``` ```
The print command displays full transactions from the journal file, The print command displays full transactions from the journal file, tidily formatted.
tidily formatted and showing all amounts explicitly. The output of As of hledger 1.2, print always produces valid [hledger journal format](/journal.html).
print is always a valid hledger journal, but it does always not However it may not preserve all original content, eg it does not print directives or inter-transaction comments.
preserve all original content exactly (eg directives).
hledger's print command also shows all unit prices in effect, or (with Normally, transactions' implicit/explicit amount style is preserved:
-B/--cost) shows cost amounts. when an amount is omitted in the journal, it will be omitted in the output.
You can use the `--explicit` flag to make all amounts explicit, which can be
useful for troubleshooting or for making your journal more readable and
robust against data entry errors.
Note, in this mode postings with a multi-commodity amount
(possible with an implicit amount in a multi-commodity transaction)
will be split into multiple single-commodity postings (valid journal format).
print also shows any [balance assertions/assignments](/journal.html#balance-assertions)
or [transaction prices](/journal.html#transaction-prices).
With -B/--cost, amounts are converted to cost (using the transaction price).
The print command also supports The print command also supports
[output destination](#output-destination) [output destination](#output-destination)