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

;doc: update CLI usage texts

Browse Source
This commit is contained in:
Simon Michael 2021-12-06 15:04:07 -10:00
parent 4d6f1ed0bf
commit 763d171108
1 changed files with 22 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
hledger/Hledger/Cli/Commands/Balance.txt
View File

@ -268,12 +268,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 tidy
and row averages are disabled in this mode (-N/--no-total is implied mode, totals and row averages are disabled (-N/--no-total is implied
and -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:
- txt csv html json sql - txt csv html json sql
------ ----- ----- ------ ------ ----- ------ ----- ----- ------ ------ -----
@ -366,41 +366,25 @@ Examples:
- Tidy layout produces normalised "tidy data", where every variable is - 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-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"
Sorting by amount Sorting by amount