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

158
hledger-lib/hledger_journal.5
View File

@ -1381,38 +1381,132 @@ account ACCTNAME [ACCTTYPE] [;COMMENT]
.fi .fi
.SS Account types .SS Account types
.PP .PP
hledger recognises five types (or classes) of account: Asset, Liability, hledger recognises five main types of account, corresponding to the
Equity, Revenue, Expense. account classes in the accounting equation:
This is used by a few accounting-aware reports such as balancesheet,
incomestatement and cashflow.
.SS Auto-detected account types
.PP .PP
If you name your top-level accounts with some variation of \f[C]Asset\f[R], \f[C]Liability\f[R], \f[C]Equity\f[R],
\f[C]assets\f[R], \f[C]liabilities\f[R]/\f[C]debts\f[R], \f[C]Revenue\f[R], \f[C]Expense\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
.PP .PP
More generally, you can declare an account\[aq]s type with an account These account types are important for controlling which accounts appear
directive, by writing a \f[C]type:\f[R] tag in a comment, followed by in the balancesheet, balancesheetequity, incomestatement reports (and
one of the words \f[C]Asset\f[R], \f[C]Liability\f[R], \f[C]Equity\f[R], probably for other things in future).
\f[C]Revenue\f[R], \f[C]Expense\f[R], or one of the letters .PP
\f[C]ALERX\f[R] (case insensitive): 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 .IP
.nf .nf
\f[C] \f[C]
account assets ; type:Asset account assets ; type: Asset
account liabilities ; type:Liability account assets:bank ; type: Cash
account equity ; type:Equity account assets:cash ; type: Cash
account revenues ; type:Revenue account liabilities ; type: Liability
account expenses ; type:Expense account equity ; type: Equity
account revenues ; type: Revenue
account expenses ; type: Expense
\f[R] \f[R]
.fi .fi
.SS Account types declared with account type codes .SS Auto-detected account types
.PP .PP
Or, you can write one of those letters separated from the account name If you happen to use common english top-level account names, you may not
by two or more spaces, but this should probably be considered deprecated need to declare account types, as they will be detected automatically
as of hledger 1.13: 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 .IP
.nf .nf
\f[C] \f[C]
@ -1423,22 +1517,6 @@ account revenues R
account expenses X account expenses X
\f[R] \f[R]
.fi .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 .SS Account display order
.PP .PP
Account directives also set the order in which accounts are displayed, Account directives also set the order in which accounts are displayed,

