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

ui: doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2018-10-17 13:14:52 -07:00
parent b5df5fb5f0
commit b1582b29b1
4 changed files with 223 additions and 163 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
hledger-ui/hledger-ui.1
View File

@ -26,6 +26,13 @@ limited data entry capability.
It is easier than hledger's command\-line interface, and sometimes It is easier than hledger's command\-line interface, and sometimes
quicker and more convenient than the web interface. quicker and more convenient than the web interface.
.PP .PP
Note hledger\-ui has some different defaults: \- it generates
rule\-based transactions and postings by default (\[en]forecast and
\[en]auto are always on).
\- it hides transactions dated in the future by default (change this
with \[en]future or the F key).
Experimental.
.PP
Like hledger, it reads data from one or more files in hledger journal, Like hledger, it reads data from one or more files in hledger journal,
timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or
\f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows, \f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows,
@ -59,8 +66,18 @@ show period balances (changes) at startup instead of historical balances
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-flat\f[] .B \f[C]\-F\ \-\-flat\f[]
show full account names, unindented show accounts as a list (default)
.RS
.RE
.TP
.B \f[C]\-T\ \-\-tree\f[]
show accounts as a tree
.RS
.RE
.TP
.B \f[C]\-\-future\f[]
show transactions dated later than today (normally hidden)
.RS .RS
.RE .RE
.PP .PP
@ -270,6 +287,14 @@ account depth and transaction status (see below).
\f[C]BACKSPACE\f[] or \f[C]DELETE\f[] removes all filters, showing all \f[C]BACKSPACE\f[] or \f[C]DELETE\f[] removes all filters, showing all
transactions. transactions.
.PP .PP
As mentioned above, hledger\-ui shows auto\-generated periodic
transactions, and hides future transactions (auto\-generated or not) by
default.
\f[C]F\f[] toggles showing and hiding these future transactions.
This is similar to using a query like \f[C]date:\-tomorrow\f[], but more
convenient.
(experimental)
.PP
\f[C]ESCAPE\f[] removes all filters and jumps back to the top screen. \f[C]ESCAPE\f[] removes all filters and jumps back to the top screen.
Or, it cancels a minibuffer edit or help dialog in progress. Or, it cancels a minibuffer edit or help dialog in progress.
.PP .PP
@ -314,21 +339,21 @@ By default, it shows all accounts and their latest ending balances
if you specify a query on the command line, it shows just the matched if you specify a query on the command line, it shows just the matched
accounts and the balances from matched transactions. accounts and the balances from matched transactions.
.PP .PP
Account names are normally indented to show the hierarchy (tree mode). Account names are shown as a flat list by default.
To see less detail, set a depth limit by pressing a number key, Press \f[C]T\f[] to toggle tree mode.
\f[C]1\f[] to \f[C]9\f[]. In flat mode, account balances are exclusive of subaccounts, except
where subaccounts are hidden by a depth limit (see below).
In tree mode, all account balances are inclusive of subaccounts.
.PP
To see less detail, press a number key, \f[C]1\f[] to \f[C]9\f[], to set
a depth limit.
Or use \f[C]\-\f[] to decrease and \f[C]+\f[]/\f[C]=\f[] to increase the
depth limit.
\f[C]0\f[] shows even less detail, collapsing all accounts to a single \f[C]0\f[] shows even less detail, collapsing all accounts to a single
total. total.
\f[C]\-\f[] and \f[C]+\f[] (or \f[C]=\f[]) decrease and increase the
depth limit.
To remove the depth limit, set it higher than the maximum account depth, To remove the depth limit, set it higher than the maximum account depth,
or press \f[C]ESCAPE\f[]. or press \f[C]ESCAPE\f[].
.PP .PP
\f[C]F\f[] toggles flat mode, in which accounts are shown as a flat
list, with their full names.
In this mode, account balances exclude subaccounts, except for accounts
at the depth limit (as with hledger's balance command).
.PP
\f[C]H\f[] toggles between showing historical balances or period \f[C]H\f[] toggles between showing historical balances or period
balances. balances.
Historical balances (the default) are ending balances at the end of the Historical balances (the default) are ending balances at the end of the
@ -380,14 +405,16 @@ If the historical total is not disturbed by a filter query, it will be
the running historical balance you would see on a bank register for the the running historical balance you would see on a bank register for the
current account. current account.
.PP .PP
If the accounts screen was in tree mode, the register screen will Transactions affecting this account's subaccounts will be included in
include transactions from both the current account and its subaccounts. the register if the accounts screen is in tree mode, or if it's in flat
If the accounts screen was in flat mode, and a non\-depth\-clipped mode but this account has subaccounts which are not shown due to a depth
account was selected, the register screen will exclude transactions from limit.
subaccounts. In other words, the register always shows the transactions contributing
In other words, the register always shows the transactions responsible to the balance shown on the accounts screen.
for the period balance shown on the accounts screen. .PD 0
As on the accounts screen, this can be toggled with \f[C]F\f[]. .P
.PD
Tree mode/flat mode can be toggled with \f[C]T\f[] here also.
.PP .PP
\f[C]U\f[] toggles filtering by unmarked status, showing or hiding \f[C]U\f[] toggles filtering by unmarked status, showing or hiding
unmarked transactions. unmarked transactions.

82
hledger-ui/hledger-ui.info
View File

@ -12,6 +12,11 @@ limited data entry capability. It is easier than hledger's command-line
interface, and sometimes quicker and more convenient than the web interface, and sometimes quicker and more convenient than the web
interface. interface.
Note hledger-ui has some different defaults: - it generates
rule-based transactions and postings by default (-forecast and -auto are
always on). - it hides transactions dated in the future by default
(change this with -future or the F key). Experimental.
Like hledger, it reads data from one or more files in hledger Like hledger, it reads data from one or more files in hledger
journal, timeclock, timedot, or CSV format specified with '-f', or journal, timeclock, timedot, or CSV format specified with '-f', or
'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps '$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps
@ -48,9 +53,15 @@ the data.
show period balances (changes) at startup instead of historical show period balances (changes) at startup instead of historical
balances balances
'--flat' '-F --flat'
show full account names, unindented show accounts as a list (default)
'-T --tree'
show accounts as a tree
'--future'
show transactions dated later than today (normally hidden)
hledger input options: hledger input options:
@ -201,6 +212,12 @@ some common filters like account depth and transaction status (see
below). 'BACKSPACE' or 'DELETE' removes all filters, showing all below). 'BACKSPACE' or 'DELETE' removes all filters, showing all
transactions. transactions.
As mentioned above, hledger-ui shows auto-generated periodic
transactions, and hides future transactions (auto-generated or not) by
default. 'F' toggles showing and hiding these future transactions.
This is similar to using a query like 'date:-tomorrow', but more
convenient. (experimental)
'ESCAPE' removes all filters and jumps back to the top screen. Or, 'ESCAPE' removes all filters and jumps back to the top screen. Or,
it cancels a minibuffer edit or help dialog in progress. it cancels a minibuffer edit or help dialog in progress.
@ -257,17 +274,17 @@ all accounts and their latest ending balances (including the balances of
subaccounts). if you specify a query on the command line, it shows just subaccounts). if you specify a query on the command line, it shows just
the matched accounts and the balances from matched transactions. the matched accounts and the balances from matched transactions.
Account names are normally indented to show the hierarchy (tree Account names are shown as a flat list by default. Press 'T' to
mode). To see less detail, set a depth limit by pressing a number key, toggle tree mode. In flat mode, account balances are exclusive of
'1' to '9'. '0' shows even less detail, collapsing all accounts to a subaccounts, except where subaccounts are hidden by a depth limit (see
single total. '-' and '+' (or '=') decrease and increase the depth below). In tree mode, all account balances are inclusive of
limit. To remove the depth limit, set it higher than the maximum subaccounts.
account depth, or press 'ESCAPE'.
'F' toggles flat mode, in which accounts are shown as a flat list, To see less detail, press a number key, '1' to '9', to set a depth
with their full names. In this mode, account balances exclude limit. Or use '-' to decrease and '+'/'=' to increase the depth limit.
subaccounts, except for accounts at the depth limit (as with hledger's '0' shows even less detail, collapsing all accounts to a single total.
balance command). To remove the depth limit, set it higher than the maximum account depth,
or press 'ESCAPE'.
'H' toggles between showing historical balances or period balances. 'H' toggles between showing historical balances or period balances.
Historical balances (the default) are ending balances at the end of the Historical balances (the default) are ending balances at the end of the
@ -318,13 +335,12 @@ a check register. Each line represents one transaction and shows:
not disturbed by a filter query, it will be the running historical not disturbed by a filter query, it will be the running historical
balance you would see on a bank register for the current account. balance you would see on a bank register for the current account.
If the accounts screen was in tree mode, the register screen will Transactions affecting this account's subaccounts will be included in
include transactions from both the current account and its subaccounts. the register if the accounts screen is in tree mode, or if it's in flat
If the accounts screen was in flat mode, and a non-depth-clipped account mode but this account has subaccounts which are not shown due to a depth
was selected, the register screen will exclude transactions from limit. In other words, the register always shows the transactions
subaccounts. In other words, the register always shows the transactions contributing to the balance shown on the accounts screen.
responsible for the period balance shown on the accounts screen. As on Tree mode/flat mode can be toggled with 'T' here also.
the accounts screen, this can be toggled with 'F'.
'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' transactions. Similarly, 'P' toggles pending transactions, and 'C'
@ -380,19 +396,19 @@ to cancel the reload attempt.)
 
