diff --git a/CHANGES.md b/CHANGES.md --- a/CHANGES.md +++ b/CHANGES.md @@ -1,6 +1,12 @@ User-visible changes in hledger-ui. See also the hledger changelog. +# 1.15 2019-09-01 + +- allow brick >=0.47 + +- use hledger 1.15 + # 1.14.2 2019-03-20 - support brick 0.47+ as well, to get into stackage nightly. diff --git a/Hledger/UI/AccountsScreen.hs b/Hledger/UI/AccountsScreen.hs --- a/Hledger/UI/AccountsScreen.hs +++ b/Hledger/UI/AccountsScreen.hs @@ -71,7 +71,7 @@ selidx = case (reset, listSelectedElement $ _asList s) of (True, _) -> 0 (_, Nothing) -> 0 - (_, Just (_,AccountsScreenItem{asItemAccountName=a})) -> + (_, Just (_,AccountsScreenItem{asItemAccountName=a})) -> headDef 0 $ catMaybes [ findIndex (a ==) as ,findIndex (a `isAccountNamePrefixOf`) as @@ -88,8 +88,8 @@ pfq | presentorfuture_ uopts == PFFuture = Any | otherwise = Date $ DateSpan Nothing (Just $ addDays 1 d) q = And [queryFromOpts d ropts, pfq] - + -- run the report (items,_total) = report ropts' q j where @@ -104,14 +104,14 @@ displayitem (fullacct, shortacct, indent, bal) = AccountsScreenItem{asItemIndentLevel = indent ,asItemAccountName = fullacct - ,asItemDisplayAccountName = replaceHiddenAccountsNameWith "All" $ if tree_ ropts' then shortacct else fullacct + ,asItemDisplayAccountName = replaceHiddenAccountsNameWith "All" $ if tree_ ropts' then shortacct else fullacct ,asItemRenderedAmounts = map showAmountWithoutPrice amts -- like showMixedAmountOneLineWithoutPrice } where Mixed amts = normaliseMixedAmountSquashPricesForDisplay $ stripPrices bal - stripPrices (Mixed as) = Mixed $ map stripprice as where stripprice a = a{aprice=NoPrice} + stripPrices (Mixed as) = Mixed $ map stripprice as where stripprice a = a{aprice=Nothing} displayitems = map displayitem items - -- blanks added for scrolling control, cf RegisterScreen + -- blanks added for scrolling control, cf RegisterScreen blankitems = replicate 100 AccountsScreenItem{asItemIndentLevel = 0 ,asItemAccountName = "" @@ -201,7 +201,7 @@ curidx = case _asList s ^. listSelectedL of Nothing -> "-" Just i -> show (i + 1) - totidx = show $ V.length nonblanks + totidx = show $ V.length nonblanks where nonblanks = V.takeWhile (not . T.null . asItemAccountName) $ s ^. asList . listElementsL @@ -215,7 +215,7 @@ ,("-+", str "depth") ,("T", renderToggle (tree_ ropts) "flat" "tree") ,("H", renderToggle (not ishistorical) "end-bals" "changes") - ,("F", renderToggle (presentorfuture_ uopts == PFFuture) "present" "future") + ,("F", renderToggle (presentorfuture_ uopts == PFFuture) "present" "future") --,("/", "filter") --,("DEL", "unfilter") --,("ESC", "cancel/top") @@ -346,14 +346,14 @@ VtyEvent (EvKey (KChar 'l') [MCtrl]) -> scrollSelectionToMiddle _asList >> redraw ui VtyEvent (EvKey (KChar 'z') [MCtrl]) -> suspend ui - -- enter register screen for selected account (if there is one), + -- enter register screen for selected account (if there is one), -- centering its selected transaction if possible - VtyEvent e | e `elem` moveRightEvents + VtyEvent e | e `elem` moveRightEvents , not $ isBlankElement $ listSelectedElement _asList-> - -- TODO center selection after entering register screen; neither of these works till second time entering; easy strictifications didn't help - rsCenterAndContinue $ + -- TODO center selection after entering register screen; neither of these works till second time entering; easy strictifications didn't help + rsCenterAndContinue $ -- flip rsHandle (VtyEvent (EvKey (KChar 'l') [MCtrl])) $ - screenEnter d regscr ui + screenEnter d regscr ui where regscr = rsSetAccount selacct isdepthclipped registerScreen isdepthclipped = case getDepth ui of @@ -363,9 +363,9 @@ -- prevent moving down over blank padding items; -- instead scroll down by one, until maximally scrolled - shows the end has been reached VtyEvent (EvKey (KDown) []) | isBlankElement mnextelement -> do - vScrollBy (viewportScroll $ _asList^.listNameL) 1 + vScrollBy (viewportScroll $ _asList^.listNameL) 1 continue ui - where + where mnextelement = listSelectedElement $ listMoveDown _asList -- if page down or end leads to a blank padding item, stop at last non-blank @@ -378,7 +378,7 @@ continue ui{aScreen=scr{_asList=list'}} else continue ui{aScreen=scr{_asList=list}} - + -- fall through to the list's event handler (handles up/down) VtyEvent ev -> do newitems <- handleListEvent (normaliseMovementKeys ev) _asList @@ -398,7 +398,7 @@ asSetSelectedAccount a s@AccountsScreen{} = s & asSelectedAccount .~ a asSetSelectedAccount _ s = s -isBlankElement mel = ((asItemAccountName . snd) <$> mel) == Just "" +isBlankElement mel = ((asItemAccountName . snd) <$> mel) == Just "" asCenterAndContinue ui = do scrollSelectionToMiddle $ _asList $ aScreen ui diff --git a/Hledger/UI/Main.hs b/Hledger/UI/Main.hs --- a/Hledger/UI/Main.hs +++ b/Hledger/UI/Main.hs @@ -163,7 +163,7 @@ } -- print (length (show ui)) >> exitSuccess -- show any debug output to this point & quit - + if not (watch_ uopts') then void $ defaultMain brickapp ui diff --git a/Hledger/UI/RegisterScreen.hs b/Hledger/UI/RegisterScreen.hs --- a/Hledger/UI/RegisterScreen.hs +++ b/Hledger/UI/RegisterScreen.hs @@ -112,10 +112,10 @@ -- otherwise, the previously selected transaction if possible; -- otherwise, the transaction nearest in date to it; -- or if there's several with the same date, the nearest in journal order; - -- otherwise, the last (latest) transaction. + -- otherwise, the last (latest) transaction. newitems' = listMoveTo newselidx newitems where - newselidx = + newselidx = case (reset, listSelectedElement rsList) of (True, _) -> endidx (_, Nothing) -> endidx @@ -164,7 +164,7 @@ changewidthproportion = fromIntegral maxchangewidthseen / fromIntegral (maxchangewidthseen + maxbalwidthseen) maxchangewidth = round $ changewidthproportion * fromIntegral maxamtswidth maxbalwidth = maxamtswidth - maxchangewidth - changewidth = min maxchangewidth maxchangewidthseen + changewidth = min maxchangewidth maxchangewidthseen balwidth = min maxbalwidth maxbalwidthseen -- assign the remaining space to the description and accounts columns -- maxdescacctswidth = totalwidth - (whitespacewidth - 4) - changewidth - balwidth @@ -177,7 +177,7 @@ -- descwidthproportion = (descwidth' + acctswidth') / descwidth' -- maxdescwidth = min (maxdescacctswidth - 7) (maxdescacctswidth / descwidthproportion) -- maxacctswidth = maxdescacctswidth - maxdescwidth - -- descwidth = min maxdescwidth descwidth' + -- descwidth = min maxdescwidth descwidth' -- acctswidth = min maxacctswidth acctswidth' -- allocating equally. descwidth = maxdescacctswidth `div` 2 @@ -232,7 +232,7 @@ -- ,("RIGHT", str "transaction") ,("T", renderToggle (tree_ ropts) "flat(-subs)" "tree(+subs)") -- rsForceInclusive may override, but use tree_ to ensure a visible toggle effect ,("H", renderToggle (not ishistorical) "historical" "period") - ,("F", renderToggle (presentorfuture_ uopts == PFFuture) "present" "future") + ,("F", renderToggle (presentorfuture_ uopts == PFFuture) "present" "future") -- ,("a", "add") -- ,("g", "reload") -- ,("q", "quit") @@ -271,11 +271,11 @@ ,aMode=mode } ev = do d <- liftIO getCurrentDay - let + let journalspan = journalDateSpan False j nonblanks = V.takeWhile (not . null . rsItemDate) $ rsList^.listElementsL lastnonblankidx = max 0 (length nonblanks - 1) - + case mode of Minibuffer ed -> case ev of @@ -358,9 +358,9 @@ -- prevent moving down over blank padding items; -- instead scroll down by one, until maximally scrolled - shows the end has been reached VtyEvent e | e `elem` moveDownEvents, isBlankElement mnextelement -> do - vScrollBy (viewportScroll $ rsList^.listNameL) 1 + vScrollBy (viewportScroll $ rsList^.listNameL) 1 continue ui - where + where mnextelement = listSelectedElement $ listMoveDown rsList -- if page down or end leads to a blank padding item, stop at last non-blank @@ -373,7 +373,7 @@ continue ui{aScreen=s{rsList=list'}} else continue ui{aScreen=s{rsList=list}} - + -- fall through to the list's event handler (handles other [pg]up/down events) VtyEvent ev -> do let ev' = normaliseMovementKeys ev @@ -386,7 +386,7 @@ rsHandle _ _ = error "event handler called with wrong screen type, should not happen" -isBlankElement mel = ((rsItemDate . snd) <$> mel) == Just "" +isBlankElement mel = ((rsItemDate . snd) <$> mel) == Just "" rsCenterAndContinue ui = do scrollSelectionToMiddle $ rsList $ aScreen ui diff --git a/Hledger/UI/Theme.hs b/Hledger/UI/Theme.hs --- a/Hledger/UI/Theme.hs +++ b/Hledger/UI/Theme.hs @@ -73,7 +73,7 @@ ,("border" <> "bold" , currentAttr & bold) ,("border" <> "depth" , active) ,("border" <> "filename" , currentAttr) - ,("border" <> "key" , active) + ,("border" <> "key" , active) ,("border" <> "minibuffer" , white `on` black & bold) ,("border" <> "query" , active) ,("border" <> "selected" , active) diff --git a/Hledger/UI/TransactionScreen.hs b/Hledger/UI/TransactionScreen.hs --- a/Hledger/UI/TransactionScreen.hs +++ b/Hledger/UI/TransactionScreen.hs @@ -136,7 +136,7 @@ where (pos,f) = case tsourcepos t of GenericSourcePos f l c -> (Just (l, Just c),f) - JournalSourcePos f (l1,_) -> (Just (l1, Nothing),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 diff --git a/Hledger/UI/UIOptions.hs b/Hledger/UI/UIOptions.hs --- a/Hledger/UI/UIOptions.hs +++ b/Hledger/UI/UIOptions.hs @@ -51,7 +51,7 @@ (argsFlag "[PATTERNS]") []){ modeGroupFlags = Group { groupUnnamed = uiflags - ,groupHidden = [] + ,groupHidden = hiddenflags ,groupNamed = [(generalflagsgroup1)] } ,modeHelpSuffix=[ @@ -85,7 +85,7 @@ ,cliopts_ = cliopts } --- | Should transactions dated later than today be included ? +-- | Should transactions dated later than today be included ? -- Like flat/tree mode, there are three states, and the meaning of default can vary by command. data PresentOrFutureOpt = PFDefault | PFPresent | PFFuture deriving (Eq, Show, Data, Typeable) instance Default PresentOrFutureOpt where def = PFDefault @@ -109,7 +109,7 @@ --getHledgerUIOpts = processArgs uimode >>= return . decodeRawOpts >>= rawOptsToUIOpts getHledgerUIOpts = do args <- getArgs >>= expandArgsAt - let args' = replaceNumericFlags args + let args' = replaceNumericFlags args let cmdargopts = either usageError id $ process uimode args' - rawOptsToUIOpts $ decodeRawOpts cmdargopts + rawOptsToUIOpts $ decodeRawOpts cmdargopts diff --git a/Hledger/UI/UIState.hs b/Hledger/UI/UIState.hs --- a/Hledger/UI/UIState.hs +++ b/Hledger/UI/UIState.hs @@ -35,15 +35,15 @@ toggleCleared ui@UIState{aopts=uopts@UIOpts{cliopts_=copts@CliOpts{reportopts_=ropts}}} = ui{aopts=uopts{cliopts_=copts{reportopts_=reportOptsToggleStatusSomehow Cleared copts ropts}}} --- TODO testing different status toggle styles +-- TODO testing different status toggle styles --- | Generate zero or more indicators of the status filters currently active, +-- | Generate zero or more indicators of the status filters currently active, -- which will be shown comma-separated as part of the indicators list. uiShowStatus :: CliOpts -> [Status] -> [String] uiShowStatus copts ss = case style of - -- in style 2, instead of "Y, Z" show "not X" - Just 2 | length ss == numstatuses-1 + -- in style 2, instead of "Y, Z" show "not X" + Just 2 | length ss == numstatuses-1 -> map (("not "++). showstatus) $ sort $ complement ss -- should be just one _ -> map showstatus $ sort ss where @@ -55,7 +55,7 @@ reportOptsToggleStatusSomehow :: Status -> CliOpts -> ReportOpts -> ReportOpts reportOptsToggleStatusSomehow s copts ropts = - case maybeintopt "status-toggles" $ rawopts_ copts of + case maybeintopt "status-toggles" $ rawopts_ copts of Just 2 -> reportOptsToggleStatus2 s ropts Just 3 -> reportOptsToggleStatus3 s ropts -- Just 4 -> reportOptsToggleStatus4 s ropts @@ -78,7 +78,7 @@ reportOptsToggleStatus2 s ropts@ReportOpts{statuses_=ss} | ss == [s] = ropts{statuses_=complement [s]} | ss == complement [s] = ropts{statuses_=[]} - | otherwise = ropts{statuses_=[s]} -- XXX assume only three values + | otherwise = ropts{statuses_=[s]} -- XXX assume only three values -- 3 UPC toggles each X reportOptsToggleStatus3 s ropts@ReportOpts{statuses_=ss} diff --git a/Hledger/UI/UIUtils.hs b/Hledger/UI/UIUtils.hs --- a/Hledger/UI/UIUtils.hs +++ b/Hledger/UI/UIUtils.hs @@ -59,7 +59,7 @@ #else import System.Posix.Signals suspendSignal :: IO () -suspendSignal = raiseSignal sigSTOP +suspendSignal = raiseSignal sigSTOP #endif -- | On posix platforms, suspend the program using the STOP signal, @@ -121,7 +121,7 @@ vBox [ withAttr ("help" <> "heading") $ str "Filtering" ,renderKey ("/ ", "set a filter query") - ,renderKey ("UPC ", "show unmarked/pending/cleared") + ,renderKey ("UPC ", "show unmarked/pending/cleared") ,renderKey ("F ", "show future/present txns") ,renderKey ("R ", "show real/all postings") ,renderKey ("Z ", "show nonzero/all amounts") @@ -208,12 +208,12 @@ -- sep = str " | " sep = str " " --- | Render the two states of a toggle, highlighting the active one. +-- | Render the two states of a toggle, highlighting the active one. renderToggle :: Bool -> String -> String -> Widget Name renderToggle isright l r = let bold = withAttr ("border" <> "selected") in if isright - then str (l++"/") <+> bold (str r) + then str (l++"/") <+> bold (str r) else bold (str l) <+> str ("/"++r) -- temporary shenanigans: @@ -310,13 +310,13 @@ --scrollToTop :: List Name e -> EventM Name () --scrollToTop list = do -- let vpname = list^.listNameL --- setTop (viewportScroll vpname) 0 +-- setTop (viewportScroll vpname) 0 -- | Scroll a list's viewport so that the selected item is centered in the -- middle of the display area. scrollSelectionToMiddle :: List Name e -> EventM Name () scrollSelectionToMiddle list = do - let mselectedrow = list^.listSelectedL + let mselectedrow = list^.listSelectedL vpname = list^.listNameL mvp <- lookupViewport vpname case (mselectedrow, mvp) of @@ -326,7 +326,7 @@ vpheight = dbg4 "vpheight" $ vp^.vpSize._2 itemsperpage = dbg4 "itemsperpage" $ vpheight `div` itemheight toprow = dbg4 "toprow" $ max 0 (selectedrow - (itemsperpage `div` 2)) -- assuming ViewportScroll's row offset is measured in list items not screen rows - setTop (viewportScroll vpname) toprow + setTop (viewportScroll vpname) toprow _ -> return () -- arrow keys vi keys emacs keys diff --git a/hledger-ui.1 b/hledger-ui.1 --- a/hledger-ui.1 +++ b/hledger-ui.1 @@ -1,227 +1,161 @@ -.TH "hledger\-ui" "1" "March 2019" "hledger\-ui 1.14" "hledger User Manuals" +.TH "hledger-ui" "1" "August 2019" "hledger-ui 1.15" "hledger User Manuals" .SH NAME .PP -hledger\-ui \- curses\-style interface for the hledger accounting tool +hledger-ui - curses-style interface for the hledger accounting tool .SH SYNOPSIS .PP -\f[C]hledger\-ui\ [OPTIONS]\ [QUERYARGS]\f[] +\f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R] .PD 0 .P .PD -\f[C]hledger\ ui\ \-\-\ [OPTIONS]\ [QUERYARGS]\f[] +\f[C]hledger ui -- [OPTIONS] [QUERYARGS]\f[R] .SH DESCRIPTION .PP -hledger is a cross\-platform program for tracking money, time, or any -other commodity, using double\-entry accounting and a simple, editable +hledger is a cross-platform program 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). .PP -hledger\-ui is hledger\[aq]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\[aq]s command\-line interface, and sometimes +hledger-ui is hledger\[aq]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\[aq]s command-line interface, and sometimes quicker and more convenient than the web interface. .PP -Note hledger\-ui has some different defaults (experimental): +Note hledger-ui has some different defaults (experimental): .IP \[bu] 2 -it generates rule\-based transactions and postings by default -(\-\-forecast and \-\-auto are always on). +it generates rule-based transactions and postings by default (--forecast +and --auto are always on). .IP \[bu] 2 it hides transactions dated in the future by default (change this with -\-\-future or the F key). +--future or the F key). .PP Like hledger, it reads data from one or more files in hledger journal, -timeclock, timedot, or CSV format specified with \f[C]\-f\f[], or -\f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows, -perhaps \f[C]C:/Users/USER/.hledger.journal\f[]). +timeclock, timedot, or CSV format specified with \f[C]-f\f[R], or +\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, +perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). For more about this see hledger(1), hledger_journal(5) etc. .SH OPTIONS .PP -Note: if invoking hledger\-ui as a hledger subcommand, write -\f[C]\-\-\f[] before options as shown above. +Note: if invoking hledger-ui as a hledger subcommand, write \f[C]--\f[R] +before options as shown above. .PP Any QUERYARGS are interpreted as a hledger search query which filters the data. .TP -.B \f[C]\-\-watch\f[] +.B \f[C]--watch\f[R] watch for data and date changes and reload automatically -.RS -.RE .TP -.B \f[C]\-\-theme=default|terminal|greenterm\f[] +.B \f[C]--theme=default|terminal|greenterm\f[R] use this custom display theme -.RS -.RE .TP -.B \f[C]\-\-register=ACCTREGEX\f[] +.B \f[C]--register=ACCTREGEX\f[R] start in the (first) matched account\[aq]s register screen -.RS -.RE .TP -.B \f[C]\-\-change\f[] +.B \f[C]--change\f[R] show period balances (changes) at startup instead of historical balances -.RS -.RE .TP -.B \f[C]\-F\ \-\-flat\f[] +.B \f[C]-F --flat\f[R] show accounts as a list (default) -.RS -.RE .TP -.B \f[C]\-T\ \-\-tree\f[] +.B \f[C]-T --tree\f[R] show accounts as a tree -.RS -.RE .TP -.B \f[C]\-\-future\f[] +.B \f[C]--future\f[R] show transactions dated later than today (normally hidden) -.RS -.RE .PP hledger input options: .TP -.B \f[C]\-f\ FILE\ \-\-file=FILE\f[] +.B \f[C]-f FILE --file=FILE\f[R] use a different input file. -For stdin, use \- (default: \f[C]$LEDGER_FILE\f[] or -\f[C]$HOME/.hledger.journal\f[]) -.RS -.RE +For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or +\f[C]$HOME/.hledger.journal\f[R]) .TP -.B \f[C]\-\-rules\-file=RULESFILE\f[] +.B \f[C]--rules-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) -.RS -.RE .TP -.B \f[C]\-\-separator=CHAR\f[] +.B \f[C]--separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) -.RS -.RE .TP -.B \f[C]\-\-alias=OLD=NEW\f[] +.B \f[C]--alias=OLD=NEW\f[R] rename accounts named OLD to NEW -.RS -.RE .TP -.B \f[C]\-\-anon\f[] +.B \f[C]--anon\f[R] anonymize accounts and payees -.RS -.RE .TP -.B \f[C]\-\-pivot\ FIELDNAME\f[] +.B \f[C]--pivot FIELDNAME\f[R] use some other field or tag for the account name -.RS -.RE .TP -.B \f[C]\-I\ \-\-ignore\-assertions\f[] +.B \f[C]-I --ignore-assertions\f[R] ignore any failing balance assertions -.RS -.RE .PP hledger reporting options: .TP -.B \f[C]\-b\ \-\-begin=DATE\f[] +.B \f[C]-b --begin=DATE\f[R] include postings/txns on or after this date -.RS -.RE .TP -.B \f[C]\-e\ \-\-end=DATE\f[] +.B \f[C]-e --end=DATE\f[R] include postings/txns before this date -.RS -.RE .TP -.B \f[C]\-D\ \-\-daily\f[] +.B \f[C]-D --daily\f[R] multiperiod/multicolumn report by day -.RS -.RE .TP -.B \f[C]\-W\ \-\-weekly\f[] +.B \f[C]-W --weekly\f[R] multiperiod/multicolumn report by week -.RS -.RE .TP -.B \f[C]\-M\ \-\-monthly\f[] +.B \f[C]-M --monthly\f[R] multiperiod/multicolumn report by month -.RS -.RE .TP -.B \f[C]\-Q\ \-\-quarterly\f[] +.B \f[C]-Q --quarterly\f[R] multiperiod/multicolumn report by quarter -.RS -.RE .TP -.B \f[C]\-Y\ \-\-yearly\f[] +.B \f[C]-Y --yearly\f[R] multiperiod/multicolumn report by year -.RS -.RE .TP -.B \f[C]\-p\ \-\-period=PERIODEXP\f[] +.B \f[C]-p --period=PERIODEXP\f[R] set start date, end date, and/or reporting interval all at once using -period expressions syntax (overrides the flags above) -.RS -.RE +period expressions syntax .TP -.B \f[C]\-\-date2\f[] +.B \f[C]--date2\f[R] match the secondary date instead (see command help for other effects) -.RS -.RE .TP -.B \f[C]\-U\ \-\-unmarked\f[] -include only unmarked postings/txns (can combine with \-P or \-C) -.RS -.RE +.B \f[C]-U --unmarked\f[R] +include only unmarked postings/txns (can combine with -P or -C) .TP -.B \f[C]\-P\ \-\-pending\f[] +.B \f[C]-P --pending\f[R] include only pending postings/txns -.RS -.RE .TP -.B \f[C]\-C\ \-\-cleared\f[] +.B \f[C]-C --cleared\f[R] include only cleared postings/txns -.RS -.RE .TP -.B \f[C]\-R\ \-\-real\f[] -include only non\-virtual postings -.RS -.RE +.B \f[C]-R --real\f[R] +include only non-virtual postings .TP -.B \f[C]\-NUM\ \-\-depth=NUM\f[] +.B \f[C]-NUM --depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep -.RS -.RE .TP -.B \f[C]\-E\ \-\-empty\f[] -show items with zero amount, normally hidden (and vice\-versa in -hledger\-ui/hledger\-web) -.RS -.RE +.B \f[C]-E --empty\f[R] +show items with zero amount, normally hidden (and vice-versa in +hledger-ui/hledger-web) .TP -.B \f[C]\-B\ \-\-cost\f[] +.B \f[C]-B --cost\f[R] convert amounts to their cost at transaction time (using the transaction price, if any) -.RS -.RE .TP -.B \f[C]\-V\ \-\-value\f[] +.B \f[C]-V --value\f[R] convert amounts to their market value on the report end date (using the most recent applicable market price, if any) -.RS -.RE .TP -.B \f[C]\-\-auto\f[] +.B \f[C]--auto\f[R] apply automated posting rules to modify transactions. -.RS -.RE .TP -.B \f[C]\-\-forecast\f[] +.B \f[C]--forecast\f[R] apply periodic transaction rules to generate future transactions, to 6 months from now or report end date. -.RS -.RE .PP When a reporting option appears more than once in the command line, the last one takes precedence. @@ -230,38 +164,33 @@ .PP hledger help options: .TP -.B \f[C]\-h\ \-\-help\f[] +.B \f[C]-h --help\f[R] show general usage (or after COMMAND, command usage) -.RS -.RE .TP -.B \f[C]\-\-version\f[] +.B \f[C]--version\f[R] show version -.RS -.RE .TP -.B \f[C]\-\-debug[=N]\f[] -show debug output (levels 1\-9, default: 1) -.RS -.RE +.B \f[C]--debug[=N]\f[R] +show debug output (levels 1-9, default: 1) .PP -A \@FILE argument will be expanded to the contents of FILE, which should -contain one command line option/argument per line. -(To prevent this, insert a \f[C]\-\-\f[] argument before.) +A \[at]FILE argument will be expanded to the contents of FILE, which +should contain one command line option/argument per line. +(To prevent this, insert a \f[C]--\f[R] argument before.) .SH KEYS .PP -\f[C]?\f[] shows a help dialog listing all keys. +\f[C]?\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[C]?\f[] again (or \f[C]ESCAPE\f[], or \f[C]LEFT\f[]) -to close it. +screen.) Press \f[C]?\f[R] again (or \f[C]ESCAPE\f[R], or +\f[C]LEFT\f[R]) to close it. The following keys work on most screens: .PP -The cursor keys navigate: \f[C]right\f[] (or \f[C]enter\f[]) goes -deeper, \f[C]left\f[] returns to the previous screen, -\f[C]up\f[]/\f[C]down\f[]/\f[C]page\ up\f[]/\f[C]page\ down\f[]/\f[C]home\f[]/\f[C]end\f[] +The cursor keys navigate: \f[C]right\f[R] (or \f[C]enter\f[R]) goes +deeper, \f[C]left\f[R] returns to the previous screen, +\f[C]up\f[R]/\f[C]down\f[R]/\f[C]page up\f[R]/\f[C]page down\f[R]/\f[C]home\f[R]/\f[C]end\f[R] move up and down through lists. -Vi\-style (\f[C]h\f[]/\f[C]j\f[]/\f[C]k\f[]/\f[C]l\f[]) and Emacs\-style -(\f[C]CTRL\-p\f[]/\f[C]CTRL\-n\f[]/\f[C]CTRL\-f\f[]/\f[C]CTRL\-b\f[]) +Vi-style (\f[C]h\f[R]/\f[C]j\f[R]/\f[C]k\f[R]/\f[C]l\f[R]) and +Emacs-style +(\f[C]CTRL-p\f[R]/\f[C]CTRL-n\f[R]/\f[C]CTRL-f\f[R]/\f[C]CTRL-b\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. @@ -269,67 +198,67 @@ .PP With shift pressed, the cursor keys adjust the report period, limiting the transactions to be shown (by default, all are shown). -\f[C]shift\-down/up\f[] steps downward and upward through these standard +\f[C]shift-down/up\f[R] steps downward and upward through these standard report period durations: year, quarter, month, week, day. -Then, \f[C]shift\-left/right\f[] moves to the previous/next period. -\f[C]t\f[] sets the report period to today. -With the \f[C]\-\-watch\f[] 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 \f[C]/\f[] and a -\f[C]date:\f[] query. +Then, \f[C]shift-left/right\f[R] moves to the previous/next period. +\f[C]t\f[R] sets the report period to today. +With the \f[C]--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[C]/\f[R] and a +\f[C]date:\f[R] query. .PP -\f[C]/\f[] 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[C]ENTER\f[] to set it, or \f[C]ESCAPE\f[]to cancel. +\f[C]/\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[C]ENTER\f[R] to set it, or \f[C]ESCAPE\f[R]to cancel. There are also keys for quickly adjusting some common filters like account depth and transaction status (see below). -\f[C]BACKSPACE\f[] or \f[C]DELETE\f[] removes all filters, showing all +\f[C]BACKSPACE\f[R] or \f[C]DELETE\f[R] removes all filters, showing all transactions. .PP -As mentioned above, hledger\-ui shows auto\-generated periodic -transactions, and hides future transactions (auto\-generated or not) by +As mentioned above, hledger-ui shows auto-generated periodic +transactions, and hides future transactions (auto-generated or not) by default. -\f[C]F\f[] toggles showing and hiding these future transactions. -This is similar to using a query like \f[C]date:\-tomorrow\f[], but more +\f[C]F\f[R] toggles showing and hiding these future transactions. +This is similar to using a query like \f[C]date:-tomorrow\f[R], but more convenient. (experimental) .PP -\f[C]ESCAPE\f[] removes all filters and jumps back to the top screen. +\f[C]ESCAPE\f[R] removes all filters and jumps back to the top screen. Or, it cancels a minibuffer edit or help dialog in progress. .PP -\f[C]CTRL\-l\f[] redraws the screen and centers the selection if +\f[C]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[C]g\f[] reloads from the data file(s) and updates the current screen +\f[C]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[C]I\f[] toggles balance assertion checking. +\f[C]I\f[R] toggles balance assertion checking. Disabling balance assertions temporarily can be useful for troubleshooting. .PP -\f[C]a\f[] runs command\-line hledger\[aq]s add command, and reloads the +\f[C]a\f[R] runs command-line hledger\[aq]s add command, and reloads the updated file. This allows some basic data entry. .PP -\f[C]A\f[] is like \f[C]a\f[], but runs the hledger\-iadd tool, which -provides a curses\-style interface. -This key will be available if \f[C]hledger\-iadd\f[] is installed in +\f[C]A\f[R] is like \f[C]a\f[R], but runs the hledger-iadd tool, which +provides a curses-style interface. +This key will be available if \f[C]hledger-iadd\f[R] is installed in $PATH. .PP -\f[C]E\f[] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default -(\f[C]emacsclient\ \-a\ ""\ \-nw\f[]) on the journal file. +\f[C]E\f[R] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default +(\f[C]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[C]q\f[] quits the application. +\f[C]q\f[R] quits the application. .PP -Additional screen\-specific keys are described below. +Additional screen-specific keys are described below. .SH SCREENS .SS Accounts screen .PP @@ -342,21 +271,21 @@ accounts and the balances from matched transactions. .PP Account names are shown as a flat list by default. -Press \f[C]T\f[] to toggle tree mode. +Press \f[C]T\f[R] to toggle tree mode. In flat mode, account balances are exclusive of subaccounts, except where subaccounts are hidden by a depth limit (see below). In tree mode, all account balances are inclusive of subaccounts. .PP -To see less detail, press a number key, \f[C]1\f[] to \f[C]9\f[], to set -a depth limit. -Or use \f[C]\-\f[] to decrease and \f[C]+\f[]/\f[C]=\f[] to increase the -depth limit. -\f[C]0\f[] shows even less detail, collapsing all accounts to a single +To see less detail, press a number key, \f[C]1\f[R] to \f[C]9\f[R], to +set a depth limit. +Or use \f[C]-\f[R] to decrease and \f[C]+\f[R]/\f[C]=\f[R] to increase +the depth limit. +\f[C]0\f[R] shows even less detail, collapsing all accounts to a single total. To remove the depth limit, set it higher than the maximum account depth, -or press \f[C]ESCAPE\f[]. +or press \f[C]ESCAPE\f[R]. .PP -\f[C]H\f[] toggles between showing historical balances or period +\f[C]H\f[R] 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 @@ -368,21 +297,21 @@ they show the change in balance during the report period. They are more useful eg when viewing a time log. .PP -\f[C]U\f[] toggles filtering by unmarked status, including or excluding +\f[C]U\f[R] toggles filtering by unmarked status, including or excluding unmarked postings in the balances. -Similarly, \f[C]P\f[] toggles pending postings, and \f[C]C\f[] toggles +Similarly, \f[C]P\f[R] toggles pending postings, and \f[C]C\f[R] toggles cleared postings. (By default, balances include all postings; if you activate one or two status filters, only those postings are included; and if you activate all three, the filter is removed.) .PP -\f[C]R\f[] toggles real mode, in which virtual postings are ignored. +\f[C]R\f[R] toggles real mode, in which virtual postings are ignored. .PP -\f[C]Z\f[] toggles nonzero mode, in which only accounts with nonzero -balances are shown (hledger\-ui shows zero items by default, unlike -command\-line hledger). +\f[C]Z\f[R] toggles nonzero mode, in which only accounts with nonzero +balances are shown (hledger-ui shows zero items by default, unlike +command-line hledger). .PP -Press \f[C]right\f[] or \f[C]enter\f[] to view an account\[aq]s +Press \f[C]right\f[R] or \f[C]enter\f[R] to view an account\[aq]s transactions register. .SS Register screen .PP @@ -399,7 +328,7 @@ .IP \[bu] 2 the running historical total or period total for the current account, after the transaction. -This can be toggled with \f[C]H\f[]. +This can be toggled with \f[C]H\f[R]. 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. @@ -416,23 +345,23 @@ .PD 0 .P .PD -Tree mode/flat mode can be toggled with \f[C]T\f[] here also. +Tree mode/flat mode can be toggled with \f[C]T\f[R] here also. .PP -\f[C]U\f[] toggles filtering by unmarked status, showing or hiding +\f[C]U\f[R] toggles filtering by unmarked status, showing or hiding unmarked transactions. -Similarly, \f[C]P\f[] toggles pending transactions, and \f[C]C\f[] +Similarly, \f[C]P\f[R] toggles pending transactions, and \f[C]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[C]R\f[] toggles real mode, in which virtual postings are ignored. +\f[C]R\f[R] toggles real mode, in which virtual postings are ignored. .PP -\f[C]Z\f[] toggles nonzero mode, in which only transactions posting a -nonzero change are shown (hledger\-ui shows zero items by default, -unlike command\-line hledger). +\f[C]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[C]right\f[] (or \f[C]enter\f[]) to view the selected +Press \f[C]right\f[R] (or \f[C]enter\f[R]) to view the selected transaction in detail. .SS Transaction screen .PP @@ -445,8 +374,8 @@ Simple transactions have two postings, but there can be more (or in certain cases, fewer). .PP -\f[C]up\f[] and \f[C]down\f[] will step through all transactions listed -in the previous account register screen. +\f[C]up\f[R] and \f[C]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. They will vary depending on which account register you came from @@ -463,40 +392,43 @@ (Or, you can press escape to cancel the reload attempt.) .SH ENVIRONMENT .PP -\f[B]COLUMNS\f[] The screen width to use. +\f[B]COLUMNS\f[R] The screen width to use. Default: the full terminal width. .PP -\f[B]LEDGER_FILE\f[] The journal file path when not specified with -\f[C]\-f\f[]. -Default: \f[C]~/.hledger.journal\f[] (on windows, perhaps -\f[C]C:/Users/USER/.hledger.journal\f[]). +\f[B]LEDGER_FILE\f[R] The journal file path when not specified with +\f[C]-f\f[R]. +Default: \f[C]\[ti]/.hledger.journal\f[R] (on windows, perhaps +\f[C]C:/Users/USER/.hledger.journal\f[R]). .SH FILES .PP Reads data from one or more files in hledger journal, timeclock, -timedot, or CSV format specified with \f[C]\-f\f[], or -\f[C]$LEDGER_FILE\f[], or \f[C]$HOME/.hledger.journal\f[] (on windows, -perhaps \f[C]C:/Users/USER/.hledger.journal\f[]). +timedot, or CSV format specified with \f[C]-f\f[R], or +\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, +perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). .SH BUGS .PP -The need to precede options with \f[C]\-\-\f[] when invoked from hledger +The need to precede options with \f[C]--\f[R] when invoked from hledger is awkward. .PP -\f[C]\-f\-\f[] doesn\[aq]t work (hledger\-ui can\[aq]t read from stdin). +\f[C]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin). .PP -\f[C]\-V\f[] affects only the accounts screen. +\f[C]-V\f[R] affects only the accounts screen. .PP -When you press \f[C]g\f[], the current and all previous screens are +When you press \f[C]g\f[R], the current and all previous screens are regenerated, which may cause a noticeable pause with large files. Also there is no visual indication that this is in progress. .PP -\f[C]\-\-watch\f[] is not yet fully robust. +\f[C]--watch\f[R] is not yet fully robust. It works well for normal usage, but many file changes in a short time (eg saving the file thousands of times with an editor macro) can cause problems at least on OSX. Symptoms include: unresponsive UI, periodic resetting of the cursor position, momentary display of parse errors, high CPU usage eventually -subsiding, and possibly a small but persistent build\-up of CPU usage +subsiding, and possibly a small but persistent build-up of CPU usage until the program is restarted. +.PP +Also, if you are viewing files mounted from another machine, +\f[C]--watch\f[R] requires that both machine clocks are roughly in step. .SH "REPORTING BUGS" 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.31.1. +-- This file has been generated from package.yaml by hpack version 0.31.2. -- -- see: https://github.com/sol/hpack -- --- hash: f9ea5523eba91a10f52f9d821483b82f77605674174f9f062dc10116047094d8 +-- hash: 0deef0df7a1a0ef153ebf7e31ddd57882a2671941a0f801bc2980dae7080501f name: hledger-ui -version: 1.14.2 +version: 1.15 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, @@ -27,7 +27,7 @@ maintainer: Simon Michael license: GPL-3 license-file: LICENSE -tested-with: GHC==7.10.3, GHC==8.0.2, GHC==8.2.2, GHC==8.4.3, GHC==8.6.3 +tested-with: GHC==7.10.3, GHC==8.0.2, GHC==8.2.2, GHC==8.4.3, GHC==8.6.5 build-type: Simple extra-source-files: CHANGES.md @@ -64,7 +64,7 @@ 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.14.2" + cpp-options: -DVERSION="1.15" build-depends: ansi-terminal >=0.6.2.3 , async @@ -76,8 +76,8 @@ , directory , filepath , fsnotify >=0.2.1.2 && <0.4 - , hledger >=1.14.2 && <1.15 - , hledger-lib >=1.14.1 && <1.15 + , hledger >=1.15 && <1.16 + , hledger-lib >=1.15 && <1.16 , megaparsec >=7.0.0 && <8 , microlens >=0.4 , microlens-platform >=0.2.3.1 diff --git a/hledger-ui.info b/hledger-ui.info --- a/hledger-ui.info +++ b/hledger-ui.info @@ -3,7 +3,7 @@  File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir) -hledger-ui(1) hledger-ui 1.14 +hledger-ui(1) hledger-ui 1.15 ***************************** hledger-ui is hledger's curses-style interface, providing an efficient @@ -24,6 +24,7 @@ '$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:: @@ -116,7 +117,7 @@ '-p --period=PERIODEXP' set start date, end date, and/or reporting interval all at once - using period expressions syntax (overrides the flags above) + using period expressions syntax '--date2' match the secondary date instead (see command help for other @@ -398,19 +399,19 @@  Tag Table: Node: Top71 -Node: OPTIONS1100 -Ref: #options1197 -Node: KEYS4616 -Ref: #keys4711 -Node: SCREENS7967 -Ref: #screens8052 -Node: Accounts screen8142 -Ref: #accounts-screen8270 -Node: Register screen10486 -Ref: #register-screen10641 -Node: Transaction screen12637 -Ref: #transaction-screen12795 -Node: Error screen13665 -Ref: #error-screen13787 +Node: OPTIONS1101 +Ref: #options1198 +Node: KEYS4589 +Ref: #keys4684 +Node: SCREENS7940 +Ref: #screens8025 +Node: Accounts screen8115 +Ref: #accounts-screen8243 +Node: Register screen10459 +Ref: #register-screen10614 +Node: Transaction screen12610 +Ref: #transaction-screen12768 +Node: Error screen13638 +Ref: #error-screen13760  End Tag Table diff --git a/hledger-ui.txt b/hledger-ui.txt --- a/hledger-ui.txt +++ b/hledger-ui.txt @@ -18,9 +18,9 @@ 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 com- - mand-line interface, and sometimes quicker and more convenient than the - web interface. + limited data entry capability. It is easier than hledger's command- + line interface, and sometimes quicker and more convenient than the web + interface. Note hledger-ui has some different defaults (experimental): @@ -114,7 +114,7 @@ -p --period=PERIODEXP set start date, end date, and/or reporting interval all at once - using period expressions syntax (overrides the flags above) + using period expressions syntax --date2 match the secondary date instead (see command help for other @@ -179,22 +179,22 @@ 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) and Emacs-style - (CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also supported. A tip: - movement speed is limited by your keyboard repeat rate, to move faster - you may want to adjust it. (If you're on a mac, the Karabiner app is - one way to do that.) + the previous screen, up/down/page up/page down/home/end move up and + down through lists. Vi-style (h/j/k/l) and Emacs-style (CTRL-p/CTRL- + n/CTRL-f/CTRL-b) movement keys are also supported. A tip: movement + speed is limited by your keyboard repeat rate, to move faster you may + want to adjust it. (If you're on a mac, the Karabiner app is one way + to do that.) With shift pressed, the cursor keys adjust the report period, limiting - the transactions to be shown (by default, all are shown). - shift-down/up steps downward and upward through these standard report - period durations: year, quarter, month, week, day. Then, - shift-left/right moves to the previous/next period. t sets the report - period to today. With the --watch option, when viewing a "current" - period (the current 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. + the transactions to be shown (by default, all are shown). shift- + down/up steps downward and upward through these standard report period + durations: year, quarter, month, week, day. Then, shift-left/right + moves to the previous/next period. t sets the report period to today. + With the --watch option, when viewing a "current" period (the current + day, week, month, quarter, or year), the period will move automatically + to track the current date. To set a non-standard period, you can use / + and a date: query. / lets you set a general filter query limiting the data shown, using the same query terms as in hledger and hledger-web. While editing the @@ -226,15 +226,15 @@ a runs command-line hledger's add command, and reloads the updated file. This allows some basic data entry. - A is like a, but runs the hledger-iadd tool, which provides a - curses-style interface. This key will be available if hledger-iadd is + A is like a, but runs the hledger-iadd tool, which provides a curses- + style interface. This key will be available if hledger-iadd is installed in $PATH. - 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 - (if possible) when invoked from the error screen. + E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a "" + -nw) on the journal file. With some editors (emacs, vi), the cursor + will be positioned at the current transaction when invoked from the + register and transaction screens, and at the error location (if possi- + ble) when invoked from the error screen. q quits the application. @@ -381,10 +381,13 @@ siding, and possibly a small but persistent build-up of CPU usage until the program is restarted. + Also, if you are viewing files mounted from another machine, --watch + requires that both machine clocks are roughly in step. + 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) @@ -398,7 +401,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) @@ -406,4 +409,4 @@ -hledger-ui 1.14 March 2019 hledger-ui(1) +hledger-ui 1.15 August 2019 hledger-ui(1)