simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-11-09 10:17:34 +03:00
Code Issues Projects Releases Wiki Activity

;doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2022-11-07 17:04:05 -10:00
parent 1f385ae774
commit 4a1d900c51
3 changed files with 77 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -252,14 +252,14 @@ 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] goes deeper, \f[C]LEFT\f[R] The cursor keys navigate: \f[C]RIGHT\f[R] or \f[C]ENTER\f[R] goes
returns to the previous screen, 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] \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 and VI-style (\f[C]k\f[R],\f[C]j\f[R],\f[C]l\f[R],\f[C]h\f[R]) movement
hledger-1.19, sorry!). 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 it. faster you may want to adjust it.
(If you\[aq]re 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.)
@ -358,28 +358,30 @@ screen.
.IP \[bu] 2 .IP \[bu] 2
If a starting screen is specified with --menu/--all/--bs/--is/--register If a starting screen is specified with --menu/--all/--bs/--is/--register
on the command line, it starts there. on the command line, it starts there.
.PP
From the starting screen you can press \f[C]LEFT\f[R] or \f[C]ESC\f[R]
to navigate back to the menu screen.
.SS Menu screen .SS Menu screen
.PP .PP
The top-most screen. The top-most screen.
hledger-ui does not show this screen at startup, but you can press LEFT
to navigate to it.
From here you can navigate to three accounts screens: From here you can navigate to three accounts screens:
.SS All accounts screen .SS All accounts screen
.PP .PP
This screen shows all accounts (possibly filtered by a query), and their This screen shows all accounts (possibly filtered by a query), and their
current balances. end balances on the date shown in the title bar (or their balance
changes in the period shown in the title bar, toggleable with
\f[C]H\f[R]).
It is like the \f[C]hledger balance\f[R] command. It is like the \f[C]hledger balance\f[R] command.
.SS Balance sheet accounts screen .SS Balance sheet accounts screen
.PP .PP
This screen shows asset, liability and equity accounts, if these can be This screen shows asset, liability and equity accounts, if these can be
detected (see account types). detected (see account types).
It always shows historical end balances on some date (not balance It always shows end balances.
changes).
It is like the \f[C]hledger balancesheetequity\f[R] command. It is like the \f[C]hledger balancesheetequity\f[R] command.
.SS Income statement accounts screen .SS Income statement accounts screen
.PP .PP
This screen shows revenue and expense accounts. This screen shows revenue and expense accounts.
It always shows balance changes in some period (not end balances). It always shows balance changes.
It is like the \f[C]hledger incomestatement\f[R] command. It is like the \f[C]hledger incomestatement\f[R] command.
.PP .PP
All of these accounts screens work in much the same way: All of these accounts screens work in much the same way:

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

@ -278,13 +278,13 @@ 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' goes deeper, 'LEFT' returns to the The cursor keys navigate: 'RIGHT' or 'ENTER' goes deeper, 'LEFT'
previous screen, 'UP'/'DOWN'/'PGUP'/'PGDN'/'HOME'/'END' move up and down returns to the previous screen, 'UP'/'DOWN'/'PGUP'/'PGDN'/'HOME'/'END'
through lists. Emacs-style ('CTRL-p'/'CTRL-n'/'CTRL-f'/'CTRL-b') move up and down through lists. Emacs-style
movement keys are also supported (but not vi-style keys, since ('CTRL-p'/'CTRL-n'/'CTRL-f'/'CTRL-b') and VI-style ('k','j','l','h')
hledger-1.19, sorry!). A tip: movement speed is limited by your movement keys are also supported. A tip: movement speed is limited by
keyboard repeat rate, to move faster you may want to adjust it. (If your keyboard repeat rate, to move faster you may want to adjust it.
you're 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.)
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).
@ -375,6 +375,9 @@ following situations:
* If a starting screen is specified with -menu/-all/-bs/-is/-register * If a starting screen is specified with -menu/-all/-bs/-is/-register
on the command line, it starts there. on the command line, it starts there.
From the starting screen you can press 'LEFT' or 'ESC' to navigate
back to the menu screen.
* Menu: * Menu:
* Menu screen:: * Menu screen::
@ -391,9 +394,8 @@ File: hledger-ui.info, Node: Menu screen, Next: All accounts screen, Up: SCRE
4.1 Menu screen 4.1 Menu screen
=============== ===============
The top-most screen. hledger-ui does not show this screen at startup, The top-most screen. From here you can navigate to three accounts
but you can press LEFT to navigate to it. From here you can navigate to screens:
three accounts screens:
 
File: hledger-ui.info, Node: All accounts screen, Next: Balance sheet accounts screen, Prev: Menu screen, Up: SCREENS File: hledger-ui.info, Node: All accounts screen, Next: Balance sheet accounts screen, Prev: Menu screen, Up: SCREENS
@ -402,7 +404,9 @@ File: hledger-ui.info, Node: All accounts screen, Next: Balance sheet accounts
======================= =======================
This screen shows all accounts (possibly filtered by a query), and their This screen shows all accounts (possibly filtered by a query), and their
current balances. It is like the 'hledger balance' command. end balances on the date shown in the title bar (or their balance
changes in the period shown in the title bar, toggleable with 'H'). It
is like the 'hledger balance' command.
 
File: hledger-ui.info, Node: Balance sheet accounts screen, Next: Income statement accounts screen, Prev: All accounts screen, Up: SCREENS File: hledger-ui.info, Node: Balance sheet accounts screen, Next: Income statement accounts screen, Prev: All accounts screen, Up: SCREENS
@ -411,9 +415,8 @@ File: hledger-ui.info, Node: Balance sheet accounts screen, Next: Income state
================================= =================================
This screen shows asset, liability and equity accounts, if these can be This screen shows asset, liability and equity accounts, if these can be
detected (see account types). It always shows historical end balances detected (see account types). It always shows end balances. It is like
on some date (not balance changes). It is like the 'hledger the 'hledger balancesheetequity' command.
balancesheetequity' command.
 
File: hledger-ui.info, Node: Income statement accounts screen, Next: Register screen, Prev: Balance sheet accounts screen, Up: SCREENS File: hledger-ui.info, Node: Income statement accounts screen, Next: Register screen, Prev: Balance sheet accounts screen, Up: SCREENS
@ -422,8 +425,7 @@ File: hledger-ui.info, Node: Income statement accounts screen, Next: Register
==================================== ====================================
This screen shows revenue and expense accounts. It always shows balance This screen shows revenue and expense accounts. It always shows balance
changes in some period (not end balances). It is like the 'hledger changes. It is like the 'hledger incomestatement' command.
incomestatement' command.
All of these accounts screens work in much the same way: All of these accounts screens work in much the same way:
@ -703,34 +705,34 @@ Node: MOUSE6839
Ref: #mouse6934 Ref: #mouse6934
Node: KEYS7216 Node: KEYS7216
Ref: #keys7309 Ref: #keys7309
Node: SCREENS11395 Node: SCREENS11384
Ref: #screens11493 Ref: #screens11482
Node: Menu screen12123 Node: Menu screen12208
Ref: #menu-screen12243 Ref: #menu-screen12328
Node: All accounts screen12412 Node: All accounts screen12405
Ref: #all-accounts-screen12586 Ref: #all-accounts-screen12579
Node: Balance sheet accounts screen12721 Node: Balance sheet accounts screen12830
Ref: #balance-sheet-accounts-screen12936 Ref: #balance-sheet-accounts-screen13045
Node: Income statement accounts screen13170 Node: Income statement accounts screen13233
Ref: #income-statement-accounts-screen13387 Ref: #income-statement-accounts-screen13450
Node: Register screen15832 Node: Register screen15861
Ref: #register-screen16004 Ref: #register-screen16033
Node: Transaction screen17988 Node: Transaction screen18017
Ref: #transaction-screen18146 Ref: #transaction-screen18175
Node: Error screen19016 Node: Error screen19045
Ref: #error-screen19138 Ref: #error-screen19167
Node: TIPS19382 Node: TIPS19411
Ref: #tips19481 Ref: #tips19510
Node: Watch mode19523 Node: Watch mode19552
Ref: #watch-mode19630 Ref: #watch-mode19659
Node: Debug output21086 Node: Debug output21115
Ref: #debug-output21197 Ref: #debug-output21226
Node: ENVIRONMENT21409 Node: ENVIRONMENT21438
Ref: #environment21520 Ref: #environment21549
Node: FILES22905 Node: FILES22934
Ref: #files23004 Ref: #files23033
Node: BUGS23217 Node: BUGS23246
Ref: #bugs23294 Ref: #bugs23323
 
End Tag Table End Tag Table

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

@ -237,13 +237,13 @@ KEYS
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 goes deeper, LEFT returns to the previ- The cursor keys navigate: RIGHT or ENTER goes deeper, LEFT returns to
ous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down through lists. the previous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down
Emacs-style (CTRL-p/CTRL-n/CTRL-f/CTRL-b) movement keys are also sup- through lists. Emacs-style (CTRL-p/CTRL-n/CTRL-f/CTRL-b) and VI-style
ported (but not vi-style keys, since hledger-1.19, sorry!). A tip: (k,j,l,h) movement keys are also supported. A tip: movement speed is
movement speed is limited by your keyboard repeat rate, to move faster limited by your keyboard repeat rate, to move faster you may want to
you may want to adjust it. (If you're on a mac, the karabiner app is adjust it. (If you're on a mac, the karabiner app is one way to do
one way to do that.) 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-
@ -327,25 +327,27 @@ SCREENS
o If a starting screen is specified with --menu/--all/--bs/--is/--reg- o If a starting screen is specified with --menu/--all/--bs/--is/--reg-
ister on the command line, it starts there. ister on the command line, it starts there.
From the starting screen you can press LEFT or ESC to navigate back to
the menu screen.
Menu screen Menu screen
The top-most screen. hledger-ui does not show this screen at startup, The top-most screen. From here you can navigate to three accounts
but you can press LEFT to navigate to it. From here you can navigate screens:
to three accounts screens:
All accounts screen All accounts screen
This screen shows all accounts (possibly filtered by a query), and This screen shows all accounts (possibly filtered by a query), and
their current balances. It is like the hledger balance command. their end balances on the date shown in the title bar (or their balance
changes in the period shown in the title bar, toggleable with H). It
is like the hledger balance command.
Balance sheet accounts screen Balance sheet accounts screen
This screen shows asset, liability and equity accounts, if these can be This screen shows asset, liability and equity accounts, if these can be
detected (see account types). It always shows historical end balances detected (see account types). It always shows end balances. It is
on some date (not balance changes). It is like the hledger bal- like the hledger balancesheetequity command.
ancesheetequity command.
Income statement accounts screen Income statement accounts screen
This screen shows revenue and expense accounts. It always shows bal- This screen shows revenue and expense accounts. It always shows bal-
ance changes in some period (not end balances). It is like the hledger ance changes. It is like the hledger incomestatement command.
incomestatement command.
All of these accounts screens work in much the same way: All of these accounts screens work in much the same way: