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

;doc: update manuals

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
hledger-ui/hledger-ui.1
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.

55
hledger-ui/hledger-ui.info
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

251
hledger-ui/hledger-ui.txt
View File

@ -215,91 +215,92 @@ 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.
? shows a help dialog listing all keys. (Some of these also appear in ? shows a help dialog listing all keys. (Some of these also appear in
the quick help at the bottom of each screen.) Press ? again (or ESCAPE, the quick help at the bottom of each screen.) Press ? again (or ESCAPE,
or LEFT, or q) to close it. The following keys work on most screens: or LEFT, or q) to close it. The following keys work on most screens:
The cursor keys navigate: RIGHT goes deeper, LEFT returns to the previ- The cursor keys navigate: RIGHT goes deeper, LEFT returns to the previ-
ous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down through lists. ous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down through lists.
Emacs-style (CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also sup- Emacs-style (CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also sup-
ported (but not vi-style keys, since hledger-1.19, sorry!). A tip: ported (but not vi-style keys, since hledger-1.19, sorry!). A tip:
movement speed is limited by your keyboard repeat rate, to move faster movement speed is limited by your keyboard repeat rate, to move faster
you may want to adjust it. (If you're on a mac, the karabiner app is you may want to adjust it. (If you're on a mac, the karabiner app is
one way to do that.) one way to do that.)
With shift pressed, the cursor keys adjust the report period, limiting With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown). SHIFT- the transactions to be shown (by default, all are shown). SHIFT-
DOWN/UP steps downward and upward through these standard report period DOWN/UP steps downward and upward through these standard report period
durations: year, quarter, month, week, day. Then, SHIFT-LEFT/RIGHT durations: year, quarter, month, week, day. Then, SHIFT-LEFT/RIGHT
moves to the previous/next period. T sets the report period to today. moves to the previous/next period. T sets the report period to today.
With the --watch option, when viewing a "current" period (the current With the --watch option, when viewing a "current" period (the current
day, week, month, quarter, or year), the period will move automatically day, week, month, quarter, or year), the period will move automatically
to track the current date. To set a non-standard period, you can use / to track the current date. To set a non-standard period, you can use /
and a date: query. and a date: query.
/ lets you set a general filter query limiting the data shown, using / lets you set a general filter query limiting the data shown, using
the same query terms as in hledger and hledger-web. While editing the the same query terms as in hledger and hledger-web. While editing the
query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set
it, or ESCAPEto cancel. There are also keys for quickly adjusting some it, or ESCAPEto cancel. There are also keys for quickly adjusting some
common filters like account depth and transaction status (see below). common filters like account depth and transaction status (see below).
BACKSPACE or DELETE removes all filters, showing all transactions. BACKSPACE or DELETE removes all filters, showing all transactions.
As mentioned above, by default hledger-ui hides future transactions - As mentioned above, by default hledger-ui hides future transactions -
both ordinary transactions recorded in the journal, and periodic trans- both ordinary transactions recorded in the journal, and periodic trans-
actions generated by rule. F toggles forecast mode, in which actions generated by rule. F toggles forecast mode, in which
future/forecasted transactions are shown. future/forecasted transactions are shown.
ESCAPE resets the UI state and jumps back to the top screen, restoring ESCAPE resets the UI state and jumps back to the top screen, restoring
the app's initial state at startup. Or, it cancels minibuffer data the app's initial state at startup. Or, it cancels minibuffer data
entry or the help dialog. entry or the help dialog.
CTRL-l redraws the screen and centers the selection if possible (selec- CTRL-l redraws the screen and centers the selection if possible (selec-
tions near the top won't be centered, since we don't scroll above the tions near the top won't be centered, since we don't scroll above the
top). top).
g reloads from the data file(s) and updates the current screen and any g reloads from the data file(s) and updates the current screen and any
previous screens. (With large files, this could cause a noticeable previous screens. (With large files, this could cause a noticeable
pause.) pause.)
I toggles balance assertion checking. Disabling balance assertions I toggles balance assertion checking. Disabling balance assertions
temporarily can be useful for troubleshooting. temporarily can be useful for troubleshooting.
a runs command-line hledger's add command, and reloads the updated a runs command-line hledger's add command, and reloads the updated
file. This allows some basic data entry. file. This allows some basic data entry.
A is like a, but runs the hledger-iadd tool, which provides a terminal A is like a, but runs the hledger-iadd tool, which provides a terminal
interface. This key will be available if hledger-iadd is installed in interface. This key will be available if hledger-iadd is installed in
$path. $path.
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a "" E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""
-nw) on the journal file. With some editors (emacs, vi), the cursor -nw) on the journal file. With some editors (emacs, vi), the cursor
will be positioned at the current transaction when invoked from the will be positioned at the current transaction when invoked from the
register and transaction screens, and at the error location (if possi- register and transaction screens, and at the error location (if possi-
ble) when invoked from the error screen. ble) when invoked from the error screen.
B toggles cost mode, showing amounts in their transaction price's com- B toggles cost mode, showing amounts in their transaction price's com-
modity (like toggling the -B/--cost flag). modity (like toggling the -B/--cost flag).
V toggles value mode, showing amounts' current market value in their V toggles value mode, showing amounts' current market value in their
default valuation commodity (like toggling the -V/--market flag). default valuation commodity (like toggling the -V/--market flag).
Note, "current market value" means the value on the report end date if Note, "current market value" means the value on the report end date if
specified, otherwise today. To see the value on another date, you can specified, otherwise today. To see the value on another date, you can
temporarily set that as the report end date. Eg: to see a transaction temporarily set that as the report end date. Eg: to see a transaction
as it was valued on july 30, go to the accounts or register screen, as it was valued on july 30, go to the accounts or register screen,
press /, and add date:-7/30 to the query. press /, and add date:-7/30 to the query.
At most one of cost or value mode can be active at once. At most one of cost or value mode can be active at once.
There's not yet any visual reminder when cost or value mode is active; There's not yet any visual reminder when cost or value mode is active;
for now pressing b b v should reliably reset to normal mode. for now pressing b b v should reliably reset to normal mode.
q quits the application. q quits the application.
@ -308,44 +309,44 @@ KEYS
SCREENS SCREENS
Accounts screen Accounts screen
This is normally the first screen displayed. It lists accounts and This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows their balances, like hledger's balance command. By default, it shows
all accounts and their latest ending balances (including the balances all accounts and their latest ending balances (including the balances
of subaccounts). If you specify a query on the command line, it shows of subaccounts). If you specify a query on the command line, it shows
just the matched accounts and the balances from matched transactions. just the matched accounts and the balances from matched transactions.
Account names are shown as a flat list by default; press t to toggle Account names are shown as a flat list by default; press t to toggle
tree mode. In list mode, account balances are exclusive of subac- tree mode. In list mode, account balances are exclusive of subac-
counts, except where subaccounts are hidden by a depth limit (see counts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of subac- below). In tree mode, all account balances are inclusive of subac-
counts. counts.
To see less detail, press a number key, 1 to 9, to set a depth limit. To see less detail, press a number key, 1 to 9, to set a depth limit.
Or use - to decrease and +/= to increase the depth limit. 0 shows even Or use - to decrease and +/= to increase the depth limit. 0 shows even
less detail, collapsing all accounts to a single total. To remove the less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press depth limit, set it higher than the maximum account depth, or press
ESCAPE. ESCAPE.
H toggles between showing historical balances or period balances. His- H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before (filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions disturbed by a filter query). Period balances ignore transactions
before the report start date, so they show the change in balance during before the report start date, so they show the change in balance during
the report period. They are more useful eg when viewing a time log. the report period. They are more useful eg when viewing a time log.
U toggles filtering by unmarked status, including or excluding unmarked U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (By default, balances include all postings; toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are if you activate one or two status filters, only those postings are
included; and if you activate all three, the filter is removed.) included; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only accounts with nonzero balances Z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line are shown (hledger-ui shows zero items by default, unlike command-line
hledger). hledger).
Press RIGHT to view an account's transactions register. Press RIGHT to view an account's transactions register.
@ -354,124 +355,124 @@ SCREENS
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows: a check register. Each line represents one transaction and shows:
o the other account(s) involved, in abbreviated form. (If there are o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected both real and virtual postings, it shows only the accounts affected
by real postings.) by real postings.)
o the overall change to the current account's balance; positive for an o the overall change to the current account's balance; positive for an
inflow to this account, negative for an outflow. inflow to this account, negative for an outflow.
o the running historical total or period total for the current account, o the running historical total or period total for the current account,
after the transaction. This can be toggled with H. Similar to the after the transaction. This can be toggled with H. Similar to the
accounts screen, the historical total is affected by transactions accounts screen, the historical total is affected by transactions
(filtered by the filter query) before the report start date, while (filtered by the filter query) before the report start date, while
the period total is not. If the historical total is not disturbed by the period total is not. If the historical total is not disturbed by
a filter query, it will be the running historical balance you would a filter query, it will be the running historical balance you would
see on a bank register for the current account. see on a bank register for the current account.
Transactions affecting this account's subaccounts will be included in Transactions affecting this account's subaccounts will be included in
the register if the accounts screen is in tree mode, or if it's in list the register if the accounts screen is in tree mode, or if it's in list
mode but this account has subaccounts which are not shown due to a mode but this account has subaccounts which are not shown due to a
depth limit. In other words, the register always shows the transac- depth limit. In other words, the register always shows the transac-
tions contributing to the balance shown on the accounts screen. Tree tions contributing to the balance shown on the accounts screen. Tree
mode/list mode can be toggled with t here also. mode/list mode can be toggled with t here also.
U toggles filtering by unmarked status, showing or hiding unmarked U toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, P toggles pending transactions, and C toggles transactions. Similarly, P toggles pending transactions, and C toggles
cleared transactions. (By default, transactions with all statuses are cleared transactions. (By default, transactions with all statuses are
shown; if you activate one or two status filters, only those transac- shown; if you activate one or two status filters, only those transac-
tions are shown; and if you activate all three, the filter is removed.) tions are shown; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only transactions posting a nonzero Z toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com- change are shown (hledger-ui shows zero items by default, unlike com-
mand-line hledger). mand-line hledger).
Press RIGHT to view the selected transaction in detail. Press RIGHT to view the selected transaction in detail.
Transaction screen Transaction screen
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour- similar to hledger's print command and journal format (hledger_jour-
nal(5)). nal(5)).
The transaction's date(s) and any cleared flag, transaction code, The transaction's date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are description, comments, along with all of its account postings are
shown. Simple transactions have two postings, but there can be more shown. Simple transactions have two postings, but there can be more
(or in certain cases, fewer). (or in certain cases, fewer).
UP and DOWN will step through all transactions listed in the previous UP and DOWN will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary show your position within that account register. They will vary
depending on which account register you came from (remember most trans- depending on which account register you came from (remember most trans-
actions appear in multiple account registers). The #N number preceding actions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour- them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload). nal, which is a more stable id (at least until the next reload).
Error screen Error screen
This screen will appear if there is a problem, such as a parse error, This screen will appear if there is a problem, such as a parse error,
when you press g to reload. Once you have fixed the problem, press g when you press g to reload. Once you have fixed the problem, press g
again to reload and resume normal operation. (Or, you can press escape again to reload and resume normal operation. (Or, you can press escape
to cancel the reload attempt.) to cancel the reload attempt.)
TIPS TIPS
Watch mode Watch mode
One of hledger-ui's best features is the auto-reloading --watch mode. One of hledger-ui's best features is the auto-reloading --watch mode.
With this flag, it will update the display automatically whenever With this flag, it will update the display automatically whenever
changes are saved to the data files. changes are saved to the data files.
This is very useful when reconciling. A good workflow is to have your This is very useful when reconciling. A good workflow is to have your
bank's online register open in a browser window, for reference; the bank's online register open in a browser window, for reference; the
journal file open in an editor window; and hledger-ui in watch mode in journal file open in an editor window; and hledger-ui in watch mode in
a terminal window, eg: a terminal window, eg:
$ hledger-ui --watch --register checking -C $ hledger-ui --watch --register checking -C
As you mark things cleared in the editor, you can see the effect imme- As you mark things cleared in the editor, you can see the effect imme-
diately without having to context switch. This leaves more mental diately without having to context switch. This leaves more mental
bandwidth for your accounting. Of course you can still interact with bandwidth for your accounting. Of course you can still interact with
hledger-ui when needed, eg to toggle cleared mode, or to explore the hledger-ui when needed, eg to toggle cleared mode, or to explore the
history. history.
Watch mode limitations Watch mode limitations
There are situations in which it won't work, ie the display will not There are situations in which it won't work, ie the display will not
update when you save a change (because the underlying inotify library update when you save a change (because the underlying inotify library
does not support it). Here are some that we know of: does not support it). Here are some that we know of:
o Certain editors: saving with gedit, and perhaps any Gnome applica- o Certain editors: saving with gedit, and perhaps any Gnome applica-
tion, won't be detected (#1617). Jetbrains IDEs, such as IDEA, also tion, won't be detected (#1617). Jetbrains IDEs, such as IDEA, also
may not work (#911). may not work (#911).
o Certain unusual filesystems might not be supported. (All the usual o Certain unusual filesystems might not be supported. (All the usual
ones on unix, mac and windows are supported.) ones on unix, mac and windows are supported.)
In such cases, the workaround is to switch to the hledger-ui window and In such cases, the workaround is to switch to the hledger-ui window and
press g each time you want it to reload. (Actually, see #1617 for press g each time you want it to reload. (Actually, see #1617 for
another workaround, and let us know if it works for you.) another workaround, and let us know if it works for you.)
If you leave hledger-ui --watch running for days, on certain platforms If you leave hledger-ui --watch running for days, on certain platforms
(?), perhaps with many transactions in your journal (?), perhaps with (?), perhaps with many transactions in your journal (?), perhaps with
large numbers of other files present (?), you may see it gradually large numbers of other files present (?), you may see it gradually
using more and more memory and CPU over time, as seen in top or Activ- using more and more memory and CPU over time, as seen in top or Activ-
ity Monitor or Task Manager. ity Monitor or Task Manager.
A workaround is to quit and restart it, or to suspend it (CTRL-z) and A workaround is to quit and restart it, or to suspend it (CTRL-z) and
restart it (fg) if your shell supports that. restart it (fg) if your shell supports that.
ENVIRONMENT ENVIRONMENT
COLUMNS The screen width to use. Default: the full terminal width. COLUMNS The screen width to use. Default: the full terminal width.
LEDGER_FILE The journal file path when not specified with -f. Default: LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal). nal).
A typical value is ~/DIR/YYYY.journal, where DIR is a version-con- A typical value is ~/DIR/YYYY.journal, where DIR is a version-con-
trolled finance directory and YYYY is the current year. Or ~/DIR/cur- trolled finance directory and YYYY is the current year. Or ~/DIR/cur-
rent.journal, where current.journal is a symbolic link to YYYY.journal. rent.journal, where current.journal is a symbolic link to YYYY.journal.
On Mac computers, you can set this and other environment variables in a On Mac computers, you can set this and other environment variables in a
more thorough way that also affects applications started from the GUI more thorough way that also affects applications started from the GUI
(say, an Emacs dock icon). Eg on MacOS Catalina I have a (say, an Emacs dock icon). Eg on MacOS Catalina I have a
~/.MacOSX/environment.plist file containing ~/.MacOSX/environment.plist file containing
{ {
@ -481,13 +482,13 @@ ENVIRONMENT
To see the effect you may need to killall Dock, or reboot. To see the effect you may need to killall Dock, or reboot.
FILES FILES
Reads data from one or more files in hledger journal, timeclock, time- Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). C:/Users/USER/.hledger.journal).
BUGS BUGS
The need to precede options with -- when invoked from hledger is awk- The need to precede options with -- when invoked from hledger is awk-
ward. ward.
-f- doesn't work (hledger-ui can't read from stdin). -f- doesn't work (hledger-ui can't read from stdin).
@ -495,24 +496,24 @@ BUGS
-V affects only the accounts screen. -V affects only the accounts screen.
When you press g, the current and all previous screens are regenerated, When you press g, the current and all previous screens are regenerated,
which may cause a noticeable pause with large files. Also there is no which may cause a noticeable pause with large files. Also there is no
visual indication that this is in progress. visual indication that this is in progress.
--watch is not yet fully robust. It works well for normal usage, but --watch is not yet fully robust. It works well for normal usage, but
many file changes in a short time (eg saving the file thousands of many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. Symp- times with an editor macro) can cause problems at least on OSX. Symp-
toms include: unresponsive UI, periodic resetting of the cursor posi- toms include: unresponsive UI, periodic resetting of the cursor posi-
tion, momentary display of parse errors, high CPU usage eventually sub- tion, momentary display of parse errors, high CPU usage eventually sub-
siding, and possibly a small but persistent build-up of CPU usage until siding, and possibly a small but persistent build-up of CPU usage until
the program is restarted. the program is restarted.
Also, if you are viewing files mounted from another machine, --watch Also, if you are viewing files mounted from another machine, --watch
requires that both machine clocks are roughly in step. requires that both machine clocks are roughly in step.
REPORTING BUGS REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list) or hledger mail list)

33
hledger/hledger.1
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

564
hledger/hledger.info
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

1462
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff