diff --git a/hledger-ui/Hledger/UI/UIUtils.hs b/hledger-ui/Hledger/UI/UIUtils.hs index e367b42df..8a1b2a562 100644 --- a/hledger-ui/Hledger/UI/UIUtils.hs +++ b/hledger-ui/Hledger/UI/UIUtils.hs @@ -239,12 +239,12 @@ helpDialog = ,renderKey ("R", "toggle real filter") ,renderKey ("E", "toggle nonzero filter") ,renderKey ("/", "set a filter query") - ,renderKey ("DEL/BS", "clear filters") + ,renderKey ("DEL/BS", "remove filters") + ,str " " ,str "accounts screen:" ,renderKey ("F", "toggle flat mode") ,renderKey ("-+=1234567890", "") - ,str " adjust/set depth limit" - ,str " 0 means no limit" + ,str " adjust/set/remove depth limit" ] ) ] diff --git a/hledger-ui/doc/hledger-ui.1 b/hledger-ui/doc/hledger-ui.1 index 5e0782be9..02301fe1b 100644 --- a/hledger-ui/doc/hledger-ui.1 +++ b/hledger-ui/doc/hledger-ui.1 @@ -217,19 +217,16 @@ be "TAG:multi:level:account:name". .RE .SH KEYS .PP -Generally 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]h\f[] shows a help dialog listing all keys. +(Some but not all of these also appear in the quick help at the bottom +of each screen.) Press \f[C]h\f[] again (or \f[C]ESCAPE\f[]) to close +it. +.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[] move up and down through lists. .PP -\f[C]g\f[] reloads from the data file(s) and updates the current screen -and any previous screens. -(With large files, there can be a noticeable pause.) -.PP -\f[C]a\f[] runs command\-line hledger\[aq]s add command, and reloads -hledger\-ui. -This allows some basic data entry. -.PP \f[C]/\f[] lets you set or change the filter query, which limits the data shown on most screens (in addition to the quick filters described below). @@ -239,7 +236,17 @@ cancel. .PP \f[C]BACKSPACE\f[] or \f[C]DELETE\f[] clears any filters in effect. .PP -\f[C]ESCAPE\f[] clears any filters and jumps to the top screen. +\f[C]ESCAPE\f[] removes any filters currently in effect, and jumps to +the top screen. +Or, it cancels a minibuffer edit or help dialog if one is active. +.PP +\f[C]g\f[] reloads from the data file(s) and updates the current screen +and any previous screens. +(With large files, there can be a noticeable pause.) +.PP +\f[C]a\f[] runs command\-line hledger\[aq]s add command, and reloads the +updated file. +This allows some basic data entry. .PP \f[C]q\f[] quits the application. .PP @@ -264,10 +271,6 @@ Or, adjust the depth limit by pressing \f[C]\-\f[] or \f[C]+\f[] (\f[C]=\f[] also works). \f[C]0\f[] removes the depth limit. .PP -\f[C]E\f[] toggles nonzero mode, in which only accounts with nonzero -balances are shown (hledger\-ui shows zero items by default, unlike -command\-line hledger). -.PP \f[C]C\f[] toggles cleared mode, in which uncleared transactions and postings are not shown. \f[C]U\f[] toggles uncleared mode, in which only uncleared @@ -275,6 +278,10 @@ transactions/postings are shown. .PP \f[C]R\f[] toggles real mode, in which virtual postings are ignored. .PP +\f[C]E\f[] 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 transactions register. .SS Register screen @@ -321,10 +328,6 @@ $\ hledger\-ui\ \-\-register\ checking\ \-\-cleared .fi .RE .PP -\f[C]E\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). -.PP \f[C]C\f[] toggles cleared mode, in which uncleared transactions and postings are not shown. \f[C]U\f[] toggles uncleared mode, in which only uncleared @@ -332,11 +335,15 @@ transactions/postings are shown. .PP \f[C]R\f[] toggles real mode, in which virtual postings are ignored. .PP -Press \f[C]right\f[] or \f[C]enter\f[] to view the selected transaction -in full detail. +\f[C]E\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). .PP -Note, filter queries which filter by account name do not yet do much -useful on this screen. +Press \f[C]right\f[] (or \f[C]enter\f[]) to view the selected +transaction in full detail. +.PP +Note, filter queries which filter by account name are not very useful on +this screen yet. .SS Transaction screen .PP This screen shows a single transaction, as a general journal entry, @@ -361,8 +368,9 @@ until the next reload). .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 described, press g again to reload and -restore normal operation. +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.) .SH ENVIRONMENT .PP \f[B]COLUMNS\f[] The screen width to use. diff --git a/hledger-ui/doc/hledger-ui.1.info b/hledger-ui/doc/hledger-ui.1.info index b708acf11..8001d3693 100644 --- a/hledger-ui/doc/hledger-ui.1.info +++ b/hledger-ui/doc/hledger-ui.1.info @@ -152,17 +152,14 @@ File: hledger-ui.1.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top 2 KEYS ****** -Generally the cursor keys navigate; `right' (or `enter') goes deeper, -`left' returns to the previous screen, `up'/`down'/`page up'/`page +`h' shows a help dialog listing all keys. (Some but not all of these +also appear in the quick help at the bottom of each screen.) Press `h' +again (or `ESCAPE') to close it. + + 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. - `g' reloads from the data file(s) and updates the current screen and -any previous screens. (With large files, there can be a noticeable -pause.) - - `a' runs command-line hledger's add command, and reloads hledger-ui. -This allows some basic data entry. - `/' lets you set or change the filter query, which limits the data shown on most screens (in addition to the quick filters described below). While editing the query you can use typical command-line edit @@ -171,7 +168,16 @@ cancel. `BACKSPACE' or `DELETE' clears any filters in effect. - `ESCAPE' clears any filters and jumps to the top screen. + `ESCAPE' removes any filters currently in effect, and jumps to the +top screen. Or, it cancels a minibuffer edit or help dialog if one is +active. + + `g' reloads from the data file(s) and updates the current screen and +any previous screens. (With large files, there can be a noticeable +pause.) + + `a' runs command-line hledger's add command, and reloads the updated +file. This allows some basic data entry. `q' quits the application. @@ -210,16 +216,16 @@ depth limit by pressing a number key, `1' to `9'. Or, adjust the depth limit by pressing `-' or `+' (`=' also works). `0' removes the depth limit. - `E' toggles nonzero mode, in which only accounts with nonzero -balances are shown (hledger-ui shows zero items by default, unlike -command-line hledger). - `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. + `E' 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.  @@ -261,21 +267,21 @@ individual postings), in hledger-ui's register: $ hledger-ui --register checking --cleared - `E' toggles nonzero mode, in which only transactions posting a -nonzero change are shown (hledger-ui shows zero items by default, unlike -command-line hledger). - `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. - Press `right' or `enter' to view the selected transaction in full + `E' 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 full detail. - Note, filter queries which filter by account name do not yet do much -useful on this screen. + Note, filter queries which filter by account name are not very +useful on this screen yet.  File: hledger-ui.1.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS @@ -308,8 +314,9 @@ File: hledger-ui.1.info, Node: Error screen, Prev: Transaction screen, Up: SC ================ 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 described, -press g again to reload and restore normal operation. +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.)  @@ -319,15 +326,15 @@ Node: OPTIONS825 Ref: #options924 Node: KEYS3800 Ref: #keys3897 -Node: SCREENS4837 -Ref: #screens4924 -Node: Accounts screen5014 -Ref: #accounts-screen5144 -Node: Register screen6248 -Ref: #register-screen6405 -Node: Transaction screen8158 -Ref: #transaction-screen8318 -Node: Error screen9185 -Ref: #error-screen9309 +Node: SCREENS5098 +Ref: #screens5185 +Node: Accounts screen5275 +Ref: #accounts-screen5405 +Node: Register screen6509 +Ref: #register-screen6666 +Node: Transaction screen8419 +Ref: #transaction-screen8579 +Node: Error screen9446 +Ref: #error-screen9570  End Tag Table diff --git a/hledger-ui/doc/hledger-ui.1.m4.md b/hledger-ui/doc/hledger-ui.1.m4.md index 17731b3bc..e1d85619c 100644 --- a/hledger-ui/doc/hledger-ui.1.m4.md +++ b/hledger-ui/doc/hledger-ui.1.m4.md @@ -75,15 +75,15 @@ _reportingoptions_ # KEYS -Generally the cursor keys navigate; `right` (or `enter`) goes deeper, `left` returns to the previous screen, +`h` shows a help dialog listing all keys. +(Some but not all of these also appear in the quick help at the bottom of each screen.) +Press `h` again (or `ESCAPE`) to close it. + +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. -`g` reloads from the data file(s) and updates the current screen and any -previous screens. (With large files, there can be a noticeable pause.) - -`a` runs command-line hledger's add command, and reloads hledger-ui. -This allows some basic data entry. - `/` lets you set or change the [filter query](/hledger.html#queries), which limits the data shown on most screens (in addition to the quick filters described below). While editing the query you can use typical @@ -92,7 +92,14 @@ or press escape to cancel. `BACKSPACE` or `DELETE` clears any filters in effect. -`ESCAPE` clears any filters and jumps to the top screen. +`ESCAPE` removes any filters currently in effect, and jumps to the top screen. +Or, it cancels a minibuffer edit or help dialog if one is active. + +`g` reloads from the data file(s) and updates the current screen and any +previous screens. (With large files, there can be a noticeable pause.) + +`a` runs command-line hledger's add command, and reloads the updated file. +This allows some basic data entry. `q` quits the application. @@ -114,10 +121,6 @@ To see less detail, set a depth limit by pressing a number key, `1` to `9`. Or, adjust the depth limit by pressing `-` or `+` (`=` also works). `0` removes the depth limit. -`E` toggles nonzero mode, in which only accounts with nonzero balances -are shown (hledger-ui shows zero items by default, unlike command-line -hledger). - `C` toggles cleared mode, in which [uncleared transactions and postings](/journal.html#transactions) are not shown. `U` toggles uncleared mode, in which only uncleared @@ -125,6 +128,10 @@ transactions/postings are shown. `R` toggles real mode, in which [virtual postings](/journal.html#virtual-postings) are ignored. +`E` 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. ## Register screen @@ -162,10 +169,6 @@ lists individual postings), in hledger-ui's register: $ hledger-ui --register checking --cleared ``` -`E` toggles nonzero mode, in which only transactions posting a nonzero -change are shown (hledger-ui shows zero items by default, -unlike command-line hledger). - `C` toggles cleared mode, in which [uncleared transactions and postings](/journal.html#transactions) are not shown. `U` toggles uncleared mode, in which only uncleared @@ -173,11 +176,15 @@ transactions/postings are shown. `R` toggles real mode, in which [virtual postings](/journal.html#virtual-postings) are ignored. -Press `right` or `enter` to view the selected transaction in full +`E` 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 full detail. -Note, filter queries which filter by account name do not yet do much -useful on this screen. +Note, filter queries which filter by account name are not very useful +on this screen yet. ## Transaction screen @@ -201,11 +208,11 @@ 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 described, -press g again to reload and restore normal operation. +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.) _man_({{ - # ENVIRONMENT **COLUMNS** @@ -233,5 +240,4 @@ visual indication that this is in progress. The register screen's switching between historic balance and running total based on query arguments may be confusing, and there is no column heading to indicate which is being displayed. - }}) diff --git a/hledger-ui/doc/hledger-ui.1.txt b/hledger-ui/doc/hledger-ui.1.txt index 8d9579c3d..7732d625c 100644 --- a/hledger-ui/doc/hledger-ui.1.txt +++ b/hledger-ui/doc/hledger-ui.1.txt @@ -141,25 +141,31 @@ OOPPTTIIOONNSS name will be "TAG:multi:level:account:name". KKEEYYSS - Generally 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. + h shows a help dialog listing all keys. (Some but not all of these + also appear in the quick help at the bottom of each screen.) Press h + again (or ESCAPE) to close it. - g reloads from the data file(s) and updates the current screen and any - previous screens. (With large files, there can be a noticeable pause.) + 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. - a runs command-line hledger's add command, and reloads hledger-ui. - This allows some basic data entry. - - / lets you set or change the filter query, which limits the data shown - on most screens (in addition to the quick filters described below). - While editing the query you can use typical command-line edit keys - (ctrl-a/e/k), press enter to set the new filter, or press escape to + / lets you set or change the filter query, which limits the data shown + on most screens (in addition to the quick filters described below). + While editing the query you can use typical command-line edit keys + (ctrl-a/e/k), press enter to set the new filter, or press escape to cancel. BACKSPACE or DELETE clears any filters in effect. - ESCAPE clears any filters and jumps to the top screen. + ESCAPE removes any filters currently in effect, and jumps to the top + screen. Or, it cancels a minibuffer edit or help dialog if one is + active. + + g reloads from the data file(s) and updates the current screen and any + previous screens. (With large files, there can be a noticeable pause.) + + a runs command-line hledger's add command, and reloads the updated + file. This allows some basic data entry. q quits the application. @@ -180,16 +186,16 @@ SSCCRREEEENNSS depth limit by pressing a number key, 1 to 9. Or, adjust the depth limit by pressing - or + (= also works). 0 removes the depth limit. - E toggles nonzero mode, in which only accounts with nonzero balances - are shown (hledger-ui shows zero items by default, unlike command-line - hledger). - 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. + E 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. RReeggiisstteerr ssccrreeeenn @@ -223,43 +229,44 @@ SSCCRREEEENNSS $ hledger-ui --begin 'this month' desc:market $ hledger-ui --register checking --cleared - E 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). - 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. - Press right or enter to view the selected transaction in full detail. + E 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). - Note, filter queries which filter by account name do not yet do much - useful on this screen. + Press right (or enter) to view the selected transaction in full detail. + + Note, filter queries which filter by account name are not very useful + on this screen yet. TTrraannssaaccttiioonn ssccrreeeenn - 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). EErrrroorr ssccrreeeenn - 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 described, - press g again to reload and restore normal operation. + 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.) EENNVVIIRROONNMMEENNTT CCOOLLUUMMNNSS The screen width to use. Default: the full terminal width.