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

;doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2023-01-10 23:34:47 -10:00
parent dbb1441402
commit fc8fe8ee46
13 changed files with 6523 additions and 5791 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-lib/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{December 2022}})m4_dnl m4_define({{_monthyear_}}, {{January 2023}})m4_dnl

2
hledger-ui/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{December 2022}})m4_dnl m4_define({{_monthyear_}}, {{January 2023}})m4_dnl

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

@ -1,5 +1,5 @@
.TH "HLEDGER-UI" "1" "December 2022" "hledger-ui-1.28.99 " "hledger User Manuals" .TH "HLEDGER-UI" "1" "January 2023" "hledger-ui-1.28.99 " "hledger User Manuals"
@ -18,10 +18,11 @@ hledger-ui - robust, friendly plain text accounting (TUI version)
This manual is for hledger\[aq]s terminal interface, version 1.28.99. This manual is for hledger\[aq]s terminal interface, version 1.28.99.
See also the hledger manual for common concepts and file formats. See also the hledger manual for common concepts and file formats.
.PP .PP
hledger is a reliable, cross-platform set of programs for tracking hledger is a robust, user-friendly, cross-platform set of programs for
money, time, or any other commodity, using double-entry accounting and a tracking money, time, or any other commodity, using double-entry
simple, editable file format. accounting and a simple, editable file format.
hledger is inspired by and largely compatible with ledger(1). hledger is inspired by and largely compatible with ledger(1), and
largely interconvertible with beancount(1).
.PP .PP
hledger-ui is hledger\[aq]s terminal interface, providing an efficient hledger-ui is hledger\[aq]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
@ -29,10 +30,11 @@ limited data entry capability.
It is easier than hledger\[aq]s command-line interface, and sometimes It is easier than hledger\[aq]s command-line interface, and sometimes
quicker and more convenient than the web interface. quicker and more convenient than the web interface.
.PP .PP
Like hledger, it reads data from one or more files in hledger journal, Like hledger, it reads data from one or more files in journal,
timeclock, timedot, or CSV format specified with \f[V]-f\f[R], or timeclock, timedot, or CSV format.
\f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows, The default file is \f[V].hledger.journal\f[R] in your home directory;
perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]). this can be overridden with one or more \f[V]-f FILE\f[R] options, or
the \f[V]LEDGER_FILE\f[R] environment variable.
For more about this see hledger(1), hledger_journal(5) etc. For more about this see hledger(1), hledger_journal(5) etc.
.PP .PP
Unlike hledger, hledger-ui hides all future-dated transactions by Unlike hledger, hledger-ui hides all future-dated transactions by
@ -618,10 +620,11 @@ Or, change it in settings: see
https://www.java.com/en/download/help/path.html. https://www.java.com/en/download/help/path.html.
.SH FILES .SH FILES
.PP .PP
Reads data from one or more files in hledger journal, timeclock, Reads data from one or more files in journal, timeclock, timedot, or CSV
timedot, or CSV format specified with \f[V]-f\f[R], or format.
\f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows, The default file is \f[V].hledger.journal\f[R] in your home directory;
perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]). this can be overridden with one or more \f[V]-f FILE\f[R] options, or
the \f[V]LEDGER_FILE\f[R] environment variable.
.SH BUGS .SH BUGS
.PP .PP
\f[V]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin). \f[V]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin).

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

@ -1,4 +1,4 @@
This is hledger-ui.info, produced by makeinfo version 6.8 from stdin. This is hledger-ui.info, produced by makeinfo version 7.0.1 from stdin.
INFO-DIR-SECTION User Applications INFO-DIR-SECTION User Applications
START-INFO-DIR-ENTRY START-INFO-DIR-ENTRY
@ -13,32 +13,33 @@ hledger-ui(1)
hledger-ui - robust, friendly plain text accounting (TUI version) hledger-ui - robust, friendly plain text accounting (TUI version)
'hledger-ui [OPTIONS] [QUERYARGS]' ‘hledger-ui [OPTIONS] [QUERYARGS]’
'hledger ui -- [OPTIONS] [QUERYARGS]' ‘hledger ui -- [OPTIONS] [QUERYARGS]’
This manual is for hledger's terminal interface, version 1.28.99. This manual is for hledger’s terminal interface, version 1.28.99.
See also the hledger manual for common concepts and file formats. See also the hledger manual for common concepts and file formats.
hledger is a reliable, cross-platform set of programs for tracking hledger is a robust, user-friendly, cross-platform set of programs
money, time, or any other commodity, using double-entry accounting and a for tracking money, time, or any other commodity, using double-entry
simple, editable file format. hledger is inspired by and largely accounting and a simple, editable file format. hledger is inspired by
compatible with ledger(1). and largely compatible with ledger(1), and largely interconvertible with
beancount(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 journal,
journal, timeclock, timedot, or CSV format specified with '-f', or timeclock, timedot, or CSV format. The default file is
'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps ‘.hledger.journal’ in your home directory; this can be overridden with
'C:/Users/USER/.hledger.journal'). For more about this see hledger(1), one or more ‘-f FILE’ options, or the ‘LEDGER_FILE’ environment
hledger_journal(5) etc. variable. For more about this see hledger(1), 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".
* Menu: * Menu:
@ -58,173 +59,173 @@ 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
'--menu' ‘--menu’
start in the menu screen start in the menu screen
'--all' ‘--all’
start in the all accounts screen start in the all accounts screen
'--bs' ‘--bs’
start in the balance sheet accounts screen start in the balance sheet accounts screen
'--is' ‘--is’
start in the income statement accounts screen start in the income statement accounts screen
'--register=ACCTREGEX' ‘--register=ACCTREGEX’
start in the (first) matched account's register screen start in the (first) matched account’s register screen
'--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: use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal') ‘$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’.
When a reporting option appears more than once in the command line, When a reporting option appears more than once in the command line,
the last one takes precedence. the last one takes precedence.
@ -233,25 +234,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
@ -262,9 +263,9 @@ File: hledger-ui.info, Node: MOUSE, Next: KEYS, Prev: OPTIONS, Up: Top
In most modern terminals, you can navigate through the screens with a 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) to go back. • Click on the left margin (column 0) to go back.
 
File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: MOUSE, Up: Top File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: MOUSE, Up: Top
@ -274,88 +275,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' or 'ENTER' goes deeper, 'LEFT' The cursor keys navigate: ‘RIGHT’ or ‘ENTER’ goes deeper, ‘LEFT’
returns to the previous screen, 'UP'/'DOWN'/'PGUP'/'PGDN'/'HOME'/'END' returns to the previous screen, ‘UP’/‘DOWN’/‘PGUP’/‘PGDN’/‘HOME’/‘END’
move up and down through lists. Emacs-style move up and down through lists. Emacs-style
('CTRL-p'/'CTRL-n'/'CTRL-f'/'CTRL-b') and VI-style ('k','j','l','h') (‘CTRL-p’/‘CTRL-n’/‘CTRL-f’/‘CTRL-b’) and VI-style (‘k’,‘j’,‘l’,‘h’)
movement keys are also supported. A tip: movement speed is limited by movement keys are also supported. A tip: movement speed is limited by
your keyboard repeat rate, to move faster you may want to adjust it. your keyboard repeat rate, to move faster you may want to adjust it.
(If you're on a mac, the karabiner app is one way to do that.) (If you’re on a mac, the karabiner app is one way to do that.)
With shift pressed, the cursor keys adjust the report period, With shift pressed, the cursor keys adjust the report period,
limiting the transactions to be shown (by default, all are shown). limiting the transactions to be shown (by default, all are shown).
'SHIFT-DOWN/UP' steps downward and upward through these standard report ‘SHIFT-DOWN/UP’ steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then, period durations: year, quarter, month, week, day. Then,
'SHIFT-LEFT/RIGHT' moves to the previous/next period. 'T' sets the ‘SHIFT-LEFT/RIGHT’ moves to the previous/next period. ‘T’ sets the
report period to today. With the '-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 cost's commodity ‘B’ toggles cost mode, showing amounts in their cost’s commodity
(like toggling the '-B/--cost' flag). (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.
@ -369,14 +370,14 @@ hledger-ui shows several different screens, described below. It shows
the "Balance sheet accounts" screen to start with, except in the the "Balance sheet accounts" screen to start with, except in the
following situations: following situations:
* If no asset/liability/equity accounts can be detected, or if an • If no asset/liability/equity accounts can be detected, or if an
account query has been given on the command line, it starts in the account query has been given on the command line, it starts in the
"All accounts" screen. "All accounts" screen.
* If a starting screen is specified with -menu/-all/-bs/-is/-register • If a starting screen is specified with –menu/–all/–bs/–is/–register
on the command line, it starts in that screen. on the command line, it starts in that screen.
From any screen you can press 'LEFT' or 'ESC' to navigate back to the From any screen you can press ‘LEFT’ or ‘ESC’ to navigate back to the
top level "Menu" screen. top level "Menu" screen.
* Menu: * Menu:
@ -406,8 +407,8 @@ File: hledger-ui.info, Node: All accounts, Next: Balance sheet accounts, Prev
This screen shows all accounts (possibly filtered by a query), and their This screen shows all accounts (possibly filtered by a query), and their
end balances on the date shown in the title bar (or their balance end balances on the date shown in the title bar (or their balance
changes in the period shown in the title bar, toggleable with 'H'). It changes in the period shown in the title bar, toggleable with ‘H’). It
is like the 'hledger balance' command. is like the ‘hledger balance’ command.
 
File: hledger-ui.info, Node: Balance sheet accounts, Next: Income statement accounts, Prev: All accounts, Up: SCREENS File: hledger-ui.info, Node: Balance sheet accounts, Next: Income statement accounts, Prev: All accounts, Up: SCREENS
@ -417,7 +418,7 @@ File: hledger-ui.info, Node: Balance sheet accounts, Next: Income statement ac
This screen shows asset, liability and equity accounts, if these can be This screen shows asset, liability and equity accounts, if these can be
detected (see account types). It always shows end balances. It is like detected (see account types). It always shows end balances. It is like
the 'hledger balancesheetequity' command. the ‘hledger balancesheetequity’ command.
 
File: hledger-ui.info, Node: Income statement accounts, Next: Register, Prev: Balance sheet accounts, Up: SCREENS File: hledger-ui.info, Node: Income statement accounts, Next: Register, Prev: Balance sheet accounts, Up: SCREENS
@ -426,7 +427,7 @@ File: hledger-ui.info, Node: Income statement accounts, Next: Register, Prev:
============================= =============================
This screen shows revenue and expense accounts. It always shows balance This screen shows revenue and expense accounts. It always shows balance
changes. It is like the 'hledger incomestatement' command. changes. It is like the ‘hledger incomestatement’ command.
All of these accounts screens work in much the same way: All of these accounts screens work in much the same way:
@ -434,26 +435,26 @@ changes. It is like the 'hledger incomestatement' command.
as accounts which have been declared with an account directive (except as accounts which have been declared with an account directive (except
for empty parent accounts). for empty parent accounts).
If you specify a query on the command line or with '/' in the app, If you specify a query on the command line or with ‘/’ in the app,
they show just the matched accounts, and the balances from matched they show just the matched accounts, and the balances from matched
transactions. transactions.
hledger-ui shows accounts with zero balances by default (unlike hledger-ui shows accounts with zero balances by default (unlike
command-line hledger). To hide these, press 'z' to toggle nonzero mode. command-line hledger). To hide these, press ‘z’ to toggle nonzero mode.
Account names are shown as a flat list by default; press 't' to 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 below). In tree mode, all account balances are inclusive of
subaccounts. 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 depth, To remove the depth limit, set it higher than the maximum account 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
(on the "All accounts" screen). Historical balances (the default) are (on the "All accounts" screen). Historical balances (the default) are
ending balances at the end of the report period, taking into account all ending balances at the end of the report period, taking into account all
transactions before that date (filtered by the filter query if any), transactions before that date (filtered by the filter query if any),
@ -464,16 +465,16 @@ ignore transactions before the report start date, so they show the
change in balance during the report period. They are more useful eg change in balance during the report period. They are more useful eg
when viewing a time log. 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.
Press 'RIGHT' to view an account's register screen, Or, 'LEFT' to see Press ‘RIGHT’ to view an account’s register screen, Or, ‘LEFT’ to see
the menu screen. the menu screen.
 
@ -485,42 +486,42 @@ File: hledger-ui.info, Node: Register, Next: Transaction, Prev: Income statem
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 affected both real and virtual postings, it shows only the accounts 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 by Similar to the accounts screen, the historical total is affected by
transactions (filtered by the filter query) before the report start transactions (filtered by the filter query) before the report start
date, while the period total is not. If the historical total is date, while the period total is not. If the historical total is
not disturbed by a filter query, it will be the running historical not disturbed by a filter query, it will be the running historical
balance you would see on a bank register for the current account. balance you would see on a bank register for the current account.
Transactions affecting this account's subaccounts will be included in Transactions affecting this account’s subaccounts will be included in
the register if the accounts screen is in tree mode, or if it's in 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 contributing to the balance shown on the accounts screen. Tree
mode/list 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, Next: Error, Prev: Register, Up: SCREENS File: hledger-ui.info, Node: Transaction, Next: Error, Prev: Register, Up: SCREENS
@ -529,20 +530,20 @@ File: hledger-ui.info, Node: Transaction, Next: Error, Prev: Register, Up: S
=============== ===============
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format similar to hledger’s print command and journal format
(hledger_journal(5)). (hledger_journal(5)).
The transaction's date(s) and any cleared flag, transaction code, The transaction’s date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are shown. 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).
@ -574,12 +575,12 @@ File: hledger-ui.info, Node: Watch mode, Next: Debug output, Up: TIPS
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 This is very useful when reconciling. A good workflow is to have
your 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:
@ -594,16 +595,16 @@ history.
Here are some current limitations to be aware of: Here are some current limitations to be aware of:
Changes might not be detected with certain editors, possibly Changes might not be detected with certain editors, possibly
including Jetbrains IDEs, 'gedit', other Gnome applications; or on including Jetbrains IDEs, ‘gedit’, other Gnome applications; or on
certain unusual filesystems. (#1617, #911). To work around, reload certain unusual filesystems. (#1617, #911). To work around, reload
manually by pressing 'g' in the hledger-ui window. (Or see #1617 for manually by pressing ‘g’ in the hledger-ui window. (Or 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.)
CPU and memory usage can sometimes gradually increase, if 'hledger-ui CPU and memory usage can sometimes gradually increase, if ‘hledger-ui
--watch' is left running for days. (Possibly correlated with certain --watch’ is left running for days. (Possibly correlated with certain
platforms, many transactions, and/or large numbers of other files platforms, many transactions, and/or large numbers of other files
present). To work around, 'q'uit and restart it, or (where supported) present). To work around, ‘q’uit and restart it, or (where supported)
suspend ('CTRL-z') and restart it ('fg'). suspend (‘CTRL-z’) and restart it (‘fg’).
 
File: hledger-ui.info, Node: Debug output, Prev: Watch mode, Up: TIPS File: hledger-ui.info, Node: Debug output, Prev: Watch mode, Up: TIPS
@ -611,8 +612,8 @@ File: hledger-ui.info, Node: Debug output, Prev: Watch mode, Up: TIPS
5.2 Debug output 5.2 Debug output
================ ================
You can add '--debug[=N]' to the command line to log debug output. This You can add ‘--debug[=N]’ to the command line to log debug output. This
will be logged to the file 'hledger-ui.log' in the current directory. N will be logged to the file ‘hledger-ui.log’ in the current directory. N
ranges from 1 (least output, the default) to 9 (maximum output). ranges from 1 (least output, the default) to 9 (maximum output).
 
@ -623,33 +624,33 @@ File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: TIPS, Up: Top
*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’.
On unix computers, the default value is: '~/.hledger.journal'. On unix computers, the default value is: ‘~/.hledger.journal’.
A more typical value is something like '~/finance/YYYY.journal', A more typical value is something like ‘~/finance/YYYY.journal’,
where '~/finance' is a version-controlled finance directory and YYYY is where ‘~/finance’ is a version-controlled finance directory and YYYY is
the current year. Or, '~/finance/current.journal', where the current year. Or, ‘~/finance/current.journal’, where
current.journal is a symbolic link to YYYY.journal. current.journal is a symbolic link to YYYY.journal.
The usual way to set this permanently is to add a command to one of The usual way to set this permanently is to add a command to one of
your shell's startup files (eg '~/.profile'): your shell’s startup files (eg ‘~/.profile’):
export LEDGER_FILE=~/finance/current.journal` export LEDGER_FILE=~/finance/current.journal`
On some Mac computers, there is a more thorough way to set On some Mac computers, there is a more thorough way to set
environment variables, that will also affect applications started from environment variables, that will also affect applications started from
the GUI (eg, Emacs started from a dock icon): In the GUI (eg, Emacs started from a dock icon): In
'~/.MacOSX/environment.plist', add an entry like: ‘~/.MacOSX/environment.plist’, add an entry like:
{ {
"LEDGER_FILE" : "~/finance/current.journal" "LEDGER_FILE" : "~/finance/current.journal"
} }
For this to take effect you might need to 'killall Dock', or reboot. For this to take effect you might need to ‘killall Dock’, or reboot.
On Windows computers, the default value is probably On Windows computers, the default value is probably
'C:\Users\YOURNAME\.hledger.journal'. You can change this by running a ‘C:\Users\YOURNAME\.hledger.journal’. You can change this by running a
command like this in a powershell window (let us know if you need to be command like this in a powershell window (let us know if you need to be
an Administrator, and if this persists across a reboot): an Administrator, and if this persists across a reboot):
@ -664,10 +665,10 @@ File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
7 FILES 7 FILES
******* *******
Reads data from one or more files in hledger journal, timeclock, Reads data from one or more files in journal, timeclock, timedot, or CSV
timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or format. The default file is ‘.hledger.journal’ in your home directory;
'$HOME/.hledger.journal' (on windows, perhaps this can be overridden with one or more ‘-f FILE’ options, or the
'C:/Users/USER/.hledger.journal'). ‘LEDGER_FILE’ environment variable.
 
File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
@ -675,15 +676,15 @@ File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
8 BUGS 8 BUGS
****** ******
'-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,
@ -692,45 +693,45 @@ 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: Top221 Node: Top223
Node: OPTIONS1745 Node: OPTIONS1871
Ref: #options1843 Ref: #options1969
Node: MOUSE6927 Node: MOUSE7336
Ref: #mouse7022 Ref: #mouse7431
Node: KEYS7259 Node: KEYS7674
Ref: #keys7352 Ref: #keys7767
Node: SCREENS11414 Node: SCREENS12061
Ref: #screens11512 Ref: #screens12159
Node: Menu12198 Node: Menu12867
Ref: #menu12290 Ref: #menu12959
Node: All accounts12367 Node: All accounts13036
Ref: #all-accounts12506 Ref: #all-accounts13175
Node: Balance sheet accounts12757 Node: Balance sheet accounts13434
Ref: #balance-sheet-accounts12937 Ref: #balance-sheet-accounts13614
Node: Income statement accounts13125 Node: Income statement accounts13806
Ref: #income-statement-accounts13307 Ref: #income-statement-accounts13988
Node: Register15727 Node: Register16482
Ref: #register15864 Ref: #register16619
Node: Transaction17848 Node: Transaction18647
Ref: #transaction17971 Ref: #transaction18770
Node: Error18841 Node: Error19654
Ref: #error18935 Ref: #error19748
Node: TIPS19179 Node: TIPS19992
Ref: #tips19278 Ref: #tips20091
Node: Watch mode19320 Node: Watch mode20133
Ref: #watch-mode19427 Ref: #watch-mode20240
Node: Debug output20883 Node: Debug output21728
Ref: #debug-output20994 Ref: #debug-output21839
Node: ENVIRONMENT21206 Node: ENVIRONMENT22059
Ref: #environment21317 Ref: #environment22170
Node: FILES22702 Node: FILES23593
Ref: #files22801 Ref: #files23692
Node: BUGS23014 Node: BUGS23952
Ref: #bugs23091 Ref: #bugs24029
 
End Tag Table End Tag Table

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

@ -14,33 +14,34 @@ DESCRIPTION
This manual is for hledger's terminal interface, version 1.28.99. See This manual is for hledger's terminal interface, version 1.28.99. See
also the hledger manual for common concepts and file formats. also the hledger manual for common concepts and file formats.
hledger is a reliable, cross-platform set of programs for tracking hledger is a robust, user-friendly, cross-platform set of programs for
money, time, or any other commodity, using double-entry accounting and tracking money, time, or any other commodity, using double-entry
a simple, editable file format. hledger is inspired by and largely accounting and a simple, editable file format. hledger is inspired by
compatible with ledger(1). and largely compatible with ledger(1), and largely interconvertible
with beancount(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- limited data entry capability. It is easier than hledger's command-
line interface, and sometimes quicker and more convenient than the web line interface, and sometimes quicker and more convenient than the web
interface. interface.
Like hledger, it reads data from one or more files in hledger journal, Like hledger, it reads data from one or more files in journal, time-
timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE, clock, timedot, or CSV format. The default file is .hledger.journal in
or $HOME/.hledger.journal (on windows, perhaps your home directory; this can be overridden with one or more -f FILE
C:/Users/USER/.hledger.journal). For more about this see hledger(1), options, or the LEDGER_FILE environment variable. For more about this
hledger_journal(5) etc. see hledger(1), 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".
OPTIONS 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
@ -61,7 +62,7 @@ OPTIONS
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
@ -77,7 +78,7 @@ OPTIONS
$LEDGER_FILE or $HOME/.hledger.journal) $LEDGER_FILE or $HOME/.hledger.journal)
--rules-file=RULESFILE --rules-file=RULESFILE
Conversion rules file to use when reading CSV (default: Conversion rules file to use when reading CSV (default:
FILE.rules) FILE.rules)
--separator=CHAR --separator=CHAR
@ -96,7 +97,7 @@ OPTIONS
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:
@ -125,15 +126,15 @@ OPTIONS
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
@ -152,49 +153,49 @@ OPTIONS
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 com- convert amounts to their market value in default valuation com-
modities modities
-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 use transaction prices (recorded with @ or @@) as additional
market prices, as if they were P directives market prices, as if they were P directives
--auto apply automated posting rules to modify transactions. --auto apply automated posting rules to modify transactions.
--forecast --forecast
generate future transactions from periodic transaction rules, generate future transactions from periodic transaction rules,
for the next 6 months or till report end date. In hledger-ui, for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible. also make ordinary future transactions visible.
--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 color- output. 'auto' (default): whenever stdout seems to be a color-
supporting terminal. 'always' or 'yes': always, useful eg when supporting terminal. 'always' or 'yes': always, useful eg when
piping output into 'less -R'. 'never' or 'no': never. A 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 charac- Show prettier output, e.g. using unicode box-drawing charac-
ters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', ters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always',
'never' also work). If you provide an argument you must use 'never' also work). If you provide an argument you must use
'=', e.g. '--pretty=yes'. '=', e.g. '--pretty=yes'.
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
@ -218,11 +219,11 @@ OPTIONS
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which should A @FILE argument will be expanded to the contents of FILE, which should
contain one command line option/argument per line. (To prevent this, contain one command line option/argument per line. (To prevent this,
insert a -- argument before.) insert a -- argument before.)
MOUSE MOUSE
In most modern terminals, you can navigate through the screens with a In most modern terminals, you can navigate through the screens with a
mouse or touchpad: mouse or touchpad:
o Use mouse wheel or trackpad to scroll up and down o Use mouse wheel or trackpad to scroll up and down
@ -234,83 +235,83 @@ MOUSE
KEYS KEYS
Keyboard gives more control. Keyboard gives more control.
? shows a help dialog listing all keys. (Some of these also appear in ? shows a help dialog listing all keys. (Some of these also appear in
the quick help at the bottom of each screen.) Press ? again (or the quick help at the bottom of each screen.) Press ? again (or
ESCAPE, or LEFT, or q) to close it. The following keys work on most ESCAPE, or LEFT, or q) to close it. The following keys work on most
screens: screens:
The cursor keys navigate: RIGHT or ENTER goes deeper, LEFT returns to The cursor keys navigate: RIGHT or ENTER goes deeper, LEFT returns to
the previous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down the previous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down
through lists. Emacs-style (CTRL-p/CTRL-n/CTRL-f/CTRL-b) and VI-style through lists. Emacs-style (CTRL-p/CTRL-n/CTRL-f/CTRL-b) and VI-style
(k,j,l,h) movement keys are also supported. A tip: movement speed is (k,j,l,h) movement keys are also supported. A tip: movement speed is
limited by your keyboard repeat rate, to move faster you may want to limited by your keyboard repeat rate, to move faster you may want to
adjust it. (If you're on a mac, the karabiner app is one way to do adjust it. (If you're on a mac, the karabiner app is one way to do
that.) that.)
With shift pressed, the cursor keys adjust the report period, limiting With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown). SHIFT- the transactions to be shown (by default, all are shown). SHIFT-
DOWN/UP steps downward and upward through these standard report period DOWN/UP steps downward and upward through these standard report period
durations: year, quarter, month, week, day. Then, SHIFT-LEFT/RIGHT durations: year, quarter, month, week, day. Then, SHIFT-LEFT/RIGHT
moves to the previous/next period. T sets the report period to today. moves to the previous/next period. T sets the report period to today.
With the -w/--watch option, when viewing a "current" period (the cur- With the -w/--watch option, when viewing a "current" period (the cur-
rent day, week, month, quarter, or year), the period will move automat- rent day, week, month, quarter, or year), the period will move automat-
ically to track the current date. To set a non-standard period, you ically to track the current date. To set a non-standard period, you
can use / and a date: query. can use / and a date: query.
/ lets you set a general filter query limiting the data shown, using / lets you set a general filter query limiting the data shown, using
the same query terms as in hledger and hledger-web. While editing the the same query terms as in hledger and hledger-web. While editing the
query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set query, you can use CTRL-a/e/d/k, BS, cursor keys; press ENTER to set
it, or ESCAPEto cancel. There are also keys for quickly adjusting some it, or ESCAPEto cancel. There are also keys for quickly adjusting some
common filters like account depth and transaction status (see below). common filters like account depth and transaction status (see below).
BACKSPACE or DELETE removes all filters, showing all transactions. BACKSPACE or DELETE removes all filters, showing all transactions.
As mentioned above, by default hledger-ui hides future transactions - As mentioned above, by default hledger-ui hides future transactions -
both ordinary transactions recorded in the journal, and periodic trans- both ordinary transactions recorded in the journal, and periodic trans-
actions generated by rule. F toggles forecast mode, in which actions 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, restoring ESCAPE resets the UI state and jumps back to the top screen, restoring
the app's initial state at startup. Or, it cancels minibuffer data the app's initial state at startup. Or, it cancels minibuffer data
entry or the help dialog. entry or the help dialog.
CTRL-l redraws the screen and centers the selection if possible (selec- CTRL-l redraws the screen and centers the selection if possible (selec-
tions near the top won't be centered, since we don't scroll above the tions near the top won't be centered, since we don't scroll above the
top). top).
g reloads from the data file(s) and updates the current screen and any g reloads from the data file(s) and updates the current screen and any
previous screens. (With large files, this could cause a noticeable previous screens. (With large files, this could cause a noticeable
pause.) pause.)
I toggles balance assertion checking. Disabling balance assertions I toggles balance assertion checking. Disabling balance assertions
temporarily can be useful for troubleshooting. temporarily can be useful for troubleshooting.
a runs command-line hledger's add command, and reloads the updated a runs command-line hledger's add command, and reloads the updated
file. This allows some basic data entry. file. This allows some basic data entry.
A is like a, but runs the hledger-iadd tool, which provides a terminal A is like a, but runs the hledger-iadd tool, which provides a terminal
interface. This key will be available if hledger-iadd is installed in interface. This key will be available if hledger-iadd is installed in
$path. $path.
E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a "" E runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (emacsclient -a ""
-nw) on the journal file. With some editors (emacs, vi), the cursor -nw) on the journal file. With some editors (emacs, vi), the cursor
will be positioned at the current transaction when invoked from the will be positioned at the current transaction when invoked from the
register and transaction screens, and at the error location (if possi- register and transaction screens, and at the error location (if possi-
ble) when invoked from the error screen. ble) when invoked from the error screen.
B toggles cost mode, showing amounts in their cost's commodity (like B toggles cost mode, showing amounts in their cost's commodity (like
toggling the -B/--cost flag). toggling the -B/--cost flag).
V toggles value mode, showing amounts' current market value in their V toggles value mode, showing amounts' current market value in their
default valuation commodity (like toggling the -V/--market flag). default valuation commodity (like toggling the -V/--market flag).
Note, "current market value" means the value on the report end date if Note, "current market value" means the value on the report end date if
specified, otherwise today. To see the value on another date, you can specified, otherwise today. To see the value on another date, you can
temporarily set that as the report end date. Eg: to see a transaction temporarily set that as the report end date. Eg: to see a transaction
as it was valued on july 30, go to the accounts or register screen, as it was valued on july 30, go to the accounts or register screen,
press /, and add date:-7/30 to the query. press /, and add date:-7/30 to the query.
At most one of cost or value mode can be active at once. At most one of cost or value mode can be active at once.
There's not yet any visual reminder when cost or value mode is active; There's not yet any visual reminder when cost or value mode is active;
for now pressing b b v should reliably reset to normal mode. for now pressing b b v should reliably reset to normal mode.
q quits the application. q quits the application.
@ -318,186 +319,186 @@ KEYS
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
SCREENS SCREENS
hledger-ui shows several different screens, described below. It shows hledger-ui shows several different screens, described below. It shows
the "Balance sheet accounts" screen to start with, except in the fol- the "Balance sheet accounts" screen to start with, except in the fol-
lowing situations: lowing situations:
o If no asset/liability/equity accounts can be detected, or if an o If no asset/liability/equity accounts can be detected, or if an
account query has been given on the command line, it starts in the account query has been given on the command line, it starts in the
"All accounts" screen. "All accounts" screen.
o If a starting screen is specified with --menu/--all/--bs/--is/--reg- o If a starting screen is specified with --menu/--all/--bs/--is/--reg-
ister on the command line, it starts in that screen. ister on the command line, it starts in that screen.
From any screen you can press LEFT or ESC to navigate back to the top From any screen you can press LEFT or ESC to navigate back to the top
level "Menu" screen. level "Menu" screen.
Menu Menu
The top-most screen. From here you can navigate to three accounts The top-most screen. From here you can navigate to three accounts
screens: screens:
All accounts All accounts
This screen shows all accounts (possibly filtered by a query), and This screen shows all accounts (possibly filtered by a query), and
their end balances on the date shown in the title bar (or their balance their end balances on the date shown in the title bar (or their balance
changes in the period shown in the title bar, toggleable with H). It changes in the period shown in the title bar, toggleable with H). It
is like the hledger balance command. is like the hledger balance command.
Balance sheet accounts Balance sheet accounts
This screen shows asset, liability and equity accounts, if these can be This screen shows asset, liability and equity accounts, if these can be
detected (see account types). It always shows end balances. It is detected (see account types). It always shows end balances. It is
like the hledger balancesheetequity command. like the hledger balancesheetequity command.
Income statement accounts Income statement accounts
This screen shows revenue and expense accounts. It always shows bal- This screen shows revenue and expense accounts. It always shows bal-
ance changes. It is like the hledger incomestatement command. ance changes. It is like the hledger incomestatement command.
All of these accounts screens work in much the same way: All of these accounts screens work in much the same way:
They show accounts which have been posted to by transactions, as well They show accounts which have been posted to by transactions, as well
as accounts which have been declared with an account directive (except as accounts which have been declared with an account directive (except
for empty parent accounts). for empty parent accounts).
If you specify a query on the command line or with / in the app, they If you specify a query on the command line or with / in the app, they
show just the matched accounts, and the balances from matched transac- show just the matched accounts, and the balances from matched transac-
tions. tions.
hledger-ui shows accounts with zero balances by default (unlike com- hledger-ui shows accounts with zero balances by default (unlike com-
mand-line hledger). To hide these, press z to toggle nonzero mode. mand-line hledger). To hide these, press z to toggle nonzero mode.
Account names are shown as a flat list by default; press t to toggle Account names are shown as a flat list by default; press t to toggle
tree mode. In list mode, account balances are exclusive of subac- tree mode. In list mode, account balances are exclusive of subac-
counts, except where subaccounts are hidden by a depth limit (see counts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of subac- below). In tree mode, all account balances are inclusive of subac-
counts. counts.
To see less detail, press a number key, 1 to 9, to set a depth limit. To see less detail, press a number key, 1 to 9, to set a depth limit.
Or use - to decrease and +/= to increase the depth limit. 0 shows even Or use - to decrease and +/= to increase the depth limit. 0 shows even
less detail, collapsing all accounts to a single total. To remove the less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press depth limit, set it higher than the maximum account depth, or press
ESCAPE. ESCAPE.
H toggles between showing historical balances or period balances (on H toggles between showing historical balances or period balances (on
the "All accounts" screen). Historical balances (the default) are end- the "All accounts" screen). Historical balances (the default) are end-
ing balances at the end of the report period, taking into account all ing balances at the end of the report period, taking into account all
transactions before that date (filtered by the filter query if any), transactions before that date (filtered by the filter query if any),
including transactions before the start of the report period. In other including transactions before the start of the report period. In other
words, historical balances are what you would see on a bank statement words, historical balances are what you would see on a bank statement
for that account (unless disturbed by a filter query). Period balances for that account (unless disturbed by a filter query). Period balances
ignore transactions before the report start date, so they show the ignore transactions before the report start date, so they show the
change in balance during the report period. They are more useful eg change in balance during the report period. They are more useful eg
when viewing a time log. when viewing a time log.
U toggles filtering by unmarked status, including or excluding unmarked U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (By default, balances include all postings; toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are if you activate one or two status filters, only those postings are
included; and if you activate all three, the filter is removed.) included; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
Press RIGHT to view an account's register screen, Or, LEFT to see the Press RIGHT to view an account's register screen, Or, LEFT to see the
menu screen. menu screen.
Register Register
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows: a check register. Each line represents one transaction and shows:
o the other account(s) involved, in abbreviated form. (If there are o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected both real and virtual postings, it shows only the accounts affected
by real postings.) by real postings.)
o the overall change to the current account's balance; positive for an o the overall change to the current account's balance; positive for an
inflow to this account, negative for an outflow. inflow to this account, negative for an outflow.
o the running historical total or period total for the current account, o the running historical total or period total for the current account,
after the transaction. This can be toggled with H. Similar to the after the transaction. This can be toggled with H. Similar to the
accounts screen, the historical total is affected by transactions accounts screen, the historical total is affected by transactions
(filtered by the filter query) before the report start date, while (filtered by the filter query) before the report start date, while
the period total is not. If the historical total is not disturbed by the period total is not. If the historical total is not disturbed by
a filter query, it will be the running historical balance you would a filter query, it will be the running historical balance you would
see on a bank register for the current account. see on a bank register for the current account.
Transactions affecting this account's subaccounts will be included in Transactions affecting this account's subaccounts will be included in
the register if the accounts screen is in tree mode, or if it's in 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 mode but this account has subaccounts which are not shown due to a
depth limit. In other words, the register always shows the transac- depth limit. In other words, the register always shows the transac-
tions contributing to the balance shown on the accounts screen. Tree tions contributing to the balance shown on the accounts screen. Tree
mode/list mode can be toggled with t here also. mode/list mode can be toggled with t here also.
U toggles filtering by unmarked status, showing or hiding unmarked U toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, P toggles pending transactions, and C toggles transactions. Similarly, P toggles pending transactions, and C toggles
cleared transactions. (By default, transactions with all statuses are cleared transactions. (By default, transactions with all statuses are
shown; if you activate one or two status filters, only those transac- shown; if you activate one or two status filters, only those transac-
tions are shown; and if you activate all three, the filter is removed.) tions are shown; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
z toggles nonzero mode, in which only transactions posting a nonzero z toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com- change are shown (hledger-ui shows zero items by default, unlike com-
mand-line hledger). mand-line hledger).
Press RIGHT to view the selected transaction in detail. Press RIGHT to view the selected transaction in detail.
Transaction Transaction
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour- similar to hledger's print command and journal format (hledger_jour-
nal(5)). nal(5)).
The transaction's date(s) and any cleared flag, transaction code, The transaction's date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are description, comments, along with all of its account postings are
shown. Simple transactions have two postings, but there can be more shown. Simple transactions have two postings, but there can be more
(or in certain cases, fewer). (or in certain cases, fewer).
UP and DOWN will step through all transactions listed in the previous UP and DOWN will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary show your position within that account register. They will vary
depending on which account register you came from (remember most trans- depending on which account register you came from (remember most trans-
actions appear in multiple account registers). The #N number preceding actions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour- them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload). nal, which is a more stable id (at least until the next reload).
Error Error
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.)
TIPS TIPS
Watch mode 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 when- mode. With this flag, it will update the display automatically when-
ever changes are saved to the data files. ever 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 your
bank's online register open in a browser window, for reference; the 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 journal file open in an editor window; and hledger-ui in watch mode in
a terminal window, eg: a 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 imme- As you mark things cleared in the editor, you can see the effect imme-
diately without having to context switch. This leaves more mental diately 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.
Here are some current limitations to be aware of: Here are some current limitations to be aware of:
Changes might not be detected with certain editors, possibly including Changes might not be detected with certain editors, possibly including
Jetbrains IDEs, gedit, other Gnome applications; or on certain unusual Jetbrains IDEs, gedit, other Gnome applications; or on certain unusual
filesystems. (#1617, #911). To work around, reload manually by press- filesystems. (#1617, #911). To work around, reload manually by press-
ing g in the hledger-ui window. (Or see #1617 for another workaround, ing g in the hledger-ui window. (Or see #1617 for another workaround,
and let us know if it works for you.) and let us know if it works for you.)
CPU and memory usage can sometimes gradually increase, if hledger-ui CPU and memory usage can sometimes gradually increase, if hledger-ui
--watch is left running for days. (Possibly correlated with certain --watch is left running for days. (Possibly correlated with certain
platforms, many transactions, and/or large numbers of other files platforms, many transactions, and/or large numbers of other files
present). To work around, quit and restart it, or (where supported) present). To work around, quit and restart it, or (where supported)
suspend (CTRL-z) and restart it (fg). suspend (CTRL-z) and restart it (fg).
Debug output Debug output
You can add --debug[=N] to the command line to log debug output. This You can add --debug[=N] to the command line to log debug output. This
will be logged to the file hledger-ui.log in the current directory. N will be logged to the file hledger-ui.log in the current directory. N
ranges from 1 (least output, the default) to 9 (maximum output). ranges from 1 (least output, the default) to 9 (maximum output).
ENVIRONMENT ENVIRONMENT
@ -507,17 +508,17 @@ ENVIRONMENT
On unix computers, the default value is: ~/.hledger.journal. On unix computers, the default value is: ~/.hledger.journal.
A more typical value is something like ~/finance/YYYY.journal, where A more typical value is something like ~/finance/YYYY.journal, where
~/finance is a version-controlled finance directory and YYYY is the ~/finance is a version-controlled finance directory and YYYY is the
current year. Or, ~/finance/current.journal, where current.journal is current year. Or, ~/finance/current.journal, where current.journal is
a symbolic link to YYYY.journal. a symbolic link to YYYY.journal.
The usual way to set this permanently is to add a command to one of The usual way to set this permanently is to add a command to one of
your shell's startup files (eg ~/.profile): your shell's startup files (eg ~/.profile):
export LEDGER_FILE=~/finance/current.journal` export LEDGER_FILE=~/finance/current.journal`
On some Mac computers, there is a more thorough way to set environment On some Mac computers, there is a more thorough way to set environment
variables, that will also affect applications started from the GUI (eg, variables, that will also affect applications started from the GUI (eg,
Emacs started from a dock icon): In ~/.MacOSX/environment.plist, add an Emacs started from a dock icon): In ~/.MacOSX/environment.plist, add an
entry like: entry like:
@ -528,21 +529,21 @@ ENVIRONMENT
For this to take effect you might need to killall Dock, or reboot. For this to take effect you might need to killall Dock, or reboot.
On Windows computers, the default value is probably C:\Users\YOUR- On Windows computers, the default value is probably C:\Users\YOUR-
NAME\.hledger.journal. You can change this by running a command like NAME\.hledger.journal. You can change this by running a command like
this in a powershell window (let us know if you need to be an Adminis- this in a powershell window (let us know if you need to be an Adminis-
trator, and if this persists across a reboot): trator, and if this persists across a reboot):
> setx LEDGER_FILE "C:\Users\MyUserName\finance\2021.journal" > setx LEDGER_FILE "C:\Users\MyUserName\finance\2021.journal"
Or, change it in settings: see https://www.java.com/en/down- Or, change it in settings: see https://www.java.com/en/down-
load/help/path.html. load/help/path.html.
FILES FILES
Reads data from one or more files in hledger journal, timeclock, time- Reads data from one or more files in journal, timeclock, timedot, or
dot, or CSV format specified with -f, or $LEDGER_FILE, or CSV format. The default file is .hledger.journal in your home direc-
$HOME/.hledger.journal (on windows, perhaps tory; this can be overridden with one or more -f FILE options, or the
C:/Users/USER/.hledger.journal). LEDGER_FILE environment variable.
BUGS BUGS
-f- doesn't work (hledger-ui can't read from stdin). -f- doesn't work (hledger-ui can't read from stdin).
@ -550,13 +551,13 @@ BUGS
-V affects only the accounts screen. -V affects only the accounts screen.
When you press g, the current and all previous screens are regenerated, When you press g, the current and all previous screens are regenerated,
which may cause a noticeable pause with large files. Also there is no which may cause a noticeable pause with large files. Also there is no
visual indication that this is in progress. visual indication that this is in progress.
--watch is not yet fully robust. It works well for normal usage, but --watch is not yet fully robust. It works well for normal usage, but
many file changes in a short time (eg saving the file thousands of many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. Symp- times with an editor macro) can cause problems at least on OSX. Symp-
toms include: unresponsive UI, periodic resetting of the cursor posi- toms include: unresponsive UI, periodic resetting of the cursor posi-
tion, momentary display of parse errors, high CPU usage eventually sub- tion, momentary display of parse errors, high CPU usage eventually sub-
siding, and possibly a small but persistent build-up of CPU usage until siding, and possibly a small but persistent build-up of CPU usage until
the program is restarted. the program is restarted.
@ -567,7 +568,7 @@ BUGS
REPORTING BUGS REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger chat or Report bugs at http://bugs.hledger.org (or on the #hledger chat or
hledger mail list) hledger mail list)
@ -589,4 +590,4 @@ SEE ALSO
hledger-ui-1.28.99 December 2022 HLEDGER-UI(1) hledger-ui-1.28.99 January 2023 HLEDGER-UI(1)

2
hledger-web/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{December 2022}})m4_dnl m4_define({{_monthyear_}}, {{January 2023}})m4_dnl

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

@ -1,5 +1,5 @@
.TH "HLEDGER-WEB" "1" "December 2022" "hledger-web-1.28.99 " "hledger User Manuals" .TH "HLEDGER-WEB" "1" "January 2023" "hledger-web-1.28.99 " "hledger User Manuals"
@ -26,10 +26,11 @@ hledger-web - robust, friendly plain text accounting (Web version)
This manual is for hledger\[aq]s web interface, version 1.28.99. This manual is for hledger\[aq]s web interface, version 1.28.99.
See also the hledger manual for common concepts and file formats. See also the hledger manual for common concepts and file formats.
.PP .PP
hledger is a reliable, cross-platform set of programs for tracking hledger is a robust, user-friendly, cross-platform set of programs for
money, time, or any other commodity, using double-entry accounting and a tracking money, time, or any other commodity, using double-entry
simple, editable file format. accounting and a simple, editable file format.
hledger is inspired by and largely compatible with ledger(1). hledger is inspired by and largely compatible with ledger(1), and
largely interconvertible with beancount(1).
.PP .PP
hledger-web is a simple web application for browsing and adding hledger-web is a simple web application for browsing and adding
transactions. transactions.
@ -46,10 +47,11 @@ As a small protection against data loss when running an unprotected
instance, it writes a numbered backup of the main journal file (only) on instance, it writes a numbered backup of the main journal file (only) on
every edit. every edit.
.PP .PP
Like hledger, it reads data from one or more files in hledger journal, Like hledger, it reads data from one or more files in journal,
timeclock, timedot, or CSV format specified with \f[V]-f\f[R], or timeclock, timedot, or CSV format.
\f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows, The default file is \f[V].hledger.journal\f[R] in your home directory;
perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]). this can be overridden with one or more \f[V]-f FILE\f[R] options, or
the \f[V]LEDGER_FILE\f[R] environment variable.
For more about this see hledger(1). For more about this see hledger(1).
.PP .PP
hledger-web can be run in three modes: hledger-web can be run in three modes:
@ -661,10 +663,11 @@ Or, change it in settings: see
https://www.java.com/en/download/help/path.html. https://www.java.com/en/download/help/path.html.
.SH FILES .SH FILES
.PP .PP
Reads data from one or more files in hledger journal, timeclock, Reads data from one or more files in journal, timeclock, timedot, or CSV
timedot, or CSV format specified with \f[V]-f\f[R], or format.
\f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows, The default file is \f[V].hledger.journal\f[R] in your home directory;
perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]). this can be overridden with one or more \f[V]-f FILE\f[R] options, or
the \f[V]LEDGER_FILE\f[R] environment variable.
.SH BUGS .SH BUGS
.PP .PP
\f[V]-f-\f[R] doesn\[aq]t work (hledger-web can\[aq]t read from stdin). \f[V]-f-\f[R] doesn\[aq]t work (hledger-web can\[aq]t read from stdin).

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

@ -1,4 +1,4 @@
This is hledger-web.info, produced by makeinfo version 6.8 from stdin. This is hledger-web.info, produced by makeinfo version 7.0.1 from stdin.
INFO-DIR-SECTION User Applications INFO-DIR-SECTION User Applications
START-INFO-DIR-ENTRY START-INFO-DIR-ENTRY
@ -13,18 +13,19 @@ hledger-web(1)
hledger-web - robust, friendly plain text accounting (Web version) hledger-web - robust, friendly plain text accounting (Web version)
'hledger-web [OPTIONS] # run temporarily & browse' ‘hledger-web [OPTIONS] # run temporarily & browse’
'hledger-web --serve [OPTIONS] # run without stopping' ‘hledger-web --serve [OPTIONS] # run without stopping’
'hledger-web --serve-api [OPTIONS] # run JSON server only' ‘hledger-web --serve-api [OPTIONS] # run JSON server only’
'hledger web -- [OPTIONS] [QUERYARGS]' # start from hledger ‘hledger web -- [OPTIONS] [QUERYARGS]’ # start from hledger
This manual is for hledger's web interface, version 1.28.99. See This manual is for hledger’s web interface, version 1.28.99. See
also the hledger manual for common concepts and file formats. also the hledger manual for common concepts and file formats.
hledger is a reliable, cross-platform set of programs for tracking hledger is a robust, user-friendly, cross-platform set of programs
money, time, or any other commodity, using double-entry accounting and a for tracking money, time, or any other commodity, using double-entry
simple, editable file format. hledger is inspired by and largely accounting and a simple, editable file format. hledger is inspired by
compatible with ledger(1). and largely compatible with ledger(1), and largely interconvertible with
beancount(1).
hledger-web is a simple web application for browsing and adding hledger-web is a simple web application for browsing and adding
transactions. It provides a more user-friendly UI than the hledger CLI transactions. It provides a more user-friendly UI than the hledger CLI
@ -38,22 +39,23 @@ you should put it behind a suitable web proxy. As a small protection
against data loss when running an unprotected instance, it writes a against data loss when running an unprotected instance, it writes a
numbered 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 journal,
journal, timeclock, timedot, or CSV format specified with '-f', or timeclock, timedot, or CSV format. The default file is
'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps ‘.hledger.journal’ in your home directory; this can be overridden with
'C:/Users/USER/.hledger.journal'). For more about this see hledger(1). one or more ‘-f FILE’ options, or the ‘LEDGER_FILE’ environment
variable. For more about this see hledger(1).
hledger-web can be run in three modes: hledger-web can be run in three modes:
* Transient mode (the default): your default web browser will be • Transient mode (the default): your default web browser will be
opened to show the app if possible, and the app exits automatically opened to show the app if possible, and the app exits automatically
after two minutes of inactivity (no requests received and no open after two minutes of inactivity (no requests received and no open
browser windows viewing it). browser windows viewing it).
* With '--serve': the app runs without stopping, and without opening • With ‘--serve’: the app runs without stopping, and without opening
a browser. a browser.
* With '--serve-api': only the JSON API is served. • With ‘--serve-api’: only the JSON API is served.
In all cases hledger-web runs as a foreground process, logging In all cases hledger-web runs as a foreground process, logging
requests to stdout. requests to stdout.
@ -80,180 +82,180 @@ 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 after timeout serve and log requests, don’t browse or auto-exit after timeout
'--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 TCP socket. Implies ‘--serve’. It can only be used if the
operating 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 with them from another server for efficiency, you would set the url 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: use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal') ‘$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’.
When a reporting option appears more than once in the command line, When a reporting option appears more than once in the command line,
the last one takes precedence. the last one takes precedence.
@ -262,53 +264,53 @@ 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 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 authentication hledger-web instances behind a reverse proxy that handles authentication
for different users. The path can be derived in a predictable way, eg for different users. The path can be derived in a predictable way, eg
by using the username within the path. As an example, 'nginx' as by using the username within the path. As an example, ‘nginx’ as
reverse proxy can use the variable '$remote_user' to derive a path from reverse proxy can use the variable ‘$remote_user’ to derive a path from
the username used in a HTTP basic authentication. The following the username used in a HTTP basic authentication. The following
'proxy_pass' directive allows access to all 'hledger-web' instances that ‘proxy_pass’ directive allows access to all ‘hledger-web’ 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.
@ -323,28 +325,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
@ -352,7 +354,7 @@ 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.
@ -363,7 +365,7 @@ 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
@ -393,7 +395,7 @@ File: hledger-web.info, Node: JSON API, Next: DEBUG OUTPUT, 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
... ...
@ -409,7 +411,7 @@ $ hledger-web -f examples/sample.journal --serve-api
/accounttransactions/ACCOUNTNAME /accounttransactions/ACCOUNTNAME
Eg, all account names in the journal (similar to the accounts Eg, all account names in the journal (similar to the accounts
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
@ -450,7 +452,7 @@ $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool
"aprice": null, "aprice": null,
... ...
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 docs. understanding, see the journal docs.
@ -458,25 +460,25 @@ understanding, see the journal docs.
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 look To understand that, go to the Hledger.Web.Handler.MiscR haddock and look
at the source for the appropriate handler to see what it returns. Eg at the source for the appropriate handler to see what it returns. 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 by ‘/add’, if hledger-web was started with the ‘add’ capability (enabled by
default). The payload must be the full, exact JSON representation of a default). The payload must be the full, exact JSON representation of 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 can from hledger-web’s ‘/transactions’ or ‘/accounttransactions’, or you 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)
>>> :q >>> :q
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": "",
@ -564,7 +566,7 @@ 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
@ -585,13 +587,13 @@ File: hledger-web.info, Node: Debug output, Up: DEBUG OUTPUT
6.1 Debug output 6.1 Debug output
================ ================
You can add '--debug[=N]' to the command line to log debug output. N You can add ‘--debug[=N]’ to the command line to log debug output. N
ranges from 1 (least output, the default) to 9 (maximum output). ranges from 1 (least output, the default) to 9 (maximum output).
Typically you would start with 1 and increase until you are seeing Typically you would start with 1 and increase until you are seeing
enough. Debug output goes to stderr, interleaved with the requests enough. Debug output goes to stderr, interleaved with the requests
logged on stdout. To capture debug output in a log file instead, you logged on stdout. To capture debug output in a log file instead, you
can usually redirect stderr, eg: can usually redirect stderr, eg:
'hledger-web --debug=3 2>hledger-web.log'. ‘hledger-web --debug=3 2>hledger-web.log’.
 
File: hledger-web.info, Node: ENVIRONMENT, Next: FILES, Prev: DEBUG OUTPUT, Up: Top File: hledger-web.info, Node: ENVIRONMENT, Next: FILES, Prev: DEBUG OUTPUT, Up: Top
@ -599,33 +601,33 @@ File: hledger-web.info, Node: ENVIRONMENT, Next: FILES, Prev: DEBUG OUTPUT,
7 ENVIRONMENT 7 ENVIRONMENT
************* *************
*LEDGER_FILE* The journal file path when not specified with '-f'. *LEDGER_FILE* The journal file path when not specified with ‘-f’.
On unix computers, the default value is: '~/.hledger.journal'. On unix computers, the default value is: ‘~/.hledger.journal’.
A more typical value is something like '~/finance/YYYY.journal', A more typical value is something like ‘~/finance/YYYY.journal’,
where '~/finance' is a version-controlled finance directory and YYYY is where ‘~/finance’ is a version-controlled finance directory and YYYY is
the current year. Or, '~/finance/current.journal', where the current year. Or, ‘~/finance/current.journal’, where
current.journal is a symbolic link to YYYY.journal. current.journal is a symbolic link to YYYY.journal.
The usual way to set this permanently is to add a command to one of The usual way to set this permanently is to add a command to one of
your shell's startup files (eg '~/.profile'): your shell’s startup files (eg ‘~/.profile’):
export LEDGER_FILE=~/finance/current.journal` export LEDGER_FILE=~/finance/current.journal`
On some Mac computers, there is a more thorough way to set On some Mac computers, there is a more thorough way to set
environment variables, that will also affect applications started from environment variables, that will also affect applications started from
the GUI (eg, Emacs started from a dock icon): In the GUI (eg, Emacs started from a dock icon): In
'~/.MacOSX/environment.plist', add an entry like: ‘~/.MacOSX/environment.plist’, add an entry like:
{ {
"LEDGER_FILE" : "~/finance/current.journal" "LEDGER_FILE" : "~/finance/current.journal"
} }
For this to take effect you might need to 'killall Dock', or reboot. For this to take effect you might need to ‘killall Dock’, or reboot.
On Windows computers, the default value is probably On Windows computers, the default value is probably
'C:\Users\YOURNAME\.hledger.journal'. You can change this by running a ‘C:\Users\YOURNAME\.hledger.journal’. You can change this by running a
command like this in a powershell window (let us know if you need to be command like this in a powershell window (let us know if you need to be
an Administrator, and if this persists across a reboot): an Administrator, and if this persists across a reboot):
@ -640,10 +642,10 @@ File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
8 FILES 8 FILES
******* *******
Reads data from one or more files in hledger journal, timeclock, Reads data from one or more files in journal, timeclock, timedot, or CSV
timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or format. The default file is ‘.hledger.journal’ in your home directory;
'$HOME/.hledger.journal' (on windows, perhaps this can be overridden with one or more ‘-f FILE’ options, or the
'C:/Users/USER/.hledger.journal'). ‘LEDGER_FILE’ environment variable.
 
File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top
@ -651,7 +653,7 @@ File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top
9 BUGS 9 BUGS
****** ******
'-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.
@ -661,27 +663,27 @@ File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top
 
Tag Table: Tag Table:
Node: Top223 Node: Top225
Node: OPTIONS2585 Node: OPTIONS2727
Ref: #options2690 Ref: #options2832
Node: PERMISSIONS10089 Node: PERMISSIONS10588
Ref: #permissions10228 Ref: #permissions10727
Node: EDITING UPLOADING DOWNLOADING11440 Node: EDITING UPLOADING DOWNLOADING11985
Ref: #editing-uploading-downloading11621 Ref: #editing-uploading-downloading12166
Node: RELOADING12455 Node: RELOADING13008
Ref: #reloading12589 Ref: #reloading13142
Node: JSON API13022 Node: JSON API13575
Ref: #json-api13137 Ref: #json-api13690
Node: DEBUG OUTPUT18625 Node: DEBUG OUTPUT19222
Ref: #debug-output18750 Ref: #debug-output19347
Node: Debug output18777 Node: Debug output19374
Ref: #debug-output-118878 Ref: #debug-output-119475
Node: ENVIRONMENT19295 Node: ENVIRONMENT19900
Ref: #environment19415 Ref: #environment20020
Node: FILES20726 Node: FILES21369
Ref: #files20826 Ref: #files21469
Node: BUGS21039 Node: BUGS21729
Ref: #bugs21117 Ref: #bugs21807
 
End Tag Table End Tag Table

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

@ -16,27 +16,29 @@ DESCRIPTION
This manual is for hledger's web interface, version 1.28.99. See also This manual is for hledger's web interface, version 1.28.99. See also
the hledger manual for common concepts and file formats. the hledger manual for common concepts and file formats.
hledger is a reliable, cross-platform set of programs for tracking hledger is a robust, user-friendly, cross-platform set of programs for
money, time, or any other commodity, using double-entry accounting and tracking money, time, or any other commodity, using double-entry
a simple, editable file format. hledger is inspired by and largely accounting and a simple, editable file format. hledger is inspired by
compatible with ledger(1). and largely compatible with ledger(1), and largely interconvertible
with beancount(1).
hledger-web is a simple web application for browsing and adding trans- hledger-web is a simple web application for browsing and adding trans-
actions. It provides a more user-friendly UI than the hledger CLI or actions. It provides a more user-friendly UI than the hledger CLI or
hledger-ui TUI, showing more at once (accounts, the current account hledger-ui TUI, showing more at once (accounts, the current account
register, balance charts) and allowing history-aware data entry, inter- register, balance charts) and allowing history-aware data entry, inter-
active searching, and bookmarking. active searching, and bookmarking.
hledger-web also lets you share a journal with multiple users, or even hledger-web also lets you share a journal 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 should put it behind a suitable web proxy. As a small protection
against data loss when running an unprotected instance, it writes a against data loss when running an unprotected instance, it writes a
numbered 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 journal, Like hledger, it reads data from one or more files in journal, time-
timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE, clock, timedot, or CSV format. The default file is .hledger.journal in
or $HOME/.hledger.journal (on windows, perhaps your home directory; this can be overridden with one or more -f FILE
C:/Users/USER/.hledger.journal). For more about this see hledger(1). options, or the LEDGER_FILE environment variable. For more about this
see hledger(1).
hledger-web can be run in three modes: hledger-web can be run in three modes:
@ -567,10 +569,10 @@ ENVIRONMENT
load/help/path.html. load/help/path.html.
FILES FILES
Reads data from one or more files in hledger journal, timeclock, time- Reads data from one or more files in journal, timeclock, timedot, or
dot, or CSV format specified with -f, or $LEDGER_FILE, or CSV format. The default file is .hledger.journal in your home direc-
$HOME/.hledger.journal (on windows, perhaps tory; this can be overridden with one or more -f FILE options, or the
C:/Users/USER/.hledger.journal). LEDGER_FILE environment variable.
BUGS BUGS
-f- doesn't work (hledger-web can't read from stdin). -f- doesn't work (hledger-web can't read from stdin).
@ -606,4 +608,4 @@ SEE ALSO
hledger-web-1.28.99 December 2022 HLEDGER-WEB(1) hledger-web-1.28.99 January 2023 HLEDGER-WEB(1)

2
hledger/.date.m4
View File

@ -1,2 +1,2 @@
m4_dnl Date to show in man pages. Updated by "Shake manuals" m4_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{December 2022}})m4_dnl m4_define({{_monthyear_}}, {{January 2023}})m4_dnl

1710
hledger/hledger.1
View File

File diff suppressed because it is too large Load Diff

6043
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

3351
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff