;doc: update manuals

This commit is contained in:
Simon Michael 2021-11-18 22:48:14 -10:00
parent 35b16346a9
commit 568b39734b
6 changed files with 1700 additions and 1652 deletions

View File

@ -321,6 +321,16 @@ reliably reset to normal mode.
\f[C]q\f[R] quits the application. \f[C]q\f[R] quits the application.
.PP .PP
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
.SH MOUSE
.PP
In most modern terminals, you can also control hledger-ui with a mouse
or touchpad as follows:
.IP \[bu] 2
Use mouse wheel or trackpad slide to scroll lists up and down
.IP \[bu] 2
Left click on list items to go deeper (like \f[C]RIGHT\f[R])
.IP \[bu] 2
Left click on the left-most column go back (like \f[C]LEFT\f[R])
.SH SCREENS .SH SCREENS
.SS Accounts screen .SS Accounts screen
.PP .PP

View File

@ -44,6 +44,7 @@ enable "forecast mode".
* OPTIONS:: * OPTIONS::
* KEYS:: * KEYS::
* MOUSE::
* SCREENS:: * SCREENS::
* TIPS:: * TIPS::
* ENVIRONMENT:: * ENVIRONMENT::
@ -236,7 +237,7 @@ should contain one command line option/argument per line. (To prevent
this, insert a `--' argument before.) this, insert a `--' argument before.)
 
File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top File: hledger-ui.info, Node: KEYS, Next: MOUSE, Prev: OPTIONS, Up: Top
2 KEYS 2 KEYS
****** ******
@ -328,9 +329,24 @@ mode.
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
 
File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: KEYS, Up: Top File: hledger-ui.info, Node: MOUSE, Next: SCREENS, Prev: KEYS, Up: Top
3 SCREENS 3 MOUSE
*******
In most modern terminals, you can also control hledger-ui with a mouse
or touchpad as follows:
* Use mouse wheel or trackpad slide to scroll lists up and down
* Left click on list items to go deeper (like `RIGHT')
* Left click on the left-most column go back (like `LEFT')

File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: MOUSE, Up: Top
4 SCREENS
********* *********
* Menu: * Menu:
@ -343,7 +359,7 @@ File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: KEYS, Up: Top
 
File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Up: SCREENS File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Up: SCREENS
3.1 Accounts screen 4.1 Accounts screen
=================== ===================
This is normally the first screen displayed. It lists accounts and their This is normally the first screen displayed. It lists accounts and their
@ -391,7 +407,7 @@ command-line hledger).
 
File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Accounts screen, Up: SCREENS File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Accounts screen, Up: SCREENS
3.2 Register screen 4.2 Register screen
=================== ===================
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
@ -440,7 +456,7 @@ detail.
 
File: hledger-ui.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS File: hledger-ui.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS
3.3 Transaction screen 4.3 Transaction screen
====================== ======================
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,
@ -464,7 +480,7 @@ reload).
 
File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCREENS File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCREENS
3.4 Error screen 4.4 Error screen
================ ================
This screen will appear if there is a problem, such as a parse error, This screen will appear if there is a problem, such as a parse error,
@ -475,7 +491,7 @@ to cancel the reload attempt.)
 
File: hledger-ui.info, Node: TIPS, Next: ENVIRONMENT, Prev: SCREENS, Up: Top File: hledger-ui.info, Node: TIPS, Next: ENVIRONMENT, Prev: SCREENS, Up: Top
4 TIPS 5 TIPS
****** ******
* Menu: * Menu:
@ -486,7 +502,7 @@ File: hledger-ui.info, Node: TIPS, Next: ENVIRONMENT, Prev: SCREENS, Up: Top
 
File: hledger-ui.info, Node: Watch mode, Next: Watch mode limitations, Up: TIPS File: hledger-ui.info, Node: Watch mode, Next: Watch mode limitations, Up: TIPS
4.1 Watch mode 5.1 Watch mode
============== ==============
One of hledger-ui's best features is the auto-reloading `--watch' mode. One of hledger-ui's best features is the auto-reloading `--watch' mode.
@ -510,7 +526,7 @@ history.
 
File: hledger-ui.info, Node: Watch mode limitations, Prev: Watch mode, Up: TIPS File: hledger-ui.info, Node: Watch mode limitations, Prev: Watch mode, Up: TIPS
4.2 Watch mode limitations 5.2 Watch mode limitations
========================== ==========================
There are situations in which it won't work, ie the display will not There are situations in which it won't work, ie the display will not
@ -541,7 +557,7 @@ gradually using more and more memory and CPU over time, as seen in
 
File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: TIPS, Up: Top File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: TIPS, Up: Top
5 ENVIRONMENT 6 ENVIRONMENT
************* *************
*COLUMNS* The screen width to use. Default: the full terminal width. *COLUMNS* The screen width to use. Default: the full terminal width.
@ -570,7 +586,7 @@ GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a
 
File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top
6 FILES 7 FILES
******* *******
Reads data from one or more files in hledger journal, timeclock, Reads data from one or more files in hledger journal, timeclock,
@ -581,7 +597,7 @@ timedot, or CSV format specified with `-f', or `$LEDGER_FILE', or
 
File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top
7 BUGS 8 BUGS
****** ******
The need to precede options with `--' when invoked from hledger is The need to precede options with `--' when invoked from hledger is
@ -610,31 +626,33 @@ program is restarted.
 
Tag Table: Tag Table:
Node: Top232 Node: Top232
Node: OPTIONS1637 Node: OPTIONS1647
Ref: #options1734 Ref: #options1744
Node: KEYS6606 Node: KEYS6616
Ref: #keys6701 Ref: #keys6709
Node: SCREENS10750 Node: MOUSE10758
Ref: #screens10848 Ref: #mouse10853
Node: Accounts screen10938 Node: SCREENS11139
Ref: #accounts-screen11066 Ref: #screens11238
Node: Register screen13270 Node: Accounts screen11328
Ref: #register-screen13425 Ref: #accounts-screen11456
Node: Transaction screen15420 Node: Register screen13660
Ref: #transaction-screen15578 Ref: #register-screen13815
Node: Error screen16445 Node: Transaction screen15810
Ref: #error-screen16567 Ref: #transaction-screen15968
Node: TIPS16809 Node: Error screen16835
Ref: #tips16908 Ref: #error-screen16957
Node: Watch mode16960 Node: TIPS17199
Ref: #watch-mode17077 Ref: #tips17298
Node: Watch mode limitations17821 Node: Watch mode17350
Ref: #watch-mode-limitations17962 Ref: #watch-mode17467
Node: ENVIRONMENT19095 Node: Watch mode limitations18211
Ref: #environment19206 Ref: #watch-mode-limitations18352
Node: FILES20011 Node: ENVIRONMENT19485
Ref: #files20110 Ref: #environment19596
Node: BUGS20323 Node: FILES20401
Ref: #bugs20400 Ref: #files20500
Node: BUGS20713
Ref: #bugs20790
 
End Tag Table End Tag Table

View File

