diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1 index 55f1b03d1..338dafd12 100644 --- a/hledger-ui/hledger-ui.1 +++ b/hledger-ui/hledger-ui.1 @@ -219,20 +219,33 @@ show debug output (levels 1-9, default: 1) 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 MOUSE +.PP +In most modern terminals, you can navigate through the screens with a +mouse or touchpad: +.IP \[bu] 2 +Use mouse wheel or trackpad to scroll lists up and down +.IP \[bu] 2 +Left click on list items to go deeper (like the \f[C]RIGHT\f[R] key) +.IP \[bu] 2 +Left click on the left-most column go back (like the \f[C]LEFT\f[R] +key). .SH KEYS .PP +Keyboard gives more control. +.PP \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[R] again (or \f[C]ESCAPE\f[R], or \f[C]LEFT\f[R], or \f[C]q\f[R]) to close it. The following keys work on most screens: .PP -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] +The cursor keys navigate: \f[C]RIGHT\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]PGUP\f[R]/\f[C]PGDN\f[R]/\f[C]HOME\f[R]/\f[C]END\f[R] move up and down through lists. 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]) +(\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 (but not vi-style keys, since hledger-1.19, sorry!). A tip: movement speed is limited by your keyboard repeat rate, to move @@ -241,9 +254,9 @@ faster you may want to adjust it. .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[R] 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[R] moves to the previous/next period. +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 @@ -321,16 +334,6 @@ reliably reset to normal mode. \f[C]q\f[R] quits the application. .PP Additional screen-specific keys are described below. -.SH MOUSE -.PP -In most modern terminals, you can also control hledger-ui with a mouse -or touchpad as follows: -.IP \[bu] 2 -Use mouse wheel or trackpad slide to scroll lists up and down -.IP \[bu] 2 -Left click on list items to go deeper (like \f[C]RIGHT\f[R]) -.IP \[bu] 2 -Left click on the left-most column go back (like \f[C]LEFT\f[R]) .SH SCREENS .SS Accounts screen .PP @@ -383,8 +386,7 @@ all three, the filter is removed.) balances are shown (hledger-ui shows zero items by default, unlike command-line hledger). .PP -Press \f[C]right\f[R] or \f[C]enter\f[R] to view an account\[aq]s -transactions register. +Press \f[C]RIGHT\f[R] to view an account\[aq]s transactions register. .SS Register screen .PP This screen shows the transactions affecting a particular account, like @@ -430,8 +432,7 @@ activate all three, the filter is removed.) nonzero change are shown (hledger-ui shows zero items by default, unlike command-line hledger). .PP -Press \f[C]right\f[R] (or \f[C]enter\f[R]) to view the selected -transaction in detail. +Press \f[C]RIGHT\f[R] to view the selected transaction in detail. .SS Transaction screen .PP This screen shows a single transaction, as a general journal entry, @@ -443,7 +444,7 @@ 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). .PP -\f[C]up\f[R] and \f[C]down\f[R] will step through all transactions +\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. diff --git a/hledger-ui/hledger-ui.info b/hledger-ui/hledger-ui.info index 745f974e0..230f321da 100644 --- a/hledger-ui/hledger-ui.info +++ b/hledger-ui/hledger-ui.info @@ -43,8 +43,8 @@ enable "forecast mode". * Menu: * OPTIONS:: -* KEYS:: * MOUSE:: +* KEYS:: * SCREENS:: * TIPS:: * ENVIRONMENT:: @@ -52,7 +52,7 @@ enable "forecast mode". * BUGS::  -File: hledger-ui.info, Node: OPTIONS, Next: KEYS, Prev: Top, Up: Top +File: hledger-ui.info, Node: OPTIONS, Next: MOUSE, Prev: Top, Up: Top 1 OPTIONS ********* @@ -237,30 +237,46 @@ should contain one command line option/argument per line. (To prevent this, insert a `--' argument before.)  -File: hledger-ui.info, Node: KEYS, Next: MOUSE, Prev: OPTIONS, Up: Top +File: hledger-ui.info, Node: MOUSE, Next: KEYS, Prev: OPTIONS, Up: Top -2 KEYS +2 MOUSE +******* + +In most modern terminals, you can navigate through the screens with a +mouse or touchpad: + + * Use mouse wheel or trackpad to scroll lists up and down + + * Left click on list items to go deeper (like the `RIGHT' key) + + * Left click on the left-most column go back (like the `LEFT' key). + + +File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: MOUSE, Up: Top + +3 KEYS ****** -`?' shows a help dialog listing all keys. (Some of these also appear in -the quick help at the bottom of each screen.) Press `?' again (or +Keyboard gives more control. + + `?' shows a help dialog listing all keys. (Some of these also appear +in the quick help at the bottom of each screen.) Press `?' again (or `ESCAPE', or `LEFT', or `q') 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. Emacs-style -(`ctrl-p'/`ctrl-n'/`ctrl-f'/`ctrl-b') movement keys are also supported -(but not vi-style keys, since hledger-1.19, sorry!). 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 cursor keys navigate: `RIGHT' goes deeper, `LEFT' returns to the +previous screen, `UP'/`DOWN'/`PGUP'/`PGDN'/`HOME'/`END' move up and +down through lists. Emacs-style (`CTRL-p'/`CTRL-n'/`CTRL-f'/`CTRL-b') +movement keys are also supported (but not vi-style keys, since +hledger-1.19, sorry!). 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 +`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 +`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 @@ -329,22 +345,7 @@ mode. Additional screen-specific keys are described below.  -File: hledger-ui.info, Node: MOUSE, Next: SCREENS, Prev: KEYS, Up: Top - -3 MOUSE -******* - -In most modern terminals, you can also control hledger-ui with a mouse -or touchpad as follows: - - * Use mouse wheel or trackpad slide to scroll lists up and down - - * Left click on list items to go deeper (like `RIGHT') - - * Left click on the left-most column go back (like `LEFT') - - -File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: MOUSE, Up: Top +File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: KEYS, Up: Top 4 SCREENS ********* @@ -402,7 +403,7 @@ is removed.) balances are shown (hledger-ui shows zero items by default, unlike command-line hledger). - Press `right' or `enter' to view an account's transactions register. + Press `RIGHT' to view an account's transactions register.  File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Accounts screen, Up: SCREENS @@ -450,8 +451,7 @@ is removed.) 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 -detail. + Press `RIGHT' to view the selected transaction in detail.  File: hledger-ui.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS @@ -468,7 +468,7 @@ 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 + `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 @@ -627,32 +627,32 @@ program is restarted. Tag Table: Node: Top232 Node: OPTIONS1647 -Ref: #options1744 -Node: KEYS6616 -Ref: #keys6709 -Node: MOUSE10758 -Ref: #mouse10853 -Node: SCREENS11139 -Ref: #screens11238 -Node: Accounts screen11328 -Ref: #accounts-screen11456 -Node: Register screen13660 -Ref: #register-screen13815 -Node: Transaction screen15810 -Ref: #transaction-screen15968 -Node: Error screen16835 -Ref: #error-screen16957 -Node: TIPS17199 -Ref: #tips17298 -Node: Watch mode17350 -Ref: #watch-mode17467 -Node: Watch mode limitations18211 -Ref: #watch-mode-limitations18352 -Node: ENVIRONMENT19485 -Ref: #environment19596 -Node: FILES20401 -Ref: #files20500 -Node: BUGS20713 -Ref: #bugs20790 +Ref: #options1745 +Node: MOUSE6617 +Ref: #mouse6712 +Node: KEYS7003 +Ref: #keys7096 +Node: SCREENS11157 +Ref: #screens11255 +Node: Accounts screen11345 +Ref: #accounts-screen11473 +Node: Register screen13666 +Ref: #register-screen13821 +Node: Transaction screen15803 +Ref: #transaction-screen15961 +Node: Error screen16828 +Ref: #error-screen16950 +Node: TIPS17192 +Ref: #tips17291 +Node: Watch mode17343 +Ref: #watch-mode17460 +Node: Watch mode limitations18204 +Ref: #watch-mode-limitations18345 +Node: ENVIRONMENT19478 +Ref: #environment19589 +Node: FILES20394 +Ref: #files20493 +Node: BUGS20706 +Ref: #bugs20783  End Tag Table diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt index 6ffc485ac..f219e4df9 100644 --- a/hledger-ui/hledger-ui.txt +++ b/hledger-ui/hledger-ui.txt @@ -211,99 +211,101 @@ OPTIONS contain one command line option/argument per line. (To prevent this, insert a -- argument before.) +MOUSE + In most modern terminals, you can navigate through the screens with a + mouse or touchpad: + + o Use mouse wheel or trackpad to scroll lists up and down + + o Left click on list items to go deeper (like the RIGHT key) + + o Left click on the left-most column go back (like the LEFT key). + KEYS - ? shows a help dialog listing all keys. (Some of these also appear in + Keyboard gives more control. + + ? shows a help dialog listing all keys. (Some of these also appear in the quick help at the bottom of each screen.) Press ? again (or ESCAPE, or LEFT, or q) 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. Emacs-style (ctrl-p/ctrl-n/ctrl-f/ctrl-b) movement - keys are also supported (but not vi-style keys, since hledger-1.19, - sorry!). 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 cursor keys navigate: RIGHT goes deeper, LEFT returns to the previ- + ous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down through lists. + Emacs-style (CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also sup- + ported (but not vi-style keys, since hledger-1.19, sorry!). 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 + 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-standard period, you can use / and a date: query. - / lets you set a general filter query limiting the data shown, using - the same query terms as in hledger and hledger-web. While editing the - query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set + / lets you set a general filter query limiting the data shown, using + the same query terms as in hledger and hledger-web. While editing the + query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set it, or ESCAPEto cancel. There are also keys for quickly adjusting some - common filters like account depth and transaction status (see below). + common filters like account depth and transaction status (see below). BACKSPACE or DELETE removes all filters, showing all transactions. - As mentioned above, by default hledger-ui hides future transactions - + As mentioned above, by default hledger-ui hides future transactions - both ordinary transactions recorded in the journal, and periodic trans- - actions generated by rule. F toggles forecast mode, in which + actions generated by rule. F toggles forecast mode, in which future/forecasted transactions are shown. - ESCAPE resets the UI state and jumps back to the top screen, restoring - the app's initial state at startup. Or, it cancels minibuffer data + ESCAPE resets the UI state and jumps back to the top screen, restoring + the app's initial state at startup. Or, it cancels minibuffer data entry or the help dialog. CTRL-l redraws the screen and centers the selection if possible (selec- - tions near the top won't be centered, since we don't scroll above the + tions near the top won't be centered, since we don't scroll above the top). - g reloads from the data file(s) and updates the current screen and any - previous screens. (With large files, this could cause a noticeable + g reloads from the data file(s) and updates the current screen and any + previous screens. (With large files, this could cause a noticeable pause.) - I toggles balance assertion checking. Disabling balance assertions + I toggles balance assertion checking. Disabling balance assertions temporarily can be useful for troubleshooting. - a runs command-line hledger's add command, and reloads the updated + a runs command-line hledger's add command, and reloads the updated file. This allows some basic data entry. - A is like a, but runs the hledger-iadd tool, which provides a terminal - interface. This key will be available if hledger-iadd is installed in + A is like a, but runs the hledger-iadd tool, which provides a terminal + interface. This key will be available if hledger-iadd is installed in $path. - 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- + 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. - B toggles cost mode, showing amounts in their transaction price's com- + B toggles cost mode, showing amounts in their transaction price's com- modity (like toggling the -B/--cost flag). - V toggles value mode, showing amounts' current market value in their - default valuation commodity (like toggling the -V/--market flag). - Note, "current market value" means the value on the report end date if - specified, otherwise today. To see the value on another date, you can - temporarily set that as the report end date. Eg: to see a transaction - as it was valued on july 30, go to the accounts or register screen, + V toggles value mode, showing amounts' current market value in their + default valuation commodity (like toggling the -V/--market flag). + Note, "current market value" means the value on the report end date if + specified, otherwise today. To see the value on another date, you can + temporarily set that as the report end date. Eg: to see a transaction + as it was valued on july 30, go to the accounts or register screen, press /, and add date:-7/30 to the query. At most one of cost or value mode can be active at once. - There's not yet any visual reminder when cost or value mode is active; + There's not yet any visual reminder when cost or value mode is active; for now pressing b b v should reliably reset to normal mode. q quits the application. Additional screen-specific keys are described below. -MOUSE - In most modern terminals, you can also control hledger-ui with a mouse - or touchpad as follows: - - o Use mouse wheel or trackpad slide to scroll lists up and down - - o Left click on list items to go deeper (like RIGHT) - - o Left click on the left-most column go back (like LEFT) - SCREENS Accounts screen This is normally the first screen displayed. It lists accounts and @@ -346,7 +348,7 @@ SCREENS are shown (hledger-ui shows zero items by default, unlike command-line hledger). - Press right or enter to view an account's transactions register. + Press RIGHT to view an account's transactions register. Register screen This screen shows the transactions affecting a particular account, like @@ -386,7 +388,7 @@ SCREENS change are shown (hledger-ui shows zero items by default, unlike com- mand-line hledger). - Press right (or enter) to view the selected transaction in detail. + Press RIGHT to view the selected transaction in detail. Transaction screen This screen shows a single transaction, as a general journal entry, @@ -398,7 +400,7 @@ SCREENS 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 + 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-