mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-18 17:57:11 +03:00
;doc: update manuals
This commit is contained in:
Simon Michael
parent
1f385ae774
commit
4a1d900c51
@ -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.
|
||||
The following keys work on most screens:
|
||||
.PP
|
||||
The cursor keys navigate: \f[C]RIGHT\f[R] goes deeper, \f[C]LEFT\f[R]
|
||||
returns to the previous screen,
|
||||
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]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])
|
||||
movement keys are also supported (but not vi-style keys, since
|
||||
hledger-1.19, sorry!).
|
||||
and VI-style (\f[C]k\f[R],\f[C]j\f[R],\f[C]l\f[R],\f[C]h\f[R]) movement
|
||||
keys are also supported.
|
||||
A tip: movement speed is limited by your keyboard repeat rate, to move
|
||||
faster you may want to adjust it.
|
||||
(If you\[aq]re on a mac, the karabiner app is one way to do that.)
|
||||
@ -358,28 +358,30 @@ screen.
|
||||
.IP \[bu] 2
|
||||
If a starting screen is specified with --menu/--all/--bs/--is/--register
|
||||
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
|
||||
.PP
|
||||
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:
|
||||
.SS All accounts screen
|
||||
.PP
|
||||
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.
|
||||
.SS Balance sheet accounts screen
|
||||
.PP
|
||||
This screen shows asset, liability and equity accounts, if these can be
|
||||
detected (see account types).
|
||||
It always shows historical end balances on some date (not balance
|
||||
changes).
|
||||
It always shows end balances.
|
||||
It is like the \f[C]hledger balancesheetequity\f[R] command.
|
||||
.SS Income statement accounts screen
|
||||
.PP
|
||||
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.
|
||||
.PP
|
||||
All of these accounts screens work in much the same way:
|
||||
|
||||
@ -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
|
||||
most screens:
|
||||
|
||||
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.)
|
||||
The cursor keys navigate: 'RIGHT' or 'ENTER' 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') and VI-style ('k','j','l','h')
|
||||
movement keys are also supported. 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).
|
||||
@ -375,6 +375,9 @@ following situations:
|
||||
* If a starting screen is specified with -menu/-all/-bs/-is/-register
|
||||
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 screen::
|
||||
@ -391,9 +394,8 @@ File: hledger-ui.info, Node: Menu screen, Next: All accounts screen, Up: SCRE
|
||||
4.1 Menu 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:
|
||||
The top-most screen. From here you can navigate to three accounts
|
||||
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
|
||||
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
|
||||
@ -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
|
||||
detected (see account types). It always shows historical end balances
|
||||
on some date (not balance changes). It is like the 'hledger
|
||||
balancesheetequity' command.
|
||||
detected (see account types). It always shows end balances. It is like
|
||||
the 'hledger balancesheetequity' command.
|
||||
|
||||
|
||||
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
|
||||
changes in some period (not end balances). It is like the 'hledger
|
||||
incomestatement' command.
|
||||
changes. It is like the 'hledger incomestatement' command.
|
||||
|
||||
All of these accounts screens work in much the same way:
|
||||
|
||||
@ -703,34 +705,34 @@ Node: MOUSE6839
|
||||
Ref: #mouse6934
|
||||
Node: KEYS7216
|
||||
Ref: #keys7309
|
||||
Node: SCREENS11395
|
||||
Ref: #screens11493
|
||||
Node: Menu screen12123
|
||||
Ref: #menu-screen12243
|
||||
Node: All accounts screen12412
|
||||
Ref: #all-accounts-screen12586
|
||||
Node: Balance sheet accounts screen12721
|
||||
Ref: #balance-sheet-accounts-screen12936
|
||||
Node: Income statement accounts screen13170
|
||||
Ref: #income-statement-accounts-screen13387
|
||||
Node: Register screen15832
|
||||
Ref: #register-screen16004
|
||||
Node: Transaction screen17988
|
||||
Ref: #transaction-screen18146
|
||||
Node: Error screen19016
|
||||
Ref: #error-screen19138
|
||||
Node: TIPS19382
|
||||
Ref: #tips19481
|
||||
Node: Watch mode19523
|
||||
Ref: #watch-mode19630
|
||||
Node: Debug output21086
|
||||
Ref: #debug-output21197
|
||||
Node: ENVIRONMENT21409
|
||||
Ref: #environment21520
|
||||
Node: FILES22905
|
||||
Ref: #files23004
|
||||
Node: BUGS23217
|
||||
Ref: #bugs23294
|
||||
Node: SCREENS11384
|
||||
Ref: #screens11482
|
||||
Node: Menu screen12208
|
||||
Ref: #menu-screen12328
|
||||
Node: All accounts screen12405
|
||||
Ref: #all-accounts-screen12579
|
||||
Node: Balance sheet accounts screen12830
|
||||
Ref: #balance-sheet-accounts-screen13045
|
||||
Node: Income statement accounts screen13233
|
||||
Ref: #income-statement-accounts-screen13450
|
||||
Node: Register screen15861
|
||||
Ref: #register-screen16033
|
||||
Node: Transaction screen18017
|
||||
Ref: #transaction-screen18175
|
||||
Node: Error screen19045
|
||||
Ref: #error-screen19167
|
||||
Node: TIPS19411
|
||||
Ref: #tips19510
|
||||
Node: Watch mode19552
|
||||
Ref: #watch-mode19659
|
||||
Node: Debug output21115
|
||||
Ref: #debug-output21226
|
||||
Node: ENVIRONMENT21438
|
||||
Ref: #environment21549
|
||||
Node: FILES22934
|
||||
Ref: #files23033
|
||||
Node: BUGS23246
|
||||
Ref: #bugs23323
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
||||
@ -237,13 +237,13 @@ KEYS
|
||||
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 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.)
|
||||
The cursor keys navigate: RIGHT or ENTER 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) and VI-style
|
||||
(k,j,l,h) movement keys are also supported. 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-
|
||||
@ -327,25 +327,27 @@ SCREENS
|
||||
o If a starting screen is specified with --menu/--all/--bs/--is/--reg-
|
||||
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
|
||||
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:
|
||||
The top-most screen. From here you can navigate to three accounts
|
||||
screens:
|
||||
|
||||
All accounts screen
|
||||
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
|
||||
This screen shows asset, liability and equity accounts, if these can be
|
||||
detected (see account types). It always shows historical end balances
|
||||
on some date (not balance changes). It is like the hledger bal-
|
||||
ancesheetequity command.
|
||||
detected (see account types). It always shows end balances. It is
|
||||
like the hledger balancesheetequity command.
|
||||
|
||||
Income statement accounts screen
|
||||
This screen shows revenue and expense accounts. It always shows bal-
|
||||
ance changes in some period (not end balances). It is like the hledger
|
||||
incomestatement command.
|
||||
This screen shows revenue and expense accounts. It always shows bal-
|
||||
ance changes. It is like the hledger incomestatement command.
|
||||
|
||||
All of these accounts screens work in much the same way:
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user