doc: ui: document new keys

hledger-ui/doc/hledger-ui.1

@@ -228,7 +228,7 @@ move up and down through lists.
 .PP
 \f[C]g\f[] gets the latest data and reloads the screen (and any previous
 screens).
-There may be a noticeable pause.
+With large journal files, there can be a noticeable pause.
 .PP
 \f[C]q\f[] quits the application.
 .PP
@@ -253,23 +253,23 @@ 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]C\f[] toggles cleared mode.
+\f[C]E\f[] toggles nonzero mode, in which only accounts with nonzero
-In cleared mode, the accounts and balances are derived only from
+balances are shown (hledger\-ui shows zero items by default, unlike
-transactions which are marked cleared (*).
+command\-line hledger).
+.PP
+\f[C]C\f[] toggles cleared mode, in which uncleared transactions (and
+postings) are ignored.
+.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 an account\[aq]s
 transactions register.
 .SS Register screen
 .PP
-This screen lists all transactions affecting a particular account (like
+This screen lists all transactions affecting a particular account, like
-a check register).
+a check register.
-In cleared mode (press \f[C]C\f[]) it lists only transactions which are
+Unlike hledger\[aq]s register command (which lists individual postings),
-marked cleared.
+in hledger\-ui\[aq]s register:
-It does not otherwise filter by query.
-.PP
-Note this screen shows transactions, not postings (unlike hledger\[aq]s
-register command).
-This means:
 .IP \[bu] 2
 Each line represents a whole transaction.
 .IP \[bu] 2
@@ -308,6 +308,15 @@ $\ 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 ignored.
+.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.
 .SS Transaction screen

hledger-ui/doc/hledger-ui.1.info

@@ -158,7 +158,7 @@ Generally the cursor keys navigate; `right' (or `enter') goes deeper,
 down'/`home'/`end' move up and down through lists.
 
    `g' gets the latest data and reloads the screen (and any previous
-screens). There may be a noticeable pause.
+screens). With large journal files, there can be a noticeable pause.
 
    `q' quits the application.
 
@@ -197,8 +197,14 @@ 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.
 
-   `C' toggles cleared mode. In cleared mode, the accounts and balances
+   `E' toggles nonzero mode, in which only accounts with nonzero
-are derived only from transactions which are marked cleared (*).
+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 ignored.
+
+   `R' toggles real mode, in which virtual postings are ignored.
 
    Press `right' or `enter' to view an account's transactions register.
 
@@ -208,13 +214,9 @@ File: hledger-ui.1.info,  Node: Register screen,  Next: Transaction screen,  Pre
 3.2 Register screen
 ===================
 
-This screen lists all transactions affecting a particular account (like
+This screen lists all transactions affecting a particular account, like
-a check register). In cleared mode (press `C') it lists only
+a check register. Unlike hledger's register command (which lists
-transactions which are marked cleared. It does not otherwise filter by
+individual postings), in hledger-ui's register:
-query.
-
-   Note this screen shows transactions, not postings (unlike hledger's
-register command). This means:
 
    * Each line represents a whole transaction.
 
@@ -245,6 +247,15 @@ register command). This means:
      $ 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 ignored.
+
+   `R' toggles real mode, in which virtual postings are ignored.
+
    Press `right' or `enter' to view the selected transaction in full
 detail.
 
@@ -290,15 +301,15 @@ Node: OPTIONS714
 Ref: #options813
 Node: KEYS3689
 Ref: #keys3786
-Node: SCREENS4183
+Node: SCREENS4209
-Ref: #screens4270
+Ref: #screens4296
-Node: Accounts screen4360
+Node: Accounts screen4386
-Ref: #accounts-screen4490
+Ref: #accounts-screen4516
-Node: Register screen5335
+Node: Register screen5535
-Ref: #register-screen5492
+Ref: #register-screen5692
-Node: Transaction screen6874
+Node: Transaction screen7264
-Ref: #transaction-screen7034
+Ref: #transaction-screen7424
-Node: Error screen7901
+Node: Error screen8291
-Ref: #error-screen8025
+Ref: #error-screen8415
 
 End Tag Table

hledger-ui/doc/hledger-ui.1.m4.md

@@ -87,7 +87,8 @@ _reportingoptions_
 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.
 
-`g` gets the latest data and reloads the screen (and any previous screens). There may be a noticeable pause.
+`g` gets the latest data and reloads the screen (and any previous
+screens). With large journal files, there can be a noticeable pause.
 
 `q` quits the application.
 
@@ -109,19 +110,23 @@ 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.
 
-`C` toggles cleared mode. In cleared mode, the accounts and balances
+`E` toggles nonzero mode, in which only accounts with nonzero balances
-are derived only from transactions which are marked cleared (*).
+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
+ignored.
+
+`R` toggles real mode, in which [virtual postings](/journal.html#virtual-postings) are ignored.
 
 Press `right` or `enter` to view an account's transactions register.
 
 ## Register screen
 
-This screen lists all transactions affecting a particular account (like a check register).
+This screen lists all transactions affecting a particular account, like
-In cleared mode (press `C`) it lists only transactions which are marked cleared.
+a check register. Unlike hledger's register command (which
-It does not otherwise filter by query.
+lists individual postings), in hledger-ui's register:
-
-Note this screen shows transactions, not postings (unlike hledger's
-register command). This means:
 
 - Each line represents a whole transaction.
 
@@ -152,7 +157,18 @@ register command). This means:
     $ hledger-ui --register checking --cleared
     ```
 
-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 command-line hledger).
+
+`C` toggles cleared mode, in which
+[uncleared transactions (and postings)](/journal.html#transactions) are
+ignored.
+
+`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
+detail.
 
 ## Transaction screen
 

hledger-ui/doc/hledger-ui.1.txt

@@ -150,7 +150,7 @@ KKEEYYSS
        up and down through lists.
 
        g  gets  the  latest  data  and  reloads  the  screen (and any previous
-       screens).  There may be a noticeable pause.
+       screens).  With large journal files, there can be a noticeable pause.
 
        q quits the application.
 
@@ -171,18 +171,21 @@ 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.
 
-       C toggles cleared mode.  In cleared mode, the accounts and balances are
+       E  toggles  nonzero  mode, in which only accounts with nonzero balances
-       derived only from transactions which are marked cleared (*).
+       are shown (hledger-ui shows zero items by default, unlike  command-line
+       hledger).
+
+       C  toggles cleared mode, in which uncleared transactions (and postings)
+       are ignored.
+
+       R toggles real mode, in which virtual postings are ignored.
 
        Press right or enter to view an account's transactions register.
 
    RReeggiisstteerr ssccrreeeenn
-       This screen lists all transactions affecting a particular account (like
+       This screen lists all transactions affecting a particular account, like
-       a  check  register).   In cleared mode (press C) it lists only transac-
+       a check register.  Unlike hledger's register command (which lists indi-
-       tions which are marked cleared.  It does not otherwise filter by query.
+       vidual postings), in hledger-ui's register:
-
-       Note  this  screen  shows  transactions, not postings (unlike hledger's
-       register command).  This means:
 
        +o Each line represents a whole transaction.
 
@@ -210,6 +213,15 @@ 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 ignored.
+
+       R toggles real mode, in which virtual postings are ignored.
+
        Press right or enter to view the selected transaction in full detail.
 
    TTrraannssaaccttiioonn ssccrreeeenn