;doc: update manuals

This commit is contained in:
Simon Michael 2022-11-07 16:18:28 -10:00
parent 82aa8f1975
commit 6e5c30ea1a
3 changed files with 198 additions and 134 deletions

View File

@ -53,6 +53,18 @@ watch for data and date changes and reload automatically
\f[B]\f[CB]--theme=default|terminal|greenterm\f[B]\f[R] \f[B]\f[CB]--theme=default|terminal|greenterm\f[B]\f[R]
use this custom display theme use this custom display theme
.TP .TP
\f[B]\f[CB]--menu\f[B]\f[R]
start in the menu screen
.TP
\f[B]\f[CB]--all\f[B]\f[R]
start in the all accounts screen
.TP
\f[B]\f[CB]--bs\f[B]\f[R]
start in the balance sheet accounts screen
.TP
\f[B]\f[CB]--is\f[B]\f[R]
start in the income statement accounts screen
.TP
\f[B]\f[CB]--register=ACCTREGEX\f[B]\f[R] \f[B]\f[CB]--register=ACCTREGEX\f[B]\f[R]
start in the (first) matched account\[aq]s register screen start in the (first) matched account\[aq]s register screen
.TP .TP
@ -335,6 +347,17 @@ reliably reset to normal mode.
.PP .PP
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
.SH SCREENS .SH SCREENS
.PP
hledger-ui can show a number of different screens, described below.
It shows the Balance sheet accounts screen to start with, except in the
following situations:
.IP \[bu] 2
If no asset/liability/equity accounts can be detected, or if an account
query has been given on the command line, it starts in the All accounts
screen.
.IP \[bu] 2
If a starting screen is specified with --menu/--all/--bs/--is/--register
on the command line, it starts there.
.SS Menu screen .SS Menu screen
.PP .PP
The top-most screen. The top-most screen.
@ -343,14 +366,13 @@ 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 (unless filtered by a query), and their This screen shows all accounts (possibly filtered by a query), and their
current balances. current balances.
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 is the screen normally shown at startup. This screen shows asset, liability and equity accounts, if these can be
It shows asset, liability and equity accounts, if these can be detected detected (see account types).
(see account types).
It always shows historical end balances on some date (not balance It always shows historical end balances on some date (not balance
changes). changes).
It is like the \f[C]hledger balancesheetequity\f[R] command. It is like the \f[C]hledger balancesheetequity\f[R] command.

View File

@ -68,6 +68,18 @@ the data.
'--theme=default|terminal|greenterm' '--theme=default|terminal|greenterm'
use this custom display theme use this custom display theme
'--menu'
start in the menu screen
'--all'
start in the all accounts screen
'--bs'
start in the balance sheet accounts screen
'--is'
start in the income statement accounts screen
'--register=ACCTREGEX' '--register=ACCTREGEX'
start in the (first) matched account's register screen start in the (first) matched account's register screen
@ -352,6 +364,17 @@ File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: KEYS, Up: Top
4 SCREENS 4 SCREENS
********* *********
hledger-ui can show a number of different screens, described below. It
shows the Balance sheet accounts screen to start with, except in the
following situations:
* If no asset/liability/equity accounts can be detected, or if an
account query has been given on the command line, it starts in the
All accounts screen.
* If a starting screen is specified with -menu/-all/-bs/-is/-register
on the command line, it starts there.
* Menu: * Menu:
* Menu screen:: * Menu screen::
@ -378,7 +401,7 @@ File: hledger-ui.info, Node: All accounts screen, Next: Balance sheet accounts
4.2 All accounts screen 4.2 All accounts screen
======================= =======================
This screen shows all accounts (unless 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. current balances. It is like the 'hledger balance' command.
 
@ -387,10 +410,10 @@ File: hledger-ui.info, Node: Balance sheet accounts screen, Next: Income state
4.3 Balance sheet accounts screen 4.3 Balance sheet accounts screen
================================= =================================
This is the screen normally shown at startup. It shows asset, liability This screen shows asset, liability and equity accounts, if these can be
and equity accounts, if these can be detected (see account types). It detected (see account types). It always shows historical end balances
always shows historical end balances on some date (not balance changes). on some date (not balance changes). It is like the 'hledger
It is like 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
@ -676,38 +699,38 @@ Tag Table:
Node: Top221 Node: Top221
Node: OPTIONS1657 Node: OPTIONS1657
Ref: #options1755 Ref: #options1755
Node: MOUSE6637 Node: MOUSE6839
Ref: #mouse6732 Ref: #mouse6934
Node: KEYS7014 Node: KEYS7216
Ref: #keys7107 Ref: #keys7309
Node: SCREENS11193 Node: SCREENS11395
Ref: #screens11291 Ref: #screens11493
Node: Menu screen11472 Node: Menu screen12123
Ref: #menu-screen11592 Ref: #menu-screen12243
Node: All accounts screen11761 Node: All accounts screen12412
Ref: #all-accounts-screen11935 Ref: #all-accounts-screen12586
Node: Balance sheet accounts screen12068 Node: Balance sheet accounts screen12721
Ref: #balance-sheet-accounts-screen12283 Ref: #balance-sheet-accounts-screen12936
Node: Income statement accounts screen12554 Node: Income statement accounts screen13170
Ref: #income-statement-accounts-screen12771 Ref: #income-statement-accounts-screen13387
Node: Register screen15216 Node: Register screen15832
Ref: #register-screen15388 Ref: #register-screen16004
Node: Transaction screen17372 Node: Transaction screen17988
Ref: #transaction-screen17530 Ref: #transaction-screen18146
Node: Error screen18400 Node: Error screen19016
Ref: #error-screen18522 Ref: #error-screen19138
Node: TIPS18766 Node: TIPS19382
Ref: #tips18865 Ref: #tips19481
Node: Watch mode18907 Node: Watch mode19523
Ref: #watch-mode19014 Ref: #watch-mode19630
Node: Debug output20470 Node: Debug output21086
Ref: #debug-output20581 Ref: #debug-output21197
Node: ENVIRONMENT20793 Node: ENVIRONMENT21409
Ref: #environment20904 Ref: #environment21520
Node: FILES22289 Node: FILES22905
Ref: #files22388 Ref: #files23004
Node: BUGS22601 Node: BUGS23217
Ref: #bugs22678 Ref: #bugs23294
 
End Tag Table End Tag Table

View File

@ -47,6 +47,14 @@ OPTIONS
--theme=default|terminal|greenterm --theme=default|terminal|greenterm
use this custom display theme use this custom display theme
--menu start in the menu screen
--all start in the all accounts screen
--bs start in the balance sheet accounts screen
--is start in the income statement accounts screen
--register=ACCTREGEX --register=ACCTREGEX
start in the (first) matched account's register screen start in the (first) matched account's register screen
@ -308,20 +316,31 @@ KEYS
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
SCREENS SCREENS
hledger-ui can show a number of different screens, described below. It
shows the Balance sheet accounts screen to start with, except in the
following situations:
o If no asset/liability/equity accounts can be detected, or if an
account query has been given on the command line, it starts in the
All accounts screen.
o If a starting screen is specified with --menu/--all/--bs/--is/--reg-
ister on the command line, it starts there.
Menu screen Menu screen
The top-most screen. hledger-ui does not show this screen at startup, 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 but you can press LEFT to navigate to it. From here you can navigate
to three accounts screens: to three accounts screens:
All accounts screen All accounts screen
This screen shows all accounts (unless filtered by a query), and their This screen shows all accounts (possibly filtered by a query), and
current balances. It is like the hledger balance command. their current balances. It is like the hledger balance command.
Balance sheet accounts screen Balance sheet accounts screen
This is the screen normally shown at startup. It shows asset, liabil- This screen shows asset, liability and equity accounts, if these can be
ity and equity accounts, if these can be detected (see account types). detected (see account types). It always shows historical end balances
It always shows historical end balances on some date (not balance on some date (not balance changes). It is like the hledger bal-
changes). It is 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-