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

doc: print tweaks

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2017-01-13 09:01:54 -08:00
parent 8954944ee6
commit b0e907e5a4
4 changed files with 77 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -363,29 +363,27 @@ $ hledger print
assets:bank:checking $-1
```
The print command displays full transactions from the journal file, tidily formatted.
As of hledger 1.2, print always produces valid [hledger journal format](/journal.html).
The print command displays full journal entries (transactions) from the journal file, tidily formatted.
As of hledger 1.2, print's output is always a valid [hledger journal](/journal.html).
However it may not preserve all original content, eg it does not print directives or inter-transaction comments.
Normally, transactions' implicit/explicit amount style is preserved:
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).
will be split into multiple single-commodity postings, for valid journal output.
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).
With -B/--cost, amounts with [transaction prices](/journal.html#transaction-prices)
are converted to cost (using the transaction price).
The print command also supports
[output destination](#output-destination)
and
[CSV output](#csv-output).
Here's an example of print's CSV output:
```shell
$ hledger print -Ocsv

17
hledger/doc/hledger.1
View File

@ -1837,30 +1837,27 @@ $\ hledger\ print
\f[]
.fi
.PP
The print command displays full transactions from the journal file,
tidily formatted.
As of hledger 1.2, print always produces valid hledger journal format.
The print command displays full journal entries (transactions) from the
journal file, tidily formatted.
.PP
As of hledger 1.2, print\[aq]s output is always a valid hledger journal.
However it may not preserve all original content, eg it does not print
directives or inter\-transaction comments.
.PP
Normally, transactions\[aq] implicit/explicit amount style is preserved:
when an amount is omitted in the journal, it will be omitted in the
output.
.PP
You can use the \f[C]\-\-explicit\f[] 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).
into multiple single\-commodity postings, for valid journal output.
.PP
print also shows any balance assertions/assignments or transaction
prices.
With \-B/\-\-cost, amounts are converted to cost (using the transaction
price).
With \-B/\-\-cost, amounts with transaction prices are converted to cost
(using the transaction price).
.PP
The print command also supports output destination and CSV output.
.PP
Here\[aq]s an example of print\[aq]s CSV output:
.IP
.nf

100
hledger/doc/hledger.1.info
View File

@ -1507,29 +1507,27 @@ $ hledger print
liabilities:debts $1
assets:bank:checking $-1
The print command displays full transactions from the journal file,
tidily formatted. As of hledger 1.2, print always produces valid hledger
journal format. However it may not preserve all original content, eg it
does not print directives or inter-transaction comments.
The print command displays full journal entries (transactions) from
the journal file, tidily formatted.
As of hledger 1.2, print's output is always a valid hledger journal.
However it may not preserve all original content, eg it does not print
directives or inter-transaction comments.
Normally, transactions' implicit/explicit amount style is preserved:
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,
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).
postings with a multi-commodity amount (possible with an implicit
amount in a multi-commodity transaction) will be split into multiple
single-commodity postings, for valid journal output.
print also shows any balance assertions/assignments or transaction
prices. With -B/-cost, amounts are converted to cost (using the
transaction price).
With -B/-cost, amounts with transaction prices are converted to cost
(using the transaction price).
The print command also supports output destination and CSV output.
Here's an example of print's CSV output:
Here's an example of print's CSV output:
$ hledger print -Ocsv
@ -2337,41 +2335,41 @@ Node: man45534
Ref: #man45631
Node: print46034
Ref: #print46139
Node: register49924
Ref: #register50037
Node: Custom register output54529
Ref: #custom-register-output54660
Node: stats55957
Ref: #stats56063
Node: test56943
Ref: #test57030
Node: ADD-ON COMMANDS57397
Ref: #add-on-commands57533
Node: api58821
Ref: #api58913
Node: autosync58947
Ref: #autosync59062
Node: diff61377
Ref: #diff61487
Node: equity62151
Ref: #equity62265
Node: interest63593
Ref: #interest63710
Node: irr66794
Ref: #irr66907
Node: print-unique69282
Ref: #print-unique69412
Node: rewrite69670
Ref: #rewrite69789
Node: ui70318
Ref: #ui70418
Node: web70459
Ref: #web70547
Node: TROUBLESHOOTING70580
Ref: #troubleshooting70699
Node: Run-time problems70753
Ref: #run-time-problems70896
Node: Known limitations72840
Ref: #known-limitations72983
Node: register49888
Ref: #register50001
Node: Custom register output54493
Ref: #custom-register-output54624
Node: stats55921
Ref: #stats56027
Node: test56907
Ref: #test56994
Node: ADD-ON COMMANDS57361
Ref: #add-on-commands57497
Node: api58785
Ref: #api58877
Node: autosync58911
Ref: #autosync59026
Node: diff61341
Ref: #diff61451
Node: equity62115
Ref: #equity62229
Node: interest63557
Ref: #interest63674
Node: irr66758
Ref: #irr66871
Node: print-unique69246
Ref: #print-unique69376
Node: rewrite69634
Ref: #rewrite69753
Node: ui70282
Ref: #ui70382
Node: web70423
Ref: #web70511
Node: TROUBLESHOOTING70544
Ref: #troubleshooting70663
Node: Run-time problems70717
Ref: #run-time-problems70860
Node: Known limitations72804
Ref: #known-limitations72947

End Tag Table

32
hledger/doc/hledger.1.txt
View File

@ -1283,28 +1283,26 @@ COMMANDS
liabilities:debts $1
assets:bank:checking $-1
The print command displays full transactions from the journal file,
tidily formatted. As of hledger 1.2, print always produces valid
hledger journal format. However it may not preserve all original con-
tent, eg it does not print directives or inter-transaction comments.
The print command displays full journal entries (transactions) from the
journal file, tidily formatted.
As of hledger 1.2, print's output is always a valid hledger journal.
However it may not preserve all original content, eg it does not print
directives or inter-transaction comments.
Normally, transactions' implicit/explicit amount style is preserved:
when an amount is omitted in the journal, it will be omitted in the
output.
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, for valid journal 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-commod-
ity postings (valid journal format).
print also shows any balance assertions/assignments or transaction
prices. With -B/--cost, amounts are converted to cost (using the
transaction price).
The print command also supports output destination and CSV output.
With -B/--cost, amounts with transaction prices are converted to cost
(using the transaction price).
The print command also supports output destination and CSV output.
Here's an example of print's CSV output:
$ hledger print -Ocsv