simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-11-07 21:15:19 +03:00
Code Issues Projects Releases Wiki Activity

doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2024-05-29 14:45:29 -10:00
parent f3eba65726
commit 152b20413c
13 changed files with 8970 additions and 9555 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_define({{_monthyear_}}, {{April 2024}})m4_dnl
m4_define({{_monthyear_}}, {{May 2024}})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_define({{_monthyear_}}, {{April 2024}})m4_dnl
m4_define({{_monthyear_}}, {{May 2024}})m4_dnl

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

@ -1,5 +1,5 @@
.TH "HLEDGER\-UI" "1" "April 2024" "hledger-ui-1.33.99 " "hledger User Manuals"
.TH "HLEDGER\-UI" "1" "May 2024" "hledger-ui-1.33.99 " "hledger User Manuals"
@ -81,163 +81,89 @@ show accounts as a tree
.PP
hledger\-ui also supports many of hledger\[aq]s general options (and the
hledger manual\[aq]s command line tips also apply here):
.SS General help options
.TP
\f[CR]\-h \-\-help\f[R]
show general or COMMAND help
.TP
\f[CR]\-\-man\f[R]
show general or COMMAND user manual with man
.TP
\f[CR]\-\-info\f[R]
show general or COMMAND user manual with info
.TP
\f[CR]\-\-version\f[R]
show general or ADDONCMD version
.TP
\f[CR]\-\-debug[=N]\f[R]
show debug output (levels 1\-9, default: 1)
.SS General input options
.TP
\f[CR]\-f FILE \-\-file=FILE\f[R]
use a different input file.
For stdin, use \- (default: \f[CR]$LEDGER_FILE\f[R] or
\f[CR]$HOME/.hledger.journal\f[R])
.TP
\f[CR]\-\-rules\-file=RULESFILE\f[R]
Conversion rules file to use when reading CSV (default: FILE.rules)
.TP
\f[CR]\-\-separator=CHAR\f[R]
Field separator to expect when reading CSV (default: \[aq],\[aq])
.TP
\f[CR]\-\-alias=OLD=NEW\f[R]
rename accounts named OLD to NEW
.TP
\f[CR]\-\-pivot FIELDNAME\f[R]
use some other field or tag for the account name
.TP
\f[CR]\-I \-\-ignore\-assertions\f[R]
disable balance assertion checks (note: does not disable balance
assignments)
.TP
\f[CR]\-s \-\-strict\f[R]
do extra error checking (check that all posted accounts are declared)
.SS General reporting options
.TP
\f[CR]\-b \-\-begin=DATE\f[R]
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
.TP
\f[CR]\-e \-\-end=DATE\f[R]
include postings/txns before this date (will be adjusted to following
subperiod end when using a report interval)
.TP
\f[CR]\-D \-\-daily\f[R]
multiperiod/multicolumn report by day
.TP
\f[CR]\-W \-\-weekly\f[R]
multiperiod/multicolumn report by week
.TP
\f[CR]\-M \-\-monthly\f[R]
multiperiod/multicolumn report by month
.TP
\f[CR]\-Q \-\-quarterly\f[R]
multiperiod/multicolumn report by quarter
.TP
\f[CR]\-Y \-\-yearly\f[R]
multiperiod/multicolumn report by year
.TP
\f[CR]\-p \-\-period=PERIODEXP\f[R]
set start date, end date, and/or reporting interval all at once using
period expressions syntax
.TP
\f[CR]\-\-date2\f[R]
match the secondary date instead (see command help for other effects)
.TP
\f[CR]\-\-today=DATE\f[R]
override today\[aq]s date (affects relative smart dates, for
tests/examples)
.TP
\f[CR]\-U \-\-unmarked\f[R]
include only unmarked postings/txns (can combine with \-P or \-C)
.TP
\f[CR]\-P \-\-pending\f[R]
include only pending postings/txns
.TP
\f[CR]\-C \-\-cleared\f[R]
include only cleared postings/txns
.TP
\f[CR]\-R \-\-real\f[R]
include only non\-virtual postings
.TP
\f[CR]\-NUM \-\-depth=NUM\f[R]
hide/aggregate accounts or postings more than NUM levels deep
.TP
\f[CR]\-E \-\-empty\f[R]
show items with zero amount, normally hidden (and vice\-versa in
hledger\-ui/hledger\-web)
.TP
\f[CR]\-B \-\-cost\f[R]
convert amounts to their cost/selling amount at transaction time
.TP
\f[CR]\-V \-\-market\f[R]
convert amounts to their market value in default valuation commodities
.TP
\f[CR]\-X \-\-exchange=COMM\f[R]
convert amounts to their market value in commodity COMM
.TP
\f[CR]\-\-value\f[R]
convert amounts to cost or market value, more flexibly than \-B/\-V/\-X
.TP
\f[CR]\-\-infer\-equity\f[R]
infer conversion equity postings from costs
.TP
\f[CR]\-\-infer\-costs\f[R]
infer costs from conversion equity postings
.TP
\f[CR]\-\-infer\-market\-prices\f[R]
use costs as additional market prices, as if they were P directives
.TP
\f[CR]\-\-forecast\f[R]
generate transactions from periodic rules,
between the latest recorded txn and 6 months from today,
or during the specified PERIOD (= is required).
Auto posting rules will be applied to these transactions as well.
Also, in hledger\-ui make future\-dated transactions visible.
.TP
\f[CR]\-\-auto\f[R]
generate extra postings by applying auto posting rules to all txns (not
just forecast txns)
.TP
\f[CR]\-\-verbose\-tags\f[R]
add visible tags indicating transactions or postings which have been
generated/modified
.TP
\f[CR]\-\-commodity\-style\f[R]
Override the commodity style in the output for the specified commodity.
For example \[aq]EUR1.000,00\[aq].
.TP
\f[CR]\-\-color=WHEN (or \-\-colour=WHEN)\f[R]
Should color\-supporting commands use ANSI color codes in text output.
\[aq]auto\[aq] (default): whenever stdout seems to be a
color\-supporting terminal.
\[aq]always\[aq] or \[aq]yes\[aq]: always, useful eg when piping output
into \[aq]less \-R\[aq].
\[aq]never\[aq] or \[aq]no\[aq]: never.
A NO_COLOR environment variable overrides this.
.TP
\f[CR]\-\-pretty[=WHEN]\f[R]
Show prettier output, e.g.
using unicode box\-drawing characters.
Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq],
\[aq]n\[aq], \[aq]always\[aq], \[aq]never\[aq] also work).
If you provide an argument you must use \[aq]=\[aq], e.g.
\[aq]\-\-pretty=yes\[aq].
.PP
When a reporting option appears more than once in the command line, the
last one takes precedence.
.PP
Some reporting options can also be written as query arguments.
.SS General options
.IP
.EX
General input/data transformation flags:
\-f \-\-file=FILE Read data from FILE, or from stdin if \-. Can be
specified more than once. If not specified, reads
from $LEDGER_FILE or $HOME/.hledger.journal.
\-\-rules\-file=RULEFILE Use conversion rules from this file for
converting subsequent CSV/SSV/TSV files. If not
specified, uses FILE.rules for each such FILE.
\-\-alias=A=B|/RGX/=RPL transform account names from A to B, or by
replacing regular expression matches
\-\-auto generate extra postings by applying auto posting
rules (\[dq]=\[dq]) to all transactions
\-\-forecast[=PERIOD] Generate extra transactions from periodic rules
(\[dq]\[ti]\[dq]), from after the latest ordinary transaction
until 6 months from now. Or, during the specified
PERIOD (the equals is required). Auto posting rules
will also be applied to these transactions. In
hledger\-ui, also make future\-dated transactions
visible at startup.
\-I \-\-ignore\-assertions don\[aq]t check balance assertions by default
\-\-infer\-costs infer conversion equity postings from costs
\-\-infer\-equity infer costs from conversion equity postings
\-\-infer\-market\-prices infer market prices from costs
\-\-pivot=TAGNAME use a different field or tag as account names
\-s \-\-strict do extra error checks (and override \-I)
\-\-verbose\-tags add tags indicating generated/modified data
General output/reporting flags (supported by some commands):
\-b \-\-begin=DATE include postings/transactions on/after this date
\-e \-\-end=DATE include postings/transactions before this date
(with a report interval, will be adjusted to
following subperiod end)
\-D \-\-daily multiperiod report with 1 day interval
\-W \-\-weekly multiperiod report with 1 week interval
\-M \-\-monthly multiperiod report with 1 month interval
\-Q \-\-quarterly multiperiod report with 1 quarter interval
\-Y \-\-yearly multiperiod report with 1 year interval
\-p \-\-period=PERIODEXP set begin date, end date, and/or report interval,
with more flexibility
\-\-today=DATE override today\[aq]s date (affects relative dates)
\-\-date2 match/use secondary dates instead (deprecated)
\-U \-\-unmarked include only unmarked postings/transactions
\-P \-\-pending include only pending postings/transactions
\-C \-\-cleared include only cleared postings/transactions
(\-U/\-P/\-C can be combined)
\-R \-\-real include only non\-virtual postings
\-\-depth=NUM or \-NUM: show only top NUM levels of accounts
\-E \-\-empty Show zero items, which are normally hidden.
In hledger\-ui & hledger\-web, do the opposite.
\-B \-\-cost show amounts converted to their cost/sale amount
\-V \-\-market Show amounts converted to their value at period
end(s) in their default valuation commodity.
Equivalent to \-\-value=end.
\-X \-\-exchange=COMM Show amounts converted to their value at period
end(s) in the specified commodity.
Equivalent to \-\-value=end,COMM.
\-\-value=WHEN[,COMM] show amounts converted to their value on the
specified date(s) in their default valuation
commodity or a specified commodity. WHEN can be:
\[aq]then\[aq]: value on transaction dates
\[aq]end\[aq]: value at period end(s)
\[aq]now\[aq]: value today
YYYY\-MM\-DD: value on given date
\-c \-\-commodity\-style=S Override a commodity\[aq]s display style.
Eg: \-c \[aq].\[aq] or \-c \[aq]1.000,00 EUR\[aq]
\-\-color=YN \-\-colour Use ANSI color codes in text output? Can be:
\[aq]yes\[aq] or \[aq]always\[aq],
\[aq]no\[aq] or \[aq]never\[aq] (a NO_COLOR env var forces this),
\[aq]auto\[aq] (the default: when using a color terminal).
\-\-pretty[=YN] Use box\-drawing characters in text output? Can be
\[aq]yes\[aq] (the default argument for \-\-pretty) or \[aq]no\[aq].
If YN is specified, the equals is required.
\-\-debug=[N] show debug output (levels 1\-9, default: 1)
General help flags:
\-h \-\-help show command line help
\-\-tldr show command examples with tldr
\-\-info show the hledger manual with info
\-\-man show the hledger manual with man
\-\-version show version information
.EE
.SH MOUSE
In most modern terminals, you can navigate through the screens with a
mouse or touchpad:
@ -375,32 +301,32 @@ Or you can use \f[CR]ESC\f[R] to return directly to the top menu screen.
You can also use a command line flag to specific a different startup
screen (\f[CR]\-\-cs\f[R], \f[CR]\-\-bs\f[R], \f[CR]\-\-is\f[R],
\f[CR]\-\-all\f[R], or \f[CR]\-\-register=ACCT\f[R]).
.SS Menu
.SS Menu screen
This is the top\-most screen.
From here you can navigate to several screens listing accounts of
various types.
Note some of these may not show anything until you have configured
account types.
.SS Cash accounts
.SS Cash accounts screen
This screen shows \[dq]cash\[dq] (ie, liquid asset) accounts (like
\f[CR]hledger balancesheet type:c\f[R]).
It always shows balances (historical ending balances on the date shown
in the title line).
.SS Balance sheet accounts
.SS Balance sheet accounts screen
This screen shows asset, liability and equity accounts (like
\f[CR]hledger balancesheetequity\f[R]).
It always shows balances.
.SS Income statement accounts
.SS Income statement accounts screen
This screen shows revenue and expense accounts (like
\f[CR]hledger incomestatement\f[R]).
It always shows changes (balance changes in the period shown in the
title line).
.SS All accounts
.SS All accounts screen
This screen shows all accounts in your journal (unless filtered by a
query; like \f[CR]hledger balance\f[R]).
It shows balances by default; you can toggle showing changes with the
\f[CR]H\f[R] key.
.SS Register
.SS Register screen
This screen shows the transactions affecting a particular account.
Each line represents one transaction, and shows:
.IP \[bu] 2
@ -454,7 +380,7 @@ nonzero change are shown (hledger\-ui shows zero items by default,
unlike command\-line hledger).
.PP
Press \f[CR]RIGHT\f[R] to view the selected transaction in detail.
.SS Transaction
.SS Transaction screen
This screen shows a single transaction, as a general journal entry,
similar to hledger\[aq]s print command and journal format
(hledger_journal(5)).
@ -485,7 +411,7 @@ must: \- press \f[CR]E\f[R], edit and save the file, then exit the
editor, returning to hledger\-ui \- press \f[CR]g\f[R] to reload the
file (or use \f[CR]\-w/\-\-watch\f[R] mode) \- press \f[CR]LEFT\f[R]
then \f[CR]RIGHT\f[R] to exit and re\-enter the transaction screen.
.SS Error
.SS Error screen
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 again to reload and resume

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

