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

;regen manuals

Browse Source
This commit is contained in:
Simon Michael 2020-07-18 12:37:06 -07:00
parent 58695f9c29
commit 21b91f17cb
12 changed files with 828 additions and 681 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

148
hledger-lib/hledger_journal.5
View File

@ -1381,38 +1381,132 @@ account ACCTNAME [ACCTTYPE] [;COMMENT]
.fi
.SS Account types
.PP
hledger recognises five types (or classes) of account: Asset, Liability,
Equity, Revenue, Expense.
This is used by a few accounting-aware reports such as balancesheet,
incomestatement and cashflow.
.SS Auto-detected account types
hledger recognises five main types of account, corresponding to the
account classes in the accounting equation:
.PP
If you name your top-level accounts with some variation of
\f[C]assets\f[R], \f[C]liabilities\f[R]/\f[C]debts\f[R],
\f[C]equity\f[R], \f[C]revenues\f[R]/\f[C]income\f[R], or
\f[C]expenses\f[R], their types are detected automatically.
.SS Account types declared with tags
\f[C]Asset\f[R], \f[C]Liability\f[R], \f[C]Equity\f[R],
\f[C]Revenue\f[R], \f[C]Expense\f[R].
.PP
More generally, you can declare an account\[aq]s type with an account
directive, by writing a \f[C]type:\f[R] tag in a comment, followed by
one of the words \f[C]Asset\f[R], \f[C]Liability\f[R], \f[C]Equity\f[R],
\f[C]Revenue\f[R], \f[C]Expense\f[R], or one of the letters
\f[C]ALERX\f[R] (case insensitive):
These account types are important for controlling which accounts appear
in the balancesheet, balancesheetequity, incomestatement reports (and
probably for other things in future).
.PP
Additionally, we recognise the \f[C]Cash\f[R] type, which is also an
\f[C]Asset\f[R], and which causes accounts to appear in the cashflow
report.
(\[dq]Cash\[dq] here means liquid assets, eg bank balances but typically
not investments or receivables.)
.SS Declaring account types
.PP
Generally, to make these reports work you should declare your top-level
accounts and their types, using account directives with \f[C]type:\f[R]
tags.
.PP
The tag\[aq]s value should be one of: \f[C]Asset\f[R],
\f[C]Liability\f[R], \f[C]Equity\f[R], \f[C]Revenue\f[R],
\f[C]Expense\f[R], \f[C]Cash\f[R], \f[C]A\f[R], \f[C]L\f[R],
\f[C]E\f[R], \f[C]R\f[R], \f[C]X\f[R], \f[C]C\f[R] (all case
insensitive).
The type is inherited by all subaccounts except where they override it.
Here\[aq]s a complete example:
.IP
.nf
\f[C]
account assets ; type: Asset
account assets:bank ; type: Cash
account assets:cash ; type: Cash
account liabilities ; type: Liability
account equity ; type: Equity
account revenues ; type: Revenue
account expenses ; type: Expense
\f[R]
.fi
.SS Account types declared with account type codes
.SS Auto-detected account types
.PP
Or, you can write one of those letters separated from the account name
by two or more spaces, but this should probably be considered deprecated
as of hledger 1.13:
If you happen to use common english top-level account names, you may not
need to declare account types, as they will be detected automatically
using the following rules:
.PP
.TS
tab(@);
l l.
T{
If name matches regular expression:
T}@T{
account type is:
T}
_
T{
\f[C]\[ha]assets?(:|$)\f[R]
T}@T{
\f[C]Asset\f[R]
T}
T{
\f[C]\[ha](debts?|liabilit(y|ies))(:|$)\f[R]
T}@T{
\f[C]Liability\f[R]
T}
T{
\f[C]\[ha]equity(:|$)\f[R]
T}@T{
\f[C]Equity\f[R]
T}
T{
\f[C]\[ha](income|revenue)s?(:|$)\f[R]
T}@T{
\f[C]Revenue\f[R]
T}
T{
\f[C]\[ha]expenses?(:|$)\f[R]
T}@T{
\f[C]Expense\f[R]
T}
.TE
.PP
.TS
tab(@);
lw(56.9n) lw(13.1n).
T{
If account type is \f[C]Asset\f[R] and name does not contain regular
expression:
T}@T{
account type is:
T}
_
T{
\f[C](investment|receivable|:A/R|:fixed)\f[R]
T}@T{
\f[C]Cash\f[R]
T}
.TE
.PP
Even so, explicit declarations may be a good idea, for clarity and
predictability.
.SS Interference from auto-detected account types
.PP
If you assign any account type, it\[aq]s a good idea to assign all of
them, to prevent any confusion from mixing declared and auto-detected
types.
Although it\[aq]s unlikely to happen in real life, here\[aq]s an
example: with the following journal, \f[C]balancesheetequity\f[R] shows
\[dq]liabilities\[dq] in both Liabilities and Equity sections.
Declaring another account as \f[C]type:Liability\f[R] would fix it:
.IP
.nf
\f[C]
account liabilities ; type:Equity
2020-01-01
assets 1
liabilities 1
equity -2
\f[R]
.fi
.SS Old account type syntax
.PP
In some hledger journals you might instead see this old syntax (the
letters ALERX, separated from the account name by two or more spaces);
this is deprecated and may be removed soon:
.IP
.nf
\f[C]
@ -1423,22 +1517,6 @@ account revenues R
account expenses X
\f[R]
.fi
.SS Overriding auto-detected types
.PP
If you ever override the types of those auto-detected english account
names mentioned above, you might need to help the reports a bit.
Eg:
.IP
.nf
\f[C]
; make \[dq]liabilities\[dq] not have the liability type - who knows why
account liabilities ; type:E
; we need to ensure some other account has the liability type,
; otherwise balancesheet would still show \[dq]liabilities\[dq] under Liabilities
account - ; type:L
\f[R]
.fi
.SS Account display order
.PP
Account directives also set the order in which accounts are displayed,

156
hledger-lib/hledger_journal.info
View File

@ -1250,27 +1250,72 @@ File: hledger_journal.info, Node: Account types, Next: Account display order,
1.13.8.3 Account types
......................
hledger recognises five types (or classes) of account: Asset, Liability,
Equity, Revenue, Expense. This is used by a few accounting-aware
reports such as balancesheet, incomestatement and cashflow.
Auto-detected account types If you name your top-level accounts with
some variation of 'assets', 'liabilities'/'debts', 'equity',
'revenues'/'income', or 'expenses', their types are detected
automatically. Account types declared with tags More generally, you can
declare an account's type with an account directive, by writing a
'type:' tag in a comment, followed by one of the words 'Asset',
'Liability', 'Equity', 'Revenue', 'Expense', or one of the letters
'ALERX' (case insensitive):
hledger recognises five main types of account, corresponding to the
account classes in the accounting equation:
'Asset', 'Liability', 'Equity', 'Revenue', 'Expense'.
These account types are important for controlling which accounts
appear in the balancesheet, balancesheetequity, incomestatement reports
(and probably for other things in future).
Additionally, we recognise the 'Cash' type, which is also an 'Asset',
and which causes accounts to appear in the cashflow report. ("Cash"
here means liquid assets, eg bank balances but typically not investments
or receivables.) Declaring account types Generally, to make these
reports work you should declare your top-level accounts and their types,
using account directives with 'type:' tags.
The tag's value should be one of: 'Asset', 'Liability', 'Equity',
'Revenue', 'Expense', 'Cash', 'A', 'L', 'E', 'R', 'X', 'C' (all case
insensitive). The type is inherited by all subaccounts except where
they override it. Here's a complete example:
account assets ; type: Asset
account assets:bank ; type: Cash
account assets:cash ; type: Cash
account liabilities ; type: Liability
account equity ; type: Equity
account revenues ; type: Revenue
account expenses ; type: Expense
Account types declared with account type codes Or, you can write one
of those letters separated from the account name by two or more spaces,
but this should probably be considered deprecated as of hledger 1.13:
Auto-detected account types If you happen to use common english
top-level account names, you may not need to declare account types, as
they will be detected automatically using the following rules:
If name matches regular account
expression: type is:
-------------------------------------------------
'^assets?(:|$)' 'Asset'
'^(debts?|liabilit(y|ies))(:|$)' 'Liability'
'^equity(:|$)' 'Equity'
'^(income|revenue)s?(:|$)' 'Revenue'
'^expenses?(:|$)' 'Expense'
If account type is 'Asset' and name does not contain account type
regular expression: is:
--------------------------------------------------------------------------
'(investment|receivable|:A/R|:fixed)' 'Cash'
Even so, explicit declarations may be a good idea, for clarity and
predictability. Interference from auto-detected account types If you
assign any account type, it's a good idea to assign all of them, to
prevent any confusion from mixing declared and auto-detected types.
Although it's unlikely to happen in real life, here's an example: with
the following journal, 'balancesheetequity' shows "liabilities" in both
Liabilities and Equity sections. Declaring another account as
'type:Liability' would fix it:
account liabilities ; type:Equity
2020-01-01
assets 1
liabilities 1
equity -2
Old account type syntax In some hledger journals you might instead
see this old syntax (the letters ALERX, separated from the account name
by two or more spaces); this is deprecated and may be removed soon:
account assets A
account liabilities L
@ -1278,17 +1323,6 @@ account equity E
account revenues R
account expenses X
Overriding auto-detected types If you ever override the types of
those auto-detected english account names mentioned above, you might
need to help the reports a bit. Eg:
; make "liabilities" not have the liability type - who knows why
account liabilities ; type:E
; we need to ensure some other account has the liability type,
; otherwise balancesheet would still show "liabilities" under Liabilities
account - ; type:L

File: hledger_journal.info, Node: Account display order, Prev: Account types, Up: Declaring accounts
@ -1910,42 +1944,42 @@ Node: Account subdirectives45713
Ref: #account-subdirectives45908
Node: Account types46221
Ref: #account-types46405
Node: Account display order48044
Ref: #account-display-order48214
Node: Rewriting accounts49365
Ref: #rewriting-accounts49550
Node: Basic aliases50307
Ref: #basic-aliases50453
Node: Regex aliases51157
Ref: #regex-aliases51329
Node: Combining aliases52047
Ref: #combining-aliases52240
Node: Aliases and multiple files53516
Ref: #aliases-and-multiple-files53725
Node: end aliases54304
Ref: #end-aliases54461
Node: Default parent account54562
Ref: #default-parent-account54730
Node: Periodic transactions55614
Ref: #periodic-transactions55789
Node: Periodic rule syntax57661
Ref: #periodic-rule-syntax57867
Node: Two spaces between period expression and description!58571
Ref: #two-spaces-between-period-expression-and-description58890
Node: Forecasting with periodic transactions59574
Ref: #forecasting-with-periodic-transactions59879
Node: Budgeting with periodic transactions61934
Ref: #budgeting-with-periodic-transactions62173
Node: Auto postings62622
Ref: #auto-postings62762
Node: Auto postings and multiple files64941
Ref: #auto-postings-and-multiple-files65145
Node: Auto postings and dates65354
Ref: #auto-postings-and-dates65628
Node: Auto postings and transaction balancing / inferred amounts / balance assertions65803
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions66154
Node: Auto posting tags66496
Ref: #auto-posting-tags66711
Node: Account display order49451
Ref: #account-display-order49621
Node: Rewriting accounts50772
Ref: #rewriting-accounts50957
Node: Basic aliases51714
Ref: #basic-aliases51860
Node: Regex aliases52564
Ref: #regex-aliases52736
Node: Combining aliases53454
Ref: #combining-aliases53647
Node: Aliases and multiple files54923
Ref: #aliases-and-multiple-files55132
Node: end aliases55711
Ref: #end-aliases55868
Node: Default parent account55969
Ref: #default-parent-account56137
Node: Periodic transactions57021
Ref: #periodic-transactions57196
Node: Periodic rule syntax59068
Ref: #periodic-rule-syntax59274
Node: Two spaces between period expression and description!59978
Ref: #two-spaces-between-period-expression-and-description60297
Node: Forecasting with periodic transactions60981
Ref: #forecasting-with-periodic-transactions61286
Node: Budgeting with periodic transactions63341
Ref: #budgeting-with-periodic-transactions63580
Node: Auto postings64029
Ref: #auto-postings64169
Node: Auto postings and multiple files66348
Ref: #auto-postings-and-multiple-files66552
Node: Auto postings and dates66761
Ref: #auto-postings-and-dates67035
Node: Auto postings and transaction balancing / inferred amounts / balance assertions67210
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions67561
Node: Auto posting tags67903
Ref: #auto-posting-tags68118

End Tag Table

91
hledger-lib/hledger_journal.txt
View File

@ -978,31 +978,79 @@ FILE FORMAT
[LEDGER-STYLE SUBDIRECTIVES, IGNORED]
Account types
hledger recognises five types (or classes) of account: Asset, Liabil-
ity, Equity, Revenue, Expense. This is used by a few accounting-aware
reports such as balancesheet, incomestatement and cashflow.
hledger recognises five main types of account, corresponding to the ac-
count classes in the accounting equation:
Auto-detected account types
If you name your top-level accounts with some variation of assets, lia-
bilities/debts, equity, revenues/income, or expenses, their types are
detected automatically.
Asset, Liability, Equity, Revenue, Expense.
Account types declared with tags
More generally, you can declare an account's type with an account di-
rective, by writing a type: tag in a comment, followed by one of the
words Asset, Liability, Equity, Revenue, Expense, or one of the letters
ALERX (case insensitive):
These account types are important for controlling which accounts appear
in the balancesheet, balancesheetequity, incomestatement reports (and
probably for other things in future).
Additionally, we recognise the Cash type, which is also an Asset, and
which causes accounts to appear in the cashflow report. ("Cash" here
means liquid assets, eg bank balances but typically not investments or
receivables.)
Declaring account types
Generally, to make these reports work you should declare your top-level
accounts and their types, using account directives with type: tags.
The tag's value should be one of: Asset, Liability, Equity, Revenue,
Expense, Cash, A, L, E, R, X, C (all case insensitive). The type is
inherited by all subaccounts except where they override it. Here's a
complete example:
account assets ; type: Asset
account assets:bank ; type: Cash
account assets:cash ; type: Cash
account liabilities ; type: Liability
account equity ; type: Equity
account revenues ; type: Revenue
account expenses ; type: Expense
Account types declared with account type codes
Or, you can write one of those letters separated from the account name
by two or more spaces, but this should probably be considered depre-
cated as of hledger 1.13:
Auto-detected account types
If you happen to use common english top-level account names, you may
not need to declare account types, as they will be detected automati-
cally using the following rules:
If name matches regular account type is:
expression:
----------------------------------------------
^assets?(:|$) Asset
^(debts?|lia- Liability
bilit(y|ies))(:|$)
^equity(:|$) Equity
^(income|revenue)s?(:|$) Revenue
^expenses?(:|$) Expense
If account type is Asset and name does not contain regu- account type
lar expression: is:
--------------------------------------------------------------------------
(investment|receivable|:A/R|:fixed) Cash
Even so, explicit declarations may be a good idea, for clarity and pre-
dictability.
Interference from auto-detected account types
If you assign any account type, it's a good idea to assign all of them,
to prevent any confusion from mixing declared and auto-detected types.
Although it's unlikely to happen in real life, here's an example: with
the following journal, balancesheetequity shows "liabilities" in both
Liabilities and Equity sections. Declaring another account as type:Li-
ability would fix it:
account liabilities ; type:Equity
2020-01-01
assets 1
liabilities 1
equity -2
Old account type syntax
In some hledger journals you might instead see this old syntax (the
letters ALERX, separated from the account name by two or more spaces);
this is deprecated and may be removed soon:
account assets A
account liabilities L
@ -1010,17 +1058,6 @@ FILE FORMAT
account revenues R
account expenses X
Overriding auto-detected types
If you ever override the types of those auto-detected english account
names mentioned above, you might need to help the reports a bit. Eg:
; make "liabilities" not have the liability type - who knows why
account liabilities ; type:E
; we need to ensure some other account has the liability type,
; otherwise balancesheet would still show "liabilities" under Liabilities
account - ; type:L
Account display order
Account directives also set the order in which accounts are displayed,
eg in reports, the hledger-ui accounts screen, and the hledger-web

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

@ -57,10 +57,10 @@ start in the (first) matched account\[aq]s register screen
\f[B]\f[CB]--change\f[B]\f[R]
show period balances (changes) at startup instead of historical balances
.TP
\f[B]\f[CB]-F --flat\f[B]\f[R]
show accounts as a list (default)
\f[B]\f[CB]-l --flat\f[B]\f[R]
show accounts as a flat list (default)
.TP
\f[B]\f[CB]-T --tree\f[B]\f[R]
\f[B]\f[CB]-t --tree\f[B]\f[R]
show accounts as a tree
.PP
hledger input options:
@ -161,14 +161,14 @@ generate future transactions from periodic transaction rules, for the
next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible.
.TP
\f[B]\f[CB]--color=always|yes|never|no|auto (or --colour=...)\f[B]\f[R]
\[aq]auto\[aq] is the default, it tries to use ANSI color codes in
terminal output when supported.
\[aq]always\[aq] or \[aq]yes\[aq] forces color on, useful when piping
output, eg into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq] forces color off.
A NO_COLOR environment variable also disables color, overriding this
option.
\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R]
Should color-supporting commands use ANSI color codes in text output.
\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting
terminal.
\[aq]always\[aq] or \[aq]yes\[aq]: always, useful eg when piping output
into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq]: never.
A NO_COLOR environment variable overrides this.
.PP
When a reporting option appears more than once in the command line, the
last one takes precedence.
@ -186,133 +186,132 @@ show version
\f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1)
.PP
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.
(To prevent this, insert a \f[C]--\f[R] argument before.)
.SH KEYS
(to prevent this, insert a \f[C]--\f[R] argument before.)
.SH keys
.PP
\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
screen.) Press \f[C]?\f[R] again (or \f[C]ESCAPE\f[R], or
\f[C]LEFT\f[R]) to close it.
The following keys work on most screens:
(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
\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] (or \f[C]enter\f[R]) goes
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]page up\f[R]/\f[C]page down\f[R]/\f[C]home\f[R]/\f[C]end\f[R]
move up and down through lists.
Vi-style (\f[C]h\f[R]/\f[C]j\f[R]/\f[C]k\f[R]/\f[C]l\f[R]) and
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.
(\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!).
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.)
(If you\[aq]re on a mac, the karabiner app is one way to do that.)
.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).
\f[C]shift-down/up\f[R] steps downward and upward through these standard
report period durations: year, quarter, month, week, day.
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.
With the \f[C]--watch\f[R] option, when viewing a \[dq]current\[dq]
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.
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
move automatically to track the current date.
To set a non-standard period, you can use \f[C]/\f[R] and a
to set a non-standard period, you can use \f[C]/\f[R] and a
\f[C]date:\f[R] query.
.PP
\f[C]/\f[R] lets you set a general filter query limiting the data shown,
using the same query terms as in hledger and hledger-web.
While editing the query, you can use CTRL-a/e/d/k, BS, cursor keys;
press \f[C]ENTER\f[R] to set it, or \f[C]ESCAPE\f[R]to cancel.
There are also keys for quickly adjusting some common filters like
while editing the query, you can use ctrl-a/e/d/k, bs, cursor keys;
press \f[C]enter\f[R] to set it, or \f[C]escape\f[R]to cancel.
there are also keys for quickly adjusting some common filters like
account depth and transaction status (see below).
\f[C]BACKSPACE\f[R] or \f[C]DELETE\f[R] removes all filters, showing all
\f[C]backspace\f[R] or \f[C]delete\f[R] removes all filters, showing all
transactions.
.PP
As mentioned above, by default hledger-ui hides future transactions -
as mentioned above, by default hledger-ui hides future transactions -
both ordinary transactions recorded in the journal, and periodic
transactions generated by rule.
\f[C]F\f[R] toggles forecast mode, in which future/forecasted
\f[C]f\f[R] toggles forecast mode, in which future/forecasted
transactions are shown.
(experimental)
\f[I](experimental)\f[R]
.PP
\f[C]ESCAPE\f[R] removes all filters and jumps back to the top screen.
Or, it cancels a minibuffer edit or help dialog in progress.
\f[C]escape\f[R] resets the UI state and jumps back to the top screen,
restoring the app\[aq]s initial state at startup.
Or, it cancels minibuffer data entry or the help dialog.
.PP
\f[C]CTRL-l\f[R] redraws the screen and centers the selection if
\f[C]ctrl-l\f[R] redraws the screen and centers the selection if
possible (selections near the top won\[aq]t be centered, since we
don\[aq]t scroll above the top).
.PP
\f[C]g\f[R] reloads from the data file(s) and updates the current screen
and any previous screens.
(With large files, this could cause a noticeable pause.)
(with large files, this could cause a noticeable pause.)
.PP
\f[C]I\f[R] toggles balance assertion checking.
Disabling balance assertions temporarily can be useful for
\f[C]i\f[R] toggles balance assertion checking.
disabling balance assertions temporarily can be useful for
troubleshooting.
.PP
\f[C]a\f[R] runs command-line hledger\[aq]s add command, and reloads the
updated file.
This allows some basic data entry.
this allows some basic data entry.
.PP
\f[C]A\f[R] is like \f[C]a\f[R], but runs the hledger-iadd tool, which
\f[C]a\f[R] is like \f[C]a\f[R], but runs the hledger-iadd tool, which
provides a terminal interface.
This key will be available if \f[C]hledger-iadd\f[R] is installed in
$PATH.
this key will be available if \f[C]hledger-iadd\f[R] is installed in
$path.
.PP
\f[C]E\f[R] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default
\f[C]e\f[R] runs $hledger_ui_editor, or $editor, or a default
(\f[C]emacsclient -a \[dq]\[dq] -nw\f[R]) on the journal file.
With some editors (emacs, vi), the cursor will be positioned at the
with some editors (emacs, vi), the cursor will be positioned at the
current transaction when invoked from the register and transaction
screens, and at the error location (if possible) when invoked from the
error screen.
.PP
\f[C]q\f[R] quits the application.
\f[C]b\f[R] toggles cost mode, showing amounts in their transaction
price\[aq]s commodity (like toggling the \f[C]-b/--cost\f[R] flag).
.PP
Experimental:
.PP
\f[C]B\f[R] toggles cost mode, showing amounts in their transaction
price\[aq]s commodity (like toggling the \f[C]-B/--cost\f[R] flag).
.PP
\f[C]V\f[R] toggles value mode, showing amounts\[aq] current market
\f[C]v\f[R] toggles value mode, showing amounts\[aq] current market
value in their default valuation commodity (like toggling the
\f[C]-V/--market\f[R] flag).
Note, \[dq]current market value\[dq] means the value on the report end
\f[C]-v/--market\f[R] flag).
note, \[dq]current market value\[dq] means the value on the report end
date if specified, otherwise today.
To see the value on another date, you can temporarily set that as the
to see the value on another date, you can temporarily set that as the
report end date.
Eg: to see a transaction as it was valued on july 30, go to the accounts
eg: to see a transaction as it was valued on july 30, go to the accounts
or register screen, press \f[C]/\f[R], and add \f[C]date:-7/30\f[R] to
the query.
.PP
At most one of cost or value mode can be active at once.
at most one of cost or value mode can be active at once.
.PP
There\[aq]s not yet any visual reminder when cost or value mode is
active; for now pressing \f[C]B\f[R] \f[C]B\f[R] \f[C]V\f[R] should
there\[aq]s not yet any visual reminder when cost or value mode is
active; for now pressing \f[C]b\f[R] \f[C]b\f[R] \f[C]v\f[R] should
reliably reset to normal mode.
.PP
With --watch active, if you save an edit to the journal file while
with --watch active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the
\f[C]B\f[R]/\f[C]V\f[R] keys will stop working.
To work around, press g to force a manual reload, or exit the
\f[C]b\f[R]/\f[C]v\f[R] keys will stop working.
to work around, press g to force a manual reload, or exit the
transaction screen.
.PP
Additional screen-specific keys are described below.
.SH SCREENS
.SS Accounts screen
\f[C]q\f[R] quits the application.
.PP
This is normally the first screen displayed.
It lists accounts and their balances, like hledger\[aq]s balance
additional screen-specific keys are described below.
.SH screens
.SS accounts screen
.PP
this is normally the first screen displayed.
it lists accounts and their balances, like hledger\[aq]s balance
command.
By default, it shows all accounts and their latest ending balances
by default, it shows all accounts and their latest ending balances
(including the balances of subaccounts).
if you specify a query on the command line, it shows just the matched
accounts and the balances from matched transactions.
.PP
Account names are shown as a flat list by default.
Press \f[C]T\f[R] to toggle tree mode.
In flat mode, account balances are exclusive of subaccounts, except
Account names are shown as a flat list by default; press \f[C]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
@ -378,11 +377,11 @@ current account.
.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
in flat mode but this account has subaccounts which are not shown due to
in list mode but this account has subaccounts which are not shown due to
a depth limit.
In other words, the register always shows the transactions contributing
to the balance shown on the accounts screen.
Tree mode/flat mode can be toggled with \f[C]T\f[R] here also.
Tree mode/list mode can be toggled with \f[C]t\f[R] here also.
.PP
\f[C]U\f[R] toggles filtering by unmarked status, showing or hiding
unmarked transactions.

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

@ -36,14 +36,14 @@ enable "forecast mode".
* Menu:
* OPTIONS::
* KEYS::
* SCREENS::
* keys::
* screens::
* ENVIRONMENT::
* FILES::
* BUGS::

File: hledger-ui.info, Node: OPTIONS, Next: KEYS, Prev: Top, Up: Top
File: hledger-ui.info, Node: OPTIONS, Next: keys, Prev: Top, Up: Top
1 OPTIONS
*********
@ -67,10 +67,10 @@ the data.
show period balances (changes) at startup instead of historical
balances
'-F --flat'
'-l --flat'
show accounts as a list (default)
'-T --tree'
show accounts as a flat list (default)
'-t --tree'
show accounts as a tree
@ -175,13 +175,13 @@ the data.
generate future transactions from periodic transaction rules, for
the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
'--color=always|yes|never|no|auto (or --colour=...)'
'--color=WHEN (or --colour=WHEN)'
'auto' is the default, it tries to use ANSI color codes in terminal
output when supported. 'always' or 'yes' forces color on, useful
when piping output, eg into 'less -R'. 'never' or 'no' forces color
off. A NO_COLOR environment variable also disables color,
overriding this option.
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a
color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line,
the last one takes precedence.
@ -200,134 +200,134 @@ the last one takes precedence.
show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which
should contain one command line option/argument per line. (To prevent
a @file argument will be expanded to the contents of file, which
should contain one command line option/argument per line. (to prevent
this, insert a '--' argument before.)

File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
File: hledger-ui.info, Node: keys, Next: screens, Prev: OPTIONS, Up: Top
2 KEYS
2 keys
******
'?' 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') to close it. The following keys work on most
screens:
'?' 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
most screens:
The cursor keys navigate: 'right' (or 'enter') goes deeper, 'left'
the cursor keys navigate: 'right' (or 'enter') goes deeper, 'left'
returns to the previous screen, 'up'/'down'/'page up'/'page
down'/'home'/'end' move up and down through lists. Vi-style
('h'/'j'/'k'/'l') and Emacs-style ('CTRL-p'/'CTRL-n'/'CTRL-f'/'CTRL-b')
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.)
down'/'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.)
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).
'shift-down/up' steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then,
'shift-left/right' moves to the previous/next period. 't' sets the
report period to today. With the '--watch' option, when viewing a
period durations: year, quarter, month, week, day. then,
'shift-left/right' moves to the previous/next period. 'T' sets the
report period to today. with the '--watch' option, when viewing a
"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
non-standard period, you can use '/' and a 'date:' query.
'/' lets you set a general filter query limiting the data shown,
using the same query terms as in hledger and hledger-web. While editing
the query, you can use CTRL-a/e/d/k, BS, cursor keys; press 'ENTER' to
set it, or 'ESCAPE'to cancel. There are also keys for quickly adjusting
using the same query terms as in hledger and hledger-web. while editing
the query, you can use ctrl-a/e/d/k, bs, cursor keys; press 'enter' to
set it, or 'escape'to cancel. there are also keys for quickly adjusting
some common filters like account depth and transaction status (see
below). 'BACKSPACE' or 'DELETE' removes all filters, showing all
below). 'backspace' or 'delete' removes all filters, showing all
transactions.
As mentioned above, by default hledger-ui hides future transactions -
as mentioned above, by default hledger-ui hides future transactions -
both ordinary transactions recorded in the journal, and periodic
transactions generated by rule. 'F' toggles forecast mode, in which
future/forecasted transactions are shown. (experimental)
transactions generated by rule. 'f' toggles forecast mode, in which
future/forecasted transactions are shown. _(experimental)_
'ESCAPE' removes all filters and jumps back to the top screen. Or,
it cancels a minibuffer edit or help dialog in progress.
'escape' resets the UI state and jumps back to the top screen,
restoring the app's initial state at startup. Or, it cancels minibuffer
data entry or the help dialog.
'CTRL-l' redraws the screen and centers the selection if possible
'ctrl-l' redraws the screen and centers the selection if possible
(selections near the top won't be centered, since we don't scroll above
the top).
'g' reloads from the data file(s) and updates the current screen and
any previous screens. (With large files, this could cause a noticeable
any previous screens. (with large files, this could cause a noticeable
pause.)
'I' toggles balance assertion checking. Disabling balance assertions
'i' toggles balance assertion checking. disabling balance assertions
temporarily can be useful for troubleshooting.
'a' runs command-line hledger's add command, and reloads the updated
file. This allows some basic data entry.
file. this allows some basic data entry.
'A' is like 'a', but runs the hledger-iadd tool, which provides a
terminal interface. This key will be available if 'hledger-iadd' is
installed in $PATH.
'a' is like 'a', but runs the hledger-iadd tool, which provides a
terminal interface. this key will be available if 'hledger-iadd' is
installed in $path.
'E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default ('emacsclient
-a "" -nw') on the journal file. With some editors (emacs, vi), the
'e' runs $hledger_ui_editor, or $editor, or a default ('emacsclient
-a "" -nw') on the journal file. with some editors (emacs, vi), the
cursor will be positioned at the current transaction when invoked from
the register and transaction screens, and at the error location (if
possible) when invoked from the error screen.
'q' quits the application.
'b' toggles cost mode, showing amounts in their transaction price's
commodity (like toggling the '-b/--cost' flag).
Experimental:
'B' toggles cost mode, showing amounts in their transaction price's
commodity (like toggling the '-B/--cost' flag).
'V' toggles value mode, showing amounts' current market value in
their default valuation commodity (like toggling the '-V/--market'
flag). Note, "current market value" means the value on the report end
date if specified, otherwise today. To see the value on another date,
you can temporarily set that as the report end date. Eg: to see a
'v' toggles value mode, showing amounts' current market value in
their default valuation commodity (like toggling the '-v/--market'
flag). note, "current market value" means the value on the report end
date if specified, otherwise today. to see the value on another date,
you can temporarily set that as the report end date. eg: to see a
transaction as it was valued on july 30, go to the accounts or register
screen, press '/', and add 'date:-7/30' to the query.
At most one of cost or value mode can be active at once.
at most one of cost or value mode can be active at once.
There's not yet any visual reminder when cost or value mode is
active; for now pressing 'B' 'B' 'V' should reliably reset to normal
there's not yet any visual reminder when cost or value mode is
active; for now pressing 'b' 'b' 'v' should reliably reset to normal
mode.
With -watch active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the 'B'/'V' keys
will stop working. To work around, press g to force a manual reload, or
with -watch active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the 'b'/'v' keys
will stop working. to work around, press g to force a manual reload, or
exit the transaction screen.
Additional screen-specific keys are described below.
'q' quits the application.
additional screen-specific keys are described below.

File: hledger-ui.info, Node: SCREENS, Next: ENVIRONMENT, Prev: KEYS, Up: Top
File: hledger-ui.info, Node: screens, Next: ENVIRONMENT, Prev: keys, Up: Top
3 SCREENS
3 screens
*********
* Menu:
* Accounts screen::
* accounts screen::
* Register screen::
* Transaction screen::
* Error screen::

File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Up: SCREENS
File: hledger-ui.info, Node: accounts screen, Next: Register screen, Up: screens
3.1 Accounts screen
3.1 accounts screen
===================
This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows
this is normally the first screen displayed. it lists accounts and
their balances, like hledger's balance command. by default, it shows
all accounts and their latest ending balances (including the balances of
subaccounts). if you specify a query on the command line, it shows just
the matched accounts and the balances from matched transactions.
Account names are shown as a flat list by default. Press 'T' to
toggle tree mode. In flat mode, account balances are exclusive of
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.
@ -364,7 +364,7 @@ command-line hledger).
Press 'right' or 'enter' 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
3.2 Register screen
===================
@ -388,11 +388,11 @@ a check register. Each line represents one transaction and shows:
balance you would see on a bank register for the current account.
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 flat
the register if the accounts screen is in tree mode, or if it's in list
mode but this account has subaccounts which are not shown due to a depth
limit. In other words, the register always shows the transactions
contributing to the balance shown on the accounts screen. Tree
mode/flat mode can be toggled with 'T' here also.
mode/list mode can be toggled with 't' here also.
'U' toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, 'P' toggles pending transactions, and 'C'
@ -411,7 +411,7 @@ command-line hledger).
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
3.3 Transaction screen
======================
@ -435,7 +435,7 @@ unfiltered journal, which is a more stable id (at least until the next
reload).

File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCREENS
File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: screens
3.4 Error screen
================
@ -446,7 +446,7 @@ again to reload and resume normal operation. (Or, you can press escape
to cancel the reload attempt.)

File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: SCREENS, Up: Top
File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: screens, Up: Top
4 ENVIRONMENT
*************
@ -517,24 +517,24 @@ Tag Table:
Node: Top71
Node: OPTIONS1476
Ref: #options1573
Node: KEYS5552
Ref: #keys5647
Node: SCREENS9923
Ref: #screens10028
Node: Accounts screen10118
Ref: #accounts-screen10246
Node: Register screen12462
Ref: #register-screen12617
Node: Transaction screen14614
Ref: #transaction-screen14772
Node: Error screen15642
Ref: #error-screen15764
Node: ENVIRONMENT16008
Ref: #environment16122
Node: FILES16929
Ref: #files17028
Node: BUGS17241
Ref: #bugs17318
Node: keys5545
Ref: #keys5640
Node: screens9972
Ref: #screens10077
Node: accounts screen10167
Ref: #accounts-screen10295
Node: Register screen12510
Ref: #register-screen12665
Node: Transaction screen14662
Ref: #transaction-screen14820
Node: Error screen15690
Ref: #error-screen15812
Node: ENVIRONMENT16056
Ref: #environment16170
Node: FILES16977
Ref: #files17076
Node: BUGS17289
Ref: #bugs17366

End Tag Table

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

@ -53,10 +53,10 @@ OPTIONS
show period balances (changes) at startup instead of historical
balances
-F --flat
show accounts as a list (default)
-l --flat
show accounts as a flat list (default)
-T --tree
-t --tree
show accounts as a tree
hledger input options:
@ -158,12 +158,12 @@ OPTIONS
for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
--color=always|yes|never|no|auto (or --colour=...)
'auto' is the default, it tries to use ANSI color codes in ter-
minal output when supported. 'always' or 'yes' forces color on,
useful when piping output, eg into 'less -R'. 'never' or 'no'
forces color off. A NO_COLOR environment variable also disables
color, overriding this option.
--color=WHEN (or --colour=WHEN)
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a color-
supporting terminal. 'always' or 'yes': always, useful eg when
piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line, the
last one takes precedence.
@ -181,109 +181,108 @@ OPTIONS
--debug[=N]
show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which should
contain one command line option/argument per line. (To prevent this,
a @file argument will be expanded to the contents of file, which should
contain one command line option/argument per line. (to prevent this,
insert a -- argument before.)
KEYS
? 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) to close it. The following keys work on most screens:
keys
? 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 most screens:
The cursor keys navigate: right (or enter) goes deeper, left returns to
the cursor keys navigate: right (or enter) goes deeper, left returns to
the previous screen, up/down/page up/page down/home/end move up and
down through lists. Vi-style (h/j/k/l) and Emacs-style (CTRL-p/CTRL-
n/CTRL-f/CTRL-b) 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.)
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.)
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-
down/up steps downward and upward through these standard report period
durations: year, quarter, month, week, day. Then, shift-left/right
moves to the previous/next period. t sets the report period to today.
With the --watch option, when viewing a "current" period (the current
durations: year, quarter, month, week, day. then, shift-left/right
moves to the previous/next period. T sets the report period to today.
with the --watch option, when viewing a "current" period (the current
day, week, month, quarter, or year), the period will move automatically
to track the current date. To set a non-standard period, you can use /
to track the current date. to set a non-standard period, you can use /
and a date: query.
/ lets you set a general filter query limiting the data shown, using
the same query terms as in hledger and hledger-web. While editing the
query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set
it, or ESCAPEto cancel. There are also keys for quickly adjusting some
the same query terms as in hledger and hledger-web. while editing the
query, you can use ctrl-a/e/d/k, bs, cursor keys; press enter to set
it, or escapeto cancel. there are also keys for quickly adjusting some
common filters like account depth and transaction status (see below).
BACKSPACE or DELETE removes all filters, showing all transactions.
backspace or delete removes all filters, showing all transactions.
As mentioned above, by default hledger-ui hides future transactions -
as mentioned above, by default hledger-ui hides future transactions -
both ordinary transactions recorded in the journal, and periodic trans-
actions generated by rule. F toggles forecast mode, in which fu-
actions generated by rule. f toggles forecast mode, in which fu-
ture/forecasted transactions are shown. (experimental)
ESCAPE removes all filters and jumps back to the top screen. Or, it
cancels a minibuffer edit or help dialog in progress.
escape resets the UI state and jumps back to the top screen, restoring
the app's initial state at startup. Or, it cancels minibuffer data en-
try or the help dialog.
CTRL-l redraws the screen and centers the selection if possible (selec-
ctrl-l redraws the screen and centers the selection if possible (selec-
tions near the top won't be centered, since we don't scroll above the
top).
g reloads from the data file(s) and updates the current screen and any
previous screens. (With large files, this could cause a noticeable
previous screens. (with large files, this could cause a noticeable
pause.)
I toggles balance assertion checking. Disabling balance assertions
i toggles balance assertion checking. disabling balance assertions
temporarily can be useful for troubleshooting.
a runs command-line hledger's add command, and reloads the updated
file. This allows some basic data entry.
file. this allows some basic data entry.
A is like a, but runs the hledger-iadd tool, which provides a terminal
interface. This key will be available if hledger-iadd is installed in
$PATH.
a is like a, but runs the hledger-iadd tool, which provides a terminal
interface. this key will be available if hledger-iadd is installed in
$path.
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""
-nw) on the journal file. With some editors (emacs, vi), the cursor
e runs $hledger_ui_editor, or $editor, or a default (emacsclient -a ""
-nw) on the journal file. with some editors (emacs, vi), the cursor
will be positioned at the current transaction when invoked from the
register and transaction screens, and at the error location (if possi-
ble) when invoked from the error screen.
q quits the application.
b toggles cost mode, showing amounts in their transaction price's com-
modity (like toggling the -b/--cost flag).
Experimental:
B toggles cost mode, showing amounts in their transaction price's com-
modity (like toggling the -B/--cost flag).
V toggles value mode, showing amounts' current market value in their
default valuation commodity (like toggling the -V/--market flag).
Note, "current market value" means the value on the report end date if
specified, otherwise today. To see the value on another date, you can
temporarily set that as the report end date. Eg: to see a transaction
v toggles value mode, showing amounts' current market value in their
default valuation commodity (like toggling the -v/--market flag).
note, "current market value" means the value on the report end date if
specified, otherwise today. to see the value on another date, you can
temporarily set that as the report end date. eg: to see a transaction
as it was valued on july 30, go to the accounts or register screen,
press /, and add date:-7/30 to the query.
At most one of cost or value mode can be active at once.
at most one of cost or value mode can be active at once.
There's not yet any visual reminder when cost or value mode is active;
for now pressing B B V should reliably reset to normal mode.
there's not yet any visual reminder when cost or value mode is active;
for now pressing b b v should reliably reset to normal mode.
With --watch active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the B/V keys will
stop working. To work around, press g to force a manual reload, or
with --watch active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the b/v keys will
stop working. to work around, press g to force a manual reload, or
exit the transaction screen.
Additional screen-specific keys are described below.
q quits the application.
SCREENS
Accounts screen
This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows
additional screen-specific keys are described below.
screens
accounts screen
this is normally the first screen displayed. it lists accounts and
their balances, like hledger's balance command. by default, it shows
all accounts and their latest ending balances (including the balances
of subaccounts). if you specify a query on the command line, it shows
just the matched accounts and the balances from matched transactions.
Account names are shown as a flat list by default. Press T to toggle
tree mode. In flat mode, account balances are exclusive of subac-
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 be-
low). In tree mode, all account balances are inclusive of subaccounts.
@ -337,11 +336,11 @@ SCREENS
see on a bank register for the current account.
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 flat
the register if the accounts screen is in tree mode, or if it's in list
mode but this account has subaccounts which are not shown due to a
depth limit. In other words, the register always shows the transac-
tions contributing to the balance shown on the accounts screen. Tree
mode/flat mode can be toggled with T here also.
mode/list mode can be toggled with t here also.
U toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, P toggles pending transactions, and C toggles

16
hledger-web/hledger-web.1
View File

@ -187,14 +187,14 @@ generate future transactions from periodic transaction rules, for the
next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible.
.TP
\f[B]\f[CB]--color=always|yes|never|no|auto (or --colour=...)\f[B]\f[R]
\[aq]auto\[aq] is the default, it tries to use ANSI color codes in
terminal output when supported.
\[aq]always\[aq] or \[aq]yes\[aq] forces color on, useful when piping
output, eg into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq] forces color off.
A NO_COLOR environment variable also disables color, overriding this
option.
\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R]
Should color-supporting commands use ANSI color codes in text output.
\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting
terminal.
\[aq]always\[aq] or \[aq]yes\[aq]: always, useful eg when piping output
into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq]: never.
A NO_COLOR environment variable overrides this.
.PP
When a reporting option appears more than once in the command line, the
last one takes precedence.

40
hledger-web/hledger-web.info
View File

@ -199,13 +199,13 @@ before options, as shown in the synopsis above.
generate future transactions from periodic transaction rules, for
the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
'--color=always|yes|never|no|auto (or --colour=...)'
'--color=WHEN (or --colour=WHEN)'
'auto' is the default, it tries to use ANSI color codes in terminal
output when supported. 'always' or 'yes' forces color on, useful
when piping output, eg into 'less -R'. 'never' or 'no' forces color
off. A NO_COLOR environment variable also disables color,
overriding this option.
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a
color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line,
the last one takes precedence.
@ -582,20 +582,20 @@ Tag Table:
Node: Top72
Node: OPTIONS1752
Ref: #options1857
Node: PERMISSIONS8749
Ref: #permissions8888
Node: EDITING UPLOADING DOWNLOADING10100
Ref: #editing-uploading-downloading10281
Node: RELOADING11115
Ref: #reloading11249
Node: JSON API11682
Ref: #json-api11796
Node: ENVIRONMENT17277
Ref: #environment17393
Node: FILES18126
Ref: #files18226
Node: BUGS18439
Ref: #bugs18517
Node: PERMISSIONS8737
Ref: #permissions8876
Node: EDITING UPLOADING DOWNLOADING10088
Ref: #editing-uploading-downloading10269
Node: RELOADING11103
Ref: #reloading11237
Node: JSON API11670
Ref: #json-api11784
Node: ENVIRONMENT17265
Ref: #environment17381
Node: FILES18114
Ref: #files18214
Node: BUGS18427
Ref: #bugs18505

End Tag Table

12
hledger-web/hledger-web.txt
View File

@ -179,12 +179,12 @@ OPTIONS
for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
--color=always|yes|never|no|auto (or --colour=...)
'auto' is the default, it tries to use ANSI color codes in ter-
minal output when supported. 'always' or 'yes' forces color on,
useful when piping output, eg into 'less -R'. 'never' or 'no'
forces color off. A NO_COLOR environment variable also disables
color, overriding this option.
--color=WHEN (or --colour=WHEN)
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a color-
supporting terminal. 'always' or 'yes': always, useful eg when
piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line, the
last one takes precedence.

16
hledger/hledger.1
View File

@ -639,14 +639,14 @@ generate future transactions from periodic transaction rules, for the
next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible.
.TP
\f[B]\f[CB]--color=always|yes|never|no|auto (or --colour=...)\f[B]\f[R]
\[aq]auto\[aq] is the default, it tries to use ANSI color codes in
terminal output when supported.
\[aq]always\[aq] or \[aq]yes\[aq] forces color on, useful when piping
output, eg into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq] forces color off.
A NO_COLOR environment variable also disables color, overriding this
option.
\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R]
Should color-supporting commands use ANSI color codes in text output.
\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting
terminal.
\[aq]always\[aq] or \[aq]yes\[aq]: always, useful eg when piping output
into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq]: never.
A NO_COLOR environment variable overrides this.
.PP
When a reporting option appears more than once in the command line, the
last one takes precedence.

364
hledger/hledger.info
View File

@ -633,13 +633,13 @@ by most hledger commands, run 'hledger -h'.
generate future transactions from periodic transaction rules, for
the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
'--color=always|yes|never|no|auto (or --colour=...)'
'--color=WHEN (or --colour=WHEN)'
'auto' is the default, it tries to use ANSI color codes in terminal
output when supported. 'always' or 'yes' forces color on, useful
when piping output, eg into 'less -R'. 'never' or 'no' forces color
off. A NO_COLOR environment variable also disables color,
overriding this option.
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a
color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line,
the last one takes precedence.
@ -4054,182 +4054,182 @@ Node: OPTIONS16859
Ref: #options16966
Node: General options17336
Ref: #general-options17461
Node: Command options20779
Ref: #command-options20930
Node: Command arguments21328
Ref: #command-arguments21475
Node: Queries22355
Ref: #queries22510
Node: Special characters in arguments and queries26472
Ref: #special-characters-in-arguments-and-queries26700
Node: More escaping27151
Ref: #more-escaping27313
Node: Even more escaping27609
Ref: #even-more-escaping27803
Node: Less escaping28474
Ref: #less-escaping28636
Node: Unicode characters28881
Ref: #unicode-characters29063
Node: Input files30475
Ref: #input-files30618
Node: Output destination32547
Ref: #output-destination32699
Node: Output format33124
Ref: #output-format33274
Node: Regular expressions35441
Ref: #regular-expressions35598
Node: Smart dates37334
Ref: #smart-dates37485
Node: Report start & end date38846
Ref: #report-start-end-date39018
Node: Report intervals40515
Ref: #report-intervals40680
Node: Period expressions41070
Ref: #period-expressions41230
Node: Depth limiting45381
Ref: #depth-limiting45525
Node: Pivoting45857
Ref: #pivoting45980
Node: Valuation47656
Ref: #valuation47758
Node: -B Cost48447
Ref: #b-cost48551
Node: -V Value48684
Ref: #v-value48830
Node: -X Value in specified commodity49025
Ref: #x-value-in-specified-commodity49224
Node: Valuation date49373
Ref: #valuation-date49541
Node: Market prices49951
Ref: #market-prices50131
Node: --infer-value market prices from transactions50908
Ref: #infer-value-market-prices-from-transactions51157
Node: Valuation commodity52439
Ref: #valuation-commodity52648
Node: Simple valuation examples53874
Ref: #simple-valuation-examples54076
Node: --value Flexible valuation54735
Ref: #value-flexible-valuation54943
Node: More valuation examples56890
Ref: #more-valuation-examples57099
Node: Effect of valuation on reports59104
Ref: #effect-of-valuation-on-reports59292
Node: COMMANDS64813
Ref: #commands64921
Node: accounts66029
Ref: #accounts66127
Node: activity66826
Ref: #activity66936
Node: add67319
Ref: #add67420
Node: aregister70213
Ref: #aregister70325
Node: aregister and custom posting dates71698
Ref: #aregister-and-custom-posting-dates71871
Ref: #output-format-172464
Node: balance72869
Ref: #balance72986
Node: Classic balance report74444
Ref: #classic-balance-report74617
Node: Customising the classic balance report76051
Ref: #customising-the-classic-balance-report76279
Node: Colour support78355
Ref: #colour-support78522
Node: Flat mode78618
Ref: #flat-mode78766
Node: Depth limited balance reports79179
Ref: #depth-limited-balance-reports79364
Node: Percentages79820
Ref: #percentages79986
Node: Multicolumn balance report81123
Ref: #multicolumn-balance-report81303
Node: Budget report86900
Ref: #budget-report87043
Node: Nested budgets92309
Ref: #nested-budgets92421
Ref: #output-format-295902
Node: balancesheet96099
Ref: #balancesheet96235
Node: balancesheetequity97701
Ref: #balancesheetequity97850
Node: cashflow98573
Ref: #cashflow98701
Node: check-dates99880
Ref: #check-dates100007
Node: check-dupes100286
Ref: #check-dupes100412
Node: close100705
Ref: #close100813
Node: close usage102335
Ref: #close-usage102428
Node: codes105241
Ref: #codes105349
Node: commodities106061
Ref: #commodities106188
Node: descriptions106270
Ref: #descriptions106398
Node: diff106702
Ref: #diff106808
Node: files107855
Ref: #files107955
Node: help108102
Ref: #help108202
Node: import109283
Ref: #import109397
Node: Importing balance assignments110290
Ref: #importing-balance-assignments110438
Node: incomestatement111087
Ref: #incomestatement111220
Node: notes112707
Ref: #notes112820
Node: payees113188
Ref: #payees113294
Node: prices113714
Ref: #prices113820
Node: print114161
Ref: #print114271
Node: print-unique119067
Ref: #print-unique119193
Node: register119478
Ref: #register119605
Node: Custom register output123777
Ref: #custom-register-output123906
Node: register-match125243
Ref: #register-match125377
Node: rewrite125728
Ref: #rewrite125843
Node: Re-write rules in a file127698
Ref: #re-write-rules-in-a-file127832
Node: Diff output format129042
Ref: #diff-output-format129211
Node: rewrite vs print --auto130303
Ref: #rewrite-vs.-print---auto130482
Node: roi131038
Ref: #roi131136
Node: stats132148
Ref: #stats132247
Node: tags133035
Ref: #tags133133
Node: test133652
Ref: #test133760
Node: Add-on commands134507
Ref: #add-on-commands134624
Node: ui135967
Ref: #ui136055
Node: web136109
Ref: #web136212
Node: iadd136328
Ref: #iadd136439
Node: interest136521
Ref: #interest136628
Node: ENVIRONMENT136868
Ref: #environment136980
Node: FILES137965
Ref: #files-1138068
Node: LIMITATIONS138281
Ref: #limitations138400
Node: TROUBLESHOOTING139142
Ref: #troubleshooting139255
Node: Command options20767
Ref: #command-options20918
Node: Command arguments21316
Ref: #command-arguments21463
Node: Queries22343
Ref: #queries22498
Node: Special characters in arguments and queries26460
Ref: #special-characters-in-arguments-and-queries26688
Node: More escaping27139
Ref: #more-escaping27301
Node: Even more escaping27597
Ref: #even-more-escaping27791
Node: Less escaping28462
Ref: #less-escaping28624
Node: Unicode characters28869
Ref: #unicode-characters29051
Node: Input files30463
Ref: #input-files30606
Node: Output destination32535
Ref: #output-destination32687
Node: Output format33112
Ref: #output-format33262
Node: Regular expressions35429
Ref: #regular-expressions35586
Node: Smart dates37322
Ref: #smart-dates37473
Node: Report start & end date38834
Ref: #report-start-end-date39006
Node: Report intervals40503
Ref: #report-intervals40668
Node: Period expressions41058
Ref: #period-expressions41218
Node: Depth limiting45369
Ref: #depth-limiting45513
Node: Pivoting45845
Ref: #pivoting45968
Node: Valuation47644
Ref: #valuation47746
Node: -B Cost48435
Ref: #b-cost48539
Node: -V Value48672
Ref: #v-value48818
Node: -X Value in specified commodity49013
Ref: #x-value-in-specified-commodity49212
Node: Valuation date49361
Ref: #valuation-date49529
Node: Market prices49939
Ref: #market-prices50119
Node: --infer-value market prices from transactions50896
Ref: #infer-value-market-prices-from-transactions51145
Node: Valuation commodity52427
Ref: #valuation-commodity52636
Node: Simple valuation examples53862
Ref: #simple-valuation-examples54064
Node: --value Flexible valuation54723
Ref: #value-flexible-valuation54931
Node: More valuation examples56878
Ref: #more-valuation-examples57087
Node: Effect of valuation on reports59092
Ref: #effect-of-valuation-on-reports59280
Node: COMMANDS64801
Ref: #commands64909
Node: accounts66017
Ref: #accounts66115
Node: activity66814
Ref: #activity66924
Node: add67307
Ref: #add67408
Node: aregister70201
Ref: #aregister70313
Node: aregister and custom posting dates71686
Ref: #aregister-and-custom-posting-dates71859
Ref: #output-format-172452
Node: balance72857
Ref: #balance72974
Node: Classic balance report74432
Ref: #classic-balance-report74605
Node: Customising the classic balance report76039
Ref: #customising-the-classic-balance-report76267
Node: Colour support78343
Ref: #colour-support78510
Node: Flat mode78606
Ref: #flat-mode78754
Node: Depth limited balance reports79167
Ref: #depth-limited-balance-reports79352
Node: Percentages79808
Ref: #percentages79974
Node: Multicolumn balance report81111
Ref: #multicolumn-balance-report81291
Node: Budget report86888
Ref: #budget-report87031
Node: Nested budgets92297
Ref: #nested-budgets92409
Ref: #output-format-295890
Node: balancesheet96087
Ref: #balancesheet96223
Node: balancesheetequity97689
Ref: #balancesheetequity97838
Node: cashflow98561
Ref: #cashflow98689
Node: check-dates99868
Ref: #check-dates99995
Node: check-dupes100274
Ref: #check-dupes100400
Node: close100693
Ref: #close100801
Node: close usage102323
Ref: #close-usage102416
Node: codes105229
Ref: #codes105337
Node: commodities106049
Ref: #commodities106176
Node: descriptions106258
Ref: #descriptions106386
Node: diff106690
Ref: #diff106796
Node: files107843
Ref: #files107943
Node: help108090
Ref: #help108190
Node: import109271
Ref: #import109385
Node: Importing balance assignments110278
Ref: #importing-balance-assignments110426
Node: incomestatement111075
Ref: #incomestatement111208
Node: notes112695
Ref: #notes112808
Node: payees113176
Ref: #payees113282
Node: prices113702
Ref: #prices113808
Node: print114149
Ref: #print114259
Node: print-unique119055
Ref: #print-unique119181
Node: register119466
Ref: #register119593
Node: Custom register output123765
Ref: #custom-register-output123894
Node: register-match125231
Ref: #register-match125365
Node: rewrite125716
Ref: #rewrite125831
Node: Re-write rules in a file127686
Ref: #re-write-rules-in-a-file127820
Node: Diff output format129030
Ref: #diff-output-format129199
Node: rewrite vs print --auto130291
Ref: #rewrite-vs.-print---auto130470
Node: roi131026
Ref: #roi131124
Node: stats132136
Ref: #stats132235
Node: tags133023
Ref: #tags133121
Node: test133640
Ref: #test133748
Node: Add-on commands134495
Ref: #add-on-commands134612
Node: ui135955
Ref: #ui136043
Node: web136097
Ref: #web136200
Node: iadd136316
Ref: #iadd136427
Node: interest136509
Ref: #interest136616
Node: ENVIRONMENT136856
Ref: #environment136968
Node: FILES137953
Ref: #files-1138056
Node: LIMITATIONS138269
Ref: #limitations138388
Node: TROUBLESHOOTING139130
Ref: #troubleshooting139243

End Tag Table

12
hledger/hledger.txt
View File

@ -538,12 +538,12 @@ OPTIONS
for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
--color=always|yes|never|no|auto (or --colour=...)
'auto' is the default, it tries to use ANSI color codes in ter-
minal output when supported. 'always' or 'yes' forces color on,
useful when piping output, eg into 'less -R'. 'never' or 'no'
forces color off. A NO_COLOR environment variable also disables
color, overriding this option.
--color=WHEN (or --colour=WHEN)
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a color-
supporting terminal. 'always' or 'yes': always, useful eg when
piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line, the
last one takes precedence.