hledger-ui 1.1.2 → 1.2
raw patch · 8 files changed
+355/−353 lines, 8 filesdep ~brickdep ~hledgerdep ~hledger-lib
Dependency ranges changed: brick, hledger, hledger-lib, megaparsec, vty
Files
- CHANGES +11/−2
- Hledger/UI/RegisterScreen.hs +4/−1
- Hledger/UI/TransactionScreen.hs +3/−1
- Hledger/UI/UIOptions.hs +1/−2
- doc/hledger-ui.1 +48/−52
- doc/hledger-ui.1.info +158/−162
- doc/hledger-ui.1.txt +113/−116
- hledger-ui.cabal +17/−17
CHANGES view
@@ -2,9 +2,18 @@ See also the hledger and project change logs. -# 1.1.2 (2017/1/25)+# 1.2 (2016/3/31) -- allow vty 0.15, brick 0.17 (#494)+Fix a pattern match failure when pressing E on the transaction screen (fixes #508)++Accounts with ? in name had empty registers (fixes #498) (Bryan Richter)++Allow brick 0.16 (Joshua Chia) and brick 0.17/vty 0.15 (Peter Simons)++Allow megaparsec 5.2 (fixes #503)++Allow text-zipper 0.10+ # 1.1.1 (2017/1/20)
Hledger/UI/RegisterScreen.hs view
@@ -281,7 +281,10 @@ where (pos,f) = case listSelectedElement rsList of Nothing -> (endPos, journalFilePath j)- Just (_, RegisterScreenItem{rsItemTransaction=Transaction{tsourcepos=GenericSourcePos f l c}}) -> (Just (l, Just c),f)+ Just (_, RegisterScreenItem{+ rsItemTransaction=Transaction{tsourcepos=GenericSourcePos f l c}}) -> (Just (l, Just c),f)+ Just (_, RegisterScreenItem{+ rsItemTransaction=Transaction{tsourcepos=JournalSourcePos f (l,_)}}) -> (Just (l, Nothing),f) VtyEvent (EvKey (KChar 'H') []) -> continue $ regenerateScreens j d $ toggleHistorical ui VtyEvent (EvKey (KChar 'F') []) -> scrollTop >> (continue $ regenerateScreens j d $ toggleFlat ui) VtyEvent (EvKey (KChar 'Z') []) -> scrollTop >> (continue $ regenerateScreens j d $ toggleEmpty ui)
Hledger/UI/TransactionScreen.hs view
@@ -128,7 +128,9 @@ VtyEvent (EvKey (KChar c) []) | c `elem` ['?'] -> continue $ setMode Help ui VtyEvent (EvKey (KChar 'E') []) -> suspendAndResume $ void (runEditor pos f) >> uiReloadJournalIfChanged copts d j ui where- (pos,f) = let GenericSourcePos f l c = tsourcepos t in (Just (l, Just c),f)+ (pos,f) = case tsourcepos t of+ GenericSourcePos f l c -> (Just (l, Just c),f)+ JournalSourcePos f (l1,_) -> (Just (l1, Nothing),f) AppEvent (DateChange old _) | isStandardPeriod p && p `periodContainsDate` old -> continue $ regenerateScreens j d $ setReportPeriod (DayPeriod d) ui where
Hledger/UI/UIOptions.hs view
@@ -39,7 +39,6 @@ -- ,flagReq ["drop"] (\s opts -> Right $ setopt "drop" s opts) "N" "with --flat, omit this many leading account name components" -- ,flagReq ["format"] (\s opts -> Right $ setopt "format" s opts) "FORMATSTR" "use this custom line format" -- ,flagNone ["no-elide"] (\opts -> setboolopt "no-elide" opts) "don't compress empty parent accounts on one line"- ,flagNone ["value","V"] (setboolopt "value") "show amounts as their current market value in their default valuation commodity (accounts screen)" ] --uimode :: Mode [([Char], [Char])]@@ -81,7 +80,7 @@ checkUIOpts :: UIOpts -> UIOpts checkUIOpts opts =- either optserror (const opts) $ do+ either usageError (const opts) $ do case maybestringopt "theme" $ rawopts_ $ cliopts_ opts of Just t | not $ elem t themeNames -> Left $ "invalid theme name: "++t _ -> Right ()
doc/hledger-ui.1 view
@@ -1,5 +1,5 @@ -.TH "hledger\-ui" "1" "January 2017" "hledger\-ui 1.1.2" "hledger User Manuals"+.TH "hledger\-ui" "1" "March 2017" "hledger\-ui 1.2" "hledger User Manuals" @@ -63,64 +63,38 @@ show full account names, unindented .RS .RE-.TP-.B \f[C]\-V\ \-\-value\f[]-show amounts as their current market value in their default valuation-commodity (accounts screen only)-.RS-.RE .PP-hledger general options:-.TP-.B \f[C]\-h\f[]-show general usage (or after COMMAND, the command\[aq]s usage)-.RS-.RE-.TP-.B \f[C]\-\-help\f[]-show the current program\[aq]s manual as plain text (or after an add\-on-COMMAND, the add\-on\[aq]s manual)-.RS-.RE-.TP-.B \f[C]\-\-man\f[]-show the current program\[aq]s manual with man-.RS-.RE-.TP-.B \f[C]\-\-info\f[]-show the current program\[aq]s manual with info-.RS-.RE+hledger input options: .TP-.B \f[C]\-\-version\f[]-show version+.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]+use a different input file.+For stdin, use \- (default: \f[C]$LEDGER_FILE\f[] or+\f[C]$HOME/.hledger.journal\f[]) .RS .RE .TP-.B \f[C]\-\-debug[=N]\f[]-show debug output (levels 1\-9, default: 1)+.B \f[C]\-\-rules\-file=RULESFILE\f[]+Conversion rules file to use when reading CSV (default: FILE.rules) .RS .RE .TP-.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]-use a different input file.-For stdin, use \-+.B \f[C]\-\-alias=OLD=NEW\f[]+rename accounts named OLD to NEW .RS .RE .TP-.B \f[C]\-\-rules\-file=RULESFILE\f[]-Conversion rules file to use when reading CSV (default: FILE.rules)+.B \f[C]\-\-anon\f[]+anonymize accounts and payees .RS .RE .TP-.B \f[C]\-\-alias=OLD=NEW\f[]-display accounts named OLD as NEW+.B \f[C]\-\-pivot\ TAGNAME\f[]+use some other field/tag for account names .RS .RE .TP .B \f[C]\-I\ \-\-ignore\-assertions\f[]-ignore any failing balance assertions in the journal+ignore any failing balance assertions .RS .RE .PP@@ -208,20 +182,42 @@ .RS .RE .TP-.B \f[C]\-\-pivot\ TAG\f[]-will transform the journal before any other processing by replacing the-account name of every posting having the tag TAG with content VALUE by-the account name "TAG:VALUE".-The TAG will only match if it is a full\-length match.-The pivot will only happen if the TAG is on a posting, not if it is on-the transaction.-If the tag value is a multi:level:account:name the new account name will-be "TAG:multi:level:account:name".+.B \f[C]\-V\ \-\-value\f[]+convert amounts to their market value on the report end date (using the+most recent applicable market price, if any) .RS .RE+.PP+hledger help options: .TP-.B \f[C]\-\-anon\f[]-show anonymized accounts and payees+.B \f[C]\-h\f[]+show general usage (or after COMMAND, command usage)+.RS+.RE+.TP+.B \f[C]\-\-help\f[]+show this program\[aq]s manual as plain text (or after an add\-on+COMMAND, the add\-on\[aq]s manual)+.RS+.RE+.TP+.B \f[C]\-\-man\f[]+show this program\[aq]s manual with man+.RS+.RE+.TP+.B \f[C]\-\-info\f[]+show this program\[aq]s manual with info+.RS+.RE+.TP+.B \f[C]\-\-version\f[]+show version+.RS+.RE+.TP+.B \f[C]\-\-debug[=N]\f[]+show debug output (levels 1\-9, default: 1) .RS .RE .SH KEYS
doc/hledger-ui.1.info view
@@ -1,24 +1,22 @@-This is hledger-ui/doc/hledger-ui.1.info, produced by makeinfo version-4.8 from stdin.+This is hledger-ui.1.info, produced by makeinfo version 6.0 from stdin. -File: hledger-ui.1.info, Node: Top, Up: (dir)+File: hledger-ui.1.info, Node: Top, Next: OPTIONS, Up: (dir) -hledger-ui(1) hledger-ui 1.1.2-******************************+hledger-ui(1) hledger-ui 1.2+**************************** hledger-ui is hledger's curses-style 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.- * Menu: * OPTIONS::@@ -31,186 +29,187 @@ 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+'--flat' -`--flat' show full account names, unindented -`-V --value'- show amounts as their current market value in their default- valuation commodity (accounts screen only)-- hledger general options:--`-h'- show general usage (or after COMMAND, the command's usage)--`--help'- show the current program's manual as plain text (or after an add-on- COMMAND, the add-on's manual)--`--man'- show the current program's manual with man+ hledger input options: -`--info'- show the current program's manual with info+'-f FILE --file=FILE' -`--version'- show version+ use a different input file. For stdin, use - (default:+ '$LEDGER_FILE' or '$HOME/.hledger.journal')+'--rules-file=RULESFILE' -`--debug[=N]'- show debug output (levels 1-9, default: 1)+ Conversion rules file to use when reading CSV (default: FILE.rules)+'--alias=OLD=NEW' -`-f FILE --file=FILE'- use a different input file. For stdin, use -+ rename accounts named OLD to NEW+'--anon' -`--rules-file=RULESFILE'- Conversion rules file to use when reading CSV (default: FILE.rules)+ anonymize accounts and payees+'--pivot TAGNAME' -`--alias=OLD=NEW'- display accounts named OLD as NEW+ use some other field/tag for account names+'-I --ignore-assertions' -`-I --ignore-assertions'- ignore any failing balance assertions in the journal+ ignore any failing balance assertions 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 (overrides the flags above)+'--date2' -`--date2' show, and match with -b/-e/-p/date:, secondary dates instead+'-C --cleared' -`-C --cleared' include only cleared postings/txns+'--pending' -`--pending' include only pending postings/txns+'-U --uncleared' -`-U --uncleared' include only uncleared (and pending) postings/txns+'-R --real' -`-R --real' include only non-virtual postings+'--depth=N' -`--depth=N' hide accounts/postings deeper than N+'-E --empty' -`-E --empty' show items with zero amount, normally hidden+'-B --cost' -`-B --cost' convert amounts to their cost at transaction time (using the transaction price, if any)+'-V --value' -`--pivot TAG'- will transform the journal before any other processing by- replacing the account name of every posting having the tag TAG- with content VALUE by the account name "TAG:VALUE". The TAG will- only match if it is a full-length match. The pivot will only- happen if the TAG is on a posting, not if it is on the- transaction. If the tag value is a multi:level:account:name the- new account name will be "TAG:multi:level:account:name".+ convert amounts to their market value on the report end date (using+ the most recent applicable market price, if any) -`--anon'- show anonymized accounts and payees+ hledger help options: +'-h'++ show general usage (or after COMMAND, command usage)+'--help'++ show this program's manual as plain text (or after an add-on+ COMMAND, the add-on's manual)+'--man'++ show this program's manual with man+'--info'++ show this program's manual with info+'--version'++ show version+'--debug[=N]'++ show debug output (levels 1-9, default: 1)+ File: hledger-ui.1.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') to close it. The following keys work on most+'?' 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') 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. Vi-style-`h'/`j'/`k'/`l' movement keys are also supported. A tip: movement speed+ 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. Vi-style+'h'/'j'/'k'/'l' 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're on a mac, the Karabiner app is one way to do+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 cleared/uncleared (see-below). `BACKSPACE' or `DELETE' removes all filters, showing all+below). 'BACKSPACE' or 'DELETE' removes all filters, showing all transactions. - `ESCAPE' removes all filters and jumps back to the top screen. Or,+ 'ESCAPE' removes all filters and jumps back to the top screen. Or, it cancels a minibuffer edit or help dialog in progress. - `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. - `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. - `q' quits the application.+ 'q' quits the application. Additional screen-specific keys are described below. @@ -233,45 +232,45 @@ 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 normally indented to show the hierarchy (tree mode). To see less detail, set a depth limit by pressing a number key,-`1' to `9'. `0' shows even less detail, collapsing all accounts to a-single total. `-' and `+' (or `=') decrease and increase the depth-limit. To remove the depth limit, set it higher than the maximum-account depth, or press `ESCAPE'.+'1' to '9'. '0' shows even less detail, collapsing all accounts to a+single total. '-' and '+' (or '=') decrease and increase the depth+limit. To remove the depth limit, set it higher than the maximum+account depth, or press 'ESCAPE'. - `F' toggles flat mode, in which accounts are shown as a flat list,-with their full names. In this mode, account balances exclude+ 'F' toggles flat mode, in which accounts are shown as a flat list,+with their full names. In this mode, account balances exclude subaccounts, except for accounts at the depth limit (as with hledger's balance command). - `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.+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. - `C' toggles cleared mode, in which uncleared transactions and-postings are not shown. `U' toggles uncleared mode, in which only+ 'C' toggles cleared mode, in which uncleared transactions and+postings are not shown. 'U' toggles uncleared mode, in which only uncleared transactions/postings are shown. - `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.1.info, Node: Register screen, Next: Transaction screen, Prev: Accounts screen, Up: SCREENS@@ -280,44 +279,42 @@ =================== 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. If the accounts screen was in tree mode, the register screen will include transactions from both the current account and its subaccounts. If the accounts screen was in flat mode, and a non-depth-clipped account was selected, the register screen will exclude transactions from-subaccounts. In other words, the register always shows the transactions-responsible for the period balance shown on the accounts screen. As on-the accounts screen, this can be toggled with `F'.+subaccounts. In other words, the register always shows the transactions+responsible for the period balance shown on the accounts screen. As on+the accounts screen, this can be toggled with 'F'. - `C' toggles cleared mode, in which uncleared transactions and-postings are not shown. `U' toggles uncleared mode, in which only+ 'C' toggles cleared mode, in which uncleared transactions and+postings are not shown. 'U' toggles uncleared mode, in which only uncleared transactions/postings are shown. - `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. @@ -335,11 +332,11 @@ 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).@@ -351,27 +348,26 @@ ================ 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.) - Tag Table:-Node: Top88-Node: OPTIONS827-Ref: #options926-Node: KEYS4005-Ref: #keys4102-Node: SCREENS6672-Ref: #screens6759-Node: Accounts screen6849-Ref: #accounts-screen6979-Node: Register screen9017-Ref: #register-screen9174-Node: Transaction screen11062-Ref: #transaction-screen11222-Node: Error screen12089-Ref: #error-screen12213+Node: Top73+Node: OPTIONS825+Ref: #options924+Node: KEYS3650+Ref: #keys3747+Node: SCREENS6335+Ref: #screens6422+Node: Accounts screen6512+Ref: #accounts-screen6642+Node: Register screen8691+Ref: #register-screen8848+Node: Transaction screen10737+Ref: #transaction-screen10897+Node: Error screen11767+Ref: #error-screen11891 End Tag Table
doc/hledger-ui.1.txt view
@@ -50,39 +50,26 @@ --flat show full account names, unindented - -V --value- show amounts as their current market value in their default val-- uation commodity (accounts screen only)-- hledger general options:-- -h show general usage (or after COMMAND, the command's usage)-- --help show the current program's manual as plain text (or after an- add-on COMMAND, the add-on's manual)-- --man show the current program's manual with man-- --info show the current program's manual with info-- --version- show version-- --debug[=N]- show debug output (levels 1-9, default: 1)+ hledger input options: -f FILE --file=FILE- use a different input file. For stdin, use -+ 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:+ Conversion rules file to use when reading CSV (default: FILE.rules) --alias=OLD=NEW- display accounts named OLD as NEW+ rename accounts named OLD to NEW + --anon anonymize accounts and payees++ --pivot TAGNAME+ use some other field/tag for account names+ -I --ignore-assertions- ignore any failing balance assertions in the journal+ ignore any failing balance assertions hledger reporting options: @@ -108,7 +95,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 (overrides the flags above) --date2@@ -133,66 +120,76 @@ show items with zero amount, normally hidden -B --cost- convert amounts to their cost at transaction time (using the+ convert amounts to their cost at transaction time (using the transaction price, if any) - --pivot TAG- will transform the journal before any other processing by- replacing the account name of every posting having the tag TAG- with content VALUE by the account name "TAG:VALUE". The TAG- will only match if it is a full-length match. The pivot will- only happen if the TAG is on a posting, not if it is on the- transaction. If the tag value is a multi:level:account:name the- new account name will be "TAG:multi:level:account:name".+ -V --value+ convert amounts to their market value on the report end date+ (using the most recent applicable market price, if any) - --anon show anonymized accounts and payees+ hledger help options: + -h show general usage (or after COMMAND, command usage)++ --help show this program's manual as plain text (or after an add-on+ COMMAND, the add-on's manual)++ --man show this program's manual with man++ --info show this program's manual with info++ --version+ show version++ --debug[=N]+ show debug output (levels 1-9, default: 1)+ 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) 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. Vi-style h/j/k/l 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're on a mac, the Karabiner+ 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+ 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-stan-+ 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-stan- dard 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 cleared/uncleared (see below).+ common filters like account depth and cleared/uncleared (see below). BACKSPACE or DELETE removes all filters, showing all transactions. - ESCAPE removes all filters and jumps back to the top screen. Or, it+ ESCAPE removes all filters and jumps back to the top screen. Or, it cancels a minibuffer edit or help dialog in progress. - 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. - E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emac-+ E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emac- sclient -a "" -nw) on the journal file. With some editors (emacs, vi),- the cursor will be positioned at the current transaction when invoked- from the register and transaction screens, and at the error location+ 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. q quits the application.@@ -201,42 +198,42 @@ 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 normally indented to show the hierarchy (tree mode).+ Account names are normally indented to show the hierarchy (tree mode). To see less detail, set a depth limit by pressing a number key, 1 to 9. 0 shows even less detail, collapsing all accounts to a single total. -- and + (or =) decrease and increase the depth limit. To remove the- depth limit, set it higher than the maximum account depth, or press+ and + (or =) decrease and increase the depth limit. To remove the+ depth limit, set it higher than the maximum account depth, or press ESCAPE. - F toggles flat mode, in which accounts are shown as a flat list, with- their full names. In this mode, account balances exclude subaccounts,- except for accounts at the depth limit (as with hledger's balance com-+ F toggles flat mode, in which accounts are shown as a flat list, with+ their full names. In this mode, account balances exclude subaccounts,+ except for accounts at the depth limit (as with hledger's balance com- mand). H toggles between showing historical balances or period balances. His-- torical 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+ torical 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. - C toggles cleared mode, in which uncleared transactions and postings- are not shown. U toggles uncleared mode, in which only uncleared+ C toggles cleared mode, in which uncleared transactions and postings+ are not shown. U toggles uncleared mode, in which only uncleared transactions/postings are shown. R toggles real mode, in which virtual postings are ignored. - Z toggles nonzero mode, in which only accounts with nonzero balances- are shown (hledger-ui shows zero items by default, unlike command-line+ 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.@@ -245,62 +242,62 @@ This screen shows the transactions affecting a particular account, like a check register. Each line represents one transaction and shows: - o the other account(s) involved, in abbreviated form. (If there are- both real and virtual postings, it shows only the accounts affected+ o 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.) - o the overall change to the current account's balance; positive for an+ o the overall change to the current account's balance; positive for an inflow to this account, negative for an outflow. o 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+ 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+ a filter query, it will be the running historical balance you would see on a bank register for the current account. - If the accounts screen was in tree mode, the register screen will+ If the accounts screen was in tree mode, the register screen will include transactions from both the current account and its subaccounts.- If the accounts screen was in flat mode, and a non-depth-clipped- account was selected, the register screen will exclude transactions+ If the accounts screen was in flat mode, and a non-depth-clipped+ account was selected, the register screen will exclude transactions from subaccounts. In other words, the register always shows the trans-- actions responsible for the period balance shown on the accounts+ actions responsible for the period balance shown on the accounts screen. As on the accounts screen, this can be toggled with F. - C toggles cleared mode, in which uncleared transactions and postings- are not shown. U toggles uncleared mode, in which only uncleared+ C toggles cleared mode, in which uncleared transactions and postings+ are not shown. U toggles uncleared mode, in which only uncleared transactions/postings are shown. 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,- description, comments, along with all of its account postings are- shown. Simple transactions have two postings, but there can be more+ 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+ 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.) @@ -308,17 +305,17 @@ 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). FILES- Reads data from one or more files in hledger journal, timeclock, time-- dot, or CSV format specified with -f, or $LEDGER_FILE, or- $HOME/.hledger.journal (on windows, perhaps+ Reads data from one or more files in hledger journal, timeclock, time-+ dot, or CSV format specified with -f, or $LEDGER_FILE, or+ $HOME/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.journal). BUGS- The need to precede options with -- when invoked from hledger is awk-+ The need to precede options with -- when invoked from hledger is awk- ward. -f- doesn't work (hledger-ui can't read from stdin).@@ -326,13 +323,13 @@ -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 there is no+ 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, 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. Symp-- toms include: unresponsive UI, periodic resetting of the cursor posi-+ --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. Symp-+ toms include: unresponsive UI, periodic resetting of the cursor posi- tion, momentary display of parse errors, high CPU usage eventually sub- siding, and possibly a small but persistent build-up of CPU usage until the program is restarted.@@ -340,7 +337,7 @@ REPORTING BUGS- Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel+ Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel or hledger mail list) @@ -354,7 +351,7 @@ SEE ALSO- hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),+ hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- dot(5), ledger(1) @@ -362,4 +359,4 @@ -hledger-ui 1.1.2 January 2017 hledger-ui(1)+hledger-ui 1.2 March 2017 hledger-ui(1)
hledger-ui.cabal view
@@ -1,11 +1,9 @@--- This file has been generated from package.yaml by hpack version 0.15.0.+-- This file has been generated from package.yaml by hpack version 0.17.0. -- -- see: https://github.com/sol/hpack name: hledger-ui-version: 1.1.2-stability: stable-category: Finance, Console+version: 1.2 synopsis: Curses-style user interface for the hledger accounting tool description: This is hledger's curses-style interface. It is simpler and more convenient for browsing data than the command-line interface,@@ -17,15 +15,17 @@ with ledger(1). hledger provides command-line, curses and web interfaces, and aims to be a reliable, practical tool for daily use.-license: GPL-license-file: LICENSE-author: Simon Michael <simon@joyful.com>-maintainer: Simon Michael <simon@joyful.com>+category: Finance, Console+stability: stable homepage: http://hledger.org bug-reports: http://bugs.hledger.org-cabal-version: >= 1.10-build-type: Simple+author: Simon Michael <simon@joyful.com>+maintainer: Simon Michael <simon@joyful.com>+license: GPL-3+license-file: LICENSE tested-with: GHC==7.10.3, GHC==8.0+build-type: Simple+cabal-version: >= 1.10 extra-source-files: CHANGES@@ -46,19 +46,19 @@ default: False flag threaded- default: True description: Build with support for multithreaded execution manual: False+ default: True executable hledger-ui main-is: hledger-ui.hs 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.1.2"+ cpp-options: -DVERSION="1.2" build-depends:- hledger >= 1.1 && < 1.2- , hledger-lib >= 1.1 && < 1.2+ hledger >= 1.2 && < 1.3+ , hledger-lib >= 1.2 && < 1.3 , ansi-terminal >= 0.6.2.3 && < 0.7 , async , base >= 4.8 && < 5@@ -72,13 +72,13 @@ , HUnit , microlens >= 0.4 && < 0.5 , microlens-platform >= 0.2.3.1 && < 0.4- , megaparsec >=5.0 && < 5.2+ , megaparsec >=5.0 && < 5.3 , pretty-show >=1.6.4 , process >= 1.2 , safe >= 0.2 , split >= 0.1 && < 0.3 , text >= 1.2 && < 1.3- , text-zipper >= 0.4 && < 0.10+ , text-zipper >= 0.4 && < 0.11 , transformers , vector if os(windows)