summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CHANGES.md8
-rw-r--r--Hledger/UI/RegisterScreen.hs15
-rw-r--r--hledger-ui.12
-rw-r--r--hledger-ui.cabal10
-rw-r--r--hledger-ui.info400
-rw-r--r--hledger-ui.txt185
6 files changed, 319 insertions, 301 deletions
diff --git a/CHANGES.md b/CHANGES.md
index 6be3460..a9cee9b 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,6 +1,14 @@
User-visible changes in hledger-ui.
See also the hledger changelog.
+# 1.20.4 2021-01-29
+
+- ui: register: show all txns in/under an account at the depth limit (#1468).
+ In 1.20-1.20.3, the register screen had stopped showing transactions
+ in accounts below a depth limit. Now it properly shows all subaccount transactions,
+ even when there is a depth limit, ensuring that the register's final total
+ matches the balance shown on the account screen.
+
# 1.20.3 2021-01-14
- Use hledger 1.20.3.
diff --git a/Hledger/UI/RegisterScreen.hs b/Hledger/UI/RegisterScreen.hs
index bd1df92..717862f 100644
--- a/Hledger/UI/RegisterScreen.hs
+++ b/Hledger/UI/RegisterScreen.hs
@@ -66,10 +66,19 @@ rsInit d reset ui@UIState{aopts=_uopts@UIOpts{cliopts_=CliOpts{reportspec_=rspec
-- XXX temp
inclusive = tree_ ropts || rsForceInclusive
thisacctq = Acct $ (if inclusive then accountNameToAccountRegex else accountNameToAccountOnlyRegex) rsAccount
-
- rspec' = rspec{rsOpts=ropts{depth_=Nothing}}
+ ropts' = ropts {
+ -- ignore any depth limit, as in postingsReport; allows register's total to match accounts screen
+ depth_=Nothing
+ -- XXX aregister also has this, needed ?
+ -- always show historical balance
+ -- , balancetype_= HistoricalBalance
+ }
+ -- regenerate the ReportSpec, making sure to use the above
+ rspec' = rspec{ rsQuery=simplifyQuery $ queryFromFlags ropts'
+ , rsOpts=ropts'
+ }
-- Further restrict the query based on the current period and future/forecast mode.
- q = simplifyQuery $ And [rsQuery rspec, periodq, excludeforecastq (forecast_ ropts)]
+ q = simplifyQuery $ And [rsQuery rspec', periodq, excludeforecastq (forecast_ ropts)]
where
periodq = Date $ periodAsDateSpan $ period_ ropts
-- Except in forecast mode, exclude future/forecast transactions.
diff --git a/hledger-ui.1 b/hledger-ui.1
index 75b732f..396e1c7 100644
--- a/hledger-ui.1
+++ b/hledger-ui.1
@@ -1,5 +1,5 @@
-.TH "HLEDGER-UI" "1" "December 2020" "hledger-ui-1.20.3 " "hledger User Manuals"
+.TH "HLEDGER-UI" "1" "December 2020" "hledger-ui-1.20.4 " "hledger User Manuals"
diff --git a/hledger-ui.cabal b/hledger-ui.cabal
index 8ca2ad4..086ce6e 100644
--- a/hledger-ui.cabal
+++ b/hledger-ui.cabal
@@ -4,10 +4,10 @@ cabal-version: 1.12
--
-- see: https://github.com/sol/hpack
--
--- hash: 59a466ffc3d5fadaf96e035598f27a0915433341b2711c32aecb77ccb9dcf061
+-- hash: e38b4cf2e33e7075fb10addabdfa2af47686be042e965677b9dd26abcfbac53c
name: hledger-ui
-version: 1.20.3
+version: 1.20.4
synopsis: Curses-style terminal interface for the hledger accounting system
description: A simple curses-style terminal user interface for the hledger accounting system.
It can be a more convenient way to browse your accounts than the CLI.
@@ -64,7 +64,7 @@ executable hledger-ui
hs-source-dirs:
./.
ghc-options: -Wall -fno-warn-unused-do-bind -fno-warn-name-shadowing -fno-warn-missing-signatures -fno-warn-type-defaults -fno-warn-orphans
- cpp-options: -DVERSION="1.20.3"
+ cpp-options: -DVERSION="1.20.4"
build-depends:
ansi-terminal >=0.9
, async
@@ -78,8 +78,8 @@ executable hledger-ui
, extra >=1.6.3
, filepath
, fsnotify >=0.2.1.2 && <0.4
- , hledger >=1.20.3 && <1.21
- , hledger-lib >=1.20.3 && <1.21
+ , hledger >=1.20.4 && <1.21
+ , hledger-lib >=1.20.4 && <1.21
, megaparsec >=7.0.0 && <9.1
, microlens >=0.4
, microlens-platform >=0.2.3.1
diff --git a/hledger-ui.info b/hledger-ui.info
index 40663b9..e9ed098 100644
--- a/hledger-ui.info
+++ b/hledger-ui.info
@@ -1,35 +1,36 @@
-This is hledger-ui.info, produced by makeinfo version 6.7 from stdin.
+This is hledger-ui/hledger-ui.info, produced by makeinfo version 4.8
+from stdin.

-File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir)
+File: hledger-ui.info, Node: Top, Up: (dir)
hledger-ui(1)
*************
A terminal interface (TUI) for the hledger accounting tool.
- 'hledger-ui [OPTIONS] [QUERYARGS]'
-'hledger ui -- [OPTIONS] [QUERYARGS]'
+ `hledger-ui [OPTIONS] [QUERYARGS]'
+`hledger ui -- [OPTIONS] [QUERYARGS]'
hledger is a reliable, cross-platform set of programs for tracking
money, time, or any other commodity, using double-entry accounting and a
-simple, editable file format. hledger is inspired by and largely
+simple, editable file format. hledger is inspired by and largely
compatible with ledger(1).
hledger-ui is hledger's terminal interface, providing an efficient
full-window text UI for viewing accounts and transactions, and some
-limited data entry capability. It is easier than hledger's command-line
+limited data entry capability. It is easier than hledger's command-line
interface, and sometimes quicker and more convenient than the web
interface.
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),
+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.
Unlike hledger, hledger-ui hides all future-dated transactions by
-default. They can be revealed, along with any rule-generated periodic
+default. They can be revealed, along with any rule-generated periodic
transactions, by pressing the F key (or starting with -forecast) to
enable "forecast mode".
@@ -48,143 +49,140 @@ File: hledger-ui.info, Node: OPTIONS, Next: KEYS, Prev: Top, Up: Top
1 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.
Any QUERYARGS are interpreted as a hledger search query which filters
the data.
-'--watch'
-
+`--watch'
watch for data and date changes and reload automatically
-'--theme=default|terminal|greenterm'
+`--theme=default|terminal|greenterm'
use this custom display theme
-'--register=ACCTREGEX'
+`--register=ACCTREGEX'
start in the (first) matched account's register screen
-'--change'
+`--change'
show period balances (changes) at startup instead of historical
balances
-'-l --flat'
+`-l --flat'
show accounts as a flat list (default)
-'-t --tree'
+`-t --tree'
show accounts as a tree
hledger input options:
-'-f FILE --file=FILE'
-
- use a different input file. For stdin, use - (default:
- '$LEDGER_FILE' or '$HOME/.hledger.journal')
-'--rules-file=RULESFILE'
+`-f FILE --file=FILE'
+ use a different input file. For stdin, use - (default:
+ `$LEDGER_FILE' or `$HOME/.hledger.journal')
+`--rules-file=RULESFILE'
Conversion rules file to use when reading CSV (default: FILE.rules)
-'--separator=CHAR'
+`--separator=CHAR'
Field separator to expect when reading CSV (default: ',')
-'--alias=OLD=NEW'
+`--alias=OLD=NEW'
rename accounts named OLD to NEW
-'--anon'
+`--anon'
anonymize accounts and payees
-'--pivot FIELDNAME'
+`--pivot FIELDNAME'
use some other field or tag for the account name
-'-I --ignore-assertions'
+`-I --ignore-assertions'
disable balance assertion checks (note: does not disable balance
assignments)
-'-s --strict'
+`-s --strict'
do extra error checking (check that all posted accounts are
declared)
hledger reporting options:
-'-b --begin=DATE'
-
+`-b --begin=DATE'
include postings/txns on or after this date
-'-e --end=DATE'
+`-e --end=DATE'
include postings/txns before this date
-'-D --daily'
+`-D --daily'
multiperiod/multicolumn report by day
-'-W --weekly'
+`-W --weekly'
multiperiod/multicolumn report by week
-'-M --monthly'
+`-M --monthly'
multiperiod/multicolumn report by month
-'-Q --quarterly'
+`-Q --quarterly'
multiperiod/multicolumn report by quarter
-'-Y --yearly'
+`-Y --yearly'
multiperiod/multicolumn report by year
-'-p --period=PERIODEXP'
+`-p --period=PERIODEXP'
set start date, end date, and/or reporting interval all at once
using period expressions syntax
-'--date2'
+`--date2'
match the secondary date instead (see command help for other
effects)
-'-U --unmarked'
+`-U --unmarked'
include only unmarked postings/txns (can combine with -P or -C)
-'-P --pending'
+`-P --pending'
include only pending postings/txns
-'-C --cleared'
+`-C --cleared'
include only cleared postings/txns
-'-R --real'
+`-R --real'
include only non-virtual postings
-'-NUM --depth=NUM'
+`-NUM --depth=NUM'
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
hledger-ui/hledger-web)
-'-B --cost'
+`-B --cost'
convert amounts to their cost/selling amount at transaction time
-'-V --market'
+`-V --market'
convert amounts to their market value in default valuation
commodities
-'-X --exchange=COMM'
+`-X --exchange=COMM'
convert amounts to their market value in commodity COMM
-'--value'
+`--value'
convert amounts to cost or market value, more flexibly than
-B/-V/-X
-'--infer-value'
+`--infer-value'
with -V/-X/-value, also infer market prices from transactions
-'--auto'
+`--auto'
apply automated posting rules to modify transactions.
-'--forecast'
+`--forecast'
generate future transactions from periodic transaction rules, for
- the next 6 months or till report end date. In hledger-ui, also
+ the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
-'--color=WHEN (or --colour=WHEN)'
+`--color=WHEN (or --colour=WHEN)'
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a
color-supporting terminal. 'always' or 'yes': always, useful eg
- when piping output into 'less -R'. 'never' or 'no': never. A
+ when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line,
@@ -194,19 +192,18 @@ the last one takes precedence.
hledger help options:
-'-h --help'
-
+`-h --help'
show general usage (or after COMMAND, command usage)
-'--version'
+`--version'
show version
-'--debug[=N]'
+`--debug[=N]'
show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which
-should contain one command line option/argument per line. (To prevent
-this, insert a '--' argument before.)
+should contain one command line option/argument per line. (To prevent
+this, insert a `--' argument before.)

File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
@@ -214,94 +211,94 @@ File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
2 KEYS
******
-'?' 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', or 'LEFT', or 'q') to close it. The following keys work on
+`?' 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', or `LEFT', or `q') to close it. The following keys work on
most screens:
- 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 down through lists. Emacs-style
-('ctrl-p'/'ctrl-n'/'ctrl-f'/'ctrl-b') movement keys are also supported
+ 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 down through lists. Emacs-style
+(`ctrl-p'/`ctrl-n'/`ctrl-f'/`ctrl-b') movement keys are also supported
(but not vi-style keys, since hledger-1.19, sorry!). A tip: 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 one way to
+want to adjust it. (If you're on a mac, the karabiner app is one way to
do that.)
With shift pressed, the cursor keys adjust the report period,
limiting the transactions to be shown (by default, all are shown).
-'shift-down/up' steps downward and upward through these standard report
-period durations: year, quarter, month, week, day. Then,
-'shift-left/right' moves to the previous/next period. 'T' sets the
-report period to today. With the '--watch' option, when viewing a
+`shift-down/up' steps downward and upward through these standard report
+period durations: year, quarter, month, week, day. Then,
+`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 (the current 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 '/' and a 'date:' query.
+period will move automatically to track the current date. To set a
+non-standard period, you can use `/' and a `date:' query.
- '/' 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 query, you can use CTRL-a/e/d/k, BS, cursor keys; press 'ENTER' to
-set it, or 'ESCAPE'to cancel. There are also keys for quickly adjusting
+ `/' 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 query, you can use CTRL-a/e/d/k, BS, cursor keys; 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). 'BACKSPACE' or 'DELETE' removes all filters, showing all
+below). `BACKSPACE' or `DELETE' removes all filters, showing all
transactions.
As mentioned above, by default hledger-ui hides future transactions -
both ordinary transactions recorded in the journal, and periodic
-transactions generated by rule. 'F' toggles forecast mode, in which
+transactions generated by rule. `F' toggles forecast mode, in which
future/forecasted transactions are shown.
- 'ESCAPE' resets the UI state and jumps back to the top screen,
-restoring the app's initial state at startup. Or, it cancels minibuffer
+ `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 entry or the help dialog.
- 'CTRL-l' redraws the screen and centers the selection if possible
+ `CTRL-l' redraws the screen and centers the selection if possible
(selections near the top won't be centered, since we don't scroll above
the top).
- 'g' reloads from the data file(s) and updates the current screen and
-any previous screens. (With large files, this could cause a noticeable
+ `g' reloads from the data file(s) and updates the current screen and
+any previous screens. (With large files, this could cause a noticeable
pause.)
- 'I' toggles balance assertion checking. Disabling balance assertions
+ `I' toggles balance assertion checking. Disabling balance assertions
temporarily can be useful for troubleshooting.
- 'a' runs command-line hledger's add command, and reloads the updated
-file. This allows some basic data entry.
+ `a' runs command-line hledger's add command, and reloads the updated
+file. This allows some basic data entry.
- 'A' is like 'a', but runs the hledger-iadd tool, which provides a
-terminal interface. This key will be available if 'hledger-iadd' is
+ `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 $path.
- 'E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default ('emacsclient
--a "" -nw') on the journal file. With some editors (emacs, vi), the
+ `E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (`emacsclient
+-a "" -nw') on the journal file. With some editors (emacs, vi), the
cursor will be positioned at the current transaction when invoked from
the register and transaction screens, and at the error location (if
possible) when invoked from the error screen.
- 'B' toggles cost mode, showing amounts in their transaction price's
-commodity (like toggling the '-B/--cost' flag).
+ `B' toggles cost mode, showing amounts in their transaction price's
+commodity (like toggling the `-B/--cost' flag).
- 'V' toggles value mode, showing amounts' current market value in
-their default valuation commodity (like toggling the '-V/--market'
-flag). 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 temporarily set that as the report end date. Eg: to see a
+ `V' toggles value mode, showing amounts' current market value in
+their default valuation commodity (like toggling the `-V/--market'
+flag). 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 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, press '/', and add 'date:-7/30' to the query.
+screen, press `/', and add `date:-7/30' to the query.
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; for now pressing 'b' 'b' 'v' should reliably reset to normal
+active; for now pressing `b' `b' `v' should reliably reset to normal
mode.
- With '--watch' active, if you save an edit to the journal file while
-viewing the transaction screen in cost or value mode, the 'B'/'V' keys
-will stop working. To work around, press 'g' to force a manual reload,
+ With `--watch' active, if you save an edit to the journal file while
+viewing the transaction screen in cost or value mode, the `B'/`V' keys
+will stop working. To work around, press `g' to force a manual reload,
or exit the transaction screen.
- 'q' quits the application.
+ `q' quits the application.
Additional screen-specific keys are described below.
@@ -324,48 +321,47 @@ File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Up: SCRE
3.1 Accounts screen
===================
-This is normally the first screen displayed. It lists accounts and
-their balances, like hledger's balance command. By default, it shows
-all accounts and their latest ending balances (including the balances of
-subaccounts). If you specify a query on the command line, it shows just
+This is normally the first screen displayed. It lists accounts and their
+balances, like hledger's balance command. By default, it shows all
+accounts and their latest ending balances (including the balances of
+subaccounts). If you specify a query on the command line, it shows just
the matched accounts and the balances from matched transactions.
- Account names are shown as a flat list by default; press 't' to
-toggle tree mode. In list mode, account balances are exclusive of
+ Account names are shown as a flat list by default; press `t' to
+toggle tree mode. In list 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.
+below). In tree mode, all account balances are inclusive of subaccounts.
- 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 'ESCAPE'.
+ 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 `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
report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before the
-start of the report period. In other words, historical balances are
-what you would see on a bank statement for that account (unless
-disturbed by a filter query). Period balances ignore transactions
-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.
-
- 'U' toggles filtering by unmarked status, including or excluding
-unmarked postings in the balances. Similarly, 'P' toggles pending
-postings, and 'C' toggles cleared postings. (By default, balances
+start of the report period. In other words, historical balances are what
+you would see on a bank statement for that account (unless disturbed by
+a filter query). Period balances ignore transactions 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.
+
+ `U' toggles filtering by unmarked status, including or excluding
+unmarked postings in the balances. Similarly, `P' toggles pending
+postings, and `C' toggles cleared postings. (By default, balances
include all postings; if you activate one or two status filters, only
those postings are 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
+ `Z' toggles nonzero mode, in which only accounts with nonzero
balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger).
- Press 'right' or 'enter' to view an account's transactions register.
+ Press `right' or `enter' to view an account's transactions register.

File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Accounts screen, Up: SCREENS
@@ -374,44 +370,46 @@ File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev:
===================
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:
- * the other account(s) involved, in abbreviated form. (If there are
- both real and virtual postings, it shows only the accounts affected
- by real postings.)
+ * the other account(s) involved, in abbreviated form. (If there are
+ both real and virtual postings, it shows only the accounts
+ affected by real postings.)
* the overall change to the current account's balance; positive for
an inflow to this account, negative for an outflow.
* the running historical total or period total for the current
- account, after the transaction. This can be toggled with 'H'.
- Similar to the accounts screen, the historical total is affected by
- transactions (filtered by the filter query) before the report start
- date, while 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 see on a bank register for the current account.
+ account, after the transaction. This can be toggled with `H'.
+ Similar to the accounts screen, the historical total is affected
+ by transactions (filtered by the filter query) before the report
+ start date, while 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 see on a bank register for the
+ current account.
+
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
mode but this account has subaccounts which are not shown due to a depth
-limit. In other words, the register always shows the transactions
-contributing to the balance shown on the accounts screen. Tree
-mode/list mode can be toggled with 't' here also.
+limit. In other words, the register always shows the transactions
+contributing to the balance shown on the accounts screen. Tree mode/list
+mode can be toggled with `t' here also.
- 'U' toggles filtering by unmarked status, showing or hiding unmarked
-transactions. Similarly, 'P' toggles pending transactions, and 'C'
-toggles cleared transactions. (By default, transactions with all
+ `U' toggles filtering by unmarked status, showing or hiding unmarked
+transactions. Similarly, `P' toggles pending transactions, and `C'
+toggles cleared transactions. (By default, transactions with all
statuses are shown; if you activate one or two status filters, only
those transactions 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
+ `Z' toggles nonzero mode, in which only transactions posting a
nonzero change are shown (hledger-ui shows zero items by default, unlike
command-line hledger).
- Press 'right' (or 'enter') to view the selected transaction in
+ Press `right' (or `enter') to view the selected transaction in
detail.

@@ -429,11 +427,11 @@ description, comments, along with all of its account postings are shown.
Simple transactions have two postings, but there can be more (or in
certain cases, fewer).
- 'up' and 'down' will step through all transactions listed in the
-previous account register screen. In the title bar, the numbers in
-parentheses show your position within that account register. They will
+ `up' and `down' will step through all transactions listed in the
+previous account register screen. In the title bar, the numbers in
+parentheses show your position within that account register. They will
vary depending on which account register you came from (remember most
-transactions appear in multiple account registers). The #N number
+transactions appear in multiple account registers). The #N number
preceding them is the transaction's position within the complete
unfiltered journal, which is a more stable id (at least until the next
reload).
@@ -445,8 +443,8 @@ File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCRE
================
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
-again to reload and resume normal operation. (Or, you can press escape
+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
to cancel the reload attempt.)

@@ -455,27 +453,28 @@ File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: SCREENS, Up: To
4 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: '~/.hledger.journal' (on windows, perhaps
-'C:/Users/USER/.hledger.journal').
+ *LEDGER_FILE* The journal file path when not specified with `-f'.
+Default: `~/.hledger.journal' (on windows, perhaps
+`C:/Users/USER/.hledger.journal').
- A typical value is '~/DIR/YYYY.journal', where DIR is a
-version-controlled finance directory and YYYY is the current year. Or
-'~/DIR/current.journal', where current.journal is a symbolic link to
+ A typical value is `~/DIR/YYYY.journal', where DIR is a
+version-controlled finance directory and YYYY is the current year. Or
+`~/DIR/current.journal', where current.journal is a symbolic link to
YYYY.journal.
- On Mac computers, you can set this and other environment variables in
-a more thorough way that also affects applications started from the GUI
-(say, an Emacs dock icon). Eg on MacOS Catalina I have a
-'~/.MacOSX/environment.plist' file containing
+ On Mac computers, you can set this and other environment variables
+in a more thorough way that also affects applications started from the
+GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a
+`~/.MacOSX/environment.plist' file containing
+
{
"LEDGER_FILE" : "~/finance/current.journal"
}
- To see the effect you may need to 'killall Dock', or reboot.
+ To see the effect you may need to `killall Dock', or reboot.

File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
@@ -484,9 +483,9 @@ File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
*******
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').
+timedot, or CSV format specified with `-f', or `$LEDGER_FILE', or
+`$HOME/.hledger.journal' (on windows, perhaps
+`C:/Users/USER/.hledger.journal').

File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
@@ -494,18 +493,18 @@ File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
6 BUGS
******
-The need to precede options with '--' when invoked from hledger is
+The need to precede options with `--' when invoked from hledger is
awkward.
- '-f-' doesn't work (hledger-ui can't read from stdin).
+ `-f-' doesn't work (hledger-ui can't read from stdin).
- '-V' affects only the accounts screen.
+ `-V' affects only the accounts screen.
- When you press 'g', the current and all previous screens are
-regenerated, which may cause a noticeable pause with large files. Also
+ 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 visual indication that this is in progress.
- '--watch' is not yet fully robust. It works well for normal usage,
+ `--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
times with an editor macro) can cause problems at least on OSX. Symptoms
include: unresponsive UI, periodic resetting of the cursor position,
@@ -514,30 +513,31 @@ and possibly a small but persistent build-up of CPU usage until the
program is restarted.
Also, if you are viewing files mounted from another machine,
-'--watch' requires that both machine clocks are roughly in step.
+`--watch' requires that both machine clocks are roughly in step.
+

Tag Table:
-Node: Top71
-Node: OPTIONS1434
-Ref: #options1531
-Node: KEYS5598
-Ref: #keys5693
-Node: SCREENS10012
-Ref: #screens10117
-Node: Accounts screen10207
-Ref: #accounts-screen10335
-Node: Register screen12550
-Ref: #register-screen12705
-Node: Transaction screen14702
-Ref: #transaction-screen14860
-Node: Error screen15730
-Ref: #error-screen15852
-Node: ENVIRONMENT16096
-Ref: #environment16210
-Node: FILES17017
-Ref: #files17116
-Node: BUGS17329
-Ref: #bugs17406
+Node: Top82
+Node: OPTIONS1425
+Ref: #options1522
+Node: KEYS5583
+Ref: #keys5678
+Node: SCREENS9974
+Ref: #screens10079
+Node: Accounts screen10169
+Ref: #accounts-screen10297
+Node: Register screen12501
+Ref: #register-screen12656
+Node: Transaction screen14651
+Ref: #transaction-screen14809
+Node: Error screen15676
+Ref: #error-screen15798
+Node: ENVIRONMENT16040
+Ref: #environment16154
+Node: FILES16959
+Ref: #files17058
+Node: BUGS17271
+Ref: #bugs17348

End Tag Table
diff --git a/hledger-ui.txt b/hledger-ui.txt
index 458100d..82c5ba3 100644
--- a/hledger-ui.txt
+++ b/hledger-ui.txt
@@ -28,8 +28,8 @@ DESCRIPTION
C:/Users/USER/.hledger.journal). For more about this see hledger(1),
hledger_journal(5) etc.
- Unlike hledger, hledger-ui hides all future-dated transactions by de-
- fault. They can be revealed, along with any rule-generated periodic
+ Unlike hledger, hledger-ui hides all future-dated transactions by
+ default. They can be revealed, along with any rule-generated periodic
transactions, by pressing the F key (or starting with --forecast) to
enable "forecast mode".
@@ -85,8 +85,8 @@ OPTIONS
assignments)
-s --strict
- do extra error checking (check that all posted accounts are de-
- clared)
+ do extra error checking (check that all posted accounts are
+ declared)
hledger reporting options:
@@ -116,8 +116,8 @@ OPTIONS
using period expressions syntax
--date2
- match the secondary date instead (see command help for other ef-
- fects)
+ match the secondary date instead (see command help for other
+ effects)
-U --unmarked
include only unmarked postings/txns (can combine with -P or -C)
@@ -142,14 +142,14 @@ OPTIONS
convert amounts to their cost/selling amount at transaction time
-V --market
- convert amounts to their market value in default valuation com-
+ convert amounts to their market value in default valuation com-
modities
-X --exchange=COMM
convert amounts to their market value in commodity COMM
--value
- convert amounts to cost or market value, more flexibly than
+ convert amounts to cost or market value, more flexibly than
-B/-V/-X
--infer-value
@@ -158,15 +158,15 @@ OPTIONS
--auto apply automated posting rules to modify transactions.
--forecast
- generate future transactions from periodic transaction rules,
- for the next 6 months or till report end date. In hledger-ui,
+ generate future transactions from periodic transaction rules,
+ for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
--color=WHEN (or --colour=WHEN)
- Should color-supporting commands use ANSI color codes in text
- output. 'auto' (default): whenever stdout seems to be a color-
- supporting terminal. 'always' or 'yes': always, useful eg when
- piping output into 'less -R'. 'never' or 'no': never. A
+ Should color-supporting commands use ANSI color codes in text
+ output. 'auto' (default): whenever stdout seems to be a color-
+ supporting terminal. 'always' or 'yes': always, useful eg when
+ piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line, the
@@ -186,91 +186,91 @@ OPTIONS
show debug output (levels 1-9, default: 1)
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.)
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,
or LEFT, or q) to close it. The following keys work on most screens:
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. Emacs-style (ctrl-p/ctrl-n/ctrl-f/ctrl-b) movement
- keys are also supported (but not vi-style keys, since hledger-1.19,
- sorry!). A tip: movement speed is limited by your keyboard repeat
- rate, to move faster you may want to adjust it. (If you're on a mac,
+ keys are also supported (but not vi-style keys, since hledger-1.19,
+ sorry!). A tip: 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 one way to do that.)
- With shift pressed, the cursor keys adjust the report period, limiting
- the transactions to be shown (by default, all are shown). shift-
- down/up steps downward and upward through these standard report period
- durations: year, quarter, month, week, day. Then, 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 (the current
+ With shift pressed, the cursor keys adjust the report period, limiting
+ the transactions to be shown (by default, all are shown). shift-
+ down/up steps downward and upward through these standard report period
+ durations: year, quarter, month, week, day. Then, 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 (the current
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 /
and a date: query.
- / 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
- query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set
+ / 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
+ 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
- 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.
- 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-
- actions generated by rule. F toggles forecast mode, in which fu-
- ture/forecasted transactions are shown.
+ actions generated by rule. F toggles forecast mode, in which
+ future/forecasted transactions are shown.
- 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 en-
- try or the help dialog.
+ 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
+ entry or the help dialog.
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).
- g reloads from the data file(s) and updates the current screen and any
- previous screens. (With large files, this could cause a noticeable
+ g reloads from the data file(s) and updates the current screen and any
+ previous screens. (With large files, this could cause a noticeable
pause.)
- I toggles balance assertion checking. Disabling balance assertions
+ I toggles balance assertion checking. Disabling balance assertions
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.
- 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
+ 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
$path.
- E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""
- -nw) on the journal file. With some editors (emacs, vi), the cursor
- will be positioned at the current transaction when invoked from the
- register and transaction screens, and at the error location (if possi-
+ E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""
+ -nw) on the journal file. With some editors (emacs, vi), the cursor
+ will be positioned at the current transaction when invoked from the
+ register and transaction screens, and at the error location (if possi-
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).
- V toggles value mode, showing amounts' current market value in their
- default valuation commodity (like toggling the -V/--market flag).
- 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
- 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,
+ V toggles value mode, showing amounts' current market value in their
+ default valuation commodity (like toggling the -V/--market flag).
+ 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
+ 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,
press /, and add date:-7/30 to the query.
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.
- With --watch active, if you save an edit to the journal file while
+ With --watch active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the B/V keys will
- stop working. To work around, press g to force a manual reload, or
+ stop working. To work around, press g to force a manual reload, or
exit the transaction screen.
q quits the application.
@@ -279,22 +279,23 @@ KEYS
SCREENS
Accounts screen
- This is normally the first screen displayed. It lists accounts and
- their balances, like hledger's balance command. By default, it shows
- all accounts and their latest ending balances (including the balances
- of subaccounts). If you specify a query on the command line, it shows
+ This is normally the first screen displayed. It lists accounts and
+ their balances, like hledger's balance command. By default, it shows
+ all accounts and their latest ending balances (including the balances
+ of subaccounts). If you specify a query on the command line, it shows
just the matched accounts and the balances from matched transactions.
- 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-
- counts, except where subaccounts are hidden by a depth limit (see be-
- low). In tree mode, all account balances are inclusive of subaccounts.
+ 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-
+ counts, except where subaccounts are hidden by a depth limit (see
+ 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 ES-
- CAPE.
+ depth limit, set it higher than the maximum account depth, or press
+ ESCAPE.
H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the
@@ -302,15 +303,15 @@ SCREENS
(filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless
- disturbed by a filter query). Period balances ignore transactions be-
- fore the report start date, so they show the change in balance during
+ disturbed by a filter query). Period balances ignore transactions
+ 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.
U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (By default, balances include all postings;
- if you activate one or two status filters, only those postings are in-
- cluded; and if you activate all three, the filter is removed.)
+ if you activate one or two status filters, only those postings are
+ included; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored.
@@ -354,33 +355,33 @@ SCREENS
R toggles real mode, in which virtual postings are ignored.
- Z toggles nonzero mode, in which only transactions posting a nonzero
- change are shown (hledger-ui shows zero items by default, unlike com-
+ Z toggles nonzero mode, in which only transactions posting a nonzero
+ change are shown (hledger-ui shows zero items by default, unlike com-
mand-line hledger).
Press right (or enter) to view the selected transaction in detail.
Transaction screen
- This screen shows a single transaction, as a general journal entry,
- similar to hledger's print command and journal format (hledger_jour-
+ This screen shows a single transaction, as a general journal entry,
+ similar to hledger's print command and journal format (hledger_jour-
nal(5)).
- The transaction's date(s) and any cleared flag, transaction code, de-
- scription, comments, along with all of its account postings are shown.
- Simple transactions have two postings, but there can be more (or in
- certain cases, fewer).
+ The transaction's date(s) and any cleared flag, transaction code,
+ description, comments, along with all of its account postings are
+ shown. Simple transactions have two postings, but there can be more
+ (or in certain cases, fewer).
- up and down will step through all transactions listed in the previous
- account register screen. In the title bar, the numbers in parentheses
- show your position within that account register. They will vary de-
- pending on which account register you came from (remember most transac-
- tions appear in multiple account registers). The #N number preceding
+ up and down will step through all transactions listed in the previous
+ account register screen. In the title bar, the numbers in parentheses
+ show your position within that account register. They will vary
+ depending on which account register you came from (remember most trans-
+ actions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload).
Error screen
- 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
+ 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
again to reload and resume normal operation. (Or, you can press escape
to cancel the reload attempt.)
@@ -388,17 +389,17 @@ ENVIRONMENT
COLUMNS The screen width to use. Default: the full terminal width.
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).
- 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-
+ 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-
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
more thorough way that also affects applications started from the GUI
- (say, an Emacs dock icon). Eg on MacOS Catalina I have a ~/.MacOSX/en-
- vironment.plist file containing
+ (say, an Emacs dock icon). Eg on MacOS Catalina I have a
+ ~/.MacOSX/environment.plist file containing
{
"LEDGER_FILE" : "~/finance/current.journal"
@@ -459,4 +460,4 @@ SEE ALSO
-hledger-ui-1.20.3 December 2020 HLEDGER-UI(1)
+hledger-ui-1.20.4 December 2020 HLEDGER-UI(1)