slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2021-11-18 22:57:53 -10:00
parent 6aa212dd4a
commit b4254f41c6
3 changed files with 141 additions and 138 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
hledger-ui/hledger-ui.1
View File

@ -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 A \[at]FILE argument will be expanded to the contents of FILE, which
should contain one command line option/argument per line. should contain one command line option/argument per line.
(To prevent this, insert a \f[C]--\f[R] argument before.) (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 .SH KEYS
.PP .PP
Keyboard gives more control.
.PP
\f[C]?\f[R] 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 (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 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. \f[C]LEFT\f[R], or \f[C]q\f[R]) to close it.
The following keys work on most screens: The following keys work on most screens:
.PP .PP
The cursor keys navigate: \f[C]right\f[R] (or \f[C]enter\f[R]) goes The cursor keys navigate: \f[C]RIGHT\f[R] goes deeper, \f[C]LEFT\f[R]
deeper, \f[C]left\f[R] returns to the previous screen, 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] \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. move up and down through lists.
Emacs-style 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 movement keys are also supported (but not vi-style keys, since
hledger-1.19, sorry!). hledger-1.19, sorry!).
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
@ -241,9 +254,9 @@ faster you may want to adjust it.
.PP .PP
With shift pressed, the cursor keys adjust the report period, limiting With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown). 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. 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. \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] 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 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. \f[C]q\f[R] quits the application.
.PP .PP
Additional screen-specific keys are described below. 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 .SH SCREENS
.SS Accounts screen .SS Accounts screen
.PP .PP
@ -383,8 +386,7 @@ all three, the filter is removed.)
balances are shown (hledger-ui shows zero items by default, unlike balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger). command-line hledger).
.PP .PP
Press \f[C]right\f[R] or \f[C]enter\f[R] to view an account\[aq]s Press \f[C]RIGHT\f[R] to view an account\[aq]s transactions register.
transactions register.
.SS Register screen .SS Register screen
.PP .PP
This screen shows the transactions affecting a particular account, like 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 nonzero change are shown (hledger-ui shows zero items by default, unlike
command-line hledger). command-line hledger).
.PP .PP
Press \f[C]right\f[R] (or \f[C]enter\f[R]) to view the selected Press \f[C]RIGHT\f[R] to view the selected transaction in detail.
transaction in detail.
.SS Transaction screen .SS Transaction screen
.PP .PP
This screen shows a single transaction, as a general journal entry, 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 Simple transactions have two postings, but there can be more (or in
certain cases, fewer). certain cases, fewer).
.PP .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. listed in the previous account register screen.
In the title bar, the numbers in parentheses show your position within In the title bar, the numbers in parentheses show your position within
that account register. that account register.

126
hledger-ui/hledger-ui.info
View File

@ -43,8 +43,8 @@ enable "forecast mode".
* Menu: * Menu:
* OPTIONS:: * OPTIONS::
* KEYS::
* MOUSE:: * MOUSE::
* KEYS::
* SCREENS:: * SCREENS::
* TIPS:: * TIPS::
* ENVIRONMENT:: * ENVIRONMENT::
@ -52,7 +52,7 @@ enable "forecast mode".
* BUGS:: * 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 1 OPTIONS
********* *********
@ -237,30 +237,46 @@ should contain one command line option/argument per line. (To prevent
this, insert a `--' argument before.) 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 Keyboard gives more control.
the quick help at the bottom of each screen.) Press `?' again (or
`?' 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 `ESCAPE', or `LEFT', or `q') to close it. The following keys work on
most screens: most screens:
The cursor keys navigate: `right' (or `enter') goes deeper, `left' The cursor keys navigate: `RIGHT' goes deeper, `LEFT' returns to the
returns to the previous screen, `up'/`down'/`page up'/`page previous screen, `UP'/`DOWN'/`PGUP'/`PGDN'/`HOME'/`END' move up and
down'/`home'/`end' move up and down through lists. Emacs-style down through lists. Emacs-style (`CTRL-p'/`CTRL-n'/`CTRL-f'/`CTRL-b')
(`ctrl-p'/`ctrl-n'/`ctrl-f'/`ctrl-b') movement keys are also supported movement keys are also supported (but not vi-style keys, since
(but not vi-style keys, since hledger-1.19, sorry!). A tip: movement hledger-1.19, sorry!). A tip: movement speed is limited by your
speed is limited by your keyboard repeat rate, to move faster you may keyboard repeat rate, to move faster you may want to adjust it. (If
want to adjust it. (If you're on a mac, the karabiner app is one way to you're on a mac, the karabiner app is one way to do that.)
do that.)
With shift pressed, the cursor keys adjust the report period, With shift pressed, the cursor keys adjust the report period,
limiting the transactions to be shown (by default, all are shown). 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, 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 report period to today. With the `--watch' option, when viewing a
"current" period (the current day, week, month, quarter, or year), the "current" period (the current day, week, month, quarter, or year), the
period will move automatically to track the current date. To set a period will move automatically to track the current date. To set a
@ -329,22 +345,7 @@ mode.
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
 
File: hledger-ui.info, Node: MOUSE, Next: SCREENS, Prev: KEYS, Up: Top File: hledger-ui.info, Node: SCREENS, Next: TIPS, 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
4 SCREENS 4 SCREENS
********* *********
@ -402,7 +403,7 @@ is removed.)
balances are shown (hledger-ui shows zero items by default, unlike balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger). 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 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 nonzero change are shown (hledger-ui shows zero items by default, unlike
command-line hledger). command-line hledger).
Press `right' (or `enter') to view the selected transaction in Press `RIGHT' to view the selected transaction in detail.
detail.
 
File: hledger-ui.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS 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 Simple transactions have two postings, but there can be more (or in
certain cases, fewer). 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 previous account register screen. In the title bar, the numbers in
parentheses show your position within that account register. They will parentheses show your position within that account register. They will
vary depending on which account register you came from (remember most vary depending on which account register you came from (remember most
@ -627,32 +627,32 @@ program is restarted.
Tag Table: Tag Table:
Node: Top232 Node: Top232
Node: OPTIONS1647 Node: OPTIONS1647
Ref: #options1744 Ref: #options1745
Node: KEYS6616 Node: MOUSE6617
Ref: #keys6709 Ref: #mouse6712
Node: MOUSE10758 Node: KEYS7003
Ref: #mouse10853 Ref: #keys7096
Node: SCREENS11139 Node: SCREENS11157
Ref: #screens11238 Ref: #screens11255
Node: Accounts screen11328 Node: Accounts screen11345
Ref: #accounts-screen11456 Ref: #accounts-screen11473
Node: Register screen13660 Node: Register screen13666
Ref: #register-screen13815 Ref: #register-screen13821
Node: Transaction screen15810 Node: Transaction screen15803
Ref: #transaction-screen15968 Ref: #transaction-screen15961
Node: Error screen16835 Node: Error screen16828
Ref: #error-screen16957 Ref: #error-screen16950
Node: TIPS17199 Node: TIPS17192
Ref: #tips17298 Ref: #tips17291
Node: Watch mode17350 Node: Watch mode17343
Ref: #watch-mode17467 Ref: #watch-mode17460
Node: Watch mode limitations18211 Node: Watch mode limitations18204
Ref: #watch-mode-limitations18352 Ref: #watch-mode-limitations18345
Node: ENVIRONMENT19485 Node: ENVIRONMENT19478
Ref: #environment19596 Ref: #environment19589
Node: FILES20401 Node: FILES20394
Ref: #files20500 Ref: #files20493
Node: BUGS20713 Node: BUGS20706
Ref: #bugs20790 Ref: #bugs20783
 
End Tag Table End Tag Table

48
hledger-ui/hledger-ui.txt
View File

@ -211,23 +211,35 @@ OPTIONS
contain one command line option/argument per line. (To prevent this, contain one command line option/argument per line. (To prevent this,
insert a -- argument before.) 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 KEYS
Keyboard gives more control.
? shows a help dialog listing all keys. (Some of these also appear in ? 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, 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: 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 cursor keys navigate: RIGHT goes deeper, LEFT returns to the previ-
the previous screen, up/down/page up/page down/home/end move up and ous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down through lists.
down through lists. Emacs-style (ctrl-p/ctrl-n/ctrl-f/ctrl-b) movement Emacs-style (CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also sup-
keys are also supported (but not vi-style keys, since hledger-1.19, ported (but not vi-style keys, since hledger-1.19, sorry!). A tip:
sorry!). A tip: movement speed is limited by your keyboard repeat movement speed is limited by your keyboard repeat rate, to move faster
rate, to move faster you may want to adjust it. (If you're on a mac, you may want to adjust it. (If you're on a mac, the karabiner app is
the karabiner app is one way to do that.) one way to do that.)
With shift pressed, the cursor keys adjust the report period, limiting With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown). shift- the transactions to be shown (by default, all are shown). SHIFT-
down/up steps downward and upward through these standard report period DOWN/UP steps downward and upward through these standard report period
durations: year, quarter, month, week, day. Then, shift-left/right durations: year, quarter, month, week, day. Then, SHIFT-LEFT/RIGHT
moves to the previous/next period. T sets the report period to today. 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 the --watch option, when viewing a "current" period (the current
day, week, month, quarter, or year), the period will move automatically day, week, month, quarter, or year), the period will move automatically
@ -294,16 +306,6 @@ KEYS
Additional screen-specific keys are described below. 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 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
@ -346,7 +348,7 @@ SCREENS
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 to view an account's transactions register.
Register screen Register screen
This screen shows the transactions affecting a particular account, like 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- 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 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,
@ -398,7 +400,7 @@ SCREENS
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-