;doc: update manuals

This commit is contained in:
Simon Michael 2021-12-06 15:04:17 -10:00
parent 763d171108
commit 76b5c5f2ac
3 changed files with 441 additions and 489 deletions

View File

@ -3250,13 +3250,13 @@ commodity symbols in a separate column
.IP \[bu] 2 .IP \[bu] 2
\f[C]--layout=tidy\f[R]: data is normalised to tidy form, with one row \f[C]--layout=tidy\f[R]: data is normalised to tidy form, with one row
per data value. per data value.
This is supported with CSV output format only. We currently support this with CSV output only.
Totals and row averages are disabled in this mode In tidy mode, totals and row averages are disabled
(\f[C]-N/--no-total\f[R] is implied and \f[C]-T/--row-total\f[R] and (\f[C]-N/--no-total\f[R] is implied and \f[C]-T/--row-total\f[R] and
\f[C]-A/--average\f[R] will be ignored). \f[C]-A/--average\f[R] will be ignored).
.PP .PP
These \f[C]--layout\f[R] values affect some but not all of the output These \f[C]--layout\f[R] modes are supported with some but not all of
formats, as shown: the output formats:
.PP .PP
.TS .TS
tab(@); tab(@);
@ -3436,44 +3436,28 @@ $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=
Tidy layout produces normalised \[dq]tidy data\[dq], where every Tidy layout produces normalised \[dq]tidy data\[dq], where every
variable is a column and each row represents a single data point (see variable is a column and each row represents a single data point (see
https://cran.r-project.org/web/packages/tidyr/vignettes/tidy-data.html). https://cran.r-project.org/web/packages/tidyr/vignettes/tidy-data.html).
This is the form of data most easily processed by other software. This kind of data is the easiest to process with other software:
Currently we support it with the CSV output format only:
.RS 2 .RS 2
.IP .IP
.nf .nf
\f[C] \f[C]
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=tidy -Y $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy
\[dq]account\[dq],\[dq]date\[dq],\[dq]commodity\[dq],\[dq]value\[dq] \[dq]account\[dq],\[dq]period\[dq],\[dq]start_date\[dq],\[dq]end_date\[dq],\[dq]commodity\[dq],\[dq]value\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]GLD\[dq],\[dq]0\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]GLD\[dq],\[dq]0\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]ITOT\[dq],\[dq]10.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]ITOT\[dq],\[dq]10.00\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]USD\[dq],\[dq]337.18\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]USD\[dq],\[dq]337.18\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]VEA\[dq],\[dq]12.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]VEA\[dq],\[dq]12.00\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]VHT\[dq],\[dq]106.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]VHT\[dq],\[dq]106.00\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]ITOT\[dq],\[dq]18.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]ITOT\[dq],\[dq]18.00\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]USD\[dq],\[dq]-98.12\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]USD\[dq],\[dq]-98.12\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]VEA\[dq],\[dq]10.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]VEA\[dq],\[dq]10.00\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]VHT\[dq],\[dq]18.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]VHT\[dq],\[dq]18.00\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]GLD\[dq],\[dq]0\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]GLD\[dq],\[dq]0\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]ITOT\[dq],\[dq]-11.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]ITOT\[dq],\[dq]-11.00\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]USD\[dq],\[dq]4881.44\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]USD\[dq],\[dq]4881.44\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]VEA\[dq],\[dq]14.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]VEA\[dq],\[dq]14.00\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]VHT\[dq],\[dq]170.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]VHT\[dq],\[dq]170.00\[dq]
\[dq]total\[dq],\[dq]2012\[dq],\[dq]GLD\[dq],\[dq]0\[dq]
\[dq]total\[dq],\[dq]2012\[dq],\[dq]ITOT\[dq],\[dq]10.00\[dq]
\[dq]total\[dq],\[dq]2012\[dq],\[dq]USD\[dq],\[dq]337.18\[dq]
\[dq]total\[dq],\[dq]2012\[dq],\[dq]VEA\[dq],\[dq]12.00\[dq]
\[dq]total\[dq],\[dq]2012\[dq],\[dq]VHT\[dq],\[dq]106.00\[dq]
\[dq]total\[dq],\[dq]2013\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq]
\[dq]total\[dq],\[dq]2013\[dq],\[dq]ITOT\[dq],\[dq]18.00\[dq]
\[dq]total\[dq],\[dq]2013\[dq],\[dq]USD\[dq],\[dq]-98.12\[dq]
\[dq]total\[dq],\[dq]2013\[dq],\[dq]VEA\[dq],\[dq]10.00\[dq]
\[dq]total\[dq],\[dq]2013\[dq],\[dq]VHT\[dq],\[dq]18.00\[dq]
\[dq]total\[dq],\[dq]2014\[dq],\[dq]GLD\[dq],\[dq]0\[dq]
\[dq]total\[dq],\[dq]2014\[dq],\[dq]ITOT\[dq],\[dq]-11.00\[dq]
\[dq]total\[dq],\[dq]2014\[dq],\[dq]USD\[dq],\[dq]4881.44\[dq]
\[dq]total\[dq],\[dq]2014\[dq],\[dq]VEA\[dq],\[dq]14.00\[dq]
\[dq]total\[dq],\[dq]2014\[dq],\[dq]VHT\[dq],\[dq]170.00\[dq]
\f[R] \f[R]
.fi .fi
.RE .RE

View File

@ -2629,12 +2629,12 @@ data:
* '--layout=bare': amounts are shown as bare numbers, with commodity * '--layout=bare': amounts are shown as bare numbers, with commodity
symbols in a separate column symbols in a separate column
* '--layout=tidy': data is normalised to tidy form, with one row per * '--layout=tidy': data is normalised to tidy form, with one row per
data value. This is supported with CSV output format only. Totals data value. We currently support this with CSV output only. In
and row averages are disabled in this mode ('-N/--no-total' is tidy mode, totals and row averages are disabled ('-N/--no-total' is
implied and '-T/--row-total' and '-A/--average' will be ignored). implied and '-T/--row-total' and '-A/--average' will be ignored).
These '--layout' values affect some but not all of the output These '--layout' modes are supported with some but not all of the
formats, as shown: output formats:
- txt csv html json sql - txt csv html json sql
--------------------------------------- ---------------------------------------
@ -2727,41 +2727,25 @@ tidy Y
* Tidy layout produces normalised "tidy data", where every variable * Tidy layout produces normalised "tidy data", where every variable
is a column and each row represents a single data point (see is a column and each row represents a single data point (see
https://cran.r-project.org/web/packages/tidyr/vignettes/tidy-data.html). https://cran.r-project.org/web/packages/tidyr/vignettes/tidy-data.html).
This is the form of data most easily processed by other software. This kind of data is the easiest to process with other software:
Currently we support it with the CSV output format only:
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=tidy -Y $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy
"account","date","commodity","value" "account","period","start_date","end_date","commodity","value"
"Assets:US:ETrade","2012","GLD","0" "Assets:US:ETrade","2012","2012-01-01","2012-12-31","GLD","0"
"Assets:US:ETrade","2012","ITOT","10.00" "Assets:US:ETrade","2012","2012-01-01","2012-12-31","ITOT","10.00"
"Assets:US:ETrade","2012","USD","337.18" "Assets:US:ETrade","2012","2012-01-01","2012-12-31","USD","337.18"
"Assets:US:ETrade","2012","VEA","12.00" "Assets:US:ETrade","2012","2012-01-01","2012-12-31","VEA","12.00"
"Assets:US:ETrade","2012","VHT","106.00" "Assets:US:ETrade","2012","2012-01-01","2012-12-31","VHT","106.00"
"Assets:US:ETrade","2013","GLD","70.00" "Assets:US:ETrade","2013","2013-01-01","2013-12-31","GLD","70.00"
"Assets:US:ETrade","2013","ITOT","18.00" "Assets:US:ETrade","2013","2013-01-01","2013-12-31","ITOT","18.00"
"Assets:US:ETrade","2013","USD","-98.12" "Assets:US:ETrade","2013","2013-01-01","2013-12-31","USD","-98.12"
"Assets:US:ETrade","2013","VEA","10.00" "Assets:US:ETrade","2013","2013-01-01","2013-12-31","VEA","10.00"
"Assets:US:ETrade","2013","VHT","18.00" "Assets:US:ETrade","2013","2013-01-01","2013-12-31","VHT","18.00"
"Assets:US:ETrade","2014","GLD","0" "Assets:US:ETrade","2014","2014-01-01","2014-12-31","GLD","0"
"Assets:US:ETrade","2014","ITOT","-11.00" "Assets:US:ETrade","2014","2014-01-01","2014-12-31","ITOT","-11.00"
"Assets:US:ETrade","2014","USD","4881.44" "Assets:US:ETrade","2014","2014-01-01","2014-12-31","USD","4881.44"
"Assets:US:ETrade","2014","VEA","14.00" "Assets:US:ETrade","2014","2014-01-01","2014-12-31","VEA","14.00"
"Assets:US:ETrade","2014","VHT","170.00" "Assets:US:ETrade","2014","2014-01-01","2014-12-31","VHT","170.00"
"total","2012","GLD","0"
"total","2012","ITOT","10.00"
"total","2012","USD","337.18"
"total","2012","VEA","12.00"
"total","2012","VHT","106.00"
"total","2013","GLD","70.00"
"total","2013","ITOT","18.00"
"total","2013","USD","-98.12"
"total","2013","VEA","10.00"
"total","2013","VHT","18.00"
"total","2014","GLD","0"
"total","2014","ITOT","-11.00"
"total","2014","USD","4881.44"
"total","2014","VEA","14.00"
"total","2014","VHT","170.00"
 
File: hledger.info, Node: Sorting by amount, Next: Percentages, Prev: Data layout, Up: balance File: hledger.info, Node: Sorting by amount, Next: Percentages, Prev: Data layout, Up: balance
@ -9244,378 +9228,378 @@ Node: Showing declared accounts90665
Ref: #showing-declared-accounts90858 Ref: #showing-declared-accounts90858
Node: Data layout91389 Node: Data layout91389
Ref: #data-layout91544 Ref: #data-layout91544
Node: Sorting by amount99640 Node: Sorting by amount99484
Ref: #sorting-by-amount99795 Ref: #sorting-by-amount99639
Node: Percentages100465 Node: Percentages100309
Ref: #percentages100623 Ref: #percentages100467
Node: Balance change end balance101584 Node: Balance change end balance101428
Ref: #balance-change-end-balance101777 Ref: #balance-change-end-balance101621
Node: Balance report types103205 Node: Balance report types103049
Ref: #balance-report-types103395 Ref: #balance-report-types103239
Node: Useful balance reports107674 Node: Useful balance reports107518
Ref: #useful-balance-reports107855 Ref: #useful-balance-reports107699
Node: Budget report108940 Node: Budget report108784
Ref: #budget-report109124 Ref: #budget-report108968
Node: Budget report start date114399 Node: Budget report start date114243
Ref: #budget-report-start-date114577 Ref: #budget-report-start-date114421
Node: Budgets and subaccounts115909 Node: Budgets and subaccounts115753
Ref: #budgets-and-subaccounts116116 Ref: #budgets-and-subaccounts115960
Node: Selecting budget goals119556 Node: Selecting budget goals119400
Ref: #selecting-budget-goals119728 Ref: #selecting-budget-goals119572
Node: Customising single-period balance reports120762 Node: Customising single-period balance reports120606
Ref: #customising-single-period-balance-reports120971 Ref: #customising-single-period-balance-reports120815
Node: balancesheet123146 Node: balancesheet122990
Ref: #balancesheet123284 Ref: #balancesheet123128
Node: balancesheetequity124583 Node: balancesheetequity124427
Ref: #balancesheetequity124734 Ref: #balancesheetequity124578
Node: cashflow126114 Node: cashflow125958
Ref: #cashflow126238 Ref: #cashflow126082
Node: check127384 Node: check127228
Ref: #check127489 Ref: #check127333
Node: Basic checks128123 Node: Basic checks127967
Ref: #basic-checks128241 Ref: #basic-checks128085
Node: Strict checks128792 Node: Strict checks128636
Ref: #strict-checks128933 Ref: #strict-checks128777
Node: Other checks129369 Node: Other checks129213
Ref: #other-checks129509 Ref: #other-checks129353
Node: Custom checks129866 Node: Custom checks129710
Ref: #custom-checks129986 Ref: #custom-checks129830
Node: close130403 Node: close130247
Ref: #close130507 Ref: #close130351
Node: close and prices132598 Node: close and prices132442
Ref: #close-and-prices132727 Ref: #close-and-prices132571
Node: close date133122 Node: close date132966
Ref: #close-date133306 Ref: #close-date133150
Node: Example close asset/liability accounts for file transition134063 Node: Example close asset/liability accounts for file transition133907
Ref: #example-close-assetliability-accounts-for-file-transition134364 Ref: #example-close-assetliability-accounts-for-file-transition134208
Node: Hiding opening/closing transactions135223 Node: Hiding opening/closing transactions135067
Ref: #hiding-openingclosing-transactions135494 Ref: #hiding-openingclosing-transactions135338
Node: close and balance assertions136871 Node: close and balance assertions136715
Ref: #close-and-balance-assertions137129 Ref: #close-and-balance-assertions136973
Node: Example close revenue/expense accounts to retained earnings138483 Node: Example close revenue/expense accounts to retained earnings138327
Ref: #example-close-revenueexpense-accounts-to-retained-earnings138761 Ref: #example-close-revenueexpense-accounts-to-retained-earnings138605
Node: codes139651 Node: codes139495
Ref: #codes139761 Ref: #codes139605
Node: commodities140473 Node: commodities140317
Ref: #commodities140602 Ref: #commodities140446
Node: descriptions140684 Node: descriptions140528
Ref: #descriptions140814 Ref: #descriptions140658
Node: diff141118 Node: diff140962
Ref: #diff141226 Ref: #diff141070
Node: files142273 Node: files142117
Ref: #files142375 Ref: #files142219
Node: help142522 Node: help142366
Ref: #help142624 Ref: #help142468
Node: import143442 Node: import143286
Ref: #import143558 Ref: #import143402
Node: Deduplication144423 Node: Deduplication144267
Ref: #deduplication144548 Ref: #deduplication144392
Node: Import testing146442 Node: Import testing146286
Ref: #import-testing146607 Ref: #import-testing146451
Node: Importing balance assignments147095 Node: Importing balance assignments146939
Ref: #importing-balance-assignments147301 Ref: #importing-balance-assignments147145
Node: Commodity display styles147950 Node: Commodity display styles147794
Ref: #commodity-display-styles148123 Ref: #commodity-display-styles147967
Node: incomestatement148252 Node: incomestatement148096
Ref: #incomestatement148387 Ref: #incomestatement148231
Node: notes149692 Node: notes149536
Ref: #notes149807 Ref: #notes149651
Node: payees150175 Node: payees150019
Ref: #payees150283 Ref: #payees150127
Node: prices150809 Node: prices150653
Ref: #prices150917 Ref: #prices150761
Node: print151286 Node: print151130
Ref: #print151398 Ref: #print151242
Node: print-unique156713 Node: print-unique156557
Ref: #print-unique156841 Ref: #print-unique156685
Node: register157126 Node: register156970
Ref: #register157255 Ref: #register157099
Node: Custom register output161701 Node: Custom register output161545
Ref: #custom-register-output161832 Ref: #custom-register-output161676
Node: register-match163169 Node: register-match163013
Ref: #register-match163305 Ref: #register-match163149
Node: rewrite163656 Node: rewrite163500
Ref: #rewrite163773 Ref: #rewrite163617
Node: Re-write rules in a file165679 Node: Re-write rules in a file165523
Ref: #re-write-rules-in-a-file165842 Ref: #re-write-rules-in-a-file165686
Node: Diff output format166991 Node: Diff output format166835
Ref: #diff-output-format167174 Ref: #diff-output-format167018
Node: rewrite vs print --auto168266 Node: rewrite vs print --auto168110
Ref: #rewrite-vs.-print---auto168426 Ref: #rewrite-vs.-print---auto168270
Node: roi168982 Node: roi168826
Ref: #roi169082 Ref: #roi168926
Node: Spaces and special characters in --inv and --pnl170768 Node: Spaces and special characters in --inv and --pnl170612
Ref: #spaces-and-special-characters-in---inv-and---pnl171008 Ref: #spaces-and-special-characters-in---inv-and---pnl170852
Node: Semantics of --inv and --pnl171496 Node: Semantics of --inv and --pnl171340
Ref: #semantics-of---inv-and---pnl171735 Ref: #semantics-of---inv-and---pnl171579
Node: IRR and TWR explained173585 Node: IRR and TWR explained173429
Ref: #irr-and-twr-explained173745 Ref: #irr-and-twr-explained173589
Node: stats176813 Node: stats176657
Ref: #stats176914 Ref: #stats176758
Node: tags178294 Node: tags178138
Ref: #tags178394 Ref: #tags178238
Node: test178913 Node: test178757
Ref: #test179029 Ref: #test178873
Node: About add-on commands179776 Node: About add-on commands179620
Ref: #about-add-on-commands179913 Ref: #about-add-on-commands179757
Node: JOURNAL FORMAT181044 Node: JOURNAL FORMAT180888
Ref: #journal-format181172 Ref: #journal-format181016
Node: Transactions183399 Node: Transactions183243
Ref: #transactions183514 Ref: #transactions183358
Node: Dates184528 Node: Dates184372
Ref: #dates184644 Ref: #dates184488
Node: Simple dates184709 Node: Simple dates184553
Ref: #simple-dates184829 Ref: #simple-dates184673
Node: Secondary dates185338 Node: Secondary dates185182
Ref: #secondary-dates185486 Ref: #secondary-dates185330
Node: Posting dates186822 Node: Posting dates186666
Ref: #posting-dates186945 Ref: #posting-dates186789
Node: Status188317 Node: Status188161
Ref: #status188427 Ref: #status188271
Node: Code190135 Node: Code189979
Ref: #code190247 Ref: #code190091
Node: Description190479 Node: Description190323
Ref: #description190607 Ref: #description190451
Node: Payee and note190927 Node: Payee and note190771
Ref: #payee-and-note191035 Ref: #payee-and-note190879
Node: Comments191370 Node: Comments191214
Ref: #comments191492 Ref: #comments191336
Node: Tags192686 Node: Tags192530
Ref: #tags-1192797 Ref: #tags-1192641
Node: Postings194190 Node: Postings194034
Ref: #postings194314 Ref: #postings194158
Node: Virtual postings195340 Node: Virtual postings195184
Ref: #virtual-postings195451 Ref: #virtual-postings195295
Node: Account names196756 Node: Account names196600
Ref: #account-names196893 Ref: #account-names196737
Node: Amounts197381 Node: Amounts197225
Ref: #amounts197518 Ref: #amounts197362
Node: Decimal marks digit group marks198503 Node: Decimal marks digit group marks198347
Ref: #decimal-marks-digit-group-marks198680 Ref: #decimal-marks-digit-group-marks198524
Node: Commodity199701 Node: Commodity199545
Ref: #commodity199890 Ref: #commodity199734
Node: Directives influencing number parsing and display200842 Node: Directives influencing number parsing and display200686
Ref: #directives-influencing-number-parsing-and-display201103 Ref: #directives-influencing-number-parsing-and-display200947
Node: Commodity display style201596 Node: Commodity display style201440
Ref: #commodity-display-style201804 Ref: #commodity-display-style201648
Node: Rounding203999 Node: Rounding203843
Ref: #rounding204119 Ref: #rounding203963
Node: Transaction prices204531 Node: Transaction prices204375
Ref: #transaction-prices204697 Ref: #transaction-prices204541
Node: Lot prices lot dates207128 Node: Lot prices lot dates206972
Ref: #lot-prices-lot-dates207311 Ref: #lot-prices-lot-dates207155
Node: Balance assertions207799 Node: Balance assertions207643
Ref: #balance-assertions207977 Ref: #balance-assertions207821
Node: Assertions and ordering209010 Node: Assertions and ordering208854
Ref: #assertions-and-ordering209192 Ref: #assertions-and-ordering209036
Node: Assertions and included files209892 Node: Assertions and included files209736
Ref: #assertions-and-included-files210129 Ref: #assertions-and-included-files209973
Node: Assertions and multiple -f options210462 Node: Assertions and multiple -f options210306
Ref: #assertions-and-multiple--f-options210712 Ref: #assertions-and-multiple--f-options210556
Node: Assertions and commodities210844 Node: Assertions and commodities210688
Ref: #assertions-and-commodities211070 Ref: #assertions-and-commodities210914
Node: Assertions and prices212227 Node: Assertions and prices212071
Ref: #assertions-and-prices212435 Ref: #assertions-and-prices212279
Node: Assertions and subaccounts212875 Node: Assertions and subaccounts212719
Ref: #assertions-and-subaccounts213098 Ref: #assertions-and-subaccounts212942
Node: Assertions and virtual postings213422 Node: Assertions and virtual postings213266
Ref: #assertions-and-virtual-postings213658 Ref: #assertions-and-virtual-postings213502
Node: Assertions and precision213800 Node: Assertions and precision213644
Ref: #assertions-and-precision213987 Ref: #assertions-and-precision213831
Node: Balance assignments214254 Node: Balance assignments214098
Ref: #balance-assignments214424 Ref: #balance-assignments214268
Node: Balance assignments and prices215588 Node: Balance assignments and prices215432
Ref: #balance-assignments-and-prices215754 Ref: #balance-assignments-and-prices215598
Node: Directives215978 Node: Directives215822
Ref: #directives216141 Ref: #directives215985
Node: Directives and multiple files220633 Node: Directives and multiple files220477
Ref: #directives-and-multiple-files220829 Ref: #directives-and-multiple-files220673
Node: Comment blocks221521 Node: Comment blocks221365
Ref: #comment-blocks221698 Ref: #comment-blocks221542
Node: Including other files221874 Node: Including other files221718
Ref: #including-other-files222048 Ref: #including-other-files221892
Node: Default year222972 Node: Default year222816
Ref: #default-year223130 Ref: #default-year222974
Node: Declaring payees223537 Node: Declaring payees223381
Ref: #declaring-payees223708 Ref: #declaring-payees223552
Node: Declaring the decimal mark223954 Node: Declaring the decimal mark223798
Ref: #declaring-the-decimal-mark224154 Ref: #declaring-the-decimal-mark223998
Node: Declaring commodities224551 Node: Declaring commodities224395
Ref: #declaring-commodities224742 Ref: #declaring-commodities224586
Node: Commodity error checking227260 Node: Commodity error checking227104
Ref: #commodity-error-checking227410 Ref: #commodity-error-checking227254
Node: Default commodity227667 Node: Default commodity227511
Ref: #default-commodity227847 Ref: #default-commodity227691
Node: Declaring market prices228963 Node: Declaring market prices228807
Ref: #declaring-market-prices229152 Ref: #declaring-market-prices228996
Node: Declaring accounts229965 Node: Declaring accounts229809
Ref: #declaring-accounts230145 Ref: #declaring-accounts229989
Node: Account error checking231347 Node: Account error checking231191
Ref: #account-error-checking231513 Ref: #account-error-checking231357
Node: Account comments232692 Node: Account comments232536
Ref: #account-comments232876 Ref: #account-comments232720
Node: Account subdirectives233300 Node: Account subdirectives233144
Ref: #account-subdirectives233485 Ref: #account-subdirectives233329
Node: Account types233798 Node: Account types233642
Ref: #account-types233972 Ref: #account-types233816
Node: Auto-detected account types235295 Node: Auto-detected account types235139
Ref: #auto-detected-account-types235450 Ref: #auto-detected-account-types235294
Node: Account display order236685 Node: Account display order236529
Ref: #account-display-order236845 Ref: #account-display-order236689
Node: Rewriting accounts237996 Node: Rewriting accounts237840
Ref: #rewriting-accounts238175 Ref: #rewriting-accounts238019
Node: Basic aliases238932 Node: Basic aliases238776
Ref: #basic-aliases239068 Ref: #basic-aliases238912
Node: Regex aliases239812 Node: Regex aliases239656
Ref: #regex-aliases239974 Ref: #regex-aliases239818
Node: Combining aliases240693 Node: Combining aliases240537
Ref: #combining-aliases240876 Ref: #combining-aliases240720
Node: Aliases and multiple files242152 Node: Aliases and multiple files241996
Ref: #aliases-and-multiple-files242351 Ref: #aliases-and-multiple-files242195
Node: end aliases242930 Node: end aliases242774
Ref: #end-aliases243077 Ref: #end-aliases242921
Node: Default parent account243226 Node: Default parent account243070
Ref: #default-parent-account243416 Ref: #default-parent-account243260
Node: Periodic transactions244300 Node: Periodic transactions244144
Ref: #periodic-transactions244483 Ref: #periodic-transactions244327
Node: Periodic rule syntax246400 Node: Periodic rule syntax246244
Ref: #periodic-rule-syntax246600 Ref: #periodic-rule-syntax246444
Node: Two spaces between period expression and description!247304 Node: Two spaces between period expression and description!247148
Ref: #two-spaces-between-period-expression-and-description247617 Ref: #two-spaces-between-period-expression-and-description247461
Node: Forecasting with periodic transactions248301 Node: Forecasting with periodic transactions248145
Ref: #forecasting-with-periodic-transactions248600 Ref: #forecasting-with-periodic-transactions248444
Node: Budgeting with periodic transactions251371 Node: Budgeting with periodic transactions251215
Ref: #budgeting-with-periodic-transactions251604 Ref: #budgeting-with-periodic-transactions251448
Node: Auto postings252013 Node: Auto postings251857
Ref: #auto-postings252149 Ref: #auto-postings251993
Node: Auto postings and multiple files254328 Node: Auto postings and multiple files254172
Ref: #auto-postings-and-multiple-files254526 Ref: #auto-postings-and-multiple-files254370
Node: Auto postings and dates254735 Node: Auto postings and dates254579
Ref: #auto-postings-and-dates255003 Ref: #auto-postings-and-dates254847
Node: Auto postings and transaction balancing / inferred amounts / balance assertions255178 Node: Auto postings and transaction balancing / inferred amounts / balance assertions255022
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions255523 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions255367
Node: Auto posting tags256026 Node: Auto posting tags255870
Ref: #auto-posting-tags256235 Ref: #auto-posting-tags256079
Node: CSV FORMAT256871 Node: CSV FORMAT256715
Ref: #csv-format256999 Ref: #csv-format256843
Node: Examples259628 Node: Examples259472
Ref: #examples259731 Ref: #examples259575
Node: Basic259939 Node: Basic259783
Ref: #basic260041 Ref: #basic259885
Node: Bank of Ireland260583 Node: Bank of Ireland260427
Ref: #bank-of-ireland260720 Ref: #bank-of-ireland260564
Node: Amazon262182 Node: Amazon262026
Ref: #amazon262302 Ref: #amazon262146
Node: Paypal264021 Node: Paypal263865
Ref: #paypal264117 Ref: #paypal263961
Node: CSV rules271761 Node: CSV rules271605
Ref: #csv-rules271879 Ref: #csv-rules271723
Node: skip272212 Node: skip272056
Ref: #skip272312 Ref: #skip272156
Node: fields list272687 Node: fields list272531
Ref: #fields-list272826 Ref: #fields-list272670
Node: field assignment274329 Node: field assignment274173
Ref: #field-assignment274481 Ref: #field-assignment274325
Node: Field names275516 Node: Field names275360
Ref: #field-names275656 Ref: #field-names275500
Node: date field276036 Node: date field275880
Ref: #date-field276156 Ref: #date-field276000
Node: date2 field276204 Node: date2 field276048
Ref: #date2-field276347 Ref: #date2-field276191
Node: status field276403 Node: status field276247
Ref: #status-field276548 Ref: #status-field276392
Node: code field276597 Node: code field276441
Ref: #code-field276744 Ref: #code-field276588
Node: description field276789 Node: description field276633
Ref: #description-field276951 Ref: #description-field276795
Node: comment field277010 Node: comment field276854
Ref: #comment-field277167 Ref: #comment-field277011
Node: account field277467 Node: account field277311
Ref: #account-field277619 Ref: #account-field277463
Node: amount field278194 Node: amount field278038
Ref: #amount-field278345 Ref: #amount-field278189
Node: currency field279590 Node: currency field279434
Ref: #currency-field279745 Ref: #currency-field279589
Node: balance field280002 Node: balance field279846
Ref: #balance-field280136 Ref: #balance-field279980
Node: separator280508 Node: separator280352
Ref: #separator280640 Ref: #separator280484
Node: if block281180 Node: if block281024
Ref: #if-block281307 Ref: #if-block281151
Node: Matching the whole record281708 Node: Matching the whole record281552
Ref: #matching-the-whole-record281885 Ref: #matching-the-whole-record281729
Node: Matching individual fields282688 Node: Matching individual fields282532
Ref: #matching-individual-fields282894 Ref: #matching-individual-fields282738
Node: Combining matchers283118 Node: Combining matchers282962
Ref: #combining-matchers283316 Ref: #combining-matchers283160
Node: Rules applied on successful match283629 Node: Rules applied on successful match283473
Ref: #rules-applied-on-successful-match283822 Ref: #rules-applied-on-successful-match283666
Node: if table284476 Node: if table284320
Ref: #if-table284597 Ref: #if-table284441
Node: end286335 Node: end286179
Ref: #end286449 Ref: #end286293
Node: date-format286673 Node: date-format286517
Ref: #date-format286807 Ref: #date-format286651
Node: decimal-mark287803 Node: decimal-mark287647
Ref: #decimal-mark287950 Ref: #decimal-mark287794
Node: newest-first288289 Node: newest-first288133
Ref: #newest-first288432 Ref: #newest-first288276
Node: include289115 Node: include288959
Ref: #include289248 Ref: #include289092
Node: balance-type289692 Node: balance-type289536
Ref: #balance-type289814 Ref: #balance-type289658
Node: Tips290514 Node: Tips290358
Ref: #tips290605 Ref: #tips290449
Node: Rapid feedback290904 Node: Rapid feedback290748
Ref: #rapid-feedback291023 Ref: #rapid-feedback290867
Node: Valid CSV291475 Node: Valid CSV291319
Ref: #valid-csv291607 Ref: #valid-csv291451
Node: File Extension291799 Node: File Extension291643
Ref: #file-extension291953 Ref: #file-extension291797
Node: Reading multiple CSV files292382 Node: Reading multiple CSV files292226
Ref: #reading-multiple-csv-files292569 Ref: #reading-multiple-csv-files292413
Node: Valid transactions292810 Node: Valid transactions292654
Ref: #valid-transactions292990 Ref: #valid-transactions292834
Node: Deduplicating importing293618 Node: Deduplicating importing293462
Ref: #deduplicating-importing293799 Ref: #deduplicating-importing293643
Node: Setting amounts294832 Node: Setting amounts294676
Ref: #setting-amounts294989 Ref: #setting-amounts294833
Node: Amount signs297430 Node: Amount signs297274
Ref: #amount-signs297584 Ref: #amount-signs297428
Node: Setting currency/commodity298271 Node: Setting currency/commodity298115
Ref: #setting-currencycommodity298459 Ref: #setting-currencycommodity298303
Node: Amount decimal places299633 Node: Amount decimal places299477
Ref: #amount-decimal-places299825 Ref: #amount-decimal-places299669
Node: Referencing other fields300137 Node: Referencing other fields299981
Ref: #referencing-other-fields300336 Ref: #referencing-other-fields300180
Node: How CSV rules are evaluated301233 Node: How CSV rules are evaluated301077
Ref: #how-csv-rules-are-evaluated301408 Ref: #how-csv-rules-are-evaluated301252
Node: TIMECLOCK FORMAT302859 Node: TIMECLOCK FORMAT302703
Ref: #timeclock-format302999 Ref: #timeclock-format302843
Node: TIMEDOT FORMAT305060 Node: TIMEDOT FORMAT304904
Ref: #timedot-format305198 Ref: #timedot-format305042
Node: COMMON TASKS309760 Node: COMMON TASKS309604
Ref: #common-tasks309889 Ref: #common-tasks309733
Node: Getting help310296 Node: Getting help310140
Ref: #getting-help310430 Ref: #getting-help310274
Node: Constructing command lines310983 Node: Constructing command lines310827
Ref: #constructing-command-lines311177 Ref: #constructing-command-lines311021
Node: Starting a journal file311874 Node: Starting a journal file311718
Ref: #starting-a-journal-file312074 Ref: #starting-a-journal-file311918
Node: Setting opening balances313262 Node: Setting opening balances313106
Ref: #setting-opening-balances313460 Ref: #setting-opening-balances313304
Node: Recording transactions316601 Node: Recording transactions316445
Ref: #recording-transactions316783 Ref: #recording-transactions316627
Node: Reconciling317339 Node: Reconciling317183
Ref: #reconciling317484 Ref: #reconciling317328
Node: Reporting319741 Node: Reporting319585
Ref: #reporting319883 Ref: #reporting319727
Node: Migrating to a new file323882 Node: Migrating to a new file323726
Ref: #migrating-to-a-new-file324032 Ref: #migrating-to-a-new-file323876
Node: LIMITATIONS324331 Node: LIMITATIONS324175
Ref: #limitations324459 Ref: #limitations324303
Node: TROUBLESHOOTING325202 Node: TROUBLESHOOTING325046
Ref: #troubleshooting325317 Ref: #troubleshooting325161
 
End Tag Table End Tag Table

View File

@ -2212,12 +2212,12 @@ COMMANDS
bols in a separate column bols in a separate column
o --layout=tidy: data is normalised to tidy form, with one row per data o --layout=tidy: data is normalised to tidy form, with one row per data
value. This is supported with CSV output format only. Totals and value. We currently support this with CSV output only. In tidy
row averages are disabled in this mode (-N/--no-total is implied and mode, totals and row averages are disabled (-N/--no-total is implied
-T/--row-total and -A/--average will be ignored). and -T/--row-total and -A/--average will be ignored).
These --layout values affect some but not all of the output formats, as These --layout modes are supported with some but not all of the output
shown: formats:
@ -2312,41 +2312,26 @@ COMMANDS
o Tidy layout produces normalised "tidy data", where every variable is o Tidy layout produces normalised "tidy data", where every variable is
a column and each row represents a single data point (see a column and each row represents a single data point (see
https://cran.r-project.org/web/packages/tidyr/vignettes/tidy- https://cran.r-project.org/web/packages/tidyr/vignettes/tidy-
data.html). This is the form of data most easily processed by other data.html). This kind of data is the easiest to process with other
software. Currently we support it with the CSV output format only: software:
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=tidy -Y $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy
"account","date","commodity","value" "account","period","start_date","end_date","commodity","value"
"Assets:US:ETrade","2012","GLD","0" "Assets:US:ETrade","2012","2012-01-01","2012-12-31","GLD","0"
"Assets:US:ETrade","2012","ITOT","10.00" "Assets:US:ETrade","2012","2012-01-01","2012-12-31","ITOT","10.00"
"Assets:US:ETrade","2012","USD","337.18" "Assets:US:ETrade","2012","2012-01-01","2012-12-31","USD","337.18"
"Assets:US:ETrade","2012","VEA","12.00" "Assets:US:ETrade","2012","2012-01-01","2012-12-31","VEA","12.00"
"Assets:US:ETrade","2012","VHT","106.00" "Assets:US:ETrade","2012","2012-01-01","2012-12-31","VHT","106.00"
"Assets:US:ETrade","2013","GLD","70.00" "Assets:US:ETrade","2013","2013-01-01","2013-12-31","GLD","70.00"
"Assets:US:ETrade","2013","ITOT","18.00" "Assets:US:ETrade","2013","2013-01-01","2013-12-31","ITOT","18.00"
"Assets:US:ETrade","2013","USD","-98.12" "Assets:US:ETrade","2013","2013-01-01","2013-12-31","USD","-98.12"
"Assets:US:ETrade","2013","VEA","10.00" "Assets:US:ETrade","2013","2013-01-01","2013-12-31","VEA","10.00"
"Assets:US:ETrade","2013","VHT","18.00" "Assets:US:ETrade","2013","2013-01-01","2013-12-31","VHT","18.00"
"Assets:US:ETrade","2014","GLD","0" "Assets:US:ETrade","2014","2014-01-01","2014-12-31","GLD","0"
"Assets:US:ETrade","2014","ITOT","-11.00" "Assets:US:ETrade","2014","2014-01-01","2014-12-31","ITOT","-11.00"
"Assets:US:ETrade","2014","USD","4881.44" "Assets:US:ETrade","2014","2014-01-01","2014-12-31","USD","4881.44"
"Assets:US:ETrade","2014","VEA","14.00" "Assets:US:ETrade","2014","2014-01-01","2014-12-31","VEA","14.00"
"Assets:US:ETrade","2014","VHT","170.00" "Assets:US:ETrade","2014","2014-01-01","2014-12-31","VHT","170.00"
"total","2012","GLD","0"
"total","2012","ITOT","10.00"
"total","2012","USD","337.18"
"total","2012","VEA","12.00"
"total","2012","VHT","106.00"
"total","2013","GLD","70.00"
"total","2013","ITOT","18.00"
"total","2013","USD","-98.12"
"total","2013","VEA","10.00"
"total","2013","VHT","18.00"
"total","2014","GLD","0"
"total","2014","ITOT","-11.00"
"total","2014","USD","4881.44"
"total","2014","VEA","14.00"
"total","2014","VHT","170.00"
Sorting by amount Sorting by amount
With -S/--sort-amount, accounts with the largest (most positive) bal- With -S/--sort-amount, accounts with the largest (most positive) bal-
@ -5014,8 +4999,6 @@ JOURNAL FORMAT
account. account.
comment Ignores part of the journal file, until end of current file Y comment Ignores part of the journal file, until end of current file Y
or end comment. or end comment.
commod- Declares a commodity, for checking all entries in all files; N, Y commod- Declares a commodity, for checking all entries in all files; N, Y
ity the decimal mark for parsing amounts of this commodity, for ity the decimal mark for parsing amounts of this commodity, for
following entries until end of current file; and its display following entries until end of current file; and its display
@ -5899,6 +5882,7 @@ CSV FORMAT
records records
fields list name CSV fields, assign them to hledger fields list name CSV fields, assign them to hledger
fields fields
field assignment assign a value to one hledger field, with field assignment assign a value to one hledger field, with
interpolation interpolation
Field names hledger field names, used in the fields list Field names hledger field names, used in the fields list