Tag Table: Tag Table:
Node: Top71 Node: Top71
Node: OPTIONS829 Node: OPTIONS1090
Ref: #options926 Ref: #options1187
Node: KEYS4226 Node: KEYS4606
Ref: #keys4321 Ref: #keys4701
Node: SCREENS7280 Node: SCREENS7957
Ref: #screens7365 Ref: #screens8042
Node: Accounts screen7455 Node: Accounts screen8132
Ref: #accounts-screen7583 Ref: #accounts-screen8260
Node: Register screen9813 Node: Register screen10476
Ref: #register-screen9968 Ref: #register-screen10631
Node: Transaction screen12042 Node: Transaction screen12628
Ref: #transaction-screen12200 Ref: #transaction-screen12786
Node: Error screen13070 Node: Error screen13656
Ref: #error-screen13192 Ref: #error-screen13778
 
End Tag Table End Tag Table

4
hledger-ui/hledger-ui.m4.md
View File

@ -130,12 +130,12 @@ press `ENTER` to set it, or `ESCAPE`to cancel.
There are also keys for quickly adjusting some common filters like account depth and transaction status (see below). There are also keys for quickly adjusting some 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, hledger-ui hides transactions in the future by default. As mentioned above, hledger-ui shows auto-generated periodic transactions,
and hides future transactions (auto-generated or not) by default.
`F` toggles showing and hiding these future transactions. `F` toggles showing and hiding these future transactions.
This is similar to using a query like `date:-tomorrow`, but more convenient. This is similar to using a query like `date:-tomorrow`, but more convenient.
(experimental) (experimental)
`ESCAPE` removes all filters and jumps back to the top screen. `ESCAPE` removes all filters and jumps back to the top screen.
Or, it cancels a minibuffer edit or help dialog in progress. Or, it cancels a minibuffer edit or help dialog in progress.

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

