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 assets:bank:checking $-1
``` ```
The print command displays full transactions from the journal file, tidily formatted. The print command displays full journal entries (transactions) from the journal file, tidily formatted.
As of hledger 1.2, print always produces valid [hledger journal format](/journal.html).
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. 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: Normally, transactions' implicit/explicit amount style is preserved:
when an amount is omitted in the journal, it will be omitted in the output. 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 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 useful for troubleshooting or for making your journal more readable and
robust against data entry errors. robust against data entry errors.
Note, in this mode postings with a multi-commodity amount Note, in this mode postings with a multi-commodity amount
(possible with an implicit amount in a multi-commodity transaction) (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) With -B/--cost, amounts with [transaction prices](/journal.html#transaction-prices)
or [transaction prices](/journal.html#transaction-prices). are converted to cost (using the transaction price).
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)
and and
[CSV output](#csv-output). [CSV output](#csv-output).
Here's an example of print's CSV output: Here's an example of print's CSV output:
```shell ```shell
$ hledger print -Ocsv $ hledger print -Ocsv

17
hledger/doc/hledger.1
View File

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

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

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

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

@ -1283,28 +1283,26 @@ COMMANDS
liabilities:debts $1 liabilities:debts $1
assets:bank:checking $-1 assets:bank:checking $-1
The print command displays full transactions from the journal file, The print command displays full journal entries (transactions) from the
tidily formatted. As of hledger 1.2, print always produces valid journal file, tidily formatted.
hledger journal format. However it may not preserve all original con-
tent, eg it does not print directives or inter-transaction comments. 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: Normally, transactions' implicit/explicit amount style is preserved:
when an amount is omitted in the journal, it will be omitted in the 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 With -B/--cost, amounts with transaction prices are converted to cost
be useful for troubleshooting or for making your journal more readable (using the transaction price).
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.
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 $ hledger print -Ocsv