@ -103,183 +103,93 @@ hledger manual's command line tips also apply here):
* Menu:
* General help options::
* General input options::
* General reporting options::
* General options::

File: hledger-ui.info, Node: General help options, Next: General input options, Up: OPTIONS
File: hledger-ui.info, Node: General options, Up: OPTIONS
1.1 General help options
========================
1.1 General options
===================
'-h --help'
General input/data transformation flags:
-f --file=FILE Read data from FILE, or from stdin if -. Can be
specified more than once. If not specified, reads
from $LEDGER_FILE or $HOME/.hledger.journal.
--rules-file=RULEFILE Use conversion rules from this file for
converting subsequent CSV/SSV/TSV files. If not
specified, uses FILE.rules for each such FILE.
--alias=A=B|/RGX/=RPL transform account names from A to B, or by
replacing regular expression matches
--auto generate extra postings by applying auto posting
rules ("=") to all transactions
--forecast[=PERIOD] Generate extra transactions from periodic rules
("~"), from after the latest ordinary transaction
until 6 months from now. Or, during the specified
PERIOD (the equals is required). Auto posting rules
will also be applied to these transactions. In
hledger-ui, also make future-dated transactions
visible at startup.
-I --ignore-assertions don't check balance assertions by default
--infer-costs infer conversion equity postings from costs
--infer-equity infer costs from conversion equity postings
--infer-market-prices infer market prices from costs
--pivot=TAGNAME use a different field or tag as account names
-s --strict do extra error checks (and override -I)
--verbose-tags add tags indicating generated/modified data
show general or COMMAND help
'--man'
General output/reporting flags (supported by some commands):
-b --begin=DATE include postings/transactions on/after this date
-e --end=DATE include postings/transactions before this date
(with a report interval, will be adjusted to
following subperiod end)
-D --daily multiperiod report with 1 day interval
-W --weekly multiperiod report with 1 week interval
-M --monthly multiperiod report with 1 month interval
-Q --quarterly multiperiod report with 1 quarter interval
-Y --yearly multiperiod report with 1 year interval
-p --period=PERIODEXP set begin date, end date, and/or report interval,
with more flexibility
--today=DATE override today's date (affects relative dates)
--date2 match/use secondary dates instead (deprecated)
-U --unmarked include only unmarked postings/transactions
-P --pending include only pending postings/transactions
-C --cleared include only cleared postings/transactions
(-U/-P/-C can be combined)
-R --real include only non-virtual postings
--depth=NUM or -NUM: show only top NUM levels of accounts
-E --empty Show zero items, which are normally hidden.
In hledger-ui & hledger-web, do the opposite.
-B --cost show amounts converted to their cost/sale amount
-V --market Show amounts converted to their value at period
end(s) in their default valuation commodity.
Equivalent to --value=end.
-X --exchange=COMM Show amounts converted to their value at period
end(s) in the specified commodity.
Equivalent to --value=end,COMM.
--value=WHEN[,COMM] show amounts converted to their value on the
specified date(s) in their default valuation
commodity or a specified commodity. WHEN can be:
'then': value on transaction dates
'end': value at period end(s)
'now': value today
YYYY-MM-DD: value on given date
-c --commodity-style=S Override a commodity's display style.
Eg: -c '.' or -c '1.000,00 EUR'
--color=YN --colour Use ANSI color codes in text output? Can be:
'yes' or 'always',
'no' or 'never' (a NO_COLOR env var forces this),
'auto' (the default: when using a color terminal).
--pretty[=YN] Use box-drawing characters in text output? Can be
'yes' (the default argument for --pretty) or 'no'.
If YN is specified, the equals is required.
--debug=[N] show debug output (levels 1-9, default: 1)
show general or COMMAND user manual with man
'--info'
show general or COMMAND user manual with info
'--version'
show general or ADDONCMD version
'--debug[=N]'
show debug output (levels 1-9, default: 1)

