doc: update generated docs
This commit is contained in:
Simon Michael
parent
0ede127132
commit
bc922cc12f
@ -1788,6 +1788,11 @@ As with help, run it with no arguments to list available topics
|
||||
.PP
|
||||
Show transactions from the journal.
|
||||
.TP
|
||||
.B \f[C]\-\-explicit\f[]
|
||||
show all amounts explicitly
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-m\ STR\ \-\-match=STR\f[]
|
||||
show the transaction whose description is most similar to STR, and is
|
||||
most recent
|
||||
@ -1833,12 +1838,26 @@ $\ hledger\ print
|
||||
.fi
|
||||
.PP
|
||||
The print command displays full transactions from the journal file,
|
||||
tidily formatted and showing all amounts explicitly.
|
||||
The output of print is always a valid hledger journal, but it does
|
||||
always not preserve all original content exactly (eg directives).
|
||||
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.
|
||||
.PP
|
||||
hledger\[aq]s print command also shows all unit prices in effect, or
|
||||
(with \-B/\-\-cost) shows cost amounts.
|
||||
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).
|
||||
.PP
|
||||
print also shows any balance assertions/assignments or transaction
|
||||
prices.
|
||||
With \-B/\-\-cost, amounts are converted to cost (using the transaction
|
||||
price).
|
||||
.PP
|
||||
The print command also supports output destination and CSV output.
|
||||
.PP
|
||||
@ -1846,6 +1865,7 @@ Here\[aq]s an example of print\[aq]s CSV output:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ hledger\ print\ \-Ocsv
|
||||
"txnidx","date","date2","status","code","description","comment","account","amount","commodity","credit","debit","posting\-status","posting\-comment"
|
||||
"1","2008/01/01","","","","income","","assets:bank:checking","1","$","","1","",""
|
||||
"1","2008/01/01","","","","income","","income:salary","\-1","$","1","","",""
|
||||
|
||||
@ -1470,6 +1470,9 @@ File: hledger.1.info, Node: print, Next: register, Prev: man, Up: COMMANDS
|
||||
|
||||
Show transactions from the journal.
|
||||
|
||||
`--explicit'
|
||||
show all amounts explicitly
|
||||
|
||||
`-m STR --match=STR'
|
||||
show the transaction whose description is most similar to STR, and
|
||||
is most recent
|
||||
@ -1505,18 +1508,31 @@ $ hledger print
|
||||
assets:bank:checking $-1
|
||||
|
||||
The print command displays full transactions from the journal file,
|
||||
tidily formatted and showing all amounts explicitly. The output of print
|
||||
is always a valid hledger journal, but it does always not preserve all
|
||||
original content exactly (eg directives).
|
||||
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.
|
||||
|
||||
hledger's print command also shows all unit prices in effect, or
|
||||
(with -B/-cost) shows cost amounts.
|
||||
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).
|
||||
|
||||
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.
|
||||
|
||||
Here's an example of print's CSV output:
|
||||
|
||||
|
||||
$ hledger print -Ocsv
|
||||
"txnidx","date","date2","status","code","description","comment","account","amount","commodity","credit","debit","posting-status","posting-comment"
|
||||
"1","2008/01/01","","","","income","","assets:bank:checking","1","$","","1","",""
|
||||
"1","2008/01/01","","","","income","","income:salary","-1","$","1","","",""
|
||||
@ -2321,41 +2337,41 @@ Node: man45534
|
||||
Ref: #man45631
|
||||
Node: print46034
|
||||
Ref: #print46139
|
||||
Node: register49249
|
||||
Ref: #register49362
|
||||
Node: Custom register output53854
|
||||
Ref: #custom-register-output53985
|
||||
Node: stats55282
|
||||
Ref: #stats55388
|
||||
Node: test56268
|
||||
Ref: #test56355
|
||||
Node: ADD-ON COMMANDS56722
|
||||
Ref: #add-on-commands56858
|
||||
Node: api58146
|
||||
Ref: #api58238
|
||||
Node: autosync58272
|
||||
Ref: #autosync58387
|
||||
Node: diff60702
|
||||
Ref: #diff60812
|
||||
Node: equity61476
|
||||
Ref: #equity61590
|
||||
Node: interest62918
|
||||
Ref: #interest63035
|
||||
Node: irr66119
|
||||
Ref: #irr66232
|
||||
Node: print-unique68607
|
||||
Ref: #print-unique68737
|
||||
Node: rewrite68995
|
||||
Ref: #rewrite69114
|
||||
Node: ui69643
|
||||
Ref: #ui69743
|
||||
Node: web69784
|
||||
Ref: #web69872
|
||||
Node: TROUBLESHOOTING69905
|
||||
Ref: #troubleshooting70024
|
||||
Node: Run-time problems70078
|
||||
Ref: #run-time-problems70221
|
||||
Node: Known limitations72165
|
||||
Ref: #known-limitations72308
|
||||
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
|
||||
|
||||
End Tag Table
|
||||
|
||||
@ -1247,6 +1247,9 @@ COMMANDS
|
||||
print
|
||||
Show transactions from the journal.
|
||||
|
||||
--explicit
|
||||
show all amounts explicitly
|
||||
|
||||
-m STR --match=STR
|
||||
show the transaction whose description is most similar to STR,
|
||||
and is most recent
|
||||
@ -1281,17 +1284,30 @@ COMMANDS
|
||||
assets:bank:checking $-1
|
||||
|
||||
The print command displays full transactions from the journal file,
|
||||
tidily formatted and showing all amounts explicitly. The output of
|
||||
print is always a valid hledger journal, but it does always not pre-
|
||||
serve all original content exactly (eg directives).
|
||||
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.
|
||||
|
||||
hledger's print command also shows all unit prices in effect, or (with
|
||||
-B/--cost) shows cost amounts.
|
||||
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-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.
|
||||
|
||||
Here's an example of print's CSV output:
|
||||
|
||||
$ hledger print -Ocsv
|
||||
"txnidx","date","date2","status","code","description","comment","account","amount","commodity","credit","debit","posting-status","posting-comment"
|
||||
"1","2008/01/01","","","","income","","assets:bank:checking","1","$","","1","",""
|
||||
"1","2008/01/01","","","","income","","income:salary","-1","$","1","","",""
|
||||
|
||||
Loading…
Reference in New Issue
Block a user