hledger-ui 1.32.1 → 1.32.2
raw patch · 7 files changed
+279/−260 lines, 7 filesdep +vty-crossplatformdep +vty-windowsdep ~brickdep ~hledgerdep ~hledger-libPVP ok
version bump matches the API change (PVP)
Dependencies added: vty-crossplatform, vty-windows
Dependency ranges changed: brick, hledger, hledger-lib, megaparsec, vty
API changes (from Hackage documentation)
Files
- CHANGES.md +16/−2
- Hledger/UI/Editor.hs +9/−4
- Hledger/UI/Main.hs +2/−1
- hledger-ui.1 +145/−144
- hledger-ui.cabal +13/−15
- hledger-ui.info +43/−43
- hledger-ui.txt +51/−51
CHANGES.md view
@@ -7,12 +7,12 @@ Breaking changes +Fixes+ Features Improvements -Fixes- Docs API@@ -20,6 +20,20 @@ --> User-visible changes in hledger-ui. See also the hledger changelog.++# 1.32.2 2023-12-31++Features++- hledger-ui is now available on Windows (ShrykeWindgrace)++Improvements++- Use Notepad as default editor on Windows (ShrykeWindgrace)++- Allow brick 2.2 (Vekhir)++- Allow megaparsec 9.6 # 1.32.1 2023-12-07
Hledger/UI/Editor.hs view
@@ -16,6 +16,7 @@ import System.Environment import System.Exit import System.FilePath+import System.Info (os) import System.Process import Hledger@@ -123,13 +124,17 @@ return $ unwords $ cmd:args -- | Get the user's preferred edit command. This is the value of the--- $HLEDGER_UI_EDITOR environment variable, or of $EDITOR, or a--- default ("emacsclient -a '' -nw", which starts/connects to an emacs--- daemon in terminal mode).+-- $HLEDGER_UI_EDITOR environment variable, or of $EDITOR, or an OS-specific default.+--+-- For non-windows machines that would be "emacsclient -a '' -nw",+-- which starts/connects to an emacs daemon in terminal mode.+--+-- For windows the default is a plain "notepad.exe" getEditCommand :: IO String getEditCommand = do hledger_ui_editor_env <- lookupEnv "HLEDGER_UI_EDITOR" editor_env <- lookupEnv "EDITOR"- let Just cmd = hledger_ui_editor_env <|> editor_env <|> Just "emacsclient -a '' -nw"+ let defaultEditor = Just $ if os == "mingw32" then "notepad.exe" else "emacsclient -a '' -nw"+ let Just cmd = hledger_ui_editor_env <|> editor_env <|> defaultEditor return cmd
Hledger/UI/Main.hs view
@@ -20,7 +20,8 @@ import Data.List.Extra (nubSort) import Data.Maybe (fromMaybe) import qualified Data.Text as T-import Graphics.Vty (mkVty, Mode (Mouse), Vty (outputIface), Output (setMode))+import Graphics.Vty (Mode (Mouse), Vty (outputIface), Output (setMode))+import Graphics.Vty.CrossPlatform (mkVty) import Lens.Micro ((^.)) import System.Directory (canonicalizePath) import System.Environment (withProgName)
hledger-ui.1 view
@@ -1,241 +1,241 @@ -.TH "HLEDGER-UI" "1" "December 2023" "hledger-ui-1.32.1 " "hledger User Manuals"+.TH "HLEDGER\-UI" "1" "December 2023" "hledger-ui-1.32.2 " "hledger User Manuals" .SH NAME-hledger-ui - robust, friendly plain text accounting (TUI version)+hledger\-ui \- robust, friendly plain text accounting (TUI version) .SH SYNOPSIS-\f[CR]hledger-ui [OPTS] [QUERYARGS]\f[R]+\f[CR]hledger\-ui [OPTS] [QUERYARGS]\f[R] .PD 0 .P .PD-\f[CR]hledger ui -- [OPTS] [QUERYARGS]\f[R]+\f[CR]hledger ui \-\- [OPTS] [QUERYARGS]\f[R] .SH DESCRIPTION-This manual is for hledger\[aq]s terminal interface, version 1.32.1.+This manual is for hledger\[aq]s terminal interface, version 1.32.2. See also the hledger manual for common concepts and file formats. .PP-hledger is a robust, user-friendly, cross-platform set of programs for-tracking money, time, or any other commodity, using double-entry+hledger is a robust, user\-friendly, 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 compatible with ledger(1), and largely interconvertible with beancount(1). .PP-hledger-ui is hledger\[aq]s terminal interface, providing an efficient-full-window text UI for viewing accounts and transactions, and some+hledger\-ui is hledger\[aq]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\[aq]s command-line interface, and sometimes+It is easier than hledger\[aq]s command\-line interface, and sometimes quicker and more convenient than the web interface. .PP Like hledger, it reads from (and appends to) a journal file specified by the \f[CR]LEDGER_FILE\f[R] environment variable (defaulting to \f[CR]$HOME/.hledger.journal\f[R]); or you can specify files with-\f[CR]-f\f[R] options.+\f[CR]\-f\f[R] options. It can also read timeclock files, timedot files, or any CSV/SSV/TSV file with a date field.-(See hledger(1) -> Input for details.)+(See hledger(1) \-> Input for details.) .PP-Unlike hledger, hledger-ui hides all future-dated transactions by+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+They can be revealed, along with any rule\-generated periodic+transactions, by pressing the F key (or starting with \-\-forecast) to enable \[dq]forecast mode\[dq]. .SH OPTIONS Any QUERYARGS are interpreted as a hledger search query which filters the data. .PP-hledger-ui provides the following options:+hledger\-ui provides the following options: .TP-\f[CR]-w --watch\f[R]+\f[CR]\-w \-\-watch\f[R] watch for data and date changes and reload automatically .TP-\f[CR]--theme=default|terminal|greenterm\f[R]+\f[CR]\-\-theme=default|terminal|greenterm\f[R] use this custom display theme .TP-\f[CR]--menu\f[R]+\f[CR]\-\-menu\f[R] start in the menu screen .TP-\f[CR]--cash\f[R]+\f[CR]\-\-cash\f[R] start in the cash accounts screen .TP-\f[CR]--bs\f[R]+\f[CR]\-\-bs\f[R] start in the balance sheet accounts screen .TP-\f[CR]--is\f[R]+\f[CR]\-\-is\f[R] start in the income statement accounts screen .TP-\f[CR]--all\f[R]+\f[CR]\-\-all\f[R] start in the all accounts screen .TP-\f[CR]--register=ACCTREGEX\f[R]+\f[CR]\-\-register=ACCTREGEX\f[R] start in the (first) matched account\[aq]s register screen .TP-\f[CR]--change\f[R]+\f[CR]\-\-change\f[R] show period balances (changes) at startup instead of historical balances .TP-\f[CR]-l --flat\f[R]+\f[CR]\-l \-\-flat\f[R] show accounts as a flat list (default) .TP-\f[CR]-t --tree\f[R]+\f[CR]\-t \-\-tree\f[R] show accounts as a tree .PP-hledger-ui also supports many of hledger\[aq]s general options (and the+hledger\-ui also supports many of hledger\[aq]s general options (and the hledger manual\[aq]s command line tips also apply here): .SS General help options .TP-\f[CR]-h --help\f[R]+\f[CR]\-h \-\-help\f[R] show general or COMMAND help .TP-\f[CR]--man\f[R]+\f[CR]\-\-man\f[R] show general or COMMAND user manual with man .TP-\f[CR]--info\f[R]+\f[CR]\-\-info\f[R] show general or COMMAND user manual with info .TP-\f[CR]--version\f[R]+\f[CR]\-\-version\f[R] show general or ADDONCMD version .TP-\f[CR]--debug[=N]\f[R]-show debug output (levels 1-9, default: 1)+\f[CR]\-\-debug[=N]\f[R]+show debug output (levels 1\-9, default: 1) .SS General input options .TP-\f[CR]-f FILE --file=FILE\f[R]+\f[CR]\-f FILE \-\-file=FILE\f[R] use a different input file.-For stdin, use - (default: \f[CR]$LEDGER_FILE\f[R] or+For stdin, use \- (default: \f[CR]$LEDGER_FILE\f[R] or \f[CR]$HOME/.hledger.journal\f[R]) .TP-\f[CR]--rules-file=RULESFILE\f[R]+\f[CR]\-\-rules\-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP-\f[CR]--separator=CHAR\f[R]+\f[CR]\-\-separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP-\f[CR]--alias=OLD=NEW\f[R]+\f[CR]\-\-alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP-\f[CR]--anon\f[R]+\f[CR]\-\-anon\f[R] anonymize accounts and payees .TP-\f[CR]--pivot FIELDNAME\f[R]+\f[CR]\-\-pivot FIELDNAME\f[R] use some other field or tag for the account name .TP-\f[CR]-I --ignore-assertions\f[R]+\f[CR]\-I \-\-ignore\-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP-\f[CR]-s --strict\f[R]+\f[CR]\-s \-\-strict\f[R] do extra error checking (check that all posted accounts are declared) .SS General reporting options .TP-\f[CR]-b --begin=DATE\f[R]+\f[CR]\-b \-\-begin=DATE\f[R] include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) .TP-\f[CR]-e --end=DATE\f[R]+\f[CR]\-e \-\-end=DATE\f[R] include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) .TP-\f[CR]-D --daily\f[R]+\f[CR]\-D \-\-daily\f[R] multiperiod/multicolumn report by day .TP-\f[CR]-W --weekly\f[R]+\f[CR]\-W \-\-weekly\f[R] multiperiod/multicolumn report by week .TP-\f[CR]-M --monthly\f[R]+\f[CR]\-M \-\-monthly\f[R] multiperiod/multicolumn report by month .TP-\f[CR]-Q --quarterly\f[R]+\f[CR]\-Q \-\-quarterly\f[R] multiperiod/multicolumn report by quarter .TP-\f[CR]-Y --yearly\f[R]+\f[CR]\-Y \-\-yearly\f[R] multiperiod/multicolumn report by year .TP-\f[CR]-p --period=PERIODEXP\f[R]+\f[CR]\-p \-\-period=PERIODEXP\f[R] set start date, end date, and/or reporting interval all at once using period expressions syntax .TP-\f[CR]--date2\f[R]+\f[CR]\-\-date2\f[R] match the secondary date instead (see command help for other effects) .TP-\f[CR]--today=DATE\f[R]+\f[CR]\-\-today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP-\f[CR]-U --unmarked\f[R]-include only unmarked postings/txns (can combine with -P or -C)+\f[CR]\-U \-\-unmarked\f[R]+include only unmarked postings/txns (can combine with \-P or \-C) .TP-\f[CR]-P --pending\f[R]+\f[CR]\-P \-\-pending\f[R] include only pending postings/txns .TP-\f[CR]-C --cleared\f[R]+\f[CR]\-C \-\-cleared\f[R] include only cleared postings/txns .TP-\f[CR]-R --real\f[R]-include only non-virtual postings+\f[CR]\-R \-\-real\f[R]+include only non\-virtual postings .TP-\f[CR]-NUM --depth=NUM\f[R]+\f[CR]\-NUM \-\-depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP-\f[CR]-E --empty\f[R]-show items with zero amount, normally hidden (and vice-versa in-hledger-ui/hledger-web)+\f[CR]\-E \-\-empty\f[R]+show items with zero amount, normally hidden (and vice\-versa in+hledger\-ui/hledger\-web) .TP-\f[CR]-B --cost\f[R]+\f[CR]\-B \-\-cost\f[R] convert amounts to their cost/selling amount at transaction time .TP-\f[CR]-V --market\f[R]+\f[CR]\-V \-\-market\f[R] convert amounts to their market value in default valuation commodities .TP-\f[CR]-X --exchange=COMM\f[R]+\f[CR]\-X \-\-exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP-\f[CR]--value\f[R]-convert amounts to cost or market value, more flexibly than -B/-V/-X+\f[CR]\-\-value\f[R]+convert amounts to cost or market value, more flexibly than \-B/\-V/\-X .TP-\f[CR]--infer-equity\f[R]+\f[CR]\-\-infer\-equity\f[R] infer conversion equity postings from costs .TP-\f[CR]--infer-costs\f[R]+\f[CR]\-\-infer\-costs\f[R] infer costs from conversion equity postings .TP-\f[CR]--infer-market-prices\f[R]+\f[CR]\-\-infer\-market\-prices\f[R] use costs as additional market prices, as if they were P directives .TP-\f[CR]--forecast\f[R]+\f[CR]\-\-forecast\f[R] generate transactions from periodic rules, between the latest recorded txn and 6 months from today, or during the specified PERIOD (= is required). Auto posting rules will be applied to these transactions as well.-Also, in hledger-ui make future-dated transactions visible.+Also, in hledger\-ui make future\-dated transactions visible. .TP-\f[CR]--auto\f[R]+\f[CR]\-\-auto\f[R] generate extra postings by applying auto posting rules to all txns (not just forecast txns) .TP-\f[CR]--verbose-tags\f[R]+\f[CR]\-\-verbose\-tags\f[R] add visible tags indicating transactions or postings which have been generated/modified .TP-\f[CR]--commodity-style\f[R]+\f[CR]\-\-commodity\-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP-\f[CR]--color=WHEN (or --colour=WHEN)\f[R]-Should color-supporting commands use ANSI color codes in text output.-\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting-terminal.+\f[CR]\-\-color=WHEN (or \-\-colour=WHEN)\f[R]+Should color\-supporting commands use ANSI color codes in text output.+\[aq]auto\[aq] (default): whenever stdout seems to be a+color\-supporting terminal. \[aq]always\[aq] or \[aq]yes\[aq]: always, useful eg when piping output-into \[aq]less -R\[aq].+into \[aq]less \-R\[aq]. \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP-\f[CR]--pretty[=WHEN]\f[R]+\f[CR]\-\-pretty[=WHEN]\f[R] Show prettier output, e.g.-using unicode box-drawing characters.+using unicode box\-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], \[aq]n\[aq], \[aq]always\[aq], \[aq]never\[aq] also work). If you provide an argument you must use \[aq]=\[aq], e.g.-\[aq]--pretty=yes\[aq].+\[aq]\-\-pretty=yes\[aq]. .PP When a reporting option appears more than once in the command line, the last one takes precedence.@@ -264,9 +264,9 @@ deeper, \f[CR]LEFT\f[R] returns to the previous screen, \f[CR]UP\f[R]/\f[CR]DOWN\f[R]/\f[CR]PGUP\f[R]/\f[CR]PGDN\f[R]/\f[CR]HOME\f[R]/\f[CR]END\f[R] move up and down through lists.-Emacs-style-(\f[CR]CTRL-p\f[R]/\f[CR]CTRL-n\f[R]/\f[CR]CTRL-f\f[R]/\f[CR]CTRL-b\f[R])-and VI-style (\f[CR]k\f[R],\f[CR]j\f[R],\f[CR]l\f[R],\f[CR]h\f[R])+Emacs\-style+(\f[CR]CTRL\-p\f[R]/\f[CR]CTRL\-n\f[R]/\f[CR]CTRL\-f\f[R]/\f[CR]CTRL\-b\f[R])+and VI\-style (\f[CR]k\f[R],\f[CR]j\f[R],\f[CR]l\f[R],\f[CR]h\f[R]) movement keys are also supported. A tip: movement speed is limited by your keyboard repeat rate, to move faster you may want to adjust it.@@ -274,36 +274,36 @@ .PP With shift pressed, the cursor keys adjust the report period, limiting the transactions to be shown (by default, all are shown).-\f[CR]SHIFT-DOWN/UP\f[R] steps downward and upward through these+\f[CR]SHIFT\-DOWN/UP\f[R] steps downward and upward through these standard report period durations: year, quarter, month, week, day.-Then, \f[CR]SHIFT-LEFT/RIGHT\f[R] moves to the previous/next period.+Then, \f[CR]SHIFT\-LEFT/RIGHT\f[R] moves to the previous/next period. \f[CR]T\f[R] sets the report period to today.-With the \f[CR]-w/--watch\f[R] option, when viewing a \[dq]current\[dq]-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 \f[CR]/\f[R] and a+With the \f[CR]\-w/\-\-watch\f[R] option, when viewing a+\[dq]current\[dq] 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 \f[CR]/\f[R] and a \f[CR]date:\f[R] query. .PP-(Mac users: SHIFT-DOWN/UP keys do not work by default in Terminal, as of-MacOS Monterey.-You can configure them as follows: open Terminal, press CMD-comma to+(Mac users: SHIFT\-DOWN/UP keys do not work by default in Terminal, as+of MacOS Monterey.+You can configure them as follows: open Terminal, press CMD\-comma to open preferences, click Profiles, select your current terminal profile on the left, click Keyboard on the right, click + and add this for-Shift-Down: \f[CR]\[rs]033[1;2B\f[R], click + and add this for Shift-Up:-\f[CR]\[rs]033[1;2A\f[R].+Shift\-Down: \f[CR]\[rs]033[1;2B\f[R], click + and add this for+Shift\-Up: \f[CR]\[rs]033[1;2A\f[R]. Press the Escape key to enter the \f[CR]\[rs]033\f[R] part, you can\[aq]t type it directly.) .PP \f[CR]/\f[R] 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;+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 \f[CR]ENTER\f[R] to set it, or \f[CR]ESCAPE\f[R]to cancel. There are also keys for quickly adjusting some common filters like account depth and transaction status (see below). \f[CR]BACKSPACE\f[R] or \f[CR]DELETE\f[R] removes all filters, showing all transactions. .PP-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 transactions generated by rule. \f[CR]F\f[R] toggles forecast mode, in which future/forecasted@@ -313,7 +313,7 @@ restoring the app\[aq]s initial state at startup. Or, it cancels minibuffer data entry or the help dialog. .PP-\f[CR]CTRL-l\f[R] redraws the screen and centers the selection if+\f[CR]CTRL\-l\f[R] redraws the screen and centers the selection if possible (selections near the top won\[aq]t be centered, since we don\[aq]t scroll above the top). .PP@@ -325,17 +325,17 @@ Disabling balance assertions temporarily can be useful for troubleshooting. .PP-\f[CR]a\f[R] runs command-line hledger\[aq]s add command, and reloads+\f[CR]a\f[R] runs command\-line hledger\[aq]s add command, and reloads the updated file. This allows some basic data entry. .PP-\f[CR]A\f[R] is like \f[CR]a\f[R], but runs the hledger-iadd tool, which-provides a terminal interface.-This key will be available if \f[CR]hledger-iadd\f[R] is installed in+\f[CR]A\f[R] is like \f[CR]a\f[R], but runs the hledger\-iadd tool,+which provides a terminal interface.+This key will be available if \f[CR]hledger\-iadd\f[R] is installed in $path. .PP \f[CR]E\f[R] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default-(\f[CR]emacsclient -a \[dq]\[dq] -nw\f[R]) on the journal file.+(\f[CR]emacsclient \-a \[dq]\[dq] \-nw\f[R]) 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@@ -349,37 +349,37 @@ More specifically, .IP "1." 3 By default, the \f[CR]V\f[R] key toggles showing end value-(\f[CR]--value=end\f[R]) on or off.+(\f[CR]\-\-value=end\f[R]) on or off. The valuation date will be the report end date if specified, otherwise today. .IP "2." 3-If you started hledger-ui with some other valuation (such as-\f[CR]--value=then,EUR\f[R]), the \f[CR]V\f[R] key toggles that off or+If you started hledger\-ui with some other valuation (such as+\f[CR]\-\-value=then,EUR\f[R]), the \f[CR]V\f[R] key toggles that off or on. .PP-Cost/value tips: - When showing end value, you can change the report end-date without restarting, by pressing \f[CR]/\f[R] and adding a query-like \f[CR]date:..YYYY-MM-DD\f[R].-- Either cost mode, or value mode, can be active, but not both at once.+Cost/value tips: \- When showing end value, you can change the report+end date without restarting, by pressing \f[CR]/\f[R] and adding a query+like \f[CR]date:..YYYY\-MM\-DD\f[R].+\- Either cost mode, or value mode, can be active, but not both at once. Cost mode takes precedence.-- There\[aq]s not yet any visual indicator that cost or value mode is+\- There\[aq]s not yet any visual indicator that cost or value mode is active, other than the amount values. .PP \f[CR]q\f[R] quits the application. .PP-Additional screen-specific keys are described below.+Additional screen\-specific keys are described below. .SH SCREENS-At startup, hledger-ui shows a menu screen by default.+At startup, hledger\-ui shows a menu screen by default. From here you can navigate to other screens using the cursor keys: \f[CR]UP\f[R]/\f[CR]DOWN\f[R] to select, \f[CR]RIGHT\f[R] to move to the selected screen, \f[CR]LEFT\f[R] to return to the previous screen. Or you can use \f[CR]ESC\f[R] to return directly to the top menu screen. .PP You can also use a command line flag to specific a different startup-screen (\f[CR]--cs\f[R], \f[CR]--bs\f[R], \f[CR]--is\f[R],-\f[CR]--all\f[R], or \f[CR]--register=ACCT\f[R]).+screen (\f[CR]\-\-cs\f[R], \f[CR]\-\-bs\f[R], \f[CR]\-\-is\f[R],+\f[CR]\-\-all\f[R], or \f[CR]\-\-register=ACCT\f[R]). .SS Menu-This is the top-most screen.+This is the top\-most screen. From here you can navigate to several screens listing accounts of various types. Note some of these may not show anything until you have configured@@ -427,8 +427,8 @@ bank\[aq]s website, eg) if not disturbed by a query. .RE .PP-Note, this screen combines each transaction\[aq]s in-period postings to-a single line item, dated with the earliest in-period transaction or+Note, this screen combines each transaction\[aq]s in\-period postings to+a single line item, dated with the earliest in\-period transaction or posting date (like hledger\[aq]s \f[CR]aregister\f[R]). So custom posting dates can cause the running balance to be temporarily inaccurate.@@ -453,8 +453,8 @@ \f[CR]R\f[R] toggles real mode, in which virtual postings are ignored. .PP \f[CR]z\f[R] toggles nonzero mode, in which only transactions posting a-nonzero change are shown (hledger-ui shows zero items by default, unlike-command-line hledger).+nonzero change are shown (hledger\-ui shows zero items by default,+unlike command\-line hledger). .PP Press \f[CR]RIGHT\f[R] to view the selected transaction in detail. .SS Transaction@@ -482,12 +482,12 @@ if possible. .PP This screen has a limitation with showing file updates: it will not show-them until you exit and re-enter it.+them until you exit and re\-enter it. So eg to see the effect of using the \f[CR]E\f[R] key, currently you-must: - press \f[CR]E\f[R], edit and save the file, then exit the-editor, returning to hledger-ui - press \f[CR]g\f[R] to reload the file-(or use \f[CR]-w/--watch\f[R] mode) - press \f[CR]LEFT\f[R] then-\f[CR]RIGHT\f[R] to exit and re-enter the transaction screen.+must: \- press \f[CR]E\f[R], edit and save the file, then exit the+editor, returning to hledger\-ui \- press \f[CR]g\f[R] to reload the+file (or use \f[CR]\-w/\-\-watch\f[R] mode) \- press \f[CR]LEFT\f[R]+then \f[CR]RIGHT\f[R] to exit and re\-enter the transaction screen. .SS Error This screen will appear if there is a problem, such as a parse error, when you press g to reload.@@ -496,35 +496,35 @@ (Or, you can press escape to cancel the reload attempt.) .SH TIPS .SS Watch mode-One of hledger-ui\[aq]s best features is the auto-reloading-\f[CR]-w/--watch\f[R] mode.+One of hledger\-ui\[aq]s best features is the auto\-reloading+\f[CR]\-w/\-\-watch\f[R] mode. With this flag, it will update the display automatically whenever changes are saved to the data files. .PP This is very useful when reconciling. A good workflow is to have your bank\[aq]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 a terminal window, eg:+window; and hledger\-ui in watch mode in a terminal window, eg: .IP .EX-$ hledger-ui --watch --register checking -C+$ hledger\-ui \-\-watch \-\-register checking \-C .EE .PP As you mark things cleared in the editor, you can see the effect immediately without having to context switch. This leaves more mental bandwidth for your accounting.-Of course you can still interact with hledger-ui when needed, eg to+Of course you can still interact with hledger\-ui when needed, eg to toggle cleared mode, or to explore the history. .PP-There are currently some limitations with \f[CR]--watch\f[R]:+There are currently some limitations with \f[CR]\-\-watch\f[R]: .PP It may not work correctly for you, depending on platform or system configuration. (Eg #836.) .PP-At least on mac, there can be a slow build-up of CPU usage over time,+At least on mac, there can be a slow build\-up of CPU usage over time, until the program is restarted (or, suspending and restarting with-\f[CR]CTRL-z\f[R] \f[CR]fg\f[R] may be enough).+\f[CR]CTRL\-z\f[R] \f[CR]fg\f[R] may be enough). .PP It will not detect file changes made by certain editors, such as Jetbrains IDEs or \f[CR]gedit\f[R], or on certain less common@@ -536,17 +536,17 @@ If you are viewing files mounted from another machine, the system clocks on both machines should be roughly in agreement. .SS Debug output-You can add \f[CR]--debug[=N]\f[R] to the command line to log debug+You can add \f[CR]\-\-debug[=N]\f[R] to the command line to log debug output.-This will be logged to the file \f[CR]hledger-ui.log\f[R] in the current-directory.+This will be logged to the file \f[CR]hledger\-ui.log\f[R] in the+current directory. N ranges from 1 (least output, the default) to 9 (maximum output). .SH ENVIRONMENT \f[B]COLUMNS\f[R] The screen width to use. Default: the full terminal width. .PP \f[B]LEDGER_FILE\f[R] The main journal file to use when not specified-with \f[CR]-f/--file\f[R].+with \f[CR]\-f/\-\-file\f[R]. Default: \f[CR]$HOME/.hledger.journal\f[R]. .SH BUGS We welcome bug reports in the hledger issue tracker (shortcut:@@ -555,15 +555,16 @@ .PP Some known issues: .PP-\f[CR]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin).+\f[CR]\-f\-\f[R] doesn\[aq]t work (hledger\-ui can\[aq]t read from+stdin). .PP If you press \f[CR]g\f[R] with large files, there could be a noticeable pause. .PP The Transaction screen does not update from file changes until you exit-and re-endter it (see SCREENS > Transaction above).+and re\-endter it (see SCREENS > Transaction above). .PP-\f[CR]--watch\f[R] is not yet fully robust on all platforms (see Watch+\f[CR]\-\-watch\f[R] is not yet fully robust on all platforms (see Watch mode above).
hledger-ui.cabal view
@@ -5,7 +5,7 @@ -- see: https://github.com/sol/hpack name: hledger-ui-version: 1.32.1+version: 1.32.2 synopsis: Terminal interface for the hledger accounting system description: A simple terminal user interface for the hledger accounting system. It can be a more convenient way to browse your accounts than the CLI.@@ -68,12 +68,12 @@ hs-source-dirs: ./ ghc-options: -Wall -Wno-incomplete-uni-patterns -Wno-missing-signatures -Wno-orphans -Wno-type-defaults -Wno-unused-do-bind- cpp-options: -DVERSION="1.32.1" -DVERSION="1.32.1"+ cpp-options: -DVERSION="1.32.2" -DVERSION="1.32.2" build-depends: ansi-terminal >=0.9 , async , base >=4.14 && <4.19- , brick >=1.5 && <2+ , brick >=2.1.1 && <2.3 , cmdargs >=0.8 , containers >=0.5.9 , data-default@@ -82,9 +82,9 @@ , extra >=1.6.3 , filepath , fsnotify ==0.4.*- , hledger >=1.32.1 && <1.33- , hledger-lib >=1.32.1 && <1.33- , megaparsec >=7.0.0 && <9.6+ , hledger >=1.32.2 && <1.33+ , hledger-lib >=1.32.2 && <1.33+ , megaparsec >=7.0.0 && <9.7 , microlens >=0.4 , microlens-platform >=0.2.3.1 , mtl >=2.2.1@@ -95,14 +95,16 @@ , text-zipper >=0.4 , time >=1.5 , transformers- , unix , vector- , vty >=5.15 && <6+ , vty ==6.1.*+ , vty-crossplatform >=0.4.0.0 && <0.5.0.0 default-language: Haskell2010 if os(windows)- buildable: False+ build-depends:+ vty-windows >=0.2.0.1 && <0.3.0.0 else- buildable: True+ build-depends:+ unix executable hledger-ui main-is: hledger-ui.hs@@ -111,14 +113,10 @@ hs-source-dirs: app ghc-options: -Wall -Wno-incomplete-uni-patterns -Wno-missing-signatures -Wno-orphans -Wno-type-defaults -Wno-unused-do-bind- cpp-options: -DVERSION="1.32.1"+ cpp-options: -DVERSION="1.32.2" build-depends: base >=4.14 && <4.19 , hledger-ui default-language: Haskell2010- if os(windows)- buildable: False- else- buildable: True if flag(threaded) ghc-options: -threaded
hledger-ui.info view
@@ -1,4 +1,4 @@-This is hledger-ui.info, produced by makeinfo version 7.0.3 from stdin.+This is hledger-ui.info, produced by makeinfo version 7.1 from stdin. INFO-DIR-SECTION User Applications START-INFO-DIR-ENTRY@@ -16,7 +16,7 @@ 'hledger-ui [OPTS] [QUERYARGS]' 'hledger ui -- [OPTS] [QUERYARGS]' - This manual is for hledger's terminal interface, version 1.32.1. See+ This manual is for hledger's terminal interface, version 1.32.2. See also the hledger manual for common concepts and file formats. hledger is a robust, user-friendly, cross-platform set of programs@@ -673,47 +673,47 @@ Tag Table:-Node: Top223-Node: OPTIONS1832-Ref: #options1930-Node: General help options2953-Ref: #general-help-options3102-Node: General input options3384-Ref: #general-input-options3569-Node: General reporting options4271-Ref: #general-reporting-options4435-Node: MOUSE7825-Ref: #mouse7920-Node: KEYS8157-Ref: #keys8250-Node: SCREENS12905-Ref: #screens13003-Node: Menu13583-Ref: #menu13676-Node: Cash accounts13871-Ref: #cash-accounts14013-Node: Balance sheet accounts14197-Ref: #balance-sheet-accounts14378-Node: Income statement accounts14498-Ref: #income-statement-accounts14684-Node: All accounts14848-Ref: #all-accounts14994-Node: Register15176-Ref: #register15300-Node: Transaction17584-Ref: #transaction17707-Node: Error19124-Ref: #error19218-Node: TIPS19462-Ref: #tips19561-Node: Watch mode19603-Ref: #watch-mode19710-Node: Debug output21169-Ref: #debug-output21280-Node: ENVIRONMENT21492-Ref: #environment21602-Node: BUGS21793-Ref: #bugs21876+Node: Top221+Node: OPTIONS1830+Ref: #options1928+Node: General help options2951+Ref: #general-help-options3100+Node: General input options3382+Ref: #general-input-options3567+Node: General reporting options4269+Ref: #general-reporting-options4433+Node: MOUSE7823+Ref: #mouse7918+Node: KEYS8155+Ref: #keys8248+Node: SCREENS12903+Ref: #screens13001+Node: Menu13581+Ref: #menu13674+Node: Cash accounts13869+Ref: #cash-accounts14011+Node: Balance sheet accounts14195+Ref: #balance-sheet-accounts14376+Node: Income statement accounts14496+Ref: #income-statement-accounts14682+Node: All accounts14846+Ref: #all-accounts14992+Node: Register15174+Ref: #register15298+Node: Transaction17582+Ref: #transaction17705+Node: Error19122+Ref: #error19216+Node: TIPS19460+Ref: #tips19559+Node: Watch mode19601+Ref: #watch-mode19708+Node: Debug output21167+Ref: #debug-output21278+Node: ENVIRONMENT21490+Ref: #environment21600+Node: BUGS21791+Ref: #bugs21874 End Tag Table
hledger-ui.txt view
@@ -9,7 +9,7 @@ hledger ui -- [OPTS] [QUERYARGS] DESCRIPTION- This manual is for hledger's terminal interface, version 1.32.1. See+ This manual is for hledger's terminal interface, version 1.32.2. See also the hledger manual for common concepts and file formats. hledger is a robust, user-friendly, cross-platform set of programs for@@ -20,23 +20,23 @@ 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 interface, and sometimes quicker and more convenient than the web- interface.+ limited data entry capability. It is easier than hledger's com-+ mand-line interface, and sometimes quicker and more convenient than the+ web interface. - Like hledger, it reads from (and appends to) a journal file specified- by the LEDGER_FILE environment variable (defaulting to- $HOME/.hledger.journal); or you can specify files with -f options. It- can also read timeclock files, timedot files, or any CSV/SSV/TSV file+ Like hledger, it reads from (and appends to) a journal file specified+ by the LEDGER_FILE environment variable (defaulting to+ $HOME/.hledger.journal); or you can specify files with -f options. It+ can also read timeclock files, timedot files, or any CSV/SSV/TSV file with a date field. (See hledger(1) -> Input for details.) - Unlike hledger, hledger-ui hides all future-dated transactions by de-- fault. They can be revealed, along with any rule-generated periodic- transactions, by pressing the F key (or starting with --forecast) to+ Unlike hledger, hledger-ui hides all future-dated transactions by de-+ fault. They can be revealed, along with any rule-generated periodic+ transactions, by pressing the F key (or starting with --forecast) to enable "forecast mode". OPTIONS- Any QUERYARGS are interpreted as a hledger search query which filters+ Any QUERYARGS are interpreted as a hledger search query which filters the data. hledger-ui provides the following options:@@ -61,7 +61,7 @@ start in the (first) matched account's register screen --change- show period balances (changes) at startup instead of historical+ show period balances (changes) at startup instead of historical balances -l --flat@@ -70,7 +70,7 @@ -t --tree show accounts as a tree - hledger-ui also supports many of hledger's general options (and the+ hledger-ui also supports many of hledger's general options (and the hledger manual's command line tips also apply here): General help options@@ -93,7 +93,7 @@ $LEDGER_FILE or $HOME/.hledger.journal) --rules-file=RULESFILE- Conversion rules file to use when reading CSV (default:+ Conversion rules file to use when reading CSV (default: FILE.rules) --separator=CHAR@@ -112,7 +112,7 @@ assignments) -s --strict- do extra error checking (check that all posted accounts are de-+ do extra error checking (check that all posted accounts are de- clared) General reporting options@@ -140,7 +140,7 @@ multiperiod/multicolumn report by year -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 --date2@@ -148,7 +148,7 @@ fects) --today=DATE- override today's date (affects relative smart dates, for+ override today's date (affects relative smart dates, for tests/examples) -U --unmarked@@ -167,21 +167,21 @@ hide/aggregate accounts or postings more than NUM levels deep -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) -B --cost 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-equity@@ -191,32 +191,32 @@ infer costs from conversion equity postings --infer-market-prices- use costs as additional market prices, as if they were P direc-+ use costs as additional market prices, as if they were P direc- tives --forecast- generate transactions from periodic rules, between the latest- recorded txn and 6 months from today, or during the specified- PERIOD (= is required). Auto posting rules will be applied to- these transactions as well. Also, in hledger-ui make future-- dated transactions visible.+ generate transactions from periodic rules, between the latest+ recorded txn and 6 months from today, or during the specified+ PERIOD (= is required). Auto posting rules will be applied to+ these transactions as well. Also, in hledger-ui make fu-+ ture-dated transactions visible. - --auto generate extra postings by applying auto posting rules to all+ --auto generate extra postings by applying auto posting rules to all txns (not just forecast txns) --verbose-tags- add visible tags indicating transactions or postings which have+ add visible tags indicating transactions or postings which have been generated/modified --commodity-style- Override the commodity style in the output for the specified+ Override the commodity style in the output for the specified commodity. For example 'EUR1.000,00'. --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. --pretty[=WHEN]@@ -257,22 +257,22 @@ 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 -w/--watch option, when viewing a "current" period (the cur-- rent day, week, month, quarter, or year), the period will move automat-- ically to track the current date. To set a non-standard period, you- can use / and a date: query.+ 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 -w/--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-stan-+ dard period, you can use / and a date: query. - (Mac users: SHIFT-DOWN/UP keys do not work by default in Terminal, as- of MacOS Monterey. You can configure them as follows: open Terminal,- press CMD-comma to open preferences, click Profiles, select your cur-+ (Mac users: SHIFT-DOWN/UP keys do not work by default in Terminal, as+ of MacOS Monterey. You can configure them as follows: open Terminal,+ press CMD-comma to open preferences, click Profiles, select your cur- rent terminal profile on the left, click Keyboard on the right, click +- and add this for Shift-Down: \033[1;2B, click + and add this for Shift-- Up: \033[1;2A. Press the Escape key to enter the \033 part, you can't- type it directly.)+ and add this for Shift-Down: \033[1;2B, click + and add this for+ Shift-Up: \033[1;2A. Press the Escape key to enter the \033 part, you+ can't type it directly.) / 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@@ -446,8 +446,8 @@ show them until you exit and re-enter it. So eg to see the effect of using the E key, currently you must: - press E, edit and save the file, then exit the editor, returning to hledger-ui - press g to reload the- file (or use -w/--watch mode) - press LEFT then RIGHT to exit and re-- enter the transaction screen.+ file (or use -w/--watch mode) - press LEFT then RIGHT to exit and+ re-enter the transaction screen. Error This screen will appear if there is a problem, such as a parse error,@@ -537,4 +537,4 @@ SEE ALSO hledger(1), hledger-ui(1), hledger-web(1), ledger(1) -hledger-ui-1.32.1 December 2023 HLEDGER-UI(1)+hledger-ui-1.32.2 December 2023 HLEDGER-UI(1)