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

doc: update generated docs

Browse Source
This commit is contained in:
Simon Michael 2017-01-13 08:25:43 -08:00
parent 0ede127132
commit bc922cc12f
3 changed files with 103 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
hledger/doc/hledger.1
View File

@ -1788,6 +1788,11 @@ As with help, run it with no arguments to list available topics
.PP .PP
Show transactions from the journal. Show transactions from the journal.
.TP .TP
.B \f[C]\-\-explicit\f[]
show all amounts explicitly
.RS
.RE
.TP
.B \f[C]\-m\ STR\ \-\-match=STR\f[] .B \f[C]\-m\ STR\ \-\-match=STR\f[]
show the transaction whose description is most similar to STR, and is show the transaction whose description is most similar to STR, and is
most recent most recent
@ -1833,12 +1838,26 @@ $\ hledger\ print
.fi .fi
.PP .PP
The print command displays full transactions from the journal file, The print command displays full transactions from the journal file,
tidily formatted and showing all amounts explicitly. tidily formatted.
The output of print is always a valid hledger journal, but it does As of hledger 1.2, print always produces valid hledger journal format.
always not preserve all original content exactly (eg directives). However it may not preserve all original content, eg it does not print
directives or inter\-transaction comments.
.PP .PP
hledger\[aq]s print command also shows all unit prices in effect, or Normally, transactions\[aq] implicit/explicit amount style is preserved:
(with \-B/\-\-cost) shows cost amounts. 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 .PP
The print command also supports output destination and CSV output. The print command also supports output destination and CSV output.
.PP .PP
@ -1846,6 +1865,7 @@ Here\[aq]s an example of print\[aq]s CSV output:
.IP .IP
.nf .nf
\f[C] \f[C]
$\ hledger\ print\ \-Ocsv
"txnidx","date","date2","status","code","description","comment","account","amount","commodity","credit","debit","posting\-status","posting\-comment" "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","","assets:bank:checking","1","$","","1","",""
"1","2008/01/01","","","","income","","income:salary","\-1","$","1","","","" "1","2008/01/01","","","","income","","income:salary","\-1","$","1","","",""

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

@ -1470,6 +1470,9 @@ File: hledger.1.info, Node: print, Next: register, Prev: man, Up: COMMANDS
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 show the transaction whose description is most similar to STR, and
is most recent is most recent
@ -1505,18 +1508,31 @@ $ 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 and showing all amounts explicitly. The output of print tidily formatted. As of hledger 1.2, print always produces valid hledger
is always a valid hledger journal, but it does always not preserve all journal format. However it may not preserve all original content, eg it
original content exactly (eg directives). does not print directives or inter-transaction comments.
hledger's print command also shows all unit prices in effect, or Normally, transactions' implicit/explicit amount style is preserved:
(with -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 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
"txnidx","date","date2","status","code","description","comment","account","amount","commodity","credit","debit","posting-status","posting-comment" "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","","assets:bank:checking","1","$","","1","",""
"1","2008/01/01","","","","income","","income:salary","-1","$","1","","","" "1","2008/01/01","","","","income","","income:salary","-1","$","1","","",""
@ -2321,41 +2337,41 @@ Node: man45534
Ref: #man45631 Ref: #man45631
Node: print46034 Node: print46034
Ref: #print46139 Ref: #print46139
Node: register49249 Node: register49924
Ref: #register49362 Ref: #register50037
Node: Custom register output53854 Node: Custom register output54529
Ref: #custom-register-output53985 Ref: #custom-register-output54660
Node: stats55282 Node: stats55957
Ref: #stats55388 Ref: #stats56063
Node: test56268 Node: test56943
Ref: #test56355 Ref: #test57030
Node: ADD-ON COMMANDS56722 Node: ADD-ON COMMANDS57397
Ref: #add-on-commands56858 Ref: #add-on-commands57533
Node: api58146 Node: api58821
Ref: #api58238 Ref: #api58913
Node: autosync58272 Node: autosync58947
Ref: #autosync58387 Ref: #autosync59062
Node: diff60702 Node: diff61377
Ref: #diff60812 Ref: #diff61487
Node: equity61476 Node: equity62151
Ref: #equity61590 Ref: #equity62265
Node: interest62918 Node: interest63593
Ref: #interest63035 Ref: #interest63710
Node: irr66119 Node: irr66794
Ref: #irr66232 Ref: #irr66907
Node: print-unique68607 Node: print-unique69282
Ref: #print-unique68737 Ref: #print-unique69412
Node: rewrite68995 Node: rewrite69670
Ref: #rewrite69114 Ref: #rewrite69789
Node: ui69643 Node: ui70318
Ref: #ui69743 Ref: #ui70418
Node: web69784 Node: web70459
Ref: #web69872 Ref: #web70547
Node: TROUBLESHOOTING69905 Node: TROUBLESHOOTING70580
Ref: #troubleshooting70024 Ref: #troubleshooting70699
Node: Run-time problems70078 Node: Run-time problems70753
Ref: #run-time-problems70221 Ref: #run-time-problems70896
Node: Known limitations72165 Node: Known limitations72840
Ref: #known-limitations72308 Ref: #known-limitations72983
 
End Tag Table End Tag Table

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

@ -1247,6 +1247,9 @@ COMMANDS
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, show the transaction whose description is most similar to STR,
and is most recent and is most recent
@ -1281,17 +1284,30 @@ COMMANDS
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 and showing all amounts explicitly. The output of tidily formatted. As of hledger 1.2, print always produces valid
print is always a valid hledger journal, but it does always not pre- hledger journal format. However it may not preserve all original con-
serve all original content exactly (eg directives). tent, eg it does not print directives or inter-transaction comments.
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-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
"txnidx","date","date2","status","code","description","comment","account","amount","commodity","credit","debit","posting-status","posting-comment" "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","","assets:bank:checking","1","$","","1","",""
"1","2008/01/01","","","","income","","income:salary","-1","$","1","","","" "1","2008/01/01","","","","income","","income:salary","-1","$","1","","",""