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

;update manuals

Browse Source
This commit is contained in:
Simon Michael 2021-06-15 06:24:25 -10:00
parent 1e13588153
commit a4db52aa05
5 changed files with 2940 additions and 3379 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,37 +1,36 @@
This is hledger-ui/hledger-ui.info, produced by makeinfo version 4.8
from stdin.
This is hledger-ui.info, produced by makeinfo version 6.7 from stdin.

File: hledger-ui.info, Node: Top, Up: (dir)
File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-ui(1)
*************
hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.21.99.
tool. This manual is for hledger-ui 1.21.99.
`hledger-ui [OPTIONS] [QUERYARGS]'
`hledger ui -- [OPTIONS] [QUERYARGS]'
'hledger-ui [OPTIONS] [QUERYARGS]'
'hledger ui -- [OPTIONS] [QUERYARGS]'
hledger is a reliable, cross-platform set of programs for tracking
money, time, or any other commodity, using double-entry accounting and a
simple, editable file format. hledger is inspired by and largely
simple, editable file format. hledger is inspired by and largely
compatible with ledger(1).
hledger-ui is hledger's terminal interface, providing an efficient
full-window text UI for viewing accounts and transactions, and some
limited data entry capability. It is easier than hledger's command-line
limited data entry capability. It is easier than hledger's command-line
interface, and sometimes quicker and more convenient than the web
interface.
Like hledger, it reads data from one or more files in hledger
journal, timeclock, timedot, or CSV format specified with `-f', or
`$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal'). For more about this see hledger(1),
journal, timeclock, timedot, or CSV format specified with '-f', or
'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps
'C:/Users/USER/.hledger.journal'). For more about this see hledger(1),
hledger_journal(5) etc.
Unlike hledger, hledger-ui hides all future-dated transactions by
default. They can be revealed, along with any rule-generated periodic
default. They can be revealed, along with any rule-generated periodic
transactions, by pressing the F key (or starting with -forecast) to
enable "forecast mode".
@ -50,143 +49,146 @@ File: hledger-ui.info, Node: OPTIONS, Next: KEYS, Prev: Top, Up: Top
1 OPTIONS
*********
Note: if invoking hledger-ui as a hledger subcommand, write `--' before
Note: if invoking hledger-ui as a hledger subcommand, write '--' before
options as shown above.
Any QUERYARGS are interpreted as a hledger search query which filters
the data.
`--watch'
'--watch'
watch for data and date changes and reload automatically
'--theme=default|terminal|greenterm'
`--theme=default|terminal|greenterm'
use this custom display theme
'--register=ACCTREGEX'
`--register=ACCTREGEX'
start in the (first) matched account's register screen
'--change'
`--change'
show period balances (changes) at startup instead of historical
balances
'-l --flat'
`-l --flat'
show accounts as a flat list (default)
'-t --tree'
`-t --tree'
show accounts as a tree
hledger input options:
`-f FILE --file=FILE'
use a different input file. For stdin, use - (default:
`$LEDGER_FILE' or `$HOME/.hledger.journal')
'-f FILE --file=FILE'
use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal')
'--rules-file=RULESFILE'
`--rules-file=RULESFILE'
Conversion rules file to use when reading CSV (default: FILE.rules)
'--separator=CHAR'
`--separator=CHAR'
Field separator to expect when reading CSV (default: ',')
'--alias=OLD=NEW'
`--alias=OLD=NEW'
rename accounts named OLD to NEW
'--anon'
`--anon'
anonymize accounts and payees
'--pivot FIELDNAME'
`--pivot FIELDNAME'
use some other field or tag for the account name
'-I --ignore-assertions'
`-I --ignore-assertions'
disable balance assertion checks (note: does not disable balance
assignments)
'-s --strict'
`-s --strict'
do extra error checking (check that all posted accounts are
declared)
hledger reporting options:
`-b --begin=DATE'
'-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'
`-e --end=DATE'
include postings/txns before this date (will be adjusted to
following subperiod end when using a report interval)
'-D --daily'
`-D --daily'
multiperiod/multicolumn report by day
'-W --weekly'
`-W --weekly'
multiperiod/multicolumn report by week
'-M --monthly'
`-M --monthly'
multiperiod/multicolumn report by month
'-Q --quarterly'
`-Q --quarterly'
multiperiod/multicolumn report by quarter
'-Y --yearly'
`-Y --yearly'
multiperiod/multicolumn report by year
'-p --period=PERIODEXP'
`-p --period=PERIODEXP'
set start date, end date, and/or reporting interval all at once
using period expressions syntax
'--date2'
`--date2'
match the secondary date instead (see command help for other
effects)
'-U --unmarked'
`-U --unmarked'
include only unmarked postings/txns (can combine with -P or -C)
'-P --pending'
`-P --pending'
include only pending postings/txns
'-C --cleared'
`-C --cleared'
include only cleared postings/txns
'-R --real'
`-R --real'
include only non-virtual postings
'-NUM --depth=NUM'
`-NUM --depth=NUM'
hide/aggregate accounts or postings more than NUM levels deep
'-E --empty'
`-E --empty'
show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
'-B --cost'
`-B --cost'
convert amounts to their cost/selling amount at transaction time
'-V --market'
`-V --market'
convert amounts to their market value in default valuation
commodities
'-X --exchange=COMM'
`-X --exchange=COMM'
convert amounts to their market value in commodity COMM
'--value'
`--value'
convert amounts to cost or market value, more flexibly than
-B/-V/-X
'--infer-market-prices'
`--infer-market-prices'
use transaction prices (recorded with @ or @@) as additional market
prices, as if they were P directives
'--auto'
`--auto'
apply automated posting rules to modify transactions.
'--forecast'
`--forecast'
generate future transactions from periodic transaction rules, for
the next 6 months or till report end date. In hledger-ui, also
the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
'--color=WHEN (or --colour=WHEN)'
`--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
when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line,
@ -196,24 +198,25 @@ the last one takes precedence.
hledger help options:
`-h --help'
'-h --help'
show general or COMMAND help
'--man'
`--man'
show general or COMMAND user manual with man
'--info'
`--info'
show general or COMMAND user manual with info
'--version'
`--version'
show general or ADDONCMD version
'--debug[=N]'
`--debug[=N]'
show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which
should contain one command line option/argument per line. (To prevent
this, insert a `--' argument before.)
should contain one command line option/argument per line. (To prevent
this, insert a '--' argument before.)

File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
@ -221,94 +224,94 @@ File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top
2 KEYS
******
`?' 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', or `LEFT', or `q') to close it. The following keys work on
'?' 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', 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 previous screen, `up'/`down'/`page up'/`page
down'/`home'/`end' move up and down through lists. Emacs-style
(`ctrl-p'/`ctrl-n'/`ctrl-f'/`ctrl-b') movement keys are also supported
The cursor keys navigate: 'right' (or 'enter') goes deeper, 'left'
returns to the previous screen, 'up'/'down'/'page up'/'page
down'/'home'/'end' move up and down through lists. Emacs-style
('ctrl-p'/'ctrl-n'/'ctrl-f'/'ctrl-b') movement keys are also supported
(but not vi-style keys, since hledger-1.19, sorry!). A tip: movement
speed is limited by your keyboard repeat rate, to move faster you may
want to adjust it. (If you're on a mac, the karabiner app is one way to
want to adjust it. (If you're on a mac, the karabiner app is one way to
do that.)
With shift pressed, the cursor keys adjust the report period,
limiting the transactions to be shown (by default, all are shown).
`shift-down/up' steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then,
`shift-left/right' moves to the previous/next period. `T' sets the
report period to today. With the `--watch' option, when viewing a
'shift-down/up' steps downward and upward through these standard report
period durations: year, quarter, month, week, day. Then,
'shift-left/right' moves to the previous/next period. 'T' sets the
report period to today. With the '--watch' option, when viewing a
"current" period (the current day, week, month, quarter, or year), the
period will move automatically to track the current date. To set a
non-standard period, you can use `/' and a `date:' query.
period will move automatically to track the current date. To set a
non-standard period, you can use '/' and a 'date:' query.
`/' lets you set a general filter query limiting the data shown,
using the same query terms as in hledger and hledger-web. While editing
the query, you can use CTRL-a/e/d/k, BS, cursor keys; press `ENTER' to
set it, or `ESCAPE'to cancel. There are also keys for quickly adjusting
'/' lets you set a general filter query limiting the data shown,
using the same query terms as in hledger and hledger-web. While editing
the query, you can use CTRL-a/e/d/k, BS, cursor keys; press 'ENTER' to
set it, or 'ESCAPE'to cancel. There are also keys for quickly adjusting
some common filters like account depth and transaction status (see
below). `BACKSPACE' or `DELETE' removes all filters, showing all
below). 'BACKSPACE' or 'DELETE' removes all filters, showing all
transactions.
As mentioned above, by default hledger-ui hides future transactions -
both ordinary transactions recorded in the journal, and periodic
transactions generated by rule. `F' toggles forecast mode, in which
transactions generated by rule. 'F' toggles forecast mode, in which
future/forecasted transactions are shown.
`ESCAPE' resets the UI state and jumps back to the top screen,
restoring the app's initial state at startup. Or, it cancels minibuffer
'ESCAPE' resets the UI state and jumps back to the top screen,
restoring the app's initial state at startup. Or, it cancels minibuffer
data entry or the help dialog.
`CTRL-l' redraws the screen and centers the selection if possible
'CTRL-l' redraws the screen and centers the selection if possible
(selections near the top won't be centered, since we don't scroll above
the top).
`g' reloads from the data file(s) and updates the current screen and
any previous screens. (With large files, this could cause a noticeable
'g' reloads from the data file(s) and updates the current screen and
any previous screens. (With large files, this could cause a noticeable
pause.)
`I' toggles balance assertion checking. Disabling balance assertions
'I' toggles balance assertion checking. Disabling balance assertions
temporarily can be useful for troubleshooting.
`a' runs command-line hledger's add command, and reloads the updated
file. This allows some basic data entry.
'a' runs command-line hledger's add command, and reloads the updated
file. This allows some basic data entry.
`A' is like `a', but runs the hledger-iadd tool, which provides a
terminal interface. This key will be available if `hledger-iadd' is
'A' is like 'a', but runs the hledger-iadd tool, which provides a
terminal interface. This key will be available if 'hledger-iadd' is
installed in $path.
`E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (`emacsclient
-a "" -nw') on the journal file. With some editors (emacs, vi), the
'E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default ('emacsclient
-a "" -nw') on the journal file. With some editors (emacs, vi), the
cursor will be positioned at the current transaction when invoked from
the register and transaction screens, and at the error location (if
possible) when invoked from the error screen.
`B' toggles cost mode, showing amounts in their transaction price's
commodity (like toggling the `-B/--cost' flag).
'B' toggles cost mode, showing amounts in their transaction price's
commodity (like toggling the '-B/--cost' flag).
`V' toggles value mode, showing amounts' current market value in
their default valuation commodity (like toggling the `-V/--market'
flag). Note, "current market value" means the value on the report end
date if specified, otherwise today. To see the value on another date,
you can temporarily set that as the report end date. Eg: to see a
'V' toggles value mode, showing amounts' current market value in
their default valuation commodity (like toggling the '-V/--market'
flag). Note, "current market value" means the value on the report end
date if specified, otherwise today. To see the value on another date,
you can temporarily set that as the report end date. Eg: to see a
transaction as it was valued on july 30, go to the accounts or register
screen, press `/', and add `date:-7/30' to the query.
screen, press '/', and add 'date:-7/30' to the query.
At most one of cost or value mode can be active at once.
There's not yet any visual reminder when cost or value mode is
active; for now pressing `b' `b' `v' should reliably reset to normal
active; for now pressing 'b' 'b' 'v' should reliably reset to normal
mode.
With `--watch' active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the `B'/`V' keys
will stop working. To work around, press `g' to force a manual reload,
With '--watch' active, if you save an edit to the journal file while
viewing the transaction screen in cost or value mode, the 'B'/'V' keys
will stop working. To work around, press 'g' to force a manual reload,
or exit the transaction screen.
`q' quits the application.
'q' quits the application.
Additional screen-specific keys are described below.
@ -331,47 +334,48 @@ File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Up: SCRE
3.1 Accounts screen
===================
This is normally the first screen displayed. It lists accounts and their
balances, like hledger's balance command. By default, it shows all
accounts and their latest ending balances (including the balances of
subaccounts). If you specify a query on the command line, it shows just
This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows
all accounts and their latest ending balances (including the balances of
subaccounts). If you specify a query on the command line, it shows just
the matched accounts and the balances from matched transactions.
Account names are shown as a flat list by default; press `t' to
toggle tree mode. In list mode, account balances are exclusive of
Account names are shown as a flat list by default; press 't' to
toggle tree mode. In list mode, account balances are exclusive of
subaccounts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of subaccounts.
below). In tree mode, all account balances are inclusive of
subaccounts.
To see less detail, press a number key, `1' to `9', to set a depth
limit. Or use `-' to decrease and `+'/`=' to increase the depth limit.
`0' shows even less detail, collapsing all accounts to a single total.
To remove the depth limit, set it higher than the maximum account
depth, or press `ESCAPE'.
To see less detail, press a number key, '1' to '9', to set a depth
limit. Or use '-' to decrease and '+'/'=' to increase the depth limit.
'0' shows even less detail, collapsing all accounts to a single total.
To remove the depth limit, set it higher than the maximum account depth,
or press 'ESCAPE'.
`H' toggles between showing historical balances or period balances.
'H' toggles between showing historical balances or period balances.
Historical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before the
start of the report period. In other words, historical balances are what
you would see on a bank statement for that account (unless disturbed by
a filter query). Period balances ignore transactions before the report
start date, so they show the change in balance during the report period.
They are more useful eg when viewing a time log.
start of the report period. In other words, historical balances are
what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions
before the report start date, so they show the change in balance during
the report period. They are more useful eg when viewing a time log.
`U' toggles filtering by unmarked status, including or excluding
unmarked postings in the balances. Similarly, `P' toggles pending
postings, and `C' toggles cleared postings. (By default, balances
'U' toggles filtering by unmarked status, including or excluding
unmarked postings in the balances. Similarly, 'P' toggles pending
postings, and 'C' toggles cleared postings. (By default, balances
include all postings; if you activate one or two status filters, only
those postings are included; and if you activate all three, the filter
is removed.)
`R' toggles real mode, in which virtual postings are ignored.
'R' toggles real mode, in which virtual postings are ignored.
`Z' toggles nonzero mode, in which only accounts with nonzero
'Z' toggles nonzero mode, in which only accounts with nonzero
balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger).
Press `right' or `enter' to view an account's transactions register.
Press 'right' or 'enter' to view an account's transactions register.

File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Accounts screen, Up: SCREENS
@ -380,46 +384,44 @@ File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev:
===================
This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows:
a check register. Each line represents one transaction and shows:
* the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts
affected by real postings.)
* the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected
by real postings.)
* the overall change to the current account's balance; positive for
an inflow to this account, negative for an outflow.
* the running historical total or period total for the current
account, after the transaction. This can be toggled with `H'.
Similar to the accounts screen, the historical total is affected
by transactions (filtered by the filter query) before the report
start date, while the period total is not. If the historical total
is not disturbed by a filter query, it will be the running
historical balance you would see on a bank register for the
current account.
account, after the transaction. This can be toggled with 'H'.
Similar to the accounts screen, the historical total is affected by
transactions (filtered by the filter query) before the report start
date, while the period total is not. If the historical total is
not disturbed by a filter query, it will be the running historical
balance you would see on a bank register for the current account.
Transactions affecting this account's subaccounts will be included in
the register if the accounts screen is in tree mode, or if it's in list
mode but this account has subaccounts which are not shown due to a depth
limit. In other words, the register always shows the transactions
contributing to the balance shown on the accounts screen. Tree mode/list
mode can be toggled with `t' here also.
limit. In other words, the register always shows the transactions
contributing to the balance shown on the accounts screen. Tree
mode/list mode can be toggled with 't' here also.
`U' toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, `P' toggles pending transactions, and `C'
toggles cleared transactions. (By default, transactions with all
'U' toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, 'P' toggles pending transactions, and 'C'
toggles cleared transactions. (By default, transactions with all
statuses are shown; if you activate one or two status filters, only
those transactions are shown; and if you activate all three, the filter
is removed.)
`R' toggles real mode, in which virtual postings are ignored.
'R' toggles real mode, in which virtual postings are ignored.
`Z' toggles nonzero mode, in which only transactions posting a
'Z' toggles nonzero mode, in which only transactions posting a
nonzero change are shown (hledger-ui shows zero items by default, unlike
command-line hledger).
Press `right' (or `enter') to view the selected transaction in
Press 'right' (or 'enter') to view the selected transaction in
detail.

@ -437,11 +439,11 @@ description, comments, along with all of its account postings are shown.
Simple transactions have two postings, but there can be more (or in
certain cases, fewer).
`up' and `down' will step through all transactions listed in the
previous account register screen. In the title bar, the numbers in
parentheses show your position within that account register. They will
'up' and 'down' will step through all transactions listed in the
previous account register screen. In the title bar, the numbers in
parentheses show your position within that account register. They will
vary depending on which account register you came from (remember most
transactions appear in multiple account registers). The #N number
transactions appear in multiple account registers). The #N number
preceding them is the transaction's position within the complete
unfiltered journal, which is a more stable id (at least until the next
reload).
@ -453,8 +455,8 @@ File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCRE
================
This screen will appear if there is a problem, such as a parse error,
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
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
to cancel the reload attempt.)