File: hledger-ui.info, Node: General input options, Next: General reporting options, Prev: General help options, Up: OPTIONS
1.2 General input options
=========================
'-f FILE --file=FILE'
use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal')
'--rules-file=RULESFILE'
Conversion rules file to use when reading CSV (default: FILE.rules)
'--separator=CHAR'
Field separator to expect when reading CSV (default: ',')
'--alias=OLD=NEW'
rename accounts named OLD to NEW
'--pivot FIELDNAME'
use some other field or tag for the account name
'-I --ignore-assertions'
disable balance assertion checks (note: does not disable balance
assignments)
'-s --strict'
do extra error checking (check that all posted accounts are
declared)

File: hledger-ui.info, Node: General reporting options, Prev: General input options, Up: OPTIONS
1.3 General reporting options
=============================
'-b --begin=DATE'
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
'-e --end=DATE'
include postings/txns before this date (will be adjusted to
following subperiod end when using a report interval)
'-D --daily'
multiperiod/multicolumn report by day
'-W --weekly'
multiperiod/multicolumn report by week
'-M --monthly'
multiperiod/multicolumn report by month
'-Q --quarterly'
multiperiod/multicolumn report by quarter
'-Y --yearly'
multiperiod/multicolumn report by year
'-p --period=PERIODEXP'
set start date, end date, and/or reporting interval all at once
using period expressions syntax
'--date2'
match the secondary date instead (see command help for other
effects)
'--today=DATE'
override today's date (affects relative smart dates, for
tests/examples)
'-U --unmarked'
include only unmarked postings/txns (can combine with -P or -C)
'-P --pending'
include only pending postings/txns
'-C --cleared'
include only cleared postings/txns
'-R --real'
include only non-virtual postings
'-NUM --depth=NUM'
hide/aggregate accounts or postings more than NUM levels deep
'-E --empty'
show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
'-B --cost'
convert amounts to their cost/selling amount at transaction time
'-V --market'
convert amounts to their market value in default valuation
commodities
'-X --exchange=COMM'
convert amounts to their market value in commodity COMM
'--value'
convert amounts to cost or market value, more flexibly than
-B/-V/-X
'--infer-equity'
infer conversion equity postings from costs
'--infer-costs'
infer costs from conversion equity postings
'--infer-market-prices'
use costs as additional market prices, as if they were P directives
'--forecast'
generate transactions from periodic rules, between the latest
recorded txn and 6 months from today, or during the specified
PERIOD (= is required). Auto posting rules will be applied to
these transactions as well. Also, in hledger-ui make future-dated
transactions visible.
'--auto'
generate extra postings by applying auto posting rules to all txns
(not just forecast txns)
'--verbose-tags'
add visible tags indicating transactions or postings which have
been generated/modified
'--commodity-style'
Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'.
'--color=WHEN (or --colour=WHEN)'
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a
color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
'--pretty[=WHEN]'
Show prettier output, e.g. using unicode box-drawing characters.
Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', 'never'
also work). If you provide an argument you must use '=', e.g.
'-pretty=yes'.
When a reporting option appears more than once in the command line,
the last one takes precedence.
Some reporting options can also be written as query arguments.
General help flags:
-h --help show command line help
--tldr show command examples with tldr
--info show the hledger manual with info
--man show the hledger manual with man
--version show version information

File: hledger-ui.info, Node: MOUSE, Next: KEYS, Prev: OPTIONS, Up: Top
@ -415,69 +325,69 @@ screen ('--cs', '--bs', '--is', '--all', or '--register=ACCT').
* Menu:
* Menu::
* Cash accounts::
* Balance sheet accounts::
* Income statement accounts::
* All accounts::
* Register::
* Transaction::
* Error::
* Menu screen::
* Cash accounts screen::
* Balance sheet accounts screen::
* Income statement accounts screen::
* All accounts screen::
* Register screen::
* Transaction screen::
* Error screen::

File: hledger-ui.info, Node: Menu, Next: Cash accounts, Up: SCREENS
File: hledger-ui.info, Node: Menu screen, Next: Cash accounts screen, Up: SCREENS
4.1 Menu
========
4.1 Menu screen
===============
This is the top-most screen. From here you can navigate to several
screens listing accounts of various types. Note some of these may not
show anything until you have configured account types.

File: hledger-ui.info, Node: Cash accounts, Next: Balance sheet accounts, Prev: Menu, Up: SCREENS
File: hledger-ui.info, Node: Cash accounts screen, Next: Balance sheet accounts screen, Prev: Menu screen, Up: SCREENS
4.2 Cash accounts
=================
4.2 Cash accounts screen
========================
This screen shows "cash" (ie, liquid asset) accounts (like 'hledger
balancesheet type:c'). It always shows balances (historical ending
balances on the date shown in the title line).

File: hledger-ui.info, Node: Balance sheet accounts, Next: Income statement accounts, Prev: Cash accounts, Up: SCREENS
File: hledger-ui.info, Node: Balance sheet accounts screen, Next: Income statement accounts screen, Prev: Cash accounts screen, Up: SCREENS
4.3 Balance sheet accounts
==========================
4.3 Balance sheet accounts screen
=================================
This screen shows asset, liability and equity accounts (like 'hledger
balancesheetequity'). It always shows balances.

File: hledger-ui.info, Node: Income statement accounts, Next: All accounts, Prev: Balance sheet accounts, Up: SCREENS
File: hledger-ui.info, Node: Income statement accounts screen, Next: All accounts screen, Prev: Balance sheet accounts screen, Up: SCREENS
4.4 Income statement accounts
=============================
4.4 Income statement accounts screen
====================================
This screen shows revenue and expense accounts (like 'hledger
incomestatement'). It always shows changes (balance changes in the
period shown in the title line).

File: hledger-ui.info, Node: All accounts, Next: Register, Prev: Income statement accounts, Up: SCREENS
File: hledger-ui.info, Node: All accounts screen, Next: Register screen, Prev: Income statement accounts screen, Up: SCREENS
4.5 All accounts
================
4.5 All accounts screen
=======================
This screen shows all accounts in your journal (unless filtered by a
query; like 'hledger balance'). It shows balances by default; you can
toggle showing changes with the 'H' key.

File: hledger-ui.info, Node: Register, Next: Transaction, Prev: All accounts, Up: SCREENS
File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: All accounts screen, Up: SCREENS
4.6 Register
============
4.6 Register screen
===================
This screen shows the transactions affecting a particular account. Each
line represents one transaction, and shows:
@ -529,10 +439,10 @@ command-line hledger).
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 screen, Next: Error screen, Prev: Register screen, Up: SCREENS
4.7 Transaction
===============
4.7 Transaction screen
======================
This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format
@ -564,10 +474,10 @@ reload the file (or use '-w/--watch' mode) - press 'LEFT' then 'RIGHT'
to exit and re-enter the transaction screen.

File: hledger-ui.info, Node: Error, Prev: Transaction, Up: SCREENS
File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCREENS
4.8 Error
=========
4.8 Error screen
================
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
@ -673,44 +583,40 @@ Tag Table:
Node: Top221
Node: OPTIONS1830
Ref: #options1928
Node: General help options2956
Ref: #general-help-options3105
Node: General input options3387
Ref: #general-input-options3572
Node: General reporting options4229
Ref: #general-reporting-options4393
Node: MOUSE7783
Ref: #mouse7878
Node: KEYS8115
Ref: #keys8208
Node: SCREENS12863
Ref: #screens12961
Node: Menu13541
Ref: #menu13634
Node: Cash accounts13829
Ref: #cash-accounts13971
Node: Balance sheet accounts14155
Ref: #balance-sheet-accounts14336
Node: Income statement accounts14456
Ref: #income-statement-accounts14642
Node: All accounts14806
Ref: #all-accounts14952
Node: Register15134
Ref: #register15258
Node: Transaction17542
Ref: #transaction17665
Node: Error19082
Ref: #error19176
Node: TIPS19420
Ref: #tips19519
Node: Watch mode19561
Ref: #watch-mode19668
Node: Debug output21127
Ref: #debug-output21238
Node: ENVIRONMENT21450
Ref: #environment21560
Node: BUGS21751
Ref: #bugs21834
Node: General options2895
Ref: #general-options2999
Node: MOUSE8226
Ref: #mouse8321
Node: KEYS8558
Ref: #keys8651
Node: SCREENS13306
Ref: #screens13404
Node: Menu screen14040
Ref: #menu-screen14161
Node: Cash accounts screen14356
Ref: #cash-accounts-screen14533
Node: Balance sheet accounts screen14717
Ref: #balance-sheet-accounts-screen14933
Node: Income statement accounts screen15053
Ref: #income-statement-accounts-screen15274
Node: All accounts screen15438
Ref: #all-accounts-screen15619
Node: Register screen15801
Ref: #register-screen15960
Node: Transaction screen18244
Ref: #transaction-screen18402
Node: Error screen19819
Ref: #error-screen19941
Node: TIPS20185
Ref: #tips20284
Node: Watch mode20326
Ref: #watch-mode20433
Node: Debug output21892
Ref: #debug-output22003
Node: ENVIRONMENT22215
Ref: #environment22325
Node: BUGS22516
Ref: #bugs22599

End Tag Table

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

@ -73,160 +73,86 @@ OPTIONS
hledger-ui also supports many of hledger's general options (and the
hledger manual's command line tips also apply here):
General help options
-h --help
show general or COMMAND help
General options
General input/data transformation flags:
-f --file=FILE Read data from FILE, or from stdin if -. Can be
specified more than once. If not specified, reads
from $LEDGER_FILE or $HOME/.hledger.journal.
--rules-file=RULEFILE Use conversion rules from this file for
converting subsequent CSV/SSV/TSV files. If not
specified, uses FILE.rules for each such FILE.
--alias=A=B|/RGX/=RPL transform account names from A to B, or by
replacing regular expression matches
--auto generate extra postings by applying auto posting
rules ("=") to all transactions
--forecast[=PERIOD] Generate extra transactions from periodic rules
("~"), from after the latest ordinary transaction
until 6 months from now. Or, during the specified
PERIOD (the equals is required). Auto posting rules
will also be applied to these transactions. In
hledger-ui, also make future-dated transactions
visible at startup.
-I --ignore-assertions don't check balance assertions by default
--infer-costs infer conversion equity postings from costs
--infer-equity infer costs from conversion equity postings
--infer-market-prices infer market prices from costs
--pivot=TAGNAME use a different field or tag as account names
-s --strict do extra error checks (and override -I)
--verbose-tags add tags indicating generated/modified data
--man show general or COMMAND user manual with man
General output/reporting flags (supported by some commands):
-b --begin=DATE include postings/transactions on/after this date
-e --end=DATE include postings/transactions before this date
(with a report interval, will be adjusted to
following subperiod end)
-D --daily multiperiod report with 1 day interval
-W --weekly multiperiod report with 1 week interval
-M --monthly multiperiod report with 1 month interval
-Q --quarterly multiperiod report with 1 quarter interval
-Y --yearly multiperiod report with 1 year interval
-p --period=PERIODEXP set begin date, end date, and/or report interval,
with more flexibility
--today=DATE override today's date (affects relative dates)
--date2 match/use secondary dates instead (deprecated)
-U --unmarked include only unmarked postings/transactions
-P --pending include only pending postings/transactions
-C --cleared include only cleared postings/transactions
(-U/-P/-C can be combined)
-R --real include only non-virtual postings
--depth=NUM or -NUM: show only top NUM levels of accounts
-E --empty Show zero items, which are normally hidden.
In hledger-ui & hledger-web, do the opposite.
-B --cost show amounts converted to their cost/sale amount
-V --market Show amounts converted to their value at period
end(s) in their default valuation commodity.
Equivalent to --value=end.
-X --exchange=COMM Show amounts converted to their value at period
end(s) in the specified commodity.
Equivalent to --value=end,COMM.
--value=WHEN[,COMM] show amounts converted to their value on the
specified date(s) in their default valuation
commodity or a specified commodity. WHEN can be:
'then': value on transaction dates
'end': value at period end(s)
'now': value today
YYYY-MM-DD: value on given date
-c --commodity-style=S Override a commodity's display style.
Eg: -c '.' or -c '1.000,00 EUR'
--color=YN --colour Use ANSI color codes in text output? Can be:
'yes' or 'always',
'no' or 'never' (a NO_COLOR env var forces this),
'auto' (the default: when using a color terminal).
--pretty[=YN] Use box-drawing characters in text output? Can be
'yes' (the default argument for --pretty) or 'no'.
If YN is specified, the equals is required.
--debug=[N] show debug output (levels 1-9, default: 1)
--info show general or COMMAND user manual with info
--version
show general or ADDONCMD version
--debug[=N]
show debug output (levels 1-9, default: 1)
General input options
-f FILE --file=FILE
use a different input file. For stdin, use - (default:
$LEDGER_FILE or $HOME/.hledger.journal)
--rules-file=RULESFILE
Conversion rules file to use when reading CSV (default:
FILE.rules)
--separator=CHAR
Field separator to expect when reading CSV (default: ',')
--alias=OLD=NEW
rename accounts named OLD to NEW
--pivot FIELDNAME
use some other field or tag for the account name
-I --ignore-assertions
disable balance assertion checks (note: does not disable balance
assignments)
-s --strict
do extra error checking (check that all posted accounts are de-
clared)
General reporting options
-b --begin=DATE
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
-e --end=DATE
include postings/txns before this date (will be adjusted to fol-
lowing subperiod end when using a report interval)
-D --daily
multiperiod/multicolumn report by day
-W --weekly
multiperiod/multicolumn report by week
-M --monthly
multiperiod/multicolumn report by month
-Q --quarterly
multiperiod/multicolumn report by quarter
-Y --yearly
multiperiod/multicolumn report by year
-p --period=PERIODEXP
set start date, end date, and/or reporting interval all at once
using period expressions syntax
--date2
match the secondary date instead (see command help for other ef-
fects)
--today=DATE
override today's date (affects relative smart dates, for
tests/examples)
-U --unmarked
include only unmarked postings/txns (can combine with -P or -C)
-P --pending
include only pending postings/txns
-C --cleared
include only cleared postings/txns
-R --real
include only non-virtual postings
-NUM --depth=NUM
hide/aggregate accounts or postings more than NUM levels deep
-E --empty
show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
-B --cost
convert amounts to their cost/selling amount at transaction time
-V --market
convert amounts to their market value in default valuation com-
modities
-X --exchange=COMM
convert amounts to their market value in commodity COMM
--value
convert amounts to cost or market value, more flexibly than
-B/-V/-X
--infer-equity
infer conversion equity postings from costs
--infer-costs
infer costs from conversion equity postings
--infer-market-prices
use costs as additional market prices, as if they were P direc-
tives
--forecast
generate transactions from periodic rules, between the latest
recorded txn and 6 months from today, or during the specified
PERIOD (= is required). Auto posting rules will be applied to
these transactions as well. Also, in hledger-ui make fu-
ture-dated transactions visible.
--auto generate extra postings by applying auto posting rules to all
txns (not just forecast txns)
--verbose-tags
add visible tags indicating transactions or postings which have
been generated/modified
--commodity-style
Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'.
--color=WHEN (or --colour=WHEN)
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a
color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
--pretty[=WHEN]
Show prettier output, e.g. using unicode box-drawing charac-
ters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always',
'never' also work). If you provide an argument you must use
'=', e.g. '--pretty=yes'.
When a reporting option appears more than once in the command line, the
last one takes precedence.
Some reporting options can also be written as query arguments.
General help flags:
-h --help show command line help
--tldr show command examples with tldr
--info show the hledger manual with info
--man show the hledger manual with man
--version show version information
MOUSE
In most modern terminals, you can navigate through the screens with a
@ -345,31 +271,31 @@ SCREENS
You can also use a command line flag to specific a different startup
screen (--cs, --bs, --is, --all, or --register=ACCT).
Menu
Menu screen
This is the top-most screen. From here you can navigate to several
screens listing accounts of various types. Note some of these may not
show anything until you have configured account types.
Cash accounts
Cash accounts screen
This screen shows "cash" (ie, liquid asset) accounts (like hledger bal-
ancesheet type:c). It always shows balances (historical ending bal-
ances on the date shown in the title line).
Balance sheet accounts
Balance sheet accounts screen
This screen shows asset, liability and equity accounts (like hledger
balancesheetequity). It always shows balances.
Income statement accounts
Income statement accounts screen
This screen shows revenue and expense accounts (like hledger incomes-
tatement). It always shows changes (balance changes in the period
shown in the title line).
All accounts
All accounts screen
This screen shows all accounts in your journal (unless filtered by a
query; like hledger balance). It shows balances by default; you can
toggle showing changes with the H key.
Register
Register screen
This screen shows the transactions affecting a particular account.
Each line represents one transaction, and shows:
@ -418,7 +344,7 @@ SCREENS
Press RIGHT to view the selected transaction in detail.
Transaction
Transaction screen
This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour-
nal(5)).
@ -447,7 +373,7 @@ SCREENS
file (or use -w/--watch mode) - press LEFT then RIGHT to exit and
re-enter the transaction screen.
Error
Error screen
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
again to reload and resume normal operation. (Or, you can press escape
@ -535,4 +461,4 @@ LICENSE
SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
hledger-ui-1.33.99 April 2024 HLEDGER-UI(1)
hledger-ui-1.33.99 May 2024 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_define({{_monthyear_}}, {{April 2024}})m4_dnl
m4_define({{_monthyear_}}, {{May 2024}})m4_dnl

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

@ -1,5 +1,5 @@
.TH "HLEDGER\-WEB" "1" "April 2024" "hledger-web-1.33.99 " "hledger User Manuals"
.TH "HLEDGER\-WEB" "1" "May 2024" "hledger-web-1.33.99 " "hledger User Manuals"
@ -137,163 +137,89 @@ If you see accounts which appear to have a zero balance, but cannot be
hidden with \f[CR]\-E\f[R]: these have a mixed\-cost balance which looks
like zero when costs are hidden.
Currently hledger\-web does not show costs at all.
.SS General help options
.TP
\f[CR]\-h \-\-help\f[R]
show general or COMMAND help
.TP
\f[CR]\-\-man\f[R]
show general or COMMAND user manual with man
.TP
\f[CR]\-\-info\f[R]
show general or COMMAND user manual with info
.TP
\f[CR]\-\-version\f[R]
show general or ADDONCMD version
.TP
\f[CR]\-\-debug[=N]\f[R]
show debug output (levels 1\-9, default: 1)
.SS General input options
.TP
\f[CR]\-f FILE \-\-file=FILE\f[R]
use a different input file.
For stdin, use \- (default: \f[CR]$LEDGER_FILE\f[R] or
\f[CR]$HOME/.hledger.journal\f[R])
.TP
\f[CR]\-\-rules\-file=RULESFILE\f[R]
Conversion rules file to use when reading CSV (default: FILE.rules)
.TP
\f[CR]\-\-separator=CHAR\f[R]
Field separator to expect when reading CSV (default: \[aq],\[aq])
.TP
\f[CR]\-\-alias=OLD=NEW\f[R]
rename accounts named OLD to NEW
.TP
\f[CR]\-\-pivot FIELDNAME\f[R]
use some other field or tag for the account name
.TP
\f[CR]\-I \-\-ignore\-assertions\f[R]
disable balance assertion checks (note: does not disable balance
assignments)
.TP
\f[CR]\-s \-\-strict\f[R]
do extra error checking (check that all posted accounts are declared)
.SS General reporting options
.TP
\f[CR]\-b \-\-begin=DATE\f[R]
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
.TP
\f[CR]\-e \-\-end=DATE\f[R]
include postings/txns before this date (will be adjusted to following
subperiod end when using a report interval)
.TP
\f[CR]\-D \-\-daily\f[R]
multiperiod/multicolumn report by day
.TP
\f[CR]\-W \-\-weekly\f[R]
multiperiod/multicolumn report by week
.TP
\f[CR]\-M \-\-monthly\f[R]
multiperiod/multicolumn report by month
.TP
\f[CR]\-Q \-\-quarterly\f[R]
multiperiod/multicolumn report by quarter
.TP
\f[CR]\-Y \-\-yearly\f[R]
multiperiod/multicolumn report by year
.TP
\f[CR]\-p \-\-period=PERIODEXP\f[R]
set start date, end date, and/or reporting interval all at once using
period expressions syntax
.TP
\f[CR]\-\-date2\f[R]
match the secondary date instead (see command help for other effects)
.TP
\f[CR]\-\-today=DATE\f[R]
override today\[aq]s date (affects relative smart dates, for
tests/examples)
.TP
\f[CR]\-U \-\-unmarked\f[R]
include only unmarked postings/txns (can combine with \-P or \-C)
.TP
\f[CR]\-P \-\-pending\f[R]
include only pending postings/txns
.TP
\f[CR]\-C \-\-cleared\f[R]
include only cleared postings/txns
.TP
\f[CR]\-R \-\-real\f[R]
include only non\-virtual postings
.TP
\f[CR]\-NUM \-\-depth=NUM\f[R]
hide/aggregate accounts or postings more than NUM levels deep
.TP
\f[CR]\-E \-\-empty\f[R]
show items with zero amount, normally hidden (and vice\-versa in
hledger\-ui/hledger\-web)
.TP
\f[CR]\-B \-\-cost\f[R]
convert amounts to their cost/selling amount at transaction time
.TP
\f[CR]\-V \-\-market\f[R]
convert amounts to their market value in default valuation commodities
.TP
\f[CR]\-X \-\-exchange=COMM\f[R]
convert amounts to their market value in commodity COMM
.TP
\f[CR]\-\-value\f[R]
convert amounts to cost or market value, more flexibly than \-B/\-V/\-X
.TP
\f[CR]\-\-infer\-equity\f[R]
infer conversion equity postings from costs
.TP
\f[CR]\-\-infer\-costs\f[R]
infer costs from conversion equity postings
.TP
\f[CR]\-\-infer\-market\-prices\f[R]
use costs as additional market prices, as if they were P directives
.TP
\f[CR]\-\-forecast\f[R]
generate transactions from periodic rules,
between the latest recorded txn and 6 months from today,
or during the specified PERIOD (= is required).
Auto posting rules will be applied to these transactions as well.
Also, in hledger\-ui make future\-dated transactions visible.
.TP
\f[CR]\-\-auto\f[R]
generate extra postings by applying auto posting rules to all txns (not
just forecast txns)
.TP
\f[CR]\-\-verbose\-tags\f[R]
add visible tags indicating transactions or postings which have been
generated/modified
.TP
\f[CR]\-\-commodity\-style\f[R]
Override the commodity style in the output for the specified commodity.
For example \[aq]EUR1.000,00\[aq].
.TP
\f[CR]\-\-color=WHEN (or \-\-colour=WHEN)\f[R]
Should color\-supporting commands use ANSI color codes in text output.
\[aq]auto\[aq] (default): whenever stdout seems to be a
color\-supporting terminal.
\[aq]always\[aq] or \[aq]yes\[aq]: always, useful eg when piping output
into \[aq]less \-R\[aq].
\[aq]never\[aq] or \[aq]no\[aq]: never.
A NO_COLOR environment variable overrides this.
.TP
\f[CR]\-\-pretty[=WHEN]\f[R]
Show prettier output, e.g.
using unicode box\-drawing characters.
Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq],
\[aq]n\[aq], \[aq]always\[aq], \[aq]never\[aq] also work).
If you provide an argument you must use \[aq]=\[aq], e.g.
\[aq]\-\-pretty=yes\[aq].
.PP
When a reporting option appears more than once in the command line, the
last one takes precedence.
.PP
Some reporting options can also be written as query arguments.
.SS General options
.IP
.EX
General input/data transformation flags:
\-f \-\-file=FILE Read data from FILE, or from stdin if \-. Can be
specified more than once. If not specified, reads
from $LEDGER_FILE or $HOME/.hledger.journal.
\-\-rules\-file=RULEFILE Use conversion rules from this file for
converting subsequent CSV/SSV/TSV files. If not
specified, uses FILE.rules for each such FILE.
\-\-alias=A=B|/RGX/=RPL transform account names from A to B, or by
replacing regular expression matches
\-\-auto generate extra postings by applying auto posting
rules (\[dq]=\[dq]) to all transactions
\-\-forecast[=PERIOD] Generate extra transactions from periodic rules
(\[dq]\[ti]\[dq]), from after the latest ordinary transaction
until 6 months from now. Or, during the specified
PERIOD (the equals is required). Auto posting rules
will also be applied to these transactions. In
hledger\-ui, also make future\-dated transactions
visible at startup.
\-I \-\-ignore\-assertions don\[aq]t check balance assertions by default
\-\-infer\-costs infer conversion equity postings from costs
\-\-infer\-equity infer costs from conversion equity postings
\-\-infer\-market\-prices infer market prices from costs
\-\-pivot=TAGNAME use a different field or tag as account names
\-s \-\-strict do extra error checks (and override \-I)
\-\-verbose\-tags add tags indicating generated/modified data
General output/reporting flags (supported by some commands):
\-b \-\-begin=DATE include postings/transactions on/after this date
\-e \-\-end=DATE include postings/transactions before this date
(with a report interval, will be adjusted to
following subperiod end)
\-D \-\-daily multiperiod report with 1 day interval
\-W \-\-weekly multiperiod report with 1 week interval
\-M \-\-monthly multiperiod report with 1 month interval
\-Q \-\-quarterly multiperiod report with 1 quarter interval
\-Y \-\-yearly multiperiod report with 1 year interval
\-p \-\-period=PERIODEXP set begin date, end date, and/or report interval,
with more flexibility
\-\-today=DATE override today\[aq]s date (affects relative dates)
\-\-date2 match/use secondary dates instead (deprecated)
\-U \-\-unmarked include only unmarked postings/transactions
\-P \-\-pending include only pending postings/transactions
\-C \-\-cleared include only cleared postings/transactions
(\-U/\-P/\-C can be combined)
\-R \-\-real include only non\-virtual postings
\-\-depth=NUM or \-NUM: show only top NUM levels of accounts
\-E \-\-empty Show zero items, which are normally hidden.
In hledger\-ui & hledger\-web, do the opposite.
\-B \-\-cost show amounts converted to their cost/sale amount
\-V \-\-market Show amounts converted to their value at period
end(s) in their default valuation commodity.
Equivalent to \-\-value=end.
\-X \-\-exchange=COMM Show amounts converted to their value at period
end(s) in the specified commodity.
Equivalent to \-\-value=end,COMM.
\-\-value=WHEN[,COMM] show amounts converted to their value on the
specified date(s) in their default valuation
commodity or a specified commodity. WHEN can be:
\[aq]then\[aq]: value on transaction dates
\[aq]end\[aq]: value at period end(s)
\[aq]now\[aq]: value today
YYYY\-MM\-DD: value on given date
\-c \-\-commodity\-style=S Override a commodity\[aq]s display style.
Eg: \-c \[aq].\[aq] or \-c \[aq]1.000,00 EUR\[aq]
\-\-color=YN \-\-colour Use ANSI color codes in text output? Can be:
\[aq]yes\[aq] or \[aq]always\[aq],
\[aq]no\[aq] or \[aq]never\[aq] (a NO_COLOR env var forces this),
\[aq]auto\[aq] (the default: when using a color terminal).
\-\-pretty[=YN] Use box\-drawing characters in text output? Can be
\[aq]yes\[aq] (the default argument for \-\-pretty) or \[aq]no\[aq].
If YN is specified, the equals is required.
\-\-debug=[N] show debug output (levels 1\-9, default: 1)
General help flags:
\-h \-\-help show command line help
\-\-tldr show command examples with tldr
\-\-info show the hledger manual with info
\-\-man show the hledger manual with man
\-\-version show version information
.EE
.SH PERMISSIONS
By default, hledger\-web allows anyone who can reach it to view the
journal and to add new transactions, but not to change existing data.
@ -468,22 +394,22 @@ corresponds to hledger\[aq]s Transaction and related data types):
\[dq]tcomment\[dq]: \[dq]\[dq],
\[dq]tpostings\[dq]: [
{
\[dq]pbalanceassertion\[dq]: null,
\[dq]pbalanceassertion\[dq]: \f[B]null\f[R],
\[dq]pstatus\[dq]: \[dq]Unmarked\[dq],
\[dq]pamount\[dq]: [
{
\[dq]aprice\[dq]: null,
\[dq]aprice\[dq]: \f[B]null\f[R],
\[dq]acommodity\[dq]: \[dq]$\[dq],
\[dq]aquantity\[dq]: {
\[dq]floatingPoint\[dq]: 1,
\[dq]decimalPlaces\[dq]: 10,
\[dq]decimalMantissa\[dq]: 10000000000
},
\[dq]aismultiplier\[dq]: false,
\[dq]aismultiplier\[dq]: \f[B]false\f[R],
\[dq]astyle\[dq]: {
\[dq]ascommodityside\[dq]: \[dq]L\[dq],
\[dq]asdigitgroups\[dq]: null,
\[dq]ascommodityspaced\[dq]: false,
\[dq]asdigitgroups\[dq]: \f[B]null\f[R],
\[dq]ascommodityspaced\[dq]: \f[B]false\f[R],
\[dq]asprecision\[dq]: 2,
\[dq]asdecimalpoint\[dq]: \[dq].\[dq]
}
@ -491,30 +417,30 @@ corresponds to hledger\[aq]s Transaction and related data types):
],
\[dq]ptransaction_\[dq]: \[dq]1\[dq],
\[dq]paccount\[dq]: \[dq]assets:bank:checking\[dq],
\[dq]pdate\[dq]: null,
\[dq]pdate\[dq]: \f[B]null\f[R],
\[dq]ptype\[dq]: \[dq]RegularPosting\[dq],
\[dq]pcomment\[dq]: \[dq]\[dq],
\[dq]pdate2\[dq]: null,
\[dq]pdate2\[dq]: \f[B]null\f[R],
\[dq]ptags\[dq]: [],
\[dq]poriginal\[dq]: null
\[dq]poriginal\[dq]: \f[B]null\f[R]
},
{
\[dq]pbalanceassertion\[dq]: null,
\[dq]pbalanceassertion\[dq]: \f[B]null\f[R],
\[dq]pstatus\[dq]: \[dq]Unmarked\[dq],
\[dq]pamount\[dq]: [
{
\[dq]aprice\[dq]: null,
\[dq]aprice\[dq]: \f[B]null\f[R],
\[dq]acommodity\[dq]: \[dq]$\[dq],
\[dq]aquantity\[dq]: {
\[dq]floatingPoint\[dq]: \-1,
\[dq]decimalPlaces\[dq]: 10,
\[dq]decimalMantissa\[dq]: \-10000000000
},
\[dq]aismultiplier\[dq]: false,
\[dq]aismultiplier\[dq]: \f[B]false\f[R],
\[dq]astyle\[dq]: {
\[dq]ascommodityside\[dq]: \[dq]L\[dq],
\[dq]asdigitgroups\[dq]: null,
\[dq]ascommodityspaced\[dq]: false,
\[dq]asdigitgroups\[dq]: \f[B]null\f[R],
\[dq]ascommodityspaced\[dq]: \f[B]false\f[R],
\[dq]asprecision\[dq]: 2,
\[dq]asdecimalpoint\[dq]: \[dq].\[dq]
}
@ -522,12 +448,12 @@ corresponds to hledger\[aq]s Transaction and related data types):
],
\[dq]ptransaction_\[dq]: \[dq]1\[dq],
\[dq]paccount\[dq]: \[dq]income:salary\[dq],
\[dq]pdate\[dq]: null,
\[dq]pdate\[dq]: \f[B]null\f[R],
\[dq]ptype\[dq]: \[dq]RegularPosting\[dq],
\[dq]pcomment\[dq]: \[dq]\[dq],
\[dq]pdate2\[dq]: null,
\[dq]pdate2\[dq]: \f[B]null\f[R],
\[dq]ptags\[dq]: [],
\[dq]poriginal\[dq]: null
\[dq]poriginal\[dq]: \f[B]null\f[R]
}
],
\[dq]ttags\[dq]: [],
@ -545,7 +471,7 @@ corresponds to hledger\[aq]s Transaction and related data types):
\[dq]tcode\[dq]: \[dq]\[dq],
\[dq]tindex\[dq]: 1,
\[dq]tprecedingcomment\[dq]: \[dq]\[dq],
\[dq]tdate2\[dq]: null,
\[dq]tdate2\[dq]: \f[B]null\f[R],
\[dq]tdescription\[dq]: \[dq]income\[dq],
\[dq]tstatus\[dq]: \[dq]Unmarked\[dq]
}

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

@ -153,183 +153,93 @@ at all.
* Menu:
* General help options::
* General input options::
* General reporting options::
* General options::

File: hledger-web.info, Node: General help options, Next: General input options, Up: OPTIONS
File: hledger-web.info, Node: General options, Up: OPTIONS
1.1 General help options
========================
1.1 General options
===================
'-h --help'
General input/data transformation flags:
-f --file=FILE Read data from FILE, or from stdin if -. Can be
specified more than once. If not specified, reads
from $LEDGER_FILE or $HOME/.hledger.journal.
--rules-file=RULEFILE Use conversion rules from this file for
converting subsequent CSV/SSV/TSV files. If not
specified, uses FILE.rules for each such FILE.
--alias=A=B|/RGX/=RPL transform account names from A to B, or by
replacing regular expression matches
--auto generate extra postings by applying auto posting
rules ("=") to all transactions
--forecast[=PERIOD] Generate extra transactions from periodic rules
("~"), from after the latest ordinary transaction
until 6 months from now. Or, during the specified
PERIOD (the equals is required). Auto posting rules
will also be applied to these transactions. In
hledger-ui, also make future-dated transactions
visible at startup.
-I --ignore-assertions don't check balance assertions by default
--infer-costs infer conversion equity postings from costs
--infer-equity infer costs from conversion equity postings
--infer-market-prices infer market prices from costs
--pivot=TAGNAME use a different field or tag as account names
-s --strict do extra error checks (and override -I)
--verbose-tags add tags indicating generated/modified data
show general or COMMAND help
'--man'
General output/reporting flags (supported by some commands):
-b --begin=DATE include postings/transactions on/after this date
-e --end=DATE include postings/transactions before this date
(with a report interval, will be adjusted to
following subperiod end)
-D --daily multiperiod report with 1 day interval
-W --weekly multiperiod report with 1 week interval
-M --monthly multiperiod report with 1 month interval
-Q --quarterly multiperiod report with 1 quarter interval
-Y --yearly multiperiod report with 1 year interval
-p --period=PERIODEXP set begin date, end date, and/or report interval,
with more flexibility
--today=DATE override today's date (affects relative dates)
--date2 match/use secondary dates instead (deprecated)
-U --unmarked include only unmarked postings/transactions
-P --pending include only pending postings/transactions
-C --cleared include only cleared postings/transactions
(-U/-P/-C can be combined)
-R --real include only non-virtual postings
--depth=NUM or -NUM: show only top NUM levels of accounts
-E --empty Show zero items, which are normally hidden.
In hledger-ui & hledger-web, do the opposite.
-B --cost show amounts converted to their cost/sale amount
-V --market Show amounts converted to their value at period
end(s) in their default valuation commodity.
Equivalent to --value=end.
-X --exchange=COMM Show amounts converted to their value at period
end(s) in the specified commodity.
Equivalent to --value=end,COMM.
--value=WHEN[,COMM] show amounts converted to their value on the
specified date(s) in their default valuation
commodity or a specified commodity. WHEN can be:
'then': value on transaction dates
'end': value at period end(s)
'now': value today
YYYY-MM-DD: value on given date
-c --commodity-style=S Override a commodity's display style.
Eg: -c '.' or -c '1.000,00 EUR'
--color=YN --colour Use ANSI color codes in text output? Can be:
'yes' or 'always',
'no' or 'never' (a NO_COLOR env var forces this),
'auto' (the default: when using a color terminal).
--pretty[=YN] Use box-drawing characters in text output? Can be
'yes' (the default argument for --pretty) or 'no'.
If YN is specified, the equals is required.
--debug=[N] show debug output (levels 1-9, default: 1)
show general or COMMAND user manual with man
'--info'
show general or COMMAND user manual with info
'--version'
show general or ADDONCMD version
'--debug[=N]'
show debug output (levels 1-9, default: 1)