@ -22,17 +22,22 @@ DESCRIPTION
mand-line interface, and sometimes quicker and more convenient than the mand-line interface, and sometimes quicker and more convenient than the
web interface. web interface.
Like hledger, it reads data from one or more files in hledger journal, Note hledger-ui has some different defaults: - it generates rule-based
timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE, transactions and postings by default (-forecast and -auto are always
or $HOME/.hledger.journal (on windows, perhaps on). - it hides transactions dated in the future by default (change
C:/Users/USER/.hledger.journal). For more about this see hledger(1), this with -future or the F key). Experimental.
Like hledger, it reads data from one or more files in hledger journal,
timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE,
or $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). For more about this see hledger(1),
hledger_journal(5) etc. hledger_journal(5) etc.
OPTIONS OPTIONS
Note: if invoking hledger-ui as a hledger subcommand, write -- before Note: if invoking hledger-ui as a hledger subcommand, write -- before
options as shown above. options as shown above.
Any QUERYARGS are interpreted as a hledger search query which filters Any QUERYARGS are interpreted as a hledger search query which filters
the data. the data.
--watch --watch
@ -45,10 +50,17 @@ OPTIONS
start in the (first) matched account's register screen start in the (first) matched account's register screen
--change --change
show period balances (changes) at startup instead of historical show period balances (changes) at startup instead of historical
balances balances
--flat show full account names, unindented -F --flat
show accounts as a list (default)
-T --tree
show accounts as a tree
--future
show transactions dated later than today (normally hidden)
hledger input options: hledger input options:
@ -57,7 +69,7 @@ OPTIONS
$LEDGER_FILE or $HOME/.hledger.journal) $LEDGER_FILE or $HOME/.hledger.journal)
--rules-file=RULESFILE --rules-file=RULESFILE
Conversion rules file to use when reading CSV (default: Conversion rules file to use when reading CSV (default:
FILE.rules) FILE.rules)
--separator=CHAR --separator=CHAR
@ -98,11 +110,11 @@ OPTIONS
multiperiod/multicolumn report by year multiperiod/multicolumn report by year
-p --period=PERIODEXP -p --period=PERIODEXP
set start date, end date, and/or reporting interval all at once set start date, end date, and/or reporting interval all at once
using period expressions syntax (overrides the flags above) using period expressions syntax (overrides the flags above)
--date2 --date2
match the secondary date instead (see command help for other match the secondary date instead (see command help for other
effects) effects)
-U --unmarked -U --unmarked
@ -121,21 +133,21 @@ OPTIONS
hide/aggregate accounts or postings more than NUM levels deep hide/aggregate accounts or postings more than NUM levels deep
-E --empty -E --empty
show items with zero amount, normally hidden (and vice-versa in show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web) hledger-ui/hledger-web)
-B --cost -B --cost
convert amounts to their cost at transaction time (using the convert amounts to their cost at transaction time (using the
transaction price, if any) transaction price, if any)
-V --value -V --value
convert amounts to their market value on the report end date convert amounts to their market value on the report end date
(using the most recent applicable market price, if any) (using the most recent applicable market price, if any)
--auto apply automated posting rules to modify transactions. --auto apply automated posting rules to modify transactions.
--forecast --forecast
apply periodic transaction rules to generate future transac- apply periodic transaction rules to generate future transac-
tions, to 6 months from now or report end date. tions, to 6 months from now or report end date.
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
@ -155,64 +167,70 @@ OPTIONS
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which should A @FILE argument will be expanded to the contents of FILE, which should
contain one command line option/argument per line. (To prevent this, contain one command line option/argument per line. (To prevent this,
insert a -- argument before.) insert a -- argument before.)
KEYS KEYS
? 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) to close it. The following keys work on most screens: or LEFT) to close it. The following keys work on most screens:
The cursor keys navigate: right (or enter) goes deeper, left returns to The cursor keys navigate: right (or enter) goes deeper, left returns to
the previous screen, up/down/page up/page down/home/end move up and the previous screen, up/down/page up/page down/home/end move up and
down through lists. Vi-style (h/j/k/l) and Emacs-style down through lists. Vi-style (h/j/k/l) and Emacs-style
(CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also supported. A tip: (CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also supported. 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). the transactions to be shown (by default, all are shown).
shift-down/up steps downward and upward through these standard report shift-down/up steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then, period durations: year, quarter, month, week, day. Then,
shift-left/right moves to the previous/next period. t sets the report shift-left/right moves to the previous/next period. t sets the report
period to today. With the --watch option, when viewing a "current" period to today. With the --watch option, when viewing a "current"
period (the current day, week, month, quarter, or year), the period period (the current day, week, month, quarter, or year), the period
will move automatically to track the current date. To set a non-stan- will move automatically to track the current date. To set a non-stan-
dard period, you can use / and a date: query. dard period, you can use / 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.
ESCAPE removes all filters and jumps back to the top screen. Or, it As mentioned above, hledger-ui shows auto-generated periodic transac-
tions, and hides future transactions (auto-generated or not) by
default. F toggles showing and hiding these future transactions. This
is similar to using a query like date:-tomorrow, but more convenient.
(experimental)
ESCAPE removes all filters and jumps back to the top screen. Or, it
cancels a minibuffer edit or help dialog in progress. cancels a minibuffer edit or help dialog in progress.
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 A is like a, but runs the hledger-iadd tool, which provides a
curses-style interface. This key will be available if hledger-iadd is curses-style interface. This key will be available if hledger-iadd is
installed in $PATH. installed in $PATH.
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emac- E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emac-
sclient -a "" -nw) on the journal file. With some editors (emacs, vi), sclient -a "" -nw) on the journal file. With some editors (emacs, vi),
the cursor will be positioned at the current transaction when invoked the cursor will be positioned at the current transaction when invoked
from the register and transaction screens, and at the error location from the register and transaction screens, and at the error location
(if possible) when invoked from the error screen. (if possible) when invoked from the error screen.
q quits the application. q quits the application.
@ -221,44 +239,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 normally indented to show the hierarchy (tree mode). Account names are shown as a flat list by default. Press T to toggle
To see less detail, set a depth limit by pressing a number key, 1 to 9. tree mode. In flat mode, account balances are exclusive of subac-
0 shows even less detail, collapsing all accounts to a single total. - counts, except where subaccounts are hidden by a depth limit (see
and + (or =) decrease and increase the depth limit. To remove the below). In tree mode, all account balances are inclusive of subac-
counts.
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
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.
F toggles flat mode, in which accounts are shown as a flat list, with
their full names. In this mode, account balances exclude subaccounts,
except for accounts at the depth limit (as with hledger's balance com-
mand).
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 or enter to view an account's transactions register. Press right or enter to view an account's transactions register.
@ -267,65 +285,64 @@ 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.
If the accounts screen was in tree mode, the register screen will Transactions affecting this account's subaccounts will be included in
include transactions from both the current account and its subaccounts. the register if the accounts screen is in tree mode, or if it's in flat
If the accounts screen was in flat mode, and a non-depth-clipped mode but this account has subaccounts which are not shown due to a
account was selected, the register screen will exclude transactions depth limit. In other words, the register always shows the transac-
from subaccounts. In other words, the register always shows the trans- tions contributing to the balance shown on the accounts screen.
actions responsible for the period balance shown on the accounts Tree mode/flat mode can be toggled with T here also.
screen. As on the accounts screen, this can be toggled with F.
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 tions are shown; and if you activate all three, the filter is
removed.)q removed.)q
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 (or enter) to view the selected transaction in detail. Press right (or enter) 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.)
@ -333,17 +350,17 @@ 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).
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).
@ -351,13 +368,13 @@ 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.
@ -365,7 +382,7 @@ BUGS
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)
@ -379,7 +396,7 @@ COPYRIGHT
SEE ALSO SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
dot(5), ledger(1) dot(5), ledger(1)