@ -294,46 +294,56 @@ KEYS
Additional screen-specific keys are described below. Additional screen-specific keys are described below.
MOUSE
In most modern terminals, you can also control hledger-ui with a mouse
or touchpad as follows:
o Use mouse wheel or trackpad slide to scroll lists up and down
o Left click on list items to go deeper (like RIGHT)
o Left click on the left-most column go back (like LEFT)
SCREENS SCREENS
Accounts screen Accounts screen
This is normally the first screen displayed. It lists accounts and This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows their balances, like hledger's balance command. By default, it shows
all accounts and their latest ending balances (including the balances all accounts and their latest ending balances (including the balances
of subaccounts). If you specify a query on the command line, it shows of subaccounts). If you specify a query on the command line, it shows
just the matched accounts and the balances from matched transactions. just the matched accounts and the balances from matched transactions.
Account names are shown as a flat list by default; press t to toggle Account names are shown as a flat list by default; press t to toggle
tree mode. In list mode, account balances are exclusive of subac- tree mode. In list mode, account balances are exclusive of subac-
counts, except where subaccounts are hidden by a depth limit (see counts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of subac- below). In tree mode, all account balances are inclusive of subac-
counts. counts.
To see less detail, press a number key, 1 to 9, to set a depth limit. To see less detail, press a number key, 1 to 9, to set a depth limit.
Or use - to decrease and +/= to increase the depth limit. 0 shows even Or use - to decrease and +/= to increase the depth limit. 0 shows even
less detail, collapsing all accounts to a single total. To remove the less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press depth limit, set it higher than the maximum account depth, or press
ESCAPE. ESCAPE.
H toggles between showing historical balances or period balances. His- H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before (filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions disturbed by a filter query). Period balances ignore transactions
before the report start date, so they show the change in balance during 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. the report period. They are more useful eg when viewing a time log.
U toggles filtering by unmarked status, including or excluding unmarked U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (By default, balances include all postings; toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are if you activate one or two status filters, only those postings are
included; and if you activate all three, the filter is removed.) included; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only accounts with nonzero balances Z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line are shown (hledger-ui shows zero items by default, unlike command-line
hledger). hledger).
Press right or enter to view an account's transactions register. Press right or enter to view an account's transactions register.
@ -342,124 +352,124 @@ SCREENS
This screen shows the transactions affecting a particular account, like This screen shows the transactions affecting a particular account, like
a check register. Each line represents one transaction and shows: a check register. Each line represents one transaction and shows:
o the other account(s) involved, in abbreviated form. (If there are o the other account(s) involved, in abbreviated form. (If there are
both real and virtual postings, it shows only the accounts affected both real and virtual postings, it shows only the accounts affected
by real postings.) by real postings.)
o the overall change to the current account's balance; positive for an o the overall change to the current account's balance; positive for an
inflow to this account, negative for an outflow. inflow to this account, negative for an outflow.
o the running historical total or period total for the current account, o the running historical total or period total for the current account,
after the transaction. This can be toggled with H. Similar to the after the transaction. This can be toggled with H. Similar to the
accounts screen, the historical total is affected by transactions accounts screen, the historical total is affected by transactions
(filtered by the filter query) before the report start date, while (filtered by the filter query) before the report start date, while
the period total is not. If the historical total is not disturbed by the period total is not. If the historical total is not disturbed by
a filter query, it will be the running historical balance you would a filter query, it will be the running historical balance you would
see on a bank register for the current account. see on a bank register for the current account.
Transactions affecting this account's subaccounts will be included in Transactions affecting this account's subaccounts will be included in
the register if the accounts screen is in tree mode, or if it's in list the register if the accounts screen is in tree mode, or if it's in list
mode but this account has subaccounts which are not shown due to a mode but this account has subaccounts which are not shown due to a
depth limit. In other words, the register always shows the transac- depth limit. In other words, the register always shows the transac-
tions contributing to the balance shown on the accounts screen. Tree tions contributing to the balance shown on the accounts screen. Tree
mode/list mode can be toggled with t here also. mode/list mode can be toggled with t here also.
U toggles filtering by unmarked status, showing or hiding unmarked U toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, P toggles pending transactions, and C toggles transactions. Similarly, P toggles pending transactions, and C toggles
cleared transactions. (By default, transactions with all statuses are cleared transactions. (By default, transactions with all statuses are
shown; if you activate one or two status filters, only those transac- shown; if you activate one or two status filters, only those transac-
tions are shown; and if you activate all three, the filter is removed.) tions are shown; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
Z toggles nonzero mode, in which only transactions posting a nonzero Z toggles nonzero mode, in which only transactions posting a nonzero
change are shown (hledger-ui shows zero items by default, unlike com- change are shown (hledger-ui shows zero items by default, unlike com-
mand-line hledger). mand-line hledger).
Press right (or enter) to view the selected transaction in detail. Press right (or enter) to view the selected transaction in detail.
Transaction screen Transaction screen
This screen shows a single transaction, as a general journal entry, This screen shows a single transaction, as a general journal entry,
similar to hledger's print command and journal format (hledger_jour- similar to hledger's print command and journal format (hledger_jour-
nal(5)). nal(5)).
The transaction's date(s) and any cleared flag, transaction code, The transaction's date(s) and any cleared flag, transaction code,
description, comments, along with all of its account postings are description, comments, along with all of its account postings are
shown. Simple transactions have two postings, but there can be more shown. Simple transactions have two postings, but there can be more
(or in certain cases, fewer). (or in certain cases, fewer).
up and down will step through all transactions listed in the previous up and down will step through all transactions listed in the previous
account register screen. In the title bar, the numbers in parentheses account register screen. In the title bar, the numbers in parentheses
show your position within that account register. They will vary show your position within that account register. They will vary
depending on which account register you came from (remember most trans- depending on which account register you came from (remember most trans-
actions appear in multiple account registers). The #N number preceding actions appear in multiple account registers). The #N number preceding
them is the transaction's position within the complete unfiltered jour- them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload). nal, which is a more stable id (at least until the next reload).
Error screen Error screen
This screen will appear if there is a problem, such as a parse error, This screen will appear if there is a problem, such as a parse error,
when you press g to reload. Once you have fixed the problem, press g when you press g to reload. Once you have fixed the problem, press g
again to reload and resume normal operation. (Or, you can press escape again to reload and resume normal operation. (Or, you can press escape
to cancel the reload attempt.) to cancel the reload attempt.)
TIPS TIPS
Watch mode Watch mode
One of hledger-ui's best features is the auto-reloading --watch mode. One of hledger-ui's best features is the auto-reloading --watch mode.
With this flag, it will update the display automatically whenever With this flag, it will update the display automatically whenever
changes are saved to the data files. changes are saved to the data files.
This is very useful when reconciling. A good workflow is to have your This is very useful when reconciling. A good workflow is to have your
bank's online register open in a browser window, for reference; the bank's online register open in a browser window, for reference; the
journal file open in an editor window; and hledger-ui in watch mode in journal file open in an editor window; and hledger-ui in watch mode in
a terminal window, eg: a terminal window, eg:
$ hledger-ui --watch --register checking -C $ hledger-ui --watch --register checking -C
As you mark things cleared in the editor, you can see the effect imme- As you mark things cleared in the editor, you can see the effect imme-
diately without having to context switch. This leaves more mental diately without having to context switch. This leaves more mental
bandwidth for your accounting. Of course you can still interact with bandwidth for your accounting. Of course you can still interact with
hledger-ui when needed, eg to toggle cleared mode, or to explore the hledger-ui when needed, eg to toggle cleared mode, or to explore the
history. history.
Watch mode limitations Watch mode limitations
There are situations in which it won't work, ie the display will not There are situations in which it won't work, ie the display will not
update when you save a change (because the underlying inotify library update when you save a change (because the underlying inotify library
does not support it). Here are some that we know of: does not support it). Here are some that we know of:
o Certain editors: saving with gedit, and perhaps any Gnome applica- o Certain editors: saving with gedit, and perhaps any Gnome applica-
tion, won't be detected (#1617). Jetbrains IDEs, such as IDEA, also tion, won't be detected (#1617). Jetbrains IDEs, such as IDEA, also
may not work (#911). may not work (#911).
o Certain unusual filesystems might not be supported. (All the usual o Certain unusual filesystems might not be supported. (All the usual
ones on unix, mac and windows are supported.) ones on unix, mac and windows are supported.)
In such cases, the workaround is to switch to the hledger-ui window and In such cases, the workaround is to switch to the hledger-ui window and
press g each time you want it to reload. (Actually, see #1617 for press g each time you want it to reload. (Actually, see #1617 for
another workaround, and let us know if it works for you.) another workaround, and let us know if it works for you.)
If you leave hledger-ui --watch running for days, on certain platforms If you leave hledger-ui --watch running for days, on certain platforms
(?), perhaps with many transactions in your journal (?), perhaps with (?), perhaps with many transactions in your journal (?), perhaps with
large numbers of other files present (?), you may see it gradually large numbers of other files present (?), you may see it gradually
using more and more memory and CPU over time, as seen in top or Activ- using more and more memory and CPU over time, as seen in top or Activ-
ity Monitor or Task Manager. ity Monitor or Task Manager.
A workaround is to quit and restart it, or to suspend it (CTRL-z) and A workaround is to quit and restart it, or to suspend it (CTRL-z) and
restart it (fg) if your shell supports that. restart it (fg) if your shell supports that.
ENVIRONMENT 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: LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal). nal).
A typical value is ~/DIR/YYYY.journal, where DIR is a version-con- A typical value is ~/DIR/YYYY.journal, where DIR is a version-con-
trolled finance directory and YYYY is the current year. Or ~/DIR/cur- trolled finance directory and YYYY is the current year. Or ~/DIR/cur-
rent.journal, where current.journal is a symbolic link to YYYY.journal. rent.journal, where current.journal is a symbolic link to YYYY.journal.
On Mac computers, you can set this and other environment variables in a On Mac computers, you can set this and other environment variables in a
more thorough way that also affects applications started from the GUI more thorough way that also affects applications started from the GUI
(say, an Emacs dock icon). Eg on MacOS Catalina I have a (say, an Emacs dock icon). Eg on MacOS Catalina I have a
~/.MacOSX/environment.plist file containing ~/.MacOSX/environment.plist file containing
{ {
@ -469,13 +479,13 @@ ENVIRONMENT
To see the effect you may need to killall Dock, or reboot. To see the effect you may need to killall Dock, or reboot.
FILES FILES
Reads data from one or more files in hledger journal, timeclock, time- Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). C:/Users/USER/.hledger.journal).
BUGS BUGS
The need to precede options with -- when invoked from hledger is awk- The need to precede options with -- when invoked from hledger is awk-
ward. ward.
-f- doesn't work (hledger-ui can't read from stdin). -f- doesn't work (hledger-ui can't read from stdin).
@ -483,24 +493,24 @@ BUGS
-V affects only the accounts screen. -V affects only the accounts screen.
When you press g, the current and all previous screens are regenerated, When you press g, the current and all previous screens are regenerated,
which may cause a noticeable pause with large files. Also there is no which may cause a noticeable pause with large files. Also there is no
visual indication that this is in progress. visual indication that this is in progress.
--watch is not yet fully robust. It works well for normal usage, but --watch is not yet fully robust. It works well for normal usage, but
many file changes in a short time (eg saving the file thousands of many file changes in a short time (eg saving the file thousands of
times with an editor macro) can cause problems at least on OSX. Symp- times with an editor macro) can cause problems at least on OSX. Symp-
toms include: unresponsive UI, periodic resetting of the cursor posi- toms include: unresponsive UI, periodic resetting of the cursor posi-
tion, momentary display of parse errors, high CPU usage eventually sub- tion, momentary display of parse errors, high CPU usage eventually sub-
siding, and possibly a small but persistent build-up of CPU usage until siding, and possibly a small but persistent build-up of CPU usage until
the program is restarted. the program is restarted.
Also, if you are viewing files mounted from another machine, --watch Also, if you are viewing files mounted from another machine, --watch
requires that both machine clocks are roughly in step. requires that both machine clocks are roughly in step.
REPORTING BUGS REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list) or hledger mail list)

View File

@ -3104,9 +3104,13 @@ Output as HTML and view with a browser:
.SS Commodity layout .SS Commodity layout
.PP .PP
With \f[C]--layout\f[R], you can control how amounts with more than one With \f[C]--layout\f[R], you can control how amounts with more than one
commodity are displayed: - \f[C]--layout=wide[,WIDTH]\f[R]: on a single commodity are displayed:
line, possibly elided to the specified width - \f[C]--layout=tall\f[R]: .IP \[bu] 2
each commodity is displayed on a separate line - \f[C]--layout=wide[,WIDTH]\f[R]: on a single line, possibly elided to
the specified width
.IP \[bu] 2
\f[C]--layout=tall\f[R]: each commodity is displayed on a separate line
.IP \[bu] 2
\f[C]--layout=bare\f[R]: commodity symbols are displayed in a separate \f[C]--layout=bare\f[R]: commodity symbols are displayed in a separate
column, and amounts are displayed as bare numbers column, and amounts are displayed as bare numbers
.IP .IP

View File

@ -2726,11 +2726,15 @@ File: hledger.info, Node: Commodity layout, Next: Sorting by amount, Prev: Mu
----------------------- -----------------------
With `--layout', you can control how amounts with more than one With `--layout', you can control how amounts with more than one
commodity are displayed: - `--layout=wide[,WIDTH]': on a single line, commodity are displayed:
possibly elided to the specified width - `--layout=tall': each
commodity is displayed on a separate line - `--layout=bare': commodity * `--layout=wide[,WIDTH]': on a single line, possibly elided to the
symbols are displayed in a separate column, and amounts are displayed specified width
as bare numbers
* `--layout=tall': each commodity is displayed on a separate line
* `--layout=bare': commodity symbols are displayed in a separate
column, and amounts are displayed as bare numbers
$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide
@ -9679,379 +9683,379 @@ Node: Multi-period balance report87607
Ref: #multi-period-balance-report87811 Ref: #multi-period-balance-report87811
Node: Commodity layout90090 Node: Commodity layout90090
Ref: #commodity-layout90262 Ref: #commodity-layout90262
Node: Sorting by amount95557 Node: Sorting by amount95579
Ref: #sorting-by-amount95715 Ref: #sorting-by-amount95737
Node: Percentages96380 Node: Percentages96402
Ref: #percentages96538 Ref: #percentages96560
Node: Balance change end balance97497 Node: Balance change end balance97519
Ref: #balance-change-end-balance97690 Ref: #balance-change-end-balance97712
Node: Balance report types99114 Node: Balance report types99136
Ref: #balance-report-types99304 Ref: #balance-report-types99326
Node: Useful balance reports103675 Node: Useful balance reports103697
Ref: #useful-balance-reports103856 Ref: #useful-balance-reports103878
Node: Budget report104940 Node: Budget report104962
Ref: #budget-report105124 Ref: #budget-report105146
Node: Budget report start date110329 Node: Budget report start date110351
Ref: #budget-report-start-date110507 Ref: #budget-report-start-date110529
Node: Budgets and subaccounts111834 Node: Budgets and subaccounts111856
Ref: #budgets-and-subaccounts112041 Ref: #budgets-and-subaccounts112063
Node: Selecting budget goals115428 Node: Selecting budget goals115450
Ref: #selecting-budget-goals115600 Ref: #selecting-budget-goals115622
Node: Customising single-period balance reports116630 Node: Customising single-period balance reports116652
Ref: #customising-single-period-balance-reports116839 Ref: #customising-single-period-balance-reports116861
Node: balancesheet119023 Node: balancesheet119045
Ref: #balancesheet119161 Ref: #balancesheet119183
Node: balancesheetequity120459 Node: balancesheetequity120481
Ref: #balancesheetequity120610 Ref: #balancesheetequity120632
Node: cashflow121990 Node: cashflow122012
Ref: #cashflow122114 Ref: #cashflow122136
Node: check123260 Node: check123282
Ref: #check123365 Ref: #check123387
Node: Basic checks123998 Node: Basic checks124020
Ref: #basic-checks124116 Ref: #basic-checks124138
Node: Strict checks124668 Node: Strict checks124690
Ref: #strict-checks124809 Ref: #strict-checks124831
Node: Other checks125245 Node: Other checks125267
Ref: #other-checks125385 Ref: #other-checks125407
Node: Custom checks125742 Node: Custom checks125764
Ref: #custom-checks125862 Ref: #custom-checks125884
Node: close126280 Node: close126302
Ref: #close126384 Ref: #close126406
Node: close and prices128470 Node: close and prices128492
Ref: #close-and-prices128599 Ref: #close-and-prices128621
Node: close date128993 Node: close date129015
Ref: #close-date129177 Ref: #close-date129199
Node: Example close asset/liability accounts for file transition129923 Node: Example close asset/liability accounts for file transition129945
Ref: #example-close-assetliability-accounts-for-file-transition130224 Ref: #example-close-assetliability-accounts-for-file-transition130246
Node: Hiding opening/closing transactions131086 Node: Hiding opening/closing transactions131108
Ref: #hiding-openingclosing-transactions131357 Ref: #hiding-openingclosing-transactions131379
Node: close and balance assertions132738 Node: close and balance assertions132760
Ref: #close-and-balance-assertions132996 Ref: #close-and-balance-assertions133018
Node: Example close revenue/expense accounts to retained earnings134350 Node: Example close revenue/expense accounts to retained earnings134372
Ref: #example-close-revenueexpense-accounts-to-retained-earnings134628 Ref: #example-close-revenueexpense-accounts-to-retained-earnings134650
Node: codes135521 Node: codes135543
Ref: #codes135631 Ref: #codes135653
Node: commodities136344 Node: commodities136366
Ref: #commodities136473 Ref: #commodities136495
Node: descriptions136555 Node: descriptions136577
Ref: #descriptions136685 Ref: #descriptions136707
Node: diff136989 Node: diff137011
Ref: #diff137097 Ref: #diff137119
Node: files138142 Node: files138164
Ref: #files138244 Ref: #files138266
Node: help138390 Node: help138412
Ref: #help138492 Ref: #help138514
Node: import139307 Node: import139329
Ref: #import139423 Ref: #import139445
Node: Deduplication140285 Node: Deduplication140307
Ref: #deduplication140410 Ref: #deduplication140432
Node: Import testing142298 Node: Import testing142320
Ref: #import-testing142463 Ref: #import-testing142485
Node: Importing balance assignments142953 Node: Importing balance assignments142975
Ref: #importing-balance-assignments143159 Ref: #importing-balance-assignments143181
Node: Commodity display styles143806 Node: Commodity display styles143828
Ref: #commodity-display-styles143979 Ref: #commodity-display-styles144001
Node: incomestatement144108 Node: incomestatement144130
Ref: #incomestatement144243 Ref: #incomestatement144265
Node: notes145544 Node: notes145566
Ref: #notes145659 Ref: #notes145681
Node: payees146026 Node: payees146048
Ref: #payees146134 Ref: #payees146156
Node: prices146660 Node: prices146682
Ref: #prices146768 Ref: #prices146790
Node: print147133 Node: print147155
Ref: #print147245 Ref: #print147267
Node: print-unique152555 Node: print-unique152577
Ref: #print-unique152683 Ref: #print-unique152705
Node: register152969 Node: register152991
Ref: #register153098 Ref: #register153120
Node: Custom register output157542 Node: Custom register output157564
Ref: #custom-register-output157673 Ref: #custom-register-output157695
Node: register-match159010 Node: register-match159032
Ref: #register-match159146 Ref: #register-match159168
Node: rewrite159494 Node: rewrite159516
Ref: #rewrite159611 Ref: #rewrite159633
Node: Re-write rules in a file161517 Node: Re-write rules in a file161539
Ref: #re-write-rules-in-a-file161680 Ref: #re-write-rules-in-a-file161702
Node: Diff output format162830 Node: Diff output format162852
Ref: #diff-output-format163013 Ref: #diff-output-format163035
Node: rewrite vs print --auto164105 Node: rewrite vs print --auto164127
Ref: #rewrite-vs.-print---auto164265 Ref: #rewrite-vs.-print---auto164287
Node: roi164815 Node: roi164837
Ref: #roi164915 Ref: #roi164937
Node: Spaces and special characters in --inv and --pnl166603 Node: Spaces and special characters in --inv and --pnl166625
Ref: #spaces-and-special-characters-in---inv-and---pnl166844 Ref: #spaces-and-special-characters-in---inv-and---pnl166866
Node: Semantics of --inv and --pnl167337 Node: Semantics of --inv and --pnl167359
Ref: #semantics-of---inv-and---pnl167576 Ref: #semantics-of---inv-and---pnl167598
Node: IRR and TWR explained169422 Node: IRR and TWR explained169444
Ref: #irr-and-twr-explained169582 Ref: #irr-and-twr-explained169604
Node: stats172644 Node: stats172666
Ref: #stats172745 Ref: #stats172767
Node: tags173532 Node: tags173554
Ref: #tags173632 Ref: #tags173654
Node: test174149 Node: test174171
Ref: #test174265 Ref: #test174287
Node: About add-on commands175010 Node: About add-on commands175032
Ref: #about-add-on-commands175147 Ref: #about-add-on-commands175169
Node: JOURNAL FORMAT176280 Node: JOURNAL FORMAT176302
Ref: #journal-format176408 Ref: #journal-format176430
Node: Transactions178628 Node: Transactions178650
Ref: #transactions178743 Ref: #transactions178765
Node: Dates179760 Node: Dates179782
Ref: #dates179876 Ref: #dates179898
Node: Simple dates179941 Node: Simple dates179963
Ref: #simple-dates180061 Ref: #simple-dates180083
Node: Secondary dates180568 Node: Secondary dates180590
Ref: #secondary-dates180716 Ref: #secondary-dates180738
Node: Posting dates182050 Node: Posting dates182072
Ref: #posting-dates182173 Ref: #posting-dates182195
Node: Status183542 Node: Status183564
Ref: #status183652 Ref: #status183674
Node: Code185357 Node: Code185379
Ref: #code185469 Ref: #code185491
Node: Description185700 Node: Description185722
Ref: #description185828 Ref: #description185850
Node: Payee and note186146 Node: Payee and note186168
Ref: #payee-and-note186254 Ref: #payee-and-note186276
Node: Comments186588 Node: Comments186610
Ref: #comments186710 Ref: #comments186732
Node: Tags187903 Node: Tags187925
Ref: #tags-1188014 Ref: #tags-1188036
Node: Postings189412 Node: Postings189434
Ref: #postings189536 Ref: #postings189558
Node: Virtual postings190560 Node: Virtual postings190582
Ref: #virtual-postings190671 Ref: #virtual-postings190693
Node: Account names191973 Node: Account names191995
Ref: #account-names192110 Ref: #account-names192132
Node: Amounts192596 Node: Amounts192618
Ref: #amounts192733 Ref: #amounts192755
Node: Decimal marks digit group marks193720 Node: Decimal marks digit group marks193742
Ref: #decimal-marks-digit-group-marks193897 Ref: #decimal-marks-digit-group-marks193919
Node: Commodity194918 Node: Commodity194940
Ref: #commodity195107 Ref: #commodity195129
Node: Directives influencing number parsing and display196057 Node: Directives influencing number parsing and display196079
Ref: #directives-influencing-number-parsing-and-display196318 Ref: #directives-influencing-number-parsing-and-display196340
Node: Commodity display style196810 Node: Commodity display style196832
Ref: #commodity-display-style197018 Ref: #commodity-display-style197040
Node: Rounding199213 Node: Rounding199235
Ref: #rounding199333 Ref: #rounding199355
Node: Transaction prices199743 Node: Transaction prices199765
Ref: #transaction-prices199909 Ref: #transaction-prices199931
Node: Lot prices lot dates202339 Node: Lot prices lot dates202361
Ref: #lot-prices-lot-dates202522 Ref: #lot-prices-lot-dates202544
Node: Balance assertions203009 Node: Balance assertions203031
Ref: #balance-assertions203187 Ref: #balance-assertions203209
Node: Assertions and ordering204217 Node: Assertions and ordering204239
Ref: #assertions-and-ordering204399 Ref: #assertions-and-ordering204421
Node: Assertions and included files205096 Node: Assertions and included files205118
Ref: #assertions-and-included-files205333 Ref: #assertions-and-included-files205355
Node: Assertions and multiple -f options205664 Node: Assertions and multiple -f options205686
Ref: #assertions-and-multiple--f-options205914 Ref: #assertions-and-multiple--f-options205936
Node: Assertions and commodities206045 Node: Assertions and commodities206067
Ref: #assertions-and-commodities206271 Ref: #assertions-and-commodities206293
Node: Assertions and prices207426 Node: Assertions and prices207448
Ref: #assertions-and-prices207634 Ref: #assertions-and-prices207656
Node: Assertions and subaccounts208075 Node: Assertions and subaccounts208097
Ref: #assertions-and-subaccounts208298 Ref: #assertions-and-subaccounts208320
Node: Assertions and virtual postings208622 Node: Assertions and virtual postings208644
Ref: #assertions-and-virtual-postings208858 Ref: #assertions-and-virtual-postings208880
Node: Assertions and precision208999 Node: Assertions and precision209021
Ref: #assertions-and-precision209186 Ref: #assertions-and-precision209208
Node: Balance assignments209451 Node: Balance assignments209473
Ref: #balance-assignments209621 Ref: #balance-assignments209643
Node: Balance assignments and prices210784 Node: Balance assignments and prices210806
Ref: #balance-assignments-and-prices210950 Ref: #balance-assignments-and-prices210972
Node: Directives211176 Node: Directives211198
Ref: #directives211339 Ref: #directives211361
Node: Directives and multiple files217082 Node: Directives and multiple files217104
Ref: #directives-and-multiple-files217278 Ref: #directives-and-multiple-files217300
Node: Comment blocks217940 Node: Comment blocks217962
Ref: #comment-blocks218117 Ref: #comment-blocks218139
Node: Including other files218292 Node: Including other files218314
Ref: #including-other-files218466 Ref: #including-other-files218488
Node: Default year219390 Node: Default year219412
Ref: #default-year219548 Ref: #default-year219570
Node: Declaring payees219955 Node: Declaring payees219977
Ref: #declaring-payees220126 Ref: #declaring-payees220148
Node: Declaring the decimal mark220371 Node: Declaring the decimal mark220393
Ref: #declaring-the-decimal-mark220571 Ref: #declaring-the-decimal-mark220593
Node: Declaring commodities220969 Node: Declaring commodities220991
Ref: #declaring-commodities221160 Ref: #declaring-commodities221182
Node: Commodity error checking223674 Node: Commodity error checking223696
Ref: #commodity-error-checking223824 Ref: #commodity-error-checking223846
Node: Default commodity224080 Node: Default commodity224102
Ref: #default-commodity224260 Ref: #default-commodity224282
Node: Declaring market prices225134 Node: Declaring market prices225156
Ref: #declaring-market-prices225323 Ref: #declaring-market-prices225345
Node: Declaring accounts226135 Node: Declaring accounts226157
Ref: #declaring-accounts226315 Ref: #declaring-accounts226337
Node: Account error checking227522 Node: Account error checking227544
Ref: #account-error-checking227688 Ref: #account-error-checking227710
Node: Account comments228865 Node: Account comments228887
Ref: #account-comments229049 Ref: #account-comments229071
Node: Account subdirectives229475 Node: Account subdirectives229497
Ref: #account-subdirectives229660 Ref: #account-subdirectives229682
Node: Account types229975 Node: Account types229997
Ref: #account-types230149 Ref: #account-types230171
Node: Declaring account types230806 Node: Declaring account types230828
Ref: #declaring-account-types230985 Ref: #declaring-account-types231007
Node: Auto-detected account types232037 Node: Auto-detected account types232059
Ref: #auto-detected-account-types232224 Ref: #auto-detected-account-types232246
Node: Account display order234236 Node: Account display order234258
Ref: #account-display-order234396 Ref: #account-display-order234418
Node: Rewriting accounts235547 Node: Rewriting accounts235569
Ref: #rewriting-accounts235726 Ref: #rewriting-accounts235748
Node: Basic aliases236485 Node: Basic aliases236507
Ref: #basic-aliases236621 Ref: #basic-aliases236643
Node: Regex aliases237363 Node: Regex aliases237385
Ref: #regex-aliases237525 Ref: #regex-aliases237547
Node: Combining aliases238245 Node: Combining aliases238267
Ref: #combining-aliases238428 Ref: #combining-aliases238450
Node: Aliases and multiple files239705 Node: Aliases and multiple files239727
Ref: #aliases-and-multiple-files239904 Ref: #aliases-and-multiple-files239926
Node: end aliases240485 Node: end aliases240507
Ref: #end-aliases240632 Ref: #end-aliases240654
Node: Default parent account240734 Node: Default parent account240756
Ref: #default-parent-account240924 Ref: #default-parent-account240946
Node: Periodic transactions241808 Node: Periodic transactions241830
Ref: #periodic-transactions241991 Ref: #periodic-transactions242013
Node: Periodic rule syntax243908 Node: Periodic rule syntax243930
Ref: #periodic-rule-syntax244108 Ref: #periodic-rule-syntax244130
Node: Two spaces between period expression and description!244811 Node: Two spaces between period expression and description!244833
Ref: #two-spaces-between-period-expression-and-description245124 Ref: #two-spaces-between-period-expression-and-description245146
Node: Forecasting with periodic transactions245809 Node: Forecasting with periodic transactions245831
Ref: #forecasting-with-periodic-transactions246108 Ref: #forecasting-with-periodic-transactions246130
Node: Budgeting with periodic transactions248876 Node: Budgeting with periodic transactions248898
Ref: #budgeting-with-periodic-transactions249109 Ref: #budgeting-with-periodic-transactions249131
Node: Auto postings249516 Node: Auto postings249538
Ref: #auto-postings249652 Ref: #auto-postings249674
Node: Auto postings and multiple files251835 Node: Auto postings and multiple files251857
Ref: #auto-postings-and-multiple-files252033 Ref: #auto-postings-and-multiple-files252055
Node: Auto postings and dates252241 Node: Auto postings and dates252263
Ref: #auto-postings-and-dates252509 Ref: #auto-postings-and-dates252531
Node: Auto postings and transaction balancing / inferred amounts / balance assertions252684 Node: Auto postings and transaction balancing / inferred amounts / balance assertions252706
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions253030 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions253052
Node: Auto posting tags253536 Node: Auto posting tags253558
Ref: #auto-posting-tags253745 Ref: #auto-posting-tags253767
Node: CSV FORMAT254382 Node: CSV FORMAT254404
Ref: #csv-format254510 Ref: #csv-format254532
Node: Examples257134 Node: Examples257156
Ref: #examples257237 Ref: #examples257259
Node: Basic257444 Node: Basic257466
Ref: #basic257546 Ref: #basic257568
Node: Bank of Ireland258090 Node: Bank of Ireland258112
Ref: #bank-of-ireland258227 Ref: #bank-of-ireland258249
Node: Amazon259692 Node: Amazon259714
Ref: #amazon259812 Ref: #amazon259834
Node: Paypal261533 Node: Paypal261555
Ref: #paypal261629 Ref: #paypal261651
Node: CSV rules269277 Node: CSV rules269299
Ref: #csv-rules269395 Ref: #csv-rules269417
Node: skip269728 Node: skip269750
Ref: #skip269828 Ref: #skip269850
Node: fields list270200 Node: fields list270222
Ref: #fields-list270339 Ref: #fields-list270361
Node: field assignment271844 Node: field assignment271866
Ref: #field-assignment271996 Ref: #field-assignment272018
Node: Field names273028 Node: Field names273050
Ref: #field-names273168 Ref: #field-names273190
Node: date field273547 Node: date field273569
Ref: #date-field273667 Ref: #date-field273689
Node: date2 field273715 Node: date2 field273737
Ref: #date2-field273858 Ref: #date2-field273880
Node: status field273914 Node: status field273936
Ref: #status-field274059 Ref: #status-field274081
Node: code field274108 Node: code field274130
Ref: #code-field274255 Ref: #code-field274277
Node: description field274300 Node: description field274322
Ref: #description-field274462 Ref: #description-field274484
Node: comment field274521 Node: comment field274543
Ref: #comment-field274678 Ref: #comment-field274700
Node: account field274977 Node: account field274999
Ref: #account-field275129 Ref: #account-field275151
Node: amount field275703 Node: amount field275725
Ref: #amount-field275854 Ref: #amount-field275876
Node: currency field277092 Node: currency field277114
Ref: #currency-field277247 Ref: #currency-field277269
Node: balance field277503 Node: balance field277525
Ref: #balance-field277637 Ref: #balance-field277659
Node: separator278009 Node: separator278031
Ref: #separator278141 Ref: #separator278163
Node: if block278683 Node: if block278705
Ref: #if-block278810 Ref: #if-block278832
Node: Matching the whole record279208 Node: Matching the whole record279230
Ref: #matching-the-whole-record279385 Ref: #matching-the-whole-record279407
Node: Matching individual fields280188 Node: Matching individual fields280210
Ref: #matching-individual-fields280394 Ref: #matching-individual-fields280416
Node: Combining matchers280618 Node: Combining matchers280640
Ref: #combining-matchers280816 Ref: #combining-matchers280838
Node: Rules applied on successful match281130 Node: Rules applied on successful match281152
Ref: #rules-applied-on-successful-match281323 Ref: #rules-applied-on-successful-match281345
Node: if table281980 Node: if table282002
Ref: #if-table282101 Ref: #if-table282123
Node: end283837 Node: end283859
Ref: #end283951 Ref: #end283973
Node: date-format284175 Node: date-format284197
Ref: #date-format284309 Ref: #date-format284331
Node: decimal-mark285306 Node: decimal-mark285328
Ref: #decimal-mark285453 Ref: #decimal-mark285475
Node: newest-first285790 Node: newest-first285812
Ref: #newest-first285933 Ref: #newest-first285955
Node: include286616 Node: include286638
Ref: #include286749 Ref: #include286771
Node: balance-type287191 Node: balance-type287213
Ref: #balance-type287313 Ref: #balance-type287335
Node: Tips288013 Node: Tips288035
Ref: #tips288104 Ref: #tips288126
Node: Rapid feedback288403 Node: Rapid feedback288425
Ref: #rapid-feedback288522 Ref: #rapid-feedback288544
Node: Valid CSV288973 Node: Valid CSV288995
Ref: #valid-csv289105 Ref: #valid-csv289127
Node: File Extension289297 Node: File Extension289319
Ref: #file-extension289451 Ref: #file-extension289473
Node: Reading multiple CSV files289880 Node: Reading multiple CSV files289902
Ref: #reading-multiple-csv-files290067 Ref: #reading-multiple-csv-files290089
Node: Valid transactions290307 Node: Valid transactions290329
Ref: #valid-transactions290487 Ref: #valid-transactions290509
Node: Deduplicating importing291115 Node: Deduplicating importing291137
Ref: #deduplicating-importing291296 Ref: #deduplicating-importing291318
Node: Setting amounts292328 Node: Setting amounts292350
Ref: #setting-amounts292485 Ref: #setting-amounts292507
Node: Amount signs294926 Node: Amount signs294948
Ref: #amount-signs295080 Ref: #amount-signs295102
Node: Setting currency/commodity295767 Node: Setting currency/commodity295789
Ref: #setting-currencycommodity295955 Ref: #setting-currencycommodity295977
Node: Amount decimal places297135 Node: Amount decimal places297157
Ref: #amount-decimal-places297327 Ref: #amount-decimal-places297349
Node: Referencing other fields297639 Node: Referencing other fields297661
Ref: #referencing-other-fields297838 Ref: #referencing-other-fields297860
Node: How CSV rules are evaluated298736 Node: How CSV rules are evaluated298758
Ref: #how-csv-rules-are-evaluated298911 Ref: #how-csv-rules-are-evaluated298933
Node: TIMECLOCK FORMAT300360 Node: TIMECLOCK FORMAT300382
Ref: #timeclock-format300500 Ref: #timeclock-format300522
Node: TIMEDOT FORMAT302568 Node: TIMEDOT FORMAT302590
Ref: #timedot-format302706 Ref: #timedot-format302728
Node: COMMON TASKS307265 Node: COMMON TASKS307287
Ref: #common-tasks307394 Ref: #common-tasks307416
Node: Getting help307801 Node: Getting help307823
Ref: #getting-help307935 Ref: #getting-help307957
Node: Constructing command lines308486 Node: Constructing command lines308508
Ref: #constructing-command-lines308680 Ref: #constructing-command-lines308702
Node: Starting a journal file309379 Node: Starting a journal file309401
Ref: #starting-a-journal-file309579 Ref: #starting-a-journal-file309601
Node: Setting opening balances310766 Node: Setting opening balances310788
Ref: #setting-opening-balances310964 Ref: #setting-opening-balances310986
Node: Recording transactions314097 Node: Recording transactions314119
Ref: #recording-transactions314279 Ref: #recording-transactions314301
Node: Reconciling314836 Node: Reconciling314858
Ref: #reconciling314981 Ref: #reconciling315003
Node: Reporting317226 Node: Reporting317248
Ref: #reporting317368 Ref: #reporting317390
Node: Migrating to a new file321288 Node: Migrating to a new file321310
Ref: #migrating-to-a-new-file321438 Ref: #migrating-to-a-new-file321460
Node: LIMITATIONS321736 Node: LIMITATIONS321758
Ref: #limitations321864 Ref: #limitations321886
Node: TROUBLESHOOTING322605 Node: TROUBLESHOOTING322627
Ref: #troubleshooting322720 Ref: #troubleshooting322742
 
End Tag Table End Tag Table

File diff suppressed because it is too large Load Diff