ui: doc: clarify
This commit is contained in:
		
							parent
							
								
									af9daa3b11
								
							
						
					
					
						commit
						9df96cdace
					
				| @ -213,9 +213,10 @@ be "TAG:multi:level:account:name". | |||||||
| .SH KEYS | .SH KEYS | ||||||
| .PP | .PP | ||||||
| \f[C]?\f[] shows a help dialog listing all keys. | \f[C]?\f[] shows a help dialog listing all keys. | ||||||
| (Some but not all of these also appear in the quick help at the bottom | (Some of these also appear in the quick help at the bottom of each | ||||||
| of each screen.) Press \f[C]?\f[] again (or \f[C]ESCAPE\f[], or | screen.) Press \f[C]?\f[] again (or \f[C]ESCAPE\f[], or \f[C]LEFT\f[]) | ||||||
| \f[C]LEFT\f[]) to close it. | to close it. | ||||||
|  | The following keys work on most screens: | ||||||
| .PP | .PP | ||||||
| The cursor keys navigate: \f[C]right\f[] (or \f[C]enter\f[]) goes | The cursor keys navigate: \f[C]right\f[] (or \f[C]enter\f[]) goes | ||||||
| deeper, \f[C]left\f[] returns to the previous screen, | deeper, \f[C]left\f[] returns to the previous screen, | ||||||
| @ -223,35 +224,34 @@ deeper, \f[C]left\f[] returns to the previous screen, | |||||||
| move up and down through lists. | move up and down through lists. | ||||||
| Vi\-style \f[C]h\f[]/\f[C]j\f[]/\f[C]k\f[]/\f[C]l\f[] movement keys are | Vi\-style \f[C]h\f[]/\f[C]j\f[]/\f[C]k\f[]/\f[C]l\f[] movement keys are | ||||||
| also supported. | also supported. | ||||||
| (A tip: movement speed is limited by your keyboard repeat rate, to move | A tip: movement speed is limited by your keyboard repeat rate, to move | ||||||
| faster you may want to adjust that. | faster you may want to adjust it. | ||||||
| On a mac, the Karabiner app is one way to do that.) | (If you\[aq]re on a mac, the Karabiner app is one way to do that.) | ||||||
| .PP | .PP | ||||||
| On most screens, \f[C]/\f[] lets you set or change the filter query, | With shift pressed, the cursor keys adjust the report period, limiting | ||||||
| which limits the data shown (this filter is in addition to the quick | the transactions to be shown (by default, all are shown). | ||||||
| filters described below). | \f[C]shift\-down/up\f[] steps downward and upward through these standard | ||||||
| While editing the query you can use typical command\-line edit keys | report period durations: year, quarter, month, week, day. | ||||||
| (CTRL\-a/e/d/k, cursor keys etc.), and \f[C]ENTER\f[]to set the new | Then, \f[C]shift\-left/right\f[] moves to the previous/next period. | ||||||
| filter or \f[C]ESCAPE\f[]to cancel. |  | ||||||
| .PP |  | ||||||
| \f[C]d\f[] and \f[C]u\f[] cycle downward and upward through standard |  | ||||||
| report periods \- year, quarter, month, week, day. |  | ||||||
| When a standard report period is selected, \f[C]n\f[] and \f[C]p\f[] |  | ||||||
| step it to the next or previous period. |  | ||||||
| \f[C]Shift\-down/up/right/left\f[] can also be used for this. |  | ||||||
| \f[C]t\f[] sets the report period to today. | \f[C]t\f[] sets the report period to today. | ||||||
| For non\-standard periods, you can use \f[C]/\f[] to set a | (To set a non\-standard period, you can use \f[C]/\f[] and a | ||||||
| \f[C]date:\f[] query. | \f[C]date:\f[] query). | ||||||
| .PP | .PP | ||||||
| \f[C]BACKSPACE\f[] or \f[C]DELETE\f[] clears any filters in effect. | \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. | ||||||
|  | There are also keys for quickly adjusting some common filters like | ||||||
|  | account depth and cleared/uncleared (see below). | ||||||
|  | \f[C]BACKSPACE\f[] or \f[C]DELETE\f[] removes all filters, showing all | ||||||
|  | transactions. | ||||||
| .PP | .PP | ||||||
| \f[C]ESCAPE\f[] removes any filters currently in effect, and jumps to | \f[C]ESCAPE\f[] removes all filters and jumps back to the top screen. | ||||||
| the top screen. | Or, it cancels a minibuffer edit or help dialog in progress. | ||||||
| Or, it cancels a minibuffer edit or help dialog if one is active. |  | ||||||
| .PP | .PP | ||||||
| \f[C]g\f[] reloads from the data file(s) and updates the current screen | \f[C]g\f[] reloads from the data file(s) and updates the current screen | ||||||
| and any previous screens. | and any previous screens. | ||||||
| (With large files, there can be a noticeable pause.) | (With large files, this could cause a noticeable pause.) | ||||||
| .PP | .PP | ||||||
| \f[C]I\f[] toggles balance assertion checking. | \f[C]I\f[] toggles balance assertion checking. | ||||||
| Disabling balance assertions temporarily can be useful for | Disabling balance assertions temporarily can be useful for | ||||||
|  | |||||||
| @ -149,38 +149,40 @@ File: hledger-ui.1.info,  Node: KEYS,  Next: SCREENS,  Prev: OPTIONS,  Up: Top | |||||||
| 2 KEYS | 2 KEYS | ||||||
| ****** | ****** | ||||||
| 
 | 
 | ||||||
