;doc: update manuals

This commit is contained in:
Simon Michael 2021-11-20 22:07:45 -10:00
parent 066a67ad09
commit e0dc028374
6 changed files with 1204 additions and 1169 deletions

View File

@ -224,12 +224,12 @@ should contain one command line option/argument per line.
In most modern terminals, you can navigate through the screens with a In most modern terminals, you can navigate through the screens with a
mouse or touchpad: mouse or touchpad:
.IP \[bu] 2 .IP \[bu] 2
Use mouse wheel or trackpad to scroll lists up and down Use mouse wheel or trackpad to scroll up and down
.IP \[bu] 2 .IP \[bu] 2
Left click on list items to go deeper (like the \f[C]RIGHT\f[R] key) Click on list items to go deeper
.IP \[bu] 2 .IP \[bu] 2
Left click on the left-most column go back (like the \f[C]LEFT\f[R] Click on the left margin (column 0), or the blank area at bottom of
key). screen, to go back.
.SH KEYS .SH KEYS
.PP .PP
Keyboard gives more control. Keyboard gives more control.

View File

@ -245,11 +245,12 @@ File: hledger-ui.info, Node: MOUSE, Next: KEYS, Prev: OPTIONS, Up: Top
In most modern terminals, you can navigate through the screens with a In most modern terminals, you can navigate through the screens with a
mouse or touchpad: mouse or touchpad:
* Use mouse wheel or trackpad to scroll lists up and down * Use mouse wheel or trackpad to scroll up and down
* Left click on list items to go deeper (like the `RIGHT' key) * Click on list items to go deeper
* Left click on the left-most column go back (like the `LEFT' key). * Click on the left margin (column 0), or the blank area at bottom of
screen, to go back.
 
File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: MOUSE, Up: Top File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: MOUSE, Up: Top
@ -630,29 +631,29 @@ Node: OPTIONS1647
Ref: #options1745 Ref: #options1745
Node: MOUSE6617 Node: MOUSE6617
Ref: #mouse6712 Ref: #mouse6712
Node: KEYS7003 Node: KEYS6996
Ref: #keys7096 Ref: #keys7089
Node: SCREENS11157 Node: SCREENS11150
Ref: #screens11255 Ref: #screens11248
Node: Accounts screen11345 Node: Accounts screen11338
Ref: #accounts-screen11473 Ref: #accounts-screen11466
Node: Register screen13666 Node: Register screen13659
Ref: #register-screen13821 Ref: #register-screen13814
Node: Transaction screen15803 Node: Transaction screen15796
Ref: #transaction-screen15961 Ref: #transaction-screen15954
Node: Error screen16828 Node: Error screen16821
Ref: #error-screen16950 Ref: #error-screen16943
Node: TIPS17192 Node: TIPS17185
Ref: #tips17291 Ref: #tips17284
Node: Watch mode17343 Node: Watch mode17336
Ref: #watch-mode17460 Ref: #watch-mode17453
Node: Watch mode limitations18204 Node: Watch mode limitations18197
Ref: #watch-mode-limitations18345 Ref: #watch-mode-limitations18338
Node: ENVIRONMENT19478 Node: ENVIRONMENT19471
Ref: #environment19589 Ref: #environment19582
Node: FILES20394 Node: FILES20387
Ref: #files20493 Ref: #files20486
Node: BUGS20706 Node: BUGS20699
Ref: #bugs20783 Ref: #bugs20776
 
End Tag Table End Tag Table

View File

@ -215,11 +215,12 @@ MOUSE
In most modern terminals, you can navigate through the screens with a In most modern terminals, you can navigate through the screens with a
mouse or touchpad: mouse or touchpad:
o Use mouse wheel or trackpad to scroll lists up and down o Use mouse wheel or trackpad to scroll up and down
o Left click on list items to go deeper (like the RIGHT key) o Click on list items to go deeper
o Left click on the left-most column go back (like the LEFT key). o Click on the left margin (column 0), or the blank area at bottom of
screen, to go back.
KEYS KEYS
Keyboard gives more control. Keyboard gives more control.

View File

@ -5519,28 +5519,39 @@ stats
.PD 0 .PD 0
.P .P
.PD .PD
Show some journal statistics. Show journal and performance statistics.
.PP .PP
The stats command displays summary information for the whole journal, or The stats command displays summary information for the whole journal, or
a matched part of it. a matched part of it.
With a reporting interval, it shows a report for each report period. With a reporting interval, it shows a report for each report period.
.PP .PP
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 \f[C]stats\f[R] command\[aq]s run time is similar to that of a
single-column balance report.
.PP
Example: Example:
.IP .IP
.nf .nf
\f[C] \f[C]
$ hledger stats $ hledger stats -f examples/1000x1000x10.journal
Main journal file : /src/hledger/examples/sample.journal Main file : /Users/simon/src/hledger/examples/1000x1000x10.journal
Included journal files : Included files :
Transactions span : 2008-01-01 to 2009-01-01 (366 days) Transactions span : 2000-01-01 to 2002-09-27 (1000 days)
Last transaction : 2008-12-31 (2333 days ago) Last transaction : 2002-09-26 (6995 days ago)
Transactions : 5 (0.0 per day) Transactions : 1000 (1.0 per day)
Transactions last 30 days: 0 (0.0 per day) Transactions last 30 days: 0 (0.0 per day)
Transactions last 7 days : 0 (0.0 per day) Transactions last 7 days : 0 (0.0 per day)
Payees/descriptions : 5 Payees/descriptions : 1000
Accounts : 8 (depth 3) Accounts : 1000 (depth 10)
Commodities : 1 ($) 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 : 12 ($) Market prices : 1000 (A)
Run time : 0.12 s
Throughput : 8342 txns/s
\f[R] \f[R]
.fi .fi
.PP .PP

View File

@ -4976,27 +4976,37 @@ File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS
=========== ===========
stats stats
Show some journal statistics. Show journal and performance statistics.
The stats command displays summary information for the whole The stats command displays summary information for the whole
journal, or a matched part of it. With a reporting interval, it shows a journal, or a matched part of it. With a reporting interval, it shows a
report for each report period. 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: Example:
$ hledger stats $ hledger stats -f examples/1000x1000x10.journal
Main journal file : /src/hledger/examples/sample.journal Main file : /Users/simon/src/hledger/examples/1000x1000x10.journal
Included journal files : Included files :
Transactions span : 2008-01-01 to 2009-01-01 (366 days) Transactions span : 2000-01-01 to 2002-09-27 (1000 days)
Last transaction : 2008-12-31 (2333 days ago) Last transaction : 2002-09-26 (6995 days ago)
Transactions : 5 (0.0 per day) Transactions : 1000 (1.0 per day)
Transactions last 30 days: 0 (0.0 per day) Transactions last 30 days: 0 (0.0 per day)
Transactions last 7 days : 0 (0.0 per day) Transactions last 7 days : 0 (0.0 per day)
Payees/descriptions : 5 Payees/descriptions : 1000
Accounts : 8 (depth 3) Accounts : 1000 (depth 10)
Commodities : 1 ($) 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 : 12 ($) Market prices : 1000 (A)
Run time : 0.12 s
Throughput : 8342 txns/s
This command also supports output destination and output format This command also supports output destination and output format
selection. selection.
@ -9791,271 +9801,271 @@ Node: IRR and TWR explained169444
Ref: #irr-and-twr-explained169604 Ref: #irr-and-twr-explained169604
Node: stats172666 Node: stats172666
Ref: #stats172767 Ref: #stats172767
Node: tags173554 Node: tags174143
Ref: #tags173654 Ref: #tags174243
Node: test174171 Node: test174760
Ref: #test174287 Ref: #test174876
Node: About add-on commands175032 Node: About add-on commands175621
Ref: #about-add-on-commands175169 Ref: #about-add-on-commands175758
Node: JOURNAL FORMAT176302 Node: JOURNAL FORMAT176891
Ref: #journal-format176430 Ref: #journal-format177019
Node: Transactions178650 Node: Transactions179239
Ref: #transactions178765 Ref: #transactions179354
Node: Dates179782 Node: Dates180371
Ref: #dates179898 Ref: #dates180487
Node: Simple dates179963 Node: Simple dates180552
Ref: #simple-dates180083 Ref: #simple-dates180672
Node: Secondary dates180590 Node: Secondary dates181179
Ref: #secondary-dates180738 Ref: #secondary-dates181327
Node: Posting dates182072 Node: Posting dates182661
Ref: #posting-dates182195 Ref: #posting-dates182784
Node: Status183564 Node: Status184153
Ref: #status183674 Ref: #status184263
Node: Code185379 Node: Code185968
Ref: #code185491 Ref: #code186080
Node: Description185722 Node: Description186311
Ref: #description185850 Ref: #description186439
Node: Payee and note186168 Node: Payee and note186757
Ref: #payee-and-note186276 Ref: #payee-and-note186865
Node: Comments186610 Node: Comments187199
Ref: #comments186732 Ref: #comments187321
Node: Tags187925 Node: Tags188514
Ref: #tags-1188036 Ref: #tags-1188625
Node: Postings189434 Node: Postings190023
Ref: #postings189558 Ref: #postings190147
Node: Virtual postings190582 Node: Virtual postings191171
Ref: #virtual-postings190693 Ref: #virtual-postings191282
Node: Account names191995 Node: Account names192584
Ref: #account-names192132 Ref: #account-names192721
Node: Amounts192618 Node: Amounts193207
Ref: #amounts192755 Ref: #amounts193344
Node: Decimal marks digit group marks193742 Node: Decimal marks digit group marks194331
Ref: #decimal-marks-digit-group-marks193919 Ref: #decimal-marks-digit-group-marks194508
Node: Commodity194940 Node: Commodity195529
Ref: #commodity195129 Ref: #commodity195718
Node: Directives influencing number parsing and display196079 Node: Directives influencing number parsing and display196668
Ref: #directives-influencing-number-parsing-and-display196340 Ref: #directives-influencing-number-parsing-and-display196929
Node: Commodity display style196832 Node: Commodity display style197421
Ref: #commodity-display-style197040 Ref: #commodity-display-style197629
Node: Rounding199235 Node: Rounding199824
Ref: #rounding199355 Ref: #rounding199944
Node: Transaction prices199765 Node: Transaction prices200354
Ref: #transaction-prices199931 Ref: #transaction-prices200520
Node: Lot prices lot dates202361 Node: Lot prices lot dates202950
Ref: #lot-prices-lot-dates202544 Ref: #lot-prices-lot-dates203133
Node: Balance assertions203031 Node: Balance assertions203620
Ref: #balance-assertions203209 Ref: #balance-assertions203798
Node: Assertions and ordering204239 Node: Assertions and ordering204828
Ref: #assertions-and-ordering204421 Ref: #assertions-and-ordering205010
Node: Assertions and included files205118 Node: Assertions and included files205707
Ref: #assertions-and-included-files205355 Ref: #assertions-and-included-files205944
Node: Assertions and multiple -f options205686 Node: Assertions and multiple -f options206275
Ref: #assertions-and-multiple--f-options205936 Ref: #assertions-and-multiple--f-options206525
Node: Assertions and commodities206067 Node: Assertions and commodities206656
Ref: #assertions-and-commodities206293 Ref: #assertions-and-commodities206882
Node: Assertions and prices207448 Node: Assertions and prices208037
Ref: #assertions-and-prices207656 Ref: #assertions-and-prices208245
Node: Assertions and subaccounts208097 Node: Assertions and subaccounts208686
Ref: #assertions-and-subaccounts208320 Ref: #assertions-and-subaccounts208909
Node: Assertions and virtual postings208644 Node: Assertions and virtual postings209233
Ref: #assertions-and-virtual-postings208880 Ref: #assertions-and-virtual-postings209469
Node: Assertions and precision209021 Node: Assertions and precision209610
Ref: #assertions-and-precision209208 Ref: #assertions-and-precision209797
Node: Balance assignments209473 Node: Balance assignments210062
Ref: #balance-assignments209643 Ref: #balance-assignments210232
Node: Balance assignments and prices210806 Node: Balance assignments and prices211395
Ref: #balance-assignments-and-prices210972 Ref: #balance-assignments-and-prices211561
Node: Directives211198 Node: Directives211787
Ref: #directives211361 Ref: #directives211950
Node: Directives and multiple files217104 Node: Directives and multiple files217693
Ref: #directives-and-multiple-files217300 Ref: #directives-and-multiple-files217889
Node: Comment blocks217962 Node: Comment blocks218551
Ref: #comment-blocks218139 Ref: #comment-blocks218728
Node: Including other files218314 Node: Including other files218903
Ref: #including-other-files218488 Ref: #including-other-files219077
Node: Default year219412 Node: Default year220001
Ref: #default-year219570 Ref: #default-year220159
Node: Declaring payees219977 Node: Declaring payees220566
Ref: #declaring-payees220148 Ref: #declaring-payees220737
Node: Declaring the decimal mark220393 Node: Declaring the decimal mark220982
Ref: #declaring-the-decimal-mark220593 Ref: #declaring-the-decimal-mark221182
Node: Declaring commodities220991 Node: Declaring commodities221580
Ref: #declaring-commodities221182 Ref: #declaring-commodities221771
Node: Commodity error checking223696 Node: Commodity error checking224285
Ref: #commodity-error-checking223846 Ref: #commodity-error-checking224435
Node: Default commodity224102 Node: Default commodity224691
Ref: #default-commodity224282 Ref: #default-commodity224871
Node: Declaring market prices225156 Node: Declaring market prices225745
Ref: #declaring-market-prices225345 Ref: #declaring-market-prices225934
Node: Declaring accounts226157 Node: Declaring accounts226746
Ref: #declaring-accounts226337 Ref: #declaring-accounts226926
Node: Account error checking227544 Node: Account error checking228133
Ref: #account-error-checking227710 Ref: #account-error-checking228299
Node: Account comments228887 Node: Account comments229476
Ref: #account-comments229071 Ref: #account-comments229660
Node: Account subdirectives229497 Node: Account subdirectives230086
Ref: #account-subdirectives229682 Ref: #account-subdirectives230271
Node: Account types229997 Node: Account types230586
Ref: #account-types230171 Ref: #account-types230760
Node: Declaring account types230828 Node: Declaring account types231417
Ref: #declaring-account-types231007 Ref: #declaring-account-types231596
Node: Auto-detected account types232059 Node: Auto-detected account types232648
Ref: #auto-detected-account-types232246 Ref: #auto-detected-account-types232835
Node: Account display order234258 Node: Account display order234847
Ref: #account-display-order234418 Ref: #account-display-order235007
Node: Rewriting accounts235569 Node: Rewriting accounts236158
Ref: #rewriting-accounts235748 Ref: #rewriting-accounts236337
Node: Basic aliases236507 Node: Basic aliases237096
Ref: #basic-aliases236643 Ref: #basic-aliases237232
Node: Regex aliases237385 Node: Regex aliases237974
Ref: #regex-aliases237547 Ref: #regex-aliases238136
Node: Combining aliases238267 Node: Combining aliases238856
Ref: #combining-aliases238450 Ref: #combining-aliases239039
Node: Aliases and multiple files239727 Node: Aliases and multiple files240316
Ref: #aliases-and-multiple-files239926 Ref: #aliases-and-multiple-files240515
Node: end aliases240507 Node: end aliases241096
Ref: #end-aliases240654 Ref: #end-aliases241243
Node: Default parent account240756 Node: Default parent account241345
Ref: #default-parent-account240946 Ref: #default-parent-account241535
Node: Periodic transactions241830 Node: Periodic transactions242419
Ref: #periodic-transactions242013 Ref: #periodic-transactions242602
Node: Periodic rule syntax243930 Node: Periodic rule syntax244519
Ref: #periodic-rule-syntax244130 Ref: #periodic-rule-syntax244719
Node: Two spaces between period expression and description!244833 Node: Two spaces between period expression and description!245422
Ref: #two-spaces-between-period-expression-and-description245146 Ref: #two-spaces-between-period-expression-and-description245735
Node: Forecasting with periodic transactions245831 Node: Forecasting with periodic transactions246420
Ref: #forecasting-with-periodic-transactions246130 Ref: #forecasting-with-periodic-transactions246719
Node: Budgeting with periodic transactions248898 Node: Budgeting with periodic transactions249487
Ref: #budgeting-with-periodic-transactions249131 Ref: #budgeting-with-periodic-transactions249720
Node: Auto postings249538 Node: Auto postings250127
Ref: #auto-postings249674 Ref: #auto-postings250263
Node: Auto postings and multiple files251857 Node: Auto postings and multiple files252446
Ref: #auto-postings-and-multiple-files252055 Ref: #auto-postings-and-multiple-files252644
Node: Auto postings and dates252263 Node: Auto postings and dates252852
Ref: #auto-postings-and-dates252531 Ref: #auto-postings-and-dates253120
Node: Auto postings and transaction balancing / inferred amounts / balance assertions252706 Node: Auto postings and transaction balancing / inferred amounts / balance assertions253295
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions253052 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions253641
Node: Auto posting tags253558 Node: Auto posting tags254147
Ref: #auto-posting-tags253767 Ref: #auto-posting-tags254356
Node: CSV FORMAT254404 Node: CSV FORMAT254993
Ref: #csv-format254532 Ref: #csv-format255121
Node: Examples257156 Node: Examples257745
Ref: #examples257259 Ref: #examples257848
Node: Basic257466 Node: Basic258055
Ref: #basic257568 Ref: #basic258157
Node: Bank of Ireland258112 Node: Bank of Ireland258701
Ref: #bank-of-ireland258249 Ref: #bank-of-ireland258838
Node: Amazon259714 Node: Amazon260303
Ref: #amazon259834 Ref: #amazon260423
Node: Paypal261555 Node: Paypal262144
Ref: #paypal261651 Ref: #paypal262240
Node: CSV rules269299 Node: CSV rules269888
Ref: #csv-rules269417 Ref: #csv-rules270006
Node: skip269750 Node: skip270339
Ref: #skip269850 Ref: #skip270439
Node: fields list270222 Node: fields list270811
Ref: #fields-list270361 Ref: #fields-list270950
Node: field assignment271866 Node: field assignment272455
Ref: #field-assignment272018 Ref: #field-assignment272607
Node: Field names273050 Node: Field names273639
Ref: #field-names273190 Ref: #field-names273779
Node: date field273569 Node: date field274158
Ref: #date-field273689 Ref: #date-field274278
Node: date2 field273737 Node: date2 field274326
Ref: #date2-field273880 Ref: #date2-field274469
Node: status field273936 Node: status field274525
Ref: #status-field274081 Ref: #status-field274670
Node: code field274130 Node: code field274719
Ref: #code-field274277 Ref: #code-field274866
Node: description field274322 Node: description field274911
Ref: #description-field274484 Ref: #description-field275073
Node: comment field274543 Node: comment field275132
Ref: #comment-field274700 Ref: #comment-field275289
Node: account field274999 Node: account field275588
Ref: #account-field275151 Ref: #account-field275740
Node: amount field275725 Node: amount field276314
Ref: #amount-field275876 Ref: #amount-field276465
Node: currency field277114 Node: currency field277703
Ref: #currency-field277269 Ref: #currency-field277858
Node: balance field277525 Node: balance field278114
Ref: #balance-field277659 Ref: #balance-field278248
Node: separator278031 Node: separator278620
Ref: #separator278163 Ref: #separator278752
Node: if block278705 Node: if block279294
Ref: #if-block278832 Ref: #if-block279421
Node: Matching the whole record279230 Node: Matching the whole record279819
Ref: #matching-the-whole-record279407 Ref: #matching-the-whole-record279996
Node: Matching individual fields280210 Node: Matching individual fields280799
Ref: #matching-individual-fields280416 Ref: #matching-individual-fields281005
Node: Combining matchers280640 Node: Combining matchers281229
Ref: #combining-matchers280838 Ref: #combining-matchers281427
Node: Rules applied on successful match281152 Node: Rules applied on successful match281741
Ref: #rules-applied-on-successful-match281345 Ref: #rules-applied-on-successful-match281934
Node: if table282002 Node: if table282591
Ref: #if-table282123 Ref: #if-table282712
Node: end283859 Node: end284448
Ref: #end283973 Ref: #end284562
Node: date-format284197 Node: date-format284786
Ref: #date-format284331 Ref: #date-format284920
Node: decimal-mark285328 Node: decimal-mark285917
Ref: #decimal-mark285475 Ref: #decimal-mark286064
Node: newest-first285812 Node: newest-first286401
Ref: #newest-first285955 Ref: #newest-first286544
Node: include286638 Node: include287227
Ref: #include286771 Ref: #include287360
Node: balance-type287213 Node: balance-type287802
Ref: #balance-type287335 Ref: #balance-type287924
Node: Tips288035 Node: Tips288624
Ref: #tips288126 Ref: #tips288715
Node: Rapid feedback288425 Node: Rapid feedback289014
Ref: #rapid-feedback288544 Ref: #rapid-feedback289133
Node: Valid CSV288995 Node: Valid CSV289584
Ref: #valid-csv289127 Ref: #valid-csv289716
Node: File Extension289319 Node: File Extension289908
Ref: #file-extension289473 Ref: #file-extension290062
Node: Reading multiple CSV files289902 Node: Reading multiple CSV files290491
Ref: #reading-multiple-csv-files290089 Ref: #reading-multiple-csv-files290678
Node: Valid transactions290329 Node: Valid transactions290918
Ref: #valid-transactions290509 Ref: #valid-transactions291098
Node: Deduplicating importing291137 Node: Deduplicating importing291726
Ref: #deduplicating-importing291318 Ref: #deduplicating-importing291907
Node: Setting amounts292350 Node: Setting amounts292939
Ref: #setting-amounts292507 Ref: #setting-amounts293096
Node: Amount signs294948 Node: Amount signs295537
Ref: #amount-signs295102 Ref: #amount-signs295691
Node: Setting currency/commodity295789 Node: Setting currency/commodity296378
Ref: #setting-currencycommodity295977 Ref: #setting-currencycommodity296566
Node: Amount decimal places297157 Node: Amount decimal places297746
Ref: #amount-decimal-places297349 Ref: #amount-decimal-places297938
Node: Referencing other fields297661 Node: Referencing other fields298250
Ref: #referencing-other-fields297860 Ref: #referencing-other-fields298449
Node: How CSV rules are evaluated298758 Node: How CSV rules are evaluated299347
Ref: #how-csv-rules-are-evaluated298933 Ref: #how-csv-rules-are-evaluated299522
Node: TIMECLOCK FORMAT300382 Node: TIMECLOCK FORMAT300971
Ref: #timeclock-format300522 Ref: #timeclock-format301111
Node: TIMEDOT FORMAT302590 Node: TIMEDOT FORMAT303179
Ref: #timedot-format302728 Ref: #timedot-format303317
Node: COMMON TASKS307287 Node: COMMON TASKS307876
Ref: #common-tasks307416 Ref: #common-tasks308005
Node: Getting help307823 Node: Getting help308412
Ref: #getting-help307957 Ref: #getting-help308546
Node: Constructing command lines308508 Node: Constructing command lines309097
Ref: #constructing-command-lines308702 Ref: #constructing-command-lines309291
Node: Starting a journal file309401 Node: Starting a journal file309990
Ref: #starting-a-journal-file309601 Ref: #starting-a-journal-file310190
Node: Setting opening balances310788 Node: Setting opening balances311377
Ref: #setting-opening-balances310986 Ref: #setting-opening-balances311575
Node: Recording transactions314119 Node: Recording transactions314708
Ref: #recording-transactions314301 Ref: #recording-transactions314890
Node: Reconciling314858 Node: Reconciling315447
Ref: #reconciling315003 Ref: #reconciling315592
Node: Reporting317248 Node: Reporting317837
Ref: #reporting317390 Ref: #reporting317979
Node: Migrating to a new file321310 Node: Migrating to a new file321899
Ref: #migrating-to-a-new-file321460 Ref: #migrating-to-a-new-file322049
Node: LIMITATIONS321758 Node: LIMITATIONS322347
Ref: #limitations321886 Ref: #limitations322475
Node: TROUBLESHOOTING322627 Node: TROUBLESHOOTING323216
Ref: #troubleshooting322742 Ref: #troubleshooting323331
 
End Tag Table End Tag Table

View File

@ -4001,26 +4001,36 @@ COMMANDS
stats stats
stats stats
Show some journal statistics. Show journal and performance statistics.
The stats command displays summary information for the whole journal, The stats command displays summary information for the whole journal,
or a matched part of it. With a reporting interval, it shows a report or a matched part of it. With a reporting interval, it shows a report
for each report period. 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: Example:
$ hledger stats $ hledger stats -f examples/1000x1000x10.journal
Main journal file : /src/hledger/examples/sample.journal Main file : /Users/simon/src/hledger/examples/1000x1000x10.journal
Included journal files : Included files :
Transactions span : 2008-01-01 to 2009-01-01 (366 days) Transactions span : 2000-01-01 to 2002-09-27 (1000 days)
Last transaction : 2008-12-31 (2333 days ago) Last transaction : 2002-09-26 (6995 days ago)
Transactions : 5 (0.0 per day) Transactions : 1000 (1.0 per day)
Transactions last 30 days: 0 (0.0 per day) Transactions last 30 days: 0 (0.0 per day)
Transactions last 7 days : 0 (0.0 per day) Transactions last 7 days : 0 (0.0 per day)
Payees/descriptions : 5 Payees/descriptions : 1000
Accounts : 8 (depth 3) Accounts : 1000 (depth 10)
Commodities : 1 ($) 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 : 12 ($) Market prices : 1000 (A)
Run time : 0.12 s
Throughput : 8342 txns/s
This command also supports output destination and output format selec- This command also supports output destination and output format selec-
tion. tion.
@ -4917,13 +4927,15 @@ JOURNAL FORMAT
subdi- optional indented directive line immediately following a parent subdi- optional indented directive line immediately following a parent
rec- directive rec- directive
tive tive
number how to interpret numbers when parsing journal entries (the iden- number how to interpret numbers when parsing journal entries (the iden-
nota- tity of the decimal separator character). (Currently each com- nota- tity of the decimal separator character). (Currently each com-
tion modity can have its own notation, even in the same file.) tion modity can have its own notation, even in the same file.)
dis- how to display amounts of a commodity in reports (symbol side dis- how to display amounts of a commodity in reports (symbol side
play and spacing, digit groups, decimal separator, decimal places) play and spacing, digit groups, decimal separator, decimal places)
style style
direc- which entries and (when there are multiple files) which files direc- which entries and (when there are multiple files) which files
tive are affected by a directive tive are affected by a directive
scope scope