diff --git a/CHANGES.md b/CHANGES.md --- a/CHANGES.md +++ b/CHANGES.md @@ -21,6 +21,16 @@ User-visible changes in hledger-ui. See also the hledger changelog. +# 1.32 2023-12-01 + +Fixes + +- The V key now preserves the valuation mode specified at the command + line, if any. (#2084) + +- The hledger-ui package no longer wastefully builds its modules + twice. + # 1.31 2023-09-03 Improvements diff --git a/Hledger/UI.hs b/Hledger/UI.hs --- a/Hledger/UI.hs +++ b/Hledger/UI.hs @@ -1,12 +1,23 @@ {-| -Re-export the modules of the hledger-ui program. + +This is the root module of the @hledger-ui@ package, +providing hledger's terminal user interface. +The main function, command-line options, and terminal themes are exported. + +== See also: + +- hledger-lib:Hledger +- hledger:Hledger.Cli +- [The README files](https://github.com/search?q=repo%3Asimonmichael%2Fhledger+path%3A**%2FREADME*&type=code&ref=advsearch) +- [The high-level developer docs](https://hledger.org/dev.html) + -} module Hledger.UI ( - module Hledger.UI.Main, - module Hledger.UI.UIOptions, - module Hledger.UI.Theme - ) + module Hledger.UI.Main, + module Hledger.UI.Theme, + module Hledger.UI.UIOptions, +) where import Hledger.UI.Main diff --git a/Hledger/UI/Main.hs b/Hledger/UI/Main.hs --- a/Hledger/UI/Main.hs +++ b/Hledger/UI/Main.hs @@ -56,8 +56,8 @@ writeChan = BC.writeBChan -main :: IO () -main = withProgName "hledger-ui.log" $ do -- force Hledger.Utils.Debug.* to log to hledger-ui.log +hledgerUiMain :: IO () +hledgerUiMain = withProgName "hledger-ui.log" $ do -- force Hledger.Utils.Debug.* to log to hledger-ui.log traceLogAtIO 1 "\n\n\n\n==== hledger-ui start" dbg1IO "args" progArgs dbg1IO "debugLevel" debugLevel diff --git a/Hledger/UI/UIScreens.hs b/Hledger/UI/UIScreens.hs --- a/Hledger/UI/UIScreens.hs +++ b/Hledger/UI/UIScreens.hs @@ -159,7 +159,9 @@ displayitems = map displayitem items where -- run the report - (items, _) = balanceReport rspec j + (items, _) = styleAmounts styles $ balanceReport rspec j + where + styles = journalCommodityStylesWith HardRounding j -- pre-render a list item displayitem (fullacct, shortacct, indent, bal) = @@ -267,7 +269,9 @@ & reportSpecSetFutureAndForecast (forecast_ $ inputopts_ copts) -- gather transactions to display - items = accountTransactionsReport rspec' j thisacctq + items = styleAmounts styles $ accountTransactionsReport rspec' j thisacctq + where + styles = journalCommodityStylesWith HardRounding j items' = (if empty_ ropts then id else filter (not . mixedAmountLooksZero . fifth6)) $ -- without --empty, exclude no-change txns reverse -- most recent last diff --git a/Hledger/UI/UIState.hs b/Hledger/UI/UIState.hs --- a/Hledger/UI/UIState.hs +++ b/Hledger/UI/UIState.hs @@ -58,7 +58,7 @@ import Hledger import Hledger.Cli.CliOptions import Hledger.UI.UITypes -import Hledger.UI.UIOptions (UIOpts) +import Hledger.UI.UIOptions (UIOpts(uoCliOpts)) import Hledger.UI.UIScreens (screenUpdate) -- | Make an initial UI state with the given options, journal, @@ -155,13 +155,17 @@ toggleCostMode (Just NoConversionOp) = Just ToCost toggleCostMode (Just ToCost) = Just NoConversionOp --- | Toggle between showing primary amounts or default valuation. +-- | Toggle between showing primary amounts or values (using valuation specified at startup, or a default). toggleValue :: UIState -> UIState -toggleValue = over value valuationToggleValue +toggleValue ui = over value (valuationToggleValue mstartupvaluation0) ui where - -- | Basic toggling of -V, for hledger-ui. - valuationToggleValue (Just (AtEnd _)) = Nothing - valuationToggleValue _ = Just $ AtEnd Nothing + mstartupvaluation0 = value_ $ _rsReportOpts $ reportspec_ $ uoCliOpts $ astartupopts ui + mdefvaluation = Just (AtEnd Nothing) + -- valuationToggleValue (maybe startupvaluation) (maybe currentvaluation) = ... + valuationToggleValue Nothing Nothing = mdefvaluation + valuationToggleValue Nothing (Just _) = Nothing + valuationToggleValue mstartupvaluation Nothing = mstartupvaluation + valuationToggleValue _ (Just _) = Nothing -- | Set hierarchic account tree mode. setTree :: UIState -> UIState diff --git a/app/hledger-ui.hs b/app/hledger-ui.hs new file mode 100644 --- /dev/null +++ b/app/hledger-ui.hs @@ -0,0 +1,4 @@ +import Hledger.UI.Main (hledgerUiMain) + +main :: IO () +main = hledgerUiMain diff --git a/hledger-ui.1 b/hledger-ui.1 --- a/hledger-ui.1 +++ b/hledger-ui.1 @@ -1,21 +1,18 @@ -.TH "HLEDGER-UI" "1" "September 2023" "hledger-ui-1.31 " "hledger User Manuals" +.TH "HLEDGER-UI" "1" "December 2023" "hledger-ui-1.32 " "hledger User Manuals" .SH NAME -.PP hledger-ui - robust, friendly plain text accounting (TUI version) .SH SYNOPSIS -.PP -\f[V]hledger-ui [OPTS] [QUERYARGS]\f[R] +\f[CR]hledger-ui [OPTS] [QUERYARGS]\f[R] .PD 0 .P .PD -\f[V]hledger ui -- [OPTS] [QUERYARGS]\f[R] +\f[CR]hledger ui -- [OPTS] [QUERYARGS]\f[R] .SH DESCRIPTION -.PP -This manual is for hledger\[aq]s terminal interface, version 1.31. +This manual is for hledger\[aq]s terminal interface, version 1.32. See also the hledger manual for common concepts and file formats. .PP hledger is a robust, user-friendly, cross-platform set of programs for @@ -31,9 +28,9 @@ quicker and more convenient than the web interface. .PP Like hledger, it reads from (and appends to) a journal file specified by -the \f[V]LEDGER_FILE\f[R] environment variable (defaulting to -\f[V]$HOME/.hledger.journal\f[R]); or you can specify files with -\f[V]-f\f[R] options. +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. It can also read timeclock files, timedot files, or any CSV/SSV/TSV file with a date field. (See hledger(1) -> Input for details.) @@ -44,187 +41,186 @@ transactions, by pressing the F key (or starting with --forecast) to enable \[dq]forecast mode\[dq]. .SH OPTIONS -.PP Any QUERYARGS are interpreted as a hledger search query which filters the data. .PP hledger-ui provides the following options: .TP -\f[V]-w --watch\f[R] +\f[CR]-w --watch\f[R] watch for data and date changes and reload automatically .TP -\f[V]--theme=default|terminal|greenterm\f[R] +\f[CR]--theme=default|terminal|greenterm\f[R] use this custom display theme .TP -\f[V]--menu\f[R] +\f[CR]--menu\f[R] start in the menu screen .TP -\f[V]--cash\f[R] +\f[CR]--cash\f[R] start in the cash accounts screen .TP -\f[V]--bs\f[R] +\f[CR]--bs\f[R] start in the balance sheet accounts screen .TP -\f[V]--is\f[R] +\f[CR]--is\f[R] start in the income statement accounts screen .TP -\f[V]--all\f[R] +\f[CR]--all\f[R] start in the all accounts screen .TP -\f[V]--register=ACCTREGEX\f[R] +\f[CR]--register=ACCTREGEX\f[R] start in the (first) matched account\[aq]s register screen .TP -\f[V]--change\f[R] +\f[CR]--change\f[R] show period balances (changes) at startup instead of historical balances .TP -\f[V]-l --flat\f[R] +\f[CR]-l --flat\f[R] show accounts as a flat list (default) .TP -\f[V]-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 manual\[aq]s command line tips also apply here): .SS General help options .TP -\f[V]-h --help\f[R] +\f[CR]-h --help\f[R] show general or COMMAND help .TP -\f[V]--man\f[R] +\f[CR]--man\f[R] show general or COMMAND user manual with man .TP -\f[V]--info\f[R] +\f[CR]--info\f[R] show general or COMMAND user manual with info .TP -\f[V]--version\f[R] +\f[CR]--version\f[R] show general or ADDONCMD version .TP -\f[V]--debug[=N]\f[R] +\f[CR]--debug[=N]\f[R] show debug output (levels 1-9, default: 1) .SS General input options .TP -\f[V]-f FILE --file=FILE\f[R] +\f[CR]-f FILE --file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[V]$LEDGER_FILE\f[R] or -\f[V]$HOME/.hledger.journal\f[R]) +For stdin, use - (default: \f[CR]$LEDGER_FILE\f[R] or +\f[CR]$HOME/.hledger.journal\f[R]) .TP -\f[V]--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[V]--separator=CHAR\f[R] +\f[CR]--separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[V]--alias=OLD=NEW\f[R] +\f[CR]--alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[V]--anon\f[R] +\f[CR]--anon\f[R] anonymize accounts and payees .TP -\f[V]--pivot FIELDNAME\f[R] +\f[CR]--pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[V]-I --ignore-assertions\f[R] +\f[CR]-I --ignore-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[V]-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[V]-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[V]-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[V]-D --daily\f[R] +\f[CR]-D --daily\f[R] multiperiod/multicolumn report by day .TP -\f[V]-W --weekly\f[R] +\f[CR]-W --weekly\f[R] multiperiod/multicolumn report by week .TP -\f[V]-M --monthly\f[R] +\f[CR]-M --monthly\f[R] multiperiod/multicolumn report by month .TP -\f[V]-Q --quarterly\f[R] +\f[CR]-Q --quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[V]-Y --yearly\f[R] +\f[CR]-Y --yearly\f[R] multiperiod/multicolumn report by year .TP -\f[V]-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[V]--date2\f[R] +\f[CR]--date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[V]--today=DATE\f[R] +\f[CR]--today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[V]-U --unmarked\f[R] +\f[CR]-U --unmarked\f[R] include only unmarked postings/txns (can combine with -P or -C) .TP -\f[V]-P --pending\f[R] +\f[CR]-P --pending\f[R] include only pending postings/txns .TP -\f[V]-C --cleared\f[R] +\f[CR]-C --cleared\f[R] include only cleared postings/txns .TP -\f[V]-R --real\f[R] +\f[CR]-R --real\f[R] include only non-virtual postings .TP -\f[V]-NUM --depth=NUM\f[R] +\f[CR]-NUM --depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[V]-E --empty\f[R] +\f[CR]-E --empty\f[R] show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) .TP -\f[V]-B --cost\f[R] +\f[CR]-B --cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[V]-V --market\f[R] +\f[CR]-V --market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[V]-X --exchange=COMM\f[R] +\f[CR]-X --exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[V]--value\f[R] +\f[CR]--value\f[R] convert amounts to cost or market value, more flexibly than -B/-V/-X .TP -\f[V]--infer-equity\f[R] +\f[CR]--infer-equity\f[R] infer conversion equity postings from costs .TP -\f[V]--infer-costs\f[R] +\f[CR]--infer-costs\f[R] infer costs from conversion equity postings .TP -\f[V]--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[V]--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. .TP -\f[V]--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[V]--verbose-tags\f[R] +\f[CR]--verbose-tags\f[R] add visible tags indicating transactions or postings which have been generated/modified .TP -\f[V]--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[V]--color=WHEN (or --colour=WHEN)\f[R] +\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. @@ -233,7 +229,7 @@ \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[V]--pretty[=WHEN]\f[R] +\f[CR]--pretty[=WHEN]\f[R] Show prettier output, e.g. using unicode box-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], @@ -246,7 +242,6 @@ .PP Some reporting options can also be written as query arguments. .SH MOUSE -.PP In most modern terminals, you can navigate through the screens with a mouse or touchpad: .IP \[bu] 2 @@ -256,163 +251,159 @@ .IP \[bu] 2 Click on the left margin (column 0) to go back. .SH KEYS -.PP Keyboard gives more control. .PP -\f[V]?\f[R] shows a help dialog listing all keys. +\f[CR]?\f[R] shows a help dialog listing all keys. (Some of these also appear in the quick help at the bottom of each screen.) -Press \f[V]?\f[R] again (or \f[V]ESCAPE\f[R], or \f[V]LEFT\f[R], or -\f[V]q\f[R]) to close it. +Press \f[CR]?\f[R] again (or \f[CR]ESCAPE\f[R], or \f[CR]LEFT\f[R], or +\f[CR]q\f[R]) to close it. The following keys work on most screens: .PP -The cursor keys navigate: \f[V]RIGHT\f[R] or \f[V]ENTER\f[R] goes -deeper, \f[V]LEFT\f[R] returns to the previous screen, -\f[V]UP\f[R]/\f[V]DOWN\f[R]/\f[V]PGUP\f[R]/\f[V]PGDN\f[R]/\f[V]HOME\f[R]/\f[V]END\f[R] +The cursor keys navigate: \f[CR]RIGHT\f[R] or \f[CR]ENTER\f[R] goes +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[V]CTRL-p\f[R]/\f[V]CTRL-n\f[R]/\f[V]CTRL-f\f[R]/\f[V]CTRL-b\f[R]) -and VI-style (\f[V]k\f[R],\f[V]j\f[R],\f[V]l\f[R],\f[V]h\f[R]) movement -keys are also supported. +(\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. (If you\[aq]re on a mac, the karabiner app is one way to do that.) .PP With shift pressed, the cursor keys adjust the report period, limiting the transactions to be shown (by default, all are shown). -\f[V]SHIFT-DOWN/UP\f[R] steps downward and upward through these standard -report period durations: year, quarter, month, week, day. -Then, \f[V]SHIFT-LEFT/RIGHT\f[R] moves to the previous/next period. -\f[V]T\f[R] sets the report period to today. -With the \f[V]-w/--watch\f[R] option, when viewing a \[dq]current\[dq] +\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. +\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[V]/\f[R] and a -\f[V]date:\f[R] query. +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 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[V]\[rs]033[1;2B\f[R], click + and add this for Shift-Up: -\f[V]\[rs]033[1;2A\f[R]. -Press the Escape key to enter the \f[V]\[rs]033\f[R] part, you can\[aq]t -type it directly.) +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[V]/\f[R] lets you set a general filter query limiting the data shown, -using the same query terms as in hledger and hledger-web. +\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; -press \f[V]ENTER\f[R] to set it, or \f[V]ESCAPE\f[R]to cancel. +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[V]BACKSPACE\f[R] or \f[V]DELETE\f[R] removes all filters, showing all -transactions. +\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 - both ordinary transactions recorded in the journal, and periodic transactions generated by rule. -\f[V]F\f[R] toggles forecast mode, in which future/forecasted +\f[CR]F\f[R] toggles forecast mode, in which future/forecasted transactions are shown. .PP -\f[V]ESCAPE\f[R] resets the UI state and jumps back to the top screen, +\f[CR]ESCAPE\f[R] resets the UI state and jumps back to the top screen, restoring the app\[aq]s initial state at startup. Or, it cancels minibuffer data entry or the help dialog. .PP -\f[V]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 -\f[V]g\f[R] reloads from the data file(s) and updates the current screen -and any previous screens. +\f[CR]g\f[R] reloads from the data file(s) and updates the current +screen and any previous screens. (With large files, this could cause a noticeable pause.) .PP -\f[V]I\f[R] toggles balance assertion checking. +\f[CR]I\f[R] toggles balance assertion checking. Disabling balance assertions temporarily can be useful for troubleshooting. .PP -\f[V]a\f[R] runs command-line hledger\[aq]s add command, and reloads the -updated file. +\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[V]A\f[R] is like \f[V]a\f[R], but runs the hledger-iadd tool, which +\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[V]hledger-iadd\f[R] is installed in +This key will be available if \f[CR]hledger-iadd\f[R] is installed in $path. .PP -\f[V]E\f[R] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default -(\f[V]emacsclient -a \[dq]\[dq] -nw\f[R]) on the journal file. +\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. 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. .PP -\f[V]B\f[R] toggles cost mode, showing amounts in their cost\[aq]s -commodity (like toggling the \f[V]-B/--cost\f[R] flag). -.PP -\f[V]V\f[R] toggles value mode, showing amounts\[aq] current market -value in their default valuation commodity (like toggling the -\f[V]-V/--market\f[R] flag). -Note, \[dq]current market value\[dq] 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 \f[V]/\f[R], and add \f[V]date:-7/30\f[R] to -the query. +\f[CR]B\f[R] toggles cost mode, showing amounts converted to their +cost\[aq]s commodity (see hledger manual > Cost reporting. .PP -At most one of cost or value mode can be active at once. +\f[CR]V\f[R] toggles value mode, showing amounts converted to their +market value (see hledger manual > Valuation flag). +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. +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 +on. .PP -There\[aq]s not yet any visual reminder when cost or value mode is -active; for now pressing \f[V]b\f[R] \f[V]b\f[R] \f[V]v\f[R] should -reliably reset to normal mode. +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 +active, other than the amount values. .PP -\f[V]q\f[R] quits the application. +\f[CR]q\f[R] quits the application. .PP Additional screen-specific keys are described below. .SH SCREENS -.PP At startup, hledger-ui shows a menu screen by default. From here you can navigate to other screens using the cursor keys: -\f[V]UP\f[R]/\f[V]DOWN\f[R] to select, \f[V]RIGHT\f[R] to move to the -selected screen, \f[V]LEFT\f[R] to return to the previous screen. -Or you can use \f[V]ESC\f[R] to return directly to the top menu screen. +\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[V]--cs\f[R], \f[V]--bs\f[R], \f[V]--is\f[R], \f[V]--all\f[R], -or \f[V]--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 -.PP 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 account types. .SS Cash accounts -.PP This screen shows \[dq]cash\[dq] (ie, liquid asset) accounts (like -\f[V]hledger balancesheet type:c\f[R]). +\f[CR]hledger balancesheet type:c\f[R]). It always shows balances (historical ending balances on the date shown in the title line). .SS Balance sheet accounts -.PP This screen shows asset, liability and equity accounts (like -\f[V]hledger balancesheetequity\f[R]). +\f[CR]hledger balancesheetequity\f[R]). It always shows balances. .SS Income statement accounts -.PP This screen shows revenue and expense accounts (like -\f[V]hledger incomestatement\f[R]). +\f[CR]hledger incomestatement\f[R]). It always shows changes (balance changes in the period shown in the title line). .SS All accounts -.PP This screen shows all accounts in your journal (unless filtered by a -query; like \f[V]hledger balance\f[R]). +query; like \f[CR]hledger balance\f[R]). It shows balances by default; you can toggle showing changes with the -\f[V]H\f[R] key. +\f[CR]H\f[R] key. .SS Register -.PP This screen shows the transactions affecting a particular account. Each line represents one transaction, and shows: .IP \[bu] 2 @@ -424,7 +415,7 @@ inflow to this account, negative for an outflow. .IP \[bu] 2 the running total after the transaction. -With the \f[V]H\f[R] key you can toggle between +With the \f[CR]H\f[R] key you can toggle between .RS 2 .IP \[bu] 2 the period total, which is from just the transactions displayed @@ -436,31 +427,37 @@ 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 +posting date (like hledger\[aq]s \f[CR]aregister\f[R]). +So custom posting dates can cause the running balance to be temporarily +inaccurate. +(See hledger manual > aregister and posting dates.) +.PP Transactions affecting this account\[aq]s subaccounts will be included in the register if the accounts screen is in tree mode, or if it\[aq]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 \f[V]t\f[R] here also. +Tree mode/list mode can be toggled with \f[CR]t\f[R] here also. .PP -\f[V]U\f[R] toggles filtering by unmarked status, showing or hiding +\f[CR]U\f[R] toggles filtering by unmarked status, showing or hiding unmarked transactions. -Similarly, \f[V]P\f[R] toggles pending transactions, and \f[V]C\f[R] +Similarly, \f[CR]P\f[R] toggles pending transactions, and \f[CR]C\f[R] 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.) .PP -\f[V]R\f[R] toggles real mode, in which virtual postings are ignored. +\f[CR]R\f[R] toggles real mode, in which virtual postings are ignored. .PP -\f[V]z\f[R] toggles nonzero mode, in which only transactions posting a +\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). .PP -Press \f[V]RIGHT\f[R] to view the selected transaction in detail. +Press \f[CR]RIGHT\f[R] to view the selected transaction in detail. .SS Transaction -.PP This screen shows a single transaction, as a general journal entry, similar to hledger\[aq]s print command and journal format (hledger_journal(5)). @@ -470,7 +467,7 @@ Simple transactions have two postings, but there can be more (or in certain cases, fewer). .PP -\f[V]UP\f[R] and \f[V]DOWN\f[R] will step through all transactions +\f[CR]UP\f[R] and \f[CR]DOWN\f[R] 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. @@ -480,19 +477,18 @@ the complete unfiltered journal, which is a more stable id (at least until the next reload). .PP -On this screen (and the register screen), the \f[V]E\f[R] key will open +On this screen (and the register screen), the \f[CR]E\f[R] key will open your text editor with the cursor positioned at the current transaction if possible. .PP This screen has a limitation with showing file updates: it will not show them until you exit and re-enter it. -So eg to see the effect of using the \f[V]E\f[R] key, currently you -must: - press \f[V]E\f[R], edit and save the file, then exit the editor, -returning to hledger-ui - press \f[V]g\f[R] to reload the file (or use -\f[V]-w/--watch\f[R] mode) - press \f[V]LEFT\f[R] then \f[V]RIGHT\f[R] -to exit and re-enter the transaction screen. +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. .SS Error -.PP 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 @@ -500,9 +496,8 @@ (Or, you can press escape to cancel the reload attempt.) .SH TIPS .SS Watch mode -.PP One of hledger-ui\[aq]s best features is the auto-reloading -\f[V]-w/--watch\f[R] mode. +\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 @@ -511,11 +506,9 @@ browser window, for reference; the journal file open in an editor window; and hledger-ui in watch mode in a terminal window, eg: .IP -.nf -\f[C] +.EX $ hledger-ui --watch --register checking -C -\f[R] -.fi +.EE .PP As you mark things cleared in the editor, you can see the effect immediately without having to context switch. @@ -523,7 +516,7 @@ 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[V]--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. @@ -531,49 +524,46 @@ .PP 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[V]CTRL-z\f[R] \f[V]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[V]gedit\f[R], or on certain less common +Jetbrains IDEs or \f[CR]gedit\f[R], or on certain less common filesystems. -(To work around, press \f[V]g\f[R] to reload manually, or try -#1617\[aq]s \f[V]fs.inotify.max_user_watches\f[R] workaround and let us +(To work around, press \f[CR]g\f[R] to reload manually, or try +#1617\[aq]s \f[CR]fs.inotify.max_user_watches\f[R] workaround and let us know.) .PP If you are viewing files mounted from another machine, the system clocks on both machines should be roughly in agreement. .SS Debug output -.PP -You can add \f[V]--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[V]hledger-ui.log\f[R] in the current +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 -.PP \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[V]-f/--file\f[R]. -Default: \f[V]$HOME/.hledger.journal\f[R]. +with \f[CR]-f/--file\f[R]. +Default: \f[CR]$HOME/.hledger.journal\f[R]. .SH BUGS -.PP We welcome bug reports in the hledger issue tracker (shortcut: http://bugs.hledger.org), or on the #hledger chat or hledger mail list (https://hledger.org/support). .PP Some known issues: .PP -\f[V]-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[V]g\f[R] with large files, there could be a noticeable +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). .PP -\f[V]--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). diff --git a/hledger-ui.cabal b/hledger-ui.cabal --- a/hledger-ui.cabal +++ b/hledger-ui.cabal @@ -1,13 +1,13 @@ cabal-version: 1.12 --- This file has been generated from package.yaml by hpack version 0.35.1. +-- This file has been generated from package.yaml by hpack version 0.36.0. -- -- see: https://github.com/sol/hpack name: hledger-ui -version: 1.31 -synopsis: Curses-style terminal interface for the hledger accounting system -description: A simple curses-style terminal user interface for the hledger accounting system. +version: 1.32 +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. This package currently does not support Microsoft Windows, except in WSL. . @@ -44,22 +44,22 @@ manual: False default: True -executable hledger-ui - main-is: hledger-ui.hs - other-modules: +library + exposed-modules: Hledger.UI + Hledger.UI.Main + Hledger.UI.Theme + Hledger.UI.UIOptions + other-modules: Hledger.UI.AccountsScreen Hledger.UI.BalancesheetScreen Hledger.UI.CashScreen Hledger.UI.Editor Hledger.UI.ErrorScreen Hledger.UI.IncomestatementScreen - Hledger.UI.Main Hledger.UI.MenuScreen Hledger.UI.RegisterScreen - Hledger.UI.Theme Hledger.UI.TransactionScreen - Hledger.UI.UIOptions Hledger.UI.UIScreens Hledger.UI.UIState Hledger.UI.UITypes @@ -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.31" + cpp-options: -DVERSION="1.32" -DVERSION="1.32" build-depends: ansi-terminal >=0.9 , async , base >=4.14 && <4.19 - , brick >=1.5 + , brick >=1.5 && <2 , cmdargs >=0.8 , containers >=0.5.9 , data-default @@ -82,8 +82,8 @@ , extra >=1.6.3 , filepath , fsnotify ==0.4.* - , hledger ==1.31.* - , hledger-lib ==1.31.* + , hledger ==1.32.* + , hledger-lib ==1.32.* , megaparsec >=7.0.0 && <9.6 , microlens >=0.4 , microlens-platform >=0.2.3.1 @@ -91,13 +91,30 @@ , process >=1.2 , safe >=0.3.19 , split >=0.1 - , text >=1.2 + , text >=1.2.4.1 , text-zipper >=0.4 , time >=1.5 , transformers , unix , vector - , vty >=5.15 + , vty >=5.15 && <6 + default-language: Haskell2010 + if os(windows) + buildable: False + else + buildable: True + +executable hledger-ui + main-is: hledger-ui.hs + other-modules: + Paths_hledger_ui + 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" + build-depends: + base >=4.14 && <4.19 + , hledger-ui default-language: Haskell2010 if os(windows) buildable: False diff --git a/hledger-ui.hs b/hledger-ui.hs deleted file mode 100644 --- a/hledger-ui.hs +++ /dev/null @@ -1,7 +0,0 @@ -module Main (main) -where --- import Hledger.UI (main) --- workaround for GHC 9.0.1 https://gitlab.haskell.org/ghc/ghc/-/issues/19397, #1503 -import qualified Hledger.UI.Main (main) -main :: IO () -main = Hledger.UI.Main.main diff --git a/hledger-ui.info b/hledger-ui.info --- a/hledger-ui.info +++ b/hledger-ui.info @@ -16,7 +16,7 @@ 'hledger-ui [OPTS] [QUERYARGS]' 'hledger ui -- [OPTS] [QUERYARGS]' - This manual is for hledger's terminal interface, version 1.31. See + This manual is for hledger's terminal interface, version 1.32. See also the hledger manual for common concepts and file formats. hledger is a robust, user-friendly, cross-platform set of programs @@ -377,23 +377,26 @@ 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 cost's commodity -(like toggling the '-B/--cost' flag). + 'B' toggles cost mode, showing amounts converted to their cost's +commodity (see hledger manual > Cost reporting. - '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. + 'V' toggles value mode, showing amounts converted to their market +value (see hledger manual > Valuation flag). More specifically, - At most one of cost or value mode can be active at once. + 1. By default, the 'V' key toggles showing end value ('--value=end') + on or off. The valuation date will be the report end date if + specified, otherwise today. - 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. + 2. If you started hledger-ui with some other valuation (such as + '--value=then,EUR'), the 'V' key toggles that off or on. + Cost/value tips: - When showing end value, you can change the report +end date without restarting, by pressing '/' and adding a query like +'date:..YYYY-MM-DD'. - Either cost mode, or value mode, can be active, +but not both at once. Cost mode takes precedence. - There's not yet +any visual indicator that cost or value mode is active, other than the +amount values. + 'q' quits the application. Additional screen-specific keys are described below. @@ -500,6 +503,12 @@ historical balance (what you would see on a bank's website, eg) if not disturbed by a query. + Note, this screen combines each transaction's in-period postings to a +single line item, dated with the earliest in-period transaction or +posting date (like hledger's 'aregister'). So custom posting dates can +cause the running balance to be temporarily inaccurate. (See hledger +manual > aregister and posting dates.) + 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 @@ -677,34 +686,34 @@ Ref: #mouse7918 Node: KEYS8155 Ref: #keys8248 -Node: SCREENS12761 -Ref: #screens12859 -Node: Menu13439 -Ref: #menu13532 -Node: Cash accounts13727 -Ref: #cash-accounts13869 -Node: Balance sheet accounts14053 -Ref: #balance-sheet-accounts14234 -Node: Income statement accounts14354 -Ref: #income-statement-accounts14540 -Node: All accounts14704 -Ref: #all-accounts14850 -Node: Register15032 -Ref: #register15156 -Node: Transaction17118 -Ref: #transaction17241 -Node: Error18658 -Ref: #error18752 -Node: TIPS18996 -Ref: #tips19095 -Node: Watch mode19137 -Ref: #watch-mode19244 -Node: Debug output20703 -Ref: #debug-output20814 -Node: ENVIRONMENT21026 -Ref: #environment21136 -Node: BUGS21327 -Ref: #bugs21410 +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 diff --git a/hledger-ui.txt b/hledger-ui.txt --- a/hledger-ui.txt +++ b/hledger-ui.txt @@ -9,7 +9,7 @@ hledger ui -- [OPTS] [QUERYARGS] DESCRIPTION - This manual is for hledger's terminal interface, version 1.31. See + This manual is for hledger's terminal interface, version 1.32. See also the hledger manual for common concepts and file formats. hledger is a robust, user-friendly, cross-platform set of programs for @@ -314,22 +314,26 @@ 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 cost's commodity (like - toggling the -B/--cost flag). + B toggles cost mode, showing amounts converted to their cost's commod- + ity (see hledger manual > Cost reporting. - 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. + V toggles value mode, showing amounts converted to their market value + (see hledger manual > Valuation flag). More specifically, - At most one of cost or value mode can be active at once. + 1. By default, the V key toggles showing end value (--value=end) on or + off. The valuation date will be the report end date if specified, + otherwise today. - 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. + 2. If you started hledger-ui with some other valuation (such as + --value=then,EUR), the V key toggles that off or on. + Cost/value tips: - When showing end value, you can change the report + end date without restarting, by pressing / and adding a query like + date:..YYYY-MM-DD. - Either cost mode, or value mode, can be active, + but not both at once. Cost mode takes precedence. - There's not yet + any visual indicator that cost or value mode is active, other than the + amount values. + q quits the application. Additional screen-specific keys are described below. @@ -389,6 +393,12 @@ (what you would see on a bank's website, eg) if not disturbed by a query. + Note, this screen combines each transaction's in-period postings to a + single line item, dated with the earliest in-period transaction or + posting date (like hledger's aregister). So custom posting dates can + cause the running balance to be temporarily inaccurate. (See hledger + manual > aregister and posting dates.) + 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 @@ -527,4 +537,4 @@ SEE ALSO hledger(1), hledger-ui(1), hledger-web(1), ledger(1) -hledger-ui-1.31 September 2023 HLEDGER-UI(1) +hledger-ui-1.32 December 2023 HLEDGER-UI(1)