;doc: update CLI usage texts

This commit is contained in:
Simon Michael 2021-11-20 22:07:40 -10:00
parent 91bfbbb437
commit 066a67ad09
2 changed files with 28 additions and 16 deletions

View File

@ -245,11 +245,13 @@ in the terminal. Here are some ways to handle that:
Commodity layout
With --layout, you can control how amounts with more than one commodity
are displayed: - --layout=wide[,WIDTH]: on a single line, possibly
elided to the specified width - --layout=tall: each commodity is
displayed on a separate line - --layout=bare: commodity symbols are
displayed in a separate column, and amounts are displayed as bare
numbers
are displayed:
- --layout=wide[,WIDTH]: on a single line, possibly elided to the
specified width
- --layout=tall: each commodity is displayed on a separate line
- --layout=bare: commodity symbols are displayed in a separate column,
and amounts are displayed as bare numbers
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide
Balance changes in 2012-01-01..2014-12-31:

View File

@ -1,5 +1,5 @@
stats
Show some journal statistics.
Show journal and performance statistics.
_FLAGS
@ -7,20 +7,30 @@ The stats command displays summary information for the whole journal, or
a matched part of it. With a reporting interval, it shows a report for
each report period.
At the end, it shows (in the terminal) the overall run time and number
of transactions processed per second. Note these are approximate and
will vary based on machine, current load, data size, hledger version,
haskell lib versions, GHC version.. but they may be of interest. The
stats command's run time is similar to that of a single-column balance
report.
Example:
$ hledger stats
Main journal file : /src/hledger/examples/sample.journal
Included journal files :
Transactions span : 2008-01-01 to 2009-01-01 (366 days)
Last transaction : 2008-12-31 (2333 days ago)
Transactions : 5 (0.0 per day)
$ hledger stats -f examples/1000x1000x10.journal
Main file : /Users/simon/src/hledger/examples/1000x1000x10.journal
Included files :
Transactions span : 2000-01-01 to 2002-09-27 (1000 days)
Last transaction : 2002-09-26 (6995 days ago)
Transactions : 1000 (1.0 per day)
Transactions last 30 days: 0 (0.0 per day)
Transactions last 7 days : 0 (0.0 per day)
Payees/descriptions : 5
Accounts : 8 (depth 3)
Commodities : 1 ($)
Market prices : 12 ($)
Payees/descriptions : 1000
Accounts : 1000 (depth 10)
Commodities : 26 (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z)
Market prices : 1000 (A)
Run time : 0.12 s
Throughput : 8342 txns/s
This command also supports output destination and output format
selection.