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

;doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2021-12-05 10:56:41 -10:00
parent fdc373f45c
commit 2a58331024
9 changed files with 3351 additions and 3657 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,5 +1,5 @@
.TH "HLEDGER-UI" "1" "December 2021" "hledger-ui-1.24 " "hledger User Manuals" .TH "HLEDGER-UI" "1" "December 2021" "hledger-ui-1.24.99 " "hledger User Manuals"
@ -7,7 +7,7 @@
.PP .PP
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. tool.
This manual is for hledger-ui 1.24. This manual is for hledger-ui 1.24.99.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R] \f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R]

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

@ -1,5 +1,4 @@
This is hledger-ui/hledger-ui.info, produced by makeinfo version 4.8 This is hledger-ui.info, produced by makeinfo version 6.8 from stdin.
from stdin.
INFO-DIR-SECTION User Applications INFO-DIR-SECTION User Applications
START-INFO-DIR-ENTRY START-INFO-DIR-ENTRY
@ -7,36 +6,36 @@ START-INFO-DIR-ENTRY
END-INFO-DIR-ENTRY END-INFO-DIR-ENTRY
 
File: hledger-ui.info, Node: Top, Up: (dir) File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-ui(1) hledger-ui(1)
************* *************
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.24. tool. This manual is for hledger-ui 1.24.99.
`hledger-ui [OPTIONS] [QUERYARGS]' 'hledger-ui [OPTIONS] [QUERYARGS]'
`hledger ui -- [OPTIONS] [QUERYARGS]' 'hledger ui -- [OPTIONS] [QUERYARGS]'
hledger is a reliable, cross-platform set of programs for tracking hledger is a reliable, cross-platform set of programs for tracking
money, time, or any other commodity, using double-entry accounting and a money, time, or any other commodity, using double-entry accounting and a
simple, editable file format. hledger is inspired by and largely simple, editable file format. hledger is inspired by and largely
compatible with ledger(1). compatible with ledger(1).
hledger-ui is hledger's terminal interface, providing an efficient hledger-ui is hledger's terminal interface, providing an efficient
full-window text UI for viewing accounts and transactions, and some full-window text UI for viewing accounts and transactions, and some
limited data entry capability. It is easier than hledger's command-line limited data entry capability. It is easier than hledger's command-line
interface, and sometimes quicker and more convenient than the web interface, and sometimes quicker and more convenient than the web
interface. interface.
Like hledger, it reads data from one or more files in hledger Like hledger, it reads data from one or more files in hledger
journal, timeclock, timedot, or CSV format specified with `-f', or journal, timeclock, timedot, or CSV format specified with '-f', or
`$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps '$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal'). For more about this see hledger(1), 'C:/Users/USER/.hledger.journal'). For more about this see hledger(1),
hledger_journal(5) etc. hledger_journal(5) etc.
Unlike hledger, hledger-ui hides all future-dated transactions by Unlike hledger, hledger-ui hides all future-dated transactions by
default. They can be revealed, along with any rule-generated periodic default. They can be revealed, along with any rule-generated periodic
transactions, by pressing the F key (or starting with -forecast) to transactions, by pressing the F key (or starting with -forecast) to
enable "forecast mode". enable "forecast mode".
@ -57,155 +56,158 @@ File: hledger-ui.info, Node: OPTIONS, Next: MOUSE, Prev: Top, Up: Top
1 OPTIONS 1 OPTIONS
********* *********
Note: if invoking hledger-ui as a hledger subcommand, write `--' before Note: if invoking hledger-ui as a hledger subcommand, write '--' before
options as shown above. options as shown above.
Any QUERYARGS are interpreted as a hledger search query which filters Any QUERYARGS are interpreted as a hledger search query which filters
the data. the data.
`-w --watch' '-w --watch'
watch for data and date changes and reload automatically watch for data and date changes and reload automatically
'--theme=default|terminal|greenterm'
`--theme=default|terminal|greenterm'
use this custom display theme use this custom display theme
'--register=ACCTREGEX'
`--register=ACCTREGEX'
start in the (first) matched account's register screen start in the (first) matched account's register screen
'--change'
`--change'
show period balances (changes) at startup instead of historical show period balances (changes) at startup instead of historical
balances balances
'-l --flat'
`-l --flat'
show accounts as a flat 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:
`-f FILE --file=FILE' '-f FILE --file=FILE'
use a different input file. For stdin, use - (default:
`$LEDGER_FILE' or `$HOME/.hledger.journal') use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal')
'--rules-file=RULESFILE'
`--rules-file=RULESFILE'
Conversion rules file to use when reading CSV (default: FILE.rules) Conversion rules file to use when reading CSV (default: FILE.rules)
'--separator=CHAR'
`--separator=CHAR'
Field separator to expect when reading CSV (default: ',') Field separator to expect when reading CSV (default: ',')
'--alias=OLD=NEW'
`--alias=OLD=NEW'
rename accounts named OLD to NEW rename accounts named OLD to NEW
'--anon'
`--anon'
anonymize accounts and payees anonymize accounts and payees
'--pivot FIELDNAME'
`--pivot FIELDNAME'
use some other field or tag for the account name use some other field or tag for the account name
'-I --ignore-assertions'
`-I --ignore-assertions'
disable balance assertion checks (note: does not disable balance disable balance assertion checks (note: does not disable balance
assignments) assignments)
'-s --strict'
`-s --strict'
do extra error checking (check that all posted accounts are do extra error checking (check that all posted accounts are
declared) declared)
hledger reporting options: hledger reporting options:
`-b --begin=DATE' '-b --begin=DATE'
include postings/txns on or after this date (will be adjusted to include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval) preceding subperiod start when using a report interval)
'-e --end=DATE'
`-e --end=DATE'
include postings/txns before this date (will be adjusted to include postings/txns before this date (will be adjusted to
following subperiod end when using a report interval) following subperiod end when using a report interval)
'-D --daily'
`-D --daily'
multiperiod/multicolumn report by day multiperiod/multicolumn report by day
'-W --weekly'
`-W --weekly'
multiperiod/multicolumn report by week multiperiod/multicolumn report by week
'-M --monthly'
`-M --monthly'
multiperiod/multicolumn report by month multiperiod/multicolumn report by month
'-Q --quarterly'
`-Q --quarterly'
multiperiod/multicolumn report by quarter multiperiod/multicolumn report by quarter
'-Y --yearly'
`-Y --yearly'
multiperiod/multicolumn report by year multiperiod/multicolumn report by year
'-p --period=PERIODEXP'
`-p --period=PERIODEXP'
set start date, end date, and/or reporting interval all at once set start date, end date, and/or reporting interval all at once
using period expressions syntax using period expressions syntax
'--date2'
`--date2'
match the secondary date instead (see command help for other match the secondary date instead (see command help for other
effects) effects)
'--today=DATE'
`--today=DATE'
override today's date (affects relative smart dates, for override today's date (affects relative smart dates, for
tests/examples) tests/examples)
'-U --unmarked'
`-U --unmarked'
include only unmarked postings/txns (can combine with -P or -C) include only unmarked postings/txns (can combine with -P or -C)
'-P --pending'
`-P --pending'
include only pending postings/txns include only pending postings/txns
'-C --cleared'
`-C --cleared'
include only cleared postings/txns include only cleared postings/txns
'-R --real'
`-R --real'
include only non-virtual postings include only non-virtual postings
'-NUM --depth=NUM'
`-NUM --depth=NUM'
hide/aggregate accounts or postings more than NUM levels deep hide/aggregate accounts or postings more than NUM levels deep
'-E --empty'
`-E --empty'
show items with zero amount, normally hidden (and vice-versa in show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web) hledger-ui/hledger-web)
'-B --cost'
`-B --cost'
convert amounts to their cost/selling amount at transaction time convert amounts to their cost/selling amount at transaction time
'-V --market'
`-V --market'
convert amounts to their market value in default valuation convert amounts to their market value in default valuation
commodities commodities
'-X --exchange=COMM'
`-X --exchange=COMM'
convert amounts to their market value in commodity COMM convert amounts to their market value in commodity COMM
'--value'
`--value'
convert amounts to cost or market value, more flexibly than convert amounts to cost or market value, more flexibly than
-B/-V/-X -B/-V/-X
'--infer-market-prices'
`--infer-market-prices'
use transaction prices (recorded with @ or @@) as additional market use transaction prices (recorded with @ or @@) as additional market
prices, as if they were P directives prices, as if they were P directives
'--auto'
`--auto'
apply automated posting rules to modify transactions. apply automated posting rules to modify transactions.
'--forecast'
`--forecast'
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.
'--commodity-style'
`--commodity-style'
Override the commodity style in the output for the specified Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'. commodity. For example 'EUR1.000,00'.
'--color=WHEN (or --colour=WHEN)'
`--color=WHEN (or --colour=WHEN)'
Should color-supporting commands use ANSI color codes in text Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a output. 'auto' (default): whenever stdout seems to be a
color-supporting terminal. 'always' or 'yes': always, useful eg color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this. NO_COLOR environment variable overrides this.
'--pretty[=WHEN]'
`--pretty[=WHEN]' Show prettier output, e.g. using unicode box-drawing characters.
Show prettier output, e.g. using unicode box-drawing characters.
Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', 'never' Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', 'never'
also work). If you provide an argument you must use '=', e.g. also work). If you provide an argument you must use '=', e.g.
'-pretty=yes'. '-pretty=yes'.
@ -217,24 +219,25 @@ the last one takes precedence.
hledger help options: hledger help options:
`-h --help' '-h --help'
show general or COMMAND help show general or COMMAND help
'--man'
`--man'
show general or COMMAND user manual with man show general or COMMAND user manual with man
'--info'
`--info'
show general or COMMAND user manual with info show general or COMMAND user manual with info
'--version'
`--version'
show general or ADDONCMD version show general or ADDONCMD version
'--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 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: MOUSE, Next: KEYS, Prev: OPTIONS, Up: Top File: hledger-ui.info, Node: MOUSE, Next: KEYS, Prev: OPTIONS, Up: Top
@ -246,9 +249,7 @@ In most modern terminals, you can navigate through the screens with a
mouse or touchpad: mouse or touchpad:
* Use mouse wheel or trackpad to scroll up and down * Use mouse wheel or trackpad to scroll up and down
* Click on list items to go deeper * Click on list items to go deeper
* Click on the left margin (column 0), or the blank area at bottom of * Click on the left margin (column 0), or the blank area at bottom of
screen, to go back. screen, to go back.
@ -260,88 +261,88 @@ File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: MOUSE, Up: Top
Keyboard gives more control. Keyboard gives more control.
`?' shows a help dialog listing all keys. (Some of these also appear '?' 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 in the quick help at the bottom of each screen.) Press '?' again (or
`ESCAPE', or `LEFT', or `q') to close it. The following keys work on 'ESCAPE', or 'LEFT', or 'q') to close it. The following keys work on
most screens: most screens:
The cursor keys navigate: `RIGHT' goes deeper, `LEFT' returns to the The cursor keys navigate: 'RIGHT' goes deeper, 'LEFT' returns to the
previous screen, `UP'/`DOWN'/`PGUP'/`PGDN'/`HOME'/`END' move up and previous screen, 'UP'/'DOWN'/'PGUP'/'PGDN'/'HOME'/'END' move up and down
down through lists. Emacs-style (`CTRL-p'/`CTRL-n'/`CTRL-f'/`CTRL-b') through lists. Emacs-style ('CTRL-p'/'CTRL-n'/'CTRL-f'/'CTRL-b')
movement keys are also supported (but not vi-style keys, since movement keys are also supported (but not vi-style keys, since
hledger-1.19, sorry!). A tip: movement speed is limited by your hledger-1.19, sorry!). A tip: movement speed is limited by your
keyboard repeat rate, to move faster you may want to adjust it. (If keyboard repeat rate, to move faster you may want to adjust it. (If
you're on a mac, the karabiner app is one way to do that.) 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 `-w/--watch' option, when viewing a report period to today. With the '-w/--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. future/forecasted transactions are shown.
`ESCAPE' resets the UI state and jumps back to the top screen, 'ESCAPE' resets the UI state and jumps back to the top screen,
restoring the app's initial state at startup. Or, it cancels minibuffer restoring the app's initial state at startup. Or, it cancels minibuffer
data entry or the help dialog. 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.
`B' toggles cost mode, showing amounts in their transaction price's 'B' toggles cost mode, showing amounts in their transaction price's
commodity (like toggling the `-B/--cost' flag). commodity (like toggling the '-B/--cost' flag).
`V' toggles value mode, showing amounts' current market value in 'V' toggles value mode, showing amounts' current market value in
their default valuation commodity (like toggling the `-V/--market' their default valuation commodity (like toggling the '-V/--market'
flag). Note, "current market value" means the value on the report end flag). Note, "current market value" means the value on the report end
date if specified, otherwise today. To see the value on another date, 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 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.
`q' quits the application. 'q' quits the application.
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
@ -364,49 +365,50 @@ File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Up: SCRE
4.1 Accounts screen 4.1 Accounts screen
=================== ===================
This is normally the first screen displayed. It lists accounts and their This is normally the first screen displayed. It lists accounts and
balances, like hledger's balance command. By default, it shows all their balances, like hledger's balance command. By default, it shows
accounts and their latest ending balances (including the balances of all accounts and their latest ending balances (including the balances of
subaccounts). Accounts which have been declared with an account subaccounts). Accounts which have been declared with an account
directive are also listed, even if not yet used (except for empty parent directive are also listed, even if not yet used (except for empty parent
accounts). If you specify a query on the command line, it shows just the accounts). If you specify a query on the command line, it shows just
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 list 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 subaccounts. below). In tree mode, all account balances are inclusive of
subaccounts.
To see less detail, press a number key, `1' to `9', to set a depth 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. limit. Or use '-' to decrease and '+'/'=' to increase the depth limit.
`0' shows even less detail, collapsing all accounts to a single total. '0' shows even less detail, collapsing all accounts to a single total.
To remove the depth limit, set it higher than the maximum account To remove the depth limit, set it higher than the maximum account depth,
depth, or press `ESCAPE'. or press 'ESCAPE'.
`H' toggles between showing historical balances or period balances. 'H' toggles between showing historical balances or period balances.
Historical balances (the default) are ending balances at the end of the Historical 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 the (filtered by the filter query if any), including transactions before the
start of the report period. In other words, historical balances are what start of the report period. In other words, historical balances are
you would see on a bank statement for that account (unless disturbed by what you would see on a bank statement for that account (unless
a filter query). Period balances ignore transactions before the report disturbed by a filter query). Period balances ignore transactions
start date, so they show the change in balance during the report period. before the report start date, so they show the change in balance during
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 'U' toggles filtering by unmarked status, including or excluding
unmarked postings in the balances. Similarly, `P' toggles pending unmarked postings in the balances. Similarly, 'P' toggles pending
postings, and `C' toggles cleared postings. (By default, balances postings, and 'C' toggles cleared postings. (By default, balances
include all postings; if you activate one or two status filters, only include all postings; if you activate one or two status filters, only
those postings are included; and if you activate all three, the filter those postings are included; and if you activate all three, the filter
is removed.) 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 'z' toggles nonzero mode, in which only accounts with nonzero
balances are shown (hledger-ui shows zero items by default, unlike balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger). command-line hledger).
Press `RIGHT' to view an account's transactions register. Press 'RIGHT' 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
@ -415,46 +417,44 @@ File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev:
=================== ===================
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:
* the other account(s) involved, in abbreviated form. (If there are * the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts both real and virtual postings, it shows only the accounts affected
affected by real postings.) by real postings.)
* the overall change to the current account's balance; positive for * the overall change to the current account's balance; positive for
an inflow to this account, negative for an outflow. an inflow to this account, negative for an outflow.
* the running historical total or period total for the current * the running historical total or period total for the current
account, after the transaction. This can be toggled with `H'. account, after the transaction. This can be toggled with 'H'.
Similar to the accounts screen, the historical total is affected Similar to the accounts screen, the historical total is affected by
by transactions (filtered by the filter query) before the report transactions (filtered by the filter query) before the report start
start date, while the period total is not. If the historical total date, while the period total is not. If the historical total is
is not disturbed by a filter query, it will be the running not disturbed by a filter query, it will be the running historical
historical balance you would see on a bank register for the balance you would see on a bank register for the current account.
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 list 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 mode/list contributing to the balance shown on the accounts screen. Tree
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'
toggles cleared transactions. (By default, transactions with all toggles cleared transactions. (By default, transactions with all
statuses are shown; if you activate one or two status filters, only statuses are shown; if you activate one or two status filters, only
those transactions are shown; and if you activate all three, the filter those transactions are shown; and if you activate all three, the filter
is removed.) 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 'z' toggles nonzero mode, in which only transactions posting a
nonzero change are shown (hledger-ui shows zero items by default, unlike nonzero change are shown (hledger-ui shows zero items by default, unlike
command-line hledger). command-line hledger).
Press `RIGHT' to view the selected transaction in detail. Press 'RIGHT' to view the selected transaction in 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
@ -471,11 +471,11 @@ description, 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 'UP' and 'DOWN' will step through all transactions listed in the
previous account register screen. In the title bar, the numbers in previous account register screen. In the title bar, the numbers in
parentheses show your position within that account register. They will parentheses show your position within that account register. They will
vary depending on which account register you came from (remember most vary depending on which account register you came from (remember most
transactions appear in multiple account registers). The #N number transactions appear in multiple account registers). The #N number
preceding them is the transaction's position within the complete preceding them is the transaction's position within the complete
unfiltered journal, which is a more stable id (at least until the next unfiltered journal, which is a more stable id (at least until the next
reload). reload).
@ -487,8 +487,8 @@ File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCRE
================ ================
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.)
 
@ -508,21 +508,20 @@ File: hledger-ui.info, Node: Watch mode, Next: Watch mode limitations, Up: TI
5.1 Watch mode 5.1 Watch mode
============== ==============
One of hledger-ui's best features is the auto-reloading `-w/--watch' One of hledger-ui's best features is the auto-reloading '-w/--watch'
mode. With this flag, it will update the display automatically whenever mode. With this flag, it will update the display automatically whenever
changes are saved to the data files. changes are saved to the data files.
This is very useful when reconciling. A good workflow is to have your This is very useful when reconciling. A good workflow is to have
bank's online register open in a browser window, for reference; the your bank's online register open in a browser window, for reference; the
journal file open in an editor window; and hledger-ui in watch mode in a journal file open in an editor window; and hledger-ui in watch mode in a
terminal window, eg: terminal window, eg:
$ hledger-ui --watch --register checking -C $ hledger-ui --watch --register checking -C
As you mark things cleared in the editor, you can see the effect As you mark things cleared in the editor, you can see the effect
immediately without having to context switch. This leaves more mental immediately without having to context switch. This leaves more mental
bandwidth for your accounting. Of course you can still interact with bandwidth for your accounting. Of course you can still interact with
hledger-ui when needed, eg to toggle cleared mode, or to explore the hledger-ui when needed, eg to toggle cleared mode, or to explore the
history. history.
@ -533,29 +532,28 @@ File: hledger-ui.info, Node: Watch mode limitations, Prev: Watch mode, Up: TI
========================== ==========================
There are situations in which it won't work, ie the display will not There are situations in which it won't work, ie the display will not
update when you save a change (because the underlying `inotify' library update when you save a change (because the underlying 'inotify' library
does not support it). Here are some that we know of: does not support it). Here are some that we know of:
* Certain editors: saving with `gedit', and perhaps any Gnome * Certain editors: saving with 'gedit', and perhaps any Gnome
application, won't be detected (#1617). Jetbrains IDEs, such as application, won't be detected (#1617). Jetbrains IDEs, such as
IDEA, also may not work (#911). IDEA, also may not work (#911).
* Certain unusual filesystems might not be supported. (All the usual * Certain unusual filesystems might not be supported. (All the usual
ones on unix, mac and windows are supported.) ones on unix, mac and windows are supported.)
In such cases, the workaround is to switch to the hledger-ui window In such cases, the workaround is to switch to the hledger-ui window
and press `g' each time you want it to reload. (Actually, see #1617 for and press 'g' each time you want it to reload. (Actually, see #1617 for
another workaround, and let us know if it works for you.) another workaround, and let us know if it works for you.)
If you leave `hledger-ui --watch' running for days, on certain If you leave 'hledger-ui --watch' running for days, on certain
platforms (?), perhaps with many transactions in your journal (?), platforms (?), perhaps with many transactions in your journal (?),
perhaps with large numbers of other files present (?), you may see it perhaps with large numbers of other files present (?), you may see it
gradually using more and more memory and CPU over time, as seen in gradually using more and more memory and CPU over time, as seen in 'top'
`top' or Activity Monitor or Task Manager. or Activity Monitor or Task Manager.
A workaround is to `q'uit and restart it, or to suspend it A workaround is to 'q'uit and restart it, or to suspend it ('CTRL-z')
(`CTRL-z') and restart it (`fg') if your shell supports that. and restart it ('fg') if your shell supports that.
 
File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: TIPS, Up: Top File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: TIPS, Up: Top
@ -563,28 +561,27 @@ File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: TIPS, Up: Top
6 ENVIRONMENT 6 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'. *LEDGER_FILE* The journal file path when not specified with '-f'.
Default: `~/.hledger.journal' (on windows, perhaps Default: '~/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal'). 'C:/Users/USER/.hledger.journal').
A typical value is `~/DIR/YYYY.journal', where DIR is a A typical value is '~/DIR/YYYY.journal', where DIR is a
version-controlled finance directory and YYYY is the current year. Or version-controlled finance directory and YYYY is the current year. Or
`~/DIR/current.journal', where current.journal is a symbolic link to '~/DIR/current.journal', where current.journal is a symbolic link to
YYYY.journal. YYYY.journal.
On Mac computers, you can set this and other environment variables On Mac computers, you can set this and other environment variables in
in a more thorough way that also affects applications started from the a more thorough way that also affects applications started from the GUI
GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a (say, an Emacs dock icon). Eg on MacOS Catalina I have a
`~/.MacOSX/environment.plist' file containing '~/.MacOSX/environment.plist' file containing
{ {
"LEDGER_FILE" : "~/finance/current.journal" "LEDGER_FILE" : "~/finance/current.journal"
} }
To see the effect you may need to `killall Dock', or reboot. To see the effect you may need to 'killall Dock', or reboot.
 
File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
@ -593,9 +590,9 @@ File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
******* *******
Reads data from one or more files in hledger journal, timeclock, Reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with `-f', or `$LEDGER_FILE', or timedot, 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').
 
File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
@ -603,18 +600,18 @@ File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
8 BUGS 8 BUGS
****** ******
The need to precede options with `--' when invoked from hledger is The need to precede options with '--' when invoked from hledger is
awkward. awkward.
`-f-' doesn't work (hledger-ui can't read from stdin). '-f-' doesn't work (hledger-ui can't read from stdin).
`-V' affects only the accounts screen. '-V' affects only the accounts screen.
When you press `g', the current and all previous screens are When you press 'g', the current and all previous screens are
regenerated, which may cause a noticeable pause with large files. Also regenerated, which may cause a noticeable pause with large files. Also
there is no visual indication that this is in progress. there is no visual indication that this is in progress.
`--watch' is not yet fully robust. It works well for normal usage, '--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 but 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. Symptoms times with an editor macro) can cause problems at least on OSX. Symptoms
include: unresponsive UI, periodic resetting of the cursor position, include: unresponsive UI, periodic resetting of the cursor position,
@ -623,39 +620,43 @@ and possibly a small but persistent build-up of CPU usage until the
program is restarted. program is restarted.
Also, if you are viewing files mounted from another machine, Also, if you are viewing files mounted from another machine,
`-w/--watch' requires that both machine clocks are roughly in step. '-w/--watch' requires that both machine clocks are roughly in step.
 
Tag Table: Tag Table:
Node: Top232 Node: Top221
Node: OPTIONS1644 Node: OPTIONS1657
Ref: #options1742 Ref: #options1755
Node: MOUSE6617 Node: MOUSE6637
Ref: #mouse6712 Ref: #mouse6732
Node: KEYS6996 Node: KEYS7014
Ref: #keys7089 Ref: #keys7107
Node: SCREENS11153 Node: SCREENS11193
Ref: #screens11251 Ref: #screens11291
Node: Accounts screen11341 Node: Accounts screen11381
Ref: #accounts-screen11469 Ref: #accounts-screen11509
Node: Register screen13796 Node: Register screen13848
Ref: #register-screen13951 Ref: #register-screen14003
Node: Transaction screen15933 Node: Transaction screen15987
Ref: #transaction-screen16091 Ref: #transaction-screen16145
Node: Error screen16958 Node: Error screen17015
Ref: #error-screen17080 Ref: #error-screen17137
Node: TIPS17322 Node: TIPS17381
Ref: #tips17421 Ref: #tips17480
Node: Watch mode17473 Node: Watch mode17532
Ref: #watch-mode17590 Ref: #watch-mode17649
Node: Watch mode limitations18337 Node: Watch mode limitations18399
Ref: #watch-mode-limitations18478 Ref: #watch-mode-limitations18540
Node: ENVIRONMENT19611 Node: ENVIRONMENT19676
Ref: #environment19722 Ref: #environment19787
Node: FILES20527 Node: FILES20594
Ref: #files20626 Ref: #files20693
Node: BUGS20839 Node: BUGS20906
Ref: #bugs20916 Ref: #bugs20983
 
End Tag Table End Tag Table

Local Variables:
coding: utf-8
End:

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

@ -5,7 +5,7 @@ HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1)
NAME NAME
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.24. tool. This manual is for hledger-ui 1.24.99.
SYNOPSIS SYNOPSIS
hledger-ui [OPTIONS] [QUERYARGS] hledger-ui [OPTIONS] [QUERYARGS]
@ -533,4 +533,4 @@ SEE ALSO
hledger-ui-1.24 December 2021 HLEDGER-UI(1) hledger-ui-1.24.99 December 2021 HLEDGER-UI(1)

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

@ -1,12 +1,12 @@
.TH "HLEDGER-WEB" "1" "December 2021" "hledger-web-1.24 " "hledger User Manuals" .TH "HLEDGER-WEB" "1" "December 2021" "hledger-web-1.24.99 " "hledger User Manuals"
.SH NAME .SH NAME
.PP .PP
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.24. This manual is for hledger-web 1.24.99.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger-web [OPTIONS]\f[R] \f[C]hledger-web [OPTIONS]\f[R]

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

@ -1,5 +1,4 @@
This is hledger-web/hledger-web.info, produced by makeinfo version 4.8 This is hledger-web.info, produced by makeinfo version 6.8 from stdin.
from stdin.
INFO-DIR-SECTION User Applications INFO-DIR-SECTION User Applications
START-INFO-DIR-ENTRY START-INFO-DIR-ENTRY
@ -7,39 +6,40 @@ START-INFO-DIR-ENTRY
END-INFO-DIR-ENTRY END-INFO-DIR-ENTRY
 
File: hledger-web.info, Node: Top, Up: (dir) File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-web(1) hledger-web(1)
************** **************
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.24. This manual is for hledger-web 1.24.99.
`hledger-web [OPTIONS]' 'hledger-web [OPTIONS]'
`hledger web -- [OPTIONS]' 'hledger web -- [OPTIONS]'
hledger is a reliable, cross-platform set of programs for tracking hledger is a reliable, cross-platform set of programs for tracking
money, time, or any other commodity, using double-entry accounting and a money, time, or any other commodity, using double-entry accounting and a
simple, editable file format. hledger is inspired by and largely simple, editable file format. hledger is inspired by and largely
compatible with ledger(1). compatible with ledger(1).
hledger-web is hledger's web interface. It starts a simple web hledger-web is hledger's web interface. It starts a simple web
application for browsing and adding transactions, and optionally opens application for browsing and adding transactions, and optionally opens
it in a web browser window if possible. It provides a more user-friendly it in a web browser window if possible. It provides a more
UI than the hledger CLI or hledger-ui interface, showing more at once user-friendly UI than the hledger CLI or hledger-ui interface, showing
(accounts, the current account register, balance charts) and allowing more at once (accounts, the current account register, balance charts)
history-aware data entry, interactive searching, and bookmarking. and allowing history-aware data entry, interactive searching, and
bookmarking.
hledger-web also lets you share a ledger with multiple users, or even hledger-web also lets you share a ledger with multiple users, or even
the public web. There is no access control, so if you need that you the public web. There is no access control, so if you need that you
should put it behind a suitable web proxy. As a small protection against should put it behind a suitable web proxy. As a small protection
data loss when running an unprotected instance, it writes a numbered against data loss when running an unprotected instance, it writes a
backup of the main journal file (only ?) on every edit. numbered backup of the main journal file (only ?) on every edit.
Like hledger, it reads data from one or more files in hledger Like hledger, it reads data from one or more files in hledger
journal, timeclock, timedot, or CSV format specified with `-f', or journal, timeclock, timedot, or CSV format specified with '-f', or
`$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps '$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal'). For more about this see hledger(1). 'C:/Users/USER/.hledger.journal'). For more about this see hledger(1).
* Menu: * Menu:
@ -59,177 +59,180 @@ File: hledger-web.info, Node: OPTIONS, Next: PERMISSIONS, Prev: Top, Up: Top
********* *********
Command-line options and arguments may be used to set an initial filter Command-line options and arguments may be used to set an initial filter
on the data. These filter options are not shown in the web UI, but it on the data. These filter options are not shown in the web UI, but it
will be applied in addition to any search query entered there. will be applied in addition to any search query entered there.
Note: if invoking hledger-web as a hledger subcommand, write `--' Note: if invoking hledger-web as a hledger subcommand, write '--'
before options, as shown in the synopsis above. before options, as shown in the synopsis above.
`--serve' '--serve'
serve and log requests, don't browse or auto-exit
serve and log requests, don't browse or auto-exit
'--serve-api'
`--serve-api'
like -serve, but serve only the JSON web API, without the like -serve, but serve only the JSON web API, without the
server-side web UI server-side web UI
'--host=IPADDR'
`--host=IPADDR'
listen on this IP address (default: 127.0.0.1) listen on this IP address (default: 127.0.0.1)
'--port=PORT'
`--port=PORT'
listen on this TCP port (default: 5000) listen on this TCP port (default: 5000)
'--socket=SOCKETFILE'
`--socket=SOCKETFILE'
use a unix domain socket file to listen for requests instead of a use a unix domain socket file to listen for requests instead of a
TCP socket. Implies `--serve'. It can only be used if the operating TCP socket. Implies '--serve'. It can only be used if the
system can provide this type of socket. operating system can provide this type of socket.
'--base-url=URL'
`--base-url=URL'
set the base url (default: http://IPADDR:PORT). You would change set the base url (default: http://IPADDR:PORT). You would change
this when sharing over the network, or integrating within a larger this when sharing over the network, or integrating within a larger
website. website.
'--file-url=URL'
`--file-url=URL' set the static files url (default: BASEURL/static). hledger-web
set the static files url (default: BASEURL/static). hledger-web
normally serves static files itself, but if you wanted to serve normally serves static files itself, but if you wanted to serve
them from another server for efficiency, you would set the url them from another server for efficiency, you would set the url with
with this. this.
'--capabilities=CAP[,CAP..]'
`--capabilities=CAP[,CAP..]'
enable the view, add, and/or manage capabilities (default: enable the view, add, and/or manage capabilities (default:
view,add) view,add)
'--capabilities-header=HTTPHEADER'
`--capabilities-header=HTTPHEADER'
read capabilities to enable from a HTTP header, like read capabilities to enable from a HTTP header, like
X-Sandstorm-Permissions (default: disabled) X-Sandstorm-Permissions (default: disabled)
'--test'
`--test' run hledger-web's tests and exit. hspec test runner args may
run hledger-web's tests and exit. hspec test runner args may
follow a -, eg: hledger-web -test - -help follow a -, eg: hledger-web -test - -help
hledger input options: hledger input options:
`-f FILE --file=FILE' '-f FILE --file=FILE'
use a different input file. For stdin, use - (default:
`$LEDGER_FILE' or `$HOME/.hledger.journal') use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal')
'--rules-file=RULESFILE'
`--rules-file=RULESFILE'
Conversion rules file to use when reading CSV (default: FILE.rules) Conversion rules file to use when reading CSV (default: FILE.rules)
'--separator=CHAR'
`--separator=CHAR'
Field separator to expect when reading CSV (default: ',') Field separator to expect when reading CSV (default: ',')
'--alias=OLD=NEW'
`--alias=OLD=NEW'
rename accounts named OLD to NEW rename accounts named OLD to NEW
'--anon'
`--anon'
anonymize accounts and payees anonymize accounts and payees
'--pivot FIELDNAME'
`--pivot FIELDNAME'
use some other field or tag for the account name use some other field or tag for the account name
'-I --ignore-assertions'
`-I --ignore-assertions'
disable balance assertion checks (note: does not disable balance disable balance assertion checks (note: does not disable balance
assignments) assignments)
'-s --strict'
`-s --strict'
do extra error checking (check that all posted accounts are do extra error checking (check that all posted accounts are
declared) declared)
hledger reporting options: hledger reporting options:
`-b --begin=DATE' '-b --begin=DATE'
include postings/txns on or after this date (will be adjusted to include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval) preceding subperiod start when using a report interval)
'-e --end=DATE'
`-e --end=DATE'
include postings/txns before this date (will be adjusted to include postings/txns before this date (will be adjusted to
following subperiod end when using a report interval) following subperiod end when using a report interval)
'-D --daily'
`-D --daily'
multiperiod/multicolumn report by day multiperiod/multicolumn report by day
'-W --weekly'
`-W --weekly'
multiperiod/multicolumn report by week multiperiod/multicolumn report by week
'-M --monthly'
`-M --monthly'
multiperiod/multicolumn report by month multiperiod/multicolumn report by month
'-Q --quarterly'
`-Q --quarterly'
multiperiod/multicolumn report by quarter multiperiod/multicolumn report by quarter
'-Y --yearly'
`-Y --yearly'
multiperiod/multicolumn report by year multiperiod/multicolumn report by year
'-p --period=PERIODEXP'
`-p --period=PERIODEXP'
set start date, end date, and/or reporting interval all at once set start date, end date, and/or reporting interval all at once
using period expressions syntax using period expressions syntax
'--date2'
`--date2'
match the secondary date instead (see command help for other match the secondary date instead (see command help for other
effects) effects)
'--today=DATE'
`--today=DATE'
override today's date (affects relative smart dates, for override today's date (affects relative smart dates, for
tests/examples) tests/examples)
'-U --unmarked'
`-U --unmarked'
include only unmarked postings/txns (can combine with -P or -C) include only unmarked postings/txns (can combine with -P or -C)
'-P --pending'
`-P --pending'
include only pending postings/txns include only pending postings/txns
'-C --cleared'
`-C --cleared'
include only cleared postings/txns include only cleared postings/txns
'-R --real'
`-R --real'
include only non-virtual postings include only non-virtual postings
'-NUM --depth=NUM'
`-NUM --depth=NUM'
hide/aggregate accounts or postings more than NUM levels deep hide/aggregate accounts or postings more than NUM levels deep
'-E --empty'
`-E --empty'
show items with zero amount, normally hidden (and vice-versa in show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web) hledger-ui/hledger-web)
'-B --cost'
`-B --cost'
convert amounts to their cost/selling amount at transaction time convert amounts to their cost/selling amount at transaction time
'-V --market'
`-V --market'
convert amounts to their market value in default valuation convert amounts to their market value in default valuation
commodities commodities
'-X --exchange=COMM'
`-X --exchange=COMM'
convert amounts to their market value in commodity COMM convert amounts to their market value in commodity COMM
'--value'
`--value'
convert amounts to cost or market value, more flexibly than convert amounts to cost or market value, more flexibly than
-B/-V/-X -B/-V/-X
'--infer-market-prices'
`--infer-market-prices'
use transaction prices (recorded with @ or @@) as additional market use transaction prices (recorded with @ or @@) as additional market
prices, as if they were P directives prices, as if they were P directives
'--auto'
`--auto'
apply automated posting rules to modify transactions. apply automated posting rules to modify transactions.
'--forecast'
`--forecast'
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.
'--commodity-style'
`--commodity-style'
Override the commodity style in the output for the specified Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'. commodity. For example 'EUR1.000,00'.
'--color=WHEN (or --colour=WHEN)'
`--color=WHEN (or --colour=WHEN)'
Should color-supporting commands use ANSI color codes in text Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a output. 'auto' (default): whenever stdout seems to be a
color-supporting terminal. 'always' or 'yes': always, useful eg color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this. NO_COLOR environment variable overrides this.
'--pretty[=WHEN]'
`--pretty[=WHEN]' Show prettier output, e.g. using unicode box-drawing characters.
Show prettier output, e.g. using unicode box-drawing characters.
Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', 'never' Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', 'never'
also work). If you provide an argument you must use '=', e.g. also work). If you provide an argument you must use '=', e.g.
'-pretty=yes'. '-pretty=yes'.
@ -241,62 +244,62 @@ the last one takes precedence.
hledger help options: hledger help options:
`-h --help' '-h --help'
show general or COMMAND help show general or COMMAND help
'--man'
`--man'
show general or COMMAND user manual with man show general or COMMAND user manual with man
'--info'
`--info'
show general or COMMAND user manual with info show general or COMMAND user manual with info
'--version'
`--version'
show general or ADDONCMD version show general or ADDONCMD version
'--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 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.)
By default, hledger-web starts the web app in "transient mode" and By default, hledger-web starts the web app in "transient mode" and
also opens it in your default web browser if possible. In this mode the also opens it in your default web browser if possible. In this mode the
web app will keep running for as long as you have it open in a browser web app will keep running for as long as you have it open in a browser
window, and will exit after two minutes of inactivity (no requests and window, and will exit after two minutes of inactivity (no requests and
no browser windows viewing it). With `--serve', it just runs the web no browser windows viewing it). With '--serve', it just runs the web
app without exiting, and logs requests to the console. With app without exiting, and logs requests to the console. With
`--serve-api', only the JSON web api (see below) is served, with the '--serve-api', only the JSON web api (see below) is served, with the
usual HTML server-side web UI disabled. usual HTML server-side web UI disabled.
By default the server listens on IP address 127.0.0.1, accessible By default the server listens on IP address 127.0.0.1, accessible
only to local requests. You can use `--host' to change this, eg `--host only to local requests. You can use '--host' to change this, eg '--host
0.0.0.0' to listen on all configured addresses. 0.0.0.0' to listen on all configured addresses.
Similarly, use `--port' to set a TCP port other than 5000, eg if you Similarly, use '--port' to set a TCP port other than 5000, eg if you
are running multiple hledger-web instances. are running multiple hledger-web instances.
Both of these options are ignored when `--socket' is used. In this Both of these options are ignored when '--socket' is used. In this
case, it creates an `AF_UNIX' socket file at the supplied path and uses case, it creates an 'AF_UNIX' socket file at the supplied path and uses
that for communication. This is an alternative way of running multiple that for communication. This is an alternative way of running multiple
hledger-web instances behind a reverse proxy that handles hledger-web instances behind a reverse proxy that handles authentication
authentication for different users. The path can be derived in a for different users. The path can be derived in a predictable way, eg
predictable way, eg by using the username within the path. As an by using the username within the path. As an example, 'nginx' as
example, `nginx' as reverse proxy can use the variable `$remote_user' reverse proxy can use the variable '$remote_user' to derive a path from
to derive a path from the username used in a HTTP basic authentication. the username used in a HTTP basic authentication. The following
The following `proxy_pass' directive allows access to all `hledger-web' 'proxy_pass' directive allows access to all 'hledger-web' instances that
instances that created a socket in `/tmp/hledger/': created a socket in '/tmp/hledger/':
proxy_pass http://unix:/tmp/hledger/${remote_user}.socket; proxy_pass http://unix:/tmp/hledger/${remote_user}.socket;
You can use `--base-url' to change the protocol, hostname, port and You can use '--base-url' to change the protocol, hostname, port and
path that appear in hyperlinks, useful eg for integrating hledger-web path that appear in hyperlinks, useful eg for integrating hledger-web
within a larger website. The default is `http://HOST:PORT/' using the within a larger website. The default is 'http://HOST:PORT/' using the
server's configured host address and TCP port (or `http://HOST' if PORT server's configured host address and TCP port (or 'http://HOST' if PORT
is 80). is 80).
With `--file-url' you can set a different base url for static files, With '--file-url' you can set a different base url for static files,
eg for better caching or cookie-less serving on high performance eg for better caching or cookie-less serving on high performance
websites. websites.
@ -311,32 +314,28 @@ journal and to add new transactions, but not to change existing data.
You can restrict who can reach it by You can restrict who can reach it by
* setting the IP address it listens on (see `--host' above). By * setting the IP address it listens on (see '--host' above). By
default it listens on 127.0.0.1, accessible to all users on the default it listens on 127.0.0.1, accessible to all users on the
local machine. local machine.
* putting it behind an authenticating proxy, using eg apache or nginx * putting it behind an authenticating proxy, using eg apache or nginx
* custom firewall rules * custom firewall rules
You can restrict what the users who reach it can do, by You can restrict what the users who reach it can do, by
* using the `--capabilities=CAP[,CAP..]' flag when you start it, * using the '--capabilities=CAP[,CAP..]' flag when you start it,
enabling one or more of the following capabilities. The default enabling one or more of the following capabilities. The default
value is `view,add': value is 'view,add':
* `view' - allows viewing the journal file and all included * 'view' - allows viewing the journal file and all included
files files
* 'add' - allows adding new transactions to the main journal
* `add' - allows adding new transactions to the main journal
file file
* 'manage' - allows editing, uploading or downloading the main
* `manage' - allows editing, uploading or downloading the main
or included files or included files
* using the `--capabilities-header=HTTPHEADER' flag to specify a HTTP * using the '--capabilities-header=HTTPHEADER' flag to specify a HTTP
header from which it will read capabilities to enable. hledger-web header from which it will read capabilities to enable. hledger-web
on Sandstorm uses the X-Sandstorm-Permissions header to integrate on Sandstorm uses the X-Sandstorm-Permissions header to integrate
with Sandstorm's permissions. This is disabled by default. with Sandstorm's permissions. This is disabled by default.
 
File: hledger-web.info, Node: EDITING UPLOADING DOWNLOADING, Next: RELOADING, Prev: PERMISSIONS, Up: Top File: hledger-web.info, Node: EDITING UPLOADING DOWNLOADING, Next: RELOADING, Prev: PERMISSIONS, Up: Top
@ -344,8 +343,8 @@ File: hledger-web.info, Node: EDITING UPLOADING DOWNLOADING, Next: RELOADING,
3 EDITING, UPLOADING, DOWNLOADING 3 EDITING, UPLOADING, DOWNLOADING
********************************* *********************************
If you enable the `manage' capability mentioned above, you'll see a new If you enable the 'manage' capability mentioned above, you'll see a new
"spanner" button to the right of the search form. Clicking this will "spanner" button to the right of the search form. Clicking this will
let you edit, upload, or download the journal file or any files it let you edit, upload, or download the journal file or any files it
includes. includes.
@ -354,13 +353,13 @@ visitor) can alter or wipe the data files.
Normally whenever a file is changed in this way, hledger-web saves a Normally whenever a file is changed in this way, hledger-web saves a
numbered backup (assuming file permissions allow it, the disk is not numbered backup (assuming file permissions allow it, the disk is not
full, etc.) hledger-web is not aware of version control systems, full, etc.) hledger-web is not aware of version control systems,
currently; if you use one, you'll have to arrange to commit the changes currently; if you use one, you'll have to arrange to commit the changes
yourself (eg with a cron job or a file watcher like entr). yourself (eg with a cron job or a file watcher like entr).
Changes which would leave the journal file(s) unparseable or Changes which would leave the journal file(s) unparseable or
non-valid (eg with failing balance assertions) are prevented. non-valid (eg with failing balance assertions) are prevented.
(Probably. This needs re-testing.) (Probably. This needs re-testing.)
 
File: hledger-web.info, Node: RELOADING, Next: JSON API, Prev: EDITING UPLOADING DOWNLOADING, Up: Top File: hledger-web.info, Node: RELOADING, Next: JSON API, Prev: EDITING UPLOADING DOWNLOADING, Up: Top
@ -370,7 +369,7 @@ File: hledger-web.info, Node: RELOADING, Next: JSON API, Prev: EDITING UPLOAD
hledger-web detects changes made to the files by other means (eg if you hledger-web detects changes made to the files by other means (eg if you
edit it directly, outside of hledger-web), and it will show the new data edit it directly, outside of hledger-web), and it will show the new data
when you reload the page or navigate to a new page. If a change makes a when you reload the page or navigate to a new page. If a change makes a
file unparseable, hledger-web will display an error message until the file unparseable, hledger-web will display an error message until the
file has been fixed. file has been fixed.
@ -384,16 +383,14 @@ File: hledger-web.info, Node: JSON API, Next: ENVIRONMENT, Prev: RELOADING,
********** **********
In addition to the web UI, hledger-web also serves a JSON API that can In addition to the web UI, hledger-web also serves a JSON API that can
be used to get data or add new transactions. If you want the JSON API be used to get data or add new transactions. If you want the JSON API
only, you can use the `--serve-api' flag. Eg: only, you can use the '--serve-api' flag. Eg:
$ hledger-web -f examples/sample.journal --serve-api $ hledger-web -f examples/sample.journal --serve-api
... ...
You can get JSON data from these routes: You can get JSON data from these routes:
/version /version
/accountnames /accountnames
/transactions /transactions
@ -406,7 +403,6 @@ $ hledger-web -f examples/sample.journal --serve-api
command). (hledger-web's JSON does not include newlines, here we use command). (hledger-web's JSON does not include newlines, here we use
python to prettify it): python to prettify it):
$ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool
[ [
"assets", "assets",
@ -426,7 +422,6 @@ $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool
Or all transactions: Or all transactions:
$ curl -s http://127.0.0.1:5000/transactions | python -m json.tool $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool
[ [
{ {
@ -448,25 +443,24 @@ $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool
Most of the JSON corresponds to hledger's data types; for details of Most of the JSON corresponds to hledger's data types; for details of
what the fields mean, see the Hledger.Data.Json haddock docs and click what the fields mean, see the Hledger.Data.Json haddock docs and click
on the various data types, eg Transaction. And for a higher level on the various data types, eg Transaction. And for a higher level
understanding, see the journal manual. understanding, see the journal manual.
In some cases there is outer JSON corresponding to a "Report" type. In some cases there is outer JSON corresponding to a "Report" type.
To understand that, go to the Hledger.Web.Handler.MiscR haddock and To understand that, go to the Hledger.Web.Handler.MiscR haddock and look
look at the source for the appropriate handler to see what it returns. at the source for the appropriate handler to see what it returns. Eg
Eg for `/accounttransactions' it's getAccounttransactionsR, returning a for '/accounttransactions' it's getAccounttransactionsR, returning a
"`accountTransactionsReport ...'". Looking up the haddock for that we "'accountTransactionsReport ...'". Looking up the haddock for that we
can see that /accounttransactions returns an AccountTransactionsReport, can see that /accounttransactions returns an AccountTransactionsReport,
which consists of a report title and a list of which consists of a report title and a list of
AccountTransactionsReportItem (etc). AccountTransactionsReportItem (etc).
You can add a new transaction to the journal with a PUT request to You can add a new transaction to the journal with a PUT request to
`/add', if hledger-web was started with the `add' capability (enabled '/add', if hledger-web was started with the 'add' capability (enabled by
by default). The payload must be the full, exact JSON representation of default). The payload must be the full, exact JSON representation of a
a hledger transaction (partial data won't do). You can get sample JSON hledger transaction (partial data won't do). You can get sample JSON
from hledger-web's `/transactions' or `/accounttransactions', or you from hledger-web's '/transactions' or '/accounttransactions', or you can
can export it with hledger-lib, eg like so: export it with hledger-lib, eg like so:
.../hledger$ stack ghci hledger-lib .../hledger$ stack ghci hledger-lib
>>> writeJsonFile "txn.json" (head $ jtxns samplejournal) >>> writeJsonFile "txn.json" (head $ jtxns samplejournal)
@ -475,7 +469,6 @@ can export it with hledger-lib, eg like so:
Here's how it looks as of hledger-1.17 (remember, this JSON Here's how it looks as of hledger-1.17 (remember, this JSON
corresponds to hledger's Transaction and related data types): corresponds to hledger's Transaction and related data types):
{ {
"tcomment": "", "tcomment": "",
"tpostings": [ "tpostings": [
@ -562,10 +555,9 @@ corresponds to hledger's Transaction and related data types):
"tstatus": "Unmarked" "tstatus": "Unmarked"
} }
And here's how to test adding it with curl. This should add a new And here's how to test adding it with curl. This should add a new
entry to your journal: entry to your journal:
$ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json $ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json
 
@ -574,26 +566,25 @@ File: hledger-web.info, Node: ENVIRONMENT, Next: FILES, Prev: JSON API, Up:
6 ENVIRONMENT 6 ENVIRONMENT
************* *************
*LEDGER_FILE* The journal file path when not specified with `-f'. *LEDGER_FILE* The journal file path when not specified with '-f'.
Default: `~/.hledger.journal' (on windows, perhaps Default: '~/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal'). 'C:/Users/USER/.hledger.journal').
A typical value is `~/DIR/YYYY.journal', where DIR is a A typical value is '~/DIR/YYYY.journal', where DIR is a
version-controlled finance directory and YYYY is the current year. Or version-controlled finance directory and YYYY is the current year. Or
`~/DIR/current.journal', where current.journal is a symbolic link to '~/DIR/current.journal', where current.journal is a symbolic link to
YYYY.journal. YYYY.journal.
On Mac computers, you can set this and other environment variables On Mac computers, you can set this and other environment variables in
in a more thorough way that also affects applications started from the a more thorough way that also affects applications started from the GUI
GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a (say, an Emacs dock icon). Eg on MacOS Catalina I have a
`~/.MacOSX/environment.plist' file containing '~/.MacOSX/environment.plist' file containing
{ {
"LEDGER_FILE" : "~/finance/current.journal" "LEDGER_FILE" : "~/finance/current.journal"
} }
To see the effect you may need to `killall Dock', or reboot. To see the effect you may need to 'killall Dock', or reboot.
 
File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
@ -602,9 +593,9 @@ File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
******* *******
Reads data from one or more files in hledger journal, timeclock, Reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with `-f', or `$LEDGER_FILE', or timedot, 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').
 
File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top
@ -612,10 +603,10 @@ File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top
8 BUGS 8 BUGS
****** ******
The need to precede options with `--' when invoked from hledger is The need to precede options with '--' when invoked from hledger is
awkward. awkward.
`-f-' doesn't work (hledger-web can't read from stdin). '-f-' doesn't work (hledger-web can't read from stdin).
Query arguments and some hledger options are ignored. Query arguments and some hledger options are ignored.
@ -623,25 +614,29 @@ awkward.
Does not work well on small screens. Does not work well on small screens.
 
Tag Table: Tag Table:
Node: Top235 Node: Top223
Node: OPTIONS1875 Node: OPTIONS1889
Ref: #options1980 Ref: #options1994
Node: PERMISSIONS9870 Node: PERMISSIONS9905
Ref: #permissions10009 Ref: #permissions10044
Node: EDITING UPLOADING DOWNLOADING11221 Node: EDITING UPLOADING DOWNLOADING11256
Ref: #editing-uploading-downloading11402 Ref: #editing-uploading-downloading11437
Node: RELOADING12233 Node: RELOADING12271
Ref: #reloading12367 Ref: #reloading12405
Node: JSON API12799 Node: JSON API12838
Ref: #json-api12913 Ref: #json-api12952
Node: ENVIRONMENT18402 Node: ENVIRONMENT18442
Ref: #environment18518 Ref: #environment18558
Node: FILES19250 Node: FILES19291
Ref: #files19350 Ref: #files19391
Node: BUGS19563 Node: BUGS19604
Ref: #bugs19641 Ref: #bugs19682
 
End Tag Table End Tag Table

Local Variables:
coding: utf-8
End:

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

@ -5,7 +5,7 @@ HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
NAME NAME
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.24. This manual is for hledger-web 1.24.99.
SYNOPSIS SYNOPSIS
hledger-web [OPTIONS] hledger-web [OPTIONS]
@ -570,4 +570,4 @@ SEE ALSO
hledger-web-1.24 December 2021 HLEDGER-WEB(1) hledger-web-1.24.99 December 2021 HLEDGER-WEB(1)

256
hledger/hledger.1
View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "HLEDGER" "1" "December 2021" "hledger-1.24 " "hledger User Manuals" .TH "HLEDGER" "1" "December 2021" "hledger-1.24.99 " "hledger User Manuals"
@ -9,7 +9,7 @@
This is the command-line interface (CLI) for the hledger accounting This is the command-line interface (CLI) for the hledger accounting
tool. tool.
Here we also describe hledger\[aq]s concepts and file formats. Here we also describe hledger\[aq]s concepts and file formats.
This manual is for hledger 1.24. This manual is for hledger 1.24.99.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger\f[R] \f[C]hledger\f[R]
@ -2371,41 +2371,161 @@ characters will (or will not) be used; - otherwise, unicode characters
will not be used. will not be used.
.SS Output format .SS Output format
.PP .PP
Some commands (print, register, the balance commands) offer a choice of Some commands offer additional output formats, other than the usual
output format. plain text terminal output.
In addition to the usual plain text format (\f[C]txt\f[R]), there are Here are those commands and the formats currently supported:
CSV (\f[C]csv\f[R]), HTML (\f[C]html\f[R]), JSON (\f[C]json\f[R]) and
SQL (\f[C]sql\f[R]).
This is controlled by the \f[C]-O/--output-format\f[R] option:
.IP
.nf
\f[C]
$ hledger print -O csv
\f[R]
.fi
.PP .PP
or, by a file extension specified with \f[C]-o/--output-file\f[R]: .TS
.IP tab(@);
.nf l l l l l l.
\f[C] T{
$ hledger balancesheet -o foo.html # write HTML to foo.html T}@T{
\f[R] txt
.fi T}@T{
.PP csv
The \f[C]-O\f[R] option can be used to override the file extension if T}@T{
needed: json
.IP T}@T{
.nf html
\f[C] T}@T{
$ hledger balancesheet -o foo.txt -O html # write HTML to foo.txt sql
\f[R] T}
.fi _
.PP T{
Some notes about JSON output: aregister
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
T}@T{
T}
T{
balance \f[I][1]\f[R]
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
Y \f[I][2]\f[R]
T}@T{
T}
T{
balancesheet \f[I][1]\f[R]
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
T}
T{
balancesheetequity \f[I][1]\f[R]
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
T}
T{
cashflow \f[I][1]\f[R]
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
T}
T{
incomestatement \f[I][1]\f[R]
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
T}
T{
print
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
T}@T{
Y
T}
T{
register
T}@T{
Y
T}@T{
Y
T}@T{
Y
T}@T{
T}@T{
T}
.TE
.IP \[bu] 2 .IP \[bu] 2
This feature is marked experimental, and not yet much used; you should \f[I][1] Balance commands also have a multi-commodity
expect our JSON to evolve. \f[CI]--layout\f[I] option which affects some output formats.\f[R]
Real-world feedback is welcome. .IP \[bu] 2
\f[I][2] Except with no report interval, or with the \f[CI]--budget\f[I]
flag.\f[R]
.PP
The output format is selected by the \f[C]-O/--output-format=FMT\f[R]
option:
.IP
.nf
\f[C]
$ hledger print -O csv # print CSV on stdout
\f[R]
.fi
.PP
or by the filename extension of an output file specified with the
\f[C]-o/--output-file=FILE.FMT\f[R] option:
.IP
.nf
\f[C]
$ hledger balancesheet -o foo.csv # write CSV to foo.csv
\f[R]
.fi
.PP
The \f[C]-O\f[R] option can be combined with \f[C]-o\f[R] to override
the file extension, if needed:
.IP
.nf
\f[C]
$ hledger balancesheet -o foo.txt -O csv # write CSV to foo.txt
\f[R]
.fi
.SS HTML output
.IP \[bu] 2
HTML output can be styled by an optional \f[C]hledger.css\f[R] file in
the same directory.
.SS JSON output
.IP \[bu] 2
Not yet much used; real-world feedback is welcome.
.IP \[bu] 2 .IP \[bu] 2
Our JSON is rather large and verbose, as it is quite a faithful Our JSON is rather large and verbose, as it is quite a faithful
representation of hledger\[aq]s internal data types. representation of hledger\[aq]s internal data types.
@ -2424,11 +2544,9 @@ your control.
We hope this approach will not cause problems in practice; if you find We hope this approach will not cause problems in practice; if you find
otherwise, please let us know. otherwise, please let us know.
(Cf #1195) (Cf #1195)
.PP .SS SQL output
Notes about SQL output:
.IP \[bu] 2 .IP \[bu] 2
SQL output is also marked experimental, and much like JSON could use Not yet much used; real-world feedback is welcome.
real-world feedback.
.IP \[bu] 2 .IP \[bu] 2
SQL output is expected to work with sqlite, MySQL and PostgreSQL SQL output is expected to work with sqlite, MySQL and PostgreSQL
.IP \[bu] 2 .IP \[bu] 2
@ -3125,8 +3243,14 @@ the specified width
.IP \[bu] 2 .IP \[bu] 2
\f[C]--layout=tall\f[R]: each commodity is displayed on a separate line \f[C]--layout=tall\f[R]: each commodity is displayed on a separate line
.IP \[bu] 2 .IP \[bu] 2
\f[C]--layout=bare\f[R]: commodity symbols are displayed in a separate \f[C]--layout=bare\f[R]: amounts are displayed as bare numbers, with
column, and amounts are displayed as bare numbers commodity symbols in a separate column
.PP
Examples:
.IP \[bu] 2
Wide layout.
With many commodities, reports can be very wide:
.RS 2
.IP .IP
.nf .nf
\f[C] \f[C]
@ -3138,7 +3262,16 @@ Balance changes in 2012-01-01..2014-12-31:
Assets:US:ETrade || 10.00 ITOT, 337.18 USD, 12.00 VEA, 106.00 VHT 70.00 GLD, 18.00 ITOT, -98.12 USD, 10.00 VEA, 18.00 VHT -11.00 ITOT, 4881.44 USD, 14.00 VEA, 170.00 VHT 70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT Assets:US:ETrade || 10.00 ITOT, 337.18 USD, 12.00 VEA, 106.00 VHT 70.00 GLD, 18.00 ITOT, -98.12 USD, 10.00 VEA, 18.00 VHT -11.00 ITOT, 4881.44 USD, 14.00 VEA, 170.00 VHT 70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT
------------------++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ------------------++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|| 10.00 ITOT, 337.18 USD, 12.00 VEA, 106.00 VHT 70.00 GLD, 18.00 ITOT, -98.12 USD, 10.00 VEA, 18.00 VHT -11.00 ITOT, 4881.44 USD, 14.00 VEA, 170.00 VHT 70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT || 10.00 ITOT, 337.18 USD, 12.00 VEA, 106.00 VHT 70.00 GLD, 18.00 ITOT, -98.12 USD, 10.00 VEA, 18.00 VHT -11.00 ITOT, 4881.44 USD, 14.00 VEA, 170.00 VHT 70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT
\f[R]
.fi
.RE
.IP \[bu] 2
Limited wide layout.
A width limit reduces the width, but some commodities will be hidden:
.RS 2
.IP
.nf
\f[C]
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide,32 $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide,32
Balance changes in 2012-01-01..2014-12-31: Balance changes in 2012-01-01..2014-12-31:
@ -3147,7 +3280,17 @@ Balance changes in 2012-01-01..2014-12-31:
Assets:US:ETrade || 10.00 ITOT, 337.18 USD, 2 more.. 70.00 GLD, 18.00 ITOT, 3 more.. -11.00 ITOT, 3 more.. 70.00 GLD, 17.00 ITOT, 3 more.. Assets:US:ETrade || 10.00 ITOT, 337.18 USD, 2 more.. 70.00 GLD, 18.00 ITOT, 3 more.. -11.00 ITOT, 3 more.. 70.00 GLD, 17.00 ITOT, 3 more..
------------------++--------------------------------------------------------------------------------------------------------------------------- ------------------++---------------------------------------------------------------------------------------------------------------------------
|| 10.00 ITOT, 337.18 USD, 2 more.. 70.00 GLD, 18.00 ITOT, 3 more.. -11.00 ITOT, 3 more.. 70.00 GLD, 17.00 ITOT, 3 more.. || 10.00 ITOT, 337.18 USD, 2 more.. 70.00 GLD, 18.00 ITOT, 3 more.. -11.00 ITOT, 3 more.. 70.00 GLD, 17.00 ITOT, 3 more..
\f[R]
.fi
.RE
.IP \[bu] 2
Tall layout.
Each commodity gets a new line (may be different in each column), and
account names are repeated:
.RS 2
.IP
.nf
\f[C]
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=tall $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=tall
Balance changes in 2012-01-01..2014-12-31: Balance changes in 2012-01-01..2014-12-31:
@ -3164,7 +3307,17 @@ Balance changes in 2012-01-01..2014-12-31:
|| 12.00 VEA -98.12 USD 14.00 VEA 5120.50 USD || 12.00 VEA -98.12 USD 14.00 VEA 5120.50 USD
|| 106.00 VHT 10.00 VEA 170.00 VHT 36.00 VEA || 106.00 VHT 10.00 VEA 170.00 VHT 36.00 VEA
|| 18.00 VHT 294.00 VHT || 18.00 VHT 294.00 VHT
\f[R]
.fi
.RE
.IP \[bu] 2
Bare layout.
Commodity symbols are kept in one column, each commodity gets its own
report row, account names are repeated:
.RS 2
.IP
.nf
\f[C]
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=bare $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=bare
Balance changes in 2012-01-01..2014-12-31: Balance changes in 2012-01-01..2014-12-31:
@ -3183,18 +3336,14 @@ Balance changes in 2012-01-01..2014-12-31:
|| VHT 106.00 18.00 170.00 294.00 || VHT 106.00 18.00 170.00 294.00
\f[R] \f[R]
.fi .fi
.PP .RE
The option \f[C]--layout=bare\f[R] also affects CSV output, which is .IP \[bu] 2
useful for producing data that is easier to consume, eg when making Bare layout also affects CSV output, which is useful for producing data
charts: that is easier to consume, eg when making charts:
.RS 2
.IP .IP
.nf .nf
\f[C] \f[C]
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv
\[dq]account\[dq],\[dq]balance\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT\[dq]
\[dq]total\[dq],\[dq]70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT\[dq]
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=bare $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=bare
\[dq]account\[dq],\[dq]commodity\[dq],\[dq]balance\[dq] \[dq]account\[dq],\[dq]commodity\[dq],\[dq]balance\[dq]
\[dq]Assets:US:ETrade\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq]
@ -3209,6 +3358,7 @@ $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=
\[dq]total\[dq],\[dq]VHT\[dq],\[dq]294.00\[dq] \[dq]total\[dq],\[dq]VHT\[dq],\[dq]294.00\[dq]
\f[R] \f[R]
.fi .fi
.RE
.SS Sorting by amount .SS Sorting by amount
.PP .PP
With \f[C]-S/--sort-amount\f[R], accounts with the largest (most With \f[C]-S/--sort-amount\f[R], accounts with the largest (most

5486
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

430
hledger/hledger.txt
View File

@ -6,7 +6,7 @@ HLEDGER(1) hledger User Manuals HLEDGER(1)
NAME NAME
This is the command-line interface (CLI) for the hledger accounting This is the command-line interface (CLI) for the hledger accounting
tool. Here we also describe hledger's concepts and file formats. This tool. Here we also describe hledger's concepts and file formats. This
manual is for hledger 1.24. manual is for hledger 1.24.99.
SYNOPSIS SYNOPSIS
hledger hledger
@ -1549,25 +1549,54 @@ OUTPUT
unicode characters will not be used. unicode characters will not be used.
Output format Output format
Some commands (print, register, the balance commands) offer a choice of Some commands offer additional output formats, other than the usual
output format. In addition to the usual plain text format (txt), there plain text terminal output. Here are those commands and the formats
are CSV (csv), HTML (html), JSON (json) and SQL (sql). This is con- currently supported:
trolled by the -O/--output-format option:
$ hledger print -O csv
or, by a file extension specified with -o/--output-file: txt csv json html sql
---------------------------------------------
aregister Y Y Y
balance [1] Y Y Y Y [2]
bal- Y Y Y Y
ancesheet
[1]
bal- Y Y Y Y
ancesheete-
quity [1]
cashflow Y Y Y Y
[1]
incomes- Y Y Y Y
tatement
[1]
print Y Y Y Y
register Y Y Y
$ hledger balancesheet -o foo.html # write HTML to foo.html o [1] Balance commands also have a multi-commodity --layout option
which affects some output formats.
The -O option can be used to override the file extension if needed: o [2] Except with no report interval, or with the --budget flag.
$ hledger balancesheet -o foo.txt -O html # write HTML to foo.txt The output format is selected by the -O/--output-format=FMT option:
Some notes about JSON output: $ hledger print -O csv # print CSV on stdout
o This feature is marked experimental, and not yet much used; you or by the filename extension of an output file specified with the
should expect our JSON to evolve. Real-world feedback is welcome. -o/--output-file=FILE.FMT option:
$ hledger balancesheet -o foo.csv # write CSV to foo.csv
The -O option can be combined with -o to override the file extension,
if needed:
$ hledger balancesheet -o foo.txt -O csv # write CSV to foo.txt
HTML output
o HTML output can be styled by an optional hledger.css file in the same
directory.
JSON output
o Not yet much used; real-world feedback is welcome.
o Our JSON is rather large and verbose, as it is quite a faithful rep- o Our JSON is rather large and verbose, as it is quite a faithful rep-
resentation of hledger's internal data types. To understand the resentation of hledger's internal data types. To understand the
@ -1584,40 +1613,38 @@ OUTPUT
hope this approach will not cause problems in practice; if you find hope this approach will not cause problems in practice; if you find
otherwise, please let us know. (Cf #1195) otherwise, please let us know. (Cf #1195)
Notes about SQL output: SQL output
o Not yet much used; real-world feedback is welcome.
o SQL output is also marked experimental, and much like JSON could use
real-world feedback.
o SQL output is expected to work with sqlite, MySQL and PostgreSQL o SQL output is expected to work with sqlite, MySQL and PostgreSQL
o SQL output is structured with the expectations that statements will o SQL output is structured with the expectations that statements will
be executed in the empty database. If you already have tables cre- be executed in the empty database. If you already have tables cre-
ated via SQL output of hledger, you would probably want to either ated via SQL output of hledger, you would probably want to either
clear tables of existing data (via delete or truncate SQL statements) clear tables of existing data (via delete or truncate SQL statements)
or drop tables completely as otherwise your postings will be duped. or drop tables completely as otherwise your postings will be duped.
Commodity styles Commodity styles
The display style of a commodity/currency is inferred according to the The display style of a commodity/currency is inferred according to the
rules described in Commodity display style. The inferred display style rules described in Commodity display style. The inferred display style
can be overridden by an optional -c/--commodity-style option (Excep- can be overridden by an optional -c/--commodity-style option (Excep-
tions: as is the case for inferred styles, price amounts, and all tions: as is the case for inferred styles, price amounts, and all
amounts displayed by the print command, will be displayed with all of amounts displayed by the print command, will be displayed with all of
their decimal digits visible, regardless of the specified precision). their decimal digits visible, regardless of the specified precision).
For example, the following will override the display style for dollars. For example, the following will override the display style for dollars.
$ hledger print -c '$1.000,0' $ hledger print -c '$1.000,0'
The format specification of the style is identical to the commodity The format specification of the style is identical to the commodity
display style specification for the commodity directive. The command display style specification for the commodity directive. The command
line option can be supplied repeatedly to override the display style line option can be supplied repeatedly to override the display style
for multiple commodity/currency symbols. for multiple commodity/currency symbols.
COMMANDS COMMANDS
hledger provides a number of commands for producing reports and manag- hledger provides a number of commands for producing reports and manag-
ing your data. Run hledger with no arguments to list the commands ing your data. Run hledger with no arguments to list the commands
available, and hledger CMD to run a command. CMD can be the full com- available, and hledger CMD to run a command. CMD can be the full com-
mand name, or its standard abbreviation shown in the commands list, or mand name, or its standard abbreviation shown in the commands list, or
any unambiguous prefix of the name. Eg: hledger bal. any unambiguous prefix of the name. Eg: hledger bal.
Here are the built-in commands, with the most often-used in bold: Here are the built-in commands, with the most often-used in bold:
@ -1661,7 +1688,7 @@ COMMANDS
o activity - show postings-per-interval bar charts o activity - show postings-per-interval bar charts
o balance (bal) - show balance changes/end balances/budgets in any o balance (bal) - show balance changes/end balances/budgets in any
accounts accounts
o codes - show transaction codes o codes - show transaction codes
@ -1684,10 +1711,10 @@ COMMANDS
o print-unique - show only transactions with unique descriptions o print-unique - show only transactions with unique descriptions
o register (reg) - show postings in one or more accounts & running o register (reg) - show postings in one or more accounts & running
total total
o register-match - show a recent posting that best matches a descrip- o register-match - show a recent posting that best matches a descrip-
tion tion
o stats - show journal statistics o stats - show journal statistics
@ -1698,8 +1725,8 @@ COMMANDS
Add-on commands: Add-on commands:
Programs or scripts named hledger-SOMETHING in your PATH are add-on Programs or scripts named hledger-SOMETHING in your PATH are add-on
commands; these appear in the commands list with a + mark. Two of commands; these appear in the commands list with a + mark. Two of
these are maintained and released with hledger: these are maintained and released with hledger:
o ui - an efficient terminal interface (TUI) for hledger o ui - an efficient terminal interface (TUI) for hledger
@ -1710,10 +1737,10 @@ COMMANDS
o iadd - a more interactive alternative for the add command o iadd - a more interactive alternative for the add command
o interest - generates interest transactions according to various o interest - generates interest transactions according to various
schemes schemes
o stockquotes - downloads market prices for your commodities from o stockquotes - downloads market prices for your commodities from
AlphaVantage (experimental) AlphaVantage (experimental)
Next, the detailed command docs, in alphabetical order. Next, the detailed command docs, in alphabetical order.
@ -1722,13 +1749,13 @@ COMMANDS
accounts accounts
Show account names. Show account names.
This command lists account names, either declared with account direc- This command lists account names, either declared with account direc-
tives (--declared), posted to (--used), or both (the default). With tives (--declared), posted to (--used), or both (the default). With
query arguments, only matched account names and account names refer- query arguments, only matched account names and account names refer-
enced by matched postings are shown. It shows a flat list by default. enced by matched postings are shown. It shows a flat list by default.
With --tree, it uses indentation to show the account hierarchy. In With --tree, it uses indentation to show the account hierarchy. In
flat mode you can add --drop N to omit the first few account name com- flat mode you can add --drop N to omit the first few account name com-
ponents. Account names can be depth-clipped with depth:N or --depth N ponents. Account names can be depth-clipped with depth:N or --depth N
or -N. or -N.
Examples: Examples:
@ -1747,8 +1774,8 @@ COMMANDS
activity activity
Show an ascii barchart of posting counts per interval. Show an ascii barchart of posting counts per interval.
The activity command displays an ascii histogram showing transaction The activity command displays an ascii histogram showing transaction
counts by day, week, month or other reporting interval (by day is the counts by day, week, month or other reporting interval (by day is the
default). With query arguments, it counts only matched transactions. default). With query arguments, it counts only matched transactions.
Examples: Examples:
@ -1761,25 +1788,25 @@ COMMANDS
add add
add add
Prompt for transactions and add them to the journal. Any arguments Prompt for transactions and add them to the journal. Any arguments
will be used as default inputs for the first N prompts. will be used as default inputs for the first N prompts.
Many hledger users edit their journals directly with a text editor, or Many hledger users edit their journals directly with a text editor, or
generate them from CSV. For more interactive data entry, there is the generate them from CSV. For more interactive data entry, there is the
add command, which prompts interactively on the console for new trans- add command, which prompts interactively on the console for new trans-
actions, and appends them to the journal file (if there are multiple -f actions, and appends them to the journal file (if there are multiple -f
FILE options, the first file is used.) Existing transactions are not FILE options, the first file is used.) Existing transactions are not
changed. This is the only hledger command that writes to the journal changed. This is the only hledger command that writes to the journal
file. file.
To use it, just run hledger add and follow the prompts. You can add as To use it, just run hledger add and follow the prompts. You can add as
many transactions as you like; when you are finished, enter . or press many transactions as you like; when you are finished, enter . or press
control-d or control-c to exit. control-d or control-c to exit.
Features: Features:
o add tries to provide useful defaults, using the most similar (by o add tries to provide useful defaults, using the most similar (by
description) recent transaction (filtered by the query, if any) as a description) recent transaction (filtered by the query, if any) as a
template. template.
o You can also set the initial defaults with command line arguments. o You can also set the initial defaults with command line arguments.
@ -1787,10 +1814,10 @@ COMMANDS
o Readline-style edit keys can be used during data entry. o Readline-style edit keys can be used during data entry.
o The tab key will auto-complete whenever possible - accounts, descrip- o The tab key will auto-complete whenever possible - accounts, descrip-
tions, dates (yesterday, today, tomorrow). If the input area is tions, dates (yesterday, today, tomorrow). If the input area is
empty, it will insert the default value. empty, it will insert the default value.
o If the journal defines a default commodity, it will be added to any o If the journal defines a default commodity, it will be added to any
bare numbers entered. bare numbers entered.
o A parenthesised transaction code may be entered following a date. o A parenthesised transaction code may be entered following a date.
@ -1799,7 +1826,7 @@ COMMANDS
o If you make a mistake, enter < at any prompt to go one step backward. o If you make a mistake, enter < at any prompt to go one step backward.
o Input prompts are displayed in a different colour when the terminal o Input prompts are displayed in a different colour when the terminal
supports it. supports it.
Example (see the tutorial for a detailed explanation): Example (see the tutorial for a detailed explanation):
@ -1829,91 +1856,91 @@ COMMANDS
Starting the next transaction (. or ctrl-D/ctrl-C to quit) Starting the next transaction (. or ctrl-D/ctrl-C to quit)
Date [2015/05/22]: <CTRL-D> $ Date [2015/05/22]: <CTRL-D> $
On Microsoft Windows, the add command makes sure that no part of the On Microsoft Windows, the add command makes sure that no part of the
file path ends with a period, as that would cause problems (#1056). file path ends with a period, as that would cause problems (#1056).
aregister aregister
aregister, areg aregister, areg
Show the transactions and running historical balance of a single Show the transactions and running historical balance of a single
account, with each transaction displayed as one line. account, with each transaction displayed as one line.
aregister shows the overall transactions affecting a particular account aregister shows the overall transactions affecting a particular account
(and any subaccounts). Each report line represents one transaction in (and any subaccounts). Each report line represents one transaction in
this account. Transactions before the report start date are always this account. Transactions before the report start date are always
included in the running balance (--historical mode is always on). included in the running balance (--historical mode is always on).
This is a more "real world", bank-like view than the register command This is a more "real world", bank-like view than the register command
(which shows individual postings, possibly from multiple accounts, not (which shows individual postings, possibly from multiple accounts, not
necessarily in historical mode). As a quick rule of thumb: - use areg- necessarily in historical mode). As a quick rule of thumb: - use areg-
ister for reviewing and reconciling real-world asset/liability accounts ister for reviewing and reconciling real-world asset/liability accounts
- use register for reviewing detailed revenues/expenses. - use register for reviewing detailed revenues/expenses.
aregister requires one argument: the account to report on. You can aregister requires one argument: the account to report on. You can
write either the full account name, or a case-insensitive regular write either the full account name, or a case-insensitive regular
expression which will select the alphabetically first matched account. expression which will select the alphabetically first matched account.
(Eg if you have assets:aaa:checking and assets:bbb:checking accounts, (Eg if you have assets:aaa:checking and assets:bbb:checking accounts,
hledger areg checking would select assets:aaa:checking.) hledger areg checking would select assets:aaa:checking.)
Transactions involving subaccounts of this account will also be shown. Transactions involving subaccounts of this account will also be shown.
aregister ignores depth limits, so its final total will always match a aregister ignores depth limits, so its final total will always match a
balance report with similar arguments. balance report with similar arguments.
Any additional arguments form a query which will filter the transac- Any additional arguments form a query which will filter the transac-
tions shown. Note some queries will disturb the running balance, caus- tions shown. Note some queries will disturb the running balance, caus-
ing it to be different from the account's real-world running balance. ing it to be different from the account's real-world running balance.
An example: this shows the transactions and historical running balance An example: this shows the transactions and historical running balance
during july, in the first account whose name contains "checking": during july, in the first account whose name contains "checking":
$ hledger areg checking date:jul $ hledger areg checking date:jul
Each aregister line item shows: Each aregister line item shows:
o the transaction's date (or the relevant posting's date if different, o the transaction's date (or the relevant posting's date if different,
see below) see below)
o the names of all the other account(s) involved in this transaction o the names of all the other account(s) involved in this transaction
(probably abbreviated) (probably abbreviated)
o the total change to this account's balance from this transaction o the total change to this account's balance from this transaction
o the account's historical running balance after this transaction. o the account's historical running balance after this transaction.
Transactions making a net change of zero are not shown by default; add Transactions making a net change of zero are not shown by default; add
the -E/--empty flag to show them. the -E/--empty flag to show them.
This command also supports the output destination and output format This command also supports the output destination and output format
options. The output formats supported are txt, csv, and json. options. The output formats supported are txt, csv, and json.
aregister and custom posting dates aregister and custom posting dates
Transactions whose date is outside the report period can still be Transactions whose date is outside the report period can still be
shown, if they have a posting to this account dated inside the report shown, if they have a posting to this account dated inside the report
period. (And in this case it's the posting date that is shown.) This period. (And in this case it's the posting date that is shown.) This
ensures that aregister can show an accurate historical running balance, ensures that aregister can show an accurate historical running balance,
matching the one shown by register -H with the same arguments. matching the one shown by register -H with the same arguments.
To filter strictly by transaction date instead, add the --txn-dates To filter strictly by transaction date instead, add the --txn-dates
flag. If you use this flag and some of your postings have custom flag. If you use this flag and some of your postings have custom
dates, it's probably best to assume the running balance is wrong. dates, it's probably best to assume the running balance is wrong.
balance balance
balance, bal balance, bal
Show accounts and their balances. Show accounts and their balances.
balance is one of hledger's oldest and most versatile commands, for balance is one of hledger's oldest and most versatile commands, for
listing account balances, balance changes, values, value changes and listing account balances, balance changes, values, value changes and
more, during one time period or many. Generally it shows a table, with more, during one time period or many. Generally it shows a table, with
rows representing accounts, and columns representing periods. rows representing accounts, and columns representing periods.
Note there are some higher-level variants of the balance command with Note there are some higher-level variants of the balance command with
convenient defaults, which can be simpler to use: balancesheet, bal- convenient defaults, which can be simpler to use: balancesheet, bal-
ancesheetequity, cashflow and incomestatement. When you need more con- ancesheetequity, cashflow and incomestatement. When you need more con-
trol, then use balance. trol, then use balance.
balance features balance features
Here's a quick overview of the balance command's features, followed by Here's a quick overview of the balance command's features, followed by
more detailed descriptions and examples. Many of these work with the more detailed descriptions and examples. Many of these work with the
higher-level commands as well. higher-level commands as well.
balance can show.. balance can show..
@ -1964,7 +1991,7 @@ COMMANDS
..with.. ..with..
o totals (-T), averages (-A), percentages (-%), inverted sign o totals (-T), averages (-A), percentages (-%), inverted sign
(--invert) (--invert)
o rows and columns swapped (--transpose) o rows and columns swapped (--transpose)
@ -1976,21 +2003,21 @@ COMMANDS
o commodities displayed on the same line or multiple lines (--layout) o commodities displayed on the same line or multiple lines (--layout)
This command supports the output destination and output format options, This command supports the output destination and output format options,
with output formats txt, csv, json, and (multi-period reports only:) with output formats txt, csv, json, and (multi-period reports only:)
html. In txt output in a colour-supporting terminal, negative amounts html. In txt output in a colour-supporting terminal, negative amounts
are shown in red. are shown in red.
The --related/-r flag shows the balance of the other postings in the The --related/-r flag shows the balance of the other postings in the
transactions of the postings which would normally be shown. transactions of the postings which would normally be shown.
Simple balance report Simple balance report
With no arguments, balance shows a list of all accounts and their With no arguments, balance shows a list of all accounts and their
change of balance - ie, the sum of posting amounts, both inflows and change of balance - ie, the sum of posting amounts, both inflows and
outflows - during the entire period of the journal. For real-world outflows - during the entire period of the journal. For real-world
accounts, this should also match their end balance at the end of the accounts, this should also match their end balance at the end of the
journal period (more on this below). journal period (more on this below).
Accounts are sorted by declaration order if any, and then alphabeti- Accounts are sorted by declaration order if any, and then alphabeti-
cally by account name. For instance (using examples/sample.journal): cally by account name. For instance (using examples/sample.journal):
$ hledger -f examples/sample.journal bal $ hledger -f examples/sample.journal bal
@ -2005,7 +2032,7 @@ COMMANDS
0 0
Accounts with a zero balance (and no non-zero subaccounts, in tree mode Accounts with a zero balance (and no non-zero subaccounts, in tree mode
- see below) are hidden by default. Use -E/--empty to show them - see below) are hidden by default. Use -E/--empty to show them
(revealing assets:bank:checking here): (revealing assets:bank:checking here):
$ hledger -f examples/sample.journal bal -E $ hledger -f examples/sample.journal bal -E
@ -2020,11 +2047,11 @@ COMMANDS
-------------------- --------------------
0 0
The total of the amounts displayed is shown as the last line, unless The total of the amounts displayed is shown as the last line, unless
-N/--no-total is used. -N/--no-total is used.
Filtered balance report Filtered balance report
You can show fewer accounts, a different time period, totals from You can show fewer accounts, a different time period, totals from
cleared transactions only, etc. by using query arguments or options to cleared transactions only, etc. by using query arguments or options to
limit the postings being matched. Eg: limit the postings being matched. Eg:
@ -2034,10 +2061,10 @@ COMMANDS
$-2 $-2
List or tree mode List or tree mode
By default, or with -l/--flat, accounts are shown as a flat list with By default, or with -l/--flat, accounts are shown as a flat list with
their full names visible, as in the examples above. their full names visible, as in the examples above.
With -t/--tree, the account hierarchy is shown, with subaccounts' With -t/--tree, the account hierarchy is shown, with subaccounts'
"leaf" names indented below their parent: "leaf" names indented below their parent:
$ hledger -f examples/sample.journal balance $ hledger -f examples/sample.journal balance
@ -2057,26 +2084,26 @@ COMMANDS
Notes: Notes:
o "Boring" accounts are combined with their subaccount for more compact o "Boring" accounts are combined with their subaccount for more compact
output, unless --no-elide is used. Boring accounts have no balance output, unless --no-elide is used. Boring accounts have no balance
of their own and just one subaccount (eg assets:bank and liabilities of their own and just one subaccount (eg assets:bank and liabilities
above). above).
o All balances shown are "inclusive", ie including the balances from o All balances shown are "inclusive", ie including the balances from
all subaccounts. Note this means some repetition in the output, all subaccounts. Note this means some repetition in the output,
which requires explanation when sharing reports with non-plaintextac- which requires explanation when sharing reports with non-plaintextac-
counting-users. A tree mode report's final total is the sum of the counting-users. A tree mode report's final total is the sum of the
top-level balances shown, not of all the balances shown. top-level balances shown, not of all the balances shown.
o Each group of sibling accounts (ie, under a common parent) is sorted o Each group of sibling accounts (ie, under a common parent) is sorted
separately. separately.
Depth limiting Depth limiting
With a depth:NUM query, or --depth NUM option, or just -NUM (eg: -3) With a depth:NUM query, or --depth NUM option, or just -NUM (eg: -3)
balance reports will show accounts only to the specified depth, hiding balance reports will show accounts only to the specified depth, hiding
the deeper subaccounts. This can be useful for getting an overview the deeper subaccounts. This can be useful for getting an overview
without too much detail. without too much detail.
Account balances at the depth limit always include the balances from Account balances at the depth limit always include the balances from
any deeper subaccounts (even in list mode). Eg, limiting to depth 1: any deeper subaccounts (even in list mode). Eg, limiting to depth 1:
$ hledger -f examples/sample.journal balance -1 $ hledger -f examples/sample.journal balance -1
@ -2088,7 +2115,7 @@ COMMANDS
0 0
Dropping top-level accounts Dropping top-level accounts
You can also hide one or more top-level account name parts, using You can also hide one or more top-level account name parts, using
--drop NUM. This can be useful for hiding repetitive top-level account --drop NUM. This can be useful for hiding repetitive top-level account
names: names:
@ -2100,9 +2127,9 @@ COMMANDS
Multi-period balance report Multi-period balance report
With a report interval (set by the -D/--daily, -W/--weekly, With a report interval (set by the -D/--daily, -W/--weekly,
-M/--monthly, -Q/--quarterly, -Y/--yearly, or -p/--period flag), bal- -M/--monthly, -Q/--quarterly, -Y/--yearly, or -p/--period flag), bal-
ance shows a tabular report, with columns representing successive time ance shows a tabular report, with columns representing successive time
periods (and a title): periods (and a title):
$ hledger -f examples/sample.journal bal --quarterly income expenses -E $ hledger -f examples/sample.journal bal --quarterly income expenses -E
@ -2123,21 +2150,21 @@ COMMANDS
encompass the displayed subperiods (so that the first and last subpe- encompass the displayed subperiods (so that the first and last subpe-
riods have the same duration as the others). riods have the same duration as the others).
o Leading and trailing periods (columns) containing all zeroes are not o Leading and trailing periods (columns) containing all zeroes are not
shown, unless -E/--empty is used. shown, unless -E/--empty is used.
o Accounts (rows) containing all zeroes are not shown, unless o Accounts (rows) containing all zeroes are not shown, unless
-E/--empty is used. -E/--empty is used.
o Amounts with many commodities are shown in abbreviated form, unless o Amounts with many commodities are shown in abbreviated form, unless
--no-elide is used. (experimental) --no-elide is used. (experimental)
o Average and/or total columns can be added with the -A/--average and o Average and/or total columns can be added with the -A/--average and
-T/--row-total flags. -T/--row-total flags.
o The --transpose flag can be used to exchange rows and columns. o The --transpose flag can be used to exchange rows and columns.
o The --pivot FIELD option causes a different transaction field to be o The --pivot FIELD option causes a different transaction field to be
used as "account name". See PIVOTING. used as "account name". See PIVOTING.
Multi-period reports with many periods can be too wide for easy viewing Multi-period reports with many periods can be too wide for easy viewing
@ -2151,27 +2178,27 @@ COMMANDS
o Reduce the terminal's font size o Reduce the terminal's font size
o View with a pager like less, eg: hledger bal -D --color=yes | less o View with a pager like less, eg: hledger bal -D --color=yes | less
-RS -RS
o Output as CSV and use a CSV viewer like visidata (hledger bal -D -O o Output as CSV and use a CSV viewer like visidata (hledger bal -D -O
csv | vd -f csv), Emacs' csv-mode (M-x csv-mode, C-c C-a), or a csv | vd -f csv), Emacs' csv-mode (M-x csv-mode, C-c C-a), or a
spreadsheet (hledger bal -D -o a.csv && open a.csv) spreadsheet (hledger bal -D -o a.csv && open a.csv)
o Output as HTML and view with a browser: hledger bal -D -o a.html && o Output as HTML and view with a browser: hledger bal -D -o a.html &&
open a.html open a.html
Showing declared accounts Showing declared accounts
With --declared, accounts which have been declared with an account With --declared, accounts which have been declared with an account
directive will be included in the balance report, even if they have no directive will be included in the balance report, even if they have no
transactions. (Since they will have a zero balance, you will also need transactions. (Since they will have a zero balance, you will also need
-E/--empty to see them.) -E/--empty to see them.)
More precisely, leaf declared accounts (with no subaccounts) will be More precisely, leaf declared accounts (with no subaccounts) will be
included, since those are usually the more useful in reports. included, since those are usually the more useful in reports.
The idea of this is to be able to see a useful "complete" balance The idea of this is to be able to see a useful "complete" balance
report, even when you don't have transactions in all of your declared report, even when you don't have transactions in all of your declared
accounts yet. accounts yet.
Commodity layout Commodity layout
@ -2183,81 +2210,89 @@ COMMANDS
o --layout=tall: each commodity is displayed on a separate line o --layout=tall: each commodity is displayed on a separate line
o --layout=bare: commodity symbols are displayed in a separate column, o --layout=bare: amounts are displayed as bare numbers, with commodity
and amounts are displayed as bare numbers symbols in a separate column
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide Examples:
Balance changes in 2012-01-01..2014-12-31:
|| 2012 2013 2014 Total o Wide layout. With many commodities, reports can be very wide:
==================++====================================================================================================================================================================================================================
Assets:US:ETrade || 10.00 ITOT, 337.18 USD, 12.00 VEA, 106.00 VHT 70.00 GLD, 18.00 ITOT, -98.12 USD, 10.00 VEA, 18.00 VHT -11.00 ITOT, 4881.44 USD, 14.00 VEA, 170.00 VHT 70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT
------------------++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|| 10.00 ITOT, 337.18 USD, 12.00 VEA, 106.00 VHT 70.00 GLD, 18.00 ITOT, -98.12 USD, 10.00 VEA, 18.00 VHT -11.00 ITOT, 4881.44 USD, 14.00 VEA, 170.00 VHT 70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide,32 $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide
Balance changes in 2012-01-01..2014-12-31: Balance changes in 2012-01-01..2014-12-31:
|| 2012 2013 2014 Total || 2012 2013 2014 Total
==================++=========================================================================================================================== ==================++====================================================================================================================================================================================================================
Assets:US:ETrade || 10.00 ITOT, 337.18 USD, 2 more.. 70.00 GLD, 18.00 ITOT, 3 more.. -11.00 ITOT, 3 more.. 70.00 GLD, 17.00 ITOT, 3 more.. Assets:US:ETrade || 10.00 ITOT, 337.18 USD, 12.00 VEA, 106.00 VHT 70.00 GLD, 18.00 ITOT, -98.12 USD, 10.00 VEA, 18.00 VHT -11.00 ITOT, 4881.44 USD, 14.00 VEA, 170.00 VHT 70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT
------------------++--------------------------------------------------------------------------------------------------------------------------- ------------------++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|| 10.00 ITOT, 337.18 USD, 2 more.. 70.00 GLD, 18.00 ITOT, 3 more.. -11.00 ITOT, 3 more.. 70.00 GLD, 17.00 ITOT, 3 more.. || 10.00 ITOT, 337.18 USD, 12.00 VEA, 106.00 VHT 70.00 GLD, 18.00 ITOT, -98.12 USD, 10.00 VEA, 18.00 VHT -11.00 ITOT, 4881.44 USD, 14.00 VEA, 170.00 VHT 70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=tall o Limited wide layout. A width limit reduces the width, but some com-
Balance changes in 2012-01-01..2014-12-31: modities will be hidden:
|| 2012 2013 2014 Total $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide,32
==================++================================================== Balance changes in 2012-01-01..2014-12-31:
Assets:US:ETrade || 10.00 ITOT 70.00 GLD -11.00 ITOT 70.00 GLD
Assets:US:ETrade || 337.18 USD 18.00 ITOT 4881.44 USD 17.00 ITOT
Assets:US:ETrade || 12.00 VEA -98.12 USD 14.00 VEA 5120.50 USD
Assets:US:ETrade || 106.00 VHT 10.00 VEA 170.00 VHT 36.00 VEA
Assets:US:ETrade || 18.00 VHT 294.00 VHT
------------------++--------------------------------------------------
|| 10.00 ITOT 70.00 GLD -11.00 ITOT 70.00 GLD
|| 337.18 USD 18.00 ITOT 4881.44 USD 17.00 ITOT
|| 12.00 VEA -98.12 USD 14.00 VEA 5120.50 USD
|| 106.00 VHT 10.00 VEA 170.00 VHT 36.00 VEA
|| 18.00 VHT 294.00 VHT
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=bare || 2012 2013 2014 Total
Balance changes in 2012-01-01..2014-12-31: ==================++===========================================================================================================================
Assets:US:ETrade || 10.00 ITOT, 337.18 USD, 2 more.. 70.00 GLD, 18.00 ITOT, 3 more.. -11.00 ITOT, 3 more.. 70.00 GLD, 17.00 ITOT, 3 more..
------------------++---------------------------------------------------------------------------------------------------------------------------
|| 10.00 ITOT, 337.18 USD, 2 more.. 70.00 GLD, 18.00 ITOT, 3 more.. -11.00 ITOT, 3 more.. 70.00 GLD, 17.00 ITOT, 3 more..
|| Commodity 2012 2013 2014 Total o Tall layout. Each commodity gets a new line (may be different in
==================++============================================= each column), and account names are repeated:
Assets:US:ETrade || GLD 0 70.00 0 70.00
Assets:US:ETrade || ITOT 10.00 18.00 -11.00 17.00
Assets:US:ETrade || USD 337.18 -98.12 4881.44 5120.50
Assets:US:ETrade || VEA 12.00 10.00 14.00 36.00
Assets:US:ETrade || VHT 106.00 18.00 170.00 294.00
------------------++---------------------------------------------
|| GLD 0 70.00 0 70.00
|| ITOT 10.00 18.00 -11.00 17.00
|| USD 337.18 -98.12 4881.44 5120.50
|| VEA 12.00 10.00 14.00 36.00
|| VHT 106.00 18.00 170.00 294.00
The option --layout=bare also affects CSV output, which is useful for $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=tall
producing data that is easier to consume, eg when making charts: Balance changes in 2012-01-01..2014-12-31:
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv || 2012 2013 2014 Total
"account","balance" ==================++==================================================
"Assets:US:ETrade","70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT" Assets:US:ETrade || 10.00 ITOT 70.00 GLD -11.00 ITOT 70.00 GLD
"total","70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT" Assets:US:ETrade || 337.18 USD 18.00 ITOT 4881.44 USD 17.00 ITOT
Assets:US:ETrade || 12.00 VEA -98.12 USD 14.00 VEA 5120.50 USD
Assets:US:ETrade || 106.00 VHT 10.00 VEA 170.00 VHT 36.00 VEA
Assets:US:ETrade || 18.00 VHT 294.00 VHT
------------------++--------------------------------------------------
|| 10.00 ITOT 70.00 GLD -11.00 ITOT 70.00 GLD
|| 337.18 USD 18.00 ITOT 4881.44 USD 17.00 ITOT
|| 12.00 VEA -98.12 USD 14.00 VEA 5120.50 USD
|| 106.00 VHT 10.00 VEA 170.00 VHT 36.00 VEA
|| 18.00 VHT 294.00 VHT
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=bare o Bare layout. Commodity symbols are kept in one column, each commod-
"account","commodity","balance" ity gets its own report row, account names are repeated:
"Assets:US:ETrade","GLD","70.00"
"Assets:US:ETrade","ITOT","17.00" $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=bare
"Assets:US:ETrade","USD","5120.50" Balance changes in 2012-01-01..2014-12-31:
"Assets:US:ETrade","VEA","36.00"
"Assets:US:ETrade","VHT","294.00" || Commodity 2012 2013 2014 Total
"total","GLD","70.00" ==================++=============================================
"total","ITOT","17.00" Assets:US:ETrade || GLD 0 70.00 0 70.00
"total","USD","5120.50" Assets:US:ETrade || ITOT 10.00 18.00 -11.00 17.00
"total","VEA","36.00" Assets:US:ETrade || USD 337.18 -98.12 4881.44 5120.50
"total","VHT","294.00" Assets:US:ETrade || VEA 12.00 10.00 14.00 36.00
Assets:US:ETrade || VHT 106.00 18.00 170.00 294.00
------------------++---------------------------------------------
|| GLD 0 70.00 0 70.00
|| ITOT 10.00 18.00 -11.00 17.00
|| USD 337.18 -98.12 4881.44 5120.50
|| VEA 12.00 10.00 14.00 36.00
|| VHT 106.00 18.00 170.00 294.00
o Bare layout also affects CSV output, which is useful for producing
data that is easier to consume, eg when making charts:
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=bare
"account","commodity","balance"
"Assets:US:ETrade","GLD","70.00"
"Assets:US:ETrade","ITOT","17.00"
"Assets:US:ETrade","USD","5120.50"
"Assets:US:ETrade","VEA","36.00"
"Assets:US:ETrade","VHT","294.00"
"total","GLD","70.00"
"total","ITOT","17.00"
"total","USD","5120.50"
"total","VEA","36.00"
"total","VHT","294.00"
Sorting by amount Sorting by amount
With -S/--sort-amount, accounts with the largest (most positive) bal- With -S/--sort-amount, accounts with the largest (most positive) bal-
@ -2425,7 +2460,6 @@ COMMANDS
period end ues from report from report report start period end ues from report from report report start
start to period start to period to period end start to period start to period to period end
end end end end
--his- change from sum of posting- period-end DATE-value of --his- change from sum of posting- period-end DATE-value of
torical journal start to date market val- value of change change from torical journal start to date market val- value of change change from
/-H period end (his- ues from journal from journal journal start /-H period end (his- ues from journal from journal journal start
@ -4924,8 +4958,6 @@ JOURNAL FORMAT
apply Prepends a common parent account to all account names, in Y apply Prepends a common parent account to all account names, in Y
account following entries until end of current file or end apply account following entries until end of current file or end apply
account. account.
comment Ignores part of the journal file, until end of current file Y comment Ignores part of the journal file, until end of current file Y
or end comment. or end comment.
commod- Declares a commodity, for checking all entries in all files; N, Y commod- Declares a commodity, for checking all entries in all files; N, Y
@ -7522,4 +7554,4 @@ SEE ALSO
hledger-1.24 December 2021 HLEDGER(1) hledger-1.24.99 December 2021 HLEDGER(1)