166
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 1.13.8.3 Account types
...................... ......................
hledger recognises five types (or classes) of account: Asset, Liability, hledger recognises five main types of account, corresponding to the
Equity, Revenue, Expense. This is used by a few accounting-aware account classes in the accounting equation:
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):
account assets ; type:Asset 'Asset', 'Liability', 'Equity', 'Revenue', 'Expense'.
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 These account types are important for controlling which accounts
of those letters separated from the account name by two or more spaces, appear in the balancesheet, balancesheetequity, incomestatement reports
but this should probably be considered deprecated as of hledger 1.13: (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
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 assets A
account liabilities L account liabilities L
@ -1278,17 +1323,6 @@ account equity E
account revenues R account revenues R
account expenses X 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 File: hledger_journal.info, Node: Account display order, Prev: Account types, Up: Declaring accounts
@ -1910,42 +1944,42 @@ Node: Account subdirectives45713
Ref: #account-subdirectives45908 Ref: #account-subdirectives45908
Node: Account types46221 Node: Account types46221
Ref: #account-types46405 Ref: #account-types46405
Node: Account display order48044 Node: Account display order49451
Ref: #account-display-order48214 Ref: #account-display-order49621
Node: Rewriting accounts49365 Node: Rewriting accounts50772
Ref: #rewriting-accounts49550 Ref: #rewriting-accounts50957
Node: Basic aliases50307 Node: Basic aliases51714
Ref: #basic-aliases50453 Ref: #basic-aliases51860
Node: Regex aliases51157 Node: Regex aliases52564
Ref: #regex-aliases51329 Ref: #regex-aliases52736
Node: Combining aliases52047 Node: Combining aliases53454
Ref: #combining-aliases52240 Ref: #combining-aliases53647
Node: Aliases and multiple files53516 Node: Aliases and multiple files54923
Ref: #aliases-and-multiple-files53725 Ref: #aliases-and-multiple-files55132
Node: end aliases54304 Node: end aliases55711
Ref: #end-aliases54461 Ref: #end-aliases55868
Node: Default parent account54562 Node: Default parent account55969
Ref: #default-parent-account54730 Ref: #default-parent-account56137
Node: Periodic transactions55614 Node: Periodic transactions57021
Ref: #periodic-transactions55789 Ref: #periodic-transactions57196
Node: Periodic rule syntax57661 Node: Periodic rule syntax59068
Ref: #periodic-rule-syntax57867 Ref: #periodic-rule-syntax59274
Node: Two spaces between period expression and description!58571 Node: Two spaces between period expression and description!59978
Ref: #two-spaces-between-period-expression-and-description58890 Ref: #two-spaces-between-period-expression-and-description60297
Node: Forecasting with periodic transactions59574 Node: Forecasting with periodic transactions60981
Ref: #forecasting-with-periodic-transactions59879 Ref: #forecasting-with-periodic-transactions61286
Node: Budgeting with periodic transactions61934 Node: Budgeting with periodic transactions63341
Ref: #budgeting-with-periodic-transactions62173 Ref: #budgeting-with-periodic-transactions63580
Node: Auto postings62622 Node: Auto postings64029
Ref: #auto-postings62762 Ref: #auto-postings64169
Node: Auto postings and multiple files64941 Node: Auto postings and multiple files66348
Ref: #auto-postings-and-multiple-files65145 Ref: #auto-postings-and-multiple-files66552
Node: Auto postings and dates65354 Node: Auto postings and dates66761
Ref: #auto-postings-and-dates65628 Ref: #auto-postings-and-dates67035
Node: Auto postings and transaction balancing / inferred amounts / balance assertions65803 Node: Auto postings and transaction balancing / inferred amounts / balance assertions67210
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions66154 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions67561
Node: Auto posting tags66496 Node: Auto posting tags67903
Ref: #auto-posting-tags66711 Ref: #auto-posting-tags68118
 
End Tag Table End Tag Table

99
hledger-lib/hledger_journal.txt
View File

@ -978,31 +978,79 @@ FILE FORMAT
[LEDGER-STYLE SUBDIRECTIVES, IGNORED] [LEDGER-STYLE SUBDIRECTIVES, IGNORED]
Account types Account types
hledger recognises five types (or classes) of account: Asset, Liabil- hledger recognises five main types of account, corresponding to the ac-
ity, Equity, Revenue, Expense. This is used by a few accounting-aware count classes in the accounting equation:
reports such as balancesheet, incomestatement and cashflow.
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
Auto-detected account types Auto-detected account types
If you name your top-level accounts with some variation of assets, lia- If you happen to use common english top-level account names, you may
bilities/debts, equity, revenues/income, or expenses, their types are not need to declare account types, as they will be detected automati-
detected automatically. cally using the following rules:
Account types declared with tags If name matches regular account type is:
More generally, you can declare an account's type with an account di- expression:
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 ^assets?(:|$) Asset
ALERX (case insensitive): ^(debts?|lia- Liability
bilit(y|ies))(:|$)
^equity(:|$) Equity
^(income|revenue)s?(:|$) Revenue
^expenses?(:|$) Expense
account assets ; type:Asset If account type is Asset and name does not contain regu- account type
account liabilities ; type:Liability lar expression: is:
account equity ; type:Equity --------------------------------------------------------------------------
account revenues ; type:Revenue (investment|receivable|:A/R|:fixed) Cash
account expenses ; type:Expense
Account types declared with account type codes Even so, explicit declarations may be a good idea, for clarity and pre-
Or, you can write one of those letters separated from the account name dictability.
by two or more spaces, but this should probably be considered depre-
cated as of hledger 1.13: 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 assets A
account liabilities L account liabilities L
@ -1010,17 +1058,6 @@ FILE FORMAT
account revenues R account revenues R
account expenses X 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 display order
Account directives also set the order in which accounts are displayed, Account directives also set the order in which accounts are displayed,
eg in reports, the hledger-ui accounts screen, and the hledger-web 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] \f[B]\f[CB]--change\f[B]\f[R]
show period balances (changes) at startup instead of historical balances show period balances (changes) at startup instead of historical balances
.TP .TP
\f[B]\f[CB]-F --flat\f[B]\f[R] \f[B]\f[CB]-l --flat\f[B]\f[R]
show accounts as a list (default) show accounts as a flat list (default)
.TP .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 show accounts as a tree
.PP .PP
hledger input options: hledger input options:
@ -161,14 +161,14 @@ generate future transactions from periodic transaction rules, for the
next 6 months or till report end date. next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible. In hledger-ui, also make ordinary future transactions visible.
.TP .TP
\f[B]\f[CB]--color=always|yes|never|no|auto (or --colour=...)\f[B]\f[R] \f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R]
\[aq]auto\[aq] is the default, it tries to use ANSI color codes in Should color-supporting commands use ANSI color codes in text output.
terminal output when supported. \[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting
\[aq]always\[aq] or \[aq]yes\[aq] forces color on, useful when piping terminal.
output, eg into \[aq]less -R\[aq]. \[aq]always\[aq] or \[aq]yes\[aq]: always, useful eg when piping output
\[aq]never\[aq] or \[aq]no\[aq] forces color off. into \[aq]less -R\[aq].
A NO_COLOR environment variable also disables color, overriding this \[aq]never\[aq] or \[aq]no\[aq]: never.
option. A NO_COLOR environment variable overrides this.
.PP .PP
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.
@ -186,133 +186,132 @@ show version
\f[B]\f[CB]--debug[=N]\f[B]\f[R] \f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
.PP .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. should contain one command line option/argument per line.
(To prevent this, insert a \f[C]--\f[R] argument before.) (to prevent this, insert a \f[C]--\f[R] argument before.)
.SH KEYS .SH keys
.PP .PP
\f[C]?\f[R] shows a help dialog listing all keys. \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 (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 screen.) press \f[C]?\f[R] again (or \f[C]escape\f[R], or
\f[C]LEFT\f[R]) to close it. \f[C]left\f[R], or \f[C]q\f[R]) to close it.
The following keys work on most screens: the following keys work on most screens:
.PP .PP
The cursor keys navigate: \f[C]right\f[R] (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, 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] \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. 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 Emacs-style
(\f[C]CTRL-p\f[R]/\f[C]CTRL-n\f[R]/\f[C]CTRL-f\f[R]/\f[C]CTRL-b\f[R]) (\f[C]ctrl-p\f[R]/\f[C]ctrl-n\f[R]/\f[C]ctrl-f\f[R]/\f[C]ctrl-b\f[R])
movement keys are also supported. 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 A tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust it. faster you may want to adjust it.
(If you\[aq]re on a mac, the Karabiner app is one way to do that.) (If you\[aq]re on a mac, the karabiner app is one way to do that.)
.PP .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). the transactions to be shown (by default, all are shown).
\f[C]shift-down/up\f[R] steps downward and upward through these standard \f[C]shift-down/up\f[R] steps downward and upward through these standard
report period durations: year, quarter, month, week, day. report period durations: year, quarter, month, week, day.
Then, \f[C]shift-left/right\f[R] moves to the previous/next period. 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. \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] 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 period (the current day, week, month, quarter, or year), the period will
move automatically to track the current date. 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. \f[C]date:\f[R] query.
.PP .PP
\f[C]/\f[R] lets you set a general filter query limiting the data shown, \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. 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; 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. 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 there are also keys for quickly adjusting some common filters like
account depth and transaction status (see below). 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. transactions.
.PP .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 both ordinary transactions recorded in the journal, and periodic
transactions generated by rule. 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. transactions are shown.
(experimental) \f[I](experimental)\f[R]
.PP .PP
\f[C]ESCAPE\f[R] removes all filters and jumps back to the top screen. \f[C]escape\f[R] resets the UI state and jumps back to the top screen,
Or, it cancels a minibuffer edit or help dialog in progress. restoring the app\[aq]s initial state at startup.
Or, it cancels minibuffer data entry or the help dialog.
.PP .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 possible (selections near the top won\[aq]t be centered, since we
don\[aq]t scroll above the top). don\[aq]t scroll above the top).
.PP .PP
\f[C]g\f[R] reloads from the data file(s) and updates the current screen \f[C]g\f[R] reloads from the data file(s) and updates the current screen
and any previous screens. and any previous screens.
(With large files, this could cause a noticeable pause.) (with large files, this could cause a noticeable pause.)
.PP .PP
\f[C]I\f[R] toggles balance assertion checking. \f[C]i\f[R] toggles balance assertion checking.
Disabling balance assertions temporarily can be useful for disabling balance assertions temporarily can be useful for
troubleshooting. troubleshooting.
.PP .PP
\f[C]a\f[R] runs command-line hledger\[aq]s add command, and reloads the \f[C]a\f[R] runs command-line hledger\[aq]s add command, and reloads the
updated file. updated file.
This allows some basic data entry. this allows some basic data entry.
.PP .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. provides a terminal interface.
This key will be available if \f[C]hledger-iadd\f[R] is installed in this key will be available if \f[C]hledger-iadd\f[R] is installed in
$PATH. $path.
.PP .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. (\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 current transaction when invoked from the register and transaction
screens, and at the error location (if possible) when invoked from the screens, and at the error location (if possible) when invoked from the
error screen. error screen.
.PP .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 .PP
Experimental: \f[C]v\f[R] toggles value mode, showing amounts\[aq] current market
.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
value in their default valuation commodity (like toggling the value in their default valuation commodity (like toggling the
\f[C]-V/--market\f[R] flag). \f[C]-v/--market\f[R] flag).
Note, \[dq]current market value\[dq] means the value on the report end note, \[dq]current market value\[dq] means the value on the report end
date if specified, otherwise today. 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. 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 or register screen, press \f[C]/\f[R], and add \f[C]date:-7/30\f[R] to
the query. the query.
.PP .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 .PP
There\[aq]s not yet any visual reminder when cost or value mode is 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 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. reliably reset to normal mode.
.PP .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 viewing the transaction screen in cost or value mode, the
\f[C]B\f[R]/\f[C]V\f[R] keys will stop working. \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 to work around, press g to force a manual reload, or exit the
transaction screen. transaction screen.
.PP .PP
Additional screen-specific keys are described below. \f[C]q\f[R] quits the application.
.SH SCREENS
.SS Accounts screen
.PP .PP
This is normally the first screen displayed. additional screen-specific keys are described below.
It lists accounts and their balances, like hledger\[aq]s balance .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. 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). (including the balances of subaccounts).
if you specify a query on the command line, it shows just the matched if you specify a query on the command line, it shows just the matched
accounts and the balances from matched transactions. accounts and the balances from matched transactions.
.PP .PP
Account names are shown as a flat list by default. Account names are shown as a flat list by default; press \f[C]t\f[R] to
Press \f[C]T\f[R] to toggle tree mode. toggle tree mode.
In flat mode, account balances are exclusive of subaccounts, except In list mode, account balances are exclusive of subaccounts, except
where subaccounts are hidden by a depth limit (see below). where subaccounts are hidden by a depth limit (see below).
In tree mode, all account balances are inclusive of subaccounts. In tree mode, all account balances are inclusive of subaccounts.
.PP .PP
@ -378,11 +377,11 @@ current account.
.PP .PP
Transactions affecting this account\[aq]s subaccounts will be included 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 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. a depth limit.
In other words, the register always shows the transactions contributing In other words, the register always shows the transactions contributing
to the balance shown on the accounts screen. 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 .PP
\f[C]U\f[R] toggles filtering by unmarked status, showing or hiding \f[C]U\f[R] toggles filtering by unmarked status, showing or hiding
unmarked transactions. unmarked transactions.

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

@ -36,14 +36,14 @@ enable "forecast mode".
* Menu: * Menu:
* OPTIONS:: * OPTIONS::
* KEYS:: * keys::
* SCREENS:: * screens::
* ENVIRONMENT:: * ENVIRONMENT::
* FILES:: * FILES::
* BUGS:: * 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 1 OPTIONS
********* *********
@ -67,10 +67,10 @@ the data.
show period balances (changes) at startup instead of historical show period balances (changes) at startup instead of historical
balances balances
'-F --flat' '-l --flat'
show accounts as a list (default) show accounts as a flat list (default)
'-T --tree' '-t --tree'
show accounts as a tree show accounts as a tree
@ -175,13 +175,13 @@ the data.
generate future transactions from periodic transaction rules, for generate future transactions from periodic transaction rules, for
the next 6 months or till report end date. In hledger-ui, also the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible. 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 Should color-supporting commands use ANSI color codes in text
output when supported. 'always' or 'yes' forces color on, useful output. 'auto' (default): whenever stdout seems to be a
when piping output, eg into 'less -R'. 'never' or 'no' forces color color-supporting terminal. 'always' or 'yes': always, useful eg
off. A NO_COLOR environment variable also disables color, when piping output into 'less -R'. 'never' or 'no': never. A
overriding this option. NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line, When a reporting option appears more than once in the command line,
the last one takes precedence. the last one takes precedence.
@ -200,134 +200,134 @@ the last one takes precedence.
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which a @file argument will be expanded to the contents of file, which
should contain one command line option/argument per line. (To prevent should contain one command line option/argument per line. (to prevent
this, insert a '--' argument before.) 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 '?' 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 the quick help at the bottom of each screen.) press '?' again (or
'ESCAPE', or 'LEFT') to close it. The following keys work on most 'escape', or 'left', or 'q') to close it. the following keys work on
screens: 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 returns to the previous screen, 'up'/'down'/'page up'/'page
down'/'home'/'end' move up and down through lists. Vi-style down'/'home'/'end' move up and down through lists. Emacs-style
('h'/'j'/'k'/'l') and Emacs-style ('CTRL-p'/'CTRL-n'/'CTRL-f'/'CTRL-b') ('ctrl-p'/'ctrl-n'/'ctrl-f'/'ctrl-b') movement keys are also supported
movement keys are also supported. A tip: movement speed is limited by (but not vi-style keys, since hledger-1.19, sorry!). A tip: movement
your keyboard repeat rate, to move faster you may want to adjust it. speed is limited by your keyboard repeat rate, to move faster you may
(If you're on a mac, the Karabiner app is one way to do that.) 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). limiting the transactions to be shown (by default, all are shown).
'shift-down/up' steps downward and upward through these standard report 'shift-down/up' steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then, period durations: year, quarter, month, week, day. then,
'shift-left/right' moves to the previous/next period. 't' sets the 'shift-left/right' moves to the previous/next period. 'T' sets the
report period to today. With the '--watch' option, when viewing a report period to today. with the '--watch' option, when viewing a
"current" period (the current day, week, month, quarter, or year), the "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. non-standard period, you can use '/' and a 'date:' query.
'/' lets you set a general filter query limiting the data shown, '/' lets you set a general filter query limiting the data shown,
using the same query terms as in hledger and hledger-web. While editing 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 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 set it, or 'escape'to cancel. there are also keys for quickly adjusting
some common filters like account depth and transaction status (see 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. 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 both ordinary transactions recorded in the journal, and periodic
transactions generated by rule. 'F' toggles forecast mode, in which transactions generated by rule. 'f' toggles forecast mode, in which
future/forecasted transactions are shown. (experimental) future/forecasted transactions are shown. _(experimental)_
'ESCAPE' removes all filters and jumps back to the top screen. Or, 'escape' resets the UI state and jumps back to the top screen,
it cancels a minibuffer edit or help dialog in progress. 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 (selections near the top won't be centered, since we don't scroll above
the top). the top).
'g' reloads from the data file(s) and updates the current screen and '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.) pause.)
'I' toggles balance assertion checking. Disabling balance assertions 'i' toggles balance assertion checking. disabling balance assertions
temporarily can be useful for troubleshooting. temporarily can be useful for troubleshooting.
'a' runs command-line hledger's add command, and reloads the updated '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 'a' is like 'a', but runs the hledger-iadd tool, which provides a
terminal interface. This key will be available if 'hledger-iadd' is terminal interface. this key will be available if 'hledger-iadd' is
installed in $PATH. installed in $path.
'E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default ('emacsclient 'e' runs $hledger_ui_editor, or $editor, or a default ('emacsclient
-a "" -nw') on the journal file. With some editors (emacs, vi), the -a "" -nw') on the journal file. with some editors (emacs, vi), the
cursor will be positioned at the current transaction when invoked from cursor will be positioned at the current transaction when invoked from
the register and transaction screens, and at the error location (if the register and transaction screens, and at the error location (if
possible) when invoked from the error screen. 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: 'v' toggles value mode, showing amounts' current market value in
their default valuation commodity (like toggling the '-v/--market'
'B' toggles cost mode, showing amounts in their transaction price's flag). note, "current market value" means the value on the report end
commodity (like toggling the '-B/--cost' flag). 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 transaction as it was valued on july 30, go to the accounts or register
screen, press '/', and add 'date:-7/30' to the query. 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 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 active; for now pressing 'b' 'b' 'v' should reliably reset to normal
mode. mode.
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 'B'/'V' keys 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 will stop working. to work around, press g to force a manual reload, or
exit the transaction screen. 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: * Menu:
* Accounts screen:: * accounts screen::
* Register screen:: * Register screen::
* Transaction screen:: * Transaction screen::
* Error 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 this is normally the first screen displayed. it lists accounts and
their balances, like hledger's balance command. By default, it shows their balances, like hledger's balance command. by default, it shows
all accounts and their latest ending balances (including the balances of all accounts and their latest ending balances (including the balances of
subaccounts). if you specify a query on the command line, it shows just subaccounts). if you specify a query on the command line, it shows just
the matched accounts and the balances from matched transactions. the matched accounts and the balances from matched transactions.
Account names are shown as a flat list by default. Press 'T' to Account names are shown as a flat list by default; press 't' to
toggle tree mode. In flat mode, account balances are exclusive of toggle tree mode. In list mode, account balances are exclusive of
subaccounts, except where subaccounts are hidden by a depth limit (see subaccounts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of below). In tree mode, all account balances are inclusive of
subaccounts. subaccounts.
@ -364,7 +364,7 @@ command-line hledger).
Press 'right' or 'enter' to view an account's transactions register. 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 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. balance you would see on a bank register for the current account.
Transactions affecting this account's subaccounts will be included in 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 mode but this account has subaccounts which are not shown due to a depth
limit. In other words, the register always shows the transactions limit. In other words, the register always shows the transactions
contributing to the balance shown on the accounts screen. Tree 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 'U' toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, 'P' toggles pending transactions, and 'C' transactions. Similarly, 'P' toggles pending transactions, and 'C'
@ -411,7 +411,7 @@ command-line hledger).
detail. 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 3.3 Transaction screen
====================== ======================
@ -435,7 +435,7 @@ unfiltered journal, which is a more stable id (at least until the next
reload). 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 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.) 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 4 ENVIRONMENT
************* *************
@ -517,24 +517,24 @@ Tag Table:
Node: Top71 Node: Top71
Node: OPTIONS1476 Node: OPTIONS1476
Ref: #options1573 Ref: #options1573
Node: KEYS5552 Node: keys5545
Ref: #keys5647 Ref: #keys5640
Node: SCREENS9923 Node: screens9972
Ref: #screens10028 Ref: #screens10077
Node: Accounts screen10118 Node: accounts screen10167
Ref: #accounts-screen10246 Ref: #accounts-screen10295
Node: Register screen12462 Node: Register screen12510
Ref: #register-screen12617 Ref: #register-screen12665
Node: Transaction screen14614 Node: Transaction screen14662
Ref: #transaction-screen14772 Ref: #transaction-screen14820
Node: Error screen15642 Node: Error screen15690
Ref: #error-screen15764 Ref: #error-screen15812
Node: ENVIRONMENT16008 Node: ENVIRONMENT16056
Ref: #environment16122 Ref: #environment16170
Node: FILES16929 Node: FILES16977
Ref: #files17028 Ref: #files17076
Node: BUGS17241 Node: BUGS17289
Ref: #bugs17318 Ref: #bugs17366
 
End Tag Table End Tag Table

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

@ -53,10 +53,10 @@ OPTIONS
show period balances (changes) at startup instead of historical show period balances (changes) at startup instead of historical
balances balances
-F --flat -l --flat
show accounts as a list (default) show accounts as a flat list (default)
-T --tree -t --tree
show accounts as a tree show accounts as a tree
hledger input options: hledger input options:
@ -158,12 +158,12 @@ OPTIONS
for the next 6 months or till report end date. In hledger-ui, for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible. 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 ter- Should color-supporting commands use ANSI color codes in text
minal output when supported. 'always' or 'yes' forces color on, output. 'auto' (default): whenever stdout seems to be a color-
useful when piping output, eg into 'less -R'. 'never' or 'no' supporting terminal. 'always' or 'yes': always, useful eg when
forces color off. A NO_COLOR environment variable also disables piping output into 'less -R'. 'never' or 'no': never. A
color, overriding this option. NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.
@ -181,138 +181,137 @@ OPTIONS
--debug[=N] --debug[=N]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which should a @file argument will be expanded to the contents of file, which should
contain one command line option/argument per line. (To prevent this, contain one command line option/argument per line. (to prevent this,
insert a -- argument before.) insert a -- argument before.)
KEYS keys
? shows a help dialog listing all keys. (Some of these also appear in ? 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, 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: 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 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- down through lists. Emacs-style (ctrl-p/ctrl-n/ctrl-f/ctrl-b) movement
n/CTRL-f/CTRL-b) movement keys are also supported. A tip: movement keys are also supported (but not vi-style keys, since hledger-1.19,
speed is limited by your keyboard repeat rate, to move faster you may sorry!). A tip: movement speed is limited by your keyboard repeat
want to adjust it. (If you're on a mac, the Karabiner app is one way rate, to move faster you may want to adjust it. (If you're on a mac,
to do that.) 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- the transactions to be shown (by default, all are shown). shift-
down/up steps downward and upward through these standard report period down/up steps downward and upward through these standard report period
durations: year, quarter, month, week, day. Then, shift-left/right durations: year, quarter, month, week, day. then, shift-left/right
moves to the previous/next period. t sets the report period to today. moves to the previous/next period. T sets the report period to today.
With the --watch option, when viewing a "current" period (the current with the --watch option, when viewing a "current" period (the current
day, week, month, quarter, or year), the period will move automatically 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. and a date: query.
/ lets you set a general filter query limiting the data shown, using / 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 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 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 it, or escapeto cancel. there are also keys for quickly adjusting some
common filters like account depth and transaction status (see below). 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- 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) ture/forecasted transactions are shown. (experimental)
ESCAPE removes all filters and jumps back to the top screen. Or, it escape resets the UI state and jumps back to the top screen, restoring
cancels a minibuffer edit or help dialog in progress. 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 tions near the top won't be centered, since we don't scroll above the
top). top).
g reloads from the data file(s) and updates the current screen and any 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.) pause.)
I toggles balance assertion checking. Disabling balance assertions i toggles balance assertion checking. disabling balance assertions
temporarily can be useful for troubleshooting. temporarily can be useful for troubleshooting.
a runs command-line hledger's add command, and reloads the updated 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 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 interface. this key will be available if hledger-iadd is installed in
$PATH. $path.
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a "" e runs $hledger_ui_editor, or $editor, or a default (emacsclient -a ""
-nw) on the journal file. With some editors (emacs, vi), the cursor -nw) on the journal file. with some editors (emacs, vi), the cursor
will be positioned at the current transaction when invoked from the will be positioned at the current transaction when invoked from the
register and transaction screens, and at the error location (if possi- register and transaction screens, and at the error location (if possi-
ble) when invoked from the error screen. ble) when invoked from the error screen.
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
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.
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
exit the transaction screen.
q quits the application. q quits the application.
Experimental: additional screen-specific keys are described below.
B toggles cost mode, showing amounts in their transaction price's com- screens
modity (like toggling the -B/--cost flag). accounts screen
this is normally the first screen displayed. it lists accounts and
V toggles value mode, showing amounts' current market value in their their balances, like hledger's balance command. by default, it shows
default valuation commodity (like toggling the -V/--market flag). all accounts and their latest ending balances (including the balances
Note, "current market value" means the value on the report end date if of subaccounts). if you specify a query on the command line, it shows
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.
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
exit the transaction screen.
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. just the matched accounts and the balances from matched transactions.
Account names are shown as a flat list by default. Press T to toggle 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- tree mode. In list mode, account balances are exclusive of subac-
counts, except where subaccounts are hidden by a depth limit (see be- counts, except where subaccounts are hidden by a depth limit (see be-
low). In tree mode, all account balances are inclusive of subaccounts. low). 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. 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 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 less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press ES- depth limit, set it higher than the maximum account depth, or press ES-
CAPE. CAPE.
H toggles between showing historical balances or period balances. His- H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before (filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions be- disturbed by a filter query). Period balances ignore transactions be-
fore the report start date, so they show the change in balance during fore 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. the report period. They are more useful eg when viewing a time log.
U toggles filtering by unmarked status, including or excluding unmarked U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (By default, balances include all postings; toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are in- if you activate one or two status filters, only those postings are in-
cluded; and if you activate all three, the filter is removed.) cluded; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only accounts with nonzero balances Z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line are shown (hledger-ui shows zero items by default, unlike command-line
hledger). hledger).
Press right or enter to view an account's transactions register. Press right or enter to view an account's transactions register.
@ -321,63 +320,63 @@ SCREENS
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows: a check register. Each line represents one transaction and shows:
o the other account(s) involved, in abbreviated form. (If there are o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected both real and virtual postings, it shows only the accounts affected
by real postings.) by real postings.)
o the overall change to the current account's balance; positive for an o the overall change to the current account's balance; positive for an
inflow to this account, negative for an outflow. inflow to this account, negative for an outflow.
o the running historical total or period total for the current account, o the running historical total or period total for the current account,
after the transaction. This can be toggled with H. Similar to the after the transaction. This can be toggled with H. Similar to the
accounts screen, the historical total is affected by transactions accounts screen, the historical total is affected by transactions
(filtered by the filter query) before the report start date, while (filtered by the filter query) before the report start date, while
the period total is not. If the historical total is not disturbed by 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 a filter query, it will be the running historical balance you would
see on a bank register for the current account. see on a bank register for the current account.
Transactions affecting this account's subaccounts will be included in 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 mode but this account has subaccounts which are not shown due to a
depth limit. In other words, the register always shows the transac- depth limit. In other words, the register always shows the transac-
tions contributing to the balance shown on the accounts screen. Tree 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 U toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, P toggles pending transactions, and C toggles transactions. Similarly, P toggles pending transactions, and C toggles
cleared transactions. (By default, transactions with all statuses are cleared transactions. (By default, transactions with all statuses are
shown; if you activate one or two status filters, only those transac- shown; if you activate one or two status filters, only those transac-
tions are shown; and if you activate all three, the filter is removed.) tions are shown; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only transactions posting a nonzero Z toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com- change are shown (hledger-ui shows zero items by default, unlike com-
mand-line hledger). mand-line hledger).
Press right (or enter) to view the selected transaction in detail. Press right (or enter) to view the selected transaction in detail.
Transaction screen Transaction screen
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour- similar to hledger's print command and journal format (hledger_jour-
nal(5)). nal(5)).
The transaction's date(s) and any cleared flag, transaction code, de- The transaction's date(s) and any cleared flag, transaction code, de-
scription, comments, along with all of its account postings are shown. scription, comments, along with all of its account postings are shown.
Simple transactions have two postings, but there can be more (or in Simple transactions have two postings, but there can be more (or in
certain cases, fewer). certain cases, fewer).
up and down will step through all transactions listed in the previous up and down will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary de- show your position within that account register. They will vary de-
pending on which account register you came from (remember most transac- pending on which account register you came from (remember most transac-
tions appear in multiple account registers). The #N number preceding tions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour- them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload). nal, which is a more stable id (at least until the next reload).
Error screen Error screen
This screen will appear if there is a problem, such as a parse error, This screen will appear if there is a problem, such as a parse error,
when you press g to reload. Once you have fixed the problem, press g when you press g to reload. Once you have fixed the problem, press g
again to reload and resume normal operation. (Or, you can press escape again to reload and resume normal operation. (Or, you can press escape
to cancel the reload attempt.) to cancel the reload attempt.)
@ -385,15 +384,15 @@ ENVIRONMENT
COLUMNS The screen width to use. Default: the full terminal width. COLUMNS The screen width to use. Default: the full terminal width.
LEDGER_FILE The journal file path when not specified with -f. Default: LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal). nal).
A typical value is ~/DIR/YYYY.journal, where DIR is a version-con- A typical value is ~/DIR/YYYY.journal, where DIR is a version-con-
trolled finance directory and YYYY is the current year. Or ~/DIR/cur- trolled finance directory and YYYY is the current year. Or ~/DIR/cur-
rent.journal, where current.journal is a symbolic link to YYYY.journal. rent.journal, where current.journal is a symbolic link to YYYY.journal.
On Mac computers, you can set this and other environment variables in a On Mac computers, you can set this and other environment variables in a
more thorough way that also affects applications started from the GUI more thorough way that also affects applications started from the GUI
(say, an Emacs dock icon). Eg on MacOS Catalina I have a ~/.MacOSX/en- (say, an Emacs dock icon). Eg on MacOS Catalina I have a ~/.MacOSX/en-
vironment.plist file containing vironment.plist file containing
@ -404,13 +403,13 @@ ENVIRONMENT
To see the effect you may need to killall Dock, or reboot. To see the effect you may need to killall Dock, or reboot.
FILES FILES
Reads data from one or more files in hledger journal, timeclock, time- Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). C:/Users/USER/.hledger.journal).
BUGS BUGS
The need to precede options with -- when invoked from hledger is awk- The need to precede options with -- when invoked from hledger is awk-
ward. ward.
-f- doesn't work (hledger-ui can't read from stdin). -f- doesn't work (hledger-ui can't read from stdin).
@ -418,24 +417,24 @@ BUGS
-V affects only the accounts screen. -V affects only the accounts screen.
When you press g, the current and all previous screens are regenerated, When you press g, the current and all previous screens are regenerated,
which may cause a noticeable pause with large files. Also there is no which may cause a noticeable pause with large files. Also there is no
visual indication that this is in progress. visual indication that this is in progress.
--watch is not yet fully robust. It works well for normal usage, but --watch is not yet fully robust. It works well for normal usage, but
many file changes in a short time (eg saving the file thousands of many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. Symp- times with an editor macro) can cause problems at least on OSX. Symp-
toms include: unresponsive UI, periodic resetting of the cursor posi- toms include: unresponsive UI, periodic resetting of the cursor posi-
tion, momentary display of parse errors, high CPU usage eventually sub- tion, momentary display of parse errors, high CPU usage eventually sub-
siding, and possibly a small but persistent build-up of CPU usage until siding, and possibly a small but persistent build-up of CPU usage until
the program is restarted. the program is restarted.
Also, if you are viewing files mounted from another machine, --watch Also, if you are viewing files mounted from another machine, --watch
requires that both machine clocks are roughly in step. requires that both machine clocks are roughly in step.
REPORTING BUGS REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list) or hledger mail list)
@ -449,7 +448,7 @@ COPYRIGHT
SEE ALSO SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
dot(5), ledger(1) dot(5), ledger(1)

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