File: hledger-web.info, Node: General input options, Next: General reporting options, Prev: General help options, Up: OPTIONS
1.2 General input options
=========================
'-f FILE --file=FILE'
use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal')
'--rules-file=RULESFILE'
Conversion rules file to use when reading CSV (default: FILE.rules)
'--separator=CHAR'
Field separator to expect when reading CSV (default: ',')
'--alias=OLD=NEW'
rename accounts named OLD to NEW
'--pivot FIELDNAME'
use some other field or tag for the account name
'-I --ignore-assertions'
disable balance assertion checks (note: does not disable balance
assignments)
'-s --strict'
do extra error checking (check that all posted accounts are
declared)

File: hledger-web.info, Node: General reporting options, Prev: General input options, Up: OPTIONS
1.3 General reporting options
=============================
'-b --begin=DATE'
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
'-e --end=DATE'
include postings/txns before this date (will be adjusted to
following subperiod end when using a report interval)
'-D --daily'
multiperiod/multicolumn report by day
'-W --weekly'
multiperiod/multicolumn report by week
'-M --monthly'
multiperiod/multicolumn report by month
'-Q --quarterly'
multiperiod/multicolumn report by quarter
'-Y --yearly'
multiperiod/multicolumn report by year
'-p --period=PERIODEXP'
set start date, end date, and/or reporting interval all at once
using period expressions syntax
'--date2'
match the secondary date instead (see command help for other
effects)
'--today=DATE'
override today's date (affects relative smart dates, for
tests/examples)
'-U --unmarked'
include only unmarked postings/txns (can combine with -P or -C)
'-P --pending'
include only pending postings/txns
'-C --cleared'
include only cleared postings/txns
'-R --real'
include only non-virtual postings
'-NUM --depth=NUM'
hide/aggregate accounts or postings more than NUM levels deep
'-E --empty'
show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
'-B --cost'
convert amounts to their cost/selling amount at transaction time
'-V --market'
convert amounts to their market value in default valuation
commodities
'-X --exchange=COMM'
convert amounts to their market value in commodity COMM
'--value'
convert amounts to cost or market value, more flexibly than
-B/-V/-X
'--infer-equity'
infer conversion equity postings from costs
'--infer-costs'
infer costs from conversion equity postings
'--infer-market-prices'
use costs as additional market prices, as if they were P directives
'--forecast'
generate transactions from periodic rules, between the latest
recorded txn and 6 months from today, or during the specified
PERIOD (= is required). Auto posting rules will be applied to
these transactions as well. Also, in hledger-ui make future-dated
transactions visible.
'--auto'
generate extra postings by applying auto posting rules to all txns
(not just forecast txns)
'--verbose-tags'
add visible tags indicating transactions or postings which have
been generated/modified
'--commodity-style'
Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'.
'--color=WHEN (or --colour=WHEN)'
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a
color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
'--pretty[=WHEN]'
Show prettier output, e.g. using unicode box-drawing characters.
Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', 'never'
also work). If you provide an argument you must use '=', e.g.
'-pretty=yes'.
When a reporting option appears more than once in the command line,
the last one takes precedence.
Some reporting options can also be written as query arguments.
General help flags:
-h --help show command line help
--tldr show command examples with tldr
--info show the hledger manual with info
--man show the hledger manual with man
--version show version information

File: hledger-web.info, Node: PERMISSIONS, Next: EDITING UPLOADING DOWNLOADING, Prev: OPTIONS, Up: Top
@ -640,28 +550,24 @@ Tag Table:
Node: Top223
Node: OPTIONS2578
Ref: #options2683
Node: General help options5648
Ref: #general-help-options5798
Node: General input options6080
Ref: #general-input-options6266
Node: General reporting options6923
Ref: #general-reporting-options7088
Node: PERMISSIONS10478
Ref: #permissions10617
Node: EDITING UPLOADING DOWNLOADING11829
Ref: #editing-uploading-downloading12010
Node: RELOADING12844
Ref: #reloading12978
Node: JSON API13411
Ref: #json-api13526
Node: DEBUG OUTPUT19014
Ref: #debug-output19139
Node: Debug output19166
Ref: #debug-output-119267
Node: ENVIRONMENT19684
Ref: #environment19803
Node: BUGS19920
Ref: #bugs20004
Node: General options5587
Ref: #general-options5692
Node: PERMISSIONS10919
Ref: #permissions11058
Node: EDITING UPLOADING DOWNLOADING12270
Ref: #editing-uploading-downloading12451
Node: RELOADING13285
Ref: #reloading13419
Node: JSON API13852
Ref: #json-api13967
Node: DEBUG OUTPUT19455
Ref: #debug-output19580
Node: Debug output19607
Ref: #debug-output-119708
Node: ENVIRONMENT20125
Ref: #environment20244
Node: BUGS20361
Ref: #bugs20445

End Tag Table

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

@ -122,160 +122,86 @@ OPTIONS
when costs are hidden. Currently hledger-web does not show costs at
all.
General help options
-h --help
show general or COMMAND help
General options
General input/data transformation flags:
-f --file=FILE Read data from FILE, or from stdin if -. Can be
specified more than once. If not specified, reads
from $LEDGER_FILE or $HOME/.hledger.journal.
--rules-file=RULEFILE Use conversion rules from this file for
converting subsequent CSV/SSV/TSV files. If not
specified, uses FILE.rules for each such FILE.
--alias=A=B|/RGX/=RPL transform account names from A to B, or by
replacing regular expression matches
--auto generate extra postings by applying auto posting
rules ("=") to all transactions
--forecast[=PERIOD] Generate extra transactions from periodic rules
("~"), from after the latest ordinary transaction
until 6 months from now. Or, during the specified
PERIOD (the equals is required). Auto posting rules
will also be applied to these transactions. In
hledger-ui, also make future-dated transactions
visible at startup.
-I --ignore-assertions don't check balance assertions by default
--infer-costs infer conversion equity postings from costs
--infer-equity infer costs from conversion equity postings
--infer-market-prices infer market prices from costs
--pivot=TAGNAME use a different field or tag as account names
-s --strict do extra error checks (and override -I)
--verbose-tags add tags indicating generated/modified data
--man show general or COMMAND user manual with man
General output/reporting flags (supported by some commands):
-b --begin=DATE include postings/transactions on/after this date
-e --end=DATE include postings/transactions before this date
(with a report interval, will be adjusted to
following subperiod end)
-D --daily multiperiod report with 1 day interval
-W --weekly multiperiod report with 1 week interval
-M --monthly multiperiod report with 1 month interval
-Q --quarterly multiperiod report with 1 quarter interval
-Y --yearly multiperiod report with 1 year interval
-p --period=PERIODEXP set begin date, end date, and/or report interval,
with more flexibility
--today=DATE override today's date (affects relative dates)
--date2 match/use secondary dates instead (deprecated)
-U --unmarked include only unmarked postings/transactions
-P --pending include only pending postings/transactions
-C --cleared include only cleared postings/transactions
(-U/-P/-C can be combined)
-R --real include only non-virtual postings
--depth=NUM or -NUM: show only top NUM levels of accounts
-E --empty Show zero items, which are normally hidden.
In hledger-ui & hledger-web, do the opposite.
-B --cost show amounts converted to their cost/sale amount
-V --market Show amounts converted to their value at period
end(s) in their default valuation commodity.
Equivalent to --value=end.
-X --exchange=COMM Show amounts converted to their value at period
end(s) in the specified commodity.
Equivalent to --value=end,COMM.
--value=WHEN[,COMM] show amounts converted to their value on the
specified date(s) in their default valuation
commodity or a specified commodity. WHEN can be:
'then': value on transaction dates
'end': value at period end(s)
'now': value today
YYYY-MM-DD: value on given date
-c --commodity-style=S Override a commodity's display style.
Eg: -c '.' or -c '1.000,00 EUR'
--color=YN --colour Use ANSI color codes in text output? Can be:
'yes' or 'always',
'no' or 'never' (a NO_COLOR env var forces this),
'auto' (the default: when using a color terminal).
--pretty[=YN] Use box-drawing characters in text output? Can be
'yes' (the default argument for --pretty) or 'no'.
If YN is specified, the equals is required.
--debug=[N] show debug output (levels 1-9, default: 1)
--info show general or COMMAND user manual with info
--version
show general or ADDONCMD version
--debug[=N]
show debug output (levels 1-9, default: 1)
General input options
-f FILE --file=FILE
use a different input file. For stdin, use - (default:
$LEDGER_FILE or $HOME/.hledger.journal)
--rules-file=RULESFILE
Conversion rules file to use when reading CSV (default:
FILE.rules)
--separator=CHAR
Field separator to expect when reading CSV (default: ',')
--alias=OLD=NEW
rename accounts named OLD to NEW
--pivot FIELDNAME
use some other field or tag for the account name
-I --ignore-assertions
disable balance assertion checks (note: does not disable balance
assignments)
-s --strict
do extra error checking (check that all posted accounts are de-
clared)
General reporting options
-b --begin=DATE
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
-e --end=DATE
include postings/txns before this date (will be adjusted to fol-
lowing subperiod end when using a report interval)
-D --daily
multiperiod/multicolumn report by day
-W --weekly
multiperiod/multicolumn report by week
-M --monthly
multiperiod/multicolumn report by month
-Q --quarterly
multiperiod/multicolumn report by quarter
-Y --yearly
multiperiod/multicolumn report by year
-p --period=PERIODEXP
set start date, end date, and/or reporting interval all at once
using period expressions syntax
--date2
match the secondary date instead (see command help for other ef-
fects)
--today=DATE
override today's date (affects relative smart dates, for
tests/examples)
-U --unmarked
include only unmarked postings/txns (can combine with -P or -C)
-P --pending
include only pending postings/txns
-C --cleared
include only cleared postings/txns
-R --real
include only non-virtual postings
-NUM --depth=NUM
hide/aggregate accounts or postings more than NUM levels deep
-E --empty
show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
-B --cost
convert amounts to their cost/selling amount at transaction time
-V --market
convert amounts to their market value in default valuation com-
modities
-X --exchange=COMM
convert amounts to their market value in commodity COMM
--value
convert amounts to cost or market value, more flexibly than
-B/-V/-X
--infer-equity
infer conversion equity postings from costs
--infer-costs
infer costs from conversion equity postings
--infer-market-prices
use costs as additional market prices, as if they were P direc-
tives
--forecast
generate transactions from periodic rules, between the latest
recorded txn and 6 months from today, or during the specified
PERIOD (= is required). Auto posting rules will be applied to
these transactions as well. Also, in hledger-ui make fu-
ture-dated transactions visible.
--auto generate extra postings by applying auto posting rules to all
txns (not just forecast txns)
--verbose-tags
add visible tags indicating transactions or postings which have
been generated/modified
--commodity-style
Override the commodity style in the output for the specified
commodity. For example 'EUR1.000,00'.
--color=WHEN (or --colour=WHEN)
Should color-supporting commands use ANSI color codes in text
output. 'auto' (default): whenever stdout seems to be a
color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
--pretty[=WHEN]
Show prettier output, e.g. using unicode box-drawing charac-
ters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always',
'never' also work). If you provide an argument you must use
'=', e.g. '--pretty=yes'.
When a reporting option appears more than once in the command line, the
last one takes precedence.
Some reporting options can also be written as query arguments.
General help flags:
-h --help show command line help
--tldr show command examples with tldr
--info show the hledger manual with info
--man show the hledger manual with man
--version show version information
PERMISSIONS
By default, hledger-web allows anyone who can reach it to view the
@ -558,4 +484,4 @@ LICENSE
SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
hledger-web-1.33.99 April 2024 HLEDGER-WEB(1)
hledger-web-1.33.99 May 2024 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_define({{_monthyear_}}, {{April 2024}})m4_dnl
m4_define({{_monthyear_}}, {{May 2024}})m4_dnl

3647
hledger/hledger.1
View File

File diff suppressed because it is too large Load Diff

7591
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

5585
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff