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 2023-03-24 10:33:17 -10:00
parent ce07424164
commit 4c29669750
3 changed files with 232 additions and 354 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -59,8 +59,8 @@ use this custom display theme
\f[V]--menu\f[R]
start in the menu screen
.TP
\f[V]--all\f[R]
start in the all accounts screen
\f[V]--cash\f[R]
start in the cash accounts screen
.TP
\f[V]--bs\f[R]
start in the balance sheet accounts screen
@ -68,6 +68,9 @@ start in the balance sheet accounts screen
\f[V]--is\f[R]
start in the income statement accounts screen
.TP
\f[V]--all\f[R]
start in the all accounts screen
.TP
\f[V]--register=ACCTREGEX\f[R]
start in the (first) matched account\[aq]s register screen
.TP
@ -361,100 +364,49 @@ reliably reset to normal mode.
Additional screen-specific keys are described below.
.SH SCREENS
.PP
hledger-ui shows several different screens, described below.
It shows the \[dq]Balance sheet accounts\[dq] 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 \[dq]All
accounts\[dq] screen.
.IP \[bu] 2
If a starting screen is specified with --menu/--all/--bs/--is/--register
on the command line, it starts in that screen.
At startup, hledger-ui shows a menu screen by default.
From here you can navigate to other screens using the cursor keys:
\f[V]UP\f[R]/\f[V]DOWN\f[R] to select, \f[V]RIGHT\f[R] to move to the
selected screen, \f[V]LEFT\f[R] to return to the previous screen.
Or you can use \f[V]ESC\f[R] to return directly to the top menu screen.
.PP
From any screen you can press \f[V]LEFT\f[R] or \f[V]ESC\f[R] to
navigate back to the top level \[dq]Menu\[dq] screen.
You can also use a command line flag to specific a different startup
screen (\f[V]--cs\f[R], \f[V]--bs\f[R], \f[V]--is\f[R], \f[V]--all\f[R],
or \f[V]--register=ACCT\f[R]).
.SS Menu
.PP
The top-most screen.
From here you can navigate to three accounts screens:
.SS All accounts
This is the top-most screen.
From here you can navigate to several screens listing accounts of
various types.
Note some of these may not show anything until you have configured
account types.
.SS Cash accounts
.PP
This screen shows all accounts (possibly filtered by a query), and 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
\f[V]H\f[R]).
It is like the \f[V]hledger balance\f[R] command.
This screen shows \[dq]cash\[dq] (ie, liquid asset) accounts (like
\f[V]hledger balancesheet type:c\f[R]).
It always shows balances (historical ending balances on the date shown
in the title line).
.SS Balance sheet accounts
.PP
This screen shows asset, liability and equity accounts, if these can be
detected (see account types).
It always shows end balances.
It is like the \f[V]hledger balancesheetequity\f[R] command.
This screen shows asset, liability and equity accounts (like
\f[V]hledger balancesheetequity\f[R]).
It always shows balances.
.SS Income statement accounts
.PP
This screen shows revenue and expense accounts.
It always shows balance changes.
It is like the \f[V]hledger incomestatement\f[R] command.
This screen shows revenue and expense accounts (like
\f[V]hledger incomestatement\f[R]).
It always shows changes (balance changes in the period shown in the
title line).
.SS All accounts
.PP
All of these accounts screens work in much the same way:
.PP
They show accounts which have been posted to by transactions, as well as
accounts which have been declared with an account directive (except for
empty parent accounts).
.PP
If you specify a query on the command line or with \f[V]/\f[R] in the
app, they show just the matched accounts, and the balances from matched
transactions.
.PP
hledger-ui shows accounts with zero balances by default (unlike
command-line hledger).
To hide these, press \f[V]z\f[R] to toggle nonzero mode.
.PP
Account names are shown as a flat list by default; press \f[V]t\f[R] to
toggle tree mode.
In list mode, account balances are exclusive of subaccounts, except
where subaccounts are hidden by a depth limit (see below).
In tree mode, all account balances are inclusive of subaccounts.
.PP
To see less detail, press a number key, \f[V]1\f[R] to \f[V]9\f[R], to
set a depth limit.
Or use \f[V]-\f[R] to decrease and \f[V]+\f[R]/\f[V]=\f[R] to increase
the depth limit.
\f[V]0\f[R] shows even less detail, collapsing all accounts to a single
total.
To remove the depth limit, set it higher than the maximum account depth,
or press \f[V]ESCAPE\f[R].
.PP
\f[V]H\f[R] toggles between showing historical balances or period
balances (on the \[dq]All accounts\[dq] screen).
Historical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before the
start of the report period.
In other words, historical balances are what you would see on a bank
statement for that account (unless disturbed by a filter query).
Period balances ignore transactions before the report start date, so
they show the change in balance during the report period.
They are more useful eg when viewing a time log.
.PP
\f[V]U\f[R] toggles filtering by unmarked status, including or excluding
unmarked postings in the balances.
Similarly, \f[V]P\f[R] toggles pending postings, and \f[V]C\f[R] toggles
cleared postings.
(By default, balances include all postings; if you activate one or two
status filters, only those postings are included; and if you activate
all three, the filter is removed.)
.PP
\f[V]R\f[R] toggles real mode, in which virtual postings are ignored.
.PP
Press \f[V]RIGHT\f[R] to view an account\[aq]s register screen, Or,
\f[V]LEFT\f[R] to see the menu screen.
This screen shows all accounts in your journal (unless filtered by a
query; like \f[V]hledger balance\f[R]).
It shows balances by default; you can toggle showing changes with the
\f[V]H\f[R] key.
.SS Register
.PP
This screen shows the transactions affecting a particular account, like
a check register.
Each line represents one transaction and shows:
This screen shows the transactions affecting a particular account.
Each line represents one transaction, and shows:
.IP \[bu] 2
the other account(s) involved, in abbreviated form.
(If there are both real and virtual postings, it shows only the accounts
@ -463,15 +415,18 @@ affected by real postings.)
the overall change to the current account\[aq]s balance; positive for an
inflow to this account, negative for an outflow.
.IP \[bu] 2
the running historical total or period total for the current account,
after the transaction.
This can be toggled with \f[V]H\f[R].
Similar to the accounts screen, the historical total is affected by
transactions (filtered by the filter query) before the report start
date, while the period total is not.
If the historical total is not disturbed by a filter query, it will be
the running historical balance you would see on a bank register for the
current account.
the running total after the transaction.
With the \f[V]H\f[R] key you can toggle between
.RS 2
.IP \[bu] 2
the period total, which is from just the transactions displayed
.IP \[bu] 2
or the historical total, which includes any undisplayed transactions
before the start of the report period (and matching the filter query if
any).
This will be the running historical balance (what you would see on a
bank\[aq]s website, eg) if not disturbed by a query.
.RE
.PP
Transactions affecting this account\[aq]s subaccounts will be included
in the register if the accounts screen is in tree mode, or if it\[aq]s

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

@ -74,15 +74,18 @@ the data.
‘--menu’
start in the menu screen
‘--all’
‘--cash’
start in the all accounts screen
start in the cash accounts screen
‘--bs’
start in the balance sheet accounts screen
‘--is’
start in the income statement accounts screen
‘--all’
start in the all accounts screen
‘--register=ACCTREGEX’
start in the (first) matched account’s register screen
@ -374,125 +377,83 @@ File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: KEYS, Up: Top
4 SCREENS
*********
hledger-ui shows several different screens, described below. It shows
the "Balance sheet accounts" screen to start with, except in the
following situations:
At startup, hledger-ui shows a menu screen by default. From here you
can navigate to other screens using the cursor keys: ‘UP’/‘DOWN’ to
select, ‘RIGHT’ to move to the selected screen, ‘LEFT’ to return to the
previous screen. Or you can use ‘ESC’ to return directly to the top
menu screen.
• 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 in that screen.
From any screen you can press ‘LEFT’ or ‘ESC’ to navigate back to the
top level "Menu" screen.
You can also use a command line flag to specific a different startup
screen (‘--cs’, ‘--bs’, ‘--is’, ‘--all’, or ‘--register=ACCT’).
* Menu:
* Menu::
* All accounts::
* Cash accounts::
* Balance sheet accounts::
* Income statement accounts::
* All accounts::
* Register::
* Transaction::
* Error::

File: hledger-ui.info, Node: Menu, Next: All accounts, Up: SCREENS
File: hledger-ui.info, Node: Menu, Next: Cash accounts, Up: SCREENS
4.1 Menu
========
The top-most screen. From here you can navigate to three accounts
screens:
This is the top-most screen. From here you can navigate to several
screens listing accounts of various types. Note some of these may not
show anything until you have configured account types.

File: hledger-ui.info, Node: All accounts, Next: Balance sheet accounts, Prev: Menu, Up: SCREENS
File: hledger-ui.info, Node: Cash accounts, Next: Balance sheet accounts, Prev: Menu, Up: SCREENS
4.2 All accounts
================
4.2 Cash accounts
=================
This screen shows all accounts (possibly filtered by a query), and 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.
This screen shows "cash" (ie, liquid asset) accounts (like ‘hledger
balancesheet type:c’). It always shows balances (historical ending
balances on the date shown in the title line).

File: hledger-ui.info, Node: Balance sheet accounts, Next: Income statement accounts, Prev: All accounts, Up: SCREENS
File: hledger-ui.info, Node: Balance sheet accounts, Next: Income statement accounts, Prev: Cash accounts, Up: SCREENS
4.3 Balance sheet accounts
==========================
This screen shows asset, liability and equity accounts, if these can be
detected (see account types). It always shows end balances. It is like
the ‘hledger balancesheetequity’ command.
This screen shows asset, liability and equity accounts (like ‘hledger
balancesheetequity’). It always shows balances.

File: hledger-ui.info, Node: Income statement accounts, Next: Register, Prev: Balance sheet accounts, Up: SCREENS
File: hledger-ui.info, Node: Income statement accounts, Next: All accounts, Prev: Balance sheet accounts, Up: SCREENS
4.4 Income statement accounts
=============================
This screen shows revenue and expense accounts. It always shows balance
changes. It is like the ‘hledger incomestatement’ command.
All of these accounts screens work in much the same way:
They show accounts which have been posted to by transactions, as well
as accounts which have been declared with an account directive (except
for empty parent accounts).
If you specify a query on the command line or with ‘/’ in the app,
they show just the matched accounts, and the balances from matched
transactions.
hledger-ui shows accounts with zero balances by default (unlike
command-line hledger). To hide these, press ‘z’ to toggle nonzero mode.
Account names are shown as a flat list by default; press ‘t’ to
toggle tree mode. In list mode, account balances are exclusive of
subaccounts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of
subaccounts.
To see less detail, press a number key, ‘1’ to ‘9’, to set a depth
limit. Or use ‘-’ to decrease and ‘+’/‘=’ to increase the depth limit.
‘0’ shows even less detail, collapsing all accounts to a single total.
To remove the depth limit, set it higher than the maximum account depth,
or press ‘ESCAPE’.
‘H’ toggles between showing historical balances or period balances
(on the "All accounts" screen). Historical balances (the default) are
ending balances at the end of the report period, taking into account all
transactions before that date (filtered by the filter query if any),
including transactions before the start of the report period. In other
words, historical balances are what you would see on a bank statement
for that account (unless disturbed by a filter query). Period balances
ignore transactions before the report start date, so they show the
change in balance during the report period. They are more useful eg
when viewing a time log.
‘U’ toggles filtering by unmarked status, including or excluding
unmarked postings in the balances. Similarly, ‘P’ toggles pending
postings, and ‘C’ toggles cleared postings. (By default, balances
include all postings; if you activate one or two status filters, only
those postings are included; and if you activate all three, the filter
is removed.)
‘R’ toggles real mode, in which virtual postings are ignored.
Press ‘RIGHT’ to view an account’s register screen, Or, ‘LEFT’ to see
the menu screen.
This screen shows revenue and expense accounts (like ‘hledger
incomestatement’). It always shows changes (balance changes in the
period shown in the title line).

File: hledger-ui.info, Node: Register, Next: Transaction, Prev: Income statement accounts, Up: SCREENS
File: hledger-ui.info, Node: All accounts, Next: Register, Prev: Income statement accounts, Up: SCREENS
4.5 Register
4.5 All accounts
================
This screen shows all accounts in your journal (unless filtered by a
query; like ‘hledger balance’). It shows balances by default; you can
toggle showing changes with the ‘H’ key.

File: hledger-ui.info, Node: Register, Next: Transaction, Prev: All accounts, Up: SCREENS
4.6 Register
============
This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows:
This screen shows the transactions affecting a particular account. Each
line represents one transaction, and shows:
• the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected
@ -501,13 +462,16 @@ a check register. Each line represents one transaction and shows:
• the overall change to the current account’s balance; positive for
an inflow to this account, negative for an outflow.
• the running historical total or period total for the current
account, after the transaction. This can be toggled with ‘H’.
Similar to the accounts screen, the historical total is affected by
transactions (filtered by the filter query) before the report start
date, while the period total is not. If the historical total is
not disturbed by a filter query, it will be the running historical
balance you would see on a bank register for the current account.
• the running total after the transaction. With the ‘H’ key you can
toggle between
• the period total, which is from just the transactions
displayed
• or the historical total, which includes any undisplayed
transactions before the start of the report period (and
matching the filter query if any). This will be the running
historical balance (what you would see on a bank’s website,
eg) if not disturbed by a query.
Transactions affecting this account’s subaccounts will be included in
the register if the accounts screen is in tree mode, or if it’s in list
@ -534,7 +498,7 @@ command-line hledger).

File: hledger-ui.info, Node: Transaction, Next: Error, Prev: Register, Up: SCREENS
4.6 Transaction
4.7 Transaction
===============
This screen shows a single transaction, as a general journal entry,
@ -558,7 +522,7 @@ reload).

File: hledger-ui.info, Node: Error, Prev: Transaction, Up: SCREENS
4.7 Error
4.8 Error
=========
This screen will appear if there is a problem, such as a parse error,
@ -708,38 +672,40 @@ Tag Table:
Node: Top223
Node: OPTIONS1871
Ref: #options1969
Node: MOUSE7336
Ref: #mouse7431
Node: KEYS7674
Ref: #keys7767
Node: SCREENS12526
Ref: #screens12624
Node: Menu13332
Ref: #menu13424
Node: All accounts13501
Ref: #all-accounts13640
Node: Balance sheet accounts13899
Ref: #balance-sheet-accounts14079
Node: Income statement accounts14271
Ref: #income-statement-accounts14453
Node: Register16947
Ref: #register17084
Node: Transaction19112
Ref: #transaction19235
Node: Error20119
Ref: #error20213
Node: TIPS20457
Ref: #tips20556
Node: Watch mode20598
Ref: #watch-mode20705
Node: Debug output22193
Ref: #debug-output22304
Node: ENVIRONMENT22524
Ref: #environment22635
Node: FILES24058
Ref: #files24157
Node: BUGS24417
Ref: #bugs24494
Node: MOUSE7389
Ref: #mouse7484
Node: KEYS7727
Ref: #keys7820
Node: SCREENS12579
Ref: #screens12677
Node: Menu13297
Ref: #menu13390
Node: Cash accounts13585
Ref: #cash-accounts13727
Node: Balance sheet accounts13915
Ref: #balance-sheet-accounts14096
Node: Income statement accounts14220
Ref: #income-statement-accounts14406
Node: All accounts14574
Ref: #all-accounts14720
Node: Register14910
Ref: #register15034
Node: Transaction17046
Ref: #transaction17169
Node: Error18053
Ref: #error18147
Node: TIPS18391
Ref: #tips18490
Node: Watch mode18532
Ref: #watch-mode18639
Node: Debug output20127
Ref: #debug-output20238
Node: ENVIRONMENT20458
Ref: #environment20569
Node: FILES21992
Ref: #files22091
Node: BUGS22351
Ref: #bugs22428

End Tag Table

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

@ -52,12 +52,14 @@ OPTIONS
--menu start in the menu screen
--all start in the all accounts screen
--cash start in the cash accounts screen
--bs start in the balance sheet accounts screen
--is start in the income statement accounts screen
--all start in the all accounts screen
--register=ACCTREGEX
start in the (first) matched account's register screen
@ -327,89 +329,41 @@ KEYS
Additional screen-specific keys are described below.
SCREENS
hledger-ui shows several different screens, described below. It shows
the "Balance sheet accounts" screen to start with, except in the fol-
lowing situations:
At startup, hledger-ui shows a menu screen by default. From here you
can navigate to other screens using the cursor keys: UP/DOWN to select,
RIGHT to move to the selected screen, LEFT to return to the previous
screen. Or you can use ESC to return directly to the top menu screen.
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 in that screen.
From any screen you can press LEFT or ESC to navigate back to the top
level "Menu" screen.
You can also use a command line flag to specific a different startup
screen (--cs, --bs, --is, --all, or --register=ACCT).
Menu
The top-most screen. From here you can navigate to three accounts
screens:
This is the top-most screen. From here you can navigate to several
screens listing accounts of various types. Note some of these may not
show anything until you have configured account types.
All accounts
This screen shows all accounts (possibly filtered by a query), and
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.
Cash accounts
This screen shows "cash" (ie, liquid asset) accounts (like hledger bal-
ancesheet type:c). It always shows balances (historical ending bal-
ances on the date shown in the title line).
Balance sheet accounts
This screen shows asset, liability and equity accounts, if these can be
detected (see account types). It always shows end balances. It is
like the hledger balancesheetequity command.
This screen shows asset, liability and equity accounts (like hledger
balancesheetequity). It always shows balances.
Income statement accounts
This screen shows revenue and expense accounts. It always shows bal-
ance changes. It is like the hledger incomestatement command.
This screen shows revenue and expense accounts (like hledger incomes-
tatement). It always shows changes (balance changes in the period
shown in the title line).
All of these accounts screens work in much the same way:
They show accounts which have been posted to by transactions, as well
as accounts which have been declared with an account directive (except
for empty parent accounts).
If you specify a query on the command line or with / in the app, they
show just the matched accounts, and the balances from matched transac-
tions.
hledger-ui shows accounts with zero balances by default (unlike com-
mand-line hledger). To hide these, press z to toggle nonzero mode.
Account names are shown as a flat list by default; press t to toggle
tree mode. In list mode, account balances are exclusive of subac-
counts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of subac-
counts.
To see less detail, press a number key, 1 to 9, to set a depth limit.
Or use - to decrease and +/= to increase the depth limit. 0 shows even
less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press
ESCAPE.
H toggles between showing historical balances or period balances (on
the "All accounts" screen). Historical balances (the default) are end-
ing balances at the end of the report period, taking into account all
transactions before that date (filtered by the filter query if any),
including transactions before the start of the report period. In other
words, historical balances are what you would see on a bank statement
for that account (unless disturbed by a filter query). Period balances
ignore transactions before the report start date, so they show the
change in balance during the report period. They are more useful eg
when viewing a time log.
U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are
included; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored.
Press RIGHT to view an account's register screen, Or, LEFT to see the
menu screen.
All accounts
This screen shows all accounts in your journal (unless filtered by a
query; like hledger balance). It shows balances by default; you can
toggle showing changes with the H key.
Register
This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows:
This screen shows the transactions affecting a particular account.
Each line represents one transaction, and shows:
o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected
@ -418,13 +372,16 @@ SCREENS
o the overall change to the current account's balance; positive for an
inflow to this account, negative for an outflow.
o the running historical total or period total for the current account,
after the transaction. This can be toggled with H. Similar to the
accounts screen, the historical total is affected by transactions
(filtered by the filter query) before the report start date, while
the period total is not. If the historical total is not disturbed by
a filter query, it will be the running historical balance you would
see on a bank register for the current account.
o the running total after the transaction. With the H key you can tog-
gle between
o the period total, which is from just the transactions displayed
o or the historical total, which includes any undisplayed transac-
tions before the start of the report period (and matching the fil-
ter query if any). This will be the running historical balance
(what you would see on a bank's website, eg) if not disturbed by a
query.
Transactions affecting this account's subaccounts will be included in
the register if the accounts screen is in tree mode, or if it's in list