| `?' shows a help dialog listing all keys. (Some but not all of these | `?' shows a help dialog listing all keys. (Some of these also appear in | ||||||
| also appear in the quick help at the bottom of each screen.) Press `?' | the quick help at the bottom of each screen.) Press `?' again (or | ||||||
| again (or `ESCAPE', or `LEFT') to close it. | `ESCAPE', or `LEFT') to close it. The following keys work on most | ||||||
|  | screens: | ||||||
| 
 | 
 | ||||||
|    The cursor keys navigate: `right' (or `enter') goes deeper, `left' |    The cursor keys navigate: `right' (or `enter') goes deeper, `left' | ||||||
| returns to the previous screen, `up'/`down'/`page up'/`page | returns to the previous screen, `up'/`down'/`page up'/`page | ||||||
| down'/`home'/`end' move up and down through lists. Vi-style | down'/`home'/`end' move up and down through lists. Vi-style | ||||||
| `h'/`j'/`k'/`l' movement keys are also supported. (A tip: movement | `h'/`j'/`k'/`l' movement keys are also supported. A tip: movement speed | ||||||
| speed is limited by your keyboard repeat rate, to move faster you may | is limited by your keyboard repeat rate, to move faster you may want to | ||||||
| want to adjust that. On a mac, the Karabiner app is one way to do that.) | adjust it. (If you're on a mac, the Karabiner app is one way to do | ||||||
|  | that.) | ||||||
| 
 | 
 | ||||||
|    On most screens, `/' lets you set or change the filter query, which |    With shift pressed, the cursor keys adjust the report period, | ||||||
| limits the data shown (this filter is in addition to the quick filters | limiting the transactions to be shown (by default, all are shown). | ||||||
| described below). While editing the query you can use typical | `shift-down/up' steps downward and upward through these standard report | ||||||
| command-line edit keys (CTRL-a/e/d/k, cursor keys etc.), and `ENTER'to | period durations: year, quarter, month, week, day. Then, | ||||||
| set the new filter or `ESCAPE'to cancel. | `shift-left/right' moves to the previous/next period. `t' sets the | ||||||
|  | report period to today. (To set a non-standard period, you can use `/' | ||||||
|  | and a `date:' query). | ||||||
| 
 | 
 | ||||||
|    `d' and `u' cycle downward and upward through standard report |    `/' lets you set a general filter query limiting the data shown, | ||||||
| periods - year, quarter, month, week, day. When a standard report period | using the same query terms as in hledger and hledger-web. While editing | ||||||
| is selected, `n' and `p' step it to the next or previous period. | the query, you can use CTRL-a/e/d/k, BS, cursor keys; press `ENTER' to | ||||||
| `Shift-down/up/right/left' can also be used for this.  `t' sets the | set it, or `ESCAPE'to cancel. There are also keys for quickly adjusting | ||||||
| report period to today. For non-standard periods, you can use `/' to | some common filters like account depth and cleared/uncleared (see | ||||||
| set a `date:' query. | below). `BACKSPACE' or `DELETE' removes all filters, showing all | ||||||
|  | transactions. | ||||||
| 
 | 
 | ||||||
|    `BACKSPACE' or `DELETE' clears any filters in effect. |    `ESCAPE' removes all filters and jumps back to the top screen. Or, | ||||||
| 
 | it cancels a minibuffer edit or help dialog in progress. | ||||||
|    `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 |    `g' reloads from the data file(s) and updates the current screen and | ||||||
| any previous screens. (With large files, there can be a noticeable | any previous screens. (With large files, this could cause a noticeable | ||||||
| pause.) | pause.) | ||||||
| 
 | 
 | ||||||
|    `I' toggles balance assertion checking. Disabling balance assertions |    `I' toggles balance assertion checking. Disabling balance assertions | ||||||
| @ -347,15 +349,15 @@ Node: OPTIONS831 | |||||||
| Ref: #options930 | Ref: #options930 | ||||||
| Node: KEYS3743 | Node: KEYS3743 | ||||||
| Ref: #keys3840 | Ref: #keys3840 | ||||||
| Node: SCREENS6107 | Node: SCREENS6241 | ||||||
| Ref: #screens6194 | Ref: #screens6328 | ||||||
| Node: Accounts screen6284 | Node: Accounts screen6418 | ||||||
| Ref: #accounts-screen6414 | Ref: #accounts-screen6548 | ||||||
| Node: Register screen7880 | Node: Register screen8014 | ||||||
| Ref: #register-screen8037 | Ref: #register-screen8171 | ||||||
| Node: Transaction screen9997 | Node: Transaction screen10131 | ||||||
| Ref: #transaction-screen10157 | Ref: #transaction-screen10291 | ||||||
| Node: Error screen11024 | Node: Error screen11158 | ||||||
| Ref: #error-screen11148 | Ref: #error-screen11282 | ||||||
|  |  | ||||||
| End Tag Table | End Tag Table | ||||||
|  | |||||||
| @ -73,39 +73,39 @@ _reportingoptions_ | |||||||
| # KEYS | # KEYS | ||||||
| 
 | 
 | ||||||
| `?` shows a help dialog listing all keys.  | `?` 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.)  | (Some of these also appear in the quick help at the bottom of each screen.)  | ||||||
| Press `?` again (or `ESCAPE`, or `LEFT`) to close it. | Press `?` again (or `ESCAPE`, or `LEFT`) to close it. | ||||||
|  | The following keys work on most screens: | ||||||
| 
 | 
 | ||||||
| The cursor keys navigate:  | The cursor keys navigate:  | ||||||
| `right` (or `enter`) goes deeper,  | `right` (or `enter`) goes deeper,  | ||||||
| `left` returns to the previous screen, | `left` returns to the previous screen, | ||||||
| `up`/`down`/`page up`/`page down`/`home`/`end` move up and down through lists. | `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.  | Vi-style `h`/`j`/`k`/`l` movement keys are also supported.  | ||||||
| (A tip: movement speed is limited by your keyboard repeat rate,  | A tip: movement speed is limited by your keyboard repeat rate,  | ||||||
| to move faster you may want to adjust that. | to move faster you may want to adjust it. | ||||||
| On a mac, the Karabiner app is one way to do that.) | (If you're on a mac, the Karabiner app is one way to do that.) | ||||||
| 
 | 
 | ||||||
| On most screens, | With shift pressed, the cursor keys adjust the report period,  | ||||||
| `/` lets you set or change the [filter query](/hledger.html#queries), | limiting the transactions to be shown (by default, all are shown).  | ||||||
| which limits the data shown (this filter is in addition to the quick | `shift-down/up` steps downward and upward through these standard report period durations: | ||||||
| filters described below). While editing the query you can use typical | year, quarter, month, week, day. | ||||||
| command-line edit keys  | Then, `shift-left/right` moves to the previous/next period. | ||||||
| ([CTRL-a/e/d/k, cursor keys etc.](http://hackage.haskell.org/package/brick-0.7/docs/Brick-Widgets-Edit.html#t:Editor)),  |  | ||||||
| and `ENTER`to set the new filter or `ESCAPE`to cancel. |  | ||||||
| 
 |  | ||||||
| `d` and `u` cycle downward and upward through standard report periods - year, quarter, month, week, day.  |  | ||||||
| When a standard report period is selected, `n` and `p` step it to the next or previous period. |  | ||||||
| `Shift-down/up/right/left` can also be used for this. |  | ||||||
| `t` sets the report period to today. | `t` sets the report period to today. | ||||||
| For non-standard periods, you can use `/` to set a [`date:` query](manual.html#queries). | (To set a non-standard period, you can use `/` and a `date:` query). | ||||||
| 
 | 
 | ||||||
| `BACKSPACE` or `DELETE` clears any filters in effect. | `/` lets you set a general filter query limiting the data shown, | ||||||
|  | using the same [query terms](/hledger.html#queries) as in hledger and hledger-web. | ||||||
|  | While editing the query, you can use [CTRL-a/e/d/k, BS, cursor keys](http://hackage.haskell.org/package/brick-0.7/docs/Brick-Widgets-Edit.html#t:Editor);  | ||||||
|  | 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 transactions. | ||||||
| 
 | 
 | ||||||
| `ESCAPE` removes any filters currently in effect, and jumps to the top screen. | `ESCAPE` removes all filters and jumps back to the top screen. | ||||||
| Or, it cancels a minibuffer edit or help dialog if one is active. | 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 | `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.) | previous screens. (With large files, this could cause a noticeable pause.) | ||||||
| 
 | 
 | ||||||
| `I` toggles balance assertion checking.  | `I` toggles balance assertion checking.  | ||||||
| Disabling balance assertions temporarily can be useful for troubleshooting.  | Disabling balance assertions temporarily can be useful for troubleshooting.  | ||||||
|  | |||||||
| @ -138,49 +138,49 @@ OPTIONS | |||||||
|        name will be "TAG:multi:level:account:name". |        name will be "TAG:multi:level:account:name". | ||||||
| 
 | 
 | ||||||
| KEYS | KEYS | ||||||
|        ?  shows  a  help  dialog listing all keys.  (Some but not all of these |        ?  shows a help dialog listing all keys.  (Some of these also appear in | ||||||
|        also appear in the quick help at the bottom of each  screen.)  Press  ? |        the quick help at the bottom of each screen.) Press ? again (or ESCAPE, | ||||||
|        again (or ESCAPE, or LEFT) to close it. |        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 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. |        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 |        A tip: movement speed is limited by your keyboard repeat rate, to  move | ||||||
|        faster you may want to adjust that.  On a mac, the Karabiner app is one |        faster  you  may want to adjust it.  (If you're on a mac, the Karabiner | ||||||
|        way to do that.) |        app is one way to do that.) | ||||||
| 
 | 
 | ||||||
|        On most screens, / lets you set or change the filter query, which  lim- |        With shift pressed, the cursor keys adjust the report period,  limiting | ||||||
|        its  the  data  shown  (this filter is in addition to the quick filters |        the   transactions   to   be   shown   (by  default,  all  are  shown). | ||||||
|        described below).  While editing the query you  can  use  typical  com- |        shift-down/up steps downward and upward through these  standard  report | ||||||
|        mand-line  edit  keys (CTRL-a/e/d/k, cursor keys etc.), and ENTERto set |        period   durations:   year,   quarter,   month,   week,   day.    Then, | ||||||
|        the new filter or ESCAPEto cancel. |        shift-left/right moves to the previous/next period.  t sets the  report | ||||||
|  |        period  to  today.   (To set a non-standard period, you can use / and a | ||||||
|  |        date: query). | ||||||
| 
 | 
 | ||||||
|        d and u cycle downward and upward through  standard  report  periods  - |        / lets you set a general filter query limiting the  data  shown,  using | ||||||
|        year,  quarter,  month,  week,  day.   When a standard report period is |        the  same query terms as in hledger and hledger-web.  While editing the | ||||||
|        selected,  n  and  p  step  it  to  the  next   or   previous   period. |        query, you can use CTRL-a/e/d/k, BS, cursor keys; press  ENTER  to  set | ||||||
|        Shift-down/up/right/left  can also be used for this.  t sets the report |        it, or ESCAPEto cancel.  There are also keys for quickly adjusting some | ||||||
|        period to today.  For non-standard periods, you can  use  /  to  set  a |        common filters like account depth and  cleared/uncleared  (see  below). | ||||||
|        date: query. |        BACKSPACE or DELETE removes all filters, showing all transactions. | ||||||
| 
 | 
 | ||||||
|        BACKSPACE or DELETE clears any filters in effect. |        ESCAPE  removes  all  filters and jumps back to the top screen.  Or, it | ||||||
|  |        cancels a minibuffer edit or help dialog in progress. | ||||||
| 
 | 
 | ||||||
|        ESCAPE  removes  any  filters currently in effect, and jumps to the top |        g reloads from the data file(s) and updates the current screen and  any | ||||||
|        screen.  Or, it cancels a minibuffer edit or  help  dialog  if  one  is |        previous  screens.   (With  large  files, this could cause a noticeable | ||||||
|        active. |        pause.) | ||||||
| 
 | 
 | ||||||
|        g  reloads from the data file(s) and updates the current screen and any |        I toggles balance assertion  checking.   Disabling  balance  assertions | ||||||
|        previous screens.  (With large files, there can be a noticeable pause.) |  | ||||||
| 
 |  | ||||||
|        I  toggles  balance  assertion  checking.  Disabling balance assertions |  | ||||||
|        temporarily can be useful for troubleshooting. |        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. |        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), |        sclient -a "" -nw) on the journal file.  With some editors (emacs, vi), | ||||||
|        the  cursor  will be positioned at the current transaction when invoked |        the cursor will be positioned at the current transaction  when  invoked | ||||||
|        from the register and transaction screens, and at  the  error  location |        from  the  register  and transaction screens, and at the error location | ||||||
|        (if possible) when invoked from the error screen. |        (if possible) when invoked from the error screen. | ||||||
| 
 | 
 | ||||||
|        q quits the application. |        q quits the application. | ||||||
| @ -189,32 +189,32 @@ KEYS | |||||||
| 
 | 
 | ||||||
| SCREENS | SCREENS | ||||||
|    Accounts screen |    Accounts screen | ||||||
|        This  is  normally  the  first screen displayed.  It lists accounts and |        This is normally the first screen displayed.   It  lists  accounts  and | ||||||
|        their balances, like hledger's balance command.  By default,  it  shows |        their  balances,  like hledger's balance command.  By default, it shows | ||||||
|        all  accounts  and their latest ending balances (including the balances |        all accounts and their latest ending balances (including  the  balances | ||||||
|        of subaccounts).  if you specify a query on the command line, it  shows |        of  subaccounts).  if you specify a query on the command line, it shows | ||||||
|        just the matched accounts and the balances from matched transactions. |        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. |        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.  - |        0 shows even less detail, collapsing all accounts to a single total.  - | ||||||
|        and + (or =) decrease and increase the  depth  limit.   To  remove  the |        and  +  (or  =)  decrease  and increase the depth limit.  To remove the | ||||||
|        depth  limit,  set  it  higher than the maximum account depth, or press |        depth limit, set it higher than the maximum  account  depth,  or  press | ||||||
|        ESCAPE. |        ESCAPE. | ||||||
| 
 | 
 | ||||||
|        F toggles flat mode on and off.  In  flat  mode,  accounts  are  listed |        F  toggles  flat  mode  on  and off.  In flat mode, accounts are listed | ||||||
|        without  indentation,  and  show  their  subaccount-excluding balances, |        without indentation,  and  show  their  subaccount-excluding  balances, | ||||||
|        except for accounts which have been clipped by  a  depth  limit,  which |        except  for  accounts  which  have been clipped by a depth limit, which | ||||||
|        show their inclusive balances (as with hledger's balance command). |        show their inclusive balances (as with hledger's balance command). | ||||||
| 
 | 
 | ||||||
|        C  toggles  cleared  mode, in which uncleared transactions and postings |        C toggles cleared mode, in which uncleared  transactions  and  postings | ||||||
|        are not shown.  U toggles  uncleared  mode,  in  which  only  uncleared |        are  not  shown.   U  toggles  uncleared  mode, in which only uncleared | ||||||
|        transactions/postings are shown. |        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 balances |        Z toggles nonzero mode, in which only accounts  with  nonzero  balances | ||||||
|        are shown (hledger-ui shows zero items by default, unlike  command-line |        are  shown (hledger-ui shows zero items by default, unlike command-line | ||||||
|        hledger). |        hledger). | ||||||
| 
 | 
 | ||||||
|        Press right or enter to view an account's transactions register. |        Press right or enter to view an account's transactions register. | ||||||
| @ -223,15 +223,15 @@ SCREENS | |||||||
|        This screen shows the transactions affecting a particular account, like |        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: | ||||||
| 
 | 
 | ||||||
|        o the other account(s) involved, in abbreviated form.   (If  there  are |        o the  other  account(s)  involved, in abbreviated form.  (If there are | ||||||
|          both  real  and virtual postings, it shows only the accounts affected |          both real and virtual postings, it shows only the  accounts  affected | ||||||
|          by real postings.) |          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. |          inflow to this account, negative for an outflow. | ||||||
| 
 | 
 | ||||||
|        o the current account's historic balance (if no query other than a date |        o the current account's historic balance (if no query other than a date | ||||||
|          limit is in effect) or the running total starting from  zero  (other- |          limit  is  in effect) or the running total starting from zero (other- | ||||||
|          wise), after the transaction. |          wise), after the transaction. | ||||||
|        Eg, these will show historic balances: |        Eg, these will show historic balances: | ||||||
| 
 | 
 | ||||||
| @ -246,48 +246,48 @@ SCREENS | |||||||
|                 $ hledger-ui --begin 'this month' desc:market |                 $ hledger-ui --begin 'this month' desc:market | ||||||
|                 $ hledger-ui --register checking --cleared |                 $ hledger-ui --register checking --cleared | ||||||
| 
 | 
 | ||||||
|        The register screen normally shows transactions in the current  account |        The  register screen normally shows transactions in the current account | ||||||
|        and  any  of  its subaccounts (inclusive mode).  If it was entered from |        and any of its subaccounts (inclusive mode).  If it  was  entered  from | ||||||
|        the accounts screen in flat mode, where the selected  account  was  not |        the  accounts  screen  in flat mode, where the selected account was not | ||||||
|        depth-clipped  and  therefore was showing its subaccount-excluding bal- |        depth-clipped and therefore was showing its  subaccount-excluding  bal- | ||||||
|        ance, the register  too  will  omit  the  transactions  of  subaccounts |        ance,  the  register  too  will  omit  the  transactions of subaccounts | ||||||
|        (exclusive  mode).   This  means the register always shows the transac- |        (exclusive mode).  This means the register always  shows  the  transac- | ||||||
|        tions responsible for the  balance  being  displayed  on  the  accounts |        tions  responsible  for  the  balance  being  displayed on the accounts | ||||||
|        screen. |        screen. | ||||||
| 
 | 
 | ||||||
|        C  toggles  cleared  mode, in which uncleared transactions and postings |        C toggles cleared mode, in which uncleared  transactions  and  postings | ||||||
|        are not shown.  U toggles  uncleared  mode,  in  which  only  uncleared |        are  not  shown.   U  toggles  uncleared  mode, in which only uncleared | ||||||
|        transactions/postings are shown. |        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 nonzero |        Z toggles nonzero mode, in which only transactions  posting  a  nonzero | ||||||
|        change are shown (hledger-ui shows zero items by default,  unlike  com- |        change  are  shown (hledger-ui shows zero items by default, unlike com- | ||||||
|        mand-line hledger). |        mand-line hledger). | ||||||
| 
 | 
 | ||||||
|        Press right (or enter) to view the selected transaction in detail. |        Press right (or enter) to view the selected transaction in detail. | ||||||
| 
 | 
 | ||||||
|    Transaction screen |    Transaction screen | ||||||
|        This  screen  shows  a  single transaction, as a general journal entry, |        This screen shows a single transaction, as  a  general  journal  entry, | ||||||
|        similar to hledger's print command and  journal  format  (hledger_jour- |        similar  to  hledger's  print command and journal format (hledger_jour- | ||||||
|        nal(5)). |        nal(5)). | ||||||
| 
 | 
 | ||||||
|        The  transaction's  date(s)  and  any  cleared  flag, transaction code, |        The transaction's date(s)  and  any  cleared  flag,  transaction  code, | ||||||
|        description, comments, along with  all  of  its  account  postings  are |        description,  comments,  along  with  all  of  its account postings are | ||||||
|        shown.   Simple  transactions  have two postings, but there can be more |        shown.  Simple transactions have two postings, but there  can  be  more | ||||||
|        (or in certain cases, fewer). |        (or in certain cases, fewer). | ||||||
| 
 | 
 | ||||||
|        up and down will step through all transactions listed in  the  previous |        up  and  down will step through all transactions listed in the previous | ||||||
|        account  register screen.  In the title bar, the numbers in parentheses |        account register screen.  In the title bar, the numbers in  parentheses | ||||||
|        show your position  within  that  account  register.   They  will  vary |        show  your  position  within  that  account  register.   They will vary | ||||||
|        depending on which account register you came from (remember most trans- |        depending on which account register you came from (remember most trans- | ||||||
|        actions appear in multiple account registers).  The #N number preceding |        actions appear in multiple account registers).  The #N number preceding | ||||||
|        them is the transaction's position within the complete unfiltered jour- |        them is the transaction's position within the complete unfiltered jour- | ||||||
|        nal, which is a more stable id (at least until the next reload). |        nal, which is a more stable id (at least until the next reload). | ||||||
| 
 | 
 | ||||||
|    Error screen |    Error screen | ||||||
|        This screen will appear if there is a problem, such as a  parse  error, |        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 |        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 |        again to reload and resume normal operation.  (Or, you can press escape | ||||||
|        to cancel the reload attempt.) |        to cancel the reload attempt.) | ||||||
| 
 | 
 | ||||||
| @ -295,17 +295,17 @@ ENVIRONMENT | |||||||
|        COLUMNS The screen width to use.  Default: the full terminal width. |        COLUMNS The screen width to use.  Default: the full terminal width. | ||||||
| 
 | 
 | ||||||
|        LEDGER_FILE The journal file path when not specified with -f.  Default: |        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). |        nal). | ||||||
| 
 | 
 | ||||||
| FILES | FILES | ||||||
|        Reads  data from one or more files in hledger journal, timeclock, time- |        Reads data from one or more files in hledger journal, timeclock,  time- | ||||||
|        dot,  or  CSV  format  specified   with   -f,   or   $LEDGER_FILE,   or |        dot,   or   CSV   format   specified   with  -f,  or  $LEDGER_FILE,  or | ||||||
|        $HOME/.hledger.journal           (on          windows,          perhaps |        $HOME/.hledger.journal          (on          windows,           perhaps | ||||||
|        C:/Users/USER/.hledger.journal). |        C:/Users/USER/.hledger.journal). | ||||||
| 
 | 
 | ||||||
| BUGS | 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. |        ward. | ||||||
| 
 | 
 | ||||||
|        -f- doesn't work (hledger-ui can't read from stdin). |        -f- doesn't work (hledger-ui can't read from stdin). | ||||||
| @ -316,14 +316,14 @@ BUGS | |||||||
|        which may cause a noticeable pause.  Also there is no visual indication |        which may cause a noticeable pause.  Also there is no visual indication | ||||||
|        that this is in progress. |        that this is in progress. | ||||||
| 
 | 
 | ||||||
|        The  register  screen's  switching between historic balance and running |        The register screen's switching between historic  balance  and  running | ||||||
|        total based on query arguments may be confusing, and there is no column |        total based on query arguments may be confusing, and there is no column | ||||||
|        heading to indicate which is being displayed. |        heading to indicate which is being displayed. | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| REPORTING BUGS | 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) |        or hledger mail list) | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| @ -337,7 +337,7 @@ COPYRIGHT | |||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| SEE ALSO | 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- |        hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- | ||||||
|        dot(5), ledger(1) |        dot(5), ledger(1) | ||||||
| 
 | 
 | ||||||
|  | |||||||
		Loading…
	
		Reference in New Issue
	
	Block a user