@ -463,28 +465,27 @@ File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: SCREENS, Up: To
4 ENVIRONMENT
*************
*COLUMNS* The screen width to use. Default: the full terminal width.
*COLUMNS* The screen width to use. Default: the full terminal width.
*LEDGER_FILE* The journal file path when not specified with `-f'.
Default: `~/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal').
*LEDGER_FILE* The journal file path when not specified with '-f'.
Default: '~/.hledger.journal' (on windows, perhaps
'C:/Users/USER/.hledger.journal').
A typical value is `~/DIR/YYYY.journal', where DIR is a
version-controlled finance directory and YYYY is the current year. Or
`~/DIR/current.journal', where current.journal is a symbolic link to
A typical value is '~/DIR/YYYY.journal', where DIR is a
version-controlled finance directory and YYYY is the current year. Or
'~/DIR/current.journal', where current.journal is a symbolic link to
YYYY.journal.
On Mac computers, you can set this and other environment variables
in a more thorough way that also affects applications started from the
GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a
`~/.MacOSX/environment.plist' file containing
On Mac computers, you can set this and other environment variables in
a more thorough way that also affects applications started from the GUI
(say, an Emacs dock icon). Eg on MacOS Catalina I have a
'~/.MacOSX/environment.plist' file containing
{
"LEDGER_FILE" : "~/finance/current.journal"
}
To see the effect you may need to `killall Dock', or reboot.
To see the effect you may need to 'killall Dock', or reboot.

File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
@ -493,9 +494,9 @@ File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
*******
Reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with `-f', or `$LEDGER_FILE', or
`$HOME/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal').
timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or
'$HOME/.hledger.journal' (on windows, perhaps
'C:/Users/USER/.hledger.journal').

File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
@ -503,18 +504,18 @@ File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
6 BUGS
******
The need to precede options with `--' when invoked from hledger is
The need to precede options with '--' when invoked from hledger is
awkward.
`-f-' doesn't work (hledger-ui can't read from stdin).
'-f-' doesn't work (hledger-ui can't read from stdin).
`-V' affects only the accounts screen.
'-V' affects only the accounts screen.
When you press `g', the current and all previous screens are
regenerated, which may cause a noticeable pause with large files. Also
When you press 'g', the current and all previous screens are
regenerated, which may cause a noticeable pause with large files. Also
there is no visual indication that this is in progress.
`--watch' is not yet fully robust. It works well for normal usage,
'--watch' is not yet fully robust. It works well for normal usage,
but many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. Symptoms
include: unresponsive UI, periodic resetting of the cursor position,
@ -523,31 +524,30 @@ and possibly a small but persistent build-up of CPU usage until the
program is restarted.
Also, if you are viewing files mounted from another machine,
`--watch' requires that both machine clocks are roughly in step.
'--watch' requires that both machine clocks are roughly in step.

Tag Table:
Node: Top82
Node: OPTIONS1478
Ref: #options1575
Node: KEYS5970
Ref: #keys6065
Node: SCREENS10361
Ref: #screens10466
Node: Accounts screen10556
Ref: #accounts-screen10684
Node: Register screen12888
Ref: #register-screen13043
Node: Transaction screen15038
Ref: #transaction-screen15196
Node: Error screen16063
Ref: #error-screen16185
Node: ENVIRONMENT16427
Ref: #environment16541
Node: FILES17346
Ref: #files17445
Node: BUGS17658
Ref: #bugs17735
Node: Top71
Node: OPTIONS1488
Ref: #options1585
Node: KEYS5986
Ref: #keys6081
Node: SCREENS10400
Ref: #screens10505
Node: Accounts screen10595
Ref: #accounts-screen10723
Node: Register screen12938
Ref: #register-screen13093
Node: Transaction screen15090
Ref: #transaction-screen15248
Node: Error screen16118
Ref: #error-screen16240
Node: ENVIRONMENT16484
Ref: #environment16598
Node: FILES17405
Ref: #files17504
Node: BUGS17717
Ref: #bugs17794

End Tag Table

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

@ -1,8 +1,7 @@
This is hledger-web/hledger-web.info, produced by makeinfo version 4.8
from stdin.
This is hledger-web.info, produced by makeinfo version 6.7 from stdin.

File: hledger-web.info, Node: Top, Up: (dir)
File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-web(1)
**************
@ -10,31 +9,32 @@ hledger-web(1)
hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.21.99.
`hledger-web [OPTIONS]'
`hledger web -- [OPTIONS]'
'hledger-web [OPTIONS]'
'hledger web -- [OPTIONS]'
hledger is a reliable, cross-platform set of programs for tracking
money, time, or any other commodity, using double-entry accounting and a
simple, editable file format. hledger is inspired by and largely
simple, editable file format. hledger is inspired by and largely
compatible with ledger(1).
hledger-web is hledger's web interface. It starts a simple web
hledger-web is hledger's web interface. It starts a simple web
application for browsing and adding transactions, and optionally opens
it in a web browser window if possible. It provides a more user-friendly
UI than the hledger CLI or hledger-ui interface, showing more at once
(accounts, the current account register, balance charts) and allowing
history-aware data entry, interactive searching, and bookmarking.
it in a web browser window if possible. It provides a more
user-friendly UI than the hledger CLI or hledger-ui interface, showing
more at once (accounts, the current account register, balance charts)
and allowing history-aware data entry, interactive searching, and
bookmarking.
hledger-web also lets you share a ledger with multiple users, or even
the public web. There is no access control, so if you need that you
should put it behind a suitable web proxy. As a small protection against
data loss when running an unprotected instance, it writes a numbered
backup of the main journal file (only ?) on every edit.
the public web. There is no access control, so if you need that you
should put it behind a suitable web proxy. As a small protection
against data loss when running an unprotected instance, it writes a
numbered backup of the main journal file (only ?) on every edit.
Like hledger, it reads data from one or more files in hledger
journal, timeclock, timedot, or CSV format specified with `-f', or
`$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal'). For more about this see hledger(1).
journal, timeclock, timedot, or CSV format specified with '-f', or
'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps
'C:/Users/USER/.hledger.journal'). For more about this see hledger(1).
* Menu:
@ -54,165 +54,168 @@ File: hledger-web.info, Node: OPTIONS, Next: PERMISSIONS, Prev: Top, Up: Top
*********
Command-line options and arguments may be used to set an initial filter
on the data. These filter options are not shown in the web UI, but it
on the data. These filter options are not shown in the web UI, but it
will be applied in addition to any search query entered there.
Note: if invoking hledger-web as a hledger subcommand, write `--'
Note: if invoking hledger-web as a hledger subcommand, write '--'
before options, as shown in the synopsis above.
`--serve'
serve and log requests, don't browse or auto-exit
'--serve'
serve and log requests, don't browse or auto-exit
'--serve-api'
`--serve-api'
like -serve, but serve only the JSON web API, without the
server-side web UI
'--host=IPADDR'
`--host=IPADDR'
listen on this IP address (default: 127.0.0.1)
'--port=PORT'
`--port=PORT'
listen on this TCP port (default: 5000)
'--socket=SOCKETFILE'
`--socket=SOCKETFILE'
use a unix domain socket file to listen for requests instead of a
TCP socket. Implies `--serve'. It can only be used if the operating
system can provide this type of socket.
TCP socket. Implies '--serve'. It can only be used if the
operating system can provide this type of socket.
'--base-url=URL'
`--base-url=URL'
set the base url (default: http://IPADDR:PORT). You would change
this when sharing over the network, or integrating within a larger
website.
'--file-url=URL'
`--file-url=URL'
set the static files url (default: BASEURL/static). hledger-web
set the static files url (default: BASEURL/static). hledger-web
normally serves static files itself, but if you wanted to serve
them from another server for efficiency, you would set the url
with this.
them from another server for efficiency, you would set the url with
this.
'--capabilities=CAP[,CAP..]'
`--capabilities=CAP[,CAP..]'
enable the view, add, and/or manage capabilities (default:
view,add)
'--capabilities-header=HTTPHEADER'
`--capabilities-header=HTTPHEADER'
read capabilities to enable from a HTTP header, like
X-Sandstorm-Permissions (default: disabled)
'--test'
`--test'
run hledger-web's tests and exit. hspec test runner args may
run hledger-web's tests and exit. hspec test runner args may
follow a -, eg: hledger-web -test - -help
hledger input options:
`-f FILE --file=FILE'
use a different input file. For stdin, use - (default:
`$LEDGER_FILE' or `$HOME/.hledger.journal')
'-f FILE --file=FILE'
use a different input file. For stdin, use - (default:
'$LEDGER_FILE' or '$HOME/.hledger.journal')
'--rules-file=RULESFILE'
`--rules-file=RULESFILE'
Conversion rules file to use when reading CSV (default: FILE.rules)
'--separator=CHAR'
`--separator=CHAR'
Field separator to expect when reading CSV (default: ',')
'--alias=OLD=NEW'
`--alias=OLD=NEW'
rename accounts named OLD to NEW
'--anon'
`--anon'
anonymize accounts and payees
'--pivot FIELDNAME'
`--pivot FIELDNAME'
use some other field or tag for the account name
'-I --ignore-assertions'
`-I --ignore-assertions'
disable balance assertion checks (note: does not disable balance
assignments)
'-s --strict'
`-s --strict'
do extra error checking (check that all posted accounts are
declared)
hledger reporting options:
`-b --begin=DATE'
'-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'
`-e --end=DATE'
include postings/txns before this date (will be adjusted to
following subperiod end when using a report interval)
'-D --daily'
`-D --daily'
multiperiod/multicolumn report by day
'-W --weekly'
`-W --weekly'
multiperiod/multicolumn report by week
'-M --monthly'
`-M --monthly'
multiperiod/multicolumn report by month
'-Q --quarterly'
`-Q --quarterly'
multiperiod/multicolumn report by quarter
'-Y --yearly'
`-Y --yearly'
multiperiod/multicolumn report by year
'-p --period=PERIODEXP'
`-p --period=PERIODEXP'
set start date, end date, and/or reporting interval all at once
using period expressions syntax
'--date2'
`--date2'
match the secondary date instead (see command help for other
effects)
'-U --unmarked'
`-U --unmarked'
include only unmarked postings/txns (can combine with -P or -C)
'-P --pending'
`-P --pending'
include only pending postings/txns
'-C --cleared'
`-C --cleared'
include only cleared postings/txns
'-R --real'
`-R --real'
include only non-virtual postings
'-NUM --depth=NUM'
`-NUM --depth=NUM'
hide/aggregate accounts or postings more than NUM levels deep
'-E --empty'
`-E --empty'
show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
'-B --cost'
`-B --cost'
convert amounts to their cost/selling amount at transaction time
'-V --market'
`-V --market'
convert amounts to their market value in default valuation
commodities
'-X --exchange=COMM'
`-X --exchange=COMM'
convert amounts to their market value in commodity COMM
'--value'
`--value'
convert amounts to cost or market value, more flexibly than
-B/-V/-X
'--infer-market-prices'
`--infer-market-prices'
use transaction prices (recorded with @ or @@) as additional market
prices, as if they were P directives
'--auto'
`--auto'
apply automated posting rules to modify transactions.
'--forecast'
`--forecast'
generate future transactions from periodic transaction rules, for
the next 6 months or till report end date. In hledger-ui, also
the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
'--color=WHEN (or --colour=WHEN)'
`--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
when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this.
When a reporting option appears more than once in the command line,
@ -222,62 +225,62 @@ the last one takes precedence.
hledger help options:
`-h --help'
'-h --help'
show general or COMMAND help
'--man'
`--man'
show general or COMMAND user manual with man
'--info'
`--info'
show general or COMMAND user manual with info
'--version'
`--version'
show general or ADDONCMD version
'--debug[=N]'
`--debug[=N]'
show debug output (levels 1-9, default: 1)
A @FILE argument will be expanded to the contents of FILE, which
should contain one command line option/argument per line. (To prevent
this, insert a `--' argument before.)
should contain one command line option/argument per line. (To prevent
this, insert a '--' argument before.)
By default, hledger-web starts the web app in "transient mode" and
also opens it in your default web browser if possible. In this mode the
also opens it in your default web browser if possible. In this mode the
web app will keep running for as long as you have it open in a browser
window, and will exit after two minutes of inactivity (no requests and
no browser windows viewing it). With `--serve', it just runs the web
app without exiting, and logs requests to the console. With
`--serve-api', only the JSON web api (see below) is served, with the
no browser windows viewing it). With '--serve', it just runs the web
app without exiting, and logs requests to the console. With
'--serve-api', only the JSON web api (see below) is served, with the
usual HTML server-side web UI disabled.
By default the server listens on IP address 127.0.0.1, accessible
only to local requests. You can use `--host' to change this, eg `--host
only to local requests. You can use '--host' to change this, eg '--host
0.0.0.0' to listen on all configured addresses.
Similarly, use `--port' to set a TCP port other than 5000, eg if you
Similarly, use '--port' to set a TCP port other than 5000, eg if you
are running multiple hledger-web instances.
Both of these options are ignored when `--socket' is used. In this
case, it creates an `AF_UNIX' socket file at the supplied path and uses
that for communication. This is an alternative way of running multiple
hledger-web instances behind a reverse proxy that handles
authentication for different users. The path can be derived in a
predictable way, eg by using the username within the path. As an
example, `nginx' as reverse proxy can use the variable `$remote_user'
to derive a path from the username used in a HTTP basic authentication.
The following `proxy_pass' directive allows access to all `hledger-web'
instances that created a socket in `/tmp/hledger/':
Both of these options are ignored when '--socket' is used. In this
case, it creates an 'AF_UNIX' socket file at the supplied path and uses
that for communication. This is an alternative way of running multiple
hledger-web instances behind a reverse proxy that handles authentication
for different users. The path can be derived in a predictable way, eg
by using the username within the path. As an example, 'nginx' as
reverse proxy can use the variable '$remote_user' to derive a path from
the username used in a HTTP basic authentication. The following
'proxy_pass' directive allows access to all 'hledger-web' instances that
created a socket in '/tmp/hledger/':
proxy_pass http://unix:/tmp/hledger/${remote_user}.socket;
You can use `--base-url' to change the protocol, hostname, port and
You can use '--base-url' to change the protocol, hostname, port and
path that appear in hyperlinks, useful eg for integrating hledger-web
within a larger website. The default is `http://HOST:PORT/' using the
server's configured host address and TCP port (or `http://HOST' if PORT
within a larger website. The default is 'http://HOST:PORT/' using the
server's configured host address and TCP port (or 'http://HOST' if PORT
is 80).
With `--file-url' you can set a different base url for static files,
With '--file-url' you can set a different base url for static files,
eg for better caching or cookie-less serving on high performance
websites.
@ -292,32 +295,28 @@ journal and to add new transactions, but not to change existing data.
You can restrict who can reach it by
* setting the IP address it listens on (see `--host' above). By
* setting the IP address it listens on (see '--host' above). By
default it listens on 127.0.0.1, accessible to all users on the
local machine.
* putting it behind an authenticating proxy, using eg apache or nginx
* custom firewall rules
You can restrict what the users who reach it can do, by
* using the `--capabilities=CAP[,CAP..]' flag when you start it,
enabling one or more of the following capabilities. The default
value is `view,add':
* `view' - allows viewing the journal file and all included
* using the '--capabilities=CAP[,CAP..]' flag when you start it,
enabling one or more of the following capabilities. The default
value is 'view,add':
* 'view' - allows viewing the journal file and all included
files
* `add' - allows adding new transactions to the main journal
* 'add' - allows adding new transactions to the main journal
file
* `manage' - allows editing, uploading or downloading the main
* 'manage' - allows editing, uploading or downloading the main
or included files
* using the `--capabilities-header=HTTPHEADER' flag to specify a HTTP
header from which it will read capabilities to enable. hledger-web
* using the '--capabilities-header=HTTPHEADER' flag to specify a HTTP
header from which it will read capabilities to enable. hledger-web
on Sandstorm uses the X-Sandstorm-Permissions header to integrate
with Sandstorm's permissions. This is disabled by default.
with Sandstorm's permissions. This is disabled by default.

File: hledger-web.info, Node: EDITING UPLOADING DOWNLOADING, Next: RELOADING, Prev: PERMISSIONS, Up: Top
@ -325,8 +324,8 @@ File: hledger-web.info, Node: EDITING UPLOADING DOWNLOADING, Next: RELOADING,
3 EDITING, UPLOADING, DOWNLOADING
*********************************
If you enable the `manage' capability mentioned above, you'll see a new
"spanner" button to the right of the search form. Clicking this will
If you enable the 'manage' capability mentioned above, you'll see a new
"spanner" button to the right of the search form. Clicking this will
let you edit, upload, or download the journal file or any files it
includes.
@ -335,13 +334,13 @@ visitor) can alter or wipe the data files.
Normally whenever a file is changed in this way, hledger-web saves a
numbered backup (assuming file permissions allow it, the disk is not
full, etc.) hledger-web is not aware of version control systems,
full, etc.) hledger-web is not aware of version control systems,
currently; if you use one, you'll have to arrange to commit the changes
yourself (eg with a cron job or a file watcher like entr).
Changes which would leave the journal file(s) unparseable or
non-valid (eg with failing balance assertions) are prevented.
(Probably. This needs re-testing.)
(Probably. This needs re-testing.)

File: hledger-web.info, Node: RELOADING, Next: JSON API, Prev: EDITING UPLOADING DOWNLOADING, Up: Top
@ -351,7 +350,7 @@ File: hledger-web.info, Node: RELOADING, Next: JSON API, Prev: EDITING UPLOAD
hledger-web detects changes made to the files by other means (eg if you
edit it directly, outside of hledger-web), and it will show the new data
when you reload the page or navigate to a new page. If a change makes a
when you reload the page or navigate to a new page. If a change makes a
file unparseable, hledger-web will display an error message until the
file has been fixed.
@ -365,16 +364,14 @@ File: hledger-web.info, Node: JSON API, Next: ENVIRONMENT, Prev: RELOADING,
**********
In addition to the web UI, hledger-web also serves a JSON API that can
be used to get data or add new transactions. If you want the JSON API
only, you can use the `--serve-api' flag. Eg:
be used to get data or add new transactions. If you want the JSON API
only, you can use the '--serve-api' flag. Eg:
$ hledger-web -f examples/sample.journal --serve-api
...
You can get JSON data from these routes:
/version
/accountnames
/transactions
@ -387,7 +384,6 @@ $ hledger-web -f examples/sample.journal --serve-api
command). (hledger-web's JSON does not include newlines, here we use
python to prettify it):
$ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool
[
"assets",
@ -407,7 +403,6 @@ $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool
Or all transactions:
$ curl -s http://127.0.0.1:5000/transactions | python -m json.tool
[
{
@ -429,25 +424,24 @@ $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool
Most of the JSON corresponds to hledger's data types; for details of
what the fields mean, see the Hledger.Data.Json haddock docs and click
on the various data types, eg Transaction. And for a higher level
on the various data types, eg Transaction. And for a higher level
understanding, see the journal manual.
In some cases there is outer JSON corresponding to a "Report" type.
To understand that, go to the Hledger.Web.Handler.MiscR haddock and
look at the source for the appropriate handler to see what it returns.
Eg for `/accounttransactions' it's getAccounttransactionsR, returning a
"`accountTransactionsReport ...'". Looking up the haddock for that we
To understand that, go to the Hledger.Web.Handler.MiscR haddock and look
at the source for the appropriate handler to see what it returns. Eg
for '/accounttransactions' it's getAccounttransactionsR, returning a
"'accountTransactionsReport ...'". Looking up the haddock for that we
can see that /accounttransactions returns an AccountTransactionsReport,
which consists of a report title and a list of
AccountTransactionsReportItem (etc).
You can add a new transaction to the journal with a PUT request to
`/add', if hledger-web was started with the `add' capability (enabled
by default). The payload must be the full, exact JSON representation of
a hledger transaction (partial data won't do). You can get sample JSON
from hledger-web's `/transactions' or `/accounttransactions', or you
can export it with hledger-lib, eg like so:
'/add', if hledger-web was started with the 'add' capability (enabled by
default). The payload must be the full, exact JSON representation of a
hledger transaction (partial data won't do). You can get sample JSON
from hledger-web's '/transactions' or '/accounttransactions', or you can
export it with hledger-lib, eg like so:
.../hledger$ stack ghci hledger-lib
>>> writeJsonFile "txn.json" (head $ jtxns samplejournal)
@ -456,7 +450,6 @@ can export it with hledger-lib, eg like so:
Here's how it looks as of hledger-1.17 (remember, this JSON
corresponds to hledger's Transaction and related data types):
{
"tcomment": "",
"tpostings": [
@ -543,10 +536,9 @@ corresponds to hledger's Transaction and related data types):
"tstatus": "Unmarked"
}
And here's how to test adding it with curl. This should add a new
And here's how to test adding it with curl. This should add a new
entry to your journal:
$ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json

@ -555,26 +547,25 @@ File: hledger-web.info, Node: ENVIRONMENT, Next: FILES, Prev: JSON API, Up:
6 ENVIRONMENT
*************
*LEDGER_FILE* The journal file path when not specified with `-f'.
Default: `~/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal').
*LEDGER_FILE* The journal file path when not specified with '-f'.
Default: '~/.hledger.journal' (on windows, perhaps
'C:/Users/USER/.hledger.journal').
A typical value is `~/DIR/YYYY.journal', where DIR is a
version-controlled finance directory and YYYY is the current year. Or
`~/DIR/current.journal', where current.journal is a symbolic link to
A typical value is '~/DIR/YYYY.journal', where DIR is a
version-controlled finance directory and YYYY is the current year. Or
'~/DIR/current.journal', where current.journal is a symbolic link to
YYYY.journal.
On Mac computers, you can set this and other environment variables
in a more thorough way that also affects applications started from the
GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a
`~/.MacOSX/environment.plist' file containing
On Mac computers, you can set this and other environment variables in
a more thorough way that also affects applications started from the GUI
(say, an Emacs dock icon). Eg on MacOS Catalina I have a
'~/.MacOSX/environment.plist' file containing
{
"LEDGER_FILE" : "~/finance/current.journal"
}
To see the effect you may need to `killall Dock', or reboot.
To see the effect you may need to 'killall Dock', or reboot.

File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
@ -583,9 +574,9 @@ File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
*******
Reads data from one or more files in hledger journal, timeclock,
timedot, or CSV format specified with `-f', or `$LEDGER_FILE', or
`$HOME/.hledger.journal' (on windows, perhaps
`C:/Users/USER/.hledger.journal').
timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or
'$HOME/.hledger.journal' (on windows, perhaps
'C:/Users/USER/.hledger.journal').

File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top
@ -593,10 +584,10 @@ File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top
8 BUGS
******
The need to precede options with `--' when invoked from hledger is
The need to precede options with '--' when invoked from hledger is
awkward.
`-f-' doesn't work (hledger-web can't read from stdin).
'-f-' doesn't work (hledger-web can't read from stdin).
Query arguments and some hledger options are ignored.
@ -604,25 +595,24 @@ awkward.
Does not work well on small screens.

Tag Table:
Node: Top84
Node: OPTIONS1727
Ref: #options1832
Node: PERMISSIONS9245
Ref: #permissions9384
Node: EDITING UPLOADING DOWNLOADING10596
Ref: #editing-uploading-downloading10777
Node: RELOADING11608
Ref: #reloading11742
Node: JSON API12174
Ref: #json-api12288
Node: ENVIRONMENT17777
Ref: #environment17893
Node: FILES18625
Ref: #files18725
Node: BUGS18938
Ref: #bugs19016
Node: Top72
Node: OPTIONS1738
Ref: #options1843
Node: PERMISSIONS9276
Ref: #permissions9415
Node: EDITING UPLOADING DOWNLOADING10627
Ref: #editing-uploading-downloading10808
Node: RELOADING11642
Ref: #reloading11776
Node: JSON API12209
Ref: #json-api12323
Node: ENVIRONMENT17813
Ref: #environment17929
Node: FILES18662
Ref: #files18762
Node: BUGS18975
Ref: #bugs19053

End Tag Table

100
hledger/hledger.1
View File

@ -3621,9 +3621,10 @@ commands, including \f[C]check\f[R]:
\f[B]parseable\f[R] - data files are well-formed and can be successfully
parsed
.IP \[bu] 2
\f[B]autobalanced\f[R] - all transactions are balanced, inferring
missing amounts where necessary, and possibly converting commodities
using transaction prices or automatically-inferred transaction prices
\f[B]balancedwithautoconversion\f[R] - all transactions are balanced,
inferring missing amounts where necessary, and possibly converting
commodities using transaction prices or automatically-inferred
transaction prices
.IP \[bu] 2
\f[B]assertions\f[R] - all balance assertions in the journal are
passing.
@ -3640,6 +3641,9 @@ Or, they can be run by giving their names as arguments to
declared
.IP \[bu] 2
\f[B]commodities\f[R] - all commodity symbols used have been declared
.IP \[bu] 2
\f[B]balancednoautoconversion\f[R] - transactions are balanced, possibly
using explicit transaction prices but not inferred ones
.SS Other checks
.PP
These checks can be run only by giving their names as arguments to
@ -6743,7 +6747,7 @@ See also Rewrite account names.
To set an account alias, use the \f[C]alias\f[R] directive in your
journal file.
This affects all subsequent journal entries in the current file or its
included files.
included files (but note: not sibling or parent files).
The spaces around the = are optional:
.IP
.nf
@ -7730,21 +7734,26 @@ below), a default account name will be chosen (like
\[dq]expenses:unknown\[dq] or \[dq]income:unknown\[dq]).
.SS amount
.PP
\f[C]amountN\f[R] sets posting N\[aq]s amount.
If the CSV uses separate fields for inflows and outflows, you can use
\f[C]amountN-in\f[R] and \f[C]amountN-out\f[R] instead.
\f[C]amountN\f[R] sets the Nth posting\[aq]s amount.
By assigning to \f[C]amount1\f[R], \f[C]amount2\f[R], ...
etc.
you can generate anywhere from 0 to 99 postings.
you can generate up to 99 postings.
.PP
There is also an older, unnumbered form of these names, suitable for
2-posting transactions, which sets both posting 1\[aq]s and (negated)
posting 2\[aq]s amount: \f[C]amount\f[R], or \f[C]amount-in\f[R] and
\f[C]amount-out\f[R].
This is still supported because it keeps pre-hledger-1.17 csv rules
files working, and because it can be more succinct, and because it
converts posting 2\[aq]s amount to cost if there\[aq]s a transaction
price, which can be useful.
If the CSV uses separate fields for debits and credits (inflows and
outflows), you can use \f[C]amountN-in\f[R] and \f[C]amountN-out\f[R]
instead.
Note hledger assumes both of these fields are unsigned, and will
automatically negate the \[dq]-out\[dq] value.
If the fields are signed, see \[dq]Setting amounts\[dq] below.
.PP
There is also an unnumbered form of these names: \f[C]amount\f[R], or
\f[C]amount-in\f[R] and \f[C]amount-out\f[R].
This is supported to keep pre-hledger-1.17 CSV rules files working (and
for occasional convenience).
It is suitable only for two-posting transactions; it sets both posting
1\[aq]s and posting 2\[aq]s amount.
Posting 2\[aq]s amount will be negated, and also converted to cost if
there\[aq]s a transaction price.
.PP
If you have an existing rules file using the unnumbered form, you might
want to use the numbered form in certain conditional blocks, without
@ -8307,40 +8316,47 @@ Assign (via a fields list or a field assignment) to \f[C]amountN\f[R].
This sets the Nth posting\[aq]s amount.
N is usually 1 or 2 but can go up to 99.
.IP "2." 3
\f[B]If the CSV has separate Debit and Credit amount fields:\f[R]
\f[B]If the CSV has separate amount fields for debit & credit (in &
out):\f[R]
.PD 0
.P
.PD
.RS 4
.IP "a." 3
\f[B]If both fields are unsigned:\f[R]
.PD 0
.P
.PD
Assign to \f[C]amountN-in\f[R] and \f[C]amountN-out\f[R].
This sets posting N\[aq]s amount to whichever of these has a non-zero
value, guessing an appropriate sign.
.RS 4
.IP \[bu] 2
\f[B]If hledger guesses the wrong sign:\f[R]
value, and negates the \[dq]-out\[dq] value.
.IP "b." 3
\f[B]If either field is signed (can contain a minus sign):\f[R]
.PD 0
.P
.PD
Prepend a minus sign to flip it.
Eg:
.RS 2
Use a conditional rule to flip the sign (of non-empty values).
Since hledger always negates amountN-out, if it was already negative, we
must undo that by negating once more (but only if the field is
non-empty):
.IP
.nf
\f[C]
fields date, description, amount-in, amount-out
amount-out -%amount-out
fields date, description, amount1-in, amount1-out
if %amount1-out [1-9]
amount1-out -%amount1-out
\f[R]
.fi
.RE
.IP \[bu] 2
\f[B]If both fields contain a non-zero value:\f[R]
.IP "c." 3
\f[B]If both fields, or neither field, can contain a non-zero
value:\f[R]
.PD 0
.P
.PD
The \f[C]amountN-in\f[R]/\f[C]amountN-out\f[R] rules require that each
CSV record has a non-zero value in exactly one of the two fields, so
that hledger knows which to choose.
So these would all be rejected:
.RS 2
hledger normally expects exactly one of the fields to have a non-zero
value.
Eg, the \f[C]amountN-in\f[R]/\f[C]amountN-out\f[R] rules would reject
value pairs like these:
.IP
.nf
\f[C]
@ -8350,9 +8366,10 @@ So these would all be rejected:
\f[R]
.fi
.PP
If your CSV has amount values like this, use conditional rules instead.
For example, to make hledger to choose the value containing non-zero
digits:
So, use smarter conditional rules to set the amount from the appropriate
field.
Eg, these rules would make it use only the value containing non-zero
digits, handling the above:
.IP
.nf
\f[C]
@ -8364,18 +8381,15 @@ if %out [1-9]
\f[R]
.fi
.RE
.RE
.IP "3." 3
\f[B]Using the old numberless syntax:\f[R]
\f[B]If you are stuck with hledger <1.17, or you want posting 2\[aq]s
amount converted to cost:\f[R]
.PD 0
.P
.PD
Assign to \f[C]amount\f[R] (or to \f[C]amount-in\f[R] and
\f[C]amount-out\f[R]).
This sets posting 1\[aq]s and posting 2\[aq]s amounts (and converts
posting 2\[aq]s amount to cost).
This is supported for backwards compatibility (and occasional
convenience).
(The old numberless syntax, which sets amount1 and amount2.)
.IP "4." 3
\f[B]If the CSV has the balance instead of the transaction amount:\f[R]
.PD 0

4571
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

624
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff