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 2022-12-01 12:24:23 -08:00
parent a5b4d80e24
commit f3b0a1f513
13 changed files with 3515 additions and 3486 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_}}, {{November 2022}})m4_dnl m4_define({{_monthyear_}}, {{December 2022}})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_}}, {{November 2022}})m4_dnl m4_define({{_monthyear_}}, {{December 2022}})m4_dnl

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

@ -1,5 +1,5 @@
.TH "HLEDGER-UI" "1" "November 2022" "hledger-ui-1.27.99 " "hledger User Manuals" .TH "HLEDGER-UI" "1" "December 2022" "hledger-ui-1.28.99 " "hledger User Manuals"
@ -7,14 +7,14 @@
.PP .PP
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. tool.
This manual is for hledger-ui 1.27.99. This manual is for hledger-ui 1.28.99.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R] \f[V]hledger-ui [OPTIONS] [QUERYARGS]\f[R]
.PD 0 .PD 0
.P .P
.PD .PD
\f[C]hledger ui -- [OPTIONS] [QUERYARGS]\f[R] \f[V]hledger ui -- [OPTIONS] [QUERYARGS]\f[R]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
hledger is a reliable, cross-platform set of programs for tracking hledger is a reliable, cross-platform set of programs for tracking
@ -29,9 +29,9 @@ 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 hledger journal,
timeclock, timedot, or CSV format specified with \f[C]-f\f[R], or timeclock, timedot, or CSV format specified with \f[V]-f\f[R], or
\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, \f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]).
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
@ -41,155 +41,155 @@ transactions, by pressing the F key (or starting with --forecast) to
enable \[dq]forecast mode\[dq]. enable \[dq]forecast mode\[dq].
.SH OPTIONS .SH OPTIONS
.PP .PP
Note: if invoking hledger-ui as a hledger subcommand, write \f[C]--\f[R] Note: if invoking hledger-ui as a hledger subcommand, write \f[V]--\f[R]
before options as shown above. before options as shown above.
.PP .PP
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.
.TP .TP
\f[B]\f[CB]-w --watch\f[B]\f[R] \f[V]-w --watch\f[R]
watch for data and date changes and reload automatically watch for data and date changes and reload automatically
.TP .TP
\f[B]\f[CB]--theme=default|terminal|greenterm\f[B]\f[R] \f[V]--theme=default|terminal|greenterm\f[R]
use this custom display theme use this custom display theme
.TP .TP
\f[B]\f[CB]--menu\f[B]\f[R] \f[V]--menu\f[R]
start in the menu screen start in the menu screen
.TP .TP
\f[B]\f[CB]--all\f[B]\f[R] \f[V]--all\f[R]
start in the all accounts screen start in the all accounts screen
.TP .TP
\f[B]\f[CB]--bs\f[B]\f[R] \f[V]--bs\f[R]
start in the balance sheet accounts screen start in the balance sheet accounts screen
.TP .TP
\f[B]\f[CB]--is\f[B]\f[R] \f[V]--is\f[R]
start in the income statement accounts screen start in the income statement accounts screen
.TP .TP
\f[B]\f[CB]--register=ACCTREGEX\f[B]\f[R] \f[V]--register=ACCTREGEX\f[R]
start in the (first) matched account\[aq]s register screen start in the (first) matched account\[aq]s register screen
.TP .TP
\f[B]\f[CB]--change\f[B]\f[R] \f[V]--change\f[R]
show period balances (changes) at startup instead of historical balances show period balances (changes) at startup instead of historical balances
.TP .TP
\f[B]\f[CB]-l --flat\f[B]\f[R] \f[V]-l --flat\f[R]
show accounts as a flat list (default) show accounts as a flat list (default)
.TP .TP
\f[B]\f[CB]-t --tree\f[B]\f[R] \f[V]-t --tree\f[R]
show accounts as a tree show accounts as a tree
.PP .PP
hledger input options: hledger input options:
.TP .TP
\f[B]\f[CB]-f FILE --file=FILE\f[B]\f[R] \f[V]-f FILE --file=FILE\f[R]
use a different input file. use a different input file.
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or For stdin, use - (default: \f[V]$LEDGER_FILE\f[R] or
\f[C]$HOME/.hledger.journal\f[R]) \f[V]$HOME/.hledger.journal\f[R])
.TP .TP
\f[B]\f[CB]--rules-file=RULESFILE\f[B]\f[R] \f[V]--rules-file=RULESFILE\f[R]
Conversion rules file to use when reading CSV (default: FILE.rules) Conversion rules file to use when reading CSV (default: FILE.rules)
.TP .TP
\f[B]\f[CB]--separator=CHAR\f[B]\f[R] \f[V]--separator=CHAR\f[R]
Field separator to expect when reading CSV (default: \[aq],\[aq]) Field separator to expect when reading CSV (default: \[aq],\[aq])
.TP .TP
\f[B]\f[CB]--alias=OLD=NEW\f[B]\f[R] \f[V]--alias=OLD=NEW\f[R]
rename accounts named OLD to NEW rename accounts named OLD to NEW
.TP .TP
\f[B]\f[CB]--anon\f[B]\f[R] \f[V]--anon\f[R]
anonymize accounts and payees anonymize accounts and payees
.TP .TP
\f[B]\f[CB]--pivot FIELDNAME\f[B]\f[R] \f[V]--pivot FIELDNAME\f[R]
use some other field or tag for the account name use some other field or tag for the account name
.TP .TP
\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R] \f[V]-I --ignore-assertions\f[R]
disable balance assertion checks (note: does not disable balance disable balance assertion checks (note: does not disable balance
assignments) assignments)
.TP .TP
\f[B]\f[CB]-s --strict\f[B]\f[R] \f[V]-s --strict\f[R]
do extra error checking (check that all posted accounts are declared) do extra error checking (check that all posted accounts are declared)
.PP .PP
hledger reporting options: hledger reporting options:
.TP .TP
\f[B]\f[CB]-b --begin=DATE\f[B]\f[R] \f[V]-b --begin=DATE\f[R]
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)
.TP .TP
\f[B]\f[CB]-e --end=DATE\f[B]\f[R] \f[V]-e --end=DATE\f[R]
include postings/txns before this date (will be adjusted to following include postings/txns before this date (will be adjusted to following
subperiod end when using a report interval) subperiod end when using a report interval)
.TP .TP
\f[B]\f[CB]-D --daily\f[B]\f[R] \f[V]-D --daily\f[R]
multiperiod/multicolumn report by day multiperiod/multicolumn report by day
.TP .TP
\f[B]\f[CB]-W --weekly\f[B]\f[R] \f[V]-W --weekly\f[R]
multiperiod/multicolumn report by week multiperiod/multicolumn report by week
.TP .TP
\f[B]\f[CB]-M --monthly\f[B]\f[R] \f[V]-M --monthly\f[R]
multiperiod/multicolumn report by month multiperiod/multicolumn report by month
.TP .TP
\f[B]\f[CB]-Q --quarterly\f[B]\f[R] \f[V]-Q --quarterly\f[R]
multiperiod/multicolumn report by quarter multiperiod/multicolumn report by quarter
.TP .TP
\f[B]\f[CB]-Y --yearly\f[B]\f[R] \f[V]-Y --yearly\f[R]
multiperiod/multicolumn report by year multiperiod/multicolumn report by year
.TP .TP
\f[B]\f[CB]-p --period=PERIODEXP\f[B]\f[R] \f[V]-p --period=PERIODEXP\f[R]
set start date, end date, and/or reporting interval all at once using set start date, end date, and/or reporting interval all at once using
period expressions syntax period expressions syntax
.TP .TP
\f[B]\f[CB]--date2\f[B]\f[R] \f[V]--date2\f[R]
match the secondary date instead (see command help for other effects) match the secondary date instead (see command help for other effects)
.TP .TP
\f[B]\f[CB]--today=DATE\f[B]\f[R] \f[V]--today=DATE\f[R]
override today\[aq]s date (affects relative smart dates, for override today\[aq]s date (affects relative smart dates, for
tests/examples) tests/examples)
.TP .TP
\f[B]\f[CB]-U --unmarked\f[B]\f[R] \f[V]-U --unmarked\f[R]
include only unmarked postings/txns (can combine with -P or -C) include only unmarked postings/txns (can combine with -P or -C)
.TP .TP
\f[B]\f[CB]-P --pending\f[B]\f[R] \f[V]-P --pending\f[R]
include only pending postings/txns include only pending postings/txns
.TP .TP
\f[B]\f[CB]-C --cleared\f[B]\f[R] \f[V]-C --cleared\f[R]
include only cleared postings/txns include only cleared postings/txns
.TP .TP
\f[B]\f[CB]-R --real\f[B]\f[R] \f[V]-R --real\f[R]
include only non-virtual postings include only non-virtual postings
.TP .TP
\f[B]\f[CB]-NUM --depth=NUM\f[B]\f[R] \f[V]-NUM --depth=NUM\f[R]
hide/aggregate accounts or postings more than NUM levels deep hide/aggregate accounts or postings more than NUM levels deep
.TP .TP
\f[B]\f[CB]-E --empty\f[B]\f[R] \f[V]-E --empty\f[R]
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)
.TP .TP
\f[B]\f[CB]-B --cost\f[B]\f[R] \f[V]-B --cost\f[R]
convert amounts to their cost/selling amount at transaction time convert amounts to their cost/selling amount at transaction time
.TP .TP
\f[B]\f[CB]-V --market\f[B]\f[R] \f[V]-V --market\f[R]
convert amounts to their market value in default valuation commodities convert amounts to their market value in default valuation commodities
.TP .TP
\f[B]\f[CB]-X --exchange=COMM\f[B]\f[R] \f[V]-X --exchange=COMM\f[R]
convert amounts to their market value in commodity COMM convert amounts to their market value in commodity COMM
.TP .TP
\f[B]\f[CB]--value\f[B]\f[R] \f[V]--value\f[R]
convert amounts to cost or market value, more flexibly than -B/-V/-X convert amounts to cost or market value, more flexibly than -B/-V/-X
.TP .TP
\f[B]\f[CB]--infer-market-prices\f[B]\f[R] \f[V]--infer-market-prices\f[R]
use transaction prices (recorded with \[at] or \[at]\[at]) as additional use transaction prices (recorded with \[at] or \[at]\[at]) as additional
market prices, as if they were P directives market prices, as if they were P directives
.TP .TP
\f[B]\f[CB]--auto\f[B]\f[R] \f[V]--auto\f[R]
apply automated posting rules to modify transactions. apply automated posting rules to modify transactions.
.TP .TP
\f[B]\f[CB]--forecast\f[B]\f[R] \f[V]--forecast\f[R]
generate future transactions from periodic transaction rules, for the generate future transactions from periodic transaction rules, for the
next 6 months or till report end date. next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible. In hledger-ui, also make ordinary future transactions visible.
.TP .TP
\f[B]\f[CB]--commodity-style\f[B]\f[R] \f[V]--commodity-style\f[R]
Override the commodity style in the output for the specified commodity. Override the commodity style in the output for the specified commodity.
For example \[aq]EUR1.000,00\[aq]. For example \[aq]EUR1.000,00\[aq].
.TP .TP
\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R] \f[V]--color=WHEN (or --colour=WHEN)\f[R]
Should color-supporting commands use ANSI color codes in text output. Should color-supporting commands use ANSI color codes in text output.
\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting \[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting
terminal. terminal.
@ -198,7 +198,7 @@ into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq]: never. \[aq]never\[aq] or \[aq]no\[aq]: never.
A NO_COLOR environment variable overrides this. A NO_COLOR environment variable overrides this.
.TP .TP
\f[B]\f[CB]--pretty[=WHEN]\f[B]\f[R] \f[V]--pretty[=WHEN]\f[R]
Show prettier output, e.g. Show prettier output, e.g.
using unicode box-drawing characters. using unicode box-drawing characters.
Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq],
@ -213,24 +213,24 @@ Some reporting options can also be written as query arguments.
.PP .PP
hledger help options: hledger help options:
.TP .TP
\f[B]\f[CB]-h --help\f[B]\f[R] \f[V]-h --help\f[R]
show general or COMMAND help show general or COMMAND help
.TP .TP
\f[B]\f[CB]--man\f[B]\f[R] \f[V]--man\f[R]
show general or COMMAND user manual with man show general or COMMAND user manual with man
.TP .TP
\f[B]\f[CB]--info\f[B]\f[R] \f[V]--info\f[R]
show general or COMMAND user manual with info show general or COMMAND user manual with info
.TP .TP
\f[B]\f[CB]--version\f[B]\f[R] \f[V]--version\f[R]
show general or ADDONCMD version show general or ADDONCMD version
.TP .TP
\f[B]\f[CB]--debug[=N]\f[B]\f[R] \f[V]--debug[=N]\f[R]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
.PP .PP
A \[at]FILE argument will be expanded to the contents of FILE, which A \[at]FILE argument will be expanded to the contents of FILE, which
should contain one command line option/argument per line. should contain one command line option/argument per line.
(To prevent this, insert a \f[C]--\f[R] argument before.) (To prevent this, insert a \f[V]--\f[R] argument before.)
.SH MOUSE .SH MOUSE
.PP .PP
In most modern terminals, you can navigate through the screens with a In most modern terminals, you can navigate through the screens with a
@ -240,25 +240,25 @@ Use mouse wheel or trackpad to scroll up and down
.IP \[bu] 2 .IP \[bu] 2
Click on list items to go deeper Click on list items to go deeper
.IP \[bu] 2 .IP \[bu] 2
Click on the left margin (column 0), or the blank area at bottom of Click on the left margin (column 0) to go back.
screen, to go back.
.SH KEYS .SH KEYS
.PP .PP
Keyboard gives more control. Keyboard gives more control.
.PP .PP
\f[C]?\f[R] shows a help dialog listing all keys. \f[V]?\f[R] shows a help dialog listing all keys.
(Some of these also appear in the quick help at the bottom of each (Some of these also appear in the quick help at the bottom of each
screen.) Press \f[C]?\f[R] again (or \f[C]ESCAPE\f[R], or screen.)
\f[C]LEFT\f[R], or \f[C]q\f[R]) to close it. Press \f[V]?\f[R] again (or \f[V]ESCAPE\f[R], or \f[V]LEFT\f[R], or
\f[V]q\f[R]) to close it.
The following keys work on most screens: The following keys work on most screens:
.PP .PP
The cursor keys navigate: \f[C]RIGHT\f[R] or \f[C]ENTER\f[R] goes The cursor keys navigate: \f[V]RIGHT\f[R] or \f[V]ENTER\f[R] goes
deeper, \f[C]LEFT\f[R] returns to the previous screen, deeper, \f[V]LEFT\f[R] returns to the previous screen,
\f[C]UP\f[R]/\f[C]DOWN\f[R]/\f[C]PGUP\f[R]/\f[C]PGDN\f[R]/\f[C]HOME\f[R]/\f[C]END\f[R] \f[V]UP\f[R]/\f[V]DOWN\f[R]/\f[V]PGUP\f[R]/\f[V]PGDN\f[R]/\f[V]HOME\f[R]/\f[V]END\f[R]
move up and down through lists. move up and down through lists.
Emacs-style Emacs-style
(\f[C]CTRL-p\f[R]/\f[C]CTRL-n\f[R]/\f[C]CTRL-f\f[R]/\f[C]CTRL-b\f[R]) (\f[V]CTRL-p\f[R]/\f[V]CTRL-n\f[R]/\f[V]CTRL-f\f[R]/\f[V]CTRL-b\f[R])
and VI-style (\f[C]k\f[R],\f[C]j\f[R],\f[C]l\f[R],\f[C]h\f[R]) movement and VI-style (\f[V]k\f[R],\f[V]j\f[R],\f[V]l\f[R],\f[V]h\f[R]) movement
keys are also supported. keys are also supported.
A tip: movement speed is limited by your keyboard repeat rate, to move A tip: movement speed is limited by your keyboard repeat rate, to move
faster you may want to adjust it. faster you may want to adjust it.
@ -266,123 +266,123 @@ faster you may want to adjust it.
.PP .PP
With shift pressed, the cursor keys adjust the report period, limiting With shift pressed, the cursor keys adjust the report period, limiting
the transactions to be shown (by default, all are shown). the transactions to be shown (by default, all are shown).
\f[C]SHIFT-DOWN/UP\f[R] steps downward and upward through these standard \f[V]SHIFT-DOWN/UP\f[R] steps downward and upward through these standard
report period durations: year, quarter, month, week, day. report period durations: year, quarter, month, week, day.
Then, \f[C]SHIFT-LEFT/RIGHT\f[R] moves to the previous/next period. Then, \f[V]SHIFT-LEFT/RIGHT\f[R] moves to the previous/next period.
\f[C]T\f[R] sets the report period to today. \f[V]T\f[R] sets the report period to today.
With the \f[C]-w/--watch\f[R] option, when viewing a \[dq]current\[dq] With the \f[V]-w/--watch\f[R] option, when viewing a \[dq]current\[dq]
period (the current day, week, month, quarter, or year), the period will period (the current day, week, month, quarter, or year), the period will
move automatically to track the current date. move automatically to track the current date.
To set a non-standard period, you can use \f[C]/\f[R] and a To set a non-standard period, you can use \f[V]/\f[R] and a
\f[C]date:\f[R] query. \f[V]date:\f[R] query.
.PP .PP
\f[C]/\f[R] lets you set a general filter query limiting the data shown, \f[V]/\f[R] lets you set a general filter query limiting the data shown,
using the same query terms as in hledger and hledger-web. using the same query terms as in hledger and hledger-web.
While editing the query, you can use CTRL-a/e/d/k, BS, cursor keys; While editing the query, you can use CTRL-a/e/d/k, BS, cursor keys;
press \f[C]ENTER\f[R] to set it, or \f[C]ESCAPE\f[R]to cancel. press \f[V]ENTER\f[R] to set it, or \f[V]ESCAPE\f[R]to cancel.
There are also keys for quickly adjusting some common filters like There are also keys for quickly adjusting some common filters like
account depth and transaction status (see below). account depth and transaction status (see below).
\f[C]BACKSPACE\f[R] or \f[C]DELETE\f[R] removes all filters, showing all \f[V]BACKSPACE\f[R] or \f[V]DELETE\f[R] removes all filters, showing all
transactions. transactions.
.PP .PP
As mentioned above, by default hledger-ui hides future transactions - As mentioned above, by default hledger-ui hides future transactions -
both ordinary transactions recorded in the journal, and periodic both ordinary transactions recorded in the journal, and periodic
transactions generated by rule. transactions generated by rule.
\f[C]F\f[R] toggles forecast mode, in which future/forecasted \f[V]F\f[R] toggles forecast mode, in which future/forecasted
transactions are shown. transactions are shown.
.PP .PP
\f[C]ESCAPE\f[R] resets the UI state and jumps back to the top screen, \f[V]ESCAPE\f[R] resets the UI state and jumps back to the top screen,
restoring the app\[aq]s initial state at startup. restoring the app\[aq]s initial state at startup.
Or, it cancels minibuffer data entry or the help dialog. Or, it cancels minibuffer data entry or the help dialog.
.PP .PP
\f[C]CTRL-l\f[R] redraws the screen and centers the selection if \f[V]CTRL-l\f[R] redraws the screen and centers the selection if
possible (selections near the top won\[aq]t be centered, since we possible (selections near the top won\[aq]t be centered, since we
don\[aq]t scroll above the top). don\[aq]t scroll above the top).
.PP .PP
\f[C]g\f[R] reloads from the data file(s) and updates the current screen \f[V]g\f[R] reloads from the data file(s) and updates the current screen
and any previous screens. and any previous screens.
(With large files, this could cause a noticeable pause.) (With large files, this could cause a noticeable pause.)
.PP .PP
\f[C]I\f[R] toggles balance assertion checking. \f[V]I\f[R] toggles balance assertion checking.
Disabling balance assertions temporarily can be useful for Disabling balance assertions temporarily can be useful for
troubleshooting. troubleshooting.
.PP .PP
\f[C]a\f[R] runs command-line hledger\[aq]s add command, and reloads the \f[V]a\f[R] runs command-line hledger\[aq]s add command, and reloads the
updated file. updated file.
This allows some basic data entry. This allows some basic data entry.
.PP .PP
\f[C]A\f[R] is like \f[C]a\f[R], but runs the hledger-iadd tool, which \f[V]A\f[R] is like \f[V]a\f[R], but runs the hledger-iadd tool, which
provides a terminal interface. provides a terminal interface.
This key will be available if \f[C]hledger-iadd\f[R] is installed in This key will be available if \f[V]hledger-iadd\f[R] is installed in
$path. $path.
.PP .PP
\f[C]E\f[R] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default \f[V]E\f[R] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default
(\f[C]emacsclient -a \[dq]\[dq] -nw\f[R]) on the journal file. (\f[V]emacsclient -a \[dq]\[dq] -nw\f[R]) on the journal file.
With some editors (emacs, vi), the cursor will be positioned at the With some editors (emacs, vi), the cursor will be positioned at the
current transaction when invoked from the register and transaction current transaction when invoked from the register and transaction
screens, and at the error location (if possible) when invoked from the screens, and at the error location (if possible) when invoked from the
error screen. error screen.
.PP .PP
\f[C]B\f[R] toggles cost mode, showing amounts in their transaction \f[V]B\f[R] toggles cost mode, showing amounts in their transaction
price\[aq]s commodity (like toggling the \f[C]-B/--cost\f[R] flag). price\[aq]s commodity (like toggling the \f[V]-B/--cost\f[R] flag).
.PP .PP
\f[C]V\f[R] toggles value mode, showing amounts\[aq] current market \f[V]V\f[R] toggles value mode, showing amounts\[aq] current market
value in their default valuation commodity (like toggling the value in their default valuation commodity (like toggling the
\f[C]-V/--market\f[R] flag). \f[V]-V/--market\f[R] flag).
Note, \[dq]current market value\[dq] means the value on the report end Note, \[dq]current market value\[dq] means the value on the report end
date if specified, otherwise today. date if specified, otherwise today.
To see the value on another date, you can temporarily set that as the To see the value on another date, you can temporarily set that as the
report end date. report end date.
Eg: to see a transaction as it was valued on july 30, go to the accounts Eg: to see a transaction as it was valued on july 30, go to the accounts
or register screen, press \f[C]/\f[R], and add \f[C]date:-7/30\f[R] to or register screen, press \f[V]/\f[R], and add \f[V]date:-7/30\f[R] to
the query. the query.
.PP .PP
At most one of cost or value mode can be active at once. At most one of cost or value mode can be active at once.
.PP .PP
There\[aq]s not yet any visual reminder when cost or value mode is There\[aq]s not yet any visual reminder when cost or value mode is
active; for now pressing \f[C]b\f[R] \f[C]b\f[R] \f[C]v\f[R] should active; for now pressing \f[V]b\f[R] \f[V]b\f[R] \f[V]v\f[R] should
reliably reset to normal mode. reliably reset to normal mode.
.PP .PP
\f[C]q\f[R] quits the application. \f[V]q\f[R] quits the application.
.PP .PP
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
.SH SCREENS .SH SCREENS
.PP .PP
hledger-ui can show a number of different screens, described below. hledger-ui shows several different screens, described below.
It shows the Balance sheet accounts screen to start with, except in the It shows the \[dq]Balance sheet accounts\[dq] screen to start with,
following situations: except in the following situations:
.IP \[bu] 2 .IP \[bu] 2
If no asset/liability/equity accounts can be detected, or if an account If no asset/liability/equity accounts can be detected, or if an account
query has been given on the command line, it starts in the All accounts query has been given on the command line, it starts in the \[dq]All
screen. accounts\[dq] screen.
.IP \[bu] 2 .IP \[bu] 2
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 there. on the command line, it starts in that screen.
.PP .PP
From the starting screen you can press \f[C]LEFT\f[R] or \f[C]ESC\f[R] From any screen you can press \f[V]LEFT\f[R] or \f[V]ESC\f[R] to
to navigate back to the menu screen. navigate back to the top level \[dq]Menu\[dq] screen.
.SS Menu screen .SS Menu
.PP .PP
The top-most screen. The top-most screen.
From here you can navigate to three accounts screens: From here you can navigate to three accounts screens:
.SS All accounts screen .SS All accounts
.PP .PP
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 changes in the period shown in the title bar, toggleable with
\f[C]H\f[R]). \f[V]H\f[R]).
It is like the \f[C]hledger balance\f[R] command. It is like the \f[V]hledger balance\f[R] command.
.SS Balance sheet accounts screen .SS Balance sheet accounts
.PP .PP
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). detected (see account types).
It always shows end balances. It always shows end balances.
It is like the \f[C]hledger balancesheetequity\f[R] command. It is like the \f[V]hledger balancesheetequity\f[R] command.
.SS Income statement accounts screen .SS Income statement accounts
.PP .PP
This screen shows revenue and expense accounts. This screen shows revenue and expense accounts.
It always shows balance changes. It always shows balance changes.
It is like the \f[C]hledger incomestatement\f[R] command. It is like the \f[V]hledger incomestatement\f[R] command.
.PP .PP
All of these accounts screens work in much the same way: All of these accounts screens work in much the same way:
.PP .PP
@ -390,25 +390,30 @@ They show accounts which have been posted to by transactions, as well as
accounts which have been declared with an account directive (except for accounts which have been declared with an account directive (except for
empty parent accounts). empty parent accounts).
.PP .PP
If you specify a query on the command line, it shows just the matched If you specify a query on the command line or with \f[V]/\f[R] in the
accounts, and the balances from matched transactions. app, they show just the matched accounts, and the balances from matched
transactions.
.PP .PP
Account names are shown as a flat list by default; press \f[C]t\f[R] to hledger-ui shows accounts with zero balances by default (unlike
command-line hledger).
To hide these, press \f[V]z\f[R] to toggle nonzero mode.
.PP
Account names are shown as a flat list by default; press \f[V]t\f[R] to
toggle tree mode. toggle tree mode.
In list mode, account balances are exclusive of subaccounts, except In list mode, account balances are exclusive of subaccounts, except
where subaccounts are hidden by a depth limit (see below). where subaccounts are hidden by a depth limit (see below).
In tree mode, all account balances are inclusive of subaccounts. In tree mode, all account balances are inclusive of subaccounts.
.PP .PP
To see less detail, press a number key, \f[C]1\f[R] to \f[C]9\f[R], to To see less detail, press a number key, \f[V]1\f[R] to \f[V]9\f[R], to
set a depth limit. set a depth limit.
Or use \f[C]-\f[R] to decrease and \f[C]+\f[R]/\f[C]=\f[R] to increase Or use \f[V]-\f[R] to decrease and \f[V]+\f[R]/\f[V]=\f[R] to increase
the depth limit. the depth limit.
\f[C]0\f[R] shows even less detail, collapsing all accounts to a single \f[V]0\f[R] shows even less detail, collapsing all accounts to a single
total. 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 \f[C]ESCAPE\f[R]. or press \f[V]ESCAPE\f[R].
.PP .PP
\f[C]H\f[R] toggles between showing historical balances or period \f[V]H\f[R] toggles between showing historical balances or period
balances (on the \[dq]All accounts\[dq] screen). balances (on the \[dq]All accounts\[dq] screen).
Historical balances (the default) are ending balances at the end of the Historical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date report period, taking into account all transactions before that date
@ -420,23 +425,19 @@ Period balances ignore transactions before the report start date, so
they show the change in balance during the report period. they show the change in balance during the report period.
They are more useful eg when viewing a time log. They are more useful eg when viewing a time log.
.PP .PP
\f[C]U\f[R] toggles filtering by unmarked status, including or excluding \f[V]U\f[R] toggles filtering by unmarked status, including or excluding
unmarked postings in the balances. unmarked postings in the balances.
Similarly, \f[C]P\f[R] toggles pending postings, and \f[C]C\f[R] toggles Similarly, \f[V]P\f[R] toggles pending postings, and \f[V]C\f[R] toggles
cleared postings. cleared postings.
(By default, balances include all postings; if you activate one or two (By default, balances include all postings; if you activate one or two
status filters, only those postings are included; and if you activate status filters, only those postings are included; and if you activate
all three, the filter is removed.) all three, the filter is removed.)
.PP .PP
\f[C]R\f[R] toggles real mode, in which virtual postings are ignored. \f[V]R\f[R] toggles real mode, in which virtual postings are ignored.
.PP .PP
\f[C]z\f[R] toggles nonzero mode, in which only accounts with nonzero Press \f[V]RIGHT\f[R] to view an account\[aq]s register screen, Or,
balances are shown (hledger-ui shows zero items by default, unlike \f[V]LEFT\f[R] to see the menu screen.
command-line hledger). .SS Register
.PP
Press \f[C]RIGHT\f[R] to view an account\[aq]s register screen, Or,
\f[C]LEFT\f[R] to see the menu screen.
.SS Register screen
.PP .PP
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
a check register. a check register.
@ -451,7 +452,7 @@ inflow to this account, negative for an outflow.
.IP \[bu] 2 .IP \[bu] 2
the running historical total or period total for the current account, the running historical total or period total for the current account,
after the transaction. after the transaction.
This can be toggled with \f[C]H\f[R]. This can be toggled with \f[V]H\f[R].
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. date, while the period total is not.
@ -465,24 +466,24 @@ in list mode but this account has subaccounts which are not shown due to
a depth limit. a depth limit.
In other words, the register always shows the transactions contributing In other words, the register always shows the transactions contributing
to the balance shown on the accounts screen. to the balance shown on the accounts screen.
Tree mode/list mode can be toggled with \f[C]t\f[R] here also. Tree mode/list mode can be toggled with \f[V]t\f[R] here also.
.PP .PP
\f[C]U\f[R] toggles filtering by unmarked status, showing or hiding \f[V]U\f[R] toggles filtering by unmarked status, showing or hiding
unmarked transactions. unmarked transactions.
Similarly, \f[C]P\f[R] toggles pending transactions, and \f[C]C\f[R] Similarly, \f[V]P\f[R] toggles pending transactions, and \f[V]C\f[R]
toggles cleared transactions. toggles cleared transactions.
(By default, transactions with all statuses are shown; if you activate (By default, transactions with all statuses are shown; if you activate
one or two status filters, only those transactions are shown; and if you one or two status filters, only those transactions are shown; and if you
activate all three, the filter is removed.) activate all three, the filter is removed.)
.PP .PP
\f[C]R\f[R] toggles real mode, in which virtual postings are ignored. \f[V]R\f[R] toggles real mode, in which virtual postings are ignored.
.PP .PP
\f[C]z\f[R] toggles nonzero mode, in which only transactions posting a \f[V]z\f[R] 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).
.PP .PP
Press \f[C]RIGHT\f[R] to view the selected transaction in detail. Press \f[V]RIGHT\f[R] to view the selected transaction in detail.
.SS Transaction screen .SS Transaction
.PP .PP
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\[aq]s print command and journal format similar to hledger\[aq]s print command and journal format
@ -493,7 +494,7 @@ 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).
.PP .PP
\f[C]UP\f[R] and \f[C]DOWN\f[R] will step through all transactions \f[V]UP\f[R] and \f[V]DOWN\f[R] will step through all transactions
listed in the previous account register screen. listed in the previous account register screen.
In the title bar, the numbers in parentheses show your position within In the title bar, the numbers in parentheses show your position within
that account register. that account register.
@ -502,7 +503,7 @@ They will vary depending on which account register you came from
The #N number preceding them is the transaction\[aq]s position within The #N number preceding them is the transaction\[aq]s position within
the complete unfiltered journal, which is a more stable id (at least the complete unfiltered journal, which is a more stable id (at least
until the next reload). until the next reload).
.SS Error screen .SS Error
.PP .PP
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. when you press g to reload.
@ -513,7 +514,7 @@ normal operation.
.SS Watch mode .SS Watch mode
.PP .PP
One of hledger-ui\[aq]s best features is the auto-reloading One of hledger-ui\[aq]s best features is the auto-reloading
\f[C]-w/--watch\f[R] mode. \f[V]-w/--watch\f[R] mode.
With this flag, it will update the display automatically whenever With this flag, it will update the display automatically whenever
changes are saved to the data files. changes are saved to the data files.
.PP .PP
@ -537,25 +538,25 @@ toggle cleared mode, or to explore the history.
Here are some current limitations to be aware of: Here are some current limitations to be aware of:
.PP .PP
Changes might not be detected with certain editors, possibly including Changes might not be detected with certain editors, possibly including
Jetbrains IDEs, \f[C]gedit\f[R], other Gnome applications; or on certain Jetbrains IDEs, \f[V]gedit\f[R], other Gnome applications; or on certain
unusual filesystems. unusual filesystems.
(#1617, #911). (#1617, #911).
To work around, reload manually by pressing \f[C]g\f[R] in the To work around, reload manually by pressing \f[V]g\f[R] in the
hledger-ui window. hledger-ui window.
(Or see #1617 for another workaround, and let us know if it works for (Or see #1617 for another workaround, and let us know if it works for
you.) you.)
.PP .PP
CPU and memory usage can sometimes gradually increase, if CPU and memory usage can sometimes gradually increase, if
\f[C]hledger-ui --watch\f[R] is left running for days. \f[V]hledger-ui --watch\f[R] is left running for days.
(Possibly correlated with certain platforms, many transactions, and/or (Possibly correlated with certain platforms, many transactions, and/or
large numbers of other files present). large numbers of other files present).
To work around, \f[C]q\f[R]uit and restart it, or (where supported) To work around, \f[V]q\f[R]uit and restart it, or (where supported)
suspend (\f[C]CTRL-z\f[R]) and restart it (\f[C]fg\f[R]). suspend (\f[V]CTRL-z\f[R]) and restart it (\f[V]fg\f[R]).
.SS Debug output .SS Debug output
.PP .PP
You can add \f[C]--debug[=N]\f[R] to the command line to log debug You can add \f[V]--debug[=N]\f[R] to the command line to log debug
output. output.
This will be logged to the file \f[C]hledger-ui.log\f[R] in the current This will be logged to the file \f[V]hledger-ui.log\f[R] in the current
directory. directory.
N ranges from 1 (least output, the default) to 9 (maximum output). N ranges from 1 (least output, the default) to 9 (maximum output).
.SH ENVIRONMENT .SH ENVIRONMENT
@ -564,19 +565,19 @@ N ranges from 1 (least output, the default) to 9 (maximum output).
Default: the full terminal width. Default: the full terminal width.
.PP .PP
\f[B]LEDGER_FILE\f[R] The journal file path when not specified with \f[B]LEDGER_FILE\f[R] The journal file path when not specified with
\f[C]-f\f[R]. \f[V]-f\f[R].
.PP .PP
On unix computers, the default value is: On unix computers, the default value is:
\f[C]\[ti]/.hledger.journal\f[R]. \f[V]\[ti]/.hledger.journal\f[R].
.PP .PP
A more typical value is something like A more typical value is something like
\f[C]\[ti]/finance/YYYY.journal\f[R], where \f[C]\[ti]/finance\f[R] is a \f[V]\[ti]/finance/YYYY.journal\f[R], where \f[V]\[ti]/finance\f[R] is a
version-controlled finance directory and YYYY is the current year. version-controlled finance directory and YYYY is the current year.
Or, \f[C]\[ti]/finance/current.journal\f[R], where current.journal is a Or, \f[V]\[ti]/finance/current.journal\f[R], where current.journal is a
symbolic link to YYYY.journal. symbolic link to YYYY.journal.
.PP .PP
The usual way to set this permanently is to add a command to one of your The usual way to set this permanently is to add a command to one of your
shell\[aq]s startup files (eg \f[C]\[ti]/.profile\f[R]): shell\[aq]s startup files (eg \f[V]\[ti]/.profile\f[R]):
.IP .IP
.nf .nf
\f[C] \f[C]
@ -587,7 +588,7 @@ export LEDGER_FILE=\[ti]/finance/current.journal\[ga]
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 Emacs started from a dock icon): In
\f[C]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: \f[V]\[ti]/.MacOSX/environment.plist\f[R], add an entry like:
.IP .IP
.nf .nf
\f[C] \f[C]
@ -597,11 +598,11 @@ Emacs started from a dock icon): In
\f[R] \f[R]
.fi .fi
.PP .PP
For this to take effect you might need to \f[C]killall Dock\f[R], or For this to take effect you might need to \f[V]killall Dock\f[R], or
reboot. reboot.
.PP .PP
On Windows computers, the default value is probably On Windows computers, the default value is probably
\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]. \f[V]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R].
You can change this by running a command like this in a powershell You can change this by running a command like this in a powershell
window (let us know if you need to be an Administrator, and if this window (let us know if you need to be an Administrator, and if this
persists across a reboot): persists across a reboot):
@ -617,23 +618,23 @@ 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 hledger journal, timeclock,
timedot, or CSV format specified with \f[C]-f\f[R], or timedot, or CSV format specified with \f[V]-f\f[R], or
\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, \f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]).
.SH BUGS .SH BUGS
.PP .PP
The need to precede options with \f[C]--\f[R] when invoked from hledger The need to precede options with \f[V]--\f[R] when invoked from hledger
is awkward. is awkward.
.PP .PP
\f[C]-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).
.PP .PP
\f[C]-V\f[R] affects only the accounts screen. \f[V]-V\f[R] affects only the accounts screen.
.PP .PP
When you press \f[C]g\f[R], the current and all previous screens are When you press \f[V]g\f[R], the current and all previous screens are
regenerated, which may cause a noticeable pause with large files. regenerated, which may cause a noticeable pause with large files.
Also there is no visual indication that this is in progress. Also there is no visual indication that this is in progress.
.PP .PP
\f[C]--watch\f[R] is not yet fully robust. \f[V]--watch\f[R] is not yet fully robust.
It works well for normal usage, but many file changes in a short time It works well for normal usage, but many file changes in a short time
(eg saving the file thousands of times with an editor macro) can cause (eg saving the file thousands of times with an editor macro) can cause
problems at least on OSX. problems at least on OSX.
@ -643,7 +644,7 @@ subsiding, and possibly a small but persistent build-up of CPU usage
until the program is restarted. until the program is restarted.
.PP .PP
Also, if you are viewing files mounted from another machine, Also, if you are viewing files mounted from another machine,
\f[C]-w/--watch\f[R] requires that both machine clocks are roughly in \f[V]-w/--watch\f[R] requires that both machine clocks are roughly in
step. step.

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

@ -12,7 +12,7 @@ hledger-ui(1)
************* *************
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.27.99. tool. This manual is for hledger-ui 1.28.99.
'hledger-ui [OPTIONS] [QUERYARGS]' 'hledger-ui [OPTIONS] [QUERYARGS]'
'hledger ui -- [OPTIONS] [QUERYARGS]' 'hledger ui -- [OPTIONS] [QUERYARGS]'
@ -262,8 +262,7 @@ mouse or touchpad:
* Use mouse wheel or trackpad to scroll up and down * Use mouse wheel or trackpad to scroll up and down
* Click on list items to go deeper * Click on list items to go deeper
* Click on the left margin (column 0), or the blank area at bottom of * Click on the left margin (column 0) to go back.
screen, 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
@ -364,44 +363,44 @@ File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: KEYS, Up: Top
4 SCREENS 4 SCREENS
********* *********
hledger-ui can show a number of different screens, described below. It hledger-ui shows several different screens, described below. It shows
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 there. on the command line, it starts in that screen.
From the starting screen you can press 'LEFT' or 'ESC' to navigate From any screen you can press 'LEFT' or 'ESC' to navigate back to the
back to the menu screen. top level "Menu" screen.
* Menu: * Menu:
* Menu screen:: * Menu::
* All accounts screen:: * All accounts::
* Balance sheet accounts screen:: * Balance sheet accounts::
* Income statement accounts screen:: * Income statement accounts::
* Register screen:: * Register::
* Transaction screen:: * Transaction::
* Error screen:: * Error::
 
File: hledger-ui.info, Node: Menu screen, Next: All accounts screen, Up: SCREENS File: hledger-ui.info, Node: Menu, Next: All accounts, Up: SCREENS
4.1 Menu screen 4.1 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:
 
File: hledger-ui.info, Node: All accounts screen, Next: Balance sheet accounts screen, Prev: Menu screen, Up: SCREENS File: hledger-ui.info, Node: All accounts, Next: Balance sheet accounts, Prev: Menu, Up: SCREENS
4.2 All accounts screen 4.2 All accounts
======================= ================
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
@ -409,20 +408,20 @@ 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 screen, Next: Income statement accounts screen, Prev: All accounts screen, Up: SCREENS File: hledger-ui.info, Node: Balance sheet accounts, Next: Income statement accounts, Prev: All accounts, Up: SCREENS
4.3 Balance sheet accounts screen 4.3 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 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 screen, Next: Register screen, Prev: Balance sheet accounts screen, Up: SCREENS File: hledger-ui.info, Node: Income statement accounts, Next: Register, Prev: Balance sheet accounts, Up: SCREENS
4.4 Income statement accounts screen 4.4 Income statement accounts
==================================== =============================
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.
@ -433,8 +432,12 @@ 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, it shows just the matched If you specify a query on the command line or with '/' in the app,
accounts, and the balances from matched transactions. they show just the matched accounts, and the balances from matched
transactions.
hledger-ui shows accounts with zero balances by default (unlike
command-line hledger). To hide these, press 'z' to toggle nonzero mode.
Account names are shown as a flat list by default; press 't' to 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
@ -468,18 +471,14 @@ is removed.)
'R' toggles real mode, in which virtual postings are ignored. 'R' toggles real mode, in which virtual postings are ignored.
'z' toggles nonzero mode, in which only accounts with nonzero
balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger).
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.
 
File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Income statement accounts screen, Up: SCREENS File: hledger-ui.info, Node: Register, Next: Transaction, Prev: Income statement accounts, Up: SCREENS
4.5 Register screen 4.5 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:
@ -522,10 +521,10 @@ command-line hledger).
Press 'RIGHT' to view the selected transaction in detail. Press 'RIGHT' to view the selected transaction in detail.
 
File: hledger-ui.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS File: hledger-ui.info, Node: Transaction, Next: Error, Prev: Register, Up: SCREENS
4.6 Transaction screen 4.6 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 similar to hledger's print command and journal format
@ -546,10 +545,10 @@ unfiltered journal, which is a more stable id (at least until the next
reload). reload).
 
File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCREENS File: hledger-ui.info, Node: Error, Prev: Transaction, Up: SCREENS
4.7 Error screen 4.7 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
@ -703,36 +702,36 @@ Node: OPTIONS1657
Ref: #options1755 Ref: #options1755
Node: MOUSE6839 Node: MOUSE6839
Ref: #mouse6934 Ref: #mouse6934
Node: KEYS7216 Node: KEYS7171
Ref: #keys7309 Ref: #keys7264
Node: SCREENS11384 Node: SCREENS11339
Ref: #screens11482 Ref: #screens11437
Node: Menu screen12208 Node: Menu12123
Ref: #menu-screen12328 Ref: #menu12215
Node: All accounts screen12405 Node: All accounts12292
Ref: #all-accounts-screen12579 Ref: #all-accounts12431
Node: Balance sheet accounts screen12830 Node: Balance sheet accounts12682
Ref: #balance-sheet-accounts-screen13045 Ref: #balance-sheet-accounts12862
Node: Income statement accounts screen13233 Node: Income statement accounts13050
Ref: #income-statement-accounts-screen13450 Ref: #income-statement-accounts13232
Node: Register screen15861 Node: Register15652
Ref: #register-screen16033 Ref: #register15789
Node: Transaction screen18017 Node: Transaction17773
Ref: #transaction-screen18175 Ref: #transaction17896
Node: Error screen19045 Node: Error18766
Ref: #error-screen19167 Ref: #error18860
Node: TIPS19411 Node: TIPS19104
Ref: #tips19510 Ref: #tips19203
Node: Watch mode19552 Node: Watch mode19245
Ref: #watch-mode19659 Ref: #watch-mode19352
Node: Debug output21115 Node: Debug output20808
Ref: #debug-output21226 Ref: #debug-output20919
Node: ENVIRONMENT21438 Node: ENVIRONMENT21131
Ref: #environment21549 Ref: #environment21242
Node: FILES22934 Node: FILES22627
Ref: #files23033 Ref: #files22726
Node: BUGS23246 Node: BUGS22939
Ref: #bugs23323 Ref: #bugs23016
 
End Tag Table End Tag Table

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

@ -5,7 +5,7 @@ HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1)
NAME NAME
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.27.99. tool. This manual is for hledger-ui 1.28.99.
SYNOPSIS SYNOPSIS
hledger-ui [OPTIONS] [QUERYARGS] hledger-ui [OPTIONS] [QUERYARGS]
@ -227,15 +227,15 @@ MOUSE
o Click on list items to go deeper o Click on list items to go deeper
o Click on the left margin (column 0), or the blank area at bottom of o Click on the left margin (column 0) to go back.
screen, to go back.
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 ESCAPE, the quick help at the bottom of each screen.) Press ? again (or
or LEFT, or q) to close it. The following keys work on most screens: ESCAPE, or LEFT, or q) to close it. The following keys work on most
screens:
The cursor keys navigate: RIGHT or ENTER goes deeper, LEFT returns to The cursor keys navigate: RIGHT or ENTER goes deeper, LEFT returns to
the previous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down the previous screen, UP/DOWN/PGUP/PGDN/HOME/END move up and down
@ -316,36 +316,36 @@ KEYS
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
SCREENS SCREENS
hledger-ui can show a number of different screens, described below. It hledger-ui shows several different screens, described below. It shows
shows the Balance sheet accounts screen to start with, except in the the "Balance sheet accounts" screen to start with, except in the fol-
following 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 there. ister on the command line, it starts in that screen.
From the starting screen you can press LEFT or ESC to navigate back to From any screen you can press LEFT or ESC to navigate back to the top
the menu screen. level "Menu" screen.
Menu screen 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 screen 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 screen 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 screen 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.
@ -355,8 +355,12 @@ SCREENS
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, it shows just the matched If you specify a query on the command line or with / in the app, they
accounts, and the balances from matched transactions. show just the matched accounts, and the balances from matched transac-
tions.
hledger-ui shows accounts with zero balances by default (unlike com-
mand-line hledger). To hide these, press z to toggle nonzero mode.
Account names are shown as a flat list by default; press t to toggle 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-
@ -389,14 +393,10 @@ SCREENS
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line
hledger).
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 screen 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:
@ -436,7 +436,7 @@ SCREENS
Press RIGHT to view the selected transaction in detail. Press RIGHT to view the selected transaction in detail.
Transaction screen 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)).
@ -454,7 +454,7 @@ SCREENS
them is the transaction's position within the complete unfiltered jour- them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload). nal, which is a more stable id (at least until the next reload).
Error screen Error
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
@ -586,4 +586,4 @@ SEE ALSO
hledger-ui-1.27.99 November 2022 HLEDGER-UI(1) hledger-ui-1.28.99 December 2022 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_}}, {{November 2022}})m4_dnl m4_define({{_monthyear_}}, {{December 2022}})m4_dnl

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

@ -1,23 +1,23 @@
.TH "HLEDGER-WEB" "1" "November 2022" "hledger-web-1.27.99 " "hledger User Manuals" .TH "HLEDGER-WEB" "1" "December 2022" "hledger-web-1.28.99 " "hledger User Manuals"
.SH NAME .SH NAME
.PP .PP
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.27.99. This manual is for hledger-web 1.28.99.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger-web [OPTIONS] # run temporarily & browse\f[R] \f[V]hledger-web [OPTIONS] # run temporarily & browse\f[R]
.PD 0 .PD 0
.P .P
.PD .PD
\f[C]hledger-web --serve [OPTIONS] # run without stopping\f[R] \f[V]hledger-web --serve [OPTIONS] # run without stopping\f[R]
.PD 0 .PD 0
.P .P
.PD .PD
\f[C]hledger-web --serve-api [OPTIONS] # run JSON server only\f[R] \f[V]hledger-web --serve-api [OPTIONS] # run JSON server only\f[R]
.PD 0 .PD 0
.P .P
.PD .PD
@ -44,9 +44,9 @@ 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 hledger journal,
timeclock, timedot, or CSV format specified with \f[C]-f\f[R], or timeclock, timedot, or CSV format specified with \f[V]-f\f[R], or
\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, \f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]).
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:
@ -56,10 +56,10 @@ show the app if possible, and the app exits automatically after two
minutes of inactivity (no requests received and no open browser windows minutes of inactivity (no requests received and no open browser windows
viewing it). viewing it).
.IP \[bu] 2 .IP \[bu] 2
With \f[C]--serve\f[R]: the app runs without stopping, and without With \f[V]--serve\f[R]: the app runs without stopping, and without
opening a browser. opening a browser.
.IP \[bu] 2 .IP \[bu] 2
With \f[C]--serve-api\f[R]: only the JSON API is served. With \f[V]--serve-api\f[R]: only the JSON API is served.
.PP .PP
In all cases hledger-web runs as a foreground process, logging requests In all cases hledger-web runs as a foreground process, logging requests
to stdout. to stdout.
@ -71,163 +71,163 @@ These filter options are not shown in the web UI, but it will be applied
in addition to any search query entered there. in addition to any search query entered there.
.PP .PP
Note: if invoking hledger-web as a hledger subcommand, write Note: if invoking hledger-web as a hledger subcommand, write
\f[C]--\f[R] before options, as shown in the synopsis above. \f[V]--\f[R] before options, as shown in the synopsis above.
.TP .TP
\f[B]\f[CB]--serve\f[B]\f[R] \f[V]--serve\f[R]
serve and log requests, don\[aq]t browse or auto-exit after timeout serve and log requests, don\[aq]t browse or auto-exit after timeout
.TP .TP
\f[B]\f[CB]--serve-api\f[B]\f[R] \f[V]--serve-api\f[R]
like --serve, but serve only the JSON web API, without the server-side like --serve, but serve only the JSON web API, without the server-side
web UI web UI
.TP .TP
\f[B]\f[CB]--host=IPADDR\f[B]\f[R] \f[V]--host=IPADDR\f[R]
listen on this IP address (default: 127.0.0.1) listen on this IP address (default: 127.0.0.1)
.TP .TP
\f[B]\f[CB]--port=PORT\f[B]\f[R] \f[V]--port=PORT\f[R]
listen on this TCP port (default: 5000) listen on this TCP port (default: 5000)
.TP .TP
\f[B]\f[CB]--socket=SOCKETFILE\f[B]\f[R] \f[V]--socket=SOCKETFILE\f[R]
use a unix domain socket file to listen for requests instead of a TCP use a unix domain socket file to listen for requests instead of a TCP
socket. socket.
Implies \f[C]--serve\f[R]. Implies \f[V]--serve\f[R].
It can only be used if the operating system can provide this type of It can only be used if the operating system can provide this type of
socket. socket.
.TP .TP
\f[B]\f[CB]--base-url=URL\f[B]\f[R] \f[V]--base-url=URL\f[R]
set the base url (default: http://IPADDR:PORT). set the base url (default: http://IPADDR:PORT).
You would change this when sharing over the network, or integrating You would change this when sharing over the network, or integrating
within a larger website. within a larger website.
.TP .TP
\f[B]\f[CB]--file-url=URL\f[B]\f[R] \f[V]--file-url=URL\f[R]
set the static files url (default: BASEURL/static). set the static files url (default: BASEURL/static).
hledger-web normally serves static files itself, but if you wanted to hledger-web normally serves static files itself, but if you wanted to
serve them from another server for efficiency, you would set the url serve them from another server for efficiency, you would set the url
with this. with this.
.TP .TP
\f[B]\f[CB]--capabilities=CAP[,CAP..]\f[B]\f[R] \f[V]--capabilities=CAP[,CAP..]\f[R]
enable the view, add, and/or manage capabilities (default: view,add) enable the view, add, and/or manage capabilities (default: view,add)
.TP .TP
\f[B]\f[CB]--capabilities-header=HTTPHEADER\f[B]\f[R] \f[V]--capabilities-header=HTTPHEADER\f[R]
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)
.TP .TP
\f[B]\f[CB]--test\f[B]\f[R] \f[V]--test\f[R]
run hledger-web\[aq]s tests and exit. run hledger-web\[aq]s tests and exit.
hspec test runner args may follow a --, eg: hledger-web --test -- --help hspec test runner args may follow a --, eg: hledger-web --test -- --help
.PP .PP
hledger input options: hledger input options:
.TP .TP
\f[B]\f[CB]-f FILE --file=FILE\f[B]\f[R] \f[V]-f FILE --file=FILE\f[R]
use a different input file. use a different input file.
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or For stdin, use - (default: \f[V]$LEDGER_FILE\f[R] or
\f[C]$HOME/.hledger.journal\f[R]) \f[V]$HOME/.hledger.journal\f[R])
.TP .TP
\f[B]\f[CB]--rules-file=RULESFILE\f[B]\f[R] \f[V]--rules-file=RULESFILE\f[R]
Conversion rules file to use when reading CSV (default: FILE.rules) Conversion rules file to use when reading CSV (default: FILE.rules)
.TP .TP
\f[B]\f[CB]--separator=CHAR\f[B]\f[R] \f[V]--separator=CHAR\f[R]
Field separator to expect when reading CSV (default: \[aq],\[aq]) Field separator to expect when reading CSV (default: \[aq],\[aq])
.TP .TP
\f[B]\f[CB]--alias=OLD=NEW\f[B]\f[R] \f[V]--alias=OLD=NEW\f[R]
rename accounts named OLD to NEW rename accounts named OLD to NEW
.TP .TP
\f[B]\f[CB]--anon\f[B]\f[R] \f[V]--anon\f[R]
anonymize accounts and payees anonymize accounts and payees
.TP .TP
\f[B]\f[CB]--pivot FIELDNAME\f[B]\f[R] \f[V]--pivot FIELDNAME\f[R]
use some other field or tag for the account name use some other field or tag for the account name
.TP .TP
\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R] \f[V]-I --ignore-assertions\f[R]
disable balance assertion checks (note: does not disable balance disable balance assertion checks (note: does not disable balance
assignments) assignments)
.TP .TP
\f[B]\f[CB]-s --strict\f[B]\f[R] \f[V]-s --strict\f[R]
do extra error checking (check that all posted accounts are declared) do extra error checking (check that all posted accounts are declared)
.PP .PP
hledger reporting options: hledger reporting options:
.TP .TP
\f[B]\f[CB]-b --begin=DATE\f[B]\f[R] \f[V]-b --begin=DATE\f[R]
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)
.TP .TP
\f[B]\f[CB]-e --end=DATE\f[B]\f[R] \f[V]-e --end=DATE\f[R]
include postings/txns before this date (will be adjusted to following include postings/txns before this date (will be adjusted to following
subperiod end when using a report interval) subperiod end when using a report interval)
.TP .TP
\f[B]\f[CB]-D --daily\f[B]\f[R] \f[V]-D --daily\f[R]
multiperiod/multicolumn report by day multiperiod/multicolumn report by day
.TP .TP
\f[B]\f[CB]-W --weekly\f[B]\f[R] \f[V]-W --weekly\f[R]
multiperiod/multicolumn report by week multiperiod/multicolumn report by week
.TP .TP
\f[B]\f[CB]-M --monthly\f[B]\f[R] \f[V]-M --monthly\f[R]
multiperiod/multicolumn report by month multiperiod/multicolumn report by month
.TP .TP
\f[B]\f[CB]-Q --quarterly\f[B]\f[R] \f[V]-Q --quarterly\f[R]
multiperiod/multicolumn report by quarter multiperiod/multicolumn report by quarter
.TP .TP
\f[B]\f[CB]-Y --yearly\f[B]\f[R] \f[V]-Y --yearly\f[R]
multiperiod/multicolumn report by year multiperiod/multicolumn report by year
.TP .TP
\f[B]\f[CB]-p --period=PERIODEXP\f[B]\f[R] \f[V]-p --period=PERIODEXP\f[R]
set start date, end date, and/or reporting interval all at once using set start date, end date, and/or reporting interval all at once using
period expressions syntax period expressions syntax
.TP .TP
\f[B]\f[CB]--date2\f[B]\f[R] \f[V]--date2\f[R]
match the secondary date instead (see command help for other effects) match the secondary date instead (see command help for other effects)
.TP .TP
\f[B]\f[CB]--today=DATE\f[B]\f[R] \f[V]--today=DATE\f[R]
override today\[aq]s date (affects relative smart dates, for override today\[aq]s date (affects relative smart dates, for
tests/examples) tests/examples)
.TP .TP
\f[B]\f[CB]-U --unmarked\f[B]\f[R] \f[V]-U --unmarked\f[R]
include only unmarked postings/txns (can combine with -P or -C) include only unmarked postings/txns (can combine with -P or -C)
.TP .TP
\f[B]\f[CB]-P --pending\f[B]\f[R] \f[V]-P --pending\f[R]
include only pending postings/txns include only pending postings/txns
.TP .TP
\f[B]\f[CB]-C --cleared\f[B]\f[R] \f[V]-C --cleared\f[R]
include only cleared postings/txns include only cleared postings/txns
.TP .TP
\f[B]\f[CB]-R --real\f[B]\f[R] \f[V]-R --real\f[R]
include only non-virtual postings include only non-virtual postings
.TP .TP
\f[B]\f[CB]-NUM --depth=NUM\f[B]\f[R] \f[V]-NUM --depth=NUM\f[R]
hide/aggregate accounts or postings more than NUM levels deep hide/aggregate accounts or postings more than NUM levels deep
.TP .TP
\f[B]\f[CB]-E --empty\f[B]\f[R] \f[V]-E --empty\f[R]
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)
.TP .TP
\f[B]\f[CB]-B --cost\f[B]\f[R] \f[V]-B --cost\f[R]
convert amounts to their cost/selling amount at transaction time convert amounts to their cost/selling amount at transaction time
.TP .TP
\f[B]\f[CB]-V --market\f[B]\f[R] \f[V]-V --market\f[R]
convert amounts to their market value in default valuation commodities convert amounts to their market value in default valuation commodities
.TP .TP
\f[B]\f[CB]-X --exchange=COMM\f[B]\f[R] \f[V]-X --exchange=COMM\f[R]
convert amounts to their market value in commodity COMM convert amounts to their market value in commodity COMM
.TP .TP
\f[B]\f[CB]--value\f[B]\f[R] \f[V]--value\f[R]
convert amounts to cost or market value, more flexibly than -B/-V/-X convert amounts to cost or market value, more flexibly than -B/-V/-X
.TP .TP
\f[B]\f[CB]--infer-market-prices\f[B]\f[R] \f[V]--infer-market-prices\f[R]
use transaction prices (recorded with \[at] or \[at]\[at]) as additional use transaction prices (recorded with \[at] or \[at]\[at]) as additional
market prices, as if they were P directives market prices, as if they were P directives
.TP .TP
\f[B]\f[CB]--auto\f[B]\f[R] \f[V]--auto\f[R]
apply automated posting rules to modify transactions. apply automated posting rules to modify transactions.
.TP .TP
\f[B]\f[CB]--forecast\f[B]\f[R] \f[V]--forecast\f[R]
generate future transactions from periodic transaction rules, for the generate future transactions from periodic transaction rules, for the
next 6 months or till report end date. next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible. In hledger-ui, also make ordinary future transactions visible.
.TP .TP
\f[B]\f[CB]--commodity-style\f[B]\f[R] \f[V]--commodity-style\f[R]
Override the commodity style in the output for the specified commodity. Override the commodity style in the output for the specified commodity.
For example \[aq]EUR1.000,00\[aq]. For example \[aq]EUR1.000,00\[aq].
.TP .TP
\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R] \f[V]--color=WHEN (or --colour=WHEN)\f[R]
Should color-supporting commands use ANSI color codes in text output. Should color-supporting commands use ANSI color codes in text output.
\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting \[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting
terminal. terminal.
@ -236,7 +236,7 @@ into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq]: never. \[aq]never\[aq] or \[aq]no\[aq]: never.
A NO_COLOR environment variable overrides this. A NO_COLOR environment variable overrides this.
.TP .TP
\f[B]\f[CB]--pretty[=WHEN]\f[B]\f[R] \f[V]--pretty[=WHEN]\f[R]
Show prettier output, e.g. Show prettier output, e.g.
using unicode box-drawing characters. using unicode box-drawing characters.
Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq],
@ -251,46 +251,46 @@ Some reporting options can also be written as query arguments.
.PP .PP
hledger help options: hledger help options:
.TP .TP
\f[B]\f[CB]-h --help\f[B]\f[R] \f[V]-h --help\f[R]
show general or COMMAND help show general or COMMAND help
.TP .TP
\f[B]\f[CB]--man\f[B]\f[R] \f[V]--man\f[R]
show general or COMMAND user manual with man show general or COMMAND user manual with man
.TP .TP
\f[B]\f[CB]--info\f[B]\f[R] \f[V]--info\f[R]
show general or COMMAND user manual with info show general or COMMAND user manual with info
.TP .TP
\f[B]\f[CB]--version\f[B]\f[R] \f[V]--version\f[R]
show general or ADDONCMD version show general or ADDONCMD version
.TP .TP
\f[B]\f[CB]--debug[=N]\f[B]\f[R] \f[V]--debug[=N]\f[R]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
.PP .PP
A \[at]FILE argument will be expanded to the contents of FILE, which A \[at]FILE argument will be expanded to the contents of FILE, which
should contain one command line option/argument per line. should contain one command line option/argument per line.
(To prevent this, insert a \f[C]--\f[R] argument before.) (To prevent this, insert a \f[V]--\f[R] argument before.)
.PP .PP
By default the server listens on IP address 127.0.0.1, accessible only By default the server listens on IP address 127.0.0.1, accessible only
to local requests. to local requests.
You can use \f[C]--host\f[R] to change this, eg \f[C]--host 0.0.0.0\f[R] You can use \f[V]--host\f[R] to change this, eg \f[V]--host 0.0.0.0\f[R]
to listen on all configured addresses. to listen on all configured addresses.
.PP .PP
Similarly, use \f[C]--port\f[R] to set a TCP port other than 5000, eg if Similarly, use \f[V]--port\f[R] to set a TCP port other than 5000, eg if
you are running multiple hledger-web instances. you are running multiple hledger-web instances.
.PP .PP
Both of these options are ignored when \f[C]--socket\f[R] is used. Both of these options are ignored when \f[V]--socket\f[R] is used.
In this case, it creates an \f[C]AF_UNIX\f[R] socket file at the In this case, it creates an \f[V]AF_UNIX\f[R] socket file at the
supplied path and uses that for communication. supplied path and uses that for communication.
This is an alternative way of running multiple hledger-web instances This is an alternative way of running multiple hledger-web instances
behind a reverse proxy that handles authentication for different users. behind a reverse proxy that handles authentication for different users.
The path can be derived in a predictable way, eg by using the username The path can be derived in a predictable way, eg by using the username
within the path. within the path.
As an example, \f[C]nginx\f[R] as reverse proxy can use the variable As an example, \f[V]nginx\f[R] as reverse proxy can use the variable
\f[C]$remote_user\f[R] to derive a path from the username used in a HTTP \f[V]$remote_user\f[R] to derive a path from the username used in a HTTP
basic authentication. basic authentication.
The following \f[C]proxy_pass\f[R] directive allows access to all The following \f[V]proxy_pass\f[R] directive allows access to all
\f[C]hledger-web\f[R] instances that created a socket in \f[V]hledger-web\f[R] instances that created a socket in
\f[C]/tmp/hledger/\f[R]: \f[V]/tmp/hledger/\f[R]:
.IP .IP
.nf .nf
\f[C] \f[C]
@ -298,14 +298,14 @@ The following \f[C]proxy_pass\f[R] directive allows access to all
\f[R] \f[R]
.fi .fi
.PP .PP
You can use \f[C]--base-url\f[R] to change the protocol, hostname, port You can use \f[V]--base-url\f[R] to change the protocol, hostname, port
and path that appear in hyperlinks, useful eg for integrating and path that appear in hyperlinks, useful eg for integrating
hledger-web within a larger website. hledger-web within a larger website.
The default is \f[C]http://HOST:PORT/\f[R] using the server\[aq]s The default is \f[V]http://HOST:PORT/\f[R] using the server\[aq]s
configured host address and TCP port (or \f[C]http://HOST\f[R] if PORT configured host address and TCP port (or \f[V]http://HOST\f[R] if PORT
is 80). is 80).
.PP .PP
With \f[C]--file-url\f[R] you can set a different base url for static With \f[V]--file-url\f[R] you can set a different base url for static
files, eg for better caching or cookie-less serving on high performance files, eg for better caching or cookie-less serving on high performance
websites. websites.
.SH PERMISSIONS .SH PERMISSIONS
@ -315,7 +315,7 @@ journal and to add new transactions, but not to change existing data.
.PP .PP
You can restrict who can reach it by You can restrict who can reach it by
.IP \[bu] 2 .IP \[bu] 2
setting the IP address it listens on (see \f[C]--host\f[R] above). setting the IP address it listens on (see \f[V]--host\f[R] above).
By default it listens on 127.0.0.1, accessible to all users on the local By default it listens on 127.0.0.1, accessible to all users on the local
machine. machine.
.IP \[bu] 2 .IP \[bu] 2
@ -325,27 +325,27 @@ custom firewall rules
.PP .PP
You can restrict what the users who reach it can do, by You can restrict what the users who reach it can do, by
.IP \[bu] 2 .IP \[bu] 2
using the \f[C]--capabilities=CAP[,CAP..]\f[R] flag when you start it, using the \f[V]--capabilities=CAP[,CAP..]\f[R] flag when you start it,
enabling one or more of the following capabilities. enabling one or more of the following capabilities.
The default value is \f[C]view,add\f[R]: The default value is \f[V]view,add\f[R]:
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
\f[C]view\f[R] - allows viewing the journal file and all included files \f[V]view\f[R] - allows viewing the journal file and all included files
.IP \[bu] 2 .IP \[bu] 2
\f[C]add\f[R] - allows adding new transactions to the main journal file \f[V]add\f[R] - allows adding new transactions to the main journal file
.IP \[bu] 2 .IP \[bu] 2
\f[C]manage\f[R] - allows editing, uploading or downloading the main or \f[V]manage\f[R] - allows editing, uploading or downloading the main or
included files included files
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
using the \f[C]--capabilities-header=HTTPHEADER\f[R] flag to specify a using the \f[V]--capabilities-header=HTTPHEADER\f[R] flag to specify a
HTTP header from which it will read capabilities to enable. HTTP header from which it will read capabilities to enable.
hledger-web on Sandstorm uses the X-Sandstorm-Permissions header to hledger-web on Sandstorm uses the X-Sandstorm-Permissions header to
integrate with Sandstorm\[aq]s permissions. integrate with Sandstorm\[aq]s permissions.
This is disabled by default. This is disabled by default.
.SH EDITING, UPLOADING, DOWNLOADING .SH EDITING, UPLOADING, DOWNLOADING
.PP .PP
If you enable the \f[C]manage\f[R] capability mentioned above, If you enable the \f[V]manage\f[R] capability mentioned above,
you\[aq]ll see a new \[dq]spanner\[dq] button to the right of the search you\[aq]ll see a new \[dq]spanner\[dq] button to the right of the search
form. form.
Clicking this will let you edit, upload, or download the journal file or Clicking this will let you edit, upload, or download the journal file or
@ -356,9 +356,10 @@ visitor) can alter or wipe the data files.
.PP .PP
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.)
currently; if you use one, you\[aq]ll have to arrange to commit the hledger-web is not aware of version control systems, currently; if you
changes yourself (eg with a cron job or a file watcher like entr). use one, you\[aq]ll have to arrange to commit the changes yourself (eg
with a cron job or a file watcher like entr).
.PP .PP
Changes which would leave the journal file(s) unparseable or non-valid Changes which would leave the journal file(s) unparseable or non-valid
(eg with failing balance assertions) are prevented. (eg with failing balance assertions) are prevented.
@ -378,7 +379,7 @@ that both machine clocks are roughly in step.)
.PP .PP
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. be used to get data or add new transactions.
If you want the JSON API only, you can use the \f[C]--serve-api\f[R] If you want the JSON API only, you can use the \f[V]--serve-api\f[R]
flag. flag.
Eg: Eg:
.IP .IP
@ -462,19 +463,19 @@ In some cases there is outer JSON corresponding to a \[dq]Report\[dq]
type. 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. at the source for the appropriate handler to see what it returns.
Eg for \f[C]/accounttransactions\f[R] it\[aq]s getAccounttransactionsR, Eg for \f[V]/accounttransactions\f[R] it\[aq]s getAccounttransactionsR,
returning a \[dq]\f[C]accountTransactionsReport ...\f[R]\[dq]. returning a \[dq]\f[V]accountTransactionsReport ...\f[R]\[dq].
Looking up the haddock for that we can see that /accounttransactions Looking up the haddock for that we can see that /accounttransactions
returns an AccountTransactionsReport, which consists of a report title returns an AccountTransactionsReport, which consists of a report title
and a list of AccountTransactionsReportItem (etc). and a list of AccountTransactionsReportItem (etc).
.PP .PP
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
\f[C]/add\f[R], if hledger-web was started with the \f[C]add\f[R] \f[V]/add\f[R], if hledger-web was started with the \f[V]add\f[R]
capability (enabled by default). capability (enabled by default).
The payload must be the full, exact JSON representation of a hledger The payload must be the full, exact JSON representation of a hledger
transaction (partial data won\[aq]t do). transaction (partial data won\[aq]t do).
You can get sample JSON from hledger-web\[aq]s \f[C]/transactions\f[R] You can get sample JSON from hledger-web\[aq]s \f[V]/transactions\f[R]
or \f[C]/accounttransactions\f[R], or you can export it with or \f[V]/accounttransactions\f[R], or you can export it with
hledger-lib, eg like so: hledger-lib, eg like so:
.IP .IP
.nf .nf
@ -589,7 +590,7 @@ $ curl http://127.0.0.1:5000/add -X PUT -H \[aq]Content-Type: application/json\[
.SH DEBUG OUTPUT .SH DEBUG OUTPUT
.SS Debug output .SS Debug output
.PP .PP
You can add \f[C]--debug[=N]\f[R] to the command line to log debug You can add \f[V]--debug[=N]\f[R] to the command line to log debug
output. output.
N ranges from 1 (least output, the default) to 9 (maximum output). N 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
@ -601,23 +602,23 @@ stderr, eg:
.PD 0 .PD 0
.P .P
.PD .PD
\f[C]hledger-web --debug=3 2>hledger-web.log\f[R]. \f[V]hledger-web --debug=3 2>hledger-web.log\f[R].
.SH ENVIRONMENT .SH ENVIRONMENT
.PP .PP
\f[B]LEDGER_FILE\f[R] The journal file path when not specified with \f[B]LEDGER_FILE\f[R] The journal file path when not specified with
\f[C]-f\f[R]. \f[V]-f\f[R].
.PP .PP
On unix computers, the default value is: On unix computers, the default value is:
\f[C]\[ti]/.hledger.journal\f[R]. \f[V]\[ti]/.hledger.journal\f[R].
.PP .PP
A more typical value is something like A more typical value is something like
\f[C]\[ti]/finance/YYYY.journal\f[R], where \f[C]\[ti]/finance\f[R] is a \f[V]\[ti]/finance/YYYY.journal\f[R], where \f[V]\[ti]/finance\f[R] is a
version-controlled finance directory and YYYY is the current year. version-controlled finance directory and YYYY is the current year.
Or, \f[C]\[ti]/finance/current.journal\f[R], where current.journal is a Or, \f[V]\[ti]/finance/current.journal\f[R], where current.journal is a
symbolic link to YYYY.journal. symbolic link to YYYY.journal.
.PP .PP
The usual way to set this permanently is to add a command to one of your The usual way to set this permanently is to add a command to one of your
shell\[aq]s startup files (eg \f[C]\[ti]/.profile\f[R]): shell\[aq]s startup files (eg \f[V]\[ti]/.profile\f[R]):
.IP .IP
.nf .nf
\f[C] \f[C]
@ -628,7 +629,7 @@ export LEDGER_FILE=\[ti]/finance/current.journal\[ga]
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 Emacs started from a dock icon): In
\f[C]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: \f[V]\[ti]/.MacOSX/environment.plist\f[R], add an entry like:
.IP .IP
.nf .nf
\f[C] \f[C]
@ -638,11 +639,11 @@ Emacs started from a dock icon): In
\f[R] \f[R]
.fi .fi
.PP .PP
For this to take effect you might need to \f[C]killall Dock\f[R], or For this to take effect you might need to \f[V]killall Dock\f[R], or
reboot. reboot.
.PP .PP
On Windows computers, the default value is probably On Windows computers, the default value is probably
\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]. \f[V]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R].
You can change this by running a command like this in a powershell You can change this by running a command like this in a powershell
window (let us know if you need to be an Administrator, and if this window (let us know if you need to be an Administrator, and if this
persists across a reboot): persists across a reboot):
@ -658,15 +659,15 @@ 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 hledger journal, timeclock,
timedot, or CSV format specified with \f[C]-f\f[R], or timedot, or CSV format specified with \f[V]-f\f[R], or
\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, \f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]).
.SH BUGS .SH BUGS
.PP .PP
The need to precede options with \f[C]--\f[R] when invoked from hledger The need to precede options with \f[V]--\f[R] when invoked from hledger
is awkward. is awkward.
.PP .PP
\f[C]-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).
.PP .PP
Query arguments and some hledger options are ignored. Query arguments and some hledger options are ignored.
.PP .PP

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

@ -12,7 +12,7 @@ hledger-web(1)
************** **************
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.27.99. This manual is for hledger-web 1.28.99.
'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'

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

@ -5,7 +5,7 @@ HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
NAME NAME
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.27.99. This manual is for hledger-web 1.28.99.
SYNOPSIS SYNOPSIS
hledger-web [OPTIONS] # run temporarily & browse hledger-web [OPTIONS] # run temporarily & browse
@ -320,7 +320,7 @@ EDITING, UPLOADING, DOWNLOADING
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, cur- full, etc.) hledger-web is not aware of version control systems, cur-
rently; if you use one, you'll have to arrange to commit the changes rently; 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).
@ -602,4 +602,4 @@ SEE ALSO
hledger-web-1.27.99 November 2022 HLEDGER-WEB(1) hledger-web-1.28.99 December 2022 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_}}, {{November 2022}})m4_dnl m4_define({{_monthyear_}}, {{December 2022}})m4_dnl

2349
hledger/hledger.1
View File

File diff suppressed because it is too large Load Diff

1111
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

2776
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff