diff --git a/hledger-lib/.date.m4 b/hledger-lib/.date.m4 index f4bc2db3f..4aa7c88b5 100644 --- a/hledger-lib/.date.m4 +++ b/hledger-lib/.date.m4 @@ -1,2 +1,2 @@ m4_dnl Date to show in man pages. Updated by "Shake manuals" -m4_define({{_monthyear_}}, {{November 2022}})m4_dnl +m4_define({{_monthyear_}}, {{December 2022}})m4_dnl diff --git a/hledger-ui/.date.m4 b/hledger-ui/.date.m4 index f4bc2db3f..4aa7c88b5 100644 --- a/hledger-ui/.date.m4 +++ b/hledger-ui/.date.m4 @@ -1,2 +1,2 @@ m4_dnl Date to show in man pages. Updated by "Shake manuals" -m4_define({{_monthyear_}}, {{November 2022}})m4_dnl +m4_define({{_monthyear_}}, {{December 2022}})m4_dnl diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1 index c41b99084..5e3ba5088 100644 --- a/hledger-ui/hledger-ui.1 +++ b/hledger-ui/hledger-ui.1 @@ -1,5 +1,5 @@ -.TH "HLEDGER-UI" "1" "November 2022" "hledger-ui-1.27.99 " "hledger User Manuals" +.TH "HLEDGER-UI" "1" "December 2022" "hledger-ui-1.28.99 " "hledger User Manuals" @@ -7,14 +7,14 @@ .PP hledger-ui is a terminal interface (TUI) for the hledger accounting tool. -This manual is for hledger-ui 1.27.99. +This manual is for hledger-ui 1.28.99. .SH SYNOPSIS .PP -\f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R] +\f[V]hledger-ui [OPTIONS] [QUERYARGS]\f[R] .PD 0 .P .PD -\f[C]hledger ui -- [OPTIONS] [QUERYARGS]\f[R] +\f[V]hledger ui -- [OPTIONS] [QUERYARGS]\f[R] .SH DESCRIPTION .PP hledger is a reliable, cross-platform set of programs for tracking @@ -29,9 +29,9 @@ It is easier than hledger\[aq]s command-line interface, and sometimes quicker and more convenient than the web interface. .PP Like hledger, it reads data from one or more files in hledger journal, -timeclock, timedot, or CSV format specified with \f[C]-f\f[R], or -\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, -perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). +timeclock, timedot, or CSV format specified with \f[V]-f\f[R], or +\f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows, +perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]). For more about this see hledger(1), hledger_journal(5) etc. .PP Unlike hledger, hledger-ui hides all future-dated transactions by @@ -41,155 +41,155 @@ transactions, by pressing the F key (or starting with --forecast) to enable \[dq]forecast mode\[dq]. .SH OPTIONS .PP -Note: if invoking hledger-ui as a hledger subcommand, write \f[C]--\f[R] +Note: if invoking hledger-ui as a hledger subcommand, write \f[V]--\f[R] before options as shown above. .PP Any QUERYARGS are interpreted as a hledger search query which filters the data. .TP -\f[B]\f[CB]-w --watch\f[B]\f[R] +\f[V]-w --watch\f[R] watch for data and date changes and reload automatically .TP -\f[B]\f[CB]--theme=default|terminal|greenterm\f[B]\f[R] +\f[V]--theme=default|terminal|greenterm\f[R] use this custom display theme .TP -\f[B]\f[CB]--menu\f[B]\f[R] +\f[V]--menu\f[R] start in the menu screen .TP -\f[B]\f[CB]--all\f[B]\f[R] +\f[V]--all\f[R] start in the all accounts screen .TP -\f[B]\f[CB]--bs\f[B]\f[R] +\f[V]--bs\f[R] start in the balance sheet accounts screen .TP -\f[B]\f[CB]--is\f[B]\f[R] +\f[V]--is\f[R] start in the income statement accounts screen .TP -\f[B]\f[CB]--register=ACCTREGEX\f[B]\f[R] +\f[V]--register=ACCTREGEX\f[R] start in the (first) matched account\[aq]s register screen .TP -\f[B]\f[CB]--change\f[B]\f[R] +\f[V]--change\f[R] show period balances (changes) at startup instead of historical balances .TP -\f[B]\f[CB]-l --flat\f[B]\f[R] +\f[V]-l --flat\f[R] show accounts as a flat list (default) .TP -\f[B]\f[CB]-t --tree\f[B]\f[R] +\f[V]-t --tree\f[R] show accounts as a tree .PP hledger input options: .TP -\f[B]\f[CB]-f FILE --file=FILE\f[B]\f[R] +\f[V]-f FILE --file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or -\f[C]$HOME/.hledger.journal\f[R]) +For stdin, use - (default: \f[V]$LEDGER_FILE\f[R] or +\f[V]$HOME/.hledger.journal\f[R]) .TP -\f[B]\f[CB]--rules-file=RULESFILE\f[B]\f[R] +\f[V]--rules-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP -\f[B]\f[CB]--separator=CHAR\f[B]\f[R] +\f[V]--separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[B]\f[CB]--alias=OLD=NEW\f[B]\f[R] +\f[V]--alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[B]\f[CB]--anon\f[B]\f[R] +\f[V]--anon\f[R] anonymize accounts and payees .TP -\f[B]\f[CB]--pivot FIELDNAME\f[B]\f[R] +\f[V]--pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R] +\f[V]-I --ignore-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[B]\f[CB]-s --strict\f[B]\f[R] +\f[V]-s --strict\f[R] do extra error checking (check that all posted accounts are declared) .PP hledger reporting options: .TP -\f[B]\f[CB]-b --begin=DATE\f[B]\f[R] +\f[V]-b --begin=DATE\f[R] include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) .TP -\f[B]\f[CB]-e --end=DATE\f[B]\f[R] +\f[V]-e --end=DATE\f[R] include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) .TP -\f[B]\f[CB]-D --daily\f[B]\f[R] +\f[V]-D --daily\f[R] multiperiod/multicolumn report by day .TP -\f[B]\f[CB]-W --weekly\f[B]\f[R] +\f[V]-W --weekly\f[R] multiperiod/multicolumn report by week .TP -\f[B]\f[CB]-M --monthly\f[B]\f[R] +\f[V]-M --monthly\f[R] multiperiod/multicolumn report by month .TP -\f[B]\f[CB]-Q --quarterly\f[B]\f[R] +\f[V]-Q --quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[B]\f[CB]-Y --yearly\f[B]\f[R] +\f[V]-Y --yearly\f[R] multiperiod/multicolumn report by year .TP -\f[B]\f[CB]-p --period=PERIODEXP\f[B]\f[R] +\f[V]-p --period=PERIODEXP\f[R] set start date, end date, and/or reporting interval all at once using period expressions syntax .TP -\f[B]\f[CB]--date2\f[B]\f[R] +\f[V]--date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[B]\f[CB]--today=DATE\f[B]\f[R] +\f[V]--today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[B]\f[CB]-U --unmarked\f[B]\f[R] +\f[V]-U --unmarked\f[R] include only unmarked postings/txns (can combine with -P or -C) .TP -\f[B]\f[CB]-P --pending\f[B]\f[R] +\f[V]-P --pending\f[R] include only pending postings/txns .TP -\f[B]\f[CB]-C --cleared\f[B]\f[R] +\f[V]-C --cleared\f[R] include only cleared postings/txns .TP -\f[B]\f[CB]-R --real\f[B]\f[R] +\f[V]-R --real\f[R] include only non-virtual postings .TP -\f[B]\f[CB]-NUM --depth=NUM\f[B]\f[R] +\f[V]-NUM --depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[B]\f[CB]-E --empty\f[B]\f[R] +\f[V]-E --empty\f[R] show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) .TP -\f[B]\f[CB]-B --cost\f[B]\f[R] +\f[V]-B --cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[B]\f[CB]-V --market\f[B]\f[R] +\f[V]-V --market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[B]\f[CB]-X --exchange=COMM\f[B]\f[R] +\f[V]-X --exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[B]\f[CB]--value\f[B]\f[R] +\f[V]--value\f[R] convert amounts to cost or market value, more flexibly than -B/-V/-X .TP -\f[B]\f[CB]--infer-market-prices\f[B]\f[R] +\f[V]--infer-market-prices\f[R] use transaction prices (recorded with \[at] or \[at]\[at]) as additional market prices, as if they were P directives .TP -\f[B]\f[CB]--auto\f[B]\f[R] +\f[V]--auto\f[R] apply automated posting rules to modify transactions. .TP -\f[B]\f[CB]--forecast\f[B]\f[R] +\f[V]--forecast\f[R] generate future transactions from periodic transaction rules, for the next 6 months or till report end date. In hledger-ui, also make ordinary future transactions visible. .TP -\f[B]\f[CB]--commodity-style\f[B]\f[R] +\f[V]--commodity-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP -\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R] +\f[V]--color=WHEN (or --colour=WHEN)\f[R] Should color-supporting commands use ANSI color codes in text output. \[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting terminal. @@ -198,7 +198,7 @@ into \[aq]less -R\[aq]. \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[B]\f[CB]--pretty[=WHEN]\f[B]\f[R] +\f[V]--pretty[=WHEN]\f[R] Show prettier output, e.g. using unicode box-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], @@ -213,24 +213,24 @@ Some reporting options can also be written as query arguments. .PP hledger help options: .TP -\f[B]\f[CB]-h --help\f[B]\f[R] +\f[V]-h --help\f[R] show general or COMMAND help .TP -\f[B]\f[CB]--man\f[B]\f[R] +\f[V]--man\f[R] show general or COMMAND user manual with man .TP -\f[B]\f[CB]--info\f[B]\f[R] +\f[V]--info\f[R] show general or COMMAND user manual with info .TP -\f[B]\f[CB]--version\f[B]\f[R] +\f[V]--version\f[R] show general or ADDONCMD version .TP -\f[B]\f[CB]--debug[=N]\f[B]\f[R] +\f[V]--debug[=N]\f[R] show debug output (levels 1-9, default: 1) .PP A \[at]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 \f[C]--\f[R] argument before.) +(To prevent this, insert a \f[V]--\f[R] argument before.) .SH MOUSE .PP In most modern terminals, you can navigate through the screens with a @@ -240,25 +240,25 @@ Use mouse wheel or trackpad to scroll up and down .IP \[bu] 2 Click on list items to go deeper .IP \[bu] 2 -Click on the left margin (column 0), or the blank area at bottom of -screen, to go back. +Click on the left margin (column 0) to go back. .SH KEYS .PP Keyboard gives more control. .PP -\f[C]?\f[R] shows a help dialog listing all keys. +\f[V]?\f[R] shows a help dialog listing all keys. (Some of these also appear in the quick help at the bottom of each -screen.) Press \f[C]?\f[R] again (or \f[C]ESCAPE\f[R], or -\f[C]LEFT\f[R], or \f[C]q\f[R]) to close it. +screen.) +Press \f[V]?\f[R] again (or \f[V]ESCAPE\f[R], or \f[V]LEFT\f[R], or +\f[V]q\f[R]) to close it. The following keys work on most screens: .PP -The cursor keys navigate: \f[C]RIGHT\f[R] or \f[C]ENTER\f[R] goes -deeper, \f[C]LEFT\f[R] returns to the previous screen, -\f[C]UP\f[R]/\f[C]DOWN\f[R]/\f[C]PGUP\f[R]/\f[C]PGDN\f[R]/\f[C]HOME\f[R]/\f[C]END\f[R] +The cursor keys navigate: \f[V]RIGHT\f[R] or \f[V]ENTER\f[R] goes +deeper, \f[V]LEFT\f[R] returns to the previous screen, +\f[V]UP\f[R]/\f[V]DOWN\f[R]/\f[V]PGUP\f[R]/\f[V]PGDN\f[R]/\f[V]HOME\f[R]/\f[V]END\f[R] move up and down through lists. Emacs-style -(\f[C]CTRL-p\f[R]/\f[C]CTRL-n\f[R]/\f[C]CTRL-f\f[R]/\f[C]CTRL-b\f[R]) -and VI-style (\f[C]k\f[R],\f[C]j\f[R],\f[C]l\f[R],\f[C]h\f[R]) movement +(\f[V]CTRL-p\f[R]/\f[V]CTRL-n\f[R]/\f[V]CTRL-f\f[R]/\f[V]CTRL-b\f[R]) +and VI-style (\f[V]k\f[R],\f[V]j\f[R],\f[V]l\f[R],\f[V]h\f[R]) movement keys are also supported. A tip: movement speed is limited by your keyboard repeat rate, to move faster you may want to adjust it. @@ -266,123 +266,123 @@ faster you may want to adjust it. .PP With shift pressed, the cursor keys adjust the report period, limiting the transactions to be shown (by default, all are shown). -\f[C]SHIFT-DOWN/UP\f[R] steps downward and upward through these standard +\f[V]SHIFT-DOWN/UP\f[R] steps downward and upward through these standard report period durations: year, quarter, month, week, day. -Then, \f[C]SHIFT-LEFT/RIGHT\f[R] moves to the previous/next period. -\f[C]T\f[R] sets the report period to today. -With the \f[C]-w/--watch\f[R] option, when viewing a \[dq]current\[dq] +Then, \f[V]SHIFT-LEFT/RIGHT\f[R] moves to the previous/next period. +\f[V]T\f[R] sets the report period to today. +With the \f[V]-w/--watch\f[R] option, when viewing a \[dq]current\[dq] period (the current day, week, month, quarter, or year), the period will move automatically to track the current date. -To set a non-standard period, you can use \f[C]/\f[R] and a -\f[C]date:\f[R] query. +To set a non-standard period, you can use \f[V]/\f[R] and a +\f[V]date:\f[R] query. .PP -\f[C]/\f[R] lets you set a general filter query limiting the data shown, +\f[V]/\f[R] lets you set a general filter query limiting the data shown, using the same query terms as in hledger and hledger-web. While editing the query, you can use CTRL-a/e/d/k, BS, cursor keys; -press \f[C]ENTER\f[R] to set it, or \f[C]ESCAPE\f[R]to cancel. +press \f[V]ENTER\f[R] to set it, or \f[V]ESCAPE\f[R]to cancel. There are also keys for quickly adjusting some common filters like account depth and transaction status (see below). -\f[C]BACKSPACE\f[R] or \f[C]DELETE\f[R] removes all filters, showing all +\f[V]BACKSPACE\f[R] or \f[V]DELETE\f[R] removes all filters, showing all transactions. .PP As mentioned above, by default hledger-ui hides future transactions - both ordinary transactions recorded in the journal, and periodic transactions generated by rule. -\f[C]F\f[R] toggles forecast mode, in which future/forecasted +\f[V]F\f[R] toggles forecast mode, in which future/forecasted transactions are shown. .PP -\f[C]ESCAPE\f[R] resets the UI state and jumps back to the top screen, +\f[V]ESCAPE\f[R] resets the UI state and jumps back to the top screen, restoring the app\[aq]s initial state at startup. Or, it cancels minibuffer data entry or the help dialog. .PP -\f[C]CTRL-l\f[R] redraws the screen and centers the selection if +\f[V]CTRL-l\f[R] redraws the screen and centers the selection if possible (selections near the top won\[aq]t be centered, since we don\[aq]t scroll above the top). .PP -\f[C]g\f[R] reloads from the data file(s) and updates the current screen +\f[V]g\f[R] reloads from the data file(s) and updates the current screen and any previous screens. (With large files, this could cause a noticeable pause.) .PP -\f[C]I\f[R] toggles balance assertion checking. +\f[V]I\f[R] toggles balance assertion checking. Disabling balance assertions temporarily can be useful for troubleshooting. .PP -\f[C]a\f[R] runs command-line hledger\[aq]s add command, and reloads the +\f[V]a\f[R] runs command-line hledger\[aq]s add command, and reloads the updated file. This allows some basic data entry. .PP -\f[C]A\f[R] is like \f[C]a\f[R], but runs the hledger-iadd tool, which +\f[V]A\f[R] is like \f[V]a\f[R], but runs the hledger-iadd tool, which provides a terminal interface. -This key will be available if \f[C]hledger-iadd\f[R] is installed in +This key will be available if \f[V]hledger-iadd\f[R] is installed in $path. .PP -\f[C]E\f[R] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default -(\f[C]emacsclient -a \[dq]\[dq] -nw\f[R]) on the journal file. +\f[V]E\f[R] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default +(\f[V]emacsclient -a \[dq]\[dq] -nw\f[R]) on the journal file. With some editors (emacs, vi), the cursor will be positioned at the current transaction when invoked from the register and transaction screens, and at the error location (if possible) when invoked from the error screen. .PP -\f[C]B\f[R] toggles cost mode, showing amounts in their transaction -price\[aq]s commodity (like toggling the \f[C]-B/--cost\f[R] flag). +\f[V]B\f[R] toggles cost mode, showing amounts in their transaction +price\[aq]s commodity (like toggling the \f[V]-B/--cost\f[R] flag). .PP -\f[C]V\f[R] toggles value mode, showing amounts\[aq] current market +\f[V]V\f[R] toggles value mode, showing amounts\[aq] current market value in their default valuation commodity (like toggling the -\f[C]-V/--market\f[R] flag). +\f[V]-V/--market\f[R] flag). Note, \[dq]current market value\[dq] means the value on the report end 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 \f[C]/\f[R], and add \f[C]date:-7/30\f[R] to +or register screen, press \f[V]/\f[R], and add \f[V]date:-7/30\f[R] to the query. .PP At most one of cost or value mode can be active at once. .PP There\[aq]s not yet any visual reminder when cost or value mode is -active; for now pressing \f[C]b\f[R] \f[C]b\f[R] \f[C]v\f[R] should +active; for now pressing \f[V]b\f[R] \f[V]b\f[R] \f[V]v\f[R] should reliably reset to normal mode. .PP -\f[C]q\f[R] quits the application. +\f[V]q\f[R] quits the application. .PP Additional screen-specific keys are described below. .SH SCREENS .PP -hledger-ui can show a number of different screens, described below. -It shows the Balance sheet accounts screen to start with, except in the -following situations: +hledger-ui shows several different screens, described below. +It shows the \[dq]Balance sheet accounts\[dq] screen to start with, +except in the following situations: .IP \[bu] 2 If no asset/liability/equity accounts can be detected, or if an account -query has been given on the command line, it starts in the All accounts -screen. +query has been given on the command line, it starts in the \[dq]All +accounts\[dq] screen. .IP \[bu] 2 If a starting screen is specified with --menu/--all/--bs/--is/--register -on the command line, it starts there. +on the command line, it starts in that screen. .PP -From the starting screen you can press \f[C]LEFT\f[R] or \f[C]ESC\f[R] -to navigate back to the menu screen. -.SS Menu screen +From any screen you can press \f[V]LEFT\f[R] or \f[V]ESC\f[R] to +navigate back to the top level \[dq]Menu\[dq] screen. +.SS Menu .PP The top-most screen. From here you can navigate to three accounts screens: -.SS All accounts screen +.SS All accounts .PP This screen shows all accounts (possibly filtered by a query), and their end balances on the date shown in the title bar (or their balance changes in the period shown in the title bar, toggleable with -\f[C]H\f[R]). -It is like the \f[C]hledger balance\f[R] command. -.SS Balance sheet accounts screen +\f[V]H\f[R]). +It is like the \f[V]hledger balance\f[R] command. +.SS Balance sheet accounts .PP This screen shows asset, liability and equity accounts, if these can be detected (see account types). It always shows end balances. -It is like the \f[C]hledger balancesheetequity\f[R] command. -.SS Income statement accounts screen +It is like the \f[V]hledger balancesheetequity\f[R] command. +.SS Income statement accounts .PP This screen shows revenue and expense accounts. It always shows balance changes. -It is like the \f[C]hledger incomestatement\f[R] command. +It is like the \f[V]hledger incomestatement\f[R] command. .PP All of these accounts screens work in much the same way: .PP @@ -390,25 +390,30 @@ They show accounts which have been posted to by transactions, as well as accounts which have been declared with an account directive (except for empty parent accounts). .PP -If you specify a query on the command line, it shows just the matched -accounts, and the balances from matched transactions. +If you specify a query on the command line or with \f[V]/\f[R] in the +app, they show just the matched accounts, and the balances from matched +transactions. .PP -Account names are shown as a flat list by default; press \f[C]t\f[R] to +hledger-ui shows accounts with zero balances by default (unlike +command-line hledger). +To hide these, press \f[V]z\f[R] to toggle nonzero mode. +.PP +Account names are shown as a flat list by default; press \f[V]t\f[R] to toggle tree mode. 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. .PP -To see less detail, press a number key, \f[C]1\f[R] to \f[C]9\f[R], to +To see less detail, press a number key, \f[V]1\f[R] to \f[V]9\f[R], to set a depth limit. -Or use \f[C]-\f[R] to decrease and \f[C]+\f[R]/\f[C]=\f[R] to increase +Or use \f[V]-\f[R] to decrease and \f[V]+\f[R]/\f[V]=\f[R] to increase the depth limit. -\f[C]0\f[R] shows even less detail, collapsing all accounts to a single +\f[V]0\f[R] shows even less detail, collapsing all accounts to a single total. To remove the depth limit, set it higher than the maximum account depth, -or press \f[C]ESCAPE\f[R]. +or press \f[V]ESCAPE\f[R]. .PP -\f[C]H\f[R] toggles between showing historical balances or period +\f[V]H\f[R] toggles between showing historical balances or period balances (on the \[dq]All accounts\[dq] screen). Historical balances (the default) are ending balances at the end of the report period, taking into account all transactions before that date @@ -420,23 +425,19 @@ Period balances ignore transactions before the report start date, so they show the change in balance during the report period. They are more useful eg when viewing a time log. .PP -\f[C]U\f[R] toggles filtering by unmarked status, including or excluding +\f[V]U\f[R] toggles filtering by unmarked status, including or excluding unmarked postings in the balances. -Similarly, \f[C]P\f[R] toggles pending postings, and \f[C]C\f[R] toggles +Similarly, \f[V]P\f[R] toggles pending postings, and \f[V]C\f[R] toggles cleared postings. (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.) .PP -\f[C]R\f[R] toggles real mode, in which virtual postings are ignored. +\f[V]R\f[R] toggles real mode, in which virtual postings are ignored. .PP -\f[C]z\f[R] toggles nonzero mode, in which only accounts with nonzero -balances are shown (hledger-ui shows zero items by default, unlike -command-line hledger). -.PP -Press \f[C]RIGHT\f[R] to view an account\[aq]s register screen, Or, -\f[C]LEFT\f[R] to see the menu screen. -.SS Register screen +Press \f[V]RIGHT\f[R] to view an account\[aq]s register screen, Or, +\f[V]LEFT\f[R] to see the menu screen. +.SS Register .PP This screen shows the transactions affecting a particular account, like a check register. @@ -451,7 +452,7 @@ inflow to this account, negative for an outflow. .IP \[bu] 2 the running historical total or period total for the current account, after the transaction. -This can be toggled with \f[C]H\f[R]. +This can be toggled with \f[V]H\f[R]. Similar to the accounts screen, the historical total is affected by transactions (filtered by the filter query) before the report start date, while the period total is not. @@ -465,24 +466,24 @@ in list mode but this account has subaccounts which are not shown due to a depth limit. 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 \f[C]t\f[R] here also. +Tree mode/list mode can be toggled with \f[V]t\f[R] here also. .PP -\f[C]U\f[R] toggles filtering by unmarked status, showing or hiding +\f[V]U\f[R] toggles filtering by unmarked status, showing or hiding unmarked transactions. -Similarly, \f[C]P\f[R] toggles pending transactions, and \f[C]C\f[R] +Similarly, \f[V]P\f[R] toggles pending transactions, and \f[V]C\f[R] toggles cleared transactions. (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.) .PP -\f[C]R\f[R] toggles real mode, in which virtual postings are ignored. +\f[V]R\f[R] toggles real mode, in which virtual postings are ignored. .PP -\f[C]z\f[R] toggles nonzero mode, in which only transactions posting a +\f[V]z\f[R] toggles nonzero mode, in which only transactions posting a nonzero change are shown (hledger-ui shows zero items by default, unlike command-line hledger). .PP -Press \f[C]RIGHT\f[R] to view the selected transaction in detail. -.SS Transaction screen +Press \f[V]RIGHT\f[R] to view the selected transaction in detail. +.SS Transaction .PP This screen shows a single transaction, as a general journal entry, similar to hledger\[aq]s print command and journal format @@ -493,7 +494,7 @@ description, comments, along with all of its account postings are shown. Simple transactions have two postings, but there can be more (or in certain cases, fewer). .PP -\f[C]UP\f[R] and \f[C]DOWN\f[R] will step through all transactions +\f[V]UP\f[R] and \f[V]DOWN\f[R] will step through all transactions listed in the previous account register screen. In the title bar, the numbers in parentheses show your position within that account register. @@ -502,7 +503,7 @@ They will vary depending on which account register you came from The #N number preceding them is the transaction\[aq]s position within the complete unfiltered journal, which is a more stable id (at least until the next reload). -.SS Error screen +.SS Error .PP This screen will appear if there is a problem, such as a parse error, when you press g to reload. @@ -513,7 +514,7 @@ normal operation. .SS Watch mode .PP One of hledger-ui\[aq]s best features is the auto-reloading -\f[C]-w/--watch\f[R] mode. +\f[V]-w/--watch\f[R] mode. With this flag, it will update the display automatically whenever changes are saved to the data files. .PP @@ -537,25 +538,25 @@ toggle cleared mode, or to explore the history. Here are some current limitations to be aware of: .PP Changes might not be detected with certain editors, possibly including -Jetbrains IDEs, \f[C]gedit\f[R], other Gnome applications; or on certain +Jetbrains IDEs, \f[V]gedit\f[R], other Gnome applications; or on certain unusual filesystems. (#1617, #911). -To work around, reload manually by pressing \f[C]g\f[R] in the +To work around, reload manually by pressing \f[V]g\f[R] in the hledger-ui window. (Or see #1617 for another workaround, and let us know if it works for you.) .PP CPU and memory usage can sometimes gradually increase, if -\f[C]hledger-ui --watch\f[R] is left running for days. +\f[V]hledger-ui --watch\f[R] is left running for days. (Possibly correlated with certain platforms, many transactions, and/or large numbers of other files present). -To work around, \f[C]q\f[R]uit and restart it, or (where supported) -suspend (\f[C]CTRL-z\f[R]) and restart it (\f[C]fg\f[R]). +To work around, \f[V]q\f[R]uit and restart it, or (where supported) +suspend (\f[V]CTRL-z\f[R]) and restart it (\f[V]fg\f[R]). .SS Debug output .PP -You can add \f[C]--debug[=N]\f[R] to the command line to log debug +You can add \f[V]--debug[=N]\f[R] to the command line to log debug output. -This will be logged to the file \f[C]hledger-ui.log\f[R] in the current +This will be logged to the file \f[V]hledger-ui.log\f[R] in the current directory. N ranges from 1 (least output, the default) to 9 (maximum output). .SH ENVIRONMENT @@ -564,19 +565,19 @@ N ranges from 1 (least output, the default) to 9 (maximum output). Default: the full terminal width. .PP \f[B]LEDGER_FILE\f[R] The journal file path when not specified with -\f[C]-f\f[R]. +\f[V]-f\f[R]. .PP On unix computers, the default value is: -\f[C]\[ti]/.hledger.journal\f[R]. +\f[V]\[ti]/.hledger.journal\f[R]. .PP A more typical value is something like -\f[C]\[ti]/finance/YYYY.journal\f[R], where \f[C]\[ti]/finance\f[R] is a +\f[V]\[ti]/finance/YYYY.journal\f[R], where \f[V]\[ti]/finance\f[R] is a version-controlled finance directory and YYYY is the current year. -Or, \f[C]\[ti]/finance/current.journal\f[R], where current.journal is a +Or, \f[V]\[ti]/finance/current.journal\f[R], where current.journal is a symbolic link to YYYY.journal. .PP The usual way to set this permanently is to add a command to one of your -shell\[aq]s startup files (eg \f[C]\[ti]/.profile\f[R]): +shell\[aq]s startup files (eg \f[V]\[ti]/.profile\f[R]): .IP .nf \f[C] @@ -587,7 +588,7 @@ export LEDGER_FILE=\[ti]/finance/current.journal\[ga] On some Mac computers, there is a more thorough way to set environment variables, that will also affect applications started from the GUI (eg, Emacs started from a dock icon): In -\f[C]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: +\f[V]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: .IP .nf \f[C] @@ -597,11 +598,11 @@ Emacs started from a dock icon): In \f[R] .fi .PP -For this to take effect you might need to \f[C]killall Dock\f[R], or +For this to take effect you might need to \f[V]killall Dock\f[R], or reboot. .PP On Windows computers, the default value is probably -\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]. +\f[V]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]. You can change this by running a command like this in a powershell window (let us know if you need to be an Administrator, and if this persists across a reboot): @@ -617,23 +618,23 @@ https://www.java.com/en/download/help/path.html. .SH FILES .PP Reads data from one or more files in hledger journal, timeclock, -timedot, or CSV format specified with \f[C]-f\f[R], or -\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, -perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). +timedot, or CSV format specified with \f[V]-f\f[R], or +\f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows, +perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]). .SH BUGS .PP -The need to precede options with \f[C]--\f[R] when invoked from hledger +The need to precede options with \f[V]--\f[R] when invoked from hledger is awkward. .PP -\f[C]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin). +\f[V]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin). .PP -\f[C]-V\f[R] affects only the accounts screen. +\f[V]-V\f[R] affects only the accounts screen. .PP -When you press \f[C]g\f[R], the current and all previous screens are +When you press \f[V]g\f[R], the current and all previous screens are regenerated, which may cause a noticeable pause with large files. Also there is no visual indication that this is in progress. .PP -\f[C]--watch\f[R] is not yet fully robust. +\f[V]--watch\f[R] is not yet fully robust. It works well for normal usage, but many file changes in a short time (eg saving the file thousands of times with an editor macro) can cause problems at least on OSX. @@ -643,7 +644,7 @@ subsiding, and possibly a small but persistent build-up of CPU usage until the program is restarted. .PP Also, if you are viewing files mounted from another machine, -\f[C]-w/--watch\f[R] requires that both machine clocks are roughly in +\f[V]-w/--watch\f[R] requires that both machine clocks are roughly in step. diff --git a/hledger-ui/hledger-ui.info b/hledger-ui/hledger-ui.info index 64e7a85de..9340049cf 100644 --- a/hledger-ui/hledger-ui.info +++ b/hledger-ui/hledger-ui.info @@ -12,7 +12,7 @@ hledger-ui(1) ************* hledger-ui is a terminal interface (TUI) for the hledger accounting -tool. This manual is for hledger-ui 1.27.99. +tool. This manual is for hledger-ui 1.28.99. 'hledger-ui [OPTIONS] [QUERYARGS]' 'hledger ui -- [OPTIONS] [QUERYARGS]' @@ -262,8 +262,7 @@ mouse or touchpad: * Use mouse wheel or trackpad to scroll up and down * Click on list items to go deeper - * Click on the left margin (column 0), or the blank area at bottom of - screen, to go back. + * Click on the left margin (column 0) to go back.  File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: MOUSE, Up: Top @@ -364,44 +363,44 @@ File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: KEYS, Up: Top 4 SCREENS ********* -hledger-ui can show a number of different screens, described below. It -shows the Balance sheet accounts screen to start with, except in the +hledger-ui shows several different screens, described below. It shows +the "Balance sheet accounts" screen to start with, except in the following situations: * If no asset/liability/equity accounts can be detected, or if an account query has been given on the command line, it starts in the - All accounts screen. + "All accounts" screen. * If a starting screen is specified with -menu/-all/-bs/-is/-register - on the command line, it starts there. + on the command line, it starts in that screen. - From the starting screen you can press 'LEFT' or 'ESC' to navigate -back to the menu screen. + From any screen you can press 'LEFT' or 'ESC' to navigate back to the +top level "Menu" screen. * Menu: -* Menu screen:: -* All accounts screen:: -* Balance sheet accounts screen:: -* Income statement accounts screen:: -* Register screen:: -* Transaction screen:: -* Error screen:: +* Menu:: +* All accounts:: +* Balance sheet accounts:: +* Income statement accounts:: +* Register:: +* Transaction:: +* Error::  -File: hledger-ui.info, Node: Menu screen, Next: All accounts screen, Up: SCREENS +File: hledger-ui.info, Node: Menu, Next: All accounts, Up: SCREENS -4.1 Menu screen -=============== +4.1 Menu +======== The top-most screen. From here you can navigate to three accounts screens:  -File: hledger-ui.info, Node: All accounts screen, Next: Balance sheet accounts screen, Prev: Menu screen, Up: SCREENS +File: hledger-ui.info, Node: All accounts, Next: Balance sheet accounts, Prev: Menu, Up: SCREENS -4.2 All accounts screen -======================= +4.2 All accounts +================ This screen shows all accounts (possibly filtered by a query), and their end balances on the date shown in the title bar (or their balance @@ -409,20 +408,20 @@ changes in the period shown in the title bar, toggleable with 'H'). It is like the 'hledger balance' command.  -File: hledger-ui.info, Node: Balance sheet accounts screen, Next: Income statement accounts screen, Prev: All accounts screen, Up: SCREENS +File: hledger-ui.info, Node: Balance sheet accounts, Next: Income statement accounts, Prev: All accounts, Up: SCREENS -4.3 Balance sheet accounts screen -================================= +4.3 Balance sheet accounts +========================== This screen shows asset, liability and equity accounts, if these can be detected (see account types). It always shows end balances. It is like the 'hledger balancesheetequity' command.  -File: hledger-ui.info, Node: Income statement accounts screen, Next: Register screen, Prev: Balance sheet accounts screen, Up: SCREENS +File: hledger-ui.info, Node: Income statement accounts, Next: Register, Prev: Balance sheet accounts, Up: SCREENS -4.4 Income statement accounts screen -==================================== +4.4 Income statement accounts +============================= This screen shows revenue and expense accounts. It always shows balance changes. It is like the 'hledger incomestatement' command. @@ -433,8 +432,12 @@ changes. It is like the 'hledger incomestatement' command. as accounts which have been declared with an account directive (except for empty parent accounts). - If you specify a query on the command line, it shows just the matched -accounts, and the balances from matched transactions. + If you specify a query on the command line or with '/' in the app, +they show just the matched accounts, and the balances from matched +transactions. + + hledger-ui shows accounts with zero balances by default (unlike +command-line hledger). To hide these, press 'z' to toggle nonzero mode. Account names are shown as a flat list by default; press 't' to toggle tree mode. In list mode, account balances are exclusive of @@ -468,18 +471,14 @@ is removed.) 'R' toggles real mode, in which virtual postings are ignored. - 'z' toggles nonzero mode, in which only accounts with nonzero -balances are shown (hledger-ui shows zero items by default, unlike -command-line hledger). - Press 'RIGHT' to view an account's register screen, Or, 'LEFT' to see the menu screen.  -File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Income statement accounts screen, Up: SCREENS +File: hledger-ui.info, Node: Register, Next: Transaction, Prev: Income statement accounts, Up: SCREENS -4.5 Register screen -=================== +4.5 Register +============ This screen shows the transactions affecting a particular account, like a check register. Each line represents one transaction and shows: @@ -522,10 +521,10 @@ command-line hledger). Press 'RIGHT' to view the selected transaction in detail.  -File: hledger-ui.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS +File: hledger-ui.info, Node: Transaction, Next: Error, Prev: Register, Up: SCREENS -4.6 Transaction screen -====================== +4.6 Transaction +=============== This screen shows a single transaction, as a general journal entry, similar to hledger's print command and journal format @@ -546,10 +545,10 @@ unfiltered journal, which is a more stable id (at least until the next reload).  -File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCREENS +File: hledger-ui.info, Node: Error, Prev: Transaction, Up: SCREENS -4.7 Error screen -================ +4.7 Error +========= This screen will appear if there is a problem, such as a parse error, when you press g to reload. Once you have fixed the problem, press g @@ -703,36 +702,36 @@ Node: OPTIONS1657 Ref: #options1755 Node: MOUSE6839 Ref: #mouse6934 -Node: KEYS7216 -Ref: #keys7309 -Node: SCREENS11384 -Ref: #screens11482 -Node: Menu screen12208 -Ref: #menu-screen12328 -Node: All accounts screen12405 -Ref: #all-accounts-screen12579 -Node: Balance sheet accounts screen12830 -Ref: #balance-sheet-accounts-screen13045 -Node: Income statement accounts screen13233 -Ref: #income-statement-accounts-screen13450 -Node: Register screen15861 -Ref: #register-screen16033 -Node: Transaction screen18017 -Ref: #transaction-screen18175 -Node: Error screen19045 -Ref: #error-screen19167 -Node: TIPS19411 -Ref: #tips19510 -Node: Watch mode19552 -Ref: #watch-mode19659 -Node: Debug output21115 -Ref: #debug-output21226 -Node: ENVIRONMENT21438 -Ref: #environment21549 -Node: FILES22934 -Ref: #files23033 -Node: BUGS23246 -Ref: #bugs23323 +Node: KEYS7171 +Ref: #keys7264 +Node: SCREENS11339 +Ref: #screens11437 +Node: Menu12123 +Ref: #menu12215 +Node: All accounts12292 +Ref: #all-accounts12431 +Node: Balance sheet accounts12682 +Ref: #balance-sheet-accounts12862 +Node: Income statement accounts13050 +Ref: #income-statement-accounts13232 +Node: Register15652 +Ref: #register15789 +Node: Transaction17773 +Ref: #transaction17896 +Node: Error18766 +Ref: #error18860 +Node: TIPS19104 +Ref: #tips19203 +Node: Watch mode19245 +Ref: #watch-mode19352 +Node: Debug output20808 +Ref: #debug-output20919 +Node: ENVIRONMENT21131 +Ref: #environment21242 +Node: FILES22627 +Ref: #files22726 +Node: BUGS22939 +Ref: #bugs23016  End Tag Table diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt index ecc23fac2..b32bbd6a2 100644 --- a/hledger-ui/hledger-ui.txt +++ b/hledger-ui/hledger-ui.txt @@ -5,7 +5,7 @@ HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1) NAME hledger-ui is a terminal interface (TUI) for the hledger accounting - tool. This manual is for hledger-ui 1.27.99. + tool. This manual is for hledger-ui 1.28.99. SYNOPSIS hledger-ui [OPTIONS] [QUERYARGS] @@ -227,15 +227,15 @@ MOUSE o Click on list items to go deeper - o Click on the left margin (column 0), or the blank area at bottom of - screen, to go back. + o Click on the left margin (column 0) to go back. KEYS Keyboard gives more control. - ? 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: + ? 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/PGUP/PGDN/HOME/END move up and down @@ -316,36 +316,36 @@ KEYS Additional screen-specific keys are described below. SCREENS - hledger-ui can show a number of different screens, described below. It - shows the Balance sheet accounts screen to start with, except in the - following situations: + hledger-ui shows several different screens, described below. It shows + the "Balance sheet accounts" screen to start with, except in the fol- + lowing situations: o If no asset/liability/equity accounts can be detected, or if an account query has been given on the command line, it starts in the - All accounts screen. + "All accounts" screen. o If a starting screen is specified with --menu/--all/--bs/--is/--reg- - ister on the command line, it starts there. + ister on the command line, it starts in that screen. - From the starting screen you can press LEFT or ESC to navigate back to - the menu screen. + From any screen you can press LEFT or ESC to navigate back to the top + level "Menu" screen. - Menu screen + Menu The top-most screen. From here you can navigate to three accounts screens: - All accounts screen + All accounts This screen shows all accounts (possibly filtered by a query), and their end balances on the date shown in the title bar (or their balance changes in the period shown in the title bar, toggleable with H). It is like the hledger balance command. - Balance sheet accounts screen + Balance sheet accounts This screen shows asset, liability and equity accounts, if these can be detected (see account types). It always shows end balances. It is like the hledger balancesheetequity command. - Income statement accounts screen + Income statement accounts This screen shows revenue and expense accounts. It always shows bal- ance changes. It is like the hledger incomestatement command. @@ -355,8 +355,12 @@ SCREENS as accounts which have been declared with an account directive (except for empty parent accounts). - If you specify a query on the command line, it shows just the matched - accounts, and the balances from matched transactions. + If you specify a query on the command line or with / in the app, they + show just the matched accounts, and the balances from matched transac- + tions. + + hledger-ui shows accounts with zero balances by default (unlike com- + mand-line hledger). To hide these, press z to toggle nonzero mode. Account names are shown as a flat list by default; press t to toggle tree mode. In list mode, account balances are exclusive of subac- @@ -389,14 +393,10 @@ SCREENS R toggles real mode, in which virtual postings are ignored. - z toggles nonzero mode, in which only accounts with nonzero balances - are shown (hledger-ui shows zero items by default, unlike command-line - hledger). - Press RIGHT to view an account's register screen, Or, LEFT to see the menu screen. - Register screen + Register This screen shows the transactions affecting a particular account, like a check register. Each line represents one transaction and shows: @@ -436,7 +436,7 @@ SCREENS Press RIGHT to view the selected transaction in detail. - Transaction screen + Transaction This screen shows a single transaction, as a general journal entry, similar to hledger's print command and journal format (hledger_jour- nal(5)). @@ -454,7 +454,7 @@ SCREENS them is the transaction's position within the complete unfiltered jour- nal, which is a more stable id (at least until the next reload). - Error screen + Error This screen will appear if there is a problem, such as a parse error, 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 @@ -586,4 +586,4 @@ SEE ALSO -hledger-ui-1.27.99 November 2022 HLEDGER-UI(1) +hledger-ui-1.28.99 December 2022 HLEDGER-UI(1) diff --git a/hledger-web/.date.m4 b/hledger-web/.date.m4 index f4bc2db3f..4aa7c88b5 100644 --- a/hledger-web/.date.m4 +++ b/hledger-web/.date.m4 @@ -1,2 +1,2 @@ m4_dnl Date to show in man pages. Updated by "Shake manuals" -m4_define({{_monthyear_}}, {{November 2022}})m4_dnl +m4_define({{_monthyear_}}, {{December 2022}})m4_dnl diff --git a/hledger-web/hledger-web.1 b/hledger-web/hledger-web.1 index d65b30bdc..e46aa9c7b 100644 --- a/hledger-web/hledger-web.1 +++ b/hledger-web/hledger-web.1 @@ -1,23 +1,23 @@ -.TH "HLEDGER-WEB" "1" "November 2022" "hledger-web-1.27.99 " "hledger User Manuals" +.TH "HLEDGER-WEB" "1" "December 2022" "hledger-web-1.28.99 " "hledger User Manuals" .SH NAME .PP hledger-web is a web interface (WUI) for the hledger accounting tool. -This manual is for hledger-web 1.27.99. +This manual is for hledger-web 1.28.99. .SH SYNOPSIS .PP -\f[C]hledger-web [OPTIONS] # run temporarily & browse\f[R] +\f[V]hledger-web [OPTIONS] # run temporarily & browse\f[R] .PD 0 .P .PD -\f[C]hledger-web --serve [OPTIONS] # run without stopping\f[R] +\f[V]hledger-web --serve [OPTIONS] # run without stopping\f[R] .PD 0 .P .PD -\f[C]hledger-web --serve-api [OPTIONS] # run JSON server only\f[R] +\f[V]hledger-web --serve-api [OPTIONS] # run JSON server only\f[R] .PD 0 .P .PD @@ -44,9 +44,9 @@ instance, it writes a numbered backup of the main journal file (only) on every edit. .PP Like hledger, it reads data from one or more files in hledger journal, -timeclock, timedot, or CSV format specified with \f[C]-f\f[R], or -\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, -perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). +timeclock, timedot, or CSV format specified with \f[V]-f\f[R], or +\f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows, +perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]). For more about this see hledger(1). .PP hledger-web can be run in three modes: @@ -56,10 +56,10 @@ show the app if possible, and the app exits automatically after two minutes of inactivity (no requests received and no open browser windows viewing it). .IP \[bu] 2 -With \f[C]--serve\f[R]: the app runs without stopping, and without +With \f[V]--serve\f[R]: the app runs without stopping, and without opening a browser. .IP \[bu] 2 -With \f[C]--serve-api\f[R]: only the JSON API is served. +With \f[V]--serve-api\f[R]: only the JSON API is served. .PP In all cases hledger-web runs as a foreground process, logging requests to stdout. @@ -71,163 +71,163 @@ These filter options are not shown in the web UI, but it will be applied in addition to any search query entered there. .PP Note: if invoking hledger-web as a hledger subcommand, write -\f[C]--\f[R] before options, as shown in the synopsis above. +\f[V]--\f[R] before options, as shown in the synopsis above. .TP -\f[B]\f[CB]--serve\f[B]\f[R] +\f[V]--serve\f[R] serve and log requests, don\[aq]t browse or auto-exit after timeout .TP -\f[B]\f[CB]--serve-api\f[B]\f[R] +\f[V]--serve-api\f[R] like --serve, but serve only the JSON web API, without the server-side web UI .TP -\f[B]\f[CB]--host=IPADDR\f[B]\f[R] +\f[V]--host=IPADDR\f[R] listen on this IP address (default: 127.0.0.1) .TP -\f[B]\f[CB]--port=PORT\f[B]\f[R] +\f[V]--port=PORT\f[R] listen on this TCP port (default: 5000) .TP -\f[B]\f[CB]--socket=SOCKETFILE\f[B]\f[R] +\f[V]--socket=SOCKETFILE\f[R] use a unix domain socket file to listen for requests instead of a TCP socket. -Implies \f[C]--serve\f[R]. +Implies \f[V]--serve\f[R]. It can only be used if the operating system can provide this type of socket. .TP -\f[B]\f[CB]--base-url=URL\f[B]\f[R] +\f[V]--base-url=URL\f[R] set the base url (default: http://IPADDR:PORT). You would change this when sharing over the network, or integrating within a larger website. .TP -\f[B]\f[CB]--file-url=URL\f[B]\f[R] +\f[V]--file-url=URL\f[R] set the static files url (default: BASEURL/static). 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. .TP -\f[B]\f[CB]--capabilities=CAP[,CAP..]\f[B]\f[R] +\f[V]--capabilities=CAP[,CAP..]\f[R] enable the view, add, and/or manage capabilities (default: view,add) .TP -\f[B]\f[CB]--capabilities-header=HTTPHEADER\f[B]\f[R] +\f[V]--capabilities-header=HTTPHEADER\f[R] read capabilities to enable from a HTTP header, like X-Sandstorm-Permissions (default: disabled) .TP -\f[B]\f[CB]--test\f[B]\f[R] +\f[V]--test\f[R] run hledger-web\[aq]s tests and exit. hspec test runner args may follow a --, eg: hledger-web --test -- --help .PP hledger input options: .TP -\f[B]\f[CB]-f FILE --file=FILE\f[B]\f[R] +\f[V]-f FILE --file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or -\f[C]$HOME/.hledger.journal\f[R]) +For stdin, use - (default: \f[V]$LEDGER_FILE\f[R] or +\f[V]$HOME/.hledger.journal\f[R]) .TP -\f[B]\f[CB]--rules-file=RULESFILE\f[B]\f[R] +\f[V]--rules-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP -\f[B]\f[CB]--separator=CHAR\f[B]\f[R] +\f[V]--separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[B]\f[CB]--alias=OLD=NEW\f[B]\f[R] +\f[V]--alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[B]\f[CB]--anon\f[B]\f[R] +\f[V]--anon\f[R] anonymize accounts and payees .TP -\f[B]\f[CB]--pivot FIELDNAME\f[B]\f[R] +\f[V]--pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R] +\f[V]-I --ignore-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[B]\f[CB]-s --strict\f[B]\f[R] +\f[V]-s --strict\f[R] do extra error checking (check that all posted accounts are declared) .PP hledger reporting options: .TP -\f[B]\f[CB]-b --begin=DATE\f[B]\f[R] +\f[V]-b --begin=DATE\f[R] include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) .TP -\f[B]\f[CB]-e --end=DATE\f[B]\f[R] +\f[V]-e --end=DATE\f[R] include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) .TP -\f[B]\f[CB]-D --daily\f[B]\f[R] +\f[V]-D --daily\f[R] multiperiod/multicolumn report by day .TP -\f[B]\f[CB]-W --weekly\f[B]\f[R] +\f[V]-W --weekly\f[R] multiperiod/multicolumn report by week .TP -\f[B]\f[CB]-M --monthly\f[B]\f[R] +\f[V]-M --monthly\f[R] multiperiod/multicolumn report by month .TP -\f[B]\f[CB]-Q --quarterly\f[B]\f[R] +\f[V]-Q --quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[B]\f[CB]-Y --yearly\f[B]\f[R] +\f[V]-Y --yearly\f[R] multiperiod/multicolumn report by year .TP -\f[B]\f[CB]-p --period=PERIODEXP\f[B]\f[R] +\f[V]-p --period=PERIODEXP\f[R] set start date, end date, and/or reporting interval all at once using period expressions syntax .TP -\f[B]\f[CB]--date2\f[B]\f[R] +\f[V]--date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[B]\f[CB]--today=DATE\f[B]\f[R] +\f[V]--today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[B]\f[CB]-U --unmarked\f[B]\f[R] +\f[V]-U --unmarked\f[R] include only unmarked postings/txns (can combine with -P or -C) .TP -\f[B]\f[CB]-P --pending\f[B]\f[R] +\f[V]-P --pending\f[R] include only pending postings/txns .TP -\f[B]\f[CB]-C --cleared\f[B]\f[R] +\f[V]-C --cleared\f[R] include only cleared postings/txns .TP -\f[B]\f[CB]-R --real\f[B]\f[R] +\f[V]-R --real\f[R] include only non-virtual postings .TP -\f[B]\f[CB]-NUM --depth=NUM\f[B]\f[R] +\f[V]-NUM --depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[B]\f[CB]-E --empty\f[B]\f[R] +\f[V]-E --empty\f[R] show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) .TP -\f[B]\f[CB]-B --cost\f[B]\f[R] +\f[V]-B --cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[B]\f[CB]-V --market\f[B]\f[R] +\f[V]-V --market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[B]\f[CB]-X --exchange=COMM\f[B]\f[R] +\f[V]-X --exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[B]\f[CB]--value\f[B]\f[R] +\f[V]--value\f[R] convert amounts to cost or market value, more flexibly than -B/-V/-X .TP -\f[B]\f[CB]--infer-market-prices\f[B]\f[R] +\f[V]--infer-market-prices\f[R] use transaction prices (recorded with \[at] or \[at]\[at]) as additional market prices, as if they were P directives .TP -\f[B]\f[CB]--auto\f[B]\f[R] +\f[V]--auto\f[R] apply automated posting rules to modify transactions. .TP -\f[B]\f[CB]--forecast\f[B]\f[R] +\f[V]--forecast\f[R] generate future transactions from periodic transaction rules, for the next 6 months or till report end date. In hledger-ui, also make ordinary future transactions visible. .TP -\f[B]\f[CB]--commodity-style\f[B]\f[R] +\f[V]--commodity-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP -\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R] +\f[V]--color=WHEN (or --colour=WHEN)\f[R] Should color-supporting commands use ANSI color codes in text output. \[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting terminal. @@ -236,7 +236,7 @@ into \[aq]less -R\[aq]. \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[B]\f[CB]--pretty[=WHEN]\f[B]\f[R] +\f[V]--pretty[=WHEN]\f[R] Show prettier output, e.g. using unicode box-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], @@ -251,46 +251,46 @@ Some reporting options can also be written as query arguments. .PP hledger help options: .TP -\f[B]\f[CB]-h --help\f[B]\f[R] +\f[V]-h --help\f[R] show general or COMMAND help .TP -\f[B]\f[CB]--man\f[B]\f[R] +\f[V]--man\f[R] show general or COMMAND user manual with man .TP -\f[B]\f[CB]--info\f[B]\f[R] +\f[V]--info\f[R] show general or COMMAND user manual with info .TP -\f[B]\f[CB]--version\f[B]\f[R] +\f[V]--version\f[R] show general or ADDONCMD version .TP -\f[B]\f[CB]--debug[=N]\f[B]\f[R] +\f[V]--debug[=N]\f[R] show debug output (levels 1-9, default: 1) .PP A \[at]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 \f[C]--\f[R] argument before.) +(To prevent this, insert a \f[V]--\f[R] argument before.) .PP By default the server listens on IP address 127.0.0.1, accessible only to local requests. -You can use \f[C]--host\f[R] to change this, eg \f[C]--host 0.0.0.0\f[R] +You can use \f[V]--host\f[R] to change this, eg \f[V]--host 0.0.0.0\f[R] to listen on all configured addresses. .PP -Similarly, use \f[C]--port\f[R] to set a TCP port other than 5000, eg if +Similarly, use \f[V]--port\f[R] to set a TCP port other than 5000, eg if you are running multiple hledger-web instances. .PP -Both of these options are ignored when \f[C]--socket\f[R] is used. -In this case, it creates an \f[C]AF_UNIX\f[R] socket file at the +Both of these options are ignored when \f[V]--socket\f[R] is used. +In this case, it creates an \f[V]AF_UNIX\f[R] 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, \f[C]nginx\f[R] as reverse proxy can use the variable -\f[C]$remote_user\f[R] to derive a path from the username used in a HTTP +As an example, \f[V]nginx\f[R] as reverse proxy can use the variable +\f[V]$remote_user\f[R] to derive a path from the username used in a HTTP basic authentication. -The following \f[C]proxy_pass\f[R] directive allows access to all -\f[C]hledger-web\f[R] instances that created a socket in -\f[C]/tmp/hledger/\f[R]: +The following \f[V]proxy_pass\f[R] directive allows access to all +\f[V]hledger-web\f[R] instances that created a socket in +\f[V]/tmp/hledger/\f[R]: .IP .nf \f[C] @@ -298,14 +298,14 @@ The following \f[C]proxy_pass\f[R] directive allows access to all \f[R] .fi .PP -You can use \f[C]--base-url\f[R] to change the protocol, hostname, port +You can use \f[V]--base-url\f[R] to change the protocol, hostname, port and path that appear in hyperlinks, useful eg for integrating hledger-web within a larger website. -The default is \f[C]http://HOST:PORT/\f[R] using the server\[aq]s -configured host address and TCP port (or \f[C]http://HOST\f[R] if PORT +The default is \f[V]http://HOST:PORT/\f[R] using the server\[aq]s +configured host address and TCP port (or \f[V]http://HOST\f[R] if PORT is 80). .PP -With \f[C]--file-url\f[R] you can set a different base url for static +With \f[V]--file-url\f[R] you can set a different base url for static files, eg for better caching or cookie-less serving on high performance websites. .SH PERMISSIONS @@ -315,7 +315,7 @@ journal and to add new transactions, but not to change existing data. .PP You can restrict who can reach it by .IP \[bu] 2 -setting the IP address it listens on (see \f[C]--host\f[R] above). +setting the IP address it listens on (see \f[V]--host\f[R] above). By default it listens on 127.0.0.1, accessible to all users on the local machine. .IP \[bu] 2 @@ -325,27 +325,27 @@ custom firewall rules .PP You can restrict what the users who reach it can do, by .IP \[bu] 2 -using the \f[C]--capabilities=CAP[,CAP..]\f[R] flag when you start it, +using the \f[V]--capabilities=CAP[,CAP..]\f[R] flag when you start it, enabling one or more of the following capabilities. -The default value is \f[C]view,add\f[R]: +The default value is \f[V]view,add\f[R]: .RS 2 .IP \[bu] 2 -\f[C]view\f[R] - allows viewing the journal file and all included files +\f[V]view\f[R] - allows viewing the journal file and all included files .IP \[bu] 2 -\f[C]add\f[R] - allows adding new transactions to the main journal file +\f[V]add\f[R] - allows adding new transactions to the main journal file .IP \[bu] 2 -\f[C]manage\f[R] - allows editing, uploading or downloading the main or +\f[V]manage\f[R] - allows editing, uploading or downloading the main or included files .RE .IP \[bu] 2 -using the \f[C]--capabilities-header=HTTPHEADER\f[R] flag to specify a +using the \f[V]--capabilities-header=HTTPHEADER\f[R] flag to specify a HTTP header from which it will read capabilities to enable. hledger-web on Sandstorm uses the X-Sandstorm-Permissions header to integrate with Sandstorm\[aq]s permissions. This is disabled by default. .SH EDITING, UPLOADING, DOWNLOADING .PP -If you enable the \f[C]manage\f[R] capability mentioned above, +If you enable the \f[V]manage\f[R] capability mentioned above, you\[aq]ll see a new \[dq]spanner\[dq] button to the right of the search form. Clicking this will let you edit, upload, or download the journal file or @@ -356,9 +356,10 @@ visitor) can alter or wipe the data files. .PP 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, -currently; if you use one, you\[aq]ll have to arrange to commit the -changes yourself (eg with a cron job or a file watcher like entr). +full, etc.) +hledger-web is not aware of version control systems, currently; if you +use one, you\[aq]ll have to arrange to commit the changes yourself (eg +with a cron job or a file watcher like entr). .PP Changes which would leave the journal file(s) unparseable or non-valid (eg with failing balance assertions) are prevented. @@ -378,7 +379,7 @@ that both machine clocks are roughly in step.) .PP 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 \f[C]--serve-api\f[R] +If you want the JSON API only, you can use the \f[V]--serve-api\f[R] flag. Eg: .IP @@ -462,19 +463,19 @@ In some cases there is outer JSON corresponding to a \[dq]Report\[dq] 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 \f[C]/accounttransactions\f[R] it\[aq]s getAccounttransactionsR, -returning a \[dq]\f[C]accountTransactionsReport ...\f[R]\[dq]. +Eg for \f[V]/accounttransactions\f[R] it\[aq]s getAccounttransactionsR, +returning a \[dq]\f[V]accountTransactionsReport ...\f[R]\[dq]. 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). .PP You can add a new transaction to the journal with a PUT request to -\f[C]/add\f[R], if hledger-web was started with the \f[C]add\f[R] +\f[V]/add\f[R], if hledger-web was started with the \f[V]add\f[R] capability (enabled by default). The payload must be the full, exact JSON representation of a hledger transaction (partial data won\[aq]t do). -You can get sample JSON from hledger-web\[aq]s \f[C]/transactions\f[R] -or \f[C]/accounttransactions\f[R], or you can export it with +You can get sample JSON from hledger-web\[aq]s \f[V]/transactions\f[R] +or \f[V]/accounttransactions\f[R], or you can export it with hledger-lib, eg like so: .IP .nf @@ -589,7 +590,7 @@ $ curl http://127.0.0.1:5000/add -X PUT -H \[aq]Content-Type: application/json\[ .SH DEBUG OUTPUT .SS Debug output .PP -You can add \f[C]--debug[=N]\f[R] to the command line to log debug +You can add \f[V]--debug[=N]\f[R] to the command line to log debug output. N ranges from 1 (least output, the default) to 9 (maximum output). Typically you would start with 1 and increase until you are seeing @@ -601,23 +602,23 @@ stderr, eg: .PD 0 .P .PD -\f[C]hledger-web --debug=3 2>hledger-web.log\f[R]. +\f[V]hledger-web --debug=3 2>hledger-web.log\f[R]. .SH ENVIRONMENT .PP \f[B]LEDGER_FILE\f[R] The journal file path when not specified with -\f[C]-f\f[R]. +\f[V]-f\f[R]. .PP On unix computers, the default value is: -\f[C]\[ti]/.hledger.journal\f[R]. +\f[V]\[ti]/.hledger.journal\f[R]. .PP A more typical value is something like -\f[C]\[ti]/finance/YYYY.journal\f[R], where \f[C]\[ti]/finance\f[R] is a +\f[V]\[ti]/finance/YYYY.journal\f[R], where \f[V]\[ti]/finance\f[R] is a version-controlled finance directory and YYYY is the current year. -Or, \f[C]\[ti]/finance/current.journal\f[R], where current.journal is a +Or, \f[V]\[ti]/finance/current.journal\f[R], where current.journal is a symbolic link to YYYY.journal. .PP The usual way to set this permanently is to add a command to one of your -shell\[aq]s startup files (eg \f[C]\[ti]/.profile\f[R]): +shell\[aq]s startup files (eg \f[V]\[ti]/.profile\f[R]): .IP .nf \f[C] @@ -628,7 +629,7 @@ export LEDGER_FILE=\[ti]/finance/current.journal\[ga] On some Mac computers, there is a more thorough way to set environment variables, that will also affect applications started from the GUI (eg, Emacs started from a dock icon): In -\f[C]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: +\f[V]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: .IP .nf \f[C] @@ -638,11 +639,11 @@ Emacs started from a dock icon): In \f[R] .fi .PP -For this to take effect you might need to \f[C]killall Dock\f[R], or +For this to take effect you might need to \f[V]killall Dock\f[R], or reboot. .PP On Windows computers, the default value is probably -\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]. +\f[V]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]. You can change this by running a command like this in a powershell window (let us know if you need to be an Administrator, and if this persists across a reboot): @@ -658,15 +659,15 @@ https://www.java.com/en/download/help/path.html. .SH FILES .PP Reads data from one or more files in hledger journal, timeclock, -timedot, or CSV format specified with \f[C]-f\f[R], or -\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, -perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). +timedot, or CSV format specified with \f[V]-f\f[R], or +\f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows, +perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]). .SH BUGS .PP -The need to precede options with \f[C]--\f[R] when invoked from hledger +The need to precede options with \f[V]--\f[R] when invoked from hledger is awkward. .PP -\f[C]-f-\f[R] doesn\[aq]t work (hledger-web can\[aq]t read from stdin). +\f[V]-f-\f[R] doesn\[aq]t work (hledger-web can\[aq]t read from stdin). .PP Query arguments and some hledger options are ignored. .PP diff --git a/hledger-web/hledger-web.info b/hledger-web/hledger-web.info index 61ea4a2e0..9ceb26be0 100644 --- a/hledger-web/hledger-web.info +++ b/hledger-web/hledger-web.info @@ -12,7 +12,7 @@ hledger-web(1) ************** hledger-web is a web interface (WUI) for the hledger accounting tool. -This manual is for hledger-web 1.27.99. +This manual is for hledger-web 1.28.99. 'hledger-web [OPTIONS] # run temporarily & browse' 'hledger-web --serve [OPTIONS] # run without stopping' diff --git a/hledger-web/hledger-web.txt b/hledger-web/hledger-web.txt index 061382978..adb0bce84 100644 --- a/hledger-web/hledger-web.txt +++ b/hledger-web/hledger-web.txt @@ -5,7 +5,7 @@ HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1) NAME hledger-web is a web interface (WUI) for the hledger accounting tool. - This manual is for hledger-web 1.27.99. + This manual is for hledger-web 1.28.99. SYNOPSIS hledger-web [OPTIONS] # run temporarily & browse @@ -320,7 +320,7 @@ EDITING, UPLOADING, DOWNLOADING Normally whenever a file is changed in this way, hledger-web saves a numbered backup (assuming file permissions allow it, the disk is not - full, etc.) hledger-web is not aware of version control systems, cur- + full, etc.) hledger-web is not aware of version control systems, cur- rently; if you use one, you'll have to arrange to commit the changes yourself (eg with a cron job or a file watcher like entr). @@ -602,4 +602,4 @@ SEE ALSO -hledger-web-1.27.99 November 2022 HLEDGER-WEB(1) +hledger-web-1.28.99 December 2022 HLEDGER-WEB(1) diff --git a/hledger/.date.m4 b/hledger/.date.m4 index f4bc2db3f..4aa7c88b5 100644 --- a/hledger/.date.m4 +++ b/hledger/.date.m4 @@ -1,2 +1,2 @@ m4_dnl Date to show in man pages. Updated by "Shake manuals" -m4_define({{_monthyear_}}, {{November 2022}})m4_dnl +m4_define({{_monthyear_}}, {{December 2022}})m4_dnl diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 5001a2ab0..2dcc56e11 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -1,6 +1,6 @@ .\"t -.TH "HLEDGER" "1" "November 2022" "hledger-1.27.99 " "hledger User Manuals" +.TH "HLEDGER" "1" "December 2022" "hledger-1.28.99 " "hledger User Manuals" @@ -9,14 +9,14 @@ This is the command-line interface (CLI) for the hledger accounting tool. Here we also describe hledger\[aq]s concepts and file formats. -This manual is for hledger 1.27.99. +This manual is for hledger 1.28.99. .SH SYNOPSIS .PP -\f[C]hledger\f[R] +\f[V]hledger\f[R] .PP -\f[C]hledger [-f FILE] COMMAND [OPTIONS] [ARGS]\f[R] +\f[V]hledger [-f FILE] COMMAND [OPTIONS] [ARGS]\f[R] .PP -\f[C]hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]\f[R] +\f[V]hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]\f[R] .SH DESCRIPTION .PP hledger is a reliable, cross-platform set of programs for tracking @@ -34,12 +34,12 @@ Additionally, hledger lists other hledger-* executables found in the user\[cq]s $PATH and can invoke them as subcommands. .PP hledger reads data from one or more files in hledger journal, timeclock, -timedot, or CSV format specified with \f[C]-f\f[R], or -\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, -perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). -If using \f[C]$LEDGER_FILE\f[R], note this must be a real environment +timedot, or CSV format specified with \f[V]-f\f[R], or +\f[V]$LEDGER_FILE\f[R], or \f[V]$HOME/.hledger.journal\f[R] (on windows, +perhaps \f[V]C:/Users/USER/.hledger.journal\f[R]). +If using \f[V]$LEDGER_FILE\f[R], note this must be a real environment variable, not a shell variable. -You can specify standard input with \f[C]-f-\f[R]. +You can specify standard input with \f[V]-f-\f[R]. .PP Transactions are dated movements of money between two (or more) named accounts, and are recorded with journal entries like this: @@ -59,147 +59,147 @@ transactions. hledger never changes existing transactions. .PP To get started, you can either save some entries like the above in -\f[C]\[ti]/.hledger.journal\f[R], or run \f[C]hledger add\f[R] and +\f[V]\[ti]/.hledger.journal\f[R], or run \f[V]hledger add\f[R] and follow the prompts. -Then try some commands like \f[C]hledger print\f[R] or -\f[C]hledger balance\f[R]. -Run \f[C]hledger\f[R] with no arguments for a list of commands. +Then try some commands like \f[V]hledger print\f[R] or +\f[V]hledger balance\f[R]. +Run \f[V]hledger\f[R] with no arguments for a list of commands. .SH OPTIONS .SS General options .PP To see general usage help, including general options which are supported -by most hledger commands, run \f[C]hledger -h\f[R]. +by most hledger commands, run \f[V]hledger -h\f[R]. .PP General help options: .TP -\f[B]\f[CB]-h --help\f[B]\f[R] +\f[V]-h --help\f[R] show general or COMMAND help .TP -\f[B]\f[CB]--man\f[B]\f[R] +\f[V]--man\f[R] show general or COMMAND user manual with man .TP -\f[B]\f[CB]--info\f[B]\f[R] +\f[V]--info\f[R] show general or COMMAND user manual with info .TP -\f[B]\f[CB]--version\f[B]\f[R] +\f[V]--version\f[R] show general or ADDONCMD version .TP -\f[B]\f[CB]--debug[=N]\f[B]\f[R] +\f[V]--debug[=N]\f[R] show debug output (levels 1-9, default: 1) .PP General input options: .TP -\f[B]\f[CB]-f FILE --file=FILE\f[B]\f[R] +\f[V]-f FILE --file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or -\f[C]$HOME/.hledger.journal\f[R]) +For stdin, use - (default: \f[V]$LEDGER_FILE\f[R] or +\f[V]$HOME/.hledger.journal\f[R]) .TP -\f[B]\f[CB]--rules-file=RULESFILE\f[B]\f[R] +\f[V]--rules-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP -\f[B]\f[CB]--separator=CHAR\f[B]\f[R] +\f[V]--separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[B]\f[CB]--alias=OLD=NEW\f[B]\f[R] +\f[V]--alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[B]\f[CB]--anon\f[B]\f[R] +\f[V]--anon\f[R] anonymize accounts and payees .TP -\f[B]\f[CB]--pivot FIELDNAME\f[B]\f[R] +\f[V]--pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R] +\f[V]-I --ignore-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[B]\f[CB]-s --strict\f[B]\f[R] +\f[V]-s --strict\f[R] do extra error checking (check that all posted accounts are declared) .PP General reporting options: .TP -\f[B]\f[CB]-b --begin=DATE\f[B]\f[R] +\f[V]-b --begin=DATE\f[R] include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) .TP -\f[B]\f[CB]-e --end=DATE\f[B]\f[R] +\f[V]-e --end=DATE\f[R] include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) .TP -\f[B]\f[CB]-D --daily\f[B]\f[R] +\f[V]-D --daily\f[R] multiperiod/multicolumn report by day .TP -\f[B]\f[CB]-W --weekly\f[B]\f[R] +\f[V]-W --weekly\f[R] multiperiod/multicolumn report by week .TP -\f[B]\f[CB]-M --monthly\f[B]\f[R] +\f[V]-M --monthly\f[R] multiperiod/multicolumn report by month .TP -\f[B]\f[CB]-Q --quarterly\f[B]\f[R] +\f[V]-Q --quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[B]\f[CB]-Y --yearly\f[B]\f[R] +\f[V]-Y --yearly\f[R] multiperiod/multicolumn report by year .TP -\f[B]\f[CB]-p --period=PERIODEXP\f[B]\f[R] +\f[V]-p --period=PERIODEXP\f[R] set start date, end date, and/or reporting interval all at once using period expressions syntax .TP -\f[B]\f[CB]--date2\f[B]\f[R] +\f[V]--date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[B]\f[CB]--today=DATE\f[B]\f[R] +\f[V]--today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[B]\f[CB]-U --unmarked\f[B]\f[R] +\f[V]-U --unmarked\f[R] include only unmarked postings/txns (can combine with -P or -C) .TP -\f[B]\f[CB]-P --pending\f[B]\f[R] +\f[V]-P --pending\f[R] include only pending postings/txns .TP -\f[B]\f[CB]-C --cleared\f[B]\f[R] +\f[V]-C --cleared\f[R] include only cleared postings/txns .TP -\f[B]\f[CB]-R --real\f[B]\f[R] +\f[V]-R --real\f[R] include only non-virtual postings .TP -\f[B]\f[CB]-NUM --depth=NUM\f[B]\f[R] +\f[V]-NUM --depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[B]\f[CB]-E --empty\f[B]\f[R] +\f[V]-E --empty\f[R] show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) .TP -\f[B]\f[CB]-B --cost\f[B]\f[R] +\f[V]-B --cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[B]\f[CB]-V --market\f[B]\f[R] +\f[V]-V --market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[B]\f[CB]-X --exchange=COMM\f[B]\f[R] +\f[V]-X --exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[B]\f[CB]--value\f[B]\f[R] +\f[V]--value\f[R] convert amounts to cost or market value, more flexibly than -B/-V/-X .TP -\f[B]\f[CB]--infer-market-prices\f[B]\f[R] +\f[V]--infer-market-prices\f[R] use transaction prices (recorded with \[at] or \[at]\[at]) as additional market prices, as if they were P directives .TP -\f[B]\f[CB]--auto\f[B]\f[R] +\f[V]--auto\f[R] apply automated posting rules to modify transactions. .TP -\f[B]\f[CB]--forecast\f[B]\f[R] +\f[V]--forecast\f[R] generate future transactions from periodic transaction rules, for the next 6 months or till report end date. In hledger-ui, also make ordinary future transactions visible. .TP -\f[B]\f[CB]--commodity-style\f[B]\f[R] +\f[V]--commodity-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP -\f[B]\f[CB]--color=WHEN (or --colour=WHEN)\f[B]\f[R] +\f[V]--color=WHEN (or --colour=WHEN)\f[R] Should color-supporting commands use ANSI color codes in text output. \[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting terminal. @@ -208,7 +208,7 @@ into \[aq]less -R\[aq]. \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[B]\f[CB]--pretty[=WHEN]\f[B]\f[R] +\f[V]--pretty[=WHEN]\f[R] Show prettier output, e.g. using unicode box-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], @@ -223,27 +223,27 @@ Some reporting options can also be written as query arguments. .SS Command options .PP To see options for a particular command, including command-specific -options, run: \f[C]hledger COMMAND -h\f[R]. +options, run: \f[V]hledger COMMAND -h\f[R]. .PP Command-specific options must be written after the command name, eg: -\f[C]hledger print -x\f[R]. +\f[V]hledger print -x\f[R]. .PP Additionally, if the command is an add-on, you may need to put its -options after a double-hyphen, eg: \f[C]hledger ui -- --watch\f[R]. +options after a double-hyphen, eg: \f[V]hledger ui -- --watch\f[R]. Or, you can run the add-on executable directly: -\f[C]hledger-ui --watch\f[R]. +\f[V]hledger-ui --watch\f[R]. .SS Command arguments .PP Most hledger commands accept arguments after the command name, which are often a query, filtering the data in some way. .PP You can save a set of command line options/arguments in a file, and then -reuse them by writing \f[C]\[at]FILENAME\f[R] as a command line +reuse them by writing \f[V]\[at]FILENAME\f[R] as a command line argument. -Eg: \f[C]hledger bal \[at]foo.args\f[R]. +Eg: \f[V]hledger bal \[at]foo.args\f[R]. (To prevent this, eg if you have an argument that begins with a literal -\f[C]\[at]\f[R], precede it with \f[C]--\f[R], eg: -\f[C]hledger bal -- \[at]ARG\f[R]). +\f[V]\[at]\f[R], precede it with \f[V]--\f[R], eg: +\f[V]hledger bal -- \[at]ARG\f[R]). .PP Inside the argument file, each line should contain just one option or argument. @@ -292,8 +292,8 @@ See also: Save frequently used options. .SS Single escaping (shell metacharacters) .PP In shell command lines, characters significant to your shell - such as -spaces, \f[C]<\f[R], \f[C]>\f[R], \f[C](\f[R], \f[C])\f[R], \f[C]|\f[R], -\f[C]$\f[R] and \f[C]\[rs]\f[R] - should be \[dq]shell-escaped\[dq] if +spaces, \f[V]<\f[R], \f[V]>\f[R], \f[V](\f[R], \f[V])\f[R], \f[V]|\f[R], +\f[V]$\f[R] and \f[V]\[rs]\f[R] - should be \[dq]shell-escaped\[dq] if you want hledger to see them. This is done by enclosing them in single or double quotes, or by writing a backslash before them. @@ -313,21 +313,21 @@ $ hledger register credit\[rs] card \f[R] .fi .PP -Windows users should keep in mind that \f[C]cmd\f[R] treats single quote +Windows users should keep in mind that \f[V]cmd\f[R] treats single quote as a regular character, so you should be using double quotes exclusively. PowerShell treats both single and double quotes as quotes. .SS Double escaping (regular expression metacharacters) .PP Characters significant in regular expressions (described below) - such -as \f[C].\f[R], \f[C]\[ha]\f[R], \f[C]$\f[R], \f[C][\f[R], \f[C]]\f[R], -\f[C](\f[R], \f[C])\f[R], \f[C]|\f[R], and \f[C]\[rs]\f[R] - may need to +as \f[V].\f[R], \f[V]\[ha]\f[R], \f[V]$\f[R], \f[V][\f[R], \f[V]]\f[R], +\f[V](\f[R], \f[V])\f[R], \f[V]|\f[R], and \f[V]\[rs]\f[R] - may need to be \[dq]regex-escaped\[dq] if you don\[aq]t want them to be interpreted by hledger\[aq]s regular expression engine. This is done by writing backslashes before them, but since backslash is typically also a shell metacharacter, both shell-escaping and regex-escaping will be needed. -Eg to match a literal \f[C]$\f[R] sign while using the bash shell: +Eg to match a literal \f[V]$\f[R] sign while using the bash shell: .IP .nf \f[C] @@ -348,8 +348,8 @@ When you use hledger to run an external add-on command (described below), one level of shell-escaping is lost from any options or arguments intended for by the add-on command, so those need an extra level of shell-escaping. -Eg to match a literal \f[C]$\f[R] sign while using the bash shell and -running an add-on command (\f[C]ui\f[R]): +Eg to match a literal \f[V]$\f[R] sign while using the bash shell and +running an add-on command (\f[V]ui\f[R]): .IP .nf \f[C] @@ -373,22 +373,22 @@ l l. T{ unescaped: T}@T{ -\f[C]$\f[R] +\f[V]$\f[R] T} T{ escaped: T}@T{ -\f[C]\[rs]$\f[R] +\f[V]\[rs]$\f[R] T} T{ double-escaped: T}@T{ -\f[C]\[rs]\[rs]$\f[R] +\f[V]\[rs]\[rs]$\f[R] T} T{ triple-escaped: T}@T{ -\f[C]\[rs]\[rs]\[rs]\[rs]$\f[R] +\f[V]\[rs]\[rs]\[rs]\[rs]$\f[R] T} .TE .PP @@ -431,13 +431,13 @@ Here are some tips: A system locale must be configured, and it must be one that can decode the characters being used. In bash, you can set a locale like this: -\f[C]export LANG=en_US.UTF-8\f[R]. +\f[V]export LANG=en_US.UTF-8\f[R]. There are some more details in Troubleshooting. This step is essential - without it, hledger will quit on encountering a non-ascii character (as with all GHC-compiled programs). .IP \[bu] 2 -your terminal software (eg Terminal.app, iTerm, CMD.exe, xterm..) must -support unicode +your terminal software (eg Terminal.app, iTerm, CMD.exe, xterm..) +must support unicode .IP \[bu] 2 the terminal must be using a font which includes the required unicode glyphs @@ -456,14 +456,14 @@ or msys terminal, and vice versa. hledger uses regular expressions in a number of places: .IP \[bu] 2 query terms, on the command line and in the hledger-web search form: -\f[C]REGEX\f[R], \f[C]desc:REGEX\f[R], \f[C]cur:REGEX\f[R], -\f[C]tag:...=REGEX\f[R] +\f[V]REGEX\f[R], \f[V]desc:REGEX\f[R], \f[V]cur:REGEX\f[R], +\f[V]tag:...=REGEX\f[R] .IP \[bu] 2 -CSV rules conditional blocks: \f[C]if REGEX ...\f[R] +CSV rules conditional blocks: \f[V]if REGEX ...\f[R] .IP \[bu] 2 account alias directives and options: -\f[C]alias /REGEX/ = REPLACEMENT\f[R], -\f[C]--alias /REGEX/=REPLACEMENT\f[R] +\f[V]alias /REGEX/ = REPLACEMENT\f[R], +\f[V]--alias /REGEX/=REPLACEMENT\f[R] .PP hledger\[aq]s regular expressions come from the regex-tdfa library. If they\[aq]re not doing what you expect, it\[aq]s important to know @@ -476,49 +476,49 @@ being matched) .IP "3." 3 they are POSIX ERE (extended regular expressions) .IP "4." 3 -they also support GNU word boundaries (\f[C]\[rs]b\f[R], -\f[C]\[rs]B\f[R], \f[C]\[rs]<\f[R], \f[C]\[rs]>\f[R]) +they also support GNU word boundaries (\f[V]\[rs]b\f[R], +\f[V]\[rs]B\f[R], \f[V]\[rs]<\f[R], \f[V]\[rs]>\f[R]) .IP "5." 3 -they do not support backreferences; if you write \f[C]\[rs]1\f[R], it -will match the digit \f[C]1\f[R]. +they do not support backreferences; if you write \f[V]\[rs]1\f[R], it +will match the digit \f[V]1\f[R]. Except when doing text replacement, eg in account aliases, where backreferences can be used in the replacement string to reference capturing groups in the search regexp. .IP "6." 3 -they do not support mode modifiers (\f[C](?s)\f[R]), character classes -(\f[C]\[rs]w\f[R], \f[C]\[rs]d\f[R]), or anything else not mentioned +they do not support mode modifiers (\f[V](?s)\f[R]), character classes +(\f[V]\[rs]w\f[R], \f[V]\[rs]d\f[R]), or anything else not mentioned above. .PP Some things to note: .IP \[bu] 2 -In the \f[C]alias\f[R] directive and \f[C]--alias\f[R] option, regular -expressions must be enclosed in forward slashes (\f[C]/REGEX/\f[R]). +In the \f[V]alias\f[R] directive and \f[V]--alias\f[R] option, regular +expressions must be enclosed in forward slashes (\f[V]/REGEX/\f[R]). Elsewhere in hledger, these are not required. .IP \[bu] 2 -In queries, to match a regular expression metacharacter like \f[C]$\f[R] +In queries, to match a regular expression metacharacter like \f[V]$\f[R] as a literal character, prepend a backslash. Eg to search for amounts with the dollar sign in hledger-web, write -\f[C]cur:\[rs]$\f[R]. +\f[V]cur:\[rs]$\f[R]. .IP \[bu] 2 -On the command line, some metacharacters like \f[C]$\f[R] have a special +On the command line, some metacharacters like \f[V]$\f[R] have a special meaning to the shell and so must be escaped at least once more. See Special characters. .SH ENVIRONMENT .PP \f[B]LEDGER_FILE\f[R] The journal file path when not specified with -\f[C]-f\f[R]. +\f[V]-f\f[R]. .PP On unix computers, the default value is: -\f[C]\[ti]/.hledger.journal\f[R]. +\f[V]\[ti]/.hledger.journal\f[R]. .PP A more typical value is something like -\f[C]\[ti]/finance/YYYY.journal\f[R], where \f[C]\[ti]/finance\f[R] is a +\f[V]\[ti]/finance/YYYY.journal\f[R], where \f[V]\[ti]/finance\f[R] is a version-controlled finance directory and YYYY is the current year. -Or, \f[C]\[ti]/finance/current.journal\f[R], where current.journal is a +Or, \f[V]\[ti]/finance/current.journal\f[R], where current.journal is a symbolic link to YYYY.journal. .PP The usual way to set this permanently is to add a command to one of your -shell\[aq]s startup files (eg \f[C]\[ti]/.profile\f[R]): +shell\[aq]s startup files (eg \f[V]\[ti]/.profile\f[R]): .IP .nf \f[C] @@ -529,7 +529,7 @@ export LEDGER_FILE=\[ti]/finance/current.journal\[ga] On some Mac computers, there is a more thorough way to set environment variables, that will also affect applications started from the GUI (eg, Emacs started from a dock icon): In -\f[C]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: +\f[V]\[ti]/.MacOSX/environment.plist\f[R], add an entry like: .IP .nf \f[C] @@ -539,11 +539,11 @@ Emacs started from a dock icon): In \f[R] .fi .PP -For this to take effect you might need to \f[C]killall Dock\f[R], or +For this to take effect you might need to \f[V]killall Dock\f[R], or reboot. .PP On Windows computers, the default value is probably -\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]. +\f[V]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]. You can change this by running a command like this in a powershell window (let us know if you need to be an Administrator, and if this persists across a reboot): @@ -566,11 +566,11 @@ This is overriden by the --color/--colour option. .SH INPUT .PP hledger reads transactions from one or more data files. -The default data file is \f[C]$HOME/.hledger.journal\f[R] (or on +The default data file is \f[V]$HOME/.hledger.journal\f[R] (or on Windows, something like -\f[C]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]). +\f[V]C:\[rs]Users\[rs]YOURNAME\[rs].hledger.journal\f[R]). .PP -You can override this with the \f[C]$LEDGER_FILE\f[R] environment +You can override this with the \f[V]$LEDGER_FILE\f[R] environment variable: .IP .nf @@ -580,7 +580,7 @@ $ hledger stats \f[R] .fi .PP -or with one or more \f[C]-f/--file\f[R] options: +or with one or more \f[V]-f/--file\f[R] options: .IP .nf \f[C] @@ -588,7 +588,7 @@ $ hledger -f /some/file -f another_file stats \f[R] .fi .PP -The file name \f[C]-\f[R] means standard input: +The file name \f[V]-\f[R] means standard input: .IP .nf \f[C] @@ -612,32 +612,32 @@ Used for file extensions: T} _ T{ -\f[C]journal\f[R] +\f[V]journal\f[R] T}@T{ hledger journal files and some Ledger journals, for transactions T}@T{ -\f[C].journal\f[R] \f[C].j\f[R] \f[C].hledger\f[R] \f[C].ledger\f[R] +\f[V].journal\f[R] \f[V].j\f[R] \f[V].hledger\f[R] \f[V].ledger\f[R] T} T{ -\f[C]timeclock\f[R] +\f[V]timeclock\f[R] T}@T{ timeclock files, for precise time logging T}@T{ -\f[C].timeclock\f[R] +\f[V].timeclock\f[R] T} T{ -\f[C]timedot\f[R] +\f[V]timedot\f[R] T}@T{ timedot files, for approximate time logging T}@T{ -\f[C].timedot\f[R] +\f[V].timedot\f[R] T} T{ -\f[C]csv\f[R] +\f[V]csv\f[R] T}@T{ comma/semicolon/tab/other-separated values, for data import T}@T{ -\f[C].csv\f[R] \f[C].ssv\f[R] \f[C].tsv\f[R] +\f[V].csv\f[R] \f[V].ssv\f[R] \f[V].tsv\f[R] T} .TE .PP @@ -646,7 +646,7 @@ These formats are described in their own sections, below. hledger detects the format automatically based on the file extensions shown above. If it can\[aq]t recognise the file extension, it assumes -\f[C]journal\f[R] format. +\f[V]journal\f[R] format. So for non-journal files, it\[aq]s important to use a recognised file extension, so as to either read successfully or to show relevant error messages. @@ -661,7 +661,7 @@ $ hledger -f csv:/some/csv-file.dat stats \f[R] .fi .PP -Or to read stdin (\f[C]-\f[R]) as timeclock format: +Or to read stdin (\f[V]-\f[R]) as timeclock format: .IP .nf \f[C] @@ -670,7 +670,7 @@ $ echo \[aq]i 2009/13/1 08:00:00\[aq] | hledger print -ftimeclock:- .fi .SS Multiple files .PP -You can specify multiple \f[C]-f\f[R] options, to read multiple files as +You can specify multiple \f[V]-f\f[R] options, to read multiple files as one big journal. There are some limitations with this: .IP \[bu] 2 @@ -683,7 +683,7 @@ If you need either of those things, you can use a single parent file which includes the others .IP \[bu] 2 or concatenate the files into one before reading, eg: -\f[C]cat a.journal b.journal | hledger -f- CMD\f[R]. +\f[V]cat a.journal b.journal | hledger -f- CMD\f[R]. .SS Strict mode .PP hledger checks input files for valid data. @@ -696,14 +696,14 @@ Are all transactions balanced ? .IP \[bu] 2 Do all balance assertions pass ? .PP -With the \f[C]-s\f[R]/\f[C]--strict\f[R] flag, additional checks are +With the \f[V]-s\f[R]/\f[V]--strict\f[R] flag, additional checks are performed: .IP \[bu] 2 -Are all accounts posted to, declared with an \f[C]account\f[R] directive +Are all accounts posted to, declared with an \f[V]account\f[R] directive ? (Account error checking) .IP \[bu] 2 -Are all commodities declared with a \f[C]commodity\f[R] directive ? +Are all commodities declared with a \f[V]commodity\f[R] directive ? (Commodity error checking) .IP \[bu] 2 Are all commodity conversions declared explicitly ? @@ -726,7 +726,7 @@ $ hledger print > foo.txt .fi .PP Some commands (print, register, stats, the balance commands) also -provide the \f[C]-o/--output-file\f[R] option, which does the same thing +provide the \f[V]-o/--output-file\f[R] option, which does the same thing without needing the shell. Eg: .IP @@ -740,18 +740,18 @@ $ hledger print -o - # write to stdout (the default) .PP hledger commands can produce colour output when the terminal supports it. -This is controlled by the \f[C]--color/--colour\f[R] option: - if the -\f[C]--color/--colour\f[R] option is given a value of \f[C]yes\f[R] or -\f[C]always\f[R] (or \f[C]no\f[R] or \f[C]never\f[R]), colour will (or -will not) be used; - otherwise, if the \f[C]NO_COLOR\f[R] environment +This is controlled by the \f[V]--color/--colour\f[R] option: - if the +\f[V]--color/--colour\f[R] option is given a value of \f[V]yes\f[R] or +\f[V]always\f[R] (or \f[V]no\f[R] or \f[V]never\f[R]), colour will (or +will not) be used; - otherwise, if the \f[V]NO_COLOR\f[R] environment variable is set, colour will not be used; - otherwise, colour will be used if the output (terminal or file) supports it. .PP hledger commands can also use unicode box-drawing characters to produce prettier tables and output. -This is controlled by the \f[C]--pretty\f[R] option: - if the -\f[C]--pretty\f[R] option is given a value of \f[C]yes\f[R] or -\f[C]always\f[R] (or \f[C]no\f[R] or \f[C]never\f[R]), unicode +This is controlled by the \f[V]--pretty\f[R] option: - if the +\f[V]--pretty\f[R] option is given a value of \f[V]yes\f[R] or +\f[V]always\f[R] (or \f[V]no\f[R] or \f[V]never\f[R]), unicode characters will (or will not) be used; - otherwise, unicode characters will not be used. .SS Output format @@ -762,7 +762,7 @@ Here are those commands and the formats currently supported: .PP .TS tab(@); -l l l l l l. +lw(25.9n) lw(9.1n) lw(9.1n) lw(11.7n) lw(7.8n) lw(6.5n). T{ - T}@T{ @@ -873,13 +873,13 @@ T}@T{ T} .TE .IP \[bu] 2 -\f[I]1 Also affected by the balance commands\[aq] \f[CI]--layout\f[I] +\f[I]1 Also affected by the balance commands\[aq] \f[VI]--layout\f[I] option.\f[R] .IP \[bu] 2 -\f[I]2 \f[CI]balance\f[I] does not support html output without a report -interval or with \f[CI]--budget\f[I].\f[R] +\f[I]2 \f[VI]balance\f[I] does not support html output without a report +interval or with \f[VI]--budget\f[I].\f[R] .PP -The output format is selected by the \f[C]-O/--output-format=FMT\f[R] +The output format is selected by the \f[V]-O/--output-format=FMT\f[R] option: .IP .nf @@ -889,7 +889,7 @@ $ hledger print -O csv # print CSV on stdout .fi .PP or by the filename extension of an output file specified with the -\f[C]-o/--output-file=FILE.FMT\f[R] option: +\f[V]-o/--output-file=FILE.FMT\f[R] option: .IP .nf \f[C] @@ -897,7 +897,7 @@ $ hledger balancesheet -o foo.csv # write CSV to foo.csv \f[R] .fi .PP -The \f[C]-O\f[R] option can be combined with \f[C]-o\f[R] to override +The \f[V]-O\f[R] option can be combined with \f[V]-o\f[R] to override the file extension, if needed: .IP .nf @@ -911,7 +911,7 @@ In CSV output, digit group marks (such as thousands separators) are disabled automatically. .SS HTML output .IP \[bu] 2 -HTML output can be styled by an optional \f[C]hledger.css\f[R] file in +HTML output can be styled by an optional \f[V]hledger.css\f[R] file in the same directory. .SS JSON output .IP \[bu] 2 @@ -944,16 +944,16 @@ SQL output is structured with the expectations that statements will be executed in the empty database. If you already have tables created via SQL output of hledger, you would probably want to either clear tables of existing data (via -\f[C]delete\f[R] or \f[C]truncate\f[R] SQL statements) or drop tables +\f[V]delete\f[R] or \f[V]truncate\f[R] SQL statements) or drop tables completely as otherwise your postings will be duped. .SS Commodity styles .PP The display style of a commodity/currency is inferred according to the rules described in Commodity display style. The inferred display style can be overridden by an optional -\f[C]-c/--commodity-style\f[R] option (Exceptions: as is the case for +\f[V]-c/--commodity-style\f[R] option (Exceptions: as is the case for inferred styles, price amounts, and all amounts displayed by the -\f[C]print\f[R] command, will be displayed with all of their decimal +\f[V]print\f[R] command, will be displayed with all of their decimal digits visible, regardless of the specified precision). For example, the following will override the display style for dollars. .IP @@ -971,14 +971,14 @@ display style for multiple commodity/currency symbols. .PP We aim for hledger to be relatively easy to troubleshoot, introspect and develop. -You can add \f[C]--debug[=N]\f[R] to any hledger command line to see +You can add \f[V]--debug[=N]\f[R] to any hledger command line to see additional debug output. N ranges from 1 (least output, the default) to 9 (maximum output). Typically you would start with 1 and increase until you are seeing enough. Debug output goes to stderr, and is not affected by -\f[C]-o/--output-file\f[R] (unless you redirect stderr to stdout, eg: -\f[C]2>&1\f[R]). +\f[V]-o/--output-file\f[R] (unless you redirect stderr to stdout, eg: +\f[V]2>&1\f[R]). It will be interleaved with normal output, which can help reveal when parts of the code are evaluated. To capture debug output in a log file instead, you can usually redirect @@ -986,7 +986,7 @@ stderr, eg: .PD 0 .P .PD -\f[C]hledger bal --debug=3 2>hledger.log\f[R]. +\f[V]hledger bal --debug=3 2>hledger.log\f[R]. .SH TIME PERIODS .SS Smart dates .PP @@ -1002,68 +1002,68 @@ Examples: tab(@); lw(24.2n) lw(45.8n). T{ -\f[C]2004/10/1\f[R], \f[C]2004-01-01\f[R], \f[C]2004.9.1\f[R] +\f[V]2004/10/1\f[R], \f[V]2004-01-01\f[R], \f[V]2004.9.1\f[R] T}@T{ exact date, several separators allowed. Year is 4+ digits, month is 1-12, day is 1-31 T} T{ -\f[C]2004\f[R] +\f[V]2004\f[R] T}@T{ start of year T} T{ -\f[C]2004/10\f[R] +\f[V]2004/10\f[R] T}@T{ start of month T} T{ -\f[C]10/1\f[R] +\f[V]10/1\f[R] T}@T{ month and day in current year T} T{ -\f[C]21\f[R] +\f[V]21\f[R] T}@T{ day in current month T} T{ -\f[C]october, oct\f[R] +\f[V]october, oct\f[R] T}@T{ start of month in current year T} T{ -\f[C]yesterday, today, tomorrow\f[R] +\f[V]yesterday, today, tomorrow\f[R] T}@T{ -1, 0, 1 days from today T} T{ -\f[C]last/this/next day/week/month/quarter/year\f[R] +\f[V]last/this/next day/week/month/quarter/year\f[R] T}@T{ -1, 0, 1 periods from the current period T} T{ -\f[C]in n days/weeks/months/quarters/years\f[R] +\f[V]in n days/weeks/months/quarters/years\f[R] T}@T{ n periods from the current period T} T{ -\f[C]n days/weeks/months/quarters/years ahead\f[R] +\f[V]n days/weeks/months/quarters/years ahead\f[R] T}@T{ n periods from the current period T} T{ -\f[C]n days/weeks/months/quarters/years ago\f[R] +\f[V]n days/weeks/months/quarters/years ago\f[R] T}@T{ -n periods from the current period T} T{ -\f[C]20181201\f[R] +\f[V]20181201\f[R] T}@T{ 8 digit YYYYMMDD with valid year month and day T} T{ -\f[C]201812\f[R] +\f[V]201812\f[R] T}@T{ 6 digit YYYYMM with valid year and month T} @@ -1076,32 +1076,32 @@ results: tab(@); lw(11.4n) lw(58.6n). T{ -\f[C]201813\f[R] +\f[V]201813\f[R] T}@T{ 6 digits with an invalid month is parsed as start of 6-digit year T} T{ -\f[C]20181301\f[R] +\f[V]20181301\f[R] T}@T{ 8 digits with an invalid month is parsed as start of 8-digit year T} T{ -\f[C]20181232\f[R] +\f[V]20181232\f[R] T}@T{ 8 digits with an invalid day gives an error T} T{ -\f[C]201801012\f[R] +\f[V]201801012\f[R] T}@T{ 9+ digits beginning with a valid YYYYMMDD gives an error T} .TE .PP Note \[dq]today\[aq]s date\[dq] can be overridden with the -\f[C]--today\f[R] option, in case it\[aq]s needed for testing or for +\f[V]--today\f[R] option, in case it\[aq]s needed for testing or for recreating old reports. (Except for periodic transaction rules; those are not affected by -\f[C]--today\f[R].) +\f[V]--today\f[R].) .PP .SS Report start & end date .PP @@ -1113,8 +1113,8 @@ market price date. .PP Often you will want to see a shorter time span, such as the current month. -You can specify a start and/or end date using \f[C]-b/--begin\f[R], -\f[C]-e/--end\f[R], \f[C]-p/--period\f[R] or a \f[C]date:\f[R] query +You can specify a start and/or end date using \f[V]-b/--begin\f[R], +\f[V]-e/--end\f[R], \f[V]-p/--period\f[R] or a \f[V]date:\f[R] query (described below). All of these accept the smart date syntax. .PP @@ -1128,8 +1128,8 @@ As noted in reporting options: among start/end dates specified with right-most) option takes precedence. .IP \[bu] 2 The effective report start and end dates are the intersection of the -start/end dates from options and that from \f[C]date:\f[R] queries. -That is, \f[C]date:2019-01 date:2019 -p\[aq]2000 to 2030\[aq]\f[R] +start/end dates from options and that from \f[V]date:\f[R] queries. +That is, \f[V]date:2019-01 date:2019 -p\[aq]2000 to 2030\[aq]\f[R] yields January 2019, the smallest common time span. .IP \[bu] 2 A report interval (see below) will adjust start/end dates, when needed, @@ -1141,42 +1141,42 @@ Examples: tab(@); lw(12.4n) lw(57.6n). T{ -\f[C]-b 2016/3/17\f[R] +\f[V]-b 2016/3/17\f[R] T}@T{ begin on St.\ Patrick\[cq]s day 2016 T} T{ -\f[C]-e 12/1\f[R] +\f[V]-e 12/1\f[R] T}@T{ end at the start of december 1st of the current year (11/30 will be the last date included) T} T{ -\f[C]-b thismonth\f[R] +\f[V]-b thismonth\f[R] T}@T{ all transactions on or after the 1st of the current month T} T{ -\f[C]-p thismonth\f[R] +\f[V]-p thismonth\f[R] T}@T{ all transactions in the current month T} T{ -\f[C]date:2016/3/17..\f[R] +\f[V]date:2016/3/17..\f[R] T}@T{ -the above written as queries instead (\f[C]..\f[R] can also be replaced -with \f[C]-\f[R]) +the above written as queries instead (\f[V]..\f[R] can also be replaced +with \f[V]-\f[R]) T} T{ -\f[C]date:..12/1\f[R] +\f[V]date:..12/1\f[R] T}@T{ T} T{ -\f[C]date:thismonth..\f[R] +\f[V]date:thismonth..\f[R] T}@T{ T} T{ -\f[C]date:thismonth\f[R] +\f[V]date:thismonth\f[R] T}@T{ T} .TE @@ -1189,23 +1189,23 @@ separate row or column. The following \[dq]standard\[dq] report intervals can be enabled by using their corresponding flag: .IP \[bu] 2 -\f[C]-D/--daily\f[R] +\f[V]-D/--daily\f[R] .IP \[bu] 2 -\f[C]-W/--weekly\f[R] +\f[V]-W/--weekly\f[R] .IP \[bu] 2 -\f[C]-M/--monthly\f[R] +\f[V]-M/--monthly\f[R] .IP \[bu] 2 -\f[C]-Q/--quarterly\f[R] +\f[V]-Q/--quarterly\f[R] .IP \[bu] 2 -\f[C]-Y/--yearly\f[R] +\f[V]-Y/--yearly\f[R] .PP These standard intervals always start on natural interval boundaries: eg -\f[C]--weekly\f[R] starts on mondays, \f[C]--monthly\f[R] starts on the -first of the month, \f[C]--yearly\f[R] always starts on January 1st, +\f[V]--weekly\f[R] starts on mondays, \f[V]--monthly\f[R] starts on the +first of the month, \f[V]--yearly\f[R] always starts on January 1st, etc. .PP Certain more complex intervals, and more flexible boundary dates, can be -specified by \f[C]-p/--period\f[R]. +specified by \f[V]-p/--period\f[R]. These are described in period expressions, below. .PP Report intervals can only be specified by the flags above, and not by @@ -1213,7 +1213,7 @@ query arguments, currently. .PP Report intervals have another effect: multi-period reports are always expanded to fill a whole number of subperiods. -So if you use a report interval (other than \f[C]--daily\f[R]), and you +So if you use a report interval (other than \f[V]--daily\f[R]), and you have specified a start or end date, you may notice those dates being overridden (ie, the report starts earlier than your requested start date, or ends later than your requested end date). @@ -1226,16 +1226,16 @@ In multiperiod reports, all subperiods are forced to be the same length, to simplify reporting. .IP \[bu] 2 Reports with the standard -\f[C]--weekly\f[R]/\f[C]--monthly\f[R]/\f[C]--quarterly\f[R]/\f[C]--yearly\f[R] +\f[V]--weekly\f[R]/\f[V]--monthly\f[R]/\f[V]--quarterly\f[R]/\f[V]--yearly\f[R] intervals are required to start on the first day of a week/month/quarter/year. We\[aq]d like more flexibility here but it isn\[aq]t supported yet. .IP \[bu] 2 -\f[C]--period\f[R] (below) can specify more complex intervals, starting +\f[V]--period\f[R] (below) can specify more complex intervals, starting on any date. .SS Period expressions .PP -The \f[C]-p/--period\f[R] option accepts period expressions, a shorthand +The \f[V]-p/--period\f[R] option accepts period expressions, a shorthand way of expressing a start date, end date, and/or report interval all at once. .PP @@ -1248,7 +1248,7 @@ exclusive: tab(@); l. T{ -\f[C]-p \[dq]from 2009/1/1 to 2009/4/1\[dq]\f[R] +\f[V]-p \[dq]from 2009/1/1 to 2009/4/1\[dq]\f[R] T} .TE .PP @@ -1261,13 +1261,13 @@ These are equivalent to the above: tab(@); l. T{ -\f[C]-p \[dq]2009/1/1 2009/4/1\[dq]\f[R] +\f[V]-p \[dq]2009/1/1 2009/4/1\[dq]\f[R] T} T{ -\f[C]-p2009/1/1to2009/4/1\f[R] +\f[V]-p2009/1/1to2009/4/1\f[R] T} T{ -\f[C]-p2009/1/1..2009/4/1\f[R] +\f[V]-p2009/1/1..2009/4/1\f[R] T} .TE .PP @@ -1278,13 +1278,13 @@ also be written as: tab(@); l. T{ -\f[C]-p \[dq]1/1 4/1\[dq]\f[R] +\f[V]-p \[dq]1/1 4/1\[dq]\f[R] T} T{ -\f[C]-p \[dq]january-apr\[dq]\f[R] +\f[V]-p \[dq]january-apr\[dq]\f[R] T} T{ -\f[C]-p \[dq]this year to 4/1\[dq]\f[R] +\f[V]-p \[dq]this year to 4/1\[dq]\f[R] T} .TE .PP @@ -1295,22 +1295,22 @@ earliest or latest transaction in your journal: tab(@); l l. T{ -\f[C]-p \[dq]from 2009/1/1\[dq]\f[R] +\f[V]-p \[dq]from 2009/1/1\[dq]\f[R] T}@T{ everything after january 1, 2009 T} T{ -\f[C]-p \[dq]from 2009/1\[dq]\f[R] +\f[V]-p \[dq]from 2009/1\[dq]\f[R] T}@T{ the same T} T{ -\f[C]-p \[dq]from 2009\[dq]\f[R] +\f[V]-p \[dq]from 2009\[dq]\f[R] T}@T{ the same T} T{ -\f[C]-p \[dq]to 2009\[dq]\f[R] +\f[V]-p \[dq]to 2009\[dq]\f[R] T}@T{ everything before january 1, 2009 T} @@ -1321,19 +1321,19 @@ start and end date like so: .PP .TS tab(@); -l l. +lw(15.3n) lw(54.7n). T{ -\f[C]-p \[dq]2009\[dq]\f[R] +\f[V]-p \[dq]2009\[dq]\f[R] T}@T{ the year 2009; equivalent to \[lq]2009/1/1 to 2010/1/1\[rq] T} T{ -\f[C]-p \[dq]2009/1\[dq]\f[R] +\f[V]-p \[dq]2009/1\[dq]\f[R] T}@T{ the month of jan; equivalent to \[lq]2009/1/1 to 2009/2/1\[rq] T} T{ -\f[C]-p \[dq]2009/1/1\[dq]\f[R] +\f[V]-p \[dq]2009/1/1\[dq]\f[R] T}@T{ just that day; equivalent to \[lq]2009/1/1 to 2009/1/2\[rq] T} @@ -1343,45 +1343,45 @@ Or you can specify a single quarter like so: .PP .TS tab(@); -l l. +lw(15.3n) lw(54.7n). T{ -\f[C]-p \[dq]2009Q1\[dq]\f[R] +\f[V]-p \[dq]2009Q1\[dq]\f[R] T}@T{ first quarter of 2009, equivalent to \[lq]2009/1/1 to 2009/4/1\[rq] T} T{ -\f[C]-p \[dq]q4\[dq]\f[R] +\f[V]-p \[dq]q4\[dq]\f[R] T}@T{ fourth quarter of the current year T} .TE .SS Period expressions with a report interval .PP -\f[C]-p/--period\f[R]\[aq]s argument can also begin with, or entirely +\f[V]-p/--period\f[R]\[aq]s argument can also begin with, or entirely consist of, a report interval. This should be separated from the start/end dates (if any) by a space, -or the word \f[C]in\f[R]. +or the word \f[V]in\f[R]. The basic intervals (which can also be written as command line flags) -are \f[C]daily\f[R], \f[C]weekly\f[R], \f[C]monthly\f[R], -\f[C]quarterly\f[R], and \f[C]yearly\f[R]. +are \f[V]daily\f[R], \f[V]weekly\f[R], \f[V]monthly\f[R], +\f[V]quarterly\f[R], and \f[V]yearly\f[R]. Some examples: .PP .TS tab(@); l. T{ -\f[C]-p \[dq]weekly from 2009/1/1 to 2009/4/1\[dq]\f[R] +\f[V]-p \[dq]weekly from 2009/1/1 to 2009/4/1\[dq]\f[R] T} T{ -\f[C]-p \[dq]monthly in 2008\[dq]\f[R] +\f[V]-p \[dq]monthly in 2008\[dq]\f[R] T} T{ -\f[C]-p \[dq]quarterly\[dq]\f[R] +\f[V]-p \[dq]quarterly\[dq]\f[R] T} .TE .PP -As mentioned above, the \f[C]weekly\f[R], \f[C]monthly\f[R], -\f[C]quarterly\f[R] and \f[C]yearly\f[R] intervals require a report +As mentioned above, the \f[V]weekly\f[R], \f[V]monthly\f[R], +\f[V]quarterly\f[R] and \f[V]yearly\f[R] intervals require a report start date that is the first day of a week, month, quarter or year. And, report start/end dates will be expanded if needed to span a whole number of intervals. @@ -1392,23 +1392,23 @@ For example: tab(@); lw(25.5n) lw(44.5n). T{ -\f[C]-p \[dq]weekly from 2009/1/1 to 2009/4/1\[dq]\f[R] +\f[V]-p \[dq]weekly from 2009/1/1 to 2009/4/1\[dq]\f[R] T}@T{ starts on 2008/12/29, closest preceding Monday T} T{ -\f[C]-p \[dq]monthly in 2008/11/25\[dq]\f[R] +\f[V]-p \[dq]monthly in 2008/11/25\[dq]\f[R] T}@T{ starts on 2018/11/01 T} T{ -\f[C]-p \[dq]quarterly from 2009-05-05 to 2009-06-01\[dq]\f[R] +\f[V]-p \[dq]quarterly from 2009-05-05 to 2009-06-01\[dq]\f[R] T}@T{ starts on 2009/04/01, ends on 2009/06/30, which are first and last days of Q2 2009 T} T{ -\f[C]-p \[dq]yearly from 2009-12-29\[dq]\f[R] +\f[V]-p \[dq]yearly from 2009-12-29\[dq]\f[R] T}@T{ starts on 2009/01/01, first day of 2009 T} @@ -1418,15 +1418,15 @@ T} Some more complex kinds of interval are also supported in period expressions: .IP \[bu] 2 -\f[C]biweekly\f[R] +\f[V]biweekly\f[R] .IP \[bu] 2 -\f[C]fortnightly\f[R] +\f[V]fortnightly\f[R] .IP \[bu] 2 -\f[C]bimonthly\f[R] +\f[V]bimonthly\f[R] .IP \[bu] 2 -\f[C]every day|week|month|quarter|year\f[R] +\f[V]every day|week|month|quarter|year\f[R] .IP \[bu] 2 -\f[C]every N days|weeks|months|quarters|years\f[R] +\f[V]every N days|weeks|months|quarters|years\f[R] .PP These too will cause report start/end dates to be expanded, if needed, to span a whole number of intervals. @@ -1436,17 +1436,17 @@ Examples: tab(@); lw(26.0n) lw(44.0n). T{ -\f[C]-p \[dq]bimonthly from 2008\[dq]\f[R] +\f[V]-p \[dq]bimonthly from 2008\[dq]\f[R] T}@T{ periods will have boundaries on 2008/01/01, 2008/03/01, ... T} T{ -\f[C]-p \[dq]every 2 weeks\[dq]\f[R] +\f[V]-p \[dq]every 2 weeks\[dq]\f[R] T}@T{ starts on closest preceding Monday T} T{ -\f[C]-p \[dq]every 5 months from 2009/03\[dq]\f[R] +\f[V]-p \[dq]every 5 months from 2009/03\[dq]\f[R] T}@T{ periods will have boundaries on 2009/03/01, 2009/08/01, ... T} @@ -1458,26 +1458,26 @@ calendar boundaries, but the following intervals can start on any date: .PP Weekly on custom day: .IP \[bu] 2 -\f[C]every Nth day of week\f[R] (\f[C]th\f[R], \f[C]nd\f[R], -\f[C]rd\f[R], or \f[C]st\f[R] are all accepted after the number) +\f[V]every Nth day of week\f[R] (\f[V]th\f[R], \f[V]nd\f[R], +\f[V]rd\f[R], or \f[V]st\f[R] are all accepted after the number) .IP \[bu] 2 -\f[C]every WEEKDAYNAME\f[R] (full or three-letter english weekday name, +\f[V]every WEEKDAYNAME\f[R] (full or three-letter english weekday name, case insensitive) .PP Monthly on custom day: .IP \[bu] 2 -\f[C]every Nth day [of month]\f[R] +\f[V]every Nth day [of month]\f[R] .IP \[bu] 2 -\f[C]every Nth WEEKDAYNAME [of month]\f[R] +\f[V]every Nth WEEKDAYNAME [of month]\f[R] .PP Yearly on custom day: .IP \[bu] 2 -\f[C]every MM/DD [of year]\f[R] (month number and day of month number) +\f[V]every MM/DD [of year]\f[R] (month number and day of month number) .IP \[bu] 2 -\f[C]every MONTHNAME DDth [of year]\f[R] (full or three-letter english +\f[V]every MONTHNAME DDth [of year]\f[R] (full or three-letter english month name, case insensitive, and day of month number) .IP \[bu] 2 -\f[C]every DDth MONTHNAME [of year]\f[R] (equivalent to the above) +\f[V]every DDth MONTHNAME [of year]\f[R] (equivalent to the above) .PP Examples: .PP @@ -1485,37 +1485,37 @@ Examples: tab(@); lw(23.9n) lw(46.1n). T{ -\f[C]-p \[dq]every 2nd day of week\[dq]\f[R] +\f[V]-p \[dq]every 2nd day of week\[dq]\f[R] T}@T{ periods will go from Tue to Tue T} T{ -\f[C]-p \[dq]every Tue\[dq]\f[R] +\f[V]-p \[dq]every Tue\[dq]\f[R] T}@T{ same T} T{ -\f[C]-p \[dq]every 15th day\[dq]\f[R] +\f[V]-p \[dq]every 15th day\[dq]\f[R] T}@T{ period boundaries will be on 15th of each month T} T{ -\f[C]-p \[dq]every 2nd Monday\[dq]\f[R] +\f[V]-p \[dq]every 2nd Monday\[dq]\f[R] T}@T{ period boundaries will be on second Monday of each month T} T{ -\f[C]-p \[dq]every 11/05\[dq]\f[R] +\f[V]-p \[dq]every 11/05\[dq]\f[R] T}@T{ yearly periods with boundaries on 5th of November T} T{ -\f[C]-p \[dq]every 5th November\[dq]\f[R] +\f[V]-p \[dq]every 5th November\[dq]\f[R] T}@T{ same T} T{ -\f[C]-p \[dq]every Nov 5th\[dq]\f[R] +\f[V]-p \[dq]every Nov 5th\[dq]\f[R] T}@T{ same T} @@ -1541,25 +1541,25 @@ $ hledger register checking -p \[dq]every 3rd day of week\[dq] .SS Periods or dates ? .PP Report intervals like the above are most often used with -\f[C]-p|--period\f[R], to divide reports into multiple subperiods - each +\f[V]-p|--period\f[R], to divide reports into multiple subperiods - each generated date marks a subperiod boundary. Here, the periods between the dates are what\[aq]s important. .PP -But report intervals can also be used with \f[C]--forecast\f[R] to -generate future transactions, or with \f[C]balance --budget\f[R] to +But report intervals can also be used with \f[V]--forecast\f[R] to +generate future transactions, or with \f[V]balance --budget\f[R] to generate budget goal-setting transactions. For these, the dates themselves are what matters. .SS Events on multiple weekdays .PP -The \f[C]every WEEKDAYNAME\f[R] form has a special variant with multiple +The \f[V]every WEEKDAYNAME\f[R] form has a special variant with multiple day names, comma-separated. -Eg: \f[C]every mon,thu,sat\f[R]. -Also, \f[C]weekday\f[R] and \f[C]weekendday\f[R] are shorthand for -\f[C]mon,tue,wed,thu,fri\f[R] and \f[C]sat,sun\f[R] respectively. +Eg: \f[V]every mon,thu,sat\f[R]. +Also, \f[V]weekday\f[R] and \f[V]weekendday\f[R] are shorthand for +\f[V]mon,tue,wed,thu,fri\f[R] and \f[V]sat,sun\f[R] respectively. .PP -This form is mainly intended for use with \f[C]--forecast\f[R], to +This form is mainly intended for use with \f[V]--forecast\f[R], to generate periodic transactions on arbitrary days of the week. -It may be less useful with \f[C]-p\f[R], since it divides each week into +It may be less useful with \f[V]-p\f[R], since it divides each week into subperiods of unequal length. (Because gaps between periods are not allowed; if you\[aq]d like to change this, see #1632.) @@ -1570,30 +1570,30 @@ Examples: tab(@); lw(17.8n) lw(52.2n). T{ -\f[C]-p \[dq]every mon,wed,fri\[dq]\f[R] +\f[V]-p \[dq]every mon,wed,fri\[dq]\f[R] T}@T{ dates will be Mon, Wed, Fri; periods will be Mon-Tue, Wed-Thu, Fri-Sun T} T{ -\f[C]-p \[dq]every weekday\[dq]\f[R] +\f[V]-p \[dq]every weekday\[dq]\f[R] T}@T{ dates will be Mon, Tue, Wed, Thu, Fri; periods will be Mon, Tue, Wed, Thu, Fri-Sun T} T{ -\f[C]-p \[dq]every weekendday\[dq]\f[R] +\f[V]-p \[dq]every weekendday\[dq]\f[R] T}@T{ dates will be Sat, Sun; periods will be Sat, Sun-Fri T} .TE .SH DEPTH .PP -With the \f[C]--depth NUM\f[R] option (short form: \f[C]-NUM\f[R]), +With the \f[V]--depth NUM\f[R] option (short form: \f[V]-NUM\f[R]), commands like account, balance and register will show only the uppermost accounts in the account tree, down to level NUM. Use this when you want a summary with less detail. -This flag has the same effect as a \f[C]depth:\f[R] query argument: -\f[C]depth:2\f[R], \f[C]--depth=2\f[R] or \f[C]-2\f[R] are equivalent. +This flag has the same effect as a \f[V]depth:\f[R] query argument: +\f[V]depth:2\f[R], \f[V]--depth=2\f[R] or \f[V]-2\f[R] are equivalent. .SH QUERIES .PP One of hledger\[aq]s strengths is being able to quickly report on a @@ -1606,40 +1606,40 @@ Zero or more space-separated query terms. These are most often account name substrings: .RS 2 .PP -\f[C]utilities food:groceries\f[R] +\f[V]utilities food:groceries\f[R] .RE .IP \[bu] 2 Terms with spaces or other special characters should be enclosed in quotes: .RS 2 .PP -\f[C]\[dq]personal care\[dq]\f[R] +\f[V]\[dq]personal care\[dq]\f[R] .RE .IP \[bu] 2 Regular expressions are also supported: .RS 2 .PP -\f[C]\[dq]\[ha]expenses\[rs]b\[dq] \[dq]accounts (payable|receivable)\[dq]\f[R] +\f[V]\[dq]\[ha]expenses\[rs]b\[dq] \[dq]accounts (payable|receivable)\[dq]\f[R] .RE .IP \[bu] 2 Add a query type prefix to match other parts of the data: .RS 2 .PP -\f[C]date:202012- desc:amazon cur:USD amt:\[dq]>100\[dq] status:\f[R] +\f[V]date:202012- desc:amazon cur:USD amt:\[dq]>100\[dq] status:\f[R] .RE .IP \[bu] 2 -Add a \f[C]not:\f[R] prefix to negate a term: +Add a \f[V]not:\f[R] prefix to negate a term: .RS 2 .PP -\f[C]not:cur:USD\f[R] +\f[V]not:cur:USD\f[R] .RE .SS Query types .PP Here are the types of query term available. -Remember these can also be prefixed with \f[B]\f[CB]not:\f[B]\f[R] to +Remember these can also be prefixed with \f[B]\f[VB]not:\f[B]\f[R] to convert them into a negative match. .PP -\f[B]\f[CB]acct:REGEX\f[B], \f[CB]REGEX\f[B]\f[R] +\f[B]\f[VB]acct:REGEX\f[B], \f[VB]REGEX\f[B]\f[R] .PD 0 .P .PD @@ -1647,120 +1647,121 @@ Match account names containing this (case insensitive) regular expression. This is the default query type when there is no prefix, and regular expression syntax is typically not needed, so usually we just write an -account name substring, like \f[C]expenses\f[R] or \f[C]food\f[R]. +account name substring, like \f[V]expenses\f[R] or \f[V]food\f[R]. .PP -\f[B]\f[CB]amt:N, amt:N, amt:>=N\f[B]\f[R] +\f[B]\f[VB]amt:N, amt:N, amt:>=N\f[B]\f[R] .PD 0 .P .PD Match postings with a single-commodity amount equal to, less than, or greater than N. (Postings with multi-commodity amounts are not tested and will always -match.) The comparison has two modes: if N is preceded by a + or - sign -(or is 0), the two signed numbers are compared. +match.) +The comparison has two modes: if N is preceded by a + or - sign (or is +0), the two signed numbers are compared. Otherwise, the absolute magnitudes are compared, ignoring sign. .PP -\f[B]\f[CB]code:REGEX\f[B]\f[R] +\f[B]\f[VB]code:REGEX\f[B]\f[R] .PD 0 .P .PD Match by transaction code (eg check number). .PP -\f[B]\f[CB]cur:REGEX\f[B]\f[R] +\f[B]\f[VB]cur:REGEX\f[B]\f[R] .PD 0 .P .PD Match postings or transactions including any amounts whose currency/commodity symbol is fully matched by REGEX. -(For a partial match, use \f[C].*REGEX.*\f[R]). +(For a partial match, use \f[V].*REGEX.*\f[R]). Note, to match special characters which are regex-significant, you need -to escape them with \f[C]\[rs]\f[R]. +to escape them with \f[V]\[rs]\f[R]. And for characters which are significant to your shell you may need one more level of escaping. So eg to match the dollar sign: .PD 0 .P .PD -\f[C]hledger print cur:\[rs]\[rs]$\f[R]. +\f[V]hledger print cur:\[rs]\[rs]$\f[R]. .PP -\f[B]\f[CB]desc:REGEX\f[B]\f[R] +\f[B]\f[VB]desc:REGEX\f[B]\f[R] .PD 0 .P .PD Match transaction descriptions. .PP -\f[B]\f[CB]date:PERIODEXPR\f[B]\f[R] +\f[B]\f[VB]date:PERIODEXPR\f[B]\f[R] .PD 0 .P .PD -Match dates (or with the \f[C]--date2\f[R] flag, secondary dates) within +Match dates (or with the \f[V]--date2\f[R] flag, secondary dates) within the specified period. PERIODEXPR is a period expression with no report interval. Examples: .PD 0 .P .PD -\f[C]date:2016\f[R], \f[C]date:thismonth\f[R], \f[C]date:2/1-2/15\f[R], -\f[C]date:2021-07-27..nextquarter\f[R]. +\f[V]date:2016\f[R], \f[V]date:thismonth\f[R], \f[V]date:2/1-2/15\f[R], +\f[V]date:2021-07-27..nextquarter\f[R]. .PP -\f[B]\f[CB]date2:PERIODEXPR\f[B]\f[R] +\f[B]\f[VB]date2:PERIODEXPR\f[B]\f[R] .PD 0 .P .PD Match secondary dates within the specified period (independent of the -\f[C]--date2\f[R] flag). +\f[V]--date2\f[R] flag). .PP -\f[B]\f[CB]depth:N\f[B]\f[R] +\f[B]\f[VB]depth:N\f[B]\f[R] .PD 0 .P .PD Match (or display, depending on command) accounts at or above this depth. .PP -\f[B]\f[CB]note:REGEX\f[B]\f[R] +\f[B]\f[VB]note:REGEX\f[B]\f[R] .PD 0 .P .PD Match transaction notes (the part of the description right of -\f[C]|\f[R], or the whole description if there\[aq]s no \f[C]|\f[R]). +\f[V]|\f[R], or the whole description if there\[aq]s no \f[V]|\f[R]). .PP -\f[B]\f[CB]payee:REGEX\f[B]\f[R] +\f[B]\f[VB]payee:REGEX\f[B]\f[R] .PD 0 .P .PD Match transaction payee/payer names (the part of the description left of -\f[C]|\f[R], or the whole description if there\[aq]s no \f[C]|\f[R]). +\f[V]|\f[R], or the whole description if there\[aq]s no \f[V]|\f[R]). .PP -\f[B]\f[CB]real:, real:0\f[B]\f[R] +\f[B]\f[VB]real:, real:0\f[B]\f[R] .PD 0 .P .PD Match real or virtual postings respectively. .PP -\f[B]\f[CB]status:, status:!, status:*\f[B]\f[R] +\f[B]\f[VB]status:, status:!, status:*\f[B]\f[R] .PD 0 .P .PD Match unmarked, pending, or cleared transactions respectively. .PP -\f[B]\f[CB]type:TYPECODES\f[B]\f[R] +\f[B]\f[VB]type:TYPECODES\f[B]\f[R] .PD 0 .P .PD Match by account type (see Declaring accounts > Account types). -\f[C]TYPECODES\f[R] is one or more of the single-letter account type -codes \f[C]ALERXCV\f[R], case insensitive. -Note \f[C]type:A\f[R] and \f[C]type:E\f[R] will also match their -respective subtypes \f[C]C\f[R] (Cash) and \f[C]V\f[R] (Conversion). +\f[V]TYPECODES\f[R] is one or more of the single-letter account type +codes \f[V]ALERXCV\f[R], case insensitive. +Note \f[V]type:A\f[R] and \f[V]type:E\f[R] will also match their +respective subtypes \f[V]C\f[R] (Cash) and \f[V]V\f[R] (Conversion). Certain kinds of account alias can disrupt account types, see Rewriting accounts > Aliases and account types. .PP -\f[B]\f[CB]tag:REGEX[=REGEX]\f[B]\f[R] +\f[B]\f[VB]tag:REGEX[=REGEX]\f[B]\f[R] .PD 0 .P .PD Match by tag name, and optionally also by tag value. -(To match only by value, use \f[C]tag:.=REGEX\f[R].) +(To match only by value, use \f[V]tag:.=REGEX\f[R].) .PP When querying by tag, note that: .IP \[bu] 2 @@ -1770,7 +1771,7 @@ Postings also inherit the tags of their account and their transaction .IP \[bu] 2 Transactions also acquire the tags of their postings. .PP -(\f[B]\f[CB]inacct:ACCTNAME\f[B]\f[R] +(\f[B]\f[VB]inacct:ACCTNAME\f[B]\f[R] .PD 0 .P .PD @@ -1778,7 +1779,8 @@ A special query term used automatically in hledger-web only: tells hledger-web to show the transaction register for an account.) .SS Combining query terms .PP -Most commands select things which match: +When given multiple query terms, most commands select things which +match: .IP \[bu] 2 any of the description terms AND .IP \[bu] 2 @@ -1788,7 +1790,7 @@ any of the status terms AND .IP \[bu] 2 all the other terms. .PP -while the print command shows transactions which: +The print command is a little different, showing transactions which: .IP \[bu] 2 match any of the description terms AND .IP \[bu] 2 @@ -1798,46 +1800,61 @@ have no postings matching any of the negative account terms AND .IP \[bu] 2 match all the other terms. .PP -You can do more powerful queries (such as AND-ing two like terms) by -running a first query with \f[C]print\f[R], and piping the result into a -second hledger command. -Eg: how much of food expenses was paid with cash ? +Although these fixed rules are enough for many needs, we do not support +full boolean expressions (#203), (and you should not write AND or OR in +your queries). +This makes certain queries hard to express, but here are some tricks +that can help: +.IP "1." 3 +Use a doubled \f[V]not:\f[R] prefix. +Eg, to print only the food expenses paid with cash: +.RS 4 .IP .nf \f[C] -$ hledger print assets:cash | hledger -f- -I balance expenses:food +$ hledger print food not:not:cash \f[R] .fi -.PP -If you are interested in full boolean expressions for queries, see #203. +.RE +.IP "2." 3 +Or pre-filter the transactions with \f[V]print\f[R], piping the result +into a second hledger command (with balance assertions disabled): +.RS 4 +.IP +.nf +\f[C] +$ hledger print cash | hledger -f- -I balance food +\f[R] +.fi +.RE .SS Queries and command options .PP Some queries can also be expressed as command-line options: -\f[C]depth:2\f[R] is equivalent to \f[C]--depth 2\f[R], -\f[C]date:2020\f[R] is equivalent to \f[C]-p 2020\f[R], etc. +\f[V]depth:2\f[R] is equivalent to \f[V]--depth 2\f[R], +\f[V]date:2020\f[R] is equivalent to \f[V]-p 2020\f[R], etc. When you mix command options and query arguments, generally the resulting query is their intersection. .SS Queries and account aliases .PP -When account names are rewritten with \f[C]--alias\f[R] or -\f[C]alias\f[R], \f[C]acct:\f[R] will match either the old or the new +When account names are rewritten with \f[V]--alias\f[R] or +\f[V]alias\f[R], \f[V]acct:\f[R] will match either the old or the new account name. .SS Queries and valuation .PP When amounts are converted to other commodities in cost or value -reports, \f[C]cur:\f[R] and \f[C]amt:\f[R] match the old commodity +reports, \f[V]cur:\f[R] and \f[V]amt:\f[R] match the old commodity symbol and the old amount quantity, not the new ones (except in hledger 1.22.0 where it\[aq]s reversed, see #1625). .SS Querying with account aliases .PP -When account names are rewritten with \f[C]--alias\f[R] or -\f[C]alias\f[R], note that \f[C]acct:\f[R] will match either the old or +When account names are rewritten with \f[V]--alias\f[R] or +\f[V]alias\f[R], note that \f[V]acct:\f[R] will match either the old or the new account name. .SS Querying with cost or value .PP When amounts are converted to other commodities in cost or value -reports, note that \f[C]cur:\f[R] matches the new commodity symbol, and -not the old one, and \f[C]amt:\f[R] matches the new quantity, and not +reports, note that \f[V]cur:\f[R] matches the new commodity symbol, and +not the old one, and \f[V]amt:\f[R] matches the new quantity, and not the old one. Note: this changed in hledger 1.22, previously it was the reverse, see the discussion at #1625. @@ -1870,11 +1887,11 @@ hledger\[aq]s cost notation. .PP As discussed a little further on in Transaction prices, when recording a transaction you can also record the amount\[aq]s cost in another -commodity, by adding \f[C]\[at] UNITPRICE\f[R] or -\f[C]\[at]\[at] TOTALPRICE\f[R]. +commodity, by adding \f[V]\[at] UNITPRICE\f[R] or +\f[V]\[at]\[at] TOTALPRICE\f[R]. .PP Then you can see a report with amounts converted to cost, by adding the -\f[C]-B/--cost\f[R] flag. +\f[V]-B/--cost\f[R] flag. (Mnemonic: \[dq]B\[dq] from \[dq]cost Basis\[dq], as in Ledger). Eg: .IP @@ -1949,7 +1966,7 @@ Happily, current hledger can read either notation, or convert one to the other when needed, so you can use the one you prefer. .SS Inferring equity postings from cost .PP -With \f[C]--infer-equity\f[R], hledger detects transactions written with +With \f[V]--infer-equity\f[R], hledger detects transactions written with PTA cost notation and adds equity conversion postings to them (and temporarily permits the coexistence of equity conversion postings and cost notation, which normally would cause an unbalanced transaction @@ -1986,7 +2003,7 @@ for sharing with non-PTA-users. \f[I]Experimental\f[R] .SS Inferring cost from equity postings .PP -The reverse operation is possible using \f[C]--infer-costs\f[R], which +The reverse operation is possible using \f[V]--infer-costs\f[R], which detects transactions written with equity conversion postings and adds PTA cost notation to them (and temporarily permits the coexistence of equity conversion postings and cost notation). @@ -2029,10 +2046,10 @@ $ hledger print --infer-costs -B Notes: .PP Postings will be recognised as equity conversion postings if they are 1. -to account(s) declared with type \f[C]V\f[R] (\f[C]Conversion\f[R]; or +to account(s) declared with type \f[V]V\f[R] (\f[V]Conversion\f[R]; or if no such accounts are declared, accounts named -\f[C]equity:conversion\f[R], \f[C]equity:trade\f[R], -\f[C]equity:trading\f[R], or subaccounts of these) 2. +\f[V]equity:conversion\f[R], \f[V]equity:trade\f[R], +\f[V]equity:trading\f[R], or subaccounts of these) 2. adjacent 3. and exactly matching the amounts of two non-conversion postings. .PP @@ -2080,10 +2097,10 @@ We\[aq]re not sure yet if that should change. Here are two suggestions to try, experience reports welcome: .IP "1." 3 When you use -B, always use --infer-costs as well. -Eg: \f[C]hledger bal -B --infer-costs\f[R] +Eg: \f[V]hledger bal -B --infer-costs\f[R] .IP "2." 3 Always run hledger with both flags enabled. -Eg: \f[C]alias hl=\[dq]hledger --infer-equity --infer-costs\[dq]\f[R] +Eg: \f[V]alias hl=\[dq]hledger --infer-equity --infer-costs\[dq]\f[R] .SS How to record conversions .PP Essentially there are four ways to record a conversion transaction in @@ -2105,7 +2122,7 @@ appropriate asset account: .PP hledger will assume this transaction is balanced, inferring that the conversion rate must be 1 EUR = 1.20 USD. -You can see the inferred rate by using \f[C]hledger print -x\f[R]. +You can see the inferred rate by using \f[V]hledger print -x\f[R]. .PP Pro: .IP \[bu] 2 @@ -2121,11 +2138,11 @@ Conversion rate is not clear Disturbs the accounting equation, unless you add the --infer-equity flag .PP You can prevent accidental implicit conversions due to a mistyped -commodity symbol, by using \f[C]hledger check commodities\f[R]. +commodity symbol, by using \f[V]hledger check commodities\f[R]. .PP You can prevent implicit conversions entirely, by using -\f[C]hledger check balancednoautoconversion\f[R], or -\f[C]-s/--strict\f[R]. +\f[V]hledger check balancednoautoconversion\f[R], or +\f[V]-s/--strict\f[R]. .SS Conversion with explicit cost .PP You can add the conversion rate using \[at] notation: @@ -2158,7 +2175,7 @@ In strict double entry bookkeeping, the above transaction is not balanced in EUR or in USD, since some EUR disappears, and some USD appears. This violates the accounting equation (A+L+E=0), and prevents reports -like \f[C]balancesheetequity\f[R] from showing a zero total. +like \f[V]balancesheetequity\f[R] from showing a zero total. .PP The proper way to make it balance is to add a balancing posting for each commodity, using an equity account: @@ -2233,12 +2250,12 @@ Combining these is possible by using the --infer-costs flag (which requires well-ordered postings). .IP \[bu] 2 When you want to see the cost (or sale proceeds) of things, use -\f[C]-B\f[R] (or \f[C]--cost\f[R]). +\f[V]-B\f[R] (or \f[V]--cost\f[R]). If you use equity conversion postings notation, use -\f[C]-B --infer-costs\f[R]. +\f[V]-B --infer-costs\f[R]. .IP \[bu] 2 If you use PTA cost notation, and you want to see a balanced balance -sheet or print correct journal entries, use \f[C]--infer-equity\f[R]. +sheet or print correct journal entries, use \f[V]--infer-equity\f[R]. .IP \[bu] 2 Conversion to cost is performed before valuation (described next). .SH VALUATION @@ -2247,19 +2264,19 @@ Instead of reporting amounts in their original commodity, hledger can convert them to cost/sale amount (using the conversion rate recorded in the transaction), and/or to market value (using some market price on a certain date). -This is controlled by the \f[C]--value=TYPE[,COMMODITY]\f[R] option, +This is controlled by the \f[V]--value=TYPE[,COMMODITY]\f[R] option, which will be described below. -We also provide the simpler \f[C]-V\f[R] and \f[C]-X COMMODITY\f[R] +We also provide the simpler \f[V]-V\f[R] and \f[V]-X COMMODITY\f[R] options, and often one of these is all you need: .SS -V: Value .PP -The \f[C]-V/--market\f[R] flag converts amounts to market value in their +The \f[V]-V/--market\f[R] flag converts amounts to market value in their default \f[I]valuation commodity\f[R], using the market prices in effect on the \f[I]valuation date(s)\f[R], if any. More on these in a minute. .SS -X: Value in specified commodity .PP -The \f[C]-X/--exchange=COMM\f[R] option is like \f[C]-V\f[R], except you +The \f[V]-X/--exchange=COMM\f[R] option is like \f[V]-V\f[R], except you tell it which currency you want to convert to, and it tries to convert everything to that. .SS Valuation date @@ -2282,7 +2299,7 @@ this order of preference : .IP "1." 3 A \f[I]declared market price\f[R] or \f[I]inferred market price\f[R]: A\[aq]s latest market price in B on or before the valuation date as -declared by a P directive, or (with the \f[C]--infer-market-prices\f[R] +declared by a P directive, or (with the \f[V]--infer-market-prices\f[R] flag) inferred from transaction prices. .IP "2." 3 A \f[I]reverse market price\f[R]: the inverse of a declared or inferred @@ -2299,7 +2316,7 @@ A to B. There is a limit to the length of these price chains; if hledger reaches that length without finding a complete chain or exhausting all possibilities, it will give up (with a \[dq]gave up\[dq] message visible -in \f[C]--debug=2\f[R] output). +in \f[V]--debug=2\f[R] output). That limit is currently 1000. .PP Amounts for which no suitable market price can be found, are not @@ -2313,55 +2330,55 @@ usually take place at close to market value, why not use the recorded transaction prices as additional market prices (as Ledger does) ? We could produce value reports without needing P directives at all. .PP -Adding the \f[C]--infer-market-prices\f[R] flag to \f[C]-V\f[R], -\f[C]-X\f[R] or \f[C]--value\f[R] enables this. -So for example, \f[C]hledger bs -V --infer-market-prices\f[R] will get +Adding the \f[V]--infer-market-prices\f[R] flag to \f[V]-V\f[R], +\f[V]-X\f[R] or \f[V]--value\f[R] enables this. +So for example, \f[V]hledger bs -V --infer-market-prices\f[R] will get market prices both from P directives and from transactions. (And if both occur on the same day, the P directive takes precedence). .PP There is a downside: value reports can sometimes be affected in confusing/undesired ways by your journal entries. If this happens to you, read all of this Valuation section carefully, -and try adding \f[C]--debug\f[R] or \f[C]--debug=2\f[R] to troubleshoot. +and try adding \f[V]--debug\f[R] or \f[V]--debug=2\f[R] to troubleshoot. .PP -\f[C]--infer-market-prices\f[R] can infer market prices from: +\f[V]--infer-market-prices\f[R] can infer market prices from: .IP \[bu] 2 multicommodity transactions with explicit prices -(\f[C]\[at]\f[R]/\f[C]\[at]\[at]\f[R]) +(\f[V]\[at]\f[R]/\f[V]\[at]\[at]\f[R]) .IP \[bu] 2 -multicommodity transactions with implicit prices (no \f[C]\[at]\f[R], +multicommodity transactions with implicit prices (no \f[V]\[at]\f[R], two commodities, unbalanced). (With these, the order of postings matters. -\f[C]hledger print -x\f[R] can be useful for troubleshooting.) +\f[V]hledger print -x\f[R] can be useful for troubleshooting.) .IP \[bu] 2 but not, currently, from \[dq]more correct\[dq] multicommodity -transactions (no \f[C]\[at]\f[R], multiple commodities, balanced). +transactions (no \f[V]\[at]\f[R], multiple commodities, balanced). .PP There is another limitation (bug) currently: when a valuation commodity -is not specified, prices inferred with \f[C]--infer-market-prices\f[R] -do not help select a default valuation commodity, as \f[C]P\f[R] prices +is not specified, prices inferred with \f[V]--infer-market-prices\f[R] +do not help select a default valuation commodity, as \f[V]P\f[R] prices would. So conversion might not happen because no valuation commodity was -detected (\f[C]--debug=2\f[R] will show this). +detected (\f[V]--debug=2\f[R] will show this). To be safe, specify the valuation commmodity, eg: .IP \[bu] 2 -\f[C]-X EUR --infer-market-prices\f[R], not -\f[C]-V --infer-market-prices\f[R] +\f[V]-X EUR --infer-market-prices\f[R], not +\f[V]-V --infer-market-prices\f[R] .IP \[bu] 2 -\f[C]--value=then,EUR --infer-market-prices\f[R], not -\f[C]--value=then --infer-market-prices\f[R] +\f[V]--value=then,EUR --infer-market-prices\f[R], not +\f[V]--value=then --infer-market-prices\f[R] .SS Valuation commodity .PP -\f[B]When you specify a valuation commodity (\f[CB]-X COMM\f[B] or -\f[CB]--value TYPE,COMM\f[B]):\f[R] +\f[B]When you specify a valuation commodity (\f[VB]-X COMM\f[B] or +\f[VB]--value TYPE,COMM\f[B]):\f[R] .PD 0 .P .PD hledger will convert all amounts to COMM, wherever it can find a suitable market price (including by reversing or chaining prices). .PP -\f[B]When you leave the valuation commodity unspecified (\f[CB]-V\f[B] -or \f[CB]--value TYPE\f[B]):\f[R] +\f[B]When you leave the valuation commodity unspecified (\f[VB]-V\f[B] +or \f[VB]--value TYPE\f[B]):\f[R] .PD 0 .P .PD @@ -2377,21 +2394,21 @@ date. valuation date.) .IP "3." 3 If there are no P directives at all (any commodity or date) and the -\f[C]--infer-market-prices\f[R] flag is used: the price commodity from +\f[V]--infer-market-prices\f[R] flag is used: the price commodity from the latest transaction-inferred price for A on or before valuation date. .PP This means: .IP \[bu] 2 -If you have P directives, they determine which commodities \f[C]-V\f[R] +If you have P directives, they determine which commodities \f[V]-V\f[R] will convert, and to what. .IP \[bu] 2 -If you have no P directives, and use the \f[C]--infer-market-prices\f[R] +If you have no P directives, and use the \f[V]--infer-market-prices\f[R] flag, transaction prices determine it. .PP Amounts for which no valuation commodity can be found are not converted. .SS Simple valuation examples .PP -Here are some quick examples of \f[C]-V\f[R]: +Here are some quick examples of \f[V]-V\f[R]: .IP .nf \f[C] @@ -2437,8 +2454,8 @@ $ hledger -f t.j bal -N euros -V .fi .SS --value: Flexible valuation .PP -\f[C]-V\f[R] and \f[C]-X\f[R] are special cases of the more general -\f[C]--value\f[R] option: +\f[V]-V\f[R] and \f[V]-X\f[R] are special cases of the more general +\f[V]--value\f[R] option: .IP .nf \f[C] @@ -2454,33 +2471,33 @@ $ hledger -f t.j bal -N euros -V .PP The TYPE part selects cost or value and valuation date: .TP -\f[B]\f[CB]--value=then\f[B]\f[R] +\f[V]--value=then\f[R] Convert amounts to their value in the default valuation commodity, using market prices on each posting\[aq]s date. .TP -\f[B]\f[CB]--value=end\f[B]\f[R] +\f[V]--value=end\f[R] Convert amounts to their value in the default valuation commodity, using market prices on the last day of the report period (or if unspecified, the journal\[aq]s end date); or in multiperiod reports, market prices on the last day of each subperiod. .TP -\f[B]\f[CB]--value=now\f[B]\f[R] +\f[V]--value=now\f[R] Convert amounts to their value in the default valuation commodity using current market prices (as of when report is generated). .TP -\f[B]\f[CB]--value=YYYY-MM-DD\f[B]\f[R] +\f[V]--value=YYYY-MM-DD\f[R] Convert amounts to their value in the default valuation commodity using market prices on this date. .PP To select a different valuation commodity, add the optional -\f[C],COMM\f[R] part: a comma, then the target commodity\[aq]s symbol. -Eg: \f[B]\f[CB]--value=now,EUR\f[B]\f[R]. +\f[V],COMM\f[R] part: a comma, then the target commodity\[aq]s symbol. +Eg: \f[B]\f[VB]--value=now,EUR\f[B]\f[R]. hledger will do its best to convert amounts to this commodity, deducing market prices as described above. .SS More valuation examples .PP -Here are some examples showing the effect of \f[C]--value\f[R], as seen -with \f[C]print\f[R]: +Here are some examples showing the effect of \f[V]--value\f[R], as seen +with \f[V]print\f[R]: .IP .nf \f[C] @@ -2635,7 +2652,7 @@ the following happens. The query is separated into two parts: .RS 4 .IP "1." 3 -the currency (\f[C]cur:\f[R]) or amount (\f[C]amt:\f[R]). +the currency (\f[V]cur:\f[R]) or amount (\f[V]amt:\f[R]). .IP "2." 3 all other parts. .RE @@ -2653,8 +2670,8 @@ See: 1625 .PP Here is a reference for how valuation is supposed to affect each part of hledger\[aq]s reports (and a glossary). -(It\[aq]s wide, you\[aq]ll have to scroll sideways.) It may be useful -when troubleshooting. +(It\[aq]s wide, you\[aq]ll have to scroll sideways.) +It may be useful when troubleshooting. If you find problems, please report them, ideally with a reproducible example. Related: #329, #1083. @@ -2665,15 +2682,15 @@ lw(9.5n) lw(11.8n) lw(12.0n) lw(17.2n) lw(12.0n) lw(7.4n). T{ Report type T}@T{ -\f[C]-B\f[R], \f[C]--cost\f[R] +\f[V]-B\f[R], \f[V]--cost\f[R] T}@T{ -\f[C]-V\f[R], \f[C]-X\f[R] +\f[V]-V\f[R], \f[V]-X\f[R] T}@T{ -\f[C]--value=then\f[R] +\f[V]--value=then\f[R] T}@T{ -\f[C]--value=end\f[R] +\f[V]--value=end\f[R] T}@T{ -\f[C]--value=DATE\f[R], \f[C]--value=now\f[R] +\f[V]--value=DATE\f[R], \f[V]--value=now\f[R] T} _ T{ @@ -2961,8 +2978,8 @@ T}@T{ T} .TE .PP -\f[C]--cumulative\f[R] is omitted to save space, it works like -\f[C]-H\f[R] but with a zero starting balance. +\f[V]--cumulative\f[R] is omitted to save space, it works like +\f[V]-H\f[R] but with a zero starting balance. .PP \f[B]Glossary:\f[R] .TP @@ -2996,15 +3013,15 @@ report\[aq]s multi-period mode (whether showing one or many subperiods). .PP Normally hledger sums amounts, and organizes them in a hierarchy, based on account name. -The \f[C]--pivot FIELD\f[R] option causes it to sum and organize +The \f[V]--pivot FIELD\f[R] option causes it to sum and organize hierarchy based on the value of some other field instead. -FIELD can be: \f[C]status\f[R], \f[C]code\f[R], \f[C]description\f[R], -\f[C]payee\f[R], \f[C]note\f[R], or the full name (case insensitive) of +FIELD can be: \f[V]status\f[R], \f[V]code\f[R], \f[V]description\f[R], +\f[V]payee\f[R], \f[V]note\f[R], or the full name (case insensitive) of any tag. -As with account names, values containing \f[C]colon:separated:parts\f[R] +As with account names, values containing \f[V]colon:separated:parts\f[R] will be displayed hierarchically in reports. .PP -\f[C]--pivot\f[R] is a general option affecting all reports; you can +\f[V]--pivot\f[R] is a general option affecting all reports; you can think of hledger transforming the journal before any other processing, replacing every posting\[aq]s account name with the value of the specified field on that posting, inheriting it from the transaction or @@ -3071,11 +3088,11 @@ $ hledger balance --pivot member acct:. .PP hledger provides a number of commands for producing reports and managing your data. -Run \f[C]hledger\f[R] with no arguments to list the commands available, -and \f[C]hledger CMD\f[R] to run a command. +Run \f[V]hledger\f[R] with no arguments to list the commands available, +and \f[V]hledger CMD\f[R] to run a command. CMD can be the full command name, or its standard abbreviation shown in the commands list, or any unambiguous prefix of the name. -Eg: \f[C]hledger bal\f[R]. +Eg: \f[V]hledger bal\f[R]. .PP Here are the built-in commands, with the most often-used in bold: .PP @@ -3155,8 +3172,8 @@ test - run self tests .PP \f[B]Add-on commands:\f[R] .PP -Programs or scripts named \f[C]hledger-SOMETHING\f[R] in your PATH are -add-on commands; these appear in the commands list with a \f[C]+\f[R] +Programs or scripts named \f[V]hledger-SOMETHING\f[R] in your PATH are +add-on commands; these appear in the commands list with a \f[V]+\f[R] mark. The following add-on commands can be installed, eg by the hledger-install script: @@ -3165,7 +3182,7 @@ hledger-install script: .IP \[bu] 2 \f[B]web\f[R] - hledger\[aq]s official web UI .IP \[bu] 2 -iadd - a popular alternative to hledger\[aq]s \f[C]add\f[R] command. +iadd - a popular alternative to hledger\[aq]s \f[V]add\f[R] command. .IP \[bu] 2 interest - generates interest transactions .IP \[bu] 2 @@ -3188,37 +3205,37 @@ declared with account directives. With query arguments, only matched account names and account names referenced by matched postings are shown. .PP -Or it can show just the used accounts (\f[C]--used\f[R]/\f[C]-u\f[R]), -the declared accounts (\f[C]--declared\f[R]/\f[C]-d\f[R]), the accounts -declared but not used (\f[C]--unused\f[R]), the accounts used but not -declared (\f[C]--undeclared\f[R]), or the first account matched by an -account name pattern, if any (\f[C]--find\f[R]). +Or it can show just the used accounts (\f[V]--used\f[R]/\f[V]-u\f[R]), +the declared accounts (\f[V]--declared\f[R]/\f[V]-d\f[R]), the accounts +declared but not used (\f[V]--unused\f[R]), the accounts used but not +declared (\f[V]--undeclared\f[R]), or the first account matched by an +account name pattern, if any (\f[V]--find\f[R]). .PP It shows a flat list by default. -With \f[C]--tree\f[R], it uses indentation to show the account +With \f[V]--tree\f[R], it uses indentation to show the account hierarchy. -In flat mode you can add \f[C]--drop N\f[R] to omit the first few +In flat mode you can add \f[V]--drop N\f[R] to omit the first few account name components. -Account names can be depth-clipped with \f[C]depth:N\f[R] or -\f[C]--depth N\f[R] or \f[C]-N\f[R]. +Account names can be depth-clipped with \f[V]depth:N\f[R] or +\f[V]--depth N\f[R] or \f[V]-N\f[R]. .PP -With \f[C]--types\f[R], it also shows each account\[aq]s type, if +With \f[V]--types\f[R], it also shows each account\[aq]s type, if it\[aq]s known. (See Declaring accounts > Account types.) .PP -With \f[C]--positions\f[R], it also shows the file and line number of +With \f[V]--positions\f[R], it also shows the file and line number of each account\[aq]s declaration, if any, and the account\[aq]s overall declaration order; these may be useful when troubleshooting account display order. .PP -With \f[C]--directives\f[R], it adds the \f[C]account\f[R] keyword, +With \f[V]--directives\f[R], it adds the \f[V]account\f[R] keyword, showing valid account directives which can be pasted into a journal file. -This is useful together with \f[C]--undeclared\f[R] when updating your -account declarations to satisfy \f[C]hledger check accounts\f[R]. +This is useful together with \f[V]--undeclared\f[R] when updating your +account declarations to satisfy \f[V]hledger check accounts\f[R]. .PP -The \f[C]--find\f[R] flag can be used to look up a single account name, -in the same way that the \f[C]aregister\f[R] command does. +The \f[V]--find\f[R] flag can be used to look up a single account name, +in the same way that the \f[V]aregister\f[R] command does. It returns the alphanumerically-first matched account name, or if none can be found, it fails with a non-zero exit code. .PP @@ -3279,17 +3296,17 @@ Any arguments will be used as default inputs for the first N prompts. .PP Many hledger users edit their journals directly with a text editor, or generate them from CSV. -For more interactive data entry, there is the \f[C]add\f[R] command, +For more interactive data entry, there is the \f[V]add\f[R] command, which prompts interactively on the console for new transactions, and appends them to the main journal file (which should be in journal format). Existing transactions are not changed. This is one of the few hledger commands that writes to the journal file -(see also \f[C]import\f[R]). +(see also \f[V]import\f[R]). .PP -To use it, just run \f[C]hledger add\f[R] and follow the prompts. +To use it, just run \f[V]hledger add\f[R] and follow the prompts. You can add as many transactions as you like; when you are finished, -enter \f[C].\f[R] or press control-d or control-c to exit. +enter \f[V].\f[R] or press control-d or control-c to exit. .PP Features: .IP \[bu] 2 @@ -3302,8 +3319,8 @@ You can also set the initial defaults with command line arguments. Readline-style edit keys can be used during data entry. .IP \[bu] 2 The tab key will auto-complete whenever possible - accounts, -descriptions, dates (\f[C]yesterday\f[R], \f[C]today\f[R], -\f[C]tomorrow\f[R]). +descriptions, dates (\f[V]yesterday\f[R], \f[V]today\f[R], +\f[V]tomorrow\f[R]). If the input area is empty, it will insert the default value. .IP \[bu] 2 If the journal defines a default commodity, it will be added to any bare @@ -3313,7 +3330,7 @@ A parenthesised transaction code may be entered following a date. .IP \[bu] 2 Comments and tags may be entered following a description or amount. .IP \[bu] 2 -If you make a mistake, enter \f[C]<\f[R] at any prompt to go one step +If you make a mistake, enter \f[V]<\f[R] at any prompt to go one step backward. .IP \[bu] 2 Input prompts are displayed in a different colour when the terminal @@ -3362,29 +3379,29 @@ aregister, areg Show the transactions and running historical balance of a single account, with each transaction displayed as one line. .PP -\f[C]aregister\f[R] shows the overall transactions affecting a +\f[V]aregister\f[R] shows the overall transactions affecting a particular account (and any subaccounts). Each report line represents one transaction in this account. Transactions before the report start date are always included in the -running balance (\f[C]--historical\f[R] mode is always on). +running balance (\f[V]--historical\f[R] mode is always on). .PP This is a more \[dq]real world\[dq], bank-like view than the -\f[C]register\f[R] command (which shows individual postings, possibly +\f[V]register\f[R] command (which shows individual postings, possibly from multiple accounts, not necessarily in historical mode). -As a quick rule of thumb: - use \f[C]aregister\f[R] for reviewing and -reconciling real-world asset/liability accounts - use \f[C]register\f[R] +As a quick rule of thumb: - use \f[V]aregister\f[R] for reviewing and +reconciling real-world asset/liability accounts - use \f[V]register\f[R] for reviewing detailed revenues/expenses. .PP -\f[C]aregister\f[R] requires one argument: the account to report on. +\f[V]aregister\f[R] requires one argument: the account to report on. You can write either the full account name, or a case-insensitive regular expression which will select the alphabetically first matched account. -(Eg if you have \f[C]assets:aaa:checking\f[R] and -\f[C]assets:bbb:checking\f[R] accounts, \f[C]hledger areg checking\f[R] -would select \f[C]assets:aaa:checking\f[R].) +(Eg if you have \f[V]assets:aaa:checking\f[R] and +\f[V]assets:bbb:checking\f[R] accounts, \f[V]hledger areg checking\f[R] +would select \f[V]assets:aaa:checking\f[R].) .PP Transactions involving subaccounts of this account will also be shown. -\f[C]aregister\f[R] ignores depth limits, so its final total will always +\f[V]aregister\f[R] ignores depth limits, so its final total will always match a balance report with similar arguments. .PP Any additional arguments form a query which will filter the transactions @@ -3402,7 +3419,7 @@ $ hledger areg checking date:jul \f[R] .fi .PP -Each \f[C]aregister\f[R] line item shows: +Each \f[V]aregister\f[R] line item shows: .IP \[bu] 2 the transaction\[aq]s date (or the relevant posting\[aq]s date if different, see below) @@ -3415,29 +3432,29 @@ the total change to this account\[aq]s balance from this transaction the account\[aq]s historical running balance after this transaction. .PP Transactions making a net change of zero are not shown by default; add -the \f[C]-E/--empty\f[R] flag to show them. +the \f[V]-E/--empty\f[R] flag to show them. .PP For performance reasons, column widths are chosen based on the first 1000 lines; this means unusually wide values in later lines can cause visual discontinuities as column widths are adjusted. If you want to ensure perfect alignment, at the cost of more time and -memory, use the \f[C]--align-all\f[R] flag. +memory, use the \f[V]--align-all\f[R] flag. .PP This command also supports the output destination and output format options. -The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R], and -\f[C]json\f[R]. +The output formats supported are \f[V]txt\f[R], \f[V]csv\f[R], and +\f[V]json\f[R]. .SS aregister and custom posting dates .PP Transactions whose date is outside the report period can still be shown, if they have a posting to this account dated inside the report period. -(And in this case it\[aq]s the posting date that is shown.) This ensures -that \f[C]aregister\f[R] can show an accurate historical running -balance, matching the one shown by \f[C]register -H\f[R] with the same -arguments. +(And in this case it\[aq]s the posting date that is shown.) +This ensures that \f[V]aregister\f[R] can show an accurate historical +running balance, matching the one shown by \f[V]register -H\f[R] with +the same arguments. .PP To filter strictly by transaction date instead, add the -\f[C]--txn-dates\f[R] flag. +\f[V]--txn-dates\f[R] flag. If you use this flag and some of your postings have custom dates, it\[aq]s probably best to assume the running balance is wrong. .SS balance @@ -3448,28 +3465,28 @@ balance, bal .PD Show accounts and their balances. .PP -\f[C]balance\f[R] is one of hledger\[aq]s oldest and most versatile +\f[V]balance\f[R] is one of hledger\[aq]s oldest and most versatile commands, for listing account balances, balance changes, values, value changes and more, during one time period or many. Generally it shows a table, with rows representing accounts, and columns representing periods. .PP -Note there are some higher-level variants of the \f[C]balance\f[R] +Note there are some higher-level variants of the \f[V]balance\f[R] command with convenient defaults, which can be simpler to use: -\f[C]balancesheet\f[R], \f[C]balancesheetequity\f[R], \f[C]cashflow\f[R] -and \f[C]incomestatement\f[R]. -When you need more control, then use \f[C]balance\f[R]. +\f[V]balancesheet\f[R], \f[V]balancesheetequity\f[R], \f[V]cashflow\f[R] +and \f[V]incomestatement\f[R]. +When you need more control, then use \f[V]balance\f[R]. .SS balance features .PP -Here\[aq]s a quick overview of the \f[C]balance\f[R] command\[aq]s +Here\[aq]s a quick overview of the \f[V]balance\f[R] command\[aq]s features, followed by more detailed descriptions and examples. Many of these work with the higher-level commands as well. .PP -\f[C]balance\f[R] can show.. +\f[V]balance\f[R] can show.. .IP \[bu] 2 -accounts as a list (\f[C]-l\f[R]) or a tree (\f[C]-t\f[R]) +accounts as a list (\f[V]-l\f[R]) or a tree (\f[V]-t\f[R]) .IP \[bu] 2 -optionally depth-limited (\f[C]-[1-9]\f[R]) +optionally depth-limited (\f[V]-[1-9]\f[R]) .IP \[bu] 2 sorted by declaration order and name, or by amount .PP @@ -3477,68 +3494,68 @@ sorted by declaration order and name, or by amount .IP \[bu] 2 balance changes (the default) .IP \[bu] 2 -or actual and planned balance changes (\f[C]--budget\f[R]) +or actual and planned balance changes (\f[V]--budget\f[R]) .IP \[bu] 2 -or value of balance changes (\f[C]-V\f[R]) +or value of balance changes (\f[V]-V\f[R]) .IP \[bu] 2 -or change of balance values (\f[C]--valuechange\f[R]) +or change of balance values (\f[V]--valuechange\f[R]) .IP \[bu] 2 -or unrealised capital gain/loss (\f[C]--gain\f[R]) +or unrealised capital gain/loss (\f[V]--gain\f[R]) .PP \&..in.. .IP \[bu] 2 one time period (the whole journal period by default) .IP \[bu] 2 -or multiple periods (\f[C]-D\f[R], \f[C]-W\f[R], \f[C]-M\f[R], -\f[C]-Q\f[R], \f[C]-Y\f[R], \f[C]-p INTERVAL\f[R]) +or multiple periods (\f[V]-D\f[R], \f[V]-W\f[R], \f[V]-M\f[R], +\f[V]-Q\f[R], \f[V]-Y\f[R], \f[V]-p INTERVAL\f[R]) .PP \&..either.. .IP \[bu] 2 per period (the default) .IP \[bu] 2 -or accumulated since report start date (\f[C]--cumulative\f[R]) +or accumulated since report start date (\f[V]--cumulative\f[R]) .IP \[bu] 2 -or accumulated since account creation (\f[C]--historical/-H\f[R]) +or accumulated since account creation (\f[V]--historical/-H\f[R]) .PP \&..possibly converted to.. .IP \[bu] 2 -cost (\f[C]--value=cost[,COMM]\f[R]/\f[C]--cost\f[R]/\f[C]-B\f[R]) +cost (\f[V]--value=cost[,COMM]\f[R]/\f[V]--cost\f[R]/\f[V]-B\f[R]) .IP \[bu] 2 -or market value, as of transaction dates (\f[C]--value=then[,COMM]\f[R]) +or market value, as of transaction dates (\f[V]--value=then[,COMM]\f[R]) .IP \[bu] 2 -or at period ends (\f[C]--value=end[,COMM]\f[R]) +or at period ends (\f[V]--value=end[,COMM]\f[R]) .IP \[bu] 2 -or now (\f[C]--value=now\f[R]) +or now (\f[V]--value=now\f[R]) .IP \[bu] 2 -or at some other date (\f[C]--value=YYYY-MM-DD\f[R]) +or at some other date (\f[V]--value=YYYY-MM-DD\f[R]) .PP \&..with.. .IP \[bu] 2 -totals (\f[C]-T\f[R]), averages (\f[C]-A\f[R]), percentages -(\f[C]-%\f[R]), inverted sign (\f[C]--invert\f[R]) +totals (\f[V]-T\f[R]), averages (\f[V]-A\f[R]), percentages +(\f[V]-%\f[R]), inverted sign (\f[V]--invert\f[R]) .IP \[bu] 2 -rows and columns swapped (\f[C]--transpose\f[R]) +rows and columns swapped (\f[V]--transpose\f[R]) .IP \[bu] 2 -another field used as account name (\f[C]--pivot\f[R]) +another field used as account name (\f[V]--pivot\f[R]) .IP \[bu] 2 custom-formatted line items (single-period reports only) -(\f[C]--format\f[R]) +(\f[V]--format\f[R]) .IP \[bu] 2 commodities displayed on the same line or multiple lines -(\f[C]--layout\f[R]) +(\f[V]--layout\f[R]) .PP This command supports the output destination and output format options, -with output formats \f[C]txt\f[R], \f[C]csv\f[R], \f[C]json\f[R], and -(multi-period reports only:) \f[C]html\f[R]. -In \f[C]txt\f[R] output in a colour-supporting terminal, negative +with output formats \f[V]txt\f[R], \f[V]csv\f[R], \f[V]json\f[R], and +(multi-period reports only:) \f[V]html\f[R]. +In \f[V]txt\f[R] output in a colour-supporting terminal, negative amounts are shown in red. .PP -The \f[C]--related\f[R]/\f[C]-r\f[R] flag shows the balance of the +The \f[V]--related\f[R]/\f[V]-r\f[R] flag shows the balance of the \f[I]other\f[R] postings in the transactions of the postings which would normally be shown. .SS Simple balance report .PP -With no arguments, \f[C]balance\f[R] shows a list of all accounts and +With no arguments, \f[V]balance\f[R] shows a list of all accounts and their change of balance - ie, the sum of posting amounts, both inflows and outflows - during the entire period of the journal. For real-world accounts, this should also match their end balance at the @@ -3565,8 +3582,8 @@ $ hledger -f examples/sample.journal bal .PP Accounts with a zero balance (and no non-zero subaccounts, in tree mode - see below) are hidden by default. -Use \f[C]-E/--empty\f[R] to show them (revealing -\f[C]assets:bank:checking\f[R] here): +Use \f[V]-E/--empty\f[R] to show them (revealing +\f[V]assets:bank:checking\f[R] here): .IP .nf \f[C] @@ -3585,7 +3602,7 @@ $ hledger -f examples/sample.journal bal -E .fi .PP The total of the amounts displayed is shown as the last line, unless -\f[C]-N\f[R]/\f[C]--no-total\f[R] is used. +\f[V]-N\f[R]/\f[V]--no-total\f[R] is used. .SS Filtered balance report .PP You can show fewer accounts, a different time period, totals from @@ -3603,10 +3620,10 @@ $ hledger -f examples/sample.journal bal --cleared assets date:200806 .fi .SS List or tree mode .PP -By default, or with \f[C]-l/--flat\f[R], accounts are shown as a flat +By default, or with \f[V]-l/--flat\f[R], accounts are shown as a flat list with their full names visible, as in the examples above. .PP -With \f[C]-t/--tree\f[R], the account hierarchy is shown, with +With \f[V]-t/--tree\f[R], the account hierarchy is shown, with subaccounts\[aq] \[dq]leaf\[dq] names indented below their parent: .IP .nf @@ -3630,9 +3647,9 @@ $ hledger -f examples/sample.journal balance Notes: .IP \[bu] 2 \[dq]Boring\[dq] accounts are combined with their subaccount for more -compact output, unless \f[C]--no-elide\f[R] is used. +compact output, unless \f[V]--no-elide\f[R] is used. Boring accounts have no balance of their own and just one subaccount (eg -\f[C]assets:bank\f[R] and \f[C]liabilities\f[R] above). +\f[V]assets:bank\f[R] and \f[V]liabilities\f[R] above). .IP \[bu] 2 All balances shown are \[dq]inclusive\[dq], ie including the balances from all subaccounts. @@ -3645,8 +3662,8 @@ Each group of sibling accounts (ie, under a common parent) is sorted separately. .SS Depth limiting .PP -With a \f[C]depth:NUM\f[R] query, or \f[C]--depth NUM\f[R] option, or -just \f[C]-NUM\f[R] (eg: \f[C]-3\f[R]) balance reports will show +With a \f[V]depth:NUM\f[R] query, or \f[V]--depth NUM\f[R] option, or +just \f[V]-NUM\f[R] (eg: \f[V]-3\f[R]) balance reports will show accounts only to the specified depth, hiding the deeper subaccounts. This can be useful for getting an overview without too much detail. .PP @@ -3668,7 +3685,7 @@ $ hledger -f examples/sample.journal balance -1 .SS Dropping top-level accounts .PP You can also hide one or more top-level account name parts, using -\f[C]--drop NUM\f[R]. +\f[V]--drop NUM\f[R]. This can be useful for hiding repetitive top-level account names: .IP .nf @@ -3683,9 +3700,9 @@ $ hledger -f examples/sample.journal bal expenses --drop 1 .PP .SS Multi-period balance report .PP -With a report interval (set by the \f[C]-D/--daily\f[R], -\f[C]-W/--weekly\f[R], \f[C]-M/--monthly\f[R], \f[C]-Q/--quarterly\f[R], -\f[C]-Y/--yearly\f[R], or \f[C]-p/--period\f[R] flag), \f[C]balance\f[R] +With a report interval (set by the \f[V]-D/--daily\f[R], +\f[V]-W/--weekly\f[R], \f[V]-M/--monthly\f[R], \f[V]-Q/--quarterly\f[R], +\f[V]-Y/--yearly\f[R], or \f[V]-p/--period\f[R] flag), \f[V]balance\f[R] shows a tabular report, with columns representing successive time periods (and a title): .IP @@ -3712,21 +3729,21 @@ fully encompass the displayed subperiods (so that the first and last subperiods have the same duration as the others). .IP \[bu] 2 Leading and trailing periods (columns) containing all zeroes are not -shown, unless \f[C]-E/--empty\f[R] is used. +shown, unless \f[V]-E/--empty\f[R] is used. .IP \[bu] 2 Accounts (rows) containing all zeroes are not shown, unless -\f[C]-E/--empty\f[R] is used. +\f[V]-E/--empty\f[R] is used. .IP \[bu] 2 Amounts with many commodities are shown in abbreviated form, unless -\f[C]--no-elide\f[R] is used. +\f[V]--no-elide\f[R] is used. \f[I](experimental)\f[R] .IP \[bu] 2 Average and/or total columns can be added with the -\f[C]-A/--average\f[R] and \f[C]-T/--row-total\f[R] flags. +\f[V]-A/--average\f[R] and \f[V]-T/--row-total\f[R] flags. .IP \[bu] 2 -The \f[C]--transpose\f[R] flag can be used to exchange rows and columns. +The \f[V]--transpose\f[R] flag can be used to exchange rows and columns. .IP \[bu] 2 -The \f[C]--pivot FIELD\f[R] option causes a different transaction field +The \f[V]--pivot FIELD\f[R] option causes a different transaction field to be used as \[dq]account name\[dq]. See PIVOTING. .PP @@ -3734,31 +3751,31 @@ Multi-period reports with many periods can be too wide for easy viewing in the terminal. Here are some ways to handle that: .IP \[bu] 2 -Hide the totals row with \f[C]-N/--no-total\f[R] +Hide the totals row with \f[V]-N/--no-total\f[R] .IP \[bu] 2 -Convert to a single currency with \f[C]-V\f[R] +Convert to a single currency with \f[V]-V\f[R] .IP \[bu] 2 Maximize the terminal window .IP \[bu] 2 Reduce the terminal\[aq]s font size .IP \[bu] 2 View with a pager like less, eg: -\f[C]hledger bal -D --color=yes | less -RS\f[R] +\f[V]hledger bal -D --color=yes | less -RS\f[R] .IP \[bu] 2 Output as CSV and use a CSV viewer like visidata -(\f[C]hledger bal -D -O csv | vd -f csv\f[R]), Emacs\[aq] csv-mode -(\f[C]M-x csv-mode, C-c C-a\f[R]), or a spreadsheet -(\f[C]hledger bal -D -o a.csv && open a.csv\f[R]) +(\f[V]hledger bal -D -O csv | vd -f csv\f[R]), Emacs\[aq] csv-mode +(\f[V]M-x csv-mode, C-c C-a\f[R]), or a spreadsheet +(\f[V]hledger bal -D -o a.csv && open a.csv\f[R]) .IP \[bu] 2 Output as HTML and view with a browser: -\f[C]hledger bal -D -o a.html && open a.html\f[R] +\f[V]hledger bal -D -o a.html && open a.html\f[R] .SS Showing declared accounts .PP -With \f[C]--declared\f[R], accounts which have been declared with an +With \f[V]--declared\f[R], accounts which have been declared with an account directive will be included in the balance report, even if they have no transactions. (Since they will have a zero balance, you will also need -\f[C]-E/--empty\f[R] to see them.) +\f[V]-E/--empty\f[R] to see them.) .PP More precisely, \f[I]leaf\f[R] declared accounts (with no subaccounts) will be included, since those are usually the more useful in reports. @@ -3768,26 +3785,26 @@ balance report, even when you don\[aq]t have transactions in all of your declared accounts yet. .SS Data layout .PP -The \f[C]--layout\f[R] option affects how multi-commodity amounts are +The \f[V]--layout\f[R] option affects how multi-commodity amounts are displayed, and some other things, influencing the overall layout of the report data: .IP \[bu] 2 -\f[C]--layout=wide[,WIDTH]\f[R]: commodities are shown on a single line, +\f[V]--layout=wide[,WIDTH]\f[R]: commodities are shown on a single line, possibly elided to the specified width .IP \[bu] 2 -\f[C]--layout=tall\f[R]: each commodity is shown on a separate line +\f[V]--layout=tall\f[R]: each commodity is shown on a separate line .IP \[bu] 2 -\f[C]--layout=bare\f[R]: amounts are shown as bare numbers, with +\f[V]--layout=bare\f[R]: amounts are shown as bare numbers, with commodity symbols in a separate column .IP \[bu] 2 -\f[C]--layout=tidy\f[R]: data is normalised to tidy form, with one row +\f[V]--layout=tidy\f[R]: data is normalised to tidy form, with one row per data value. We currently support this with CSV output only. In tidy mode, totals and row averages are disabled -(\f[C]-N/--no-total\f[R] is implied and \f[C]-T/--row-total\f[R] and -\f[C]-A/--average\f[R] will be ignored). +(\f[V]-N/--no-total\f[R] is implied and \f[V]-T/--row-total\f[R] and +\f[V]-A/--average\f[R] will be ignored). .PP -These \f[C]--layout\f[R] modes are supported with some but not all of +These \f[V]--layout\f[R] modes are supported with some but not all of the output formats: .PP .TS @@ -3995,24 +4012,24 @@ $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layo .RE .SS Sorting by amount .PP -With \f[C]-S/--sort-amount\f[R], accounts with the largest (most +With \f[V]-S/--sort-amount\f[R], accounts with the largest (most positive) balances are shown first. -Eg: \f[C]hledger bal expenses -MAS\f[R] shows your biggest averaged +Eg: \f[V]hledger bal expenses -MAS\f[R] shows your biggest averaged monthly expenses first. When more than one commodity is present, they will be sorted by the alphabetically earliest commodity first, and then by subsequent commodities (if an amount is missing a commodity, it is treated as 0). .PP Revenues and liability balances are typically negative, however, so -\f[C]-S\f[R] shows these in reverse order. -To work around this, you can add \f[C]--invert\f[R] to flip the signs. +\f[V]-S\f[R] shows these in reverse order. +To work around this, you can add \f[V]--invert\f[R] to flip the signs. (Or, use one of the higher-level reports, which flip the sign automatically. -Eg: \f[C]hledger incomestatement -MAS\f[R]). +Eg: \f[V]hledger incomestatement -MAS\f[R]). .PP .SS Percentages .PP -With \f[C]-%/--percent\f[R], balance reports show each account\[aq]s +With \f[V]-%/--percent\f[R], balance reports show each account\[aq]s value expressed as a percentage of the (column) total: .IP .nf @@ -4041,8 +4058,8 @@ $ hledger bal -% amt:\[ga]<0\[ga] .fi .PP Similarly, if the amounts in a column have mixed commodities, convert -them to one commodity with \f[C]-B\f[R], \f[C]-V\f[R], \f[C]-X\f[R] or -\f[C]--value\f[R], or make a separate report for each commodity: +them to one commodity with \f[V]-B\f[R], \f[V]-V\f[R], \f[V]-X\f[R] or +\f[V]--value\f[R], or make a separate report for each commodity: .IP .nf \f[C] @@ -4075,7 +4092,7 @@ In general, balance changes are what you want to see when reviewing revenues and expenses, and historical end balances are what you want to see when reviewing or reconciling asset, liability and equity accounts. .PP -\f[C]balance\f[R] shows balance changes by default. +\f[V]balance\f[R] shows balance changes by default. To see accurate historical end balances: .IP "1." 3 Initialise account starting balances with an \[dq]opening balances\[dq] @@ -4084,14 +4101,14 @@ covers the account\[aq]s full lifetime. .IP "2." 3 Include all of of the account\[aq]s prior postings in the report, by not specifying a report start date, or by using the -\f[C]-H/--historical\f[R] flag. -(\f[C]-H\f[R] causes report start date to be ignored when summing +\f[V]-H/--historical\f[R] flag. +(\f[V]-H\f[R] causes report start date to be ignored when summing postings.) .SS Balance report types .PP For more flexible reporting, there are three important option groups: .PP -\f[C]hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] ...\f[R] +\f[V]hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] ...\f[R] .PP The first two are the most important: calculation type selects the basic calculation to perform for each table cell, while accumulation type says @@ -4108,15 +4125,15 @@ value or cost. The basic calculation to perform for each table cell. It is one of: .IP \[bu] 2 -\f[C]--sum\f[R] : sum the posting amounts (\f[B]default\f[R]) +\f[V]--sum\f[R] : sum the posting amounts (\f[B]default\f[R]) .IP \[bu] 2 -\f[C]--budget\f[R] : like --sum but also show a goal amount +\f[V]--budget\f[R] : like --sum but also show a goal amount .IP \[bu] 2 -\f[C]--valuechange\f[R] : show the change in period-end historical +\f[V]--valuechange\f[R] : show the change in period-end historical balance values (caused by deposits, withdrawals, and/or market price fluctuations) .IP \[bu] 2 -\f[C]--gain\f[R] : show the unrealised capital gain/loss, (the current +\f[V]--gain\f[R] : show the unrealised capital gain/loss, (the current valued balance minus each amount\[aq]s original cost) .PP \f[B]Accumulation type:\f[R] @@ -4126,16 +4143,16 @@ valued balance minus each amount\[aq]s original cost) Which postings should be included in each cell\[aq]s calculation. It is one of: .IP \[bu] 2 -\f[C]--change\f[R] : postings from column start to column end, ie within +\f[V]--change\f[R] : postings from column start to column end, ie within the cell\[aq]s period. Typically used to see revenues/expenses. (\f[B]default for balance, incomestatement\f[R]) .IP \[bu] 2 -\f[C]--cumulative\f[R] : postings from report start to column end, eg to +\f[V]--cumulative\f[R] : postings from report start to column end, eg to show changes accumulated since the report\[aq]s start date. Rarely used. .IP \[bu] 2 -\f[C]--historical/-H\f[R] : postings from journal start to column end, +\f[V]--historical/-H\f[R] : postings from journal start to column end, ie all postings from account creation to the end of the cell\[aq]s period. Typically used to see historical end balances of @@ -4153,32 +4170,32 @@ It is one of: no valuation, show amounts in their original commodities (\f[B]default\f[R]) .IP \[bu] 2 -\f[C]--value=cost[,COMM]\f[R] : no valuation, show amounts converted to +\f[V]--value=cost[,COMM]\f[R] : no valuation, show amounts converted to cost .IP \[bu] 2 -\f[C]--value=then[,COMM]\f[R] : show value at transaction dates +\f[V]--value=then[,COMM]\f[R] : show value at transaction dates .IP \[bu] 2 -\f[C]--value=end[,COMM]\f[R] : show value at period end date(s) -(\f[B]default with \f[CB]--valuechange\f[B], \f[CB]--gain\f[B]\f[R]) +\f[V]--value=end[,COMM]\f[R] : show value at period end date(s) +(\f[B]default with \f[VB]--valuechange\f[B], \f[VB]--gain\f[B]\f[R]) .IP \[bu] 2 -\f[C]--value=now[,COMM]\f[R] : show value at today\[aq]s date +\f[V]--value=now[,COMM]\f[R] : show value at today\[aq]s date .IP \[bu] 2 -\f[C]--value=YYYY-MM-DD[,COMM]\f[R] : show value at another date +\f[V]--value=YYYY-MM-DD[,COMM]\f[R] : show value at another date .PP -or one of their aliases: \f[C]--cost/-B\f[R], \f[C]--market/-V\f[R] or -\f[C]--exchange/-X\f[R]. +or one of their aliases: \f[V]--cost/-B\f[R], \f[V]--market/-V\f[R] or +\f[V]--exchange/-X\f[R]. .PP Most combinations of these options should produce reasonable reports, but if you find any that seem wrong or misleading, let us know. The following restrictions are applied: .IP \[bu] 2 -\f[C]--valuechange\f[R] implies \f[C]--value=end\f[R] +\f[V]--valuechange\f[R] implies \f[V]--value=end\f[R] .IP \[bu] 2 -\f[C]--valuechange\f[R] makes \f[C]--change\f[R] the default when used -with the \f[C]balancesheet\f[R]/\f[C]balancesheetequity\f[R] commands +\f[V]--valuechange\f[R] makes \f[V]--change\f[R] the default when used +with the \f[V]balancesheet\f[R]/\f[V]balancesheetequity\f[R] commands .IP \[bu] 2 -\f[C]--cumulative\f[R] or \f[C]--historical\f[R] disables -\f[C]--row-total/-T\f[R] +\f[V]--cumulative\f[R] or \f[V]--historical\f[R] disables +\f[V]--row-total/-T\f[R] .PP For reference, here is what the combinations of accumulation and valuation show: @@ -4191,15 +4208,15 @@ Valuation: >Accumulation: v T}@T{ no valuation T}@T{ -\f[C]--value= then\f[R] +\f[V]--value= then\f[R] T}@T{ -\f[C]--value= end\f[R] +\f[V]--value= end\f[R] T}@T{ -\f[C]--value= YYYY-MM-DD /now\f[R] +\f[V]--value= YYYY-MM-DD /now\f[R] T} _ T{ -\f[C]--change\f[R] +\f[V]--change\f[R] T}@T{ change in period T}@T{ @@ -4210,7 +4227,7 @@ T}@T{ DATE-value of change in period T} T{ -\f[C]--cumulative\f[R] +\f[V]--cumulative\f[R] T}@T{ change from report start to period end T}@T{ @@ -4221,7 +4238,7 @@ T}@T{ DATE-value of change from report start to period end T} T{ -\f[C]--historical /-H\f[R] +\f[V]--historical /-H\f[R] T}@T{ change from journal start to period end (historical end balance) T}@T{ @@ -4234,65 +4251,65 @@ T} .TE .SS Useful balance reports .PP -Some frequently used \f[C]balance\f[R] options/reports are: +Some frequently used \f[V]balance\f[R] options/reports are: .IP \[bu] 2 -\f[C]bal -M revenues expenses\f[R] +\f[V]bal -M revenues expenses\f[R] .PD 0 .P .PD Show revenues/expenses in each month. -Also available as the \f[C]incomestatement\f[R] command. +Also available as the \f[V]incomestatement\f[R] command. .IP \[bu] 2 -\f[C]bal -M -H assets liabilities\f[R] +\f[V]bal -M -H assets liabilities\f[R] .PD 0 .P .PD Show historical asset/liability balances at each month end. -Also available as the \f[C]balancesheet\f[R] command. +Also available as the \f[V]balancesheet\f[R] command. .IP \[bu] 2 -\f[C]bal -M -H assets liabilities equity\f[R] +\f[V]bal -M -H assets liabilities equity\f[R] .PD 0 .P .PD Show historical asset/liability/equity balances at each month end. -Also available as the \f[C]balancesheetequity\f[R] command. +Also available as the \f[V]balancesheetequity\f[R] command. .IP \[bu] 2 -\f[C]bal -M assets not:receivable\f[R] +\f[V]bal -M assets not:receivable\f[R] .PD 0 .P .PD Show changes to liquid assets in each month. -Also available as the \f[C]cashflow\f[R] command. +Also available as the \f[V]cashflow\f[R] command. .PP Also: .IP \[bu] 2 -\f[C]bal -M expenses -2 -SA\f[R] +\f[V]bal -M expenses -2 -SA\f[R] .PD 0 .P .PD Show monthly expenses summarised to depth 2 and sorted by average amount. .IP \[bu] 2 -\f[C]bal -M --budget expenses\f[R] +\f[V]bal -M --budget expenses\f[R] .PD 0 .P .PD Show monthly expenses and budget goals. .IP \[bu] 2 -\f[C]bal -M --valuechange investments\f[R] +\f[V]bal -M --valuechange investments\f[R] .PD 0 .P .PD Show monthly change in market value of investment assets. .IP \[bu] 2 -\f[C]bal investments --valuechange -D date:lastweek amt:\[aq]>1000\[aq] -STA [--invert]\f[R] +\f[V]bal investments --valuechange -D date:lastweek amt:\[aq]>1000\[aq] -STA [--invert]\f[R] .PD 0 .P .PD Show top gainers [or losers] last week .SS Budget report .PP -The \f[C]--budget\f[R] report type activates extra columns showing any +The \f[V]--budget\f[R] report type activates extra columns showing any budget goals for each account and period. The budget goals are defined by periodic transactions. This is very useful for comparing planned and actual income, expenses, @@ -4367,14 +4384,14 @@ Eg assets, assets:bank, and expenses above. Amounts always include all subaccounts, budgeted or unbudgeted, even in list mode. .PP -This means that the numbers displayed will not always add up! Eg above, -the \f[C]expenses\f[R] actual amount includes the gifts and supplies -transactions, but the \f[C]expenses:gifts\f[R] and -\f[C]expenses:supplies\f[R] accounts are not shown, as they have no +This means that the numbers displayed will not always add up! +Eg above, the \f[V]expenses\f[R] actual amount includes the gifts and +supplies transactions, but the \f[V]expenses:gifts\f[R] and +\f[V]expenses:supplies\f[R] accounts are not shown, as they have no budget amounts declared. .PP This can be confusing. -When you need to make things clearer, use the \f[C]-E/--empty\f[R] flag, +When you need to make things clearer, use the \f[V]-E/--empty\f[R] flag, which will reveal all accounts including unbudgeted ones, giving the full picture. Eg: @@ -4402,7 +4419,7 @@ Budget performance in 2017/11/01-2017/12/31: .fi .PP You can roll over unspent budgets to next period with -\f[C]--cumulative\f[R]: +\f[V]--cumulative\f[R]: .IP .nf \f[C] @@ -4430,7 +4447,7 @@ For more examples and notes, see Budgeting. This might be a bug, but for now: when making budget reports, it\[aq]s a good idea to explicitly set the report\[aq]s start date to the first day of a reporting period, because a periodic rule like -\f[C]\[ti] monthly\f[R] generates its transactions on the 1st of each +\f[V]\[ti] monthly\f[R] generates its transactions on the 1st of each month, and if your journal has no regular transactions on the 1st, the default report start date could exclude that budget goal, which can be a little surprising. @@ -4461,10 +4478,10 @@ Budget performance in 2020-01-15: .fi .PP To avoid this, specify the budget report\[aq]s period, or at least the -start date, with \f[C]-b\f[R]/\f[C]-e\f[R]/\f[C]-p\f[R]/\f[C]date:\f[R], +start date, with \f[V]-b\f[R]/\f[V]-e\f[R]/\f[V]-p\f[R]/\f[V]date:\f[R], to ensure it includes the budget goal transactions (periodic transactions) that you want. -Eg, adding \f[C]-b 2020/1/1\f[R] to the above: +Eg, adding \f[V]-b 2020/1/1\f[R] to the above: .IP .nf \f[C] @@ -4501,14 +4518,14 @@ To illustrate this, consider the following budget: .PP With this, monthly budget for electronics is defined to be $100 and budget for personal expenses is an additional $1000, which implicitly -means that budget for both \f[C]expenses:personal\f[R] and -\f[C]expenses\f[R] is $1100. +means that budget for both \f[V]expenses:personal\f[R] and +\f[V]expenses\f[R] is $1100. .PP -Transactions in \f[C]expenses:personal:electronics\f[R] will be counted -both towards its $100 budget and $1100 of \f[C]expenses:personal\f[R] , -and transactions in any other subaccount of \f[C]expenses:personal\f[R] +Transactions in \f[V]expenses:personal:electronics\f[R] will be counted +both towards its $100 budget and $1100 of \f[V]expenses:personal\f[R] , +and transactions in any other subaccount of \f[V]expenses:personal\f[R] would be counted towards only towards the budget of -\f[C]expenses:personal\f[R]. +\f[V]expenses:personal\f[R]. .PP For example, let\[aq]s consider these transactions: .IP @@ -4538,11 +4555,11 @@ For example, let\[aq]s consider these transactions: .fi .PP As you can see, we have transactions in -\f[C]expenses:personal:electronics:upgrades\f[R] and -\f[C]expenses:personal:train tickets\f[R], and since both of these +\f[V]expenses:personal:electronics:upgrades\f[R] and +\f[V]expenses:personal:train tickets\f[R], and since both of these accounts are without explicitly defined budget, these transactions would -be counted towards budgets of \f[C]expenses:personal:electronics\f[R] -and \f[C]expenses:personal\f[R] accordingly: +be counted towards budgets of \f[V]expenses:personal:electronics\f[R] +and \f[V]expenses:personal\f[R] accordingly: .IP .nf \f[C] @@ -4560,7 +4577,7 @@ Budget performance in 2019/01: \f[R] .fi .PP -And with \f[C]--empty\f[R], we can get a better picture of budget +And with \f[V]--empty\f[R], we can get a better picture of budget allocation and consumption: .IP .nf @@ -4601,8 +4618,8 @@ Eg if you have daily, weekly and monthly periodic rules, all of these will contribute to the goals in a monthly budget report. .PP You can select a subset of periodic rules by providing an argument to -the \f[C]--budget\f[R] flag. -\f[C]--budget=DESCPAT\f[R] will match all periodic rules whose +the \f[V]--budget\f[R] flag. +\f[V]--budget=DESCPAT\f[R] will match all periodic rules whose description contains DESCPAT, a case-insensitive substring (not a regular expression or query). This means you can give your periodic rules descriptions (remember that @@ -4611,7 +4628,7 @@ your journal. .SS Customising single-period balance reports .PP For single-period balance reports displayed in the terminal (only), you -can use \f[C]--format FMT\f[R] to customise the format and content of +can use \f[V]--format FMT\f[R] to customise the format and content of each line. Eg: .IP @@ -4637,7 +4654,7 @@ The FMT format string (plus a newline) specifies the formatting applied to each account/balance pair. It may contain any suitable text, with data fields interpolated like so: .PP -\f[C]%[MIN][.MAX](FIELDNAME)\f[R] +\f[V]%[MIN][.MAX](FIELDNAME)\f[R] .IP \[bu] 2 MIN pads with spaces to at least this width (optional) .IP \[bu] 2 @@ -4646,41 +4663,41 @@ MAX truncates at this width (optional) FIELDNAME must be enclosed in parentheses, and can be one of: .RS 2 .IP \[bu] 2 -\f[C]depth_spacer\f[R] - a number of spaces equal to the account\[aq]s +\f[V]depth_spacer\f[R] - a number of spaces equal to the account\[aq]s depth, or if MIN is specified, MIN * depth spaces. .IP \[bu] 2 -\f[C]account\f[R] - the account\[aq]s name +\f[V]account\f[R] - the account\[aq]s name .IP \[bu] 2 -\f[C]total\f[R] - the account\[aq]s balance/posted total, right +\f[V]total\f[R] - the account\[aq]s balance/posted total, right justified .RE .PP Also, FMT can begin with an optional prefix to control how multi-commodity amounts are rendered: .IP \[bu] 2 -\f[C]%_\f[R] - render on multiple lines, bottom-aligned (the default) +\f[V]%_\f[R] - render on multiple lines, bottom-aligned (the default) .IP \[bu] 2 -\f[C]%\[ha]\f[R] - render on multiple lines, top-aligned +\f[V]%\[ha]\f[R] - render on multiple lines, top-aligned .IP \[bu] 2 -\f[C]%,\f[R] - render on one line, comma-separated +\f[V]%,\f[R] - render on one line, comma-separated .PP There are some quirks. -Eg in one-line mode, \f[C]%(depth_spacer)\f[R] has no effect, instead -\f[C]%(account)\f[R] has indentation built in. +Eg in one-line mode, \f[V]%(depth_spacer)\f[R] has no effect, instead +\f[V]%(account)\f[R] has indentation built in. Experimentation may be needed to get pleasing results. .PP Some example formats: .IP \[bu] 2 -\f[C]%(total)\f[R] - the account\[aq]s total +\f[V]%(total)\f[R] - the account\[aq]s total .IP \[bu] 2 -\f[C]%-20.20(account)\f[R] - the account\[aq]s name, left justified, +\f[V]%-20.20(account)\f[R] - the account\[aq]s name, left justified, padded to 20 characters and clipped at 20 characters .IP \[bu] 2 -\f[C]%,%-50(account) %25(total)\f[R] - account name padded to 50 +\f[V]%,%-50(account) %25(total)\f[R] - account name padded to 50 characters, total padded to 20 characters, with multiple commodities rendered on one line .IP \[bu] 2 -\f[C]%20(total) %2(depth_spacer)%-(account)\f[R] - the default format +\f[V]%20(total) %2(depth_spacer)%-(account)\f[R] - the default format for the single-column balance report .SS balancesheet .PP @@ -4690,14 +4707,14 @@ balancesheet, bs .PD This command displays a balance sheet, showing historical ending balances of asset and liability accounts. -(To see equity as well, use the balancesheetequity command.) Amounts are -shown with normal positive sign, as in conventional financial -statements. +(To see equity as well, use the balancesheetequity command.) +Amounts are shown with normal positive sign, as in conventional +financial statements. .PP -This report shows accounts declared with the \f[C]Asset\f[R], -\f[C]Cash\f[R] or \f[C]Liability\f[R] type (see account types). +This report shows accounts declared with the \f[V]Asset\f[R], +\f[V]Cash\f[R] or \f[V]Liability\f[R] type (see account types). Or if no such accounts are declared, it shows top-level accounts named -\f[C]asset\f[R] or \f[C]liability\f[R] (case insensitive, plurals +\f[V]asset\f[R] or \f[V]liability\f[R] (case insensitive, plurals allowed) and their subaccounts. .PP Example: @@ -4725,16 +4742,16 @@ Total: \f[R] .fi .PP -This command is a higher-level variant of the \f[C]balance\f[R] command, +This command is a higher-level variant of the \f[V]balance\f[R] command, and supports many of that command\[aq]s features, such as multi-period reports. -It is similar to \f[C]hledger balance -H assets liabilities\f[R], but +It is similar to \f[V]hledger balance -H assets liabilities\f[R], but with smarter account detection, and liabilities displayed with their sign flipped. .PP This command also supports the output destination and output format -options The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R], -\f[C]html\f[R], and (experimental) \f[C]json\f[R]. +options The output formats supported are \f[V]txt\f[R], \f[V]csv\f[R], +\f[V]html\f[R], and (experimental) \f[V]json\f[R]. .SS balancesheetequity .PP balancesheetequity, bse @@ -4746,11 +4763,11 @@ balances of asset, liability and equity accounts. Amounts are shown with normal positive sign, as in conventional financial statements. .PP -This report shows accounts declared with the \f[C]Asset\f[R], -\f[C]Cash\f[R], \f[C]Liability\f[R] or \f[C]Equity\f[R] type (see +This report shows accounts declared with the \f[V]Asset\f[R], +\f[V]Cash\f[R], \f[V]Liability\f[R] or \f[V]Equity\f[R] type (see account types). Or if no such accounts are declared, it shows top-level accounts named -\f[C]asset\f[R], \f[C]liability\f[R] or \f[C]equity\f[R] (case +\f[V]asset\f[R], \f[V]liability\f[R] or \f[V]equity\f[R] (case insensitive, plurals allowed) and their subaccounts. .PP Example: @@ -4783,16 +4800,16 @@ Total: \f[R] .fi .PP -This command is a higher-level variant of the \f[C]balance\f[R] command, +This command is a higher-level variant of the \f[V]balance\f[R] command, and supports many of that command\[aq]s features, such as multi-period reports. -It is similar to \f[C]hledger balance -H assets liabilities equity\f[R], +It is similar to \f[V]hledger balance -H assets liabilities equity\f[R], but with smarter account detection, and liabilities/equity displayed with their sign flipped. .PP This command also supports the output destination and output format -options The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R], -\f[C]html\f[R], and (experimental) \f[C]json\f[R]. +options The output formats supported are \f[V]txt\f[R], \f[V]csv\f[R], +\f[V]html\f[R], and (experimental) \f[V]json\f[R]. .SS cashflow .PP cashflow, cf @@ -4805,20 +4822,20 @@ assets. Amounts are shown with normal positive sign, as in conventional financial statements. .PP -This report shows accounts declared with the \f[C]Cash\f[R] type (see +This report shows accounts declared with the \f[V]Cash\f[R] type (see account types). Or if no such accounts are declared, it shows accounts .IP \[bu] 2 -under a top-level account named \f[C]asset\f[R] (case insensitive, +under a top-level account named \f[V]asset\f[R] (case insensitive, plural allowed) .IP \[bu] 2 -whose name contains some variation of \f[C]cash\f[R], \f[C]bank\f[R], -\f[C]checking\f[R] or \f[C]saving\f[R]. +whose name contains some variation of \f[V]cash\f[R], \f[V]bank\f[R], +\f[V]checking\f[R] or \f[V]saving\f[R]. .PP More precisely: all accounts matching this case insensitive regular expression: .PP -\f[C]\[ha]assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|currentcash)(:|$)\f[R] +\f[V]\[ha]assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|currentcash)(:|$)\f[R] .PP and their subaccounts. .PP @@ -4842,16 +4859,16 @@ Total: \f[R] .fi .PP -This command is a higher-level variant of the \f[C]balance\f[R] command, +This command is a higher-level variant of the \f[V]balance\f[R] command, and supports many of that command\[aq]s features, such as multi-period reports. It is similar to -\f[C]hledger balance assets not:fixed not:investment not:receivable\f[R], +\f[V]hledger balance assets not:fixed not:investment not:receivable\f[R], but with smarter account detection. .PP This command also supports the output destination and output format -options The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R], -\f[C]html\f[R], and (experimental) \f[C]json\f[R]. +options The output formats supported are \f[V]txt\f[R], \f[V]csv\f[R], +\f[V]html\f[R], and (experimental) \f[V]json\f[R]. .SS check .PP check @@ -4863,7 +4880,7 @@ Check for various kinds of errors in your data. hledger provides a number of built-in error checks to help prevent problems in your data. Some of these are run automatically; or, you can use this -\f[C]check\f[R] command to run them on demand, with no output and a zero +\f[V]check\f[R] command to run them on demand, with no output and a zero exit code if all is well. Specify their names (or a prefix) as argument(s). .PP @@ -4884,7 +4901,7 @@ Here are the checks currently available: .SS Basic checks .PP These checks are always run automatically, by (almost) all hledger -commands, including \f[C]check\f[R]: +commands, including \f[V]check\f[R]: .IP \[bu] 2 \f[B]parseable\f[R] - data files are well-formed and can be successfully parsed @@ -4897,13 +4914,13 @@ transaction prices \f[B]assertions\f[R] - all balance assertions in the journal are passing. (This check can be disabled with -\f[C]-I\f[R]/\f[C]--ignore-assertions\f[R].) +\f[V]-I\f[R]/\f[V]--ignore-assertions\f[R].) .SS Strict checks .PP -These additional checks are run when the \f[C]-s\f[R]/\f[C]--strict\f[R] +These additional checks are run when the \f[V]-s\f[R]/\f[V]--strict\f[R] (strict mode) flag is used. Or, they can be run by giving their names as arguments to -\f[C]check\f[R]: +\f[V]check\f[R]: .IP \[bu] 2 \f[B]accounts\f[R] - all account names used by transactions have been declared @@ -4915,7 +4932,7 @@ 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 -\f[C]check\f[R]. +\f[V]check\f[R]. They are more specialised and not desirable for everyone, therefore optional: .IP \[bu] 2 @@ -4943,7 +4960,7 @@ You could make similar scripts to perform your own custom checks. See: Cookbook -> Scripting. .SS More about specific checks .PP -\f[C]hledger check recentassertions\f[R] will complain if any +\f[V]hledger check recentassertions\f[R] will complain if any balance-asserted account does not have a balance assertion within 7 days before its latest posting. This aims to prevent the situation where you are regularly updating your @@ -4982,33 +4999,33 @@ earnings\[dq] (part of equity), and allows the accounting equation zero total. .PP You can print just the closing transaction by using the -\f[C]--close\f[R] flag, or just the opening transaction with the -\f[C]--open\f[R] flag. +\f[V]--close\f[R] flag, or just the opening transaction with the +\f[V]--open\f[R] flag. .PP -Their descriptions are \f[C]closing balances\f[R] and -\f[C]opening balances\f[R] by default; you can customise these with the -\f[C]--close-desc\f[R] and \f[C]--open-desc\f[R] options. +Their descriptions are \f[V]closing balances\f[R] and +\f[V]opening balances\f[R] by default; you can customise these with the +\f[V]--close-desc\f[R] and \f[V]--open-desc\f[R] options. .PP Just one balancing equity posting is used by default, with the amount left implicit. -The default account name is \f[C]equity:opening/closing balances\f[R]. -You can customise the account name(s) with \f[C]--close-acct\f[R] and -\f[C]--open-acct\f[R]. +The default account name is \f[V]equity:opening/closing balances\f[R]. +You can customise the account name(s) with \f[V]--close-acct\f[R] and +\f[V]--open-acct\f[R]. (If you specify only one of these, it will be used for both.) .PP -With \f[C]--x/--explicit\f[R], the equity posting\[aq]s amount will be +With \f[V]--x/--explicit\f[R], the equity posting\[aq]s amount will be shown explicitly, and if it involves multiple commodities, there will be a separate equity posting for each commodity (as in the print command). .PP -With \f[C]--interleaved\f[R], each equity posting is shown next to the +With \f[V]--interleaved\f[R], each equity posting is shown next to the posting it balances (good for troubleshooting). .SS close and prices .PP Transaction prices are ignored (and discarded) by closing/opening transactions, by default. -With \f[C]--show-costs\f[R], they are preserved; there will be a +With \f[V]--show-costs\f[R], they are preserved; there will be a separate equity posting for each cost in each commodity. -This means \f[C]balance -B\f[R] reports will look the same after the +This means \f[V]balance -B\f[R] reports will look the same after the transition. Note if you have many foreign currency or investment transactions, this will generate very large journal entries. @@ -5017,7 +5034,7 @@ will generate very large journal entries. The default closing date is yesterday, or the journal\[aq]s end date, whichever is later. .PP -Unless you are running \f[C]close\f[R] on exactly the first day of the +Unless you are running \f[V]close\f[R] on exactly the first day of the new period, you\[aq]ll want to override the closing date. This is done by specifying a report end date, where \[dq]last day of the report period\[dq] will be the closing date. @@ -5027,7 +5044,7 @@ any of these will work: .PP .TS tab(@); -l l. +lw(14.9n) lw(55.1n). T{ end date argument T}@T{ @@ -5035,22 +5052,22 @@ explanation T} _ T{ -\f[C]-e 2021-01-01\f[R] +\f[V]-e 2021-01-01\f[R] T}@T{ end dates are exclusive T} T{ -\f[C]-e 2021\f[R] +\f[V]-e 2021\f[R] T}@T{ equivalent, per smart dates T} T{ -\f[C]-p 2020\f[R] +\f[V]-p 2020\f[R] T}@T{ equivalent, the period\[aq]s begin date is ignored T} T{ -\f[C]date:2020\f[R] +\f[V]date:2020\f[R] T}@T{ equivalent query T} @@ -5090,7 +5107,7 @@ $ hledger bs -f 2020.journal # just old files - balances are z .SS Hiding opening/closing transactions .PP Although the closing/opening transactions cancel out, they will be -visible in reports like \f[C]print\f[R] and \f[C]register\f[R], creating +visible in reports like \f[V]print\f[R] and \f[V]register\f[R], creating some visual clutter. You can exclude them all with a query, like: .IP @@ -5165,14 +5182,14 @@ The closing and opening transactions will include balance assertions, verifying that the accounts have first been reset to zero and then restored to their previous balance. These provide valuable error checking, alerting you when things get out -of line, but you can ignore them temporarily with \f[C]-I\f[R] or just +of line, but you can ignore them temporarily with \f[V]-I\f[R] or just remove them if you prefer. .PP You probably shouldn\[aq]t use status or realness filters (like -C or -R -or \f[C]status:\f[R]) with \f[C]close\f[R], or the generated balance +or \f[V]status:\f[R]) with \f[V]close\f[R], or the generated balance assertions will depend on these flags. -Likewise, if you run this command with \f[C]--auto\f[R], the balance -assertions would probably always require \f[C]--auto\f[R]. +Likewise, if you run this command with \f[V]--auto\f[R], the balance +assertions would probably always require \f[V]--auto\f[R]. .PP Multi-day transactions (where some postings have a different date) break the balance assertions, because the money is temporarily @@ -5205,7 +5222,7 @@ single-day transactions): .fi .SS Example: close revenue/expense accounts to retained earnings .PP -For this, use \f[C]--close\f[R] to suppress the opening transaction, as +For this, use \f[V]--close\f[R] to suppress the opening transaction, as it\[aq]s not needed. Also you\[aq]ll want to change the equity account name to your equivalent of \[dq]equity:retained earnings\[dq]. @@ -5239,7 +5256,7 @@ $ hledger bse -p Q1 .PP And we must suppress the closing transaction to see the first quarter\[aq]s income statement (using the description; -\f[C]not:\[aq]retained earnings\[aq]\f[R] won\[aq]t work here): +\f[V]not:\[aq]retained earnings\[aq]\f[R] won\[aq]t work here): .IP .nf \f[C] @@ -5262,7 +5279,7 @@ number or similar. .PP Transactions aren\[aq]t required to have a code, and missing or empty codes will not be shown by default. -With the \f[C]-E\f[R]/\f[C]--empty\f[R] flag, they will be printed as +With the \f[V]-E\f[R]/\f[V]--empty\f[R] flag, they will be printed as blank lines. .PP You can add a query to select a subset of transactions. @@ -5345,9 +5362,10 @@ in the other. .PP More precisely, for each posting affecting this account in either file, it looks for a corresponding posting in the other file which posts the -same amount to the same account (ignoring date, description, etc.) Since -postings not transactions are compared, this also works when multiple -bank transactions have been combined into a single journal entry. +same amount to the same account (ignoring date, description, etc.) +Since postings not transactions are compared, this also works when +multiple bank transactions have been combined into a single journal +entry. .PP This is useful eg if you have downloaded an account\[aq]s transactions from your bank (eg as CSV data). @@ -5384,13 +5402,13 @@ help .PD 0 .P .PD -Show the hledger user manual in the terminal, with \f[C]info\f[R], -\f[C]man\f[R], or a pager. +Show the hledger user manual in the terminal, with \f[V]info\f[R], +\f[V]man\f[R], or a pager. With a TOPIC argument, open it at that topic if possible. TOPIC can be any heading in the manual, or a heading prefix, case insensitive. -Eg: \f[C]commands\f[R], \f[C]print\f[R], \f[C]forecast\f[R], -\f[C]journal\f[R], \f[C]amount\f[R], \f[C]\[dq]auto postings\[dq]\f[R]. +Eg: \f[V]commands\f[R], \f[V]print\f[R], \f[V]forecast\f[R], +\f[V]journal\f[R], \f[V]amount\f[R], \f[V]\[dq]auto postings\[dq]\f[R]. .PP This command shows the hledger manual built in to your hledger version. It can be useful when offline, or when you prefer the terminal to a web @@ -5399,8 +5417,8 @@ installed on your system. .PP By default it chooses the best viewer found in $PATH (preferring info since the hledger manual is large). -You can select a particular viewer with the \f[C]-i\f[R], \f[C]-m\f[R], -or \f[C]-p\f[R] flags. +You can select a particular viewer with the \f[V]-i\f[R], \f[V]-m\f[R], +or \f[V]-p\f[R] flags. .PP Examples .IP @@ -5427,30 +5445,30 @@ This command may append new transactions to the main journal file (which should be in journal format). Existing transactions are not changed. This is one of the few hledger commands that writes to the journal file -(see also \f[C]add\f[R]). +(see also \f[V]add\f[R]). .PP -Unlike other hledger commands, with \f[C]import\f[R] the journal file is +Unlike other hledger commands, with \f[V]import\f[R] the journal file is an output file, and will be modified, though only by appending (existing data will not be changed). The input files are specified as arguments, so to import one or more CSV files to your main journal, you will run -\f[C]hledger import bank.csv\f[R] or perhaps -\f[C]hledger import *.csv\f[R]. +\f[V]hledger import bank.csv\f[R] or perhaps +\f[V]hledger import *.csv\f[R]. .PP Note you can import from any file format, though CSV files are the most common import source, and these docs focus on that case. .SS Deduplication .PP -As a convenience \f[C]import\f[R] does \f[I]deduplication\f[R] while +As a convenience \f[V]import\f[R] does \f[I]deduplication\f[R] while reading transactions. This does not mean \[dq]ignore transactions that look the same\[dq], but rather \[dq]ignore transactions that have been seen before\[dq]. This is intended for when you are periodically importing foreign data which may contain already-imported transactions. So eg, if every day you download bank CSV files containing redundant -data, you can safely run \f[C]hledger import bank.csv\f[R] and only new +data, you can safely run \f[V]hledger import bank.csv\f[R] and only new transactions will be imported. -(\f[C]import\f[R] is idempotent.) +(\f[V]import\f[R] is idempotent.) .PP Since the items being read (CSV records, eg) often do not come with unique identifiers, hledger detects new transactions by date, assuming @@ -5471,8 +5489,8 @@ few, so less likely to be the ones affected). .PP hledger remembers the latest date processed in each input file by saving a hidden \[dq].latest\[dq] state file in the same directory. -Eg when reading \f[C]finance/bank.csv\f[R], it will look for and update -the \f[C]finance/.latest.bank.csv\f[R] state file. +Eg when reading \f[V]finance/bank.csv\f[R], it will look for and update +the \f[V]finance/.latest.bank.csv\f[R] state file. The format is simple: one or more lines containing the same ISO-format date (YYYY-MM-DD), meaning \[dq]I have processed transactions up to this date, and this many of them on that date.\[dq] Normally you won\[aq]t @@ -5482,10 +5500,10 @@ transactions \[dq]new\[dq]), or you can construct them to \[dq]catch up\[dq] to a certain date. .PP Note deduplication (and updating of state files) can also be done by -\f[C]print --new\f[R], but this is less often used. +\f[V]print --new\f[R], but this is less often used. .SS Import testing .PP -With \f[C]--dry-run\f[R], the transactions that will be imported are +With \f[V]--dry-run\f[R], the transactions that will be imported are printed to the terminal, without updating your journal or state files. The output is valid journal format, like the print command, so you can re-parse it. @@ -5508,7 +5526,7 @@ $ ls bank.csv* | entr bash -c \[aq]echo ====; hledger import --dry bank.csv | hl .SS Importing balance assignments .PP Entries added by import will have their posting amounts made explicit -(like \f[C]hledger print -x\f[R]). +(like \f[V]hledger print -x\f[R]). This means that any balance assignments in imported files must be evaluated; but, imported files don\[aq]t get to see the main file\[aq]s account balances. @@ -5540,10 +5558,10 @@ during one or more periods. Amounts are shown with normal positive sign, as in conventional financial statements. .PP -This report shows accounts declared with the \f[C]Revenue\f[R] or -\f[C]Expense\f[R] type (see account types). +This report shows accounts declared with the \f[V]Revenue\f[R] or +\f[V]Expense\f[R] type (see account types). Or if no such accounts are declared, it shows top-level accounts named -\f[C]revenue\f[R] or \f[C]income\f[R] or \f[C]expense\f[R] (case +\f[V]revenue\f[R] or \f[V]income\f[R] or \f[V]expense\f[R] (case insensitive, plurals allowed) and their subaccounts. .PP Example: @@ -5573,17 +5591,17 @@ Total: \f[R] .fi .PP -This command is a higher-level variant of the \f[C]balance\f[R] command, +This command is a higher-level variant of the \f[V]balance\f[R] command, and supports many of that command\[aq]s features, such as multi-period reports. It is similar to -\f[C]hledger balance \[aq](revenues|income)\[aq] expenses\f[R], but with +\f[V]hledger balance \[aq](revenues|income)\[aq] expenses\f[R], but with smarter account detection, and revenues/income displayed with their sign flipped. .PP This command also supports the output destination and output format -options The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R], -\f[C]html\f[R], and (experimental) \f[C]json\f[R]. +options The output formats supported are \f[V]txt\f[R], \f[V]csv\f[R], +\f[V]html\f[R], and (experimental) \f[V]json\f[R]. .SS notes .PP notes @@ -5658,7 +5676,7 @@ print Show transaction journal entries, sorted by date. .PP The print command displays full journal entries (transactions) from the -journal file, sorted by date (or with \f[C]--date2\f[R], by secondary +journal file, sorted by date (or with \f[V]--date2\f[R], by secondary date). .PP Amounts are shown mostly normalised to commodity display style, eg the @@ -5730,36 +5748,37 @@ For example, when an amount is omitted in the journal, it will not appear in the output. Similarly, when a transaction price is implied but not written, it will not appear in the output. -You can use the \f[C]-x\f[R]/\f[C]--explicit\f[R] flag to make all +You can use the \f[V]-x\f[R]/\f[V]--explicit\f[R] flag to make all amounts and transaction prices explicit, which can be useful for troubleshooting or for making your journal more readable and robust against data entry errors. -\f[C]-x\f[R] is also implied by using any of -\f[C]-B\f[R],\f[C]-V\f[R],\f[C]-X\f[R],\f[C]--value\f[R]. +\f[V]-x\f[R] is also implied by using any of +\f[V]-B\f[R],\f[V]-V\f[R],\f[V]-X\f[R],\f[V]--value\f[R]. .PP -Note, \f[C]-x\f[R]/\f[C]--explicit\f[R] will cause postings with a +Note, \f[V]-x\f[R]/\f[V]--explicit\f[R] will cause postings with a multi-commodity amount (these can arise when a multi-commodity transaction has an implicit amount) to be split into multiple single-commodity postings, keeping the output parseable. .PP -With \f[C]-B\f[R]/\f[C]--cost\f[R], amounts with transaction prices are +With \f[V]-B\f[R]/\f[V]--cost\f[R], amounts with transaction prices are converted to cost using that price. This can be used for troubleshooting. .PP -With \f[C]-m\f[R]/\f[C]--match\f[R] and a STR argument, print will show -at most one transaction: the one one whose description is most similar -to STR, and is most recent. -STR should contain at least two characters. -If there is no similar-enough match, no transaction will be shown. +With \f[V]-m DESC\f[R]/\f[V]--match=DESC\f[R], print does a fuzzy search +for the one transaction whose description is most similar to DESC, also +preferring recent tranactions. +DESC should contain at least two characters. +If there is no similar-enough match, no transaction will be shown and +the program exit code will be non-zero. .PP -With \f[C]--new\f[R], hledger prints only transactions it has not seen +With \f[V]--new\f[R], hledger prints only transactions it has not seen on a previous run. -This uses the same deduplication system as the \f[C]import\f[R] command. +This uses the same deduplication system as the \f[V]import\f[R] command. (See import\[aq]s docs for details.) .PP This command also supports the output destination and output format -options The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R], -and (experimental) \f[C]json\f[R] and \f[C]sql\f[R]. +options The output formats supported are \f[V]txt\f[R], \f[V]csv\f[R], +and (experimental) \f[V]json\f[R] and \f[V]sql\f[R]. .PP Here\[aq]s an example of print\[aq]s CSV output: .IP @@ -5829,7 +5848,7 @@ Show postings and their running total. .PP The register command displays matched postings, across all accounts, in date order, with their running total or running historical balance. -(See also the \f[C]aregister\f[R] command, which shows matched +(See also the \f[V]aregister\f[R] command, which shows matched transactions in a specific account.) .PP register normally shows line per posting, but note that multi-commodity @@ -5854,9 +5873,9 @@ For performance reasons, column widths are chosen based on the first 1000 lines; this means unusually wide values in later lines can cause visual discontinuities as column widths are adjusted. If you want to ensure perfect alignment, at the cost of more time and -memory, use the \f[C]--align-all\f[R] flag. +memory, use the \f[V]--align-all\f[R] flag. .PP -The \f[C]--historical\f[R]/\f[C]-H\f[R] flag adds the balance from any +The \f[V]--historical\f[R]/\f[V]-H\f[R] flag adds the balance from any undisplayed prior postings to the running total. This is useful when you want to see only recent activity, with a historically accurate running balance: @@ -5870,21 +5889,21 @@ $ hledger register checking -b 2008/6 --historical \f[R] .fi .PP -The \f[C]--depth\f[R] option limits the amount of sub-account detail +The \f[V]--depth\f[R] option limits the amount of sub-account detail displayed. .PP -The \f[C]--average\f[R]/\f[C]-A\f[R] flag shows the running average +The \f[V]--average\f[R]/\f[V]-A\f[R] flag shows the running average posting amount instead of the running total (so, the final number displayed is the average for the whole report period). -This flag implies \f[C]--empty\f[R] (see below). -It is affected by \f[C]--historical\f[R]. +This flag implies \f[V]--empty\f[R] (see below). +It is affected by \f[V]--historical\f[R]. It works best when showing just one account and one commodity. .PP -The \f[C]--related\f[R]/\f[C]-r\f[R] flag shows the \f[I]other\f[R] +The \f[V]--related\f[R]/\f[V]-r\f[R] flag shows the \f[I]other\f[R] postings in the transactions of the postings which would normally be shown. .PP -The \f[C]--invert\f[R] flag negates all amounts. +The \f[V]--invert\f[R] flag negates all amounts. For example, it can be used on an income account where amounts are normally displayed as negative numbers. It\[aq]s also useful to show postings on the checking account together @@ -5908,7 +5927,7 @@ $ hledger register --monthly income .fi .PP Periods with no activity, and summary postings with a zero amount, are -not shown by default; use the \f[C]--empty\f[R]/\f[C]-E\f[R] flag to see +not shown by default; use the \f[V]--empty\f[R]/\f[V]-E\f[R] flag to see them: .IP .nf @@ -5930,7 +5949,7 @@ $ hledger register --monthly income -E .fi .PP Often, you\[aq]ll want to see just one line per interval. -The \f[C]--depth\f[R] option helps with this, causing subaccounts to be +The \f[V]--depth\f[R] option helps with this, causing subaccounts to be aggregated: .IP .nf @@ -5950,14 +5969,14 @@ comparable to the others in the report. .SS Custom register output .PP register uses the full terminal width by default, except on windows. -You can override this by setting the \f[C]COLUMNS\f[R] environment +You can override this by setting the \f[V]COLUMNS\f[R] environment variable (not a bash shell variable) or by using the -\f[C]--width\f[R]/\f[C]-w\f[R] option. +\f[V]--width\f[R]/\f[V]-w\f[R] option. .PP The description and account columns normally share the space equally (about half of (width - 40) each). You can adjust this by adding a description width as part of ---width\[aq]s argument, comma-separated: \f[C]--width W,D\f[R] . +--width\[aq]s argument, comma-separated: \f[V]--width W,D\f[R] . Here\[aq]s a diagram (won\[aq]t display correctly in --help): .IP .nf @@ -5982,8 +6001,8 @@ $ hledger reg -w $COLUMNS,40 # use terminal width, & description width 40 .fi .PP This command also supports the output destination and output format -options The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R], -and (experimental) \f[C]json\f[R]. +options The output formats supported are \f[V]txt\f[R], \f[V]csv\f[R], +and (experimental) \f[V]json\f[R]. .SS register-match .PP register-match @@ -6048,9 +6067,9 @@ $ hledger rewrite -- \[ha]income --add-posting \[aq](budget:foreign curre \f[R] .fi .PP -Argument for \f[C]--add-posting\f[R] option is a usual posting of +Argument for \f[V]--add-posting\f[R] option is a usual posting of transaction with an exception for amount specification. -More precisely, you can use \f[C]\[aq]*\[aq]\f[R] (star symbol) before +More precisely, you can use \f[V]\[aq]*\[aq]\f[R] (star symbol) before the amount to indicate that that this is a factor for an amount of original matched posting. If the amount includes a commodity name, the new posting amount will be @@ -6082,7 +6101,7 @@ Make contents look like this: \f[R] .fi .PP -Note that \f[C]\[aq]=\[aq]\f[R] (equality symbol) that is used instead +Note that \f[V]\[aq]=\[aq]\f[R] (equality symbol) that is used instead of date in transactions you usually write. It indicates the query by which you want to match the posting to add new ones. @@ -6139,15 +6158,15 @@ Output might look like: \f[R] .fi .PP -If you\[aq]ll pass this through \f[C]patch\f[R] tool you\[aq]ll get +If you\[aq]ll pass this through \f[V]patch\f[R] tool you\[aq]ll get transactions containing the posting that matches your query be updated. Note that multiple files might be update according to list of input -files specified via \f[C]--file\f[R] options and \f[C]include\f[R] +files specified via \f[V]--file\f[R] options and \f[V]include\f[R] directives inside of these files. .PP Be careful. Whole transaction being re-formatted in a style of output from -\f[C]hledger print\f[R]. +\f[V]hledger print\f[R]. .PP See also: .PP @@ -6178,14 +6197,14 @@ Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on your investments. .PP At a minimum, you need to supply a query (which could be just an account -name) to select your investment(s) with \f[C]--inv\f[R], and another +name) to select your investment(s) with \f[V]--inv\f[R], and another query to identify your profit and loss transactions with -\f[C]--pnl\f[R]. +\f[V]--pnl\f[R]. .PP If you do not record changes in the value of your investment manually, or do not require computation of time-weighted return (TWR), -\f[C]--pnl\f[R] could be an empty query (\f[C]--pnl \[dq]\[dq]\f[R] or -\f[C]--pnl STR\f[R] where \f[C]STR\f[R] does not match any of your +\f[V]--pnl\f[R] could be an empty query (\f[V]--pnl \[dq]\[dq]\f[R] or +\f[V]--pnl STR\f[R] where \f[V]STR\f[R] does not match any of your accounts). .PP This command will compute and display the internalized rate of return @@ -6195,7 +6214,7 @@ Both rates of return are annualized before display, regardless of the length of reporting interval. .PP Price directives will be taken into account if you supply appropriate -\f[C]--cost\f[R] or \f[C]--value\f[R] flags (see VALUATION). +\f[V]--cost\f[R] or \f[V]--value\f[R] flags (see VALUATION). .PP Note, in some cases this report can fail, for these reasons: .IP \[bu] 2 @@ -6213,9 +6232,9 @@ Using roi to compute total return of investment in stocks: https://github.com/simonmichael/hledger/blob/master/examples/investing/roi-unrealised.ledger .IP \[bu] 2 Cookbook > Return on Investment: https://hledger.org/roi.html -.SS Spaces and special characters in \f[C]--inv\f[R] and \f[C]--pnl\f[R] +.SS Spaces and special characters in \f[V]--inv\f[R] and \f[V]--pnl\f[R] .PP -Note that \f[C]--inv\f[R] and \f[C]--pnl\f[R]\[aq]s argument is a query, +Note that \f[V]--inv\f[R] and \f[V]--pnl\f[R]\[aq]s argument is a query, and queries could have several space-separated terms (see QUERIES). .PP To indicate that all search terms form single command-line argument, you @@ -6235,15 +6254,15 @@ level of nested quoting, eg: $ hledger roi --inv=\[dq]\[aq]Assets:Test 1\[aq]\[dq] --pnl=\[dq]\[aq]Equity:Unrealized Profit and Loss\[aq]\[dq] \f[R] .fi -.SS Semantics of \f[C]--inv\f[R] and \f[C]--pnl\f[R] +.SS Semantics of \f[V]--inv\f[R] and \f[V]--pnl\f[R] .PP -Query supplied to \f[C]--inv\f[R] has to match all transactions that are +Query supplied to \f[V]--inv\f[R] has to match all transactions that are related to your investment. -Transactions not matching \f[C]--inv\f[R] will be ignored. +Transactions not matching \f[V]--inv\f[R] will be ignored. .PP In these transactions, ROI will conside postings that match -\f[C]--inv\f[R] to be \[dq]investment postings\[dq] and other postings -(not matching \f[C]--inv\f[R]) will be sorted into two categories: +\f[V]--inv\f[R] to be \[dq]investment postings\[dq] and other postings +(not matching \f[V]--inv\f[R]) will be sorted into two categories: \[dq]cash flow\[dq] and \[dq]profit and loss\[dq], as ROI needs to know which part of the investment value is your contributions and which is due to the return on investment. @@ -6280,11 +6299,11 @@ Example: .RE .PP All non-investment postings are assumed to be \[dq]cash flow\[dq], -unless they match \f[C]--pnl\f[R] query. +unless they match \f[V]--pnl\f[R] query. Changes in value of your investment due to \[dq]profit and loss\[dq] postings will be considered as part of your investment return. .PP -Example: if you use \f[C]--inv snake --pnl equity:unrealized\f[R], then +Example: if you use \f[V]--inv snake --pnl equity:unrealized\f[R], then postings in the example below would be classifed as: .IP .nf @@ -6330,8 +6349,8 @@ compound annual rate of return that investment is expected to generate. .PP As mentioned before, in-flows and out-flows would be any cash that you personally put in or withdraw, and for the \[dq]roi\[dq] command, these -are the postings that match the query in the\f[C]--inv\f[R] argument and -NOT match the query in the\f[C]--pnl\f[R] argument. +are the postings that match the query in the\f[V]--inv\f[R] argument and +NOT match the query in the\f[V]--pnl\f[R] argument. .PP If you manually record changes in the value of your investment as transactions that balance them against \[dq]profit and loss\[dq] (or @@ -6346,9 +6365,9 @@ value of all the cash flows of your investment to add up to zero. This could be hard to wrap your head around, especially if you haven\[aq]t done discounted cash flow analysis before. Implementation of IRR in hledger should produce results that match the -\f[C]XIRR\f[R] formula in Excel. +\f[V]XIRR\f[R] formula in Excel. .PP -Second way to compute rate of return that \f[C]roi\f[R] command +Second way to compute rate of return that \f[V]roi\f[R] command implements is called \[dq]time-weighted rate of return\[dq] or \[dq]TWR\[dq]. Like IRR, it will also break the history of your investment into periods @@ -6390,7 +6409,7 @@ of transactions processed per second. Note these are approximate and will vary based on machine, current load, data size, hledger version, haskell lib versions, GHC version.. but they may be of interest. -The \f[C]stats\f[R] command\[aq]s run time is similar to that of a +The \f[V]stats\f[R] command\[aq]s run time is similar to that of a single-column balance report. .PP Example: @@ -6476,16 +6495,16 @@ $ hledger test -- -pData.Amount --color=never .fi .PP For help on these, see https://github.com/feuerbach/tasty#options -(\f[C]-- --help\f[R] currently doesn\[aq]t show them). +(\f[V]-- --help\f[R] currently doesn\[aq]t show them). .SS Add-on commands .PP Add-on commands are programs or scripts in your PATH .IP \[bu] 2 -whose name starts with \f[C]hledger-\f[R] +whose name starts with \f[V]hledger-\f[R] .IP \[bu] 2 whose name ends with a recognised file extension: -\f[C].bat\f[R],\f[C].com\f[R],\f[C].exe\f[R], -\f[C].hs\f[R],\f[C].lhs\f[R],\f[C].pl\f[R],\f[C].py\f[R],\f[C].rb\f[R],\f[C].rkt\f[R],\f[C].sh\f[R] +\f[V].bat\f[R],\f[V].com\f[R],\f[V].exe\f[R], +\f[V].hs\f[R],\f[V].lhs\f[R],\f[V].pl\f[R],\f[V].py\f[R],\f[V].rb\f[R],\f[V].rkt\f[R],\f[V].sh\f[R] or none .IP \[bu] 2 and (on unix, mac) which are executable by the current user. @@ -6499,7 +6518,7 @@ Some experimental/example add-on scripts can be found in the hledger repo\[aq]s bin/ directory. .PP Note in a hledger command line, add-on command flags must have a double -dash (\f[C]--\f[R]) preceding them. +dash (\f[V]--\f[R]) preceding them. Eg you must write: .IP .nf @@ -6516,11 +6535,11 @@ $ hledger web --serve \f[R] .fi .PP -(because the \f[C]--serve\f[R] flag belongs to \f[C]hledger-web\f[R], -not \f[C]hledger\f[R]). +(because the \f[V]--serve\f[R] flag belongs to \f[V]hledger-web\f[R], +not \f[V]hledger\f[R]). .PP -The \f[C]-h/--help\f[R] and \f[C]--version\f[R] flags don\[aq]t require -\f[C]--\f[R]. +The \f[V]-h/--help\f[R] and \f[V]--version\f[R] flags don\[aq]t require +\f[V]--\f[R]. .PP If you have any trouble with this, remember you can always run the add-on program directly, eg: @@ -6537,7 +6556,7 @@ hledger\[aq]s default file format, representing a General Journal. hledger\[aq]s usual data source is a plain text file containing journal entries in hledger journal format. This file represents a standard accounting general journal. -I use file names ending in \f[C].journal\f[R], but that\[aq]s not +I use file names ending in \f[V].journal\f[R], but that\[aq]s not required. The journal file contains a number of transaction entries, each describing a transfer of money (or any commodity) between two or more @@ -6576,7 +6595,7 @@ date in column 0. This can be followed by any of the following optional fields, separated by spaces: .IP \[bu] 2 -a status character (empty, \f[C]!\f[R], or \f[C]*\f[R]) +a status character (empty, \f[V]!\f[R], or \f[V]*\f[R]) .IP \[bu] 2 a code (any short number or text, enclosed in parentheses) .IP \[bu] 2 @@ -6602,13 +6621,13 @@ Here\[aq]s a simple journal file containing one transaction: .SS Simple dates .PP Dates in the journal file use \f[I]simple dates\f[R] format: -\f[C]YYYY-MM-DD\f[R] or \f[C]YYYY/MM/DD\f[R] or \f[C]YYYY.MM.DD\f[R], +\f[V]YYYY-MM-DD\f[R] or \f[V]YYYY/MM/DD\f[R] or \f[V]YYYY.MM.DD\f[R], with leading zeros optional. The year may be omitted, in which case it will be inferred from the context: the current transaction, the default year set with a default year directive, or the current date when the command is run. -Some examples: \f[C]2010-01-31\f[R], \f[C]2010/01/31\f[R], -\f[C]2010.1.31\f[R], \f[C]1/31\f[R]. +Some examples: \f[V]2010-01-31\f[R], \f[V]2010/01/31\f[R], +\f[V]2010.1.31\f[R], \f[V]1/31\f[R]. .PP (The UI also accepts simple dates, as well as the more flexible smart dates documented in the hledger manual.) @@ -6629,8 +6648,8 @@ A secondary date is written after the primary date, following an equals sign. If the year is omitted, the primary date\[aq]s year is assumed. When running reports, the primary (left) date is used by default, but -with the \f[C]--date2\f[R] flag (or \f[C]--aux-date\f[R] or -\f[C]--effective\f[R]), the secondary (right) date will be used instead. +with the \f[V]--date2\f[R] flag (or \f[V]--aux-date\f[R] or +\f[V]--effective\f[R]), the secondary (right) date will be used instead. .PP The meaning of secondary dates is up to you, but it\[aq]s best to follow a consistent rule. @@ -6662,7 +6681,7 @@ $ hledger register checking --date2 .PP You can give individual postings a different date from their parent transaction, by adding a posting comment containing a tag (see below) -like \f[C]date:DATE\f[R]. +like \f[V]date:DATE\f[R]. This is probably the best way to control posting dates precisely. Eg in this example the expense should appear in May reports, and the deduction from checking should be reported on 6/1 for easy bank @@ -6692,16 +6711,16 @@ $ hledger -f t.j register checking .PP DATE should be a simple date; if the year is not specified it will use the year of the transaction\[aq]s date. -You can set the secondary date similarly, with \f[C]date2:DATE2\f[R]. -The \f[C]date:\f[R] or \f[C]date2:\f[R] tags must have a valid simple -date value if they are present, eg a \f[C]date:\f[R] tag with no value +You can set the secondary date similarly, with \f[V]date2:DATE2\f[R]. +The \f[V]date:\f[R] or \f[V]date2:\f[R] tags must have a valid simple +date value if they are present, eg a \f[V]date:\f[R] tag with no value is not allowed. .PP Ledger\[aq]s earlier, more compact bracketed date syntax is also -supported: \f[C][DATE]\f[R], \f[C][DATE=DATE2]\f[R] or -\f[C][=DATE2]\f[R]. +supported: \f[V][DATE]\f[R], \f[V][DATE=DATE2]\f[R] or +\f[V][=DATE2]\f[R]. hledger will attempt to parse any square-bracketed sequence of the -\f[C]0123456789/-.=\f[R] characters in this way. +\f[V]0123456789/-.=\f[R] characters in this way. With this syntax, DATE infers its year from the transaction and DATE2 infers its year from DATE. .SS Status @@ -6726,21 +6745,21 @@ T}@T{ unmarked T} T{ -\f[C]!\f[R] +\f[V]!\f[R] T}@T{ pending T} T{ -\f[C]*\f[R] +\f[V]*\f[R] T}@T{ cleared T} .TE .PP When reporting, you can filter by status with the -\f[C]-U/--unmarked\f[R], \f[C]-P/--pending\f[R], and -\f[C]-C/--cleared\f[R] flags; or the \f[C]status:\f[R], -\f[C]status:!\f[R], and \f[C]status:*\f[R] queries; or the U, P, C keys +\f[V]-U/--unmarked\f[R], \f[V]-P/--pending\f[R], and +\f[V]-C/--cleared\f[R] flags; or the \f[V]status:\f[R], +\f[V]status:!\f[R], and \f[V]status:*\f[R] queries; or the U, P, C keys in hledger-ui. .PP Note, in Ledger and in older versions of hledger, the \[dq]unmarked\[dq] @@ -6787,8 +6806,8 @@ complete, reconciled as far as possible, and considered correct T} .TE .PP -With this scheme, you would use \f[C]-PC\f[R] to see the current balance -at your bank, \f[C]-U\f[R] to see things which will probably hit your +With this scheme, you would use \f[V]-PC\f[R] to see the current balance +at your bank, \f[V]-U\f[R] to see things which will probably hit your bank soon (like uncashed checks), and no flags to see the most up-to-date state of your finances. .SS Code @@ -6806,16 +6825,16 @@ can be used for whatever you wish, or left blank. Transaction descriptions can be queried, unlike comments. .SS Payee and note .PP -You can optionally include a \f[C]|\f[R] (pipe) character in +You can optionally include a \f[V]|\f[R] (pipe) character in descriptions to subdivide the description into separate fields for -payee/payer name on the left (up to the first \f[C]|\f[R]) and an -additional note field on the right (after the first \f[C]|\f[R]). +payee/payer name on the left (up to the first \f[V]|\f[R]) and an +additional note field on the right (after the first \f[V]|\f[R]). This may be worthwhile if you need to do more precise querying and pivoting by payee or by note. .SS Comments .PP -Lines in the journal beginning with a semicolon (\f[C];\f[R]) or hash -(\f[C]#\f[R]) or star (\f[C]*\f[R]) are comments, and will be ignored. +Lines in the journal beginning with a semicolon (\f[V];\f[R]) or hash +(\f[V]#\f[R]) or star (\f[V]*\f[R]) are comments, and will be ignored. (Star comments cause org-mode nodes to be ignored, allowing emacs users to fold and navigate their journals with org-mode or orgstruct-mode.) .PP @@ -6825,7 +6844,7 @@ postings). Similarly, you can attach comments to an individual posting by writing them after the amount and/or indented on the following lines. Transaction and posting comments must begin with a semicolon -(\f[C];\f[R]). +(\f[V];\f[R]). .PP Some examples: .IP @@ -6851,8 +6870,8 @@ end comment \f[R] .fi .PP -You can also comment larger regions of a file using \f[C]comment\f[R] -and \f[C]end comment\f[R] directives. +You can also comment larger regions of a file using \f[V]comment\f[R] +and \f[V]end comment\f[R] directives. .SS Tags .PP Tags are a way to add extra labels or labelled data to transactions, @@ -6879,19 +6898,19 @@ Tags on a transaction affect the transaction and all of its postings .IP \[bu] 2 Tags on an account affect all postings to that account. .PP -So in the example above, - the \f[C]assets:checking\f[R] account has one -tag (\f[C]accounttag\f[R]) - the transaction has two tags -(\f[C]transaction-tag\f[R], \f[C]another-transaction-tag\f[R]) - the -\f[C]assets:checking\f[R] posting has three tags -(\f[C]transaction-tag\f[R], \f[C]another-transaction-tag\f[R], -\f[C]accounttag\f[R]) - the \f[C]expenses:food\f[R] posting has three -tags (\f[C]transaction-tag\f[R], \f[C]another-transaction-tag\f[R], -\f[C]posting-tag\f[R]). +So in the example above, - the \f[V]assets:checking\f[R] account has one +tag (\f[V]accounttag\f[R]) - the transaction has two tags +(\f[V]transaction-tag\f[R], \f[V]another-transaction-tag\f[R]) - the +\f[V]assets:checking\f[R] posting has three tags +(\f[V]transaction-tag\f[R], \f[V]another-transaction-tag\f[R], +\f[V]accounttag\f[R]) - the \f[V]expenses:food\f[R] posting has three +tags (\f[V]transaction-tag\f[R], \f[V]another-transaction-tag\f[R], +\f[V]posting-tag\f[R]). .PP Tags can have a value, which is the text after the colon, until the next comma or end of line, with surrounding whitespace stripped. -So here \f[C]a-posting-tag\f[R]\[aq]s value is \[dq]the tag value\[dq], -\f[C]tag2\f[R]\[aq]s value is \[dq]foo\[dq], and \f[C]tag3\f[R]\[aq]s +So here \f[V]a-posting-tag\f[R]\[aq]s value is \[dq]the tag value\[dq], +\f[V]tag2\f[R]\[aq]s value is \[dq]foo\[dq], and \f[V]tag3\f[R]\[aq]s value is \[dq]\[dq] (the empty string): .IP .nf @@ -6909,7 +6928,7 @@ from, an account. Each posting line begins with at least one space or tab (2 or 4 spaces is common), followed by: .IP \[bu] 2 -(optional) a status character (empty, \f[C]!\f[R], or \f[C]*\f[R]), +(optional) a status character (empty, \f[V]!\f[R], or \f[V]*\f[R]), followed by a space .IP \[bu] 2 (required) an account name (any text, optionally containing \f[B]single @@ -6972,17 +6991,17 @@ Eg: Ordinary non-parenthesised, non-bracketed postings are called \f[I]real postings\f[R]. You can exclude virtual postings from reports with the -\f[C]-R/--real\f[R] flag or \f[C]real:1\f[R] query. +\f[V]-R/--real\f[R] flag or \f[V]real:1\f[R] query. .SS Account names .PP Account names typically have several parts separated by a full colon, from which hledger derives a hierarchical chart of accounts. They can be anything you like, but in finance there are traditionally -five top-level accounts: \f[C]assets\f[R], \f[C]liabilities\f[R], -\f[C]revenue\f[R], \f[C]expenses\f[R], and \f[C]equity\f[R]. +five top-level accounts: \f[V]assets\f[R], \f[V]liabilities\f[R], +\f[V]revenue\f[R], \f[V]expenses\f[R], and \f[V]equity\f[R]. .PP Account names may contain single spaces, eg: -\f[C]assets:accounts receivable\f[R]. +\f[V]assets:accounts receivable\f[R]. Because of this, they must always be followed by \f[B]two or more spaces\f[R] (or newline). .PP @@ -7087,8 +7106,8 @@ To prevent confusing parsing mistakes and undetected typos, especially if your data contains digit group marks (eg, thousands separators), we recommend explicitly declaring the decimal mark character in each journal file, using a directive at the top of the file. -The \f[C]decimal-mark\f[R] directive is best, otherwise -\f[C]commodity\f[R] directives will also work. +The \f[V]decimal-mark\f[R] directive is best, otherwise +\f[V]commodity\f[R] directives will also work. These are described detail below. .SS Commodity .PP @@ -7099,25 +7118,25 @@ tracking. .PP If the commodity name contains non-letters (spaces, numbers, or punctuation), you must always write it inside double quotes -(\f[C]\[dq]green apples\[dq]\f[R], \f[C]\[dq]ABC123\[dq]\f[R]). +(\f[V]\[dq]green apples\[dq]\f[R], \f[V]\[dq]ABC123\[dq]\f[R]). .PP If you write just a bare number, that too will have a commodity, with -name \f[C]\[dq]\[dq]\f[R]; we call that the \[dq]no-symbol +name \f[V]\[dq]\[dq]\f[R]; we call that the \[dq]no-symbol commodity\[dq]. .PP Actually, hledger combines these single-commodity amounts into more powerful multi-commodity amounts, which are what it works with most of the time. A multi-commodity amount could be, eg: -\f[C]1 USD, 2 EUR, 3.456 TSLA\f[R]. +\f[V]1 USD, 2 EUR, 3.456 TSLA\f[R]. In practice, you will only see multi-commodity amounts in hledger\[aq]s output; you can\[aq]t write them directly in the journal file. .PP (If you are writing scripts or working with hledger\[aq]s internals, -these are the \f[C]Amount\f[R] and \f[C]MixedAmount\f[R] types.) +these are the \f[V]Amount\f[R] and \f[V]MixedAmount\f[R] types.) .SS Directives influencing number parsing and display .PP -You can add \f[C]decimal-mark\f[R] and \f[C]commodity\f[R] directives to +You can add \f[V]decimal-mark\f[R] and \f[V]commodity\f[R] directives to the journal, to declare and control these things more explicitly and precisely. These are described below, in JOURNAL FORMAT -> Declaring commodities. @@ -7141,12 +7160,12 @@ commodity 1 000 000.9455 For the amounts in each commodity, hledger chooses a consistent display style to use in most reports. (Exceptions: price amounts, and all amounts displayed by the -\f[C]print\f[R] command, are displayed with all of their decimal digits +\f[V]print\f[R] command, are displayed with all of their decimal digits visible.) .PP A commodity\[aq]s display style is inferred as follows. .PP -First, if a default commodity is declared with \f[C]D\f[R], this +First, if a default commodity is declared with \f[V]D\f[R], this commodity and its style is applied to any no-symbol amounts in the journal. .PP @@ -7160,7 +7179,7 @@ The amounts in that commodity seen in the journal\[aq]s transactions. (Posting amounts only; prices and periodic or auto rules are ignored, currently.) .IP \[bu] 2 -The built-in fallback style, which looks like this: \f[C]$1000.00\f[R]. +The built-in fallback style, which looks like this: \f[V]$1000.00\f[R]. (Symbol on the left, period decimal mark, two decimal places.) .PP A style is inferred from journal amounts as follows: @@ -7180,7 +7199,7 @@ If you find this causing problems, use a commodity directive to fix the display style. .PP To summarise: each commodity\[aq]s amounts will be normalised to (a) the -style declared by a \f[C]commodity\f[R] directive, or (b) the style of +style declared by a \f[V]commodity\f[R] directive, or (b) the style of the first posting amount in the journal, with the first-seen digit group style and the maximum-seen number of decimal places. So if your reports are showing amounts in a way you don\[aq]t like, eg @@ -7214,8 +7233,8 @@ hledger was built with Decimal < 0.5.1.) (AKA Costs) .PP After a posting amount, you can note its cost or selling price in -another commodity, by writing either \f[C]\[at] UNITPRICE\f[R] or -\f[C]\[at]\[at] TOTALPRICE\f[R] after it. +another commodity, by writing either \f[V]\[at] UNITPRICE\f[R] or +\f[V]\[at]\[at] TOTALPRICE\f[R] after it. This indicates a conversion transaction, where one commodity is exchanged for another. .PP @@ -7226,8 +7245,8 @@ are not. feature can represent either a buyer\[aq]s cost, or a seller\[aq]s price. .PP -Costs are usually written explicitly with \f[C]\[at]\f[R] or -\f[C]\[at]\[at]\f[R], but can also be inferred automatically for simple +Costs are usually written explicitly with \f[V]\[at]\f[R] or +\f[V]\[at]\[at]\f[R], but can also be inferred automatically for simple multi-commodity transactions. .PD 0 .P @@ -7236,7 +7255,7 @@ As an example, here are several ways to record purchases of a foreign currency in hledger, using the cost notation either explicitly or implicitly: .IP "1." 3 -Write the price per unit, as \f[C]\[at] UNITPRICE\f[R] after the amount: +Write the price per unit, as \f[V]\[at] UNITPRICE\f[R] after the amount: .RS 4 .IP .nf @@ -7248,7 +7267,7 @@ Write the price per unit, as \f[C]\[at] UNITPRICE\f[R] after the amount: .fi .RE .IP "2." 3 -Write the total price, as \f[C]\[at]\[at] TOTALPRICE\f[R] after the +Write the total price, as \f[V]\[at]\[at] TOTALPRICE\f[R] after the amount: .RS 4 .IP @@ -7274,21 +7293,21 @@ hledger infer the price that balances the transaction: .fi .RE .IP "4." 3 -Like 1, but the \f[C]\[at]\f[R] is parenthesised, i.e. -\f[C](\[at])\f[R]; this is for compatibility with Ledger journals +Like 1, but the \f[V]\[at]\f[R] is parenthesised, i.e. +\f[V](\[at])\f[R]; this is for compatibility with Ledger journals (Virtual posting costs), and is equivalent to 1 in hledger. .IP "5." 3 -Like 2, but as in 4 the \f[C]\[at]\[at]\f[R] is parenthesised, i.e. -\f[C](\[at]\[at])\f[R]; in hledger, this is equivalent to 2. +Like 2, but as in 4 the \f[V]\[at]\[at]\f[R] is parenthesised, i.e. +\f[V](\[at]\[at])\f[R]; in hledger, this is equivalent to 2. .PP Amounts can be converted to cost at report time using the -\f[C]-B/--cost\f[R] flag; this is discussed more in the COST section. +\f[V]-B/--cost\f[R] flag; this is discussed more in the COST section. .SS Lot prices, lot dates .PP Ledger allows another kind of price, lot price (four variants: -\f[C]{UNITPRICE}\f[R], \f[C]{{TOTALPRICE}}\f[R], -\f[C]{=FIXEDUNITPRICE}\f[R], \f[C]{{=FIXEDTOTALPRICE}}\f[R]), and/or a -lot date (\f[C][DATE]\f[R]) to be specified. +\f[V]{UNITPRICE}\f[R], \f[V]{{TOTALPRICE}}\f[R], +\f[V]{=FIXEDUNITPRICE}\f[R], \f[V]{{=FIXEDTOTALPRICE}}\f[R]), and/or a +lot date (\f[V][DATE]\f[R]) to be specified. These are normally used to select a lot when selling investments. hledger will parse these, for compatibility with Ledger journals, but currently ignores them. @@ -7297,7 +7316,7 @@ after the posting amount and before the balance assertion if any. .SS Balance assertions .PP hledger supports Ledger-style balance assertions in journal files. -These look like, for example, \f[C]= EXPECTEDBALANCE\f[R] following a +These look like, for example, \f[V]= EXPECTEDBALANCE\f[R] following a posting\[aq]s amount. Eg here we assert the expected dollar balance in accounts a and b after each posting: @@ -7319,7 +7338,7 @@ and report an error if any of them fail. Balance assertions can protect you from, eg, inadvertently disrupting reconciled balances while cleaning up old entries. You can disable them temporarily with the -\f[C]-I/--ignore-assertions\f[R] flag, which can be useful for +\f[V]-I/--ignore-assertions\f[R] flag, which can be useful for troubleshooting or for reading Ledger files. (Note: this flag currently does not disable balance assignments, below). .SS Assertions and ordering @@ -7340,7 +7359,7 @@ order of postings and assertions within a day, so you can assert intra-day balances. .SS Assertions and multiple included files .PP -Multiple files included with the \f[C]include\f[R] directive are +Multiple files included with the \f[V]include\f[R] directive are processed as if concatenated into one file, preserving their order and the posting order within each file. It means that balance assertions in later files will see balance from @@ -7352,14 +7371,14 @@ on that day, you\[aq]ll need to put the assertion in the right file - the last one in the sequence, probably. .SS Assertions and multiple -f files .PP -Unlike \f[C]include\f[R], when multiple files are specified on the -command line with multiple \f[C]-f/--file\f[R] options, balance +Unlike \f[V]include\f[R], when multiple files are specified on the +command line with multiple \f[V]-f/--file\f[R] options, balance assertions will not see balance from earlier files. This can be useful when you do not want problems in earlier files to disrupt valid assertions in later files. .PP If you do want assertions to see balance from earlier files, use -\f[C]include\f[R], or concatenate the files temporarily. +\f[V]include\f[R], or concatenate the files temporarily. .SS Assertions and commodities .PP The asserted balance must be a simple single-commodity amount, and in @@ -7372,7 +7391,7 @@ To assert the balance of more than one commodity in an account, you can write multiple postings, each asserting one commodity\[aq]s balance. .PP You can make a stronger \[dq]total\[dq] balance assertion by writing a -double equals sign (\f[C]== EXPECTEDBALANCE\f[R]). +double equals sign (\f[V]== EXPECTEDBALANCE\f[R]). This asserts that there are no other commodities in the account besides the asserted one (or at least, that their balance is 0). .IP @@ -7431,11 +7450,11 @@ generate balance assertions with prices), and because balance \f[I]assignments\f[R] do use them (see below). .SS Assertions and subaccounts .PP -The balance assertions above (\f[C]=\f[R] and \f[C]==\f[R]) do not count +The balance assertions above (\f[V]=\f[R] and \f[V]==\f[R]) do not count the balance from subaccounts; they check the account\[aq]s exclusive balance only. -You can assert the balance including subaccounts by writing \f[C]=*\f[R] -or \f[C]==*\f[R], eg: +You can assert the balance including subaccounts by writing \f[V]=*\f[R] +or \f[V]==*\f[R], eg: .IP .nf \f[C] @@ -7449,22 +7468,22 @@ or \f[C]==*\f[R], eg: .SS Assertions and virtual postings .PP Balance assertions always consider both real and virtual postings; they -are not affected by the \f[C]--real/-R\f[R] flag or \f[C]real:\f[R] +are not affected by the \f[V]--real/-R\f[R] flag or \f[V]real:\f[R] query. .SS Assertions and auto postings .PP -Balance assertions \f[I]are\f[R] affected by the \f[C]--auto\f[R] flag, +Balance assertions \f[I]are\f[R] affected by the \f[V]--auto\f[R] flag, which generates auto postings, which can alter account balances. Because auto postings are optional in hledger, accounts affected by them effectively have two balances. But balance assertions can only test one or the other of these. So to avoid making fragile assertions, either: .IP \[bu] 2 -assert the balance calculated with \f[C]--auto\f[R], and always use -\f[C]--auto\f[R] with that file +assert the balance calculated with \f[V]--auto\f[R], and always use +\f[V]--auto\f[R] with that file .IP \[bu] 2 -or assert the balance calculated without \f[C]--auto\f[R], and never use -\f[C]--auto\f[R] with that file +or assert the balance calculated without \f[V]--auto\f[R], and never use +\f[V]--auto\f[R] with that file .IP \[bu] 2 or avoid balance assertions on accounts affected by auto postings (or avoid auto postings entirely). @@ -7576,34 +7595,34 @@ T{ Declare a commodity\[aq]s or file\[aq]s decimal mark to help parse amounts accurately T}@T{ -\f[C]commodity\f[R], \f[C]D\f[R], \f[C]decimal-mark\f[R] +\f[V]commodity\f[R], \f[V]D\f[R], \f[V]decimal-mark\f[R] T}@T{ T} T{ Apply changes to the data while parsing T}@T{ -\f[C]alias\f[R], \f[C]apply account\f[R], \f[C]comment\f[R], -\f[C]D\f[R], \f[C]Y\f[R] +\f[V]alias\f[R], \f[V]apply account\f[R], \f[V]comment\f[R], +\f[V]D\f[R], \f[V]Y\f[R] T}@T{ -\f[C]--alias\f[R] +\f[V]--alias\f[R] T} T{ Inline extra data files T}@T{ -\f[C]include\f[R] +\f[V]include\f[R] T}@T{ -multiple \f[C]-f/--file\f[R]\[aq]s +multiple \f[V]-f/--file\f[R]\[aq]s T} T{ Generate extra transactions or budget goals T}@T{ -\f[C]\[ti]\f[R] +\f[V]\[ti]\f[R] T}@T{ T} T{ Generate extra postings T}@T{ -\f[C]=\f[R] +\f[V]=\f[R] T}@T{ T} T{ @@ -7614,7 +7633,7 @@ T} T{ Define valid entities to allow stricter error checking T}@T{ -\f[C]account\f[R], \f[C]commodity\f[R], \f[C]payee\f[R] +\f[V]account\f[R], \f[V]commodity\f[R], \f[V]payee\f[R] T}@T{ T} T{ @@ -7625,15 +7644,15 @@ T} T{ Declare accounts\[aq] display order and accounting type T}@T{ -\f[C]account\f[R] +\f[V]account\f[R] T}@T{ T} T{ Declare commodity display styles T}@T{ -\f[C]commodity\f[R], \f[C]D\f[R] +\f[V]commodity\f[R], \f[V]D\f[R] T}@T{ -\f[C]-c/--commodity-style\f[R] +\f[V]-c/--commodity-style\f[R] T} .TE .PP @@ -7651,7 +7670,7 @@ ends at file end? T} _ T{ -\f[B]\f[CB]account\f[B]\f[R] +\f[B]\f[VB]account\f[B]\f[R] T}@T{ Declares an account, for checking all entries in all files; and its display order and type, for reports. @@ -7659,42 +7678,42 @@ Subdirectives: any text, ignored. T}@T{ T} T{ -\f[B]\f[CB]alias\f[B]\f[R] +\f[B]\f[VB]alias\f[B]\f[R] T}@T{ Rewrites account names, in following entries until end of current file -or \f[C]end aliases\f[R]. +or \f[V]end aliases\f[R]. T}@T{ Y T} T{ -\f[B]\f[CB]apply account\f[B]\f[R] +\f[B]\f[VB]apply account\f[B]\f[R] T}@T{ Prepends a common parent account to all account names, in following -entries until end of current file or \f[C]end apply account\f[R]. +entries until end of current file or \f[V]end apply account\f[R]. T}@T{ Y T} T{ -\f[B]\f[CB]comment\f[B]\f[R] +\f[B]\f[VB]comment\f[B]\f[R] T}@T{ Ignores part of the journal file, until end of current file or -\f[C]end comment\f[R]. +\f[V]end comment\f[R]. T}@T{ Y T} T{ -\f[B]\f[CB]commodity\f[B]\f[R] +\f[B]\f[VB]commodity\f[B]\f[R] T}@T{ Declares a commodity, for checking all entries in all files; the decimal mark for parsing amounts of this commodity, for following entries until end of current file; and its display style, for reports. -Takes precedence over \f[C]D\f[R]. -Subdirectives: \f[C]format\f[R] (alternate syntax). +Takes precedence over \f[V]D\f[R]. +Subdirectives: \f[V]format\f[R] (alternate syntax). T}@T{ N, Y T} T{ -\f[B]\f[CB]D\f[B]\f[R] +\f[B]\f[VB]D\f[B]\f[R] T}@T{ Sets a default commodity to use for no-symbol amounts, and its decimal mark for parsing amounts of this commodity in following entries until @@ -7703,38 +7722,38 @@ T}@T{ Y T} T{ -\f[B]\f[CB]decimal-mark\f[B]\f[R] +\f[B]\f[VB]decimal-mark\f[B]\f[R] T}@T{ Declares the decimal mark, for parsing amounts of all commodities in -following entries until next \f[C]decimal-mark\f[R] or end of current +following entries until next \f[V]decimal-mark\f[R] or end of current file. Included files can override. -Takes precedence over \f[C]commodity\f[R] and \f[C]D\f[R]. +Takes precedence over \f[V]commodity\f[R] and \f[V]D\f[R]. T}@T{ Y T} T{ -\f[B]\f[CB]include\f[B]\f[R] +\f[B]\f[VB]include\f[B]\f[R] T}@T{ Includes entries and directives from another file, as if they were written inline. T}@T{ T} T{ -\f[B]\f[CB]payee\f[B]\f[R] +\f[B]\f[VB]payee\f[B]\f[R] T}@T{ Declares a payee name, for checking all entries in all files. T}@T{ T} T{ -\f[B]\f[CB]P\f[B]\f[R] +\f[B]\f[VB]P\f[B]\f[R] T}@T{ Declares a market price for a commodity on some date, for valuation reports. T}@T{ T} T{ -\f[B]\f[CB]Y\f[B]\f[R] +\f[B]\f[VB]Y\f[B]\f[R] T}@T{ Declares a year for yearless dates, for following entries until end of current file. @@ -7742,18 +7761,18 @@ T}@T{ Y T} T{ -\f[B]\f[CB]\[ti]\f[B]\f[R] (tilde) +\f[B]\f[VB]\[ti]\f[B]\f[R] (tilde) T}@T{ Declares a periodic transaction rule that generates future transactions -with \f[C]--forecast\f[R] and budget goals with -\f[C]balance --budget\f[R]. +with \f[V]--forecast\f[R] and budget goals with +\f[V]balance --budget\f[R]. T}@T{ T} T{ -\f[B]\f[CB]=\f[B]\f[R] (equals) +\f[B]\f[VB]=\f[B]\f[R] (equals) T}@T{ Declares an auto posting rule that generates extra postings on matched -transactions with \f[C]--auto\f[R], in current, parent, and child files +transactions with \f[V]--auto\f[R], in current, parent, and child files (but not sibling files, see #1212). T}@T{ partly @@ -7761,8 +7780,8 @@ T} .TE .SS Directives and multiple files .PP -If you use multiple \f[C]-f\f[R]/\f[C]--file\f[R] options, or the -\f[C]include\f[R] directive, hledger will process multiple input files. +If you use multiple \f[V]-f\f[R]/\f[V]--file\f[R] options, or the +\f[V]include\f[R] directive, hledger will process multiple input files. But directives which affect input typically have effect only until the end of the file in which they occur (and on any included files in that region). @@ -7773,12 +7792,12 @@ Otherwise you could see different numbers if you happened to write -f options in a different order, or if you moved includes around while cleaning up your files. .PP -It can be surprising though; for example, it means that \f[C]alias\f[R] +It can be surprising though; for example, it means that \f[V]alias\f[R] directives do not affect parent or sibling files (see below). .SS Comment blocks .PP -A line containing just \f[C]comment\f[R] starts a commented region of -the file, and a line containing just \f[C]end comment\f[R] (or the end +A line containing just \f[V]comment\f[R] starts a commented region of +the file, and a line containing just \f[V]end comment\f[R] (or the end of the current file) ends it. See also comments. .SS Including other files @@ -7798,25 +7817,25 @@ files can be included (not CSV files, currently). If the file path does not begin with a slash, it is relative to the current file\[aq]s folder. .PP -A tilde means home directory, eg: \f[C]include \[ti]/main.journal\f[R]. +A tilde means home directory, eg: \f[V]include \[ti]/main.journal\f[R]. .PP The path may contain glob patterns to match multiple files, eg: -\f[C]include *.journal\f[R]. +\f[V]include *.journal\f[R]. .PP -There is limited support for recursive wildcards: \f[C]**/\f[R] (the +There is limited support for recursive wildcards: \f[V]**/\f[R] (the slash is required) matches 0 or more subdirectories. It\[aq]s not super convenient since you have to avoid include cycles and including directories, but this can be done, eg: -\f[C]include */**/*.journal\f[R]. +\f[V]include */**/*.journal\f[R]. .PP The path may also be prefixed to force a specific file format, overriding the file extension (as described in hledger.1 -> Input -files): \f[C]include timedot:\[ti]/notes/2020*.md\f[R]. +files): \f[V]include timedot:\[ti]/notes/2020*.md\f[R]. .SS Default year .PP You can set a default year to be used for subsequent dates which don\[aq]t specify a year. -This is a line beginning with \f[C]Y\f[R] followed by the year. +This is a line beginning with \f[V]Y\f[R] followed by the year. Eg: .IP .nf @@ -7840,7 +7859,7 @@ Y2010 ; change default year to 2010 .fi .SS Declaring payees .PP -The \f[C]payee\f[R] directive can be used to declare a limited set of +The \f[V]payee\f[R] directive can be used to declare a limited set of payees which may appear in transaction descriptions. The \[dq]payees\[dq] check will report an error if any transaction refers to a payee that has not been declared. @@ -7853,7 +7872,7 @@ payee Whole Foods .fi .SS Declaring the decimal mark .PP -You can use a \f[C]decimal-mark\f[R] directive - usually one per file, +You can use a \f[V]decimal-mark\f[R] directive - usually one per file, at the top of the file - to declare which character represents a decimal mark when parsing amounts in this file. It can look like @@ -7877,8 +7896,8 @@ recommend it, especially if the file contains digit group marks (eg thousands separators). .SS Declaring commodities .PP -You can use \f[C]commodity\f[R] directives to declare your commodities. -In fact the \f[C]commodity\f[R] directive performs several functions at +You can use \f[V]commodity\f[R] directives to declare your commodities. +In fact the \f[V]commodity\f[R] directive performs several functions at once: .IP "1." 3 It declares commodities which may be used in the journal. @@ -7888,8 +7907,8 @@ This can optionally be enforced, providing useful error checking. It declares which decimal mark character (period or comma), to expect when parsing input - useful to disambiguate international number formats in your data. -Without this, hledger will parse both \f[C]1,000\f[R] and -\f[C]1.000\f[R] as 1. +Without this, hledger will parse both \f[V]1,000\f[R] and +\f[V]1.000\f[R] as 1. (Cf Amounts) .IP "3." 3 It declares how to render the commodity\[aq]s amounts when displaying @@ -7904,7 +7923,7 @@ parsing and display. Generally you should put them at the top of your journal file (since for function 2, they affect only following amounts, cf #793). .PP -A commodity directive is just the word \f[C]commodity\f[R] followed by a +A commodity directive is just the word \f[V]commodity\f[R] followed by a sample amount, like this: .IP .nf @@ -7916,7 +7935,7 @@ commodity 1,000.0000 AAAA ; optional same-line comment \f[R] .fi .PP -It may also be written on multiple lines, and use the \f[C]format\f[R] +It may also be written on multiple lines, and use the \f[V]format\f[R] subdirective, as in Ledger. Note in this case the commodity symbol appears twice; it must be the same in both places: @@ -7962,31 +7981,31 @@ Even in the presence of commodity directives, the commodity display style can still be overridden by supplying a command line option. .SS Commodity error checking .PP -In strict mode, enabled with the \f[C]-s\f[R]/\f[C]--strict\f[R] flag, +In strict mode, enabled with the \f[V]-s\f[R]/\f[V]--strict\f[R] flag, hledger will report an error if a commodity symbol is used that has not -been declared by a \f[C]commodity\f[R] directive. +been declared by a \f[V]commodity\f[R] directive. This works similarly to account error checking, see the notes there for more details. .PP Note, this disallows amounts without a commodity symbol, because -currently it\[aq]s not possible (?) to declare the \[dq]no-symbol\[dq] -commodity with a directive. +currently it\[aq]s not possible (?) +to declare the \[dq]no-symbol\[dq] commodity with a directive. This is one exception for convenience: zero amounts are always allowed to have no commodity symbol. .SS Default commodity .PP -The \f[C]D\f[R] directive sets a default commodity, to be used for any +The \f[V]D\f[R] directive sets a default commodity, to be used for any subsequent commodityless amounts (ie, plain numbers) seen while parsing the journal. -This effect lasts until the next \f[C]D\f[R] directive, or the end of +This effect lasts until the next \f[V]D\f[R] directive, or the end of the journal. .PP -For compatibility/historical reasons, \f[C]D\f[R] also acts like a -\f[C]commodity\f[R] directive (setting the commodity\[aq]s decimal mark +For compatibility/historical reasons, \f[V]D\f[R] also acts like a +\f[V]commodity\f[R] directive (setting the commodity\[aq]s decimal mark for parsing and display style for output). .PP -The syntax is \f[C]D AMOUNT\f[R]. -As with \f[C]commodity\f[R], the amount must include a decimal mark +The syntax is \f[V]D AMOUNT\f[R]. +As with \f[V]commodity\f[R], the amount must include a decimal mark (either period or comma). Eg: .IP @@ -8002,21 +8021,21 @@ D $1,000.00 \f[R] .fi .PP -If both \f[C]commodity\f[R] and \f[C]D\f[R] directives are found for a -commodity, \f[C]commodity\f[R] takes precedence for setting decimal mark +If both \f[V]commodity\f[R] and \f[V]D\f[R] directives are found for a +commodity, \f[V]commodity\f[R] takes precedence for setting decimal mark and display style. .PP -If you are using \f[C]D\f[R] and also checking commodities, you will -need to add a \f[C]commodity\f[R] directive similar to the \f[C]D\f[R]. -(The \f[C]hledger check commodities\f[R] command expects -\f[C]commodity\f[R] directives, and ignores \f[C]D\f[R]). +If you are using \f[V]D\f[R] and also checking commodities, you will +need to add a \f[V]commodity\f[R] directive similar to the \f[V]D\f[R]. +(The \f[V]hledger check commodities\f[R] command expects +\f[V]commodity\f[R] directives, and ignores \f[V]D\f[R]). .SS Declaring market prices .PP -The \f[C]P\f[R] directive declares a market price, which is an exchange +The \f[V]P\f[R] directive declares a market price, which is an exchange rate between two commodities on a certain date. -(In Ledger, they are called \[dq]historical prices\[dq].) These are -often obtained from a stock exchange, cryptocurrency exchange, or the -foreign exchange market. +(In Ledger, they are called \[dq]historical prices\[dq].) +These are often obtained from a stock exchange, cryptocurrency exchange, +or the foreign exchange market. .PP The format is: .IP @@ -8041,12 +8060,12 @@ P 2010-01-01 \[Eu] $1.40 \f[R] .fi .PP -The \f[C]-V\f[R], \f[C]-X\f[R] and \f[C]--value\f[R] flags use these +The \f[V]-V\f[R], \f[V]-X\f[R] and \f[V]--value\f[R] flags use these market prices to show amount values in another commodity. See Valuation. .SS Declaring accounts .PP -\f[C]account\f[R] directives can be used to declare accounts (ie, the +\f[V]account\f[R] directives can be used to declare accounts (ie, the places that amounts are transferred from and to). Though not required, these declarations can provide several benefits: .IP \[bu] 2 @@ -8069,7 +8088,7 @@ They can help hledger know your accounts\[aq] types (asset, liability, equity, revenue, expense), affecting reports like balancesheet and incomestatement. .PP -They are written as the word \f[C]account\f[R] followed by a +They are written as the word \f[V]account\f[R] followed by a hledger-style account name, eg: .IP .nf @@ -8082,11 +8101,11 @@ account assets:bank:checking Comments, beginning with a semicolon: .IP \[bu] 2 can be written on the same line, but only after \f[B]two or more -spaces\f[R] (because \f[C];\f[R] is allowed in account names) +spaces\f[R] (because \f[V];\f[R] is allowed in account names) .IP \[bu] 2 and/or on the next lines, indented .IP \[bu] 2 -and may contain tags, such as the \f[C]type:\f[R] tag. +and may contain tags, such as the \f[V]type:\f[R] tag. .PP For example: .IP @@ -8117,7 +8136,7 @@ mis-spell an account name in the journal. Usually you\[aq]ll find that error later, as an extra account in balance reports, or an incorrect balance when reconciling. .PP -In strict mode, enabled with the \f[C]-s\f[R]/\f[C]--strict\f[R] flag, +In strict mode, enabled with the \f[V]-s\f[R]/\f[V]--strict\f[R] flag, hledger will report an error if any transaction uses an account name that has not been declared by an account directive. Some notes: @@ -8132,7 +8151,7 @@ includes, but not parent or sibling files. The position of account directives within the file does not matter, though it\[aq]s usual to put them at the top. .IP \[bu] 2 -Accounts can only be declared in \f[C]journal\f[R] files, but will +Accounts can only be declared in \f[V]journal\f[R] files, but will affect included files of all types. .IP \[bu] 2 It\[aq]s currently not possible to declare \[dq]all possible @@ -8180,51 +8199,51 @@ account other:zoo \f[R] .fi .PP -would influence the position of \f[C]zoo\f[R] among -\f[C]other\f[R]\[aq]s subaccounts, but not the position of -\f[C]other\f[R] among the top-level accounts. +would influence the position of \f[V]zoo\f[R] among +\f[V]other\f[R]\[aq]s subaccounts, but not the position of +\f[V]other\f[R] among the top-level accounts. This means: .IP \[bu] 2 -you will sometimes declare parent accounts (eg \f[C]account other\f[R] +you will sometimes declare parent accounts (eg \f[V]account other\f[R] above) that you don\[aq]t intend to post to, just to customize their display order .IP \[bu] 2 -sibling accounts stay together (you couldn\[aq]t display \f[C]x:y\f[R] -in between \f[C]a:b\f[R] and \f[C]a:c\f[R]). +sibling accounts stay together (you couldn\[aq]t display \f[V]x:y\f[R] +in between \f[V]a:b\f[R] and \f[V]a:c\f[R]). .SS Account types .PP hledger knows that accounts come in several types: assets, liabilities, expenses and so on. This enables easy reports like balancesheet and incomestatement, and -filtering by account type with the \f[C]type:\f[R] query. +filtering by account type with the \f[V]type:\f[R] query. .PP As a convenience, hledger will detect these account types automatically if you are using common english-language top-level account names (described below). But generally we recommend you declare types explicitly, by adding a -\f[C]type:\f[R] tag to your top-level account directives. +\f[V]type:\f[R] tag to your top-level account directives. Subaccounts will inherit the type of their parent. The tag\[aq]s value should be one of the five main account types: .IP \[bu] 2 -\f[C]A\f[R] or \f[C]Asset\f[R] (things you own) +\f[V]A\f[R] or \f[V]Asset\f[R] (things you own) .IP \[bu] 2 -\f[C]L\f[R] or \f[C]Liability\f[R] (things you owe) +\f[V]L\f[R] or \f[V]Liability\f[R] (things you owe) .IP \[bu] 2 -\f[C]E\f[R] or \f[C]Equity\f[R] (investment/ownership; balanced +\f[V]E\f[R] or \f[V]Equity\f[R] (investment/ownership; balanced counterpart of assets & liabilities) .IP \[bu] 2 -\f[C]R\f[R] or \f[C]Revenue\f[R] (what you received money from, AKA +\f[V]R\f[R] or \f[V]Revenue\f[R] (what you received money from, AKA income; technically part of Equity) .IP \[bu] 2 -\f[C]X\f[R] or \f[C]Expense\f[R] (what you spend money on; technically +\f[V]X\f[R] or \f[V]Expense\f[R] (what you spend money on; technically part of Equity) .PP or, it can be (these are used less often): .IP \[bu] 2 -\f[C]C\f[R] or \f[C]Cash\f[R] (a subtype of Asset, indicating liquid +\f[V]C\f[R] or \f[V]Cash\f[R] (a subtype of Asset, indicating liquid assets for the cashflow report) .IP \[bu] 2 -\f[C]V\f[R] or \f[C]Conversion\f[R] (a subtype of Equity, for +\f[V]V\f[R] or \f[V]Conversion\f[R] (a subtype of Equity, for conversions (see COST).) .PP Here is a typical set of account type declarations: @@ -8282,9 +8301,9 @@ More precisely, an account\[aq]s type is decided by the first of these that exists: .RS 2 .IP "1." 3 -A \f[C]type:\f[R] declaration for this account. +A \f[V]type:\f[R] declaration for this account. .IP "2." 3 -A \f[C]type:\f[R] declaration in the parent accounts above it, +A \f[V]type:\f[R] declaration in the parent accounts above it, preferring the nearest. .IP "3." 3 An account type inferred from this account\[aq]s name. @@ -8333,7 +8352,7 @@ invalid account names with them; more on this below. See also Rewrite account names. .SS Basic aliases .PP -To set an account alias, use the \f[C]alias\f[R] directive in your +To set an account alias, use the \f[V]alias\f[R] directive in your journal file. This affects all subsequent journal entries in the current file or its included files (but note: not sibling or parent files). @@ -8345,7 +8364,7 @@ alias OLD = NEW \f[R] .fi .PP -Or, you can use the \f[C]--alias \[aq]OLD=NEW\[aq]\f[R] option on the +Or, you can use the \f[V]--alias \[aq]OLD=NEW\[aq]\f[R] option on the command line. This affects all entries. It\[aq]s useful for trying out aliases interactively. @@ -8390,7 +8409,7 @@ REPLACEMENT. REGEX is case-insensitive as usual. .PP If you need to match a forward slash, escape it with a backslash, eg -\f[C]/\[rs]/=:\f[R]. +\f[V]/\[rs]/=:\f[R]. .PP If REGEX contains parenthesised match groups, these can be referenced by the usual backslash and number in REPLACEMENT: @@ -8417,10 +8436,10 @@ In such cases it can be important to understand which aliases will be applied and in which order. For (each account name in) each journal entry, we apply: .IP "1." 3 -\f[C]alias\f[R] directives preceding the journal entry, most recently +\f[V]alias\f[R] directives preceding the journal entry, most recently parsed first (ie, reading upward from the journal entry, bottom to top) .IP "2." 3 -\f[C]--alias\f[R] options, in the order they appeared on the command +\f[V]--alias\f[R] options, in the order they appeared on the command line (left to right). .PP In other words, for (an account name in) a given journal entry: @@ -8435,11 +8454,11 @@ This gives nearby aliases precedence over distant ones, and helps provide semantic stability - aliases will keep working the same way independent of which files are being read and in which order. .PP -In case of trouble, adding \f[C]--debug=6\f[R] to the command line will +In case of trouble, adding \f[V]--debug=6\f[R] to the command line will show which aliases are being applied when. .SS Aliases and multiple files .PP -As explained at Directives and multiple files, \f[C]alias\f[R] +As explained at Directives and multiple files, \f[V]alias\f[R] directives do not affect parent or sibling files. Eg in this command, .IP @@ -8477,7 +8496,7 @@ alias bar=Bar include c.journal ; also affected \f[R] .fi -.SS \f[C]end aliases\f[R] +.SS \f[V]end aliases\f[R] .PP You can clear (forget) all currently defined aliases (seen in the journal so far, or defined on the command line) with this directive: @@ -8490,7 +8509,7 @@ end aliases .SS Aliases can generate bad account names .PP Be aware that account aliases can produce malformed account names, which -could cause confusing reports or invalid \f[C]print\f[R] output. +could cause confusing reports or invalid \f[V]print\f[R] output. For example, you could erase all account names: .IP .nf @@ -8509,8 +8528,8 @@ $ hledger print --alias \[aq]/.*/=\[aq] \f[R] .fi .PP -The above \f[C]print\f[R] output is not a valid journal. -Or you could insert an illegal double space, causing \f[C]print\f[R] +The above \f[V]print\f[R] output is not a valid journal. +Or you could insert an illegal double space, causing \f[V]print\f[R] output that would give a different journal when reparsed: .IP .nf @@ -8542,7 +8561,7 @@ child accounts from inheriting the account type of their parents. Secondly, if an account\[aq]s type is being inferred from its name, renaming it by an alias could prevent or alter that. .PP -If you are using account aliases and the \f[C]type:\f[R] query is not +If you are using account aliases and the \f[V]type:\f[R] query is not matching accounts as you expect, try troubleshooting with the accounts command, eg something like: .IP @@ -8555,7 +8574,7 @@ $ hledger accounts --alias assets=bassetts type:a .PP You can specify a parent account which will be prepended to all accounts within a section of the journal. -Use the \f[C]apply account\f[R] and \f[C]end apply account\f[R] +Use the \f[V]apply account\f[R] and \f[V]end apply account\f[R] directives like so: .IP .nf @@ -8580,7 +8599,7 @@ which is equivalent to: \f[R] .fi .PP -If \f[C]end apply account\f[R] is omitted, the effect lasts to the end +If \f[V]end apply account\f[R] is omitted, the effect lasts to the end of the file. Included files are also affected, eg: .IP @@ -8594,7 +8613,7 @@ include personal.journal \f[R] .fi .PP -Prior to hledger 1.0, legacy \f[C]account\f[R] and \f[C]end\f[R] +Prior to hledger 1.0, legacy \f[V]account\f[R] and \f[V]end\f[R] spellings were also supported. .PP A default parent account also affects account directives. @@ -8616,8 +8635,8 @@ Two spaces accidentally added or omitted will cause you trouble - read about this below. .IP "2." 3 For troubleshooting, show the generated transactions with -\f[C]hledger print --forecast tag:generated\f[R] or -\f[C]hledger register --forecast tag:generated\f[R]. +\f[V]hledger print --forecast tag:generated\f[R] or +\f[V]hledger register --forecast tag:generated\f[R]. .IP "3." 3 Forecasted transactions will begin only after the last non-forecasted transaction\[aq]s date. @@ -8630,16 +8649,16 @@ Their documentation needs improvement, but is worth studying. .IP "6." 3 Some period expressions with a repeating interval must begin on a natural boundary of that interval. -Eg in \f[C]weekly from DATE\f[R], DATE must be a monday. -\f[C]\[ti] weekly from 2019/10/1\f[R] (a tuesday) will give an error. +Eg in \f[V]weekly from DATE\f[R], DATE must be a monday. +\f[V]\[ti] weekly from 2019/10/1\f[R] (a tuesday) will give an error. .IP "7." 3 Other period expressions with an interval are automatically expanded to cover a whole number of that interval. (This is done to improve reports, but it also affects periodic transactions. -Yes, it\[aq]s a bit inconsistent with the above.) Eg: -\f[C]\[ti] every 10th day of month from 2020/01\f[R], which is -equivalent to \f[C]\[ti] every 10th day of month from 2020/01/01\f[R], +Yes, it\[aq]s a bit inconsistent with the above.) +Eg: \f[V]\[ti] every 10th day of month from 2020/01\f[R], which is +equivalent to \f[V]\[ti] every 10th day of month from 2020/01/01\f[R], will be adjusted to start on 2019/12/10. .PP Periodic transaction rules also have a second meaning: they are used to @@ -8647,8 +8666,8 @@ define budget goals, shown in budget reports. .SS Periodic rule syntax .PP A periodic transaction rule looks like a normal journal entry, with the -date replaced by a tilde (\f[C]\[ti]\f[R]) followed by a period -expression (mnemonic: \f[C]\[ti]\f[R] looks like a recurring sine +date replaced by a tilde (\f[V]\[ti]\f[R]) followed by a period +expression (mnemonic: \f[V]\[ti]\f[R] looks like a recurring sine wave.): .IP .nf @@ -8661,20 +8680,20 @@ wave.): .PP There is an additional constraint on the period expression: the start date must fall on a natural boundary of the interval. -Eg \f[C]monthly from 2018/1/1\f[R] is valid, but -\f[C]monthly from 2018/1/15\f[R] is not. +Eg \f[V]monthly from 2018/1/1\f[R] is valid, but +\f[V]monthly from 2018/1/15\f[R] is not. .SS Periodic rules and relative dates .PP -Partial or relative dates (like \f[C]12/31\f[R], \f[C]25\f[R], -\f[C]tomorrow\f[R], \f[C]last week\f[R], \f[C]next quarter\f[R]) are +Partial or relative dates (like \f[V]12/31\f[R], \f[V]25\f[R], +\f[V]tomorrow\f[R], \f[V]last week\f[R], \f[V]next quarter\f[R]) are usually not recommended in periodic rules, since the results will change as time passes. If used, they will be interpreted relative to, in order of preference: .IP "1." 3 -the first day of the default year specified by a recent \f[C]Y\f[R] +the first day of the default year specified by a recent \f[V]Y\f[R] directive .IP "2." 3 -or the date specified with \f[C]--today\f[R] +or the date specified with \f[V]--today\f[R] .IP "3." 3 or the date on which you are running the report. .PP @@ -8708,41 +8727,41 @@ Don\[aq]t accidentally write two spaces in the middle of your period expression. .SS Forecasting with periodic transactions .PP -The \f[C]--forecast\f[R] flag activates any periodic transaction rules +The \f[V]--forecast\f[R] flag activates any periodic transaction rules in the journal. These will generate temporary additional transactions, usually recurring and in the future, which will appear in all reports. -\f[C]hledger print --forecast\f[R] is a good way to see them. +\f[V]hledger print --forecast\f[R] is a good way to see them. .PP This can be useful for estimating balances into the future, perhaps experimenting with different scenarios. .PP It could also be useful for scripted data entry: you could describe recurring transactions, and every so often copy the output of -\f[C]print --forecast\f[R] into the journal. +\f[V]print --forecast\f[R] into the journal. .PP The generated transactions will have an extra tag, like -\f[C]generated-transaction:\[ti] PERIODICEXPR\f[R], indicating which +\f[V]generated-transaction:\[ti] PERIODICEXPR\f[R], indicating which periodic rule generated them. There is also a similar, hidden tag, named -\f[C]_generated-transaction:\f[R], which you can use to reliably match -transactions generated \[dq]just now\[dq] (rather than \f[C]print\f[R]ed +\f[V]_generated-transaction:\f[R], which you can use to reliably match +transactions generated \[dq]just now\[dq] (rather than \f[V]print\f[R]ed in the past). .PP The forecast transactions are generated within a \f[I]forecast period\f[R], which is independent of the report period. (Forecast period sets the bounds for generated transactions, report -period controls which transactions are reported.) The forecast period -begins on: +period controls which transactions are reported.) +The forecast period begins on: .IP \[bu] 2 -the start date provided within \f[C]--forecast\f[R]\[aq]s argument, if +the start date provided within \f[V]--forecast\f[R]\[aq]s argument, if any .IP \[bu] 2 otherwise, the later of .RS 2 .IP \[bu] 2 the report start date, if specified (with -\f[C]-b\f[R]/\f[C]-p\f[R]/\f[C]date:\f[R]) +\f[V]-b\f[R]/\f[V]-p\f[R]/\f[V]date:\f[R]) .IP \[bu] 2 the day after the latest ordinary transaction in the journal, if any .RE @@ -8751,10 +8770,10 @@ otherwise today. .PP It ends on: .IP \[bu] 2 -the end date provided within \f[C]--forecast\f[R]\[aq]s argument, if any +the end date provided within \f[V]--forecast\f[R]\[aq]s argument, if any .IP \[bu] 2 otherwise, the report end date, if specified (with -\f[C]-e\f[R]/\f[C]-p\f[R]/\f[C]date:\f[R]) +\f[V]-e\f[R]/\f[V]-p\f[R]/\f[V]date:\f[R]) .IP \[bu] 2 otherwise 180 days (6 months) from today. .PP @@ -8765,16 +8784,16 @@ This is usually convenient, but you can get around it in two ways: .IP \[bu] 2 If you need to record some transactions in the future, make them periodic transactions (with a single occurrence, eg: -\f[C]\[ti] YYYY-MM-DD\f[R]) rather than ordinary transactions. +\f[V]\[ti] YYYY-MM-DD\f[R]) rather than ordinary transactions. That way they won\[aq]t suppress other periodic transactions. .IP \[bu] 2 -Or give \f[C]--forecast\f[R] a period expression argument. +Or give \f[V]--forecast\f[R] a period expression argument. A forecast period specified this way can overlap ordinary transactions, and need not be in the future. Some things to note: .RS 2 .IP \[bu] 2 -You must use \f[C]=\f[R] between flag and argument; a space won\[aq]t +You must use \f[V]=\f[R] between flag and argument; a space won\[aq]t work. .IP \[bu] 2 The period expression can specify the forecast period\[aq]s start date, @@ -8785,11 +8804,11 @@ The period expression should not specify a report interval. (Each periodic transaction rule specifies its own interval.) .RE .PP -Some examples: \f[C]--forecast=202001-202004\f[R], -\f[C]--forecast=jan-\f[R], \f[C]--forecast=2021\f[R]. +Some examples: \f[V]--forecast=202001-202004\f[R], +\f[V]--forecast=jan-\f[R], \f[V]--forecast=2021\f[R]. .SS Budgeting with periodic transactions .PP -With the \f[C]--budget\f[R] flag, currently supported by the balance +With the \f[V]--budget\f[R] flag, currently supported by the balance command, each periodic transaction rule declares recurring budget goals for the specified accounts. Eg the first example above declares a goal of spending $2000 on rent @@ -8803,7 +8822,7 @@ See also: Budgeting and Forecasting. \[dq]Automated postings\[dq] or \[dq]auto postings\[dq] are extra postings which get added automatically to transactions which match certain queries, defined by \[dq]auto posting rules\[dq], when you use -the \f[C]--auto\f[R] flag. +the \f[V]--auto\f[R] flag. .PP An auto posting rule looks a bit like a transaction: .IP @@ -8816,23 +8835,23 @@ An auto posting rule looks a bit like a transaction: \f[R] .fi .PP -except the first line is an equals sign (mnemonic: \f[C]=\f[R] suggests +except the first line is an equals sign (mnemonic: \f[V]=\f[R] suggests matching), followed by a query (which matches existing postings), and each \[dq]posting\[dq] line describes a posting to be generated, and the posting amounts can be: .IP \[bu] 2 -a normal amount with a commodity symbol, eg \f[C]$2\f[R]. +a normal amount with a commodity symbol, eg \f[V]$2\f[R]. This will be used as-is. .IP \[bu] 2 -a number, eg \f[C]2\f[R]. +a number, eg \f[V]2\f[R]. The commodity symbol (if any) from the matched posting will be added to this. .IP \[bu] 2 -a numeric multiplier, eg \f[C]*2\f[R] (a star followed by a number N). +a numeric multiplier, eg \f[V]*2\f[R] (a star followed by a number N). The matched posting\[aq]s amount (and total price, if any) will be multiplied by N. .IP \[bu] 2 -a multiplier with a commodity symbol, eg \f[C]*$2\f[R] (a star, number +a multiplier with a commodity symbol, eg \f[V]*$2\f[R] (a star, number N, and symbol S). The matched posting\[aq]s amount will be multiplied by N, and its commodity symbol will be replaced with S. @@ -8891,7 +8910,7 @@ $ hledger print --auto An auto posting rule can affect any transaction in the current file, or in any parent file or child file. Note, currently it will not affect sibling files (when multiple -\f[C]-f\f[R]/\f[C]--file\f[R] are used - see #1212). +\f[V]-f\f[R]/\f[V]--file\f[R] are used - see #1212). .SS Auto postings and dates .PP A posting date (or secondary date) in the matched posting, or (taking @@ -8917,10 +8936,10 @@ infer amounts. .PP Automated postings will have some extra tags: .IP \[bu] 2 -\f[C]generated-posting:= QUERY\f[R] - shows this was generated by an +\f[V]generated-posting:= QUERY\f[R] - shows this was generated by an auto posting rule, and the query .IP \[bu] 2 -\f[C]_generated-posting:= QUERY\f[R] - a hidden tag, which does not +\f[V]_generated-posting:= QUERY\f[R] - a hidden tag, which does not appear in hledger\[aq]s output. This can be used to match postings generated \[dq]just now\[dq], rather than generated in the past and saved to the journal. @@ -8928,9 +8947,9 @@ than generated in the past and saved to the journal. Also, any transaction that has been changed by auto posting rules will have these tags added: .IP \[bu] 2 -\f[C]modified:\f[R] - this transaction was modified +\f[V]modified:\f[R] - this transaction was modified .IP \[bu] 2 -\f[C]_modified:\f[R] - a hidden tag not appearing in the comment; this +\f[V]_modified:\f[R] - a hidden tag not appearing in the comment; this transaction was modified \[dq]just now\[dq]. .SH CSV FORMAT .PP @@ -8944,11 +8963,11 @@ files, automatically converting each CSV record into a transaction. .PP We describe each CSV file\[aq]s format with a corresponding \f[I]rules file\f[R]. -By default this is named like the CSV file with a \f[C].rules\f[R] +By default this is named like the CSV file with a \f[V].rules\f[R] extension added. -Eg when reading \f[C]FILE.csv\f[R], hledger also looks for -\f[C]FILE.csv.rules\f[R] in the same directory as \f[C]FILE.csv\f[R]. -You can specify a different rules file with the \f[C]--rules-file\f[R] +Eg when reading \f[V]FILE.csv\f[R], hledger also looks for +\f[V]FILE.csv.rules\f[R] in the same directory as \f[V]FILE.csv\f[R]. +You can specify a different rules file with the \f[V]--rules-file\f[R] option. If a rules file is not found, hledger will create a sample rules file, which you\[aq]ll need to adjust. @@ -8965,12 +8984,12 @@ below, after the examples: tab(@); lw(26.4n) lw(43.6n). T{ -\f[B]\f[CB]skip\f[B]\f[R] +\f[B]\f[VB]skip\f[B]\f[R] T}@T{ skip one or more header lines or matched CSV records T} T{ -\f[B]\f[CB]fields\f[B] list\f[R] +\f[B]\f[VB]fields\f[B] list\f[R] T}@T{ name CSV fields, assign them to hledger fields T} @@ -8985,61 +9004,61 @@ T}@T{ hledger field names, used in the fields list and field assignments T} T{ -\f[B]\f[CB]separator\f[B]\f[R] +\f[B]\f[VB]separator\f[B]\f[R] T}@T{ a custom field separator T} T{ -\f[B]\f[CB]if\f[B] block\f[R] +\f[B]\f[VB]if\f[B] block\f[R] T}@T{ apply some rules to CSV records matched by patterns T} T{ -\f[B]\f[CB]if\f[B] table\f[R] +\f[B]\f[VB]if\f[B] table\f[R] T}@T{ apply some rules to CSV records matched by patterns, alternate syntax T} T{ -\f[B]\f[CB]end\f[B]\f[R] +\f[B]\f[VB]end\f[B]\f[R] T}@T{ skip the remaining CSV records T} T{ -\f[B]\f[CB]date-format\f[B]\f[R] +\f[B]\f[VB]date-format\f[B]\f[R] T}@T{ how to parse dates in CSV records T} T{ -\f[B]\f[CB]decimal-mark\f[B]\f[R] +\f[B]\f[VB]decimal-mark\f[B]\f[R] T}@T{ the decimal mark used in CSV amounts, if ambiguous T} T{ -\f[B]\f[CB]newest-first\f[B]\f[R] +\f[B]\f[VB]newest-first\f[B]\f[R] T}@T{ improve txn order when there are multiple records, newest first, all with the same date T} T{ -\f[B]\f[CB]intra-day-reversed\f[B]\f[R] +\f[B]\f[VB]intra-day-reversed\f[B]\f[R] T}@T{ improve txn order when each day\[aq]s txns are reverse of the overall date order T} T{ -\f[B]\f[CB]include\f[B]\f[R] +\f[B]\f[VB]include\f[B]\f[R] T}@T{ inline another CSV rules file T} T{ -\f[B]\f[CB]balance-type\f[B]\f[R] +\f[B]\f[VB]balance-type\f[B]\f[R] T}@T{ choose which type of balance assignments to use T} .TE .PP Note, for best error messages when reading CSV files, use a -\f[C].csv\f[R], \f[C].tsv\f[R] or \f[C].ssv\f[R] file extension or file +\f[V].csv\f[R], \f[V].tsv\f[R] or \f[V].ssv\f[R] file extension or file prefix - see File Extension below. .PP There\[aq]s an introductory Importing CSV data tutorial on hledger.org. @@ -9378,9 +9397,9 @@ $ hledger -f paypal-custom.csv print .SS CSV rules .PP The following kinds of rule can appear in the rules file, in any order. -Blank lines and lines beginning with \f[C]#\f[R] or \f[C];\f[R] are +Blank lines and lines beginning with \f[V]#\f[R] or \f[V];\f[R] are ignored. -.SS \f[C]skip\f[R] +.SS \f[V]skip\f[R] .IP .nf \f[C] @@ -9391,12 +9410,12 @@ skip N The word \[dq]skip\[dq] followed by a number (or no number, meaning 1) tells hledger to ignore this many non-empty lines preceding the CSV data. -(Empty/blank lines are skipped automatically.) You\[aq]ll need this -whenever your CSV data contains header lines. +(Empty/blank lines are skipped automatically.) +You\[aq]ll need this whenever your CSV data contains header lines. .PP It also has a second purpose: it can be used inside if blocks to ignore certain CSV records (described below). -.SS \f[C]fields\f[R] list +.SS \f[V]fields\f[R] list .IP .nf \f[C] @@ -9407,8 +9426,8 @@ fields FIELDNAME1, FIELDNAME2, ... A fields list (the word \[dq]fields\[dq] followed by comma-separated field names) is the quick way to assign CSV field values to hledger fields. -(The other way is field assignments, see below.) A fields list does does -two things: +(The other way is field assignments, see below.) +A fields list does does two things: .IP "1." 3 It names the CSV fields. This is optional, but can be convenient later for interpolating them. @@ -9437,7 +9456,7 @@ comma). Field names may not contain spaces. Spaces before/after field names are optional. .IP \[bu] 2 -Field names may contain \f[C]_\f[R] (underscore) or \f[C]-\f[R] +Field names may contain \f[V]_\f[R] (underscore) or \f[V]-\f[R] (hyphen). .IP \[bu] 2 If the CSV contains column headings, it\[aq]s a good idea to use these, @@ -9449,7 +9468,7 @@ want to set the hledger fields directly, alter those names, eg by appending an underscore. .IP \[bu] 2 Fields you don\[aq]t care about can be given a dummy name (eg: -\f[C]_\f[R] ), or no name. +\f[V]_\f[R] ), or no name. .SS field assignment .IP .nf @@ -9466,8 +9485,8 @@ To assign a value to a hledger field, write the field name (any of the standard hledger field/pseudo-field names, defined below), a space, followed by a text value on the same line. This text value may interpolate CSV fields, referenced by their 1-based -position in the CSV record (\f[C]%N\f[R]), or by the name they were -given in the fields list (\f[C]%CSVFIELDNAME\f[R]). +position in the CSV record (\f[V]%N\f[R]), or by the name they were +given in the fields list (\f[V]%CSVFIELDNAME\f[R]). .PP Some examples: .IP @@ -9484,7 +9503,7 @@ comment note: %somefield - %anotherfield, date: %1 Tips: .IP \[bu] 2 Interpolation strips outer whitespace (so a CSV value like -\f[C]\[dq] 1 \[dq]\f[R] becomes \f[C]1\f[R] when interpolated) (#1051). +\f[V]\[dq] 1 \[dq]\f[R] becomes \f[V]1\f[R] when interpolated) (#1051). .IP \[bu] 2 Interpolations always refer to a CSV field - you can\[aq]t interpolate a hledger field. @@ -9496,42 +9515,42 @@ can use in a fields list and in field assignments. For more about the transaction parts they refer to, see Transactions. .SS date field .PP -Assigning to \f[C]date\f[R] sets the transaction date. +Assigning to \f[V]date\f[R] sets the transaction date. .SS date2 field .PP -\f[C]date2\f[R] sets the transaction\[aq]s secondary date, if any. +\f[V]date2\f[R] sets the transaction\[aq]s secondary date, if any. .SS status field .PP -\f[C]status\f[R] sets the transaction\[aq]s status, if any. +\f[V]status\f[R] sets the transaction\[aq]s status, if any. .SS code field .PP -\f[C]code\f[R] sets the transaction\[aq]s code, if any. +\f[V]code\f[R] sets the transaction\[aq]s code, if any. .SS description field .PP -\f[C]description\f[R] sets the transaction\[aq]s description, if any. +\f[V]description\f[R] sets the transaction\[aq]s description, if any. .SS comment field .PP -\f[C]comment\f[R] sets the transaction\[aq]s comment, if any. +\f[V]comment\f[R] sets the transaction\[aq]s comment, if any. .PP -\f[C]commentN\f[R], where N is a number, sets the Nth posting\[aq]s +\f[V]commentN\f[R], where N is a number, sets the Nth posting\[aq]s comment. .PP Tips: .IP \[bu] 2 -You can assign multi-line comments by writing literal \f[C]\[rs]n\f[R] +You can assign multi-line comments by writing literal \f[V]\[rs]n\f[R] in the code. -A comment starting with \f[C]\[rs]n\f[R] will begin on a new line. +A comment starting with \f[V]\[rs]n\f[R] will begin on a new line. .IP \[bu] 2 Comments can contain tags, as usual. .SS account field .PP -Assigning to \f[C]accountN\f[R], where N is 1 to 99, sets the account +Assigning to \f[V]accountN\f[R], where N is 1 to 99, sets the account name of the Nth posting, and causes that posting to be generated. .PP Most often there are two postings, so you\[aq]ll want to set -\f[C]account1\f[R] and \f[C]account2\f[R]. -Typically \f[C]account1\f[R] is associated with the CSV file, and is set -once with a top-level assignment, while \f[C]account2\f[R] is set based +\f[V]account1\f[R] and \f[V]account2\f[R]. +Typically \f[V]account1\f[R] is associated with the CSV file, and is set +once with a top-level assignment, while \f[V]account2\f[R] is set based on each transaction\[aq]s description, and in conditional blocks. .PP If a posting\[aq]s account name is left unset but its amount is set (see @@ -9539,20 +9558,20 @@ below), a default account name will be chosen (like \[dq]expenses:unknown\[dq] or \[dq]income:unknown\[dq]). .SS amount field .PP -\f[C]amountN\f[R] sets the amount of the Nth posting, and causes that +\f[V]amountN\f[R] sets the amount of the Nth posting, and causes that posting to be generated. -By assigning to \f[C]amount1\f[R], \f[C]amount2\f[R], ... +By assigning to \f[V]amount1\f[R], \f[V]amount2\f[R], ... etc. you can generate up to 99 postings. .PP -\f[C]amountN-in\f[R] and \f[C]amountN-out\f[R] can be used instead, if +\f[V]amountN-in\f[R] and \f[V]amountN-out\f[R] can be used instead, if the CSV uses separate fields for debits and credits (inflows and outflows). hledger assumes both of these CSV fields are unsigned, and will automatically negate the \[dq]-out\[dq] value. If they are signed, see \[dq]Setting amounts\[dq] below. .PP -\f[C]amount\f[R], or \f[C]amount-in\f[R] and \f[C]amount-out\f[R] are a +\f[V]amount\f[R], or \f[V]amount-in\f[R] and \f[V]amount-out\f[R] are a legacy mode, to keep pre-hledger-1.17 CSV rules files working (and for occasional convenience). They are suitable only for two-posting transactions; they set both @@ -9564,38 +9583,38 @@ If you have an existing rules file using the unnumbered form, you might want to use the numbered form in certain conditional blocks, without having to update and retest all the old rules. To facilitate this, posting 1 ignores -\f[C]amount\f[R]/\f[C]amount-in\f[R]/\f[C]amount-out\f[R] if any of -\f[C]amount1\f[R]/\f[C]amount1-in\f[R]/\f[C]amount1-out\f[R] are +\f[V]amount\f[R]/\f[V]amount-in\f[R]/\f[V]amount-out\f[R] if any of +\f[V]amount1\f[R]/\f[V]amount1-in\f[R]/\f[V]amount1-out\f[R] are assigned, and posting 2 ignores them if any of -\f[C]amount2\f[R]/\f[C]amount2-in\f[R]/\f[C]amount2-out\f[R] are +\f[V]amount2\f[R]/\f[V]amount2-in\f[R]/\f[V]amount2-out\f[R] are assigned, avoiding conflicts. .SS currency field .PP -\f[C]currency\f[R] sets a currency symbol, to be prepended to all +\f[V]currency\f[R] sets a currency symbol, to be prepended to all postings\[aq] amounts. You can use this if the CSV amounts do not have a currency symbol, eg if it is in a separate column. .PP -\f[C]currencyN\f[R] prepends a currency symbol to just the Nth +\f[V]currencyN\f[R] prepends a currency symbol to just the Nth posting\[aq]s amount. .SS balance field .PP -\f[C]balanceN\f[R] sets a balance assertion amount (or if the posting +\f[V]balanceN\f[R] sets a balance assertion amount (or if the posting amount is left empty, a balance assignment) on posting N. .PP -\f[C]balance\f[R] is a compatibility spelling for hledger <1.17; it is -equivalent to \f[C]balance1\f[R]. +\f[V]balance\f[R] is a compatibility spelling for hledger <1.17; it is +equivalent to \f[V]balance1\f[R]. .PP You can adjust the type of assertion/assignment with the -\f[C]balance-type\f[R] rule (see below). +\f[V]balance-type\f[R] rule (see below). .PP See Tips below for more about setting amounts and currency. -.SS \f[C]separator\f[R] +.SS \f[V]separator\f[R] .PP -You can use the \f[C]separator\f[R] rule to read other kinds of +You can use the \f[V]separator\f[R] rule to read other kinds of character-separated data. The argument is any single separator character, or the words -\f[C]tab\f[R] or \f[C]space\f[R] (case insensitive). +\f[V]tab\f[R] or \f[V]space\f[R] (case insensitive). Eg, for comma-separated values (CSV): .IP .nf @@ -9620,11 +9639,11 @@ separator TAB \f[R] .fi .PP -If the input file has a \f[C].csv\f[R], \f[C].ssv\f[R] or \f[C].tsv\f[R] -file extension (or a \f[C]csv:\f[R], \f[C]ssv:\f[R], \f[C]tsv:\f[R] +If the input file has a \f[V].csv\f[R], \f[V].ssv\f[R] or \f[V].tsv\f[R] +file extension (or a \f[V]csv:\f[R], \f[V]ssv:\f[R], \f[V]tsv:\f[R] prefix), the appropriate separator will be inferred automatically, and you won\[aq]t need this rule. -.SS \f[C]if\f[R] block +.SS \f[V]if\f[R] block .IP .nf \f[C] @@ -9657,8 +9676,8 @@ REGEX REGEX is a case-insensitive regular expression that tries to match anywhere within the CSV record. It is a POSIX ERE (extended regular expression) that also supports GNU -word boundaries (\f[C]\[rs]b\f[R], \f[C]\[rs]B\f[R], \f[C]\[rs]<\f[R], -\f[C]\[rs]>\f[R]), and nothing else. +word boundaries (\f[V]\[rs]b\f[R], \f[V]\[rs]B\f[R], \f[V]\[rs]<\f[R], +\f[V]\[rs]>\f[R]), and nothing else. If you have trouble, be sure to check our doc: https://hledger.org/hledger.html#regular-expressions .PP @@ -9667,8 +9686,8 @@ but a synthetic one, with any enclosing double quotes (but not enclosing whitespace) removed, and always comma-separated (which means that a field containing a comma will appear like two fields). Eg, if the original record is -\f[C]2020-01-01; \[dq]Acme, Inc.\[dq]; 1,000\f[R], the REGEX will -actually see \f[C]2020-01-01,Acme, Inc., 1,000\f[R]). +\f[V]2020-01-01; \[dq]Acme, Inc.\[dq]; 1,000\f[R], the REGEX will +actually see \f[V]2020-01-01,Acme, Inc., 1,000\f[R]). .SS Matching individual fields .PP Or, MATCHER can be a field matcher, like this: @@ -9681,13 +9700,13 @@ Or, MATCHER can be a field matcher, like this: .PP which matches just the content of a particular CSV field. CSVFIELD is a percent sign followed by the field\[aq]s name or column -number, like \f[C]%date\f[R] or \f[C]%1\f[R]. +number, like \f[V]%date\f[R] or \f[V]%1\f[R]. .SS Combining matchers .PP A single matcher can be written on the same line as the \[dq]if\[dq]; or multiple matchers can be written on the following lines, non-indented. Multiple matchers are OR\[aq]d (any one of them can match), unless one -begins with an \f[C]&\f[R] symbol, in which case it is AND\[aq]ed with +begins with an \f[V]&\f[R] symbol, in which case it is AND\[aq]ed with the previous matcher. .IP .nf @@ -9731,7 +9750,7 @@ banking thru software comment XXX deductible ? check it \f[R] .fi -.SS \f[C]if\f[R] table +.SS \f[V]if\f[R] table .IP .nf \f[C] @@ -9749,10 +9768,10 @@ match certain patterns. .PP MATCHER could be either field or record matcher, as described above. When MATCHER matches, values from that row would be assigned to the CSV -fields named on the \f[C]if\f[R] line, in the same order. +fields named on the \f[V]if\f[R] line, in the same order. .PP -Therefore \f[C]if\f[R] table is exactly equivalent to a sequence of of -\f[C]if\f[R] blocks: +Therefore \f[V]if\f[R] table is exactly equivalent to a sequence of of +\f[V]if\f[R] blocks: .IP .nf \f[C] @@ -9780,13 +9799,13 @@ Each line starting with MATCHER should contain enough (possibly empty) values for all the listed fields. .PP Rules would be checked and applied in the order they are listed in the -table and, like with \f[C]if\f[R] blocks, later rules (in the same or -another table) or \f[C]if\f[R] blocks could override the effect of any +table and, like with \f[V]if\f[R] blocks, later rules (in the same or +another table) or \f[V]if\f[R] blocks could override the effect of any rule. .PP Instead of \[aq],\[aq] you can use a variety of other non-alphanumeric characters as a separator. -First character after \f[C]if\f[R] is taken to be the separator for the +First character after \f[V]if\f[R] is taken to be the separator for the rest of the table. It is the responsibility of the user to ensure that separator does not occur inside MATCHERs and values - there is no way to escape separator. @@ -9801,7 +9820,7 @@ atm transaction fee,expenses:business:banking,deductible? check it 2020/01/12.*Plumbing LLC,expenses:house:upkeep,emergency plumbing call-out \f[R] .fi -.SS \f[C]end\f[R] +.SS \f[V]end\f[R] .PP This rule can be used inside if blocks (only), to make hledger stop reading this CSV file and move on to the next input file, or to command @@ -9815,7 +9834,7 @@ if ,,,, end \f[R] .fi -.SS \f[C]date-format\f[R] +.SS \f[V]date-format\f[R] .IP .nf \f[C] @@ -9823,9 +9842,9 @@ date-format DATEFMT \f[R] .fi .PP -This is a helper for the \f[C]date\f[R] (and \f[C]date2\f[R]) fields. -If your CSV dates are not formatted like \f[C]YYYY-MM-DD\f[R], -\f[C]YYYY/MM/DD\f[R] or \f[C]YYYY.MM.DD\f[R], you\[aq]ll need to add a +This is a helper for the \f[V]date\f[R] (and \f[V]date2\f[R]) fields. +If your CSV dates are not formatted like \f[V]YYYY-MM-DD\f[R], +\f[V]YYYY/MM/DD\f[R] or \f[V]YYYY.MM.DD\f[R], you\[aq]ll need to add a date-format rule describing them with a strptime-style date parsing pattern - see https://hackage.haskell.org/package/time/docs/Data-Time-Format.html#v:formatTime. @@ -9861,7 +9880,7 @@ date-format %Y-%h-%d date-format %-m/%-d/%Y %l:%M %p some other junk \f[R] .fi -.SS \f[C]timezone\f[R] +.SS \f[V]timezone\f[R] .IP .nf \f[C] @@ -9875,8 +9894,8 @@ use this rule to declare the CSV\[aq]s native time zone, which helps prevent off-by-one dates. .PP When the CSV date-times do contain time zone information, you don\[aq]t -need this rule; instead, use \f[C]%Z\f[R] in \f[C]date-format\f[R] (or -\f[C]%z\f[R], \f[C]%EZ\f[R], \f[C]%Ez\f[R]; see the formatTime link +need this rule; instead, use \f[V]%Z\f[R] in \f[V]date-format\f[R] (or +\f[V]%z\f[R], \f[V]%EZ\f[R], \f[V]%Ez\f[R]; see the formatTime link above). .PP In either of these cases, hledger will do a time-zone-aware conversion, @@ -9891,12 +9910,12 @@ $ TZ=-1000 hledger print -f foo.csv # or TZ=-1000 hledger import foo.csv \f[R] .fi .PP -\f[C]timezone\f[R] currently does not understand timezone names, except +\f[V]timezone\f[R] currently does not understand timezone names, except \[dq]UTC\[dq], \[dq]GMT\[dq], \[dq]EST\[dq], \[dq]EDT\[dq], \[dq]CST\[dq], \[dq]CDT\[dq], \[dq]MST\[dq], \[dq]MDT\[dq], \[dq]PST\[dq], or \[dq]PDT\[dq]. For others, use numeric format: +HHMM or -HHMM. -.SS \f[C]decimal-mark\f[R] +.SS \f[V]decimal-mark\f[R] .IP .nf \f[C] @@ -9917,7 +9936,7 @@ when parsing numbers (cf Amounts). However if any numbers in the CSV contain digit group marks, such as thousand-separating commas, you should declare the decimal mark explicitly with this rule, to avoid misparsed numbers. -.SS \f[C]newest-first\f[R] +.SS \f[V]newest-first\f[R] .PP hledger tries to ensure that the generated transactions will be ordered chronologically, including intra-day transactions. @@ -9934,7 +9953,7 @@ If in fact the CSV\[aq]s records are normally newest first, like: \f[R] .fi .PP -you can add the \f[C]newest-first\f[R] rule to help hledger generate the +you can add the \f[V]newest-first\f[R] rule to help hledger generate the transactions in correct order. .IP .nf @@ -9943,7 +9962,7 @@ transactions in correct order. newest-first \f[R] .fi -.SS \f[C]intra-day-reversed\f[R] +.SS \f[V]intra-day-reversed\f[R] .PP CSV records for each day are sometimes ordered in reverse compared to the overall date order. @@ -9959,7 +9978,7 @@ oldest first: \f[R] .fi .PP -In this situation, add the \f[C]intra-day-reversed\f[R] rule, and +In this situation, add the \f[V]intra-day-reversed\f[R] rule, and hledger will compensate, improving the order of transactions. .IP .nf @@ -9968,7 +9987,7 @@ hledger will compensate, improving the order of transactions. intra-day-reversed \f[R] .fi -.SS \f[C]include\f[R] +.SS \f[V]include\f[R] .IP .nf \f[C] @@ -9977,7 +9996,7 @@ include RULESFILE .fi .PP This includes the contents of another CSV rules file at this point. -\f[C]RULESFILE\f[R] is an absolute file path or a path relative to the +\f[V]RULESFILE\f[R] is an absolute file path or a path relative to the current file\[aq]s directory. This can be useful for sharing common rules between several rules files, eg: @@ -9995,16 +10014,16 @@ account2 expenses:misc include categorisation.rules \f[R] .fi -.SS \f[C]balance-type\f[R] +.SS \f[V]balance-type\f[R] .PP Balance assertions generated by assigning to balanceN are of the simple -\f[C]=\f[R] type by default, which is a single-commodity, +\f[V]=\f[R] type by default, which is a single-commodity, subaccount-excluding assertion. You may find the subaccount-including variants more useful, eg if you have created some virtual subaccounts of checking to help with budgeting. You can select a different type of assertion with the -\f[C]balance-type\f[R] rule: +\f[V]balance-type\f[R] rule: .IP .nf \f[C] @@ -10052,10 +10071,10 @@ spaces outside the quotes are not allowed .SS File Extension .PP To help hledger identify the format and show the right error messages, -CSV/SSV/TSV files should normally be named with a \f[C].csv\f[R], -\f[C].ssv\f[R] or \f[C].tsv\f[R] filename extension. -Or, the file path should be prefixed with \f[C]csv:\f[R], \f[C]ssv:\f[R] -or \f[C]tsv:\f[R]. +CSV/SSV/TSV files should normally be named with a \f[V].csv\f[R], +\f[V].ssv\f[R] or \f[V].tsv\f[R] filename extension. +Or, the file path should be prefixed with \f[V]csv:\f[R], \f[V]ssv:\f[R] +or \f[V]tsv:\f[R]. Eg: .IP .nf @@ -10076,10 +10095,10 @@ You can override the file extension with a separator rule if needed. See also: Input files in the hledger manual. .SS Reading multiple CSV files .PP -If you use multiple \f[C]-f\f[R] options to read multiple CSV files at +If you use multiple \f[V]-f\f[R] options to read multiple CSV files at once, hledger will look for a correspondingly-named rules file for each CSV file. -But if you use the \f[C]--rules-file\f[R] option, that rules file will +But if you use the \f[V]--rules-file\f[R] option, that rules file will be used for all the CSV files. .SS Valid transactions .PP @@ -10110,8 +10129,8 @@ The import command will (a) detect the new transactions, and (b) append just those transactions to your main journal. It is idempotent, so you don\[aq]t have to remember how many times you ran it or with which version of the CSV. -(It keeps state in a hidden \f[C].latest.FILE.csv\f[R] file.) This is -the easiest way to import CSV data. +(It keeps state in a hidden \f[V].latest.FILE.csv\f[R] file.) +This is the easiest way to import CSV data. Eg: .IP .nf @@ -10143,7 +10162,7 @@ Here are the ways to set a posting\[aq]s amount: .PD 0 .P .PD -Assign (via a fields list or a field assignment) to \f[C]amountN\f[R]. +Assign (via a fields list or a field assignment) to \f[V]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 @@ -10158,7 +10177,7 @@ out):\f[R] .PD 0 .P .PD -Assign to \f[C]amountN-in\f[R] and \f[C]amountN-out\f[R]. +Assign to \f[V]amountN-in\f[R] and \f[V]amountN-out\f[R]. This sets posting N\[aq]s amount to whichever of these has a non-zero value, and negates the \[dq]-out\[dq] value. .IP "b." 3 @@ -10186,7 +10205,7 @@ value:\f[R] .PD 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 +Eg, the \f[V]amountN-in\f[R]/\f[V]amountN-out\f[R] rules would reject value pairs like these: .IP .nf @@ -10217,8 +10236,8 @@ if %out [1-9] .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]). +Assign to \f[V]amount\f[R] (or to \f[V]amount-in\f[R] and +\f[V]amount-out\f[R]). (This is the legacy numberless syntax, which sets amount1 and amount2 and converts amount2 to cost.) .IP "4." 3 @@ -10226,9 +10245,9 @@ and converts amount2 to cost.) .PD 0 .P .PD -Assign to \f[C]balanceN\f[R], which sets posting N\[aq]s amount +Assign to \f[V]balanceN\f[R], which sets posting N\[aq]s amount indirectly via a balance assignment. -(Old syntax: \f[C]balance\f[R], equivalent to \f[C]balance1\f[R].) +(Old syntax: \f[V]balance\f[R], equivalent to \f[V]balance1\f[R].) .RS 4 .IP \[bu] 2 \f[B]If hledger guesses the wrong default account name:\f[R] @@ -10257,22 +10276,22 @@ sign-flipping: .PD 0 .P .PD -that will be removed: \f[C]+AMT\f[R] becomes \f[C]AMT\f[R] +that will be removed: \f[V]+AMT\f[R] becomes \f[V]AMT\f[R] .IP \[bu] 2 \f[B]If an amount value is parenthesised:\f[R] .PD 0 .P .PD -it will be de-parenthesised and sign-flipped: \f[C](AMT)\f[R] becomes -\f[C]-AMT\f[R] +it will be de-parenthesised and sign-flipped: \f[V](AMT)\f[R] becomes +\f[V]-AMT\f[R] .IP \[bu] 2 \f[B]If an amount value has two minus signs (or two sets of parentheses, or a minus sign and parentheses):\f[R] .PD 0 .P .PD -they cancel out and will be removed: \f[C]--AMT\f[R] or \f[C]-(AMT)\f[R] -becomes \f[C]AMT\f[R] +they cancel out and will be removed: \f[V]--AMT\f[R] or \f[V]-(AMT)\f[R] +becomes \f[V]AMT\f[R] .IP \[bu] 2 \f[B]If an amount value contains just a sign (or just a set of parentheses):\f[R] @@ -10280,8 +10299,8 @@ parentheses):\f[R] .P .PD that is removed, making it an empty value. -\f[C]\[dq]+\[dq]\f[R] or \f[C]\[dq]-\[dq]\f[R] or \f[C]\[dq]()\[dq]\f[R] -becomes \f[C]\[dq]\[dq]\f[R]. +\f[V]\[dq]+\[dq]\f[R] or \f[V]\[dq]-\[dq]\f[R] or \f[V]\[dq]()\[dq]\f[R] +becomes \f[V]\[dq]\[dq]\f[R]. .SS Setting currency/commodity .PP If the currency/commodity symbol is included in the CSV\[aq]s amount @@ -10319,7 +10338,7 @@ If the currency is provided as a separate CSV field: \f[R] .fi .PP -You can assign that to the \f[C]currency\f[R] pseudo-field, which has +You can assign that to the \f[V]currency\f[R] pseudo-field, which has the special effect of prepending itself to every amount in the transaction (on the left, with no separating space): .IP @@ -10356,13 +10375,13 @@ amount %amt %cur \f[R] .fi .PP -Note we used a temporary field name (\f[C]cur\f[R]) that is not -\f[C]currency\f[R] - that would trigger the prepending effect, which we +Note we used a temporary field name (\f[V]cur\f[R]) that is not +\f[V]currency\f[R] - that would trigger the prepending effect, which we don\[aq]t want here. .SS Amount decimal places .PP Like amounts in a journal file, the amounts generated by CSV rules like -\f[C]amount1\f[R] influence commodity display styles, such as the number +\f[V]amount1\f[R] influence commodity display styles, such as the number of decimal places displayed in reports. .PP The original amounts as written in the CSV file do not affect display @@ -10419,7 +10438,7 @@ Here\[aq]s how to think of CSV rules being evaluated (if you really need to). First, .IP \[bu] 2 -\f[C]include\f[R] - all includes are inlined, from top to bottom, depth +\f[V]include\f[R] - all includes are inlined, from top to bottom, depth first. (At each include point the file is inlined and scanned for further includes, recursively, before proceeding.) @@ -10427,25 +10446,25 @@ includes, recursively, before proceeding.) Then \[dq]global\[dq] rules are evaluated, top to bottom. If a rule is repeated, the last one wins: .IP \[bu] 2 -\f[C]skip\f[R] (at top level) +\f[V]skip\f[R] (at top level) .IP \[bu] 2 -\f[C]date-format\f[R] +\f[V]date-format\f[R] .IP \[bu] 2 -\f[C]newest-first\f[R] +\f[V]newest-first\f[R] .IP \[bu] 2 -\f[C]fields\f[R] - names the CSV fields, optionally sets up initial +\f[V]fields\f[R] - names the CSV fields, optionally sets up initial assignments to hledger fields .PP Then for each CSV record in turn: .IP \[bu] 2 -test all \f[C]if\f[R] blocks. -If any of them contain a \f[C]end\f[R] rule, skip all remaining CSV +test all \f[V]if\f[R] blocks. +If any of them contain a \f[V]end\f[R] rule, skip all remaining CSV records. -Otherwise if any of them contain a \f[C]skip\f[R] rule, skip that many +Otherwise if any of them contain a \f[V]skip\f[R] rule, skip that many CSV records. -If there are multiple matched \f[C]skip\f[R] rules, the first one wins. +If there are multiple matched \f[V]skip\f[R] rules, the first one wins. .IP \[bu] 2 -collect all field assignments at top level and in matched \f[C]if\f[R] +collect all field assignments at top level and in matched \f[V]if\f[R] blocks. When there are multiple assignments for a field, keep only the last one. .IP \[bu] 2 @@ -10485,7 +10504,7 @@ hledger treats each clock-in/clock-out pair as a transaction posting some number of hours to an account. Or if the session spans more than one day, it is split into several transactions, one for each day. -For the above time log, \f[C]hledger print\f[R] generates these journal +For the above time log, \f[V]hledger print\f[R] generates these journal entries: .IP .nf @@ -10518,17 +10537,17 @@ use emacs and the built-in timeclock.el, or the extended timeclock-x.el and perhaps the extras in ledgerutils.el .IP \[bu] 2 at the command line, use these bash aliases: -\f[C]shell alias ti=\[dq]echo i \[ga]date \[aq]+%Y-%m-%d %H:%M:%S\[aq]\[ga] \[rs]$* >>$TIMELOG\[dq] alias to=\[dq]echo o \[ga]date \[aq]+%Y-%m-%d %H:%M:%S\[aq]\[ga] >>$TIMELOG\[dq]\f[R] +\f[V]shell alias ti=\[dq]echo i \[ga]date \[aq]+%Y-%m-%d %H:%M:%S\[aq]\[ga] \[rs]$* >>$TIMELOG\[dq] alias to=\[dq]echo o \[ga]date \[aq]+%Y-%m-%d %H:%M:%S\[aq]\[ga] >>$TIMELOG\[dq]\f[R] .IP \[bu] 2 -or use the old \f[C]ti\f[R] and \f[C]to\f[R] scripts in the ledger 2.x +or use the old \f[V]ti\f[R] and \f[V]to\f[R] scripts in the ledger 2.x repository. These rely on a \[dq]timeclock\[dq] executable which I think is just the ledger 2 executable renamed. .SH TIMEDOT FORMAT .PP -\f[C]timedot\f[R] format is hledger\[aq]s human-friendly time logging +\f[V]timedot\f[R] format is hledger\[aq]s human-friendly time logging format. -Compared to \f[C]timeclock\f[R] format, it is +Compared to \f[V]timeclock\f[R] format, it is .IP \[bu] 2 convenient for quick, approximate, and retroactive time logging .IP \[bu] 2 @@ -10572,7 +10591,7 @@ Optionally this can be followed on the same line by a common \f[B]transaction description\f[R] for this day .IP \[bu] 2 a common \f[B]transaction comment\f[R] for this day, after a semicolon -(\f[C];\f[R]). +(\f[V];\f[R]). .PP After the date line are zero or more optionally-indented time transaction lines, consisting of: @@ -10594,37 +10613,37 @@ In more detail, timedot amounts can be: \f[B]dots\f[R]: zero or more period characters, each representing one quarter-hour. Spaces are ignored and can be used for grouping. -Eg: \f[C].... ..\f[R] +Eg: \f[V].... ..\f[R] .IP \[bu] 2 a \f[B]number\f[R], representing hours. -Eg: \f[C]1.5\f[R] +Eg: \f[V]1.5\f[R] .IP \[bu] 2 -a \f[B]number immediately followed by a unit symbol\f[R] \f[C]s\f[R], -\f[C]m\f[R], \f[C]h\f[R], \f[C]d\f[R], \f[C]w\f[R], \f[C]mo\f[R], or -\f[C]y\f[R], representing seconds, minutes, hours, days weeks, months or +a \f[B]number immediately followed by a unit symbol\f[R] \f[V]s\f[R], +\f[V]m\f[R], \f[V]h\f[R], \f[V]d\f[R], \f[V]w\f[R], \f[V]mo\f[R], or +\f[V]y\f[R], representing seconds, minutes, hours, days weeks, months or years. -Eg \f[C]1.5h\f[R] or \f[C]90m\f[R]. +Eg \f[V]1.5h\f[R] or \f[V]90m\f[R]. The following equivalencies are assumed: .PD 0 .P .PD -\f[C]60s\f[R] = \f[C]1m\f[R], \f[C]60m\f[R] = \f[C]1h\f[R], -\f[C]24h\f[R] = \f[C]1d\f[R], \f[C]7d\f[R] = \f[C]1w\f[R], \f[C]30d\f[R] -= \f[C]1mo\f[R], \f[C]365d\f[R] = \f[C]1y\f[R]. +\f[V]60s\f[R] = \f[V]1m\f[R], \f[V]60m\f[R] = \f[V]1h\f[R], +\f[V]24h\f[R] = \f[V]1d\f[R], \f[V]7d\f[R] = \f[V]1w\f[R], \f[V]30d\f[R] += \f[V]1mo\f[R], \f[V]365d\f[R] = \f[V]1y\f[R]. (This unit will not be visible in the generated transaction amount, which is always in hours.) .PP There is some added flexibility to help with keeping time log data in the same file as your notes, todo lists, etc.: .IP \[bu] 2 -Lines beginning with \f[C]#\f[R] or \f[C];\f[R], and blank lines, are +Lines beginning with \f[V]#\f[R] or \f[V];\f[R], and blank lines, are ignored. .IP \[bu] 2 Lines not ending with a double-space and amount are parsed as transactions with zero amount. (Most hledger reports hide these by default; add -E to see them.) .IP \[bu] 2 -One or more stars (\f[C]*\f[R]) followed by a space, at the start of a +One or more stars (\f[V]*\f[R]) followed by a space, at the start of a line, is ignored. So date lines or time transaction lines can also be Org-mode headlines. .IP \[bu] 2 @@ -10777,10 +10796,10 @@ the confusing real world details described in OPTIONS, below. If that happens, here are some tips that may help: .IP \[bu] 2 command-specific options must go after the command (it\[aq]s fine to put -all options there) (\f[C]hledger CMD OPTS ARGS\f[R]) +all options there) (\f[V]hledger CMD OPTS ARGS\f[R]) .IP \[bu] 2 running add-on executables directly simplifies command line parsing -(\f[C]hledger-ui OPTS ARGS\f[R]) +(\f[V]hledger-ui OPTS ARGS\f[R]) .IP \[bu] 2 enclose \[dq]problematic\[dq] args in single quotes .IP \[bu] 2 @@ -10788,11 +10807,11 @@ if needed, also add a backslash to hide regular expression metacharacters from the shell .IP \[bu] 2 to see how a misbehaving command is being parsed, add -\f[C]--debug=2\f[R]. +\f[V]--debug=2\f[R]. .SS Starting a journal file .PP hledger looks for your accounting data in a journal file, -\f[C]$HOME/.hledger.journal\f[R] by default: +\f[V]$HOME/.hledger.journal\f[R] by default: .IP .nf \f[C] @@ -10803,7 +10822,7 @@ Or, specify an existing journal file with -f or LEDGER_FILE. \f[R] .fi .PP -You can override this by setting the \f[C]LEDGER_FILE\f[R] environment +You can override this by setting the \f[V]LEDGER_FILE\f[R] environment variable. It\[aq]s a good practice to keep this important file under version control, and to start a new file each year. @@ -10835,8 +10854,8 @@ Market prices : 0 () .SS Setting opening balances .PP Pick a starting date for which you can look up the balances of some -real-world assets (bank accounts, wallet..) and liabilities (credit -cards..). +real-world assets (bank accounts, wallet..) +and liabilities (credit cards..). .PP To avoid a lot of data entry, you may want to start with just one or two accounts, like your checking account or cash wallet; and pick a recent @@ -10876,7 +10895,7 @@ The = amounts are optional balance assertions, providing extra error checking. .RE .IP \[bu] 2 -The second way: run \f[C]hledger add\f[R] and follow the prompts to +The second way: run \f[V]hledger add\f[R] and follow the prompts to record a similar transaction: .RS 2 .IP @@ -10969,10 +10988,10 @@ A typical workflow: .IP "1." 3 Reconcile cash. Count what\[aq]s in your wallet. -Compare with what hledger reports (\f[C]hledger bal cash\f[R]). +Compare with what hledger reports (\f[V]hledger bal cash\f[R]). If they are different, try to remember the missing transaction, or look for the error in the already-recorded transactions. -A register report can be helpful (\f[C]hledger reg cash\f[R]). +A register report can be helpful (\f[V]hledger reg cash\f[R]). If you can\[aq]t find the error, add an adjustment transaction. Eg if you have $105 after the above, and can\[aq]t explain the missing $2, it could be: @@ -10990,12 +11009,12 @@ $2, it could be: Reconcile checking. Log in to your bank\[aq]s website. Compare today\[aq]s (cleared) balance with hledger\[aq]s cleared balance -(\f[C]hledger bal checking -C\f[R]). +(\f[V]hledger bal checking -C\f[R]). If they are different, track down the error or record the missing transaction(s) or add an adjustment transaction, similar to the above. Unlike the cash case, you can usually compare the transaction history and running balance from your bank with the one reported by -\f[C]hledger reg checking -C\f[R]. +\f[V]hledger reg checking -C\f[R]. This will be easier if you generally record transaction dates quite similar to your bank\[aq]s clearing dates. .IP "3." 3 @@ -11003,13 +11022,13 @@ Repeat for other asset/liability accounts. .PP Tip: instead of the register command, use hledger-ui to see a live-updating register while you edit the journal: -\f[C]hledger-ui --watch --register checking -C\f[R] +\f[V]hledger-ui --watch --register checking -C\f[R] .PP After reconciling, it could be a good time to mark the reconciled transactions\[aq] status as \[dq]cleared and confirmed\[dq], if you want -to track that, by adding the \f[C]*\f[R] marker. -Eg in the paycheck transaction above, insert \f[C]*\f[R] between -\f[C]2020-01-15\f[R] and \f[C]paycheck\f[R] +to track that, by adding the \f[V]*\f[R] marker. +Eg in the paycheck transaction above, insert \f[V]*\f[R] between +\f[V]2020-01-15\f[R] and \f[V]paycheck\f[R] .PP If you\[aq]re using version control, this can be another good time to commit: @@ -11141,7 +11160,7 @@ Balance Sheet 2020-01-16 .fi .PP The final total is your \[dq]net worth\[dq] on the end date. -(Or use \f[C]bse\f[R] for a full balance sheet with equity.) +(Or use \f[V]bse\f[R] for a full balance sheet with equity.) .PP Show income and expense totals, formatted as an income statement: .IP @@ -11201,11 +11220,11 @@ file, so that old transactions don\[aq]t slow down or clutter your reports, and to help ensure the integrity of your accounting history. See the close command. .PP -If using version control, don\[aq]t forget to \f[C]git add\f[R] the new +If using version control, don\[aq]t forget to \f[V]git add\f[R] the new file. .SH LIMITATIONS .PP -The need to precede add-on command options with \f[C]--\f[R] when +The need to precede add-on command options with \f[V]--\f[R] when invoked from hledger is awkward. .PP When input data contains non-ascii characters, a suitable system locale @@ -11246,10 +11265,10 @@ file\f[R] .PD 0 .P .PD -\f[C]LEDGER_FILE\f[R] should be a real environment variable, not just a +\f[V]LEDGER_FILE\f[R] should be a real environment variable, not just a shell variable. -The command \f[C]env | grep LEDGER_FILE\f[R] should show it. -You may need to use \f[C]export\f[R]. +The command \f[V]env | grep LEDGER_FILE\f[R] should show it. +You may need to use \f[V]export\f[R]. Here\[aq]s an explanation. .PP \f[B]Getting errors like \[dq]Illegal byte sequence\[dq] or \[dq]Invalid @@ -11259,10 +11278,10 @@ character)\[dq]\f[R] .PD 0 .P .PD -Programs compiled with GHC (hledger, haskell build tools, etc.) need to -have a UTF-8-aware locale configured in the environment, otherwise they -will fail with these kinds of errors when they encounter non-ascii -characters. +Programs compiled with GHC (hledger, haskell build tools, etc.) +need to have a UTF-8-aware locale configured in the environment, +otherwise they will fail with these kinds of errors when they encounter +non-ascii characters. .PP To fix it, set the LANG environment variable to some locale which supports UTF-8. @@ -11284,8 +11303,8 @@ $ LANG=en_US.utf8 hledger -f my.journal print # ensure it is used for this com \f[R] .fi .PP -If available, \f[C]C.UTF-8\f[R] will also work. -If your preferred locale isn\[aq]t listed by \f[C]locale -a\f[R], you +If available, \f[V]C.UTF-8\f[R] will also work. +If your preferred locale isn\[aq]t listed by \f[V]locale -a\f[R], you might need to install it. Eg on Ubuntu/Debian: .IP @@ -11315,7 +11334,7 @@ $ bash --login .fi .PP Exact spelling and capitalisation may be important. -Note the difference on MacOS (\f[C]UTF-8\f[R], not \f[C]utf8\f[R]). +Note the difference on MacOS (\f[V]UTF-8\f[R], not \f[V]utf8\f[R]). Some platforms (eg ubuntu) allow variant spellings, but others (eg macos) require it to be exact: .IP diff --git a/hledger/hledger.info b/hledger/hledger.info index 8781a6094..d4ec9f313 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -13,7 +13,7 @@ hledger(1) This is the command-line interface (CLI) for the hledger accounting tool. Here we also describe hledger's concepts and file formats. This -manual is for hledger 1.27.99. +manual is for hledger 1.28.99. 'hledger' @@ -720,16 +720,16 @@ Some commands offer additional output formats, other than the usual plain text terminal output. Here are those commands and the formats currently supported: -- txt csv html json sql ------------------------------------------------------------- -aregister Y Y Y -balance Y _1_ Y _1_ Y _1,2_ Y -balancesheet Y _1_ Y _1_ Y _1_ Y -balancesheetequity Y _1_ Y _1_ Y _1_ Y -cashflow Y _1_ Y _1_ Y _1_ Y -incomestatement Y _1_ Y _1_ Y _1_ Y -print Y Y Y Y -register Y Y Y +- txt csv html json sql +----------------------------------------------------------------------------- +aregister Y Y Y +balance Y _1_ Y _1_ Y _1,2_ Y +balancesheet Y _1_ Y _1_ Y _1_ Y +balancesheetequity Y _1_ Y _1_ Y _1_ Y +cashflow Y _1_ Y _1_ Y _1_ Y +incomestatement Y _1_ Y _1_ Y _1_ Y +print Y Y Y Y +register Y Y Y * _1 Also affected by the balance commands' '--layout' option._ * _2 'balance' does not support html output without a report interval @@ -1049,14 +1049,16 @@ the earliest or latest transaction in your journal: A single date with no "from" or "to" defines both the start and end date like so: -'-p "2009"' the year 2009; equivalent to “2009/1/1 to 2010/1/1” -'-p "2009/1"' the month of jan; equivalent to “2009/1/1 to 2009/2/1” -'-p "2009/1/1"' just that day; equivalent to “2009/1/1 to 2009/1/2” +'-p "2009"' the year 2009; equivalent to “2009/1/1 to 2010/1/1” +'-p "2009/1"' the month of jan; equivalent to “2009/1/1 to 2009/2/1” +'-p just that day; equivalent to “2009/1/1 to 2009/1/2” +"2009/1/1"' Or you can specify a single quarter like so: -'-p "2009Q1"' first quarter of 2009, equivalent to “2009/1/1 to 2009/4/1” -'-p "q4"' fourth quarter of the current year +'-p "2009Q1"' first quarter of 2009, equivalent to “2009/1/1 to + 2009/4/1” +'-p "q4"' fourth quarter of the current year * Menu: @@ -1367,28 +1369,35 @@ File: hledger.info, Node: Combining query terms, Next: Queries and command opt 7.2 Combining query terms ========================= -Most commands select things which match: +When given multiple query terms, most commands select things which +match: * any of the description terms AND * any of the account terms AND * any of the status terms AND * all the other terms. - while the print command shows transactions which: + The print command is a little different, showing transactions which: * match any of the description terms AND * have any postings matching any of the positive account terms AND * have no postings matching any of the negative account terms AND * match all the other terms. - You can do more powerful queries (such as AND-ing two like terms) by -running a first query with 'print', and piping the result into a second -hledger command. Eg: how much of food expenses was paid with cash ? + Although these fixed rules are enough for many needs, we do not +support full boolean expressions (#203), (and you should not write AND +or OR in your queries). This makes certain queries hard to express, but +here are some tricks that can help: -$ hledger print assets:cash | hledger -f- -I balance expenses:food + 1. Use a doubled 'not:' prefix. Eg, to print only the food expenses + paid with cash: - If you are interested in full boolean expressions for queries, see -#203. + $ hledger print food not:not:cash + + 2. Or pre-filter the transactions with 'print', piping the result into + a second hledger command (with balance assertions disabled): + + $ hledger print cash | hledger -f- -I balance food  File: hledger.info, Node: Queries and command options, Next: Queries and account aliases, Prev: Combining query terms, Up: QUERIES @@ -4154,13 +4163,14 @@ be the closing date. The opening date is always the following day. So to close on (end of) 2020-12-31 and open on (start of) 2021-01-01, any of these will work: -end date explanation +end date explanation argument -------------------------------------------------------------------- -'-e 2021-01-01' end dates are exclusive -'-e 2021' equivalent, per smart dates -'-p 2020' equivalent, the period's begin date is ignored -'date:2020' equivalent query +-------------------------------------------------------------------------- +'-e end dates are exclusive +2021-01-01' +'-e 2021' equivalent, per smart dates +'-p 2020' equivalent, the period's begin date is ignored +'date:2020' equivalent query  File: hledger.info, Node: Example close asset/liability accounts for file transition, Next: Hiding opening/closing transactions, Prev: close date, Up: close @@ -4770,10 +4780,11 @@ keeping the output parseable. With '-B'/'--cost', amounts with transaction prices are converted to cost using that price. This can be used for troubleshooting. - With '-m'/'--match' and a STR argument, print will show at most one -transaction: the one one whose description is most similar to STR, and -is most recent. STR should contain at least two characters. If there -is no similar-enough match, no transaction will be shown. + With '-m DESC'/'--match=DESC', print does a fuzzy search for the one +transaction whose description is most similar to DESC, also preferring +recent tranactions. DESC should contain at least two characters. If +there is no similar-enough match, no transaction will be shown and the +program exit code will be non-zero. With '--new', hledger prints only transactions it has not seen on a previous run. This uses the same deduplication system as the 'import' @@ -9828,522 +9839,522 @@ Node: Output styling21710 Ref: #output-styling21856 Node: Output format22613 Ref: #output-format22755 -Node: CSV output24119 -Ref: #csv-output24235 -Node: HTML output24338 -Ref: #html-output24476 -Node: JSON output24570 -Ref: #json-output24708 -Node: SQL output25625 -Ref: #sql-output25741 -Node: Commodity styles26242 -Ref: #commodity-styles26388 -Node: Debug output27164 -Ref: #debug-output27280 -Node: TIME PERIODS27946 -Ref: #time-periods28059 -Node: Smart dates28157 -Ref: #smart-dates28283 -Node: Report start & end date30113 -Ref: #report-start-end-date30288 -Node: Report intervals31955 -Ref: #report-intervals32123 -Node: Period expressions33862 -Ref: #period-expressions34002 -Node: Period expressions with a report interval35733 -Ref: #period-expressions-with-a-report-interval35965 -Node: More complex report intervals37046 -Ref: #more-complex-report-intervals37295 -Node: Intervals with custom start date37935 -Ref: #intervals-with-custom-start-date38167 -Node: Periods or dates ?39741 -Ref: #periods-or-dates39943 -Node: Events on multiple weekdays40385 -Ref: #events-on-multiple-weekdays40564 -Node: DEPTH41427 -Ref: #depth41527 -Node: QUERIES41861 -Ref: #queries41957 -Node: Query types42898 -Ref: #query-types43017 -Node: Combining query terms46191 -Ref: #combining-query-terms46366 -Node: Queries and command options47169 -Ref: #queries-and-command-options47372 -Node: Queries and account aliases47621 -Ref: #queries-and-account-aliases47824 -Node: Queries and valuation47944 -Ref: #queries-and-valuation48137 -Node: Querying with account aliases48366 -Ref: #querying-with-account-aliases48575 -Node: Querying with cost or value48705 -Ref: #querying-with-cost-or-value48880 -Node: COST49181 -Ref: #cost49275 -Node: -B Convert to cost50469 -Ref: #b-convert-to-cost50613 -Node: Equity conversion postings52041 -Ref: #equity-conversion-postings52243 -Node: Inferring equity postings from cost52870 -Ref: #inferring-equity-postings-from-cost53107 -Node: Inferring cost from equity postings54096 -Ref: #inferring-cost-from-equity-postings54332 -Node: When to infer cost/equity56557 -Ref: #when-to-infer-costequity56763 -Node: How to record conversions57159 -Ref: #how-to-record-conversions57339 -Node: Conversion with implicit cost57630 -Ref: #conversion-with-implicit-cost57833 -Node: Conversion with explicit cost58710 -Ref: #conversion-with-explicit-cost58953 -Node: Conversion with equity postings59370 -Ref: #conversion-with-equity-postings59637 -Node: Conversion with equity postings and explicit cost60456 -Ref: #conversion-with-equity-postings-and-explicit-cost60721 -Node: Cost tips61326 -Ref: #cost-tips61440 -Node: VALUATION62169 -Ref: #valuation62274 -Node: -V Value63041 -Ref: #v-value63165 -Node: -X Value in specified commodity63360 -Ref: #x-value-in-specified-commodity63553 -Node: Valuation date63702 -Ref: #valuation-date63864 -Node: Market prices64301 -Ref: #market-prices64483 -Node: --infer-market-prices market prices from transactions65666 -Ref: #infer-market-prices-market-prices-from-transactions65933 -Node: Valuation commodity67817 -Ref: #valuation-commodity68028 -Node: Simple valuation examples69254 -Ref: #simple-valuation-examples69450 -Node: --value Flexible valuation70109 -Ref: #value-flexible-valuation70311 -Node: More valuation examples71955 -Ref: #more-valuation-examples72162 -Node: Interaction of valuation and queries74161 -Ref: #interaction-of-valuation-and-queries74400 -Node: Effect of valuation on reports74872 -Ref: #effect-of-valuation-on-reports75067 -Node: PIVOTING82764 -Ref: #pivoting82873 -Node: COMMANDS84559 -Ref: #commands84673 -Node: accounts87927 -Ref: #accounts88027 -Node: activity89923 -Ref: #activity90035 -Node: add90418 -Ref: #add90521 -Node: aregister93329 -Ref: #aregister93443 -Node: aregister and custom posting dates96112 -Ref: #aregister-and-custom-posting-dates96278 -Node: balance96830 -Ref: #balance96949 -Node: balance features97942 -Ref: #balance-features98082 -Node: Simple balance report100006 -Ref: #simple-balance-report100188 -Node: Filtered balance report101668 -Ref: #filtered-balance-report101855 -Node: List or tree mode102182 -Ref: #list-or-tree-mode102350 -Node: Depth limiting103695 -Ref: #depth-limiting103861 -Node: Dropping top-level accounts104462 -Ref: #dropping-top-level-accounts104664 -Node: Multi-period balance report104974 -Ref: #multi-period-balance-report105187 -Node: Showing declared accounts107462 -Ref: #showing-declared-accounts107655 -Node: Data layout108186 -Ref: #data-layout108341 -Node: Sorting by amount116281 -Ref: #sorting-by-amount116436 -Node: Percentages117106 -Ref: #percentages117264 -Node: Balance change end balance118225 -Ref: #balance-change-end-balance118418 -Node: Balance report types119846 -Ref: #balance-report-types120036 -Node: Useful balance reports124315 -Ref: #useful-balance-reports124496 -Node: Budget report125581 -Ref: #budget-report125765 -Node: Budget report start date131040 -Ref: #budget-report-start-date131218 -Node: Budgets and subaccounts132550 -Ref: #budgets-and-subaccounts132757 -Node: Selecting budget goals136197 -Ref: #selecting-budget-goals136369 -Node: Customising single-period balance reports137403 -Ref: #customising-single-period-balance-reports137612 -Node: balancesheet139787 -Ref: #balancesheet139925 -Node: balancesheetequity141253 -Ref: #balancesheetequity141404 -Node: cashflow142807 -Ref: #cashflow142931 -Node: check144363 -Ref: #check144468 -Node: Basic checks145276 -Ref: #basic-checks145394 -Node: Strict checks145945 -Ref: #strict-checks146086 -Node: Other checks146522 -Ref: #other-checks146662 -Node: Custom checks147161 -Ref: #custom-checks147316 -Node: More about specific checks147733 -Ref: #more-about-specific-checks147893 -Node: close148621 -Ref: #close148725 -Node: close and prices150816 -Ref: #close-and-prices150945 -Node: close date151340 -Ref: #close-date151524 -Node: Example close asset/liability accounts for file transition152281 -Ref: #example-close-assetliability-accounts-for-file-transition152582 -Node: Hiding opening/closing transactions153441 -Ref: #hiding-openingclosing-transactions153712 -Node: close and balance assertions155089 -Ref: #close-and-balance-assertions155347 -Node: Example close revenue/expense accounts to retained earnings156701 -Ref: #example-close-revenueexpense-accounts-to-retained-earnings156979 -Node: codes157869 -Ref: #codes157979 -Node: commodities158691 -Ref: #commodities158820 -Node: descriptions158902 -Ref: #descriptions159032 -Node: diff159336 -Ref: #diff159444 -Node: files160491 -Ref: #files160593 -Node: help160740 -Ref: #help160842 -Node: import161793 -Ref: #import161909 -Node: Deduplication163002 -Ref: #deduplication163127 -Node: Import testing165021 -Ref: #import-testing165186 -Node: Importing balance assignments165674 -Ref: #importing-balance-assignments165880 -Node: Commodity display styles166529 -Ref: #commodity-display-styles166702 -Node: incomestatement166831 -Ref: #incomestatement166966 -Node: notes168298 -Ref: #notes168413 -Node: payees168781 -Ref: #payees168889 -Node: prices169415 -Ref: #prices169523 -Node: print169892 -Ref: #print170004 -Node: print-unique175372 -Ref: #print-unique175500 -Node: register175785 -Ref: #register175914 -Node: Custom register output180664 -Ref: #custom-register-output180795 -Node: register-match182132 -Ref: #register-match182268 -Node: rewrite182619 -Ref: #rewrite182736 -Node: Re-write rules in a file184642 -Ref: #re-write-rules-in-a-file184805 -Node: Diff output format185954 -Ref: #diff-output-format186137 -Node: rewrite vs print --auto187229 -Ref: #rewrite-vs.-print---auto187389 -Node: roi187945 -Ref: #roi188045 -Node: Spaces and special characters in --inv and --pnl189770 -Ref: #spaces-and-special-characters-in---inv-and---pnl190010 -Node: Semantics of --inv and --pnl190498 -Ref: #semantics-of---inv-and---pnl190737 -Node: IRR and TWR explained192587 -Ref: #irr-and-twr-explained192747 -Node: stats195833 -Ref: #stats195934 -Node: tags197314 -Ref: #tags197414 -Node: test198428 -Ref: #test198538 -Node: Add-on commands199285 -Ref: #add-on-commands199404 -Node: JOURNAL FORMAT200535 -Ref: #journal-format200663 -Node: Transactions202890 -Ref: #transactions203005 -Node: Dates204019 -Ref: #dates204135 -Node: Simple dates204200 -Ref: #simple-dates204320 -Node: Secondary dates204829 -Ref: #secondary-dates204977 -Node: Posting dates206313 -Ref: #posting-dates206436 -Node: Status207808 -Ref: #status207918 -Node: Code209626 -Ref: #code209738 -Node: Description209970 -Ref: #description210098 -Node: Payee and note210418 -Ref: #payee-and-note210526 -Node: Comments210861 -Ref: #comments210983 -Node: Tags212177 -Ref: #tags-1212288 -Node: Postings213743 -Ref: #postings213867 -Node: Virtual postings214893 -Ref: #virtual-postings215004 -Node: Account names216309 -Ref: #account-names216446 -Node: Amounts216934 -Ref: #amounts217071 -Node: Decimal marks digit group marks218056 -Ref: #decimal-marks-digit-group-marks218233 -Node: Commodity219254 -Ref: #commodity219443 -Node: Directives influencing number parsing and display220395 -Ref: #directives-influencing-number-parsing-and-display220656 -Node: Commodity display style221149 -Ref: #commodity-display-style221357 -Node: Rounding223552 -Ref: #rounding223672 -Node: Transaction prices224084 -Ref: #transaction-prices224250 -Node: Lot prices lot dates226173 -Ref: #lot-prices-lot-dates226356 -Node: Balance assertions226844 -Ref: #balance-assertions227022 -Node: Assertions and ordering228095 -Ref: #assertions-and-ordering228286 -Node: Assertions and multiple included files228986 -Ref: #assertions-and-multiple-included-files229248 -Node: Assertions and multiple -f files229748 -Ref: #assertions-and-multiple--f-files230001 -Node: Assertions and commodities230398 -Ref: #assertions-and-commodities230622 -Node: Assertions and prices231802 -Ref: #assertions-and-prices232010 -Node: Assertions and subaccounts232450 -Ref: #assertions-and-subaccounts232673 -Node: Assertions and virtual postings232997 -Ref: #assertions-and-virtual-postings233237 -Node: Assertions and auto postings233369 -Ref: #assertions-and-auto-postings233601 -Node: Assertions and precision234246 -Ref: #assertions-and-precision234430 -Node: Balance assignments234697 -Ref: #balance-assignments234867 -Node: Balance assignments and prices236031 -Ref: #balance-assignments-and-prices236197 -Node: Directives236421 -Ref: #directives236584 -Node: Directives and multiple files241076 -Ref: #directives-and-multiple-files241272 -Node: Comment blocks241964 -Ref: #comment-blocks242141 -Node: Including other files242317 -Ref: #including-other-files242491 -Node: Default year243415 -Ref: #default-year243573 -Node: Declaring payees243980 -Ref: #declaring-payees244151 -Node: Declaring the decimal mark244397 -Ref: #declaring-the-decimal-mark244597 -Node: Declaring commodities244994 -Ref: #declaring-commodities245185 -Node: Commodity error checking247703 -Ref: #commodity-error-checking247853 -Node: Default commodity248368 -Ref: #default-commodity248548 -Node: Declaring market prices249664 -Ref: #declaring-market-prices249853 -Node: Declaring accounts250666 -Ref: #declaring-accounts250846 -Node: Account comments252010 -Ref: #account-comments252163 -Node: Account subdirectives252586 -Ref: #account-subdirectives252780 -Node: Account error checking252922 -Ref: #account-error-checking253123 -Node: Account display order254312 -Ref: #account-display-order254503 -Node: Account types255604 -Ref: #account-types255748 -Node: Rewriting accounts259422 -Ref: #rewriting-accounts259601 -Node: Basic aliases260641 -Ref: #basic-aliases260777 -Node: Regex aliases261521 -Ref: #regex-aliases261683 -Node: Combining aliases262573 -Ref: #combining-aliases262756 -Node: Aliases and multiple files264032 -Ref: #aliases-and-multiple-files264231 -Node: end aliases264810 -Ref: #end-aliases265004 -Node: Aliases can generate bad account names265153 -Ref: #aliases-can-generate-bad-account-names265396 -Node: Aliases and account types265981 -Ref: #aliases-and-account-types266178 -Node: Default parent account266874 -Ref: #default-parent-account267064 -Node: Periodic transactions267948 -Ref: #periodic-transactions268131 -Node: Periodic rule syntax270086 -Ref: #periodic-rule-syntax270266 -Node: Periodic rules and relative dates270725 -Ref: #periodic-rules-and-relative-dates270993 -Node: Two spaces between period expression and description!271504 -Ref: #two-spaces-between-period-expression-and-description271830 -Node: Forecasting with periodic transactions272514 -Ref: #forecasting-with-periodic-transactions272813 -Node: Budgeting with periodic transactions275584 -Ref: #budgeting-with-periodic-transactions275817 -Node: Auto postings276226 -Ref: #auto-postings276362 -Node: Auto postings and multiple files278541 -Ref: #auto-postings-and-multiple-files278739 -Node: Auto postings and dates278948 -Ref: #auto-postings-and-dates279216 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions279391 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions279736 -Node: Auto posting tags280239 -Ref: #auto-posting-tags280448 -Node: CSV FORMAT281084 -Ref: #csv-format281212 -Node: Examples284038 -Ref: #examples284141 -Node: Basic284349 -Ref: #basic284451 -Node: Bank of Ireland284993 -Ref: #bank-of-ireland285130 -Node: Amazon286592 -Ref: #amazon286712 -Node: Paypal288431 -Ref: #paypal288527 -Node: CSV rules296171 -Ref: #csv-rules296289 -Node: skip296658 -Ref: #skip296758 -Node: fields list297133 -Ref: #fields-list297272 -Node: field assignment298838 -Ref: #field-assignment298990 -Node: Field names300025 -Ref: #field-names300165 -Node: date field300545 -Ref: #date-field300665 -Node: date2 field300713 -Ref: #date2-field300856 -Node: status field300912 -Ref: #status-field301057 -Node: code field301106 -Ref: #code-field301253 -Node: description field301298 -Ref: #description-field301460 -Node: comment field301519 -Ref: #comment-field301676 -Node: account field301987 -Ref: #account-field302139 -Node: amount field302714 -Ref: #amount-field302865 -Node: currency field304110 -Ref: #currency-field304265 -Node: balance field304522 -Ref: #balance-field304656 -Node: separator305028 -Ref: #separator305160 -Node: if block305700 -Ref: #if-block305827 -Node: Matching the whole record306228 -Ref: #matching-the-whole-record306405 -Node: Matching individual fields307208 -Ref: #matching-individual-fields307414 -Node: Combining matchers307638 -Ref: #combining-matchers307836 -Node: Rules applied on successful match308149 -Ref: #rules-applied-on-successful-match308342 -Node: if table308996 -Ref: #if-table309117 -Node: end310855 -Ref: #end310969 -Node: date-format311193 -Ref: #date-format311323 -Node: timezone312047 -Ref: #timezone312182 -Node: decimal-mark313187 -Ref: #decimal-mark313331 -Node: newest-first313670 -Ref: #newest-first313824 -Node: intra-day-reversed314402 -Ref: #intra-day-reversed314563 -Node: include315056 -Ref: #include315195 -Node: balance-type315639 -Ref: #balance-type315761 -Node: Tips316461 -Ref: #tips316552 -Node: Rapid feedback316851 -Ref: #rapid-feedback316970 -Node: Valid CSV317422 -Ref: #valid-csv317554 -Node: File Extension317746 -Ref: #file-extension317900 -Node: Reading multiple CSV files318329 -Ref: #reading-multiple-csv-files318516 -Node: Valid transactions318757 -Ref: #valid-transactions318937 -Node: Deduplicating importing319565 -Ref: #deduplicating-importing319746 -Node: Setting amounts320782 -Ref: #setting-amounts320939 -Node: Amount signs323383 -Ref: #amount-signs323537 -Node: Setting currency/commodity324224 -Ref: #setting-currencycommodity324412 -Node: Amount decimal places325586 -Ref: #amount-decimal-places325778 -Node: Referencing other fields326090 -Ref: #referencing-other-fields326289 -Node: How CSV rules are evaluated327186 -Ref: #how-csv-rules-are-evaluated327361 -Node: TIMECLOCK FORMAT328812 -Ref: #timeclock-format328952 -Node: TIMEDOT FORMAT331013 -Ref: #timedot-format331151 -Node: COMMON TASKS335713 -Ref: #common-tasks335842 -Node: Getting help336116 -Ref: #getting-help336250 -Node: Constructing command lines337002 -Ref: #constructing-command-lines337196 -Node: Starting a journal file337893 -Ref: #starting-a-journal-file338093 -Node: Setting opening balances339281 -Ref: #setting-opening-balances339479 -Node: Recording transactions342620 -Ref: #recording-transactions342802 -Node: Reconciling343358 -Ref: #reconciling343503 -Node: Reporting345760 -Ref: #reporting345902 -Node: Migrating to a new file349887 -Ref: #migrating-to-a-new-file350037 -Node: LIMITATIONS350336 -Ref: #limitations350464 -Node: TROUBLESHOOTING351233 -Ref: #troubleshooting351348 +Node: CSV output24266 +Ref: #csv-output24382 +Node: HTML output24485 +Ref: #html-output24623 +Node: JSON output24717 +Ref: #json-output24855 +Node: SQL output25772 +Ref: #sql-output25888 +Node: Commodity styles26389 +Ref: #commodity-styles26535 +Node: Debug output27311 +Ref: #debug-output27427 +Node: TIME PERIODS28093 +Ref: #time-periods28206 +Node: Smart dates28304 +Ref: #smart-dates28430 +Node: Report start & end date30260 +Ref: #report-start-end-date30435 +Node: Report intervals32102 +Ref: #report-intervals32270 +Node: Period expressions34009 +Ref: #period-expressions34149 +Node: Period expressions with a report interval35908 +Ref: #period-expressions-with-a-report-interval36140 +Node: More complex report intervals37221 +Ref: #more-complex-report-intervals37470 +Node: Intervals with custom start date38110 +Ref: #intervals-with-custom-start-date38342 +Node: Periods or dates ?39916 +Ref: #periods-or-dates40118 +Node: Events on multiple weekdays40560 +Ref: #events-on-multiple-weekdays40739 +Node: DEPTH41602 +Ref: #depth41702 +Node: QUERIES42036 +Ref: #queries42132 +Node: Query types43073 +Ref: #query-types43192 +Node: Combining query terms46366 +Ref: #combining-query-terms46541 +Node: Queries and command options47615 +Ref: #queries-and-command-options47818 +Node: Queries and account aliases48067 +Ref: #queries-and-account-aliases48270 +Node: Queries and valuation48390 +Ref: #queries-and-valuation48583 +Node: Querying with account aliases48812 +Ref: #querying-with-account-aliases49021 +Node: Querying with cost or value49151 +Ref: #querying-with-cost-or-value49326 +Node: COST49627 +Ref: #cost49721 +Node: -B Convert to cost50915 +Ref: #b-convert-to-cost51059 +Node: Equity conversion postings52487 +Ref: #equity-conversion-postings52689 +Node: Inferring equity postings from cost53316 +Ref: #inferring-equity-postings-from-cost53553 +Node: Inferring cost from equity postings54542 +Ref: #inferring-cost-from-equity-postings54778 +Node: When to infer cost/equity57003 +Ref: #when-to-infer-costequity57209 +Node: How to record conversions57605 +Ref: #how-to-record-conversions57785 +Node: Conversion with implicit cost58076 +Ref: #conversion-with-implicit-cost58279 +Node: Conversion with explicit cost59156 +Ref: #conversion-with-explicit-cost59399 +Node: Conversion with equity postings59816 +Ref: #conversion-with-equity-postings60083 +Node: Conversion with equity postings and explicit cost60902 +Ref: #conversion-with-equity-postings-and-explicit-cost61167 +Node: Cost tips61772 +Ref: #cost-tips61886 +Node: VALUATION62615 +Ref: #valuation62720 +Node: -V Value63487 +Ref: #v-value63611 +Node: -X Value in specified commodity63806 +Ref: #x-value-in-specified-commodity63999 +Node: Valuation date64148 +Ref: #valuation-date64310 +Node: Market prices64747 +Ref: #market-prices64929 +Node: --infer-market-prices market prices from transactions66112 +Ref: #infer-market-prices-market-prices-from-transactions66379 +Node: Valuation commodity68263 +Ref: #valuation-commodity68474 +Node: Simple valuation examples69700 +Ref: #simple-valuation-examples69896 +Node: --value Flexible valuation70555 +Ref: #value-flexible-valuation70757 +Node: More valuation examples72401 +Ref: #more-valuation-examples72608 +Node: Interaction of valuation and queries74607 +Ref: #interaction-of-valuation-and-queries74846 +Node: Effect of valuation on reports75318 +Ref: #effect-of-valuation-on-reports75513 +Node: PIVOTING83210 +Ref: #pivoting83319 +Node: COMMANDS85005 +Ref: #commands85119 +Node: accounts88373 +Ref: #accounts88473 +Node: activity90369 +Ref: #activity90481 +Node: add90864 +Ref: #add90967 +Node: aregister93775 +Ref: #aregister93889 +Node: aregister and custom posting dates96558 +Ref: #aregister-and-custom-posting-dates96724 +Node: balance97276 +Ref: #balance97395 +Node: balance features98388 +Ref: #balance-features98528 +Node: Simple balance report100452 +Ref: #simple-balance-report100634 +Node: Filtered balance report102114 +Ref: #filtered-balance-report102301 +Node: List or tree mode102628 +Ref: #list-or-tree-mode102796 +Node: Depth limiting104141 +Ref: #depth-limiting104307 +Node: Dropping top-level accounts104908 +Ref: #dropping-top-level-accounts105110 +Node: Multi-period balance report105420 +Ref: #multi-period-balance-report105633 +Node: Showing declared accounts107908 +Ref: #showing-declared-accounts108101 +Node: Data layout108632 +Ref: #data-layout108787 +Node: Sorting by amount116727 +Ref: #sorting-by-amount116882 +Node: Percentages117552 +Ref: #percentages117710 +Node: Balance change end balance118671 +Ref: #balance-change-end-balance118864 +Node: Balance report types120292 +Ref: #balance-report-types120482 +Node: Useful balance reports124761 +Ref: #useful-balance-reports124942 +Node: Budget report126027 +Ref: #budget-report126211 +Node: Budget report start date131486 +Ref: #budget-report-start-date131664 +Node: Budgets and subaccounts132996 +Ref: #budgets-and-subaccounts133203 +Node: Selecting budget goals136643 +Ref: #selecting-budget-goals136815 +Node: Customising single-period balance reports137849 +Ref: #customising-single-period-balance-reports138058 +Node: balancesheet140233 +Ref: #balancesheet140371 +Node: balancesheetequity141699 +Ref: #balancesheetequity141850 +Node: cashflow143253 +Ref: #cashflow143377 +Node: check144809 +Ref: #check144914 +Node: Basic checks145722 +Ref: #basic-checks145840 +Node: Strict checks146391 +Ref: #strict-checks146532 +Node: Other checks146968 +Ref: #other-checks147108 +Node: Custom checks147607 +Ref: #custom-checks147762 +Node: More about specific checks148179 +Ref: #more-about-specific-checks148339 +Node: close149067 +Ref: #close149171 +Node: close and prices151262 +Ref: #close-and-prices151391 +Node: close date151786 +Ref: #close-date151970 +Node: Example close asset/liability accounts for file transition152736 +Ref: #example-close-assetliability-accounts-for-file-transition153037 +Node: Hiding opening/closing transactions153896 +Ref: #hiding-openingclosing-transactions154167 +Node: close and balance assertions155544 +Ref: #close-and-balance-assertions155802 +Node: Example close revenue/expense accounts to retained earnings157156 +Ref: #example-close-revenueexpense-accounts-to-retained-earnings157434 +Node: codes158324 +Ref: #codes158434 +Node: commodities159146 +Ref: #commodities159275 +Node: descriptions159357 +Ref: #descriptions159487 +Node: diff159791 +Ref: #diff159899 +Node: files160946 +Ref: #files161048 +Node: help161195 +Ref: #help161297 +Node: import162248 +Ref: #import162364 +Node: Deduplication163457 +Ref: #deduplication163582 +Node: Import testing165476 +Ref: #import-testing165641 +Node: Importing balance assignments166129 +Ref: #importing-balance-assignments166335 +Node: Commodity display styles166984 +Ref: #commodity-display-styles167157 +Node: incomestatement167286 +Ref: #incomestatement167421 +Node: notes168753 +Ref: #notes168868 +Node: payees169236 +Ref: #payees169344 +Node: prices169870 +Ref: #prices169978 +Node: print170347 +Ref: #print170459 +Node: print-unique175876 +Ref: #print-unique176004 +Node: register176289 +Ref: #register176418 +Node: Custom register output181168 +Ref: #custom-register-output181299 +Node: register-match182636 +Ref: #register-match182772 +Node: rewrite183123 +Ref: #rewrite183240 +Node: Re-write rules in a file185146 +Ref: #re-write-rules-in-a-file185309 +Node: Diff output format186458 +Ref: #diff-output-format186641 +Node: rewrite vs print --auto187733 +Ref: #rewrite-vs.-print---auto187893 +Node: roi188449 +Ref: #roi188549 +Node: Spaces and special characters in --inv and --pnl190274 +Ref: #spaces-and-special-characters-in---inv-and---pnl190514 +Node: Semantics of --inv and --pnl191002 +Ref: #semantics-of---inv-and---pnl191241 +Node: IRR and TWR explained193091 +Ref: #irr-and-twr-explained193251 +Node: stats196337 +Ref: #stats196438 +Node: tags197818 +Ref: #tags197918 +Node: test198932 +Ref: #test199042 +Node: Add-on commands199789 +Ref: #add-on-commands199908 +Node: JOURNAL FORMAT201039 +Ref: #journal-format201167 +Node: Transactions203394 +Ref: #transactions203509 +Node: Dates204523 +Ref: #dates204639 +Node: Simple dates204704 +Ref: #simple-dates204824 +Node: Secondary dates205333 +Ref: #secondary-dates205481 +Node: Posting dates206817 +Ref: #posting-dates206940 +Node: Status208312 +Ref: #status208422 +Node: Code210130 +Ref: #code210242 +Node: Description210474 +Ref: #description210602 +Node: Payee and note210922 +Ref: #payee-and-note211030 +Node: Comments211365 +Ref: #comments211487 +Node: Tags212681 +Ref: #tags-1212792 +Node: Postings214247 +Ref: #postings214371 +Node: Virtual postings215397 +Ref: #virtual-postings215508 +Node: Account names216813 +Ref: #account-names216950 +Node: Amounts217438 +Ref: #amounts217575 +Node: Decimal marks digit group marks218560 +Ref: #decimal-marks-digit-group-marks218737 +Node: Commodity219758 +Ref: #commodity219947 +Node: Directives influencing number parsing and display220899 +Ref: #directives-influencing-number-parsing-and-display221160 +Node: Commodity display style221653 +Ref: #commodity-display-style221861 +Node: Rounding224056 +Ref: #rounding224176 +Node: Transaction prices224588 +Ref: #transaction-prices224754 +Node: Lot prices lot dates226677 +Ref: #lot-prices-lot-dates226860 +Node: Balance assertions227348 +Ref: #balance-assertions227526 +Node: Assertions and ordering228599 +Ref: #assertions-and-ordering228790 +Node: Assertions and multiple included files229490 +Ref: #assertions-and-multiple-included-files229752 +Node: Assertions and multiple -f files230252 +Ref: #assertions-and-multiple--f-files230505 +Node: Assertions and commodities230902 +Ref: #assertions-and-commodities231126 +Node: Assertions and prices232306 +Ref: #assertions-and-prices232514 +Node: Assertions and subaccounts232954 +Ref: #assertions-and-subaccounts233177 +Node: Assertions and virtual postings233501 +Ref: #assertions-and-virtual-postings233741 +Node: Assertions and auto postings233873 +Ref: #assertions-and-auto-postings234105 +Node: Assertions and precision234750 +Ref: #assertions-and-precision234934 +Node: Balance assignments235201 +Ref: #balance-assignments235371 +Node: Balance assignments and prices236535 +Ref: #balance-assignments-and-prices236701 +Node: Directives236925 +Ref: #directives237088 +Node: Directives and multiple files241580 +Ref: #directives-and-multiple-files241776 +Node: Comment blocks242468 +Ref: #comment-blocks242645 +Node: Including other files242821 +Ref: #including-other-files242995 +Node: Default year243919 +Ref: #default-year244077 +Node: Declaring payees244484 +Ref: #declaring-payees244655 +Node: Declaring the decimal mark244901 +Ref: #declaring-the-decimal-mark245101 +Node: Declaring commodities245498 +Ref: #declaring-commodities245689 +Node: Commodity error checking248207 +Ref: #commodity-error-checking248357 +Node: Default commodity248872 +Ref: #default-commodity249052 +Node: Declaring market prices250168 +Ref: #declaring-market-prices250357 +Node: Declaring accounts251170 +Ref: #declaring-accounts251350 +Node: Account comments252514 +Ref: #account-comments252667 +Node: Account subdirectives253090 +Ref: #account-subdirectives253284 +Node: Account error checking253426 +Ref: #account-error-checking253627 +Node: Account display order254816 +Ref: #account-display-order255007 +Node: Account types256108 +Ref: #account-types256252 +Node: Rewriting accounts259926 +Ref: #rewriting-accounts260105 +Node: Basic aliases261145 +Ref: #basic-aliases261281 +Node: Regex aliases262025 +Ref: #regex-aliases262187 +Node: Combining aliases263077 +Ref: #combining-aliases263260 +Node: Aliases and multiple files264536 +Ref: #aliases-and-multiple-files264735 +Node: end aliases265314 +Ref: #end-aliases265508 +Node: Aliases can generate bad account names265657 +Ref: #aliases-can-generate-bad-account-names265900 +Node: Aliases and account types266485 +Ref: #aliases-and-account-types266682 +Node: Default parent account267378 +Ref: #default-parent-account267568 +Node: Periodic transactions268452 +Ref: #periodic-transactions268635 +Node: Periodic rule syntax270590 +Ref: #periodic-rule-syntax270770 +Node: Periodic rules and relative dates271229 +Ref: #periodic-rules-and-relative-dates271497 +Node: Two spaces between period expression and description!272008 +Ref: #two-spaces-between-period-expression-and-description272334 +Node: Forecasting with periodic transactions273018 +Ref: #forecasting-with-periodic-transactions273317 +Node: Budgeting with periodic transactions276088 +Ref: #budgeting-with-periodic-transactions276321 +Node: Auto postings276730 +Ref: #auto-postings276866 +Node: Auto postings and multiple files279045 +Ref: #auto-postings-and-multiple-files279243 +Node: Auto postings and dates279452 +Ref: #auto-postings-and-dates279720 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions279895 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions280240 +Node: Auto posting tags280743 +Ref: #auto-posting-tags280952 +Node: CSV FORMAT281588 +Ref: #csv-format281716 +Node: Examples284542 +Ref: #examples284645 +Node: Basic284853 +Ref: #basic284955 +Node: Bank of Ireland285497 +Ref: #bank-of-ireland285634 +Node: Amazon287096 +Ref: #amazon287216 +Node: Paypal288935 +Ref: #paypal289031 +Node: CSV rules296675 +Ref: #csv-rules296793 +Node: skip297162 +Ref: #skip297262 +Node: fields list297637 +Ref: #fields-list297776 +Node: field assignment299342 +Ref: #field-assignment299494 +Node: Field names300529 +Ref: #field-names300669 +Node: date field301049 +Ref: #date-field301169 +Node: date2 field301217 +Ref: #date2-field301360 +Node: status field301416 +Ref: #status-field301561 +Node: code field301610 +Ref: #code-field301757 +Node: description field301802 +Ref: #description-field301964 +Node: comment field302023 +Ref: #comment-field302180 +Node: account field302491 +Ref: #account-field302643 +Node: amount field303218 +Ref: #amount-field303369 +Node: currency field304614 +Ref: #currency-field304769 +Node: balance field305026 +Ref: #balance-field305160 +Node: separator305532 +Ref: #separator305664 +Node: if block306204 +Ref: #if-block306331 +Node: Matching the whole record306732 +Ref: #matching-the-whole-record306909 +Node: Matching individual fields307712 +Ref: #matching-individual-fields307918 +Node: Combining matchers308142 +Ref: #combining-matchers308340 +Node: Rules applied on successful match308653 +Ref: #rules-applied-on-successful-match308846 +Node: if table309500 +Ref: #if-table309621 +Node: end311359 +Ref: #end311473 +Node: date-format311697 +Ref: #date-format311827 +Node: timezone312551 +Ref: #timezone312686 +Node: decimal-mark313691 +Ref: #decimal-mark313835 +Node: newest-first314174 +Ref: #newest-first314328 +Node: intra-day-reversed314906 +Ref: #intra-day-reversed315067 +Node: include315560 +Ref: #include315699 +Node: balance-type316143 +Ref: #balance-type316265 +Node: Tips316965 +Ref: #tips317056 +Node: Rapid feedback317355 +Ref: #rapid-feedback317474 +Node: Valid CSV317926 +Ref: #valid-csv318058 +Node: File Extension318250 +Ref: #file-extension318404 +Node: Reading multiple CSV files318833 +Ref: #reading-multiple-csv-files319020 +Node: Valid transactions319261 +Ref: #valid-transactions319441 +Node: Deduplicating importing320069 +Ref: #deduplicating-importing320250 +Node: Setting amounts321286 +Ref: #setting-amounts321443 +Node: Amount signs323887 +Ref: #amount-signs324041 +Node: Setting currency/commodity324728 +Ref: #setting-currencycommodity324916 +Node: Amount decimal places326090 +Ref: #amount-decimal-places326282 +Node: Referencing other fields326594 +Ref: #referencing-other-fields326793 +Node: How CSV rules are evaluated327690 +Ref: #how-csv-rules-are-evaluated327865 +Node: TIMECLOCK FORMAT329316 +Ref: #timeclock-format329456 +Node: TIMEDOT FORMAT331517 +Ref: #timedot-format331655 +Node: COMMON TASKS336217 +Ref: #common-tasks336346 +Node: Getting help336620 +Ref: #getting-help336754 +Node: Constructing command lines337506 +Ref: #constructing-command-lines337700 +Node: Starting a journal file338397 +Ref: #starting-a-journal-file338597 +Node: Setting opening balances339785 +Ref: #setting-opening-balances339983 +Node: Recording transactions343124 +Ref: #recording-transactions343306 +Node: Reconciling343862 +Ref: #reconciling344007 +Node: Reporting346264 +Ref: #reporting346406 +Node: Migrating to a new file350391 +Ref: #migrating-to-a-new-file350541 +Node: LIMITATIONS350840 +Ref: #limitations350968 +Node: TROUBLESHOOTING351737 +Ref: #troubleshooting351852  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index d67dd4fda..dbc51275b 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -6,7 +6,7 @@ HLEDGER(1) hledger User Manuals HLEDGER(1) NAME This is the command-line interface (CLI) for the hledger accounting tool. Here we also describe hledger's concepts and file formats. This - manual is for hledger 1.27.99. + manual is for hledger 1.28.99. SYNOPSIS hledger @@ -575,20 +575,16 @@ OUTPUT currently supported: - - txt csv html json sql - --------------------------------------------- - aregister Y Y Y - balance Y 1 Y 1 Y 1,2 Y - bal- Y 1 Y 1 Y 1 Y - ancesheet - bal- Y 1 Y 1 Y 1 Y - ancesheete- - quity - cashflow Y 1 Y 1 Y 1 Y - incomes- Y 1 Y 1 Y 1 Y - tatement - print Y Y Y Y - register Y Y Y + - txt csv html json sql + -------------------------------------------------------------------------------------- + aregister Y Y Y + balance Y 1 Y 1 Y 1,2 Y + balancesheet Y 1 Y 1 Y 1 Y + balancesheetequity Y 1 Y 1 Y 1 Y + cashflow Y 1 Y 1 Y 1 Y + incomestatement Y 1 Y 1 Y 1 Y + print Y Y Y Y + register Y Y Y o 1 Also affected by the balance commands' --layout option. @@ -685,12 +681,13 @@ TIME PERIODS 2004/10/1, 2004-01-01, exact date, several separators allowed. Year 2004.9.1 is 4+ digits, month is 1-12, day is 1-31 - 2004 start of year 2004/10 start of month 10/1 month and day in current year 21 day in current month october, oct start of month in current year + + yesterday, today, tomor- -1, 0, 1 days from today row last/this/next -1, 0, 1 periods from the current period @@ -754,12 +751,13 @@ TIME PERIODS Examples: - -b 2016/3/17 begin on St. Patrick's day 2016 -e 12/1 end at the start of december 1st of the current year (11/30 will be the last date included) -b thismonth all transactions on or after the 1st of the current month -p thismonth all transactions in the current month + + date:2016/3/17.. the above written as queries instead (.. can also be replaced with -) date:..12/1 @@ -859,22 +857,16 @@ TIME PERIODS date like so: - -p "2009" the year 2009; equivalent - to "2009/1/1 to 2010/1/1" - -p "2009/1" the month of jan; equiva- - lent to "2009/1/1 to - 2009/2/1" - -p "2009/1/1" just that day; equivalent - to "2009/1/1 to 2009/1/2" + -p "2009" the year 2009; equivalent to "2009/1/1 to 2010/1/1" + -p "2009/1" the month of jan; equivalent to "2009/1/1 to 2009/2/1" + -p "2009/1/1" just that day; equivalent to "2009/1/1 to 2009/1/2" Or you can specify a single quarter like so: - -p "2009Q1" first quarter of 2009, - equivalent to "2009/1/1 to - 2009/4/1" - -p "q4" fourth quarter of the cur- - rent year + -p "2009Q1" first quarter of 2009, equivalent to "2009/1/1 to + 2009/4/1" + -p "q4" fourth quarter of the current year Period expressions with a report interval -p/--period's argument can also begin with, or entirely consist of, a @@ -961,7 +953,6 @@ TIME PERIODS -p "every 2nd day of periods will go from Tue to Tue week" - -p "every Tue" same -p "every 15th day" period boundaries will be on 15th of each month @@ -1062,7 +1053,7 @@ QUERIES amt:N, amt:N, amt:>=N Match postings with a single-commodity amount equal to, less than, or greater than N. (Postings with multi-commodity amounts are not tested - and will always match.) The comparison has two modes: if N is preceded + and will always match.) The comparison has two modes: if N is preceded by a + or - sign (or is 0), the two signed numbers are compared. Oth- erwise, the absolute magnitudes are compared, ignoring sign. @@ -1134,7 +1125,8 @@ QUERIES hledger-web to show the transaction register for an account.) Combining query terms - Most commands select things which match: + When given multiple query terms, most commands select things which + match: o any of the description terms AND @@ -1144,7 +1136,7 @@ QUERIES o all the other terms. - while the print command shows transactions which: + The print command is a little different, showing transactions which: o match any of the description terms AND @@ -1154,29 +1146,35 @@ QUERIES o match all the other terms. - You can do more powerful queries (such as AND-ing two like terms) by - running a first query with print, and piping the result into a second - hledger command. Eg: how much of food expenses was paid with cash ? + Although these fixed rules are enough for many needs, we do not support + full boolean expressions (#203), (and you should not write AND or OR in + your queries). This makes certain queries hard to express, but here + are some tricks that can help: - $ hledger print assets:cash | hledger -f- -I balance expenses:food + 1. Use a doubled not: prefix. Eg, to print only the food expenses paid + with cash: - If you are interested in full boolean expressions for queries, see - #203. + $ hledger print food not:not:cash + + 2. Or pre-filter the transactions with print, piping the result into a + second hledger command (with balance assertions disabled): + + $ hledger print cash | hledger -f- -I balance food Queries and command options - Some queries can also be expressed as command-line options: depth:2 is + Some queries can also be expressed as command-line options: depth:2 is equivalent to --depth 2, date:2020 is equivalent to -p 2020, etc. When - you mix command options and query arguments, generally the resulting + you mix command options and query arguments, generally the resulting query is their intersection. Queries and account aliases - When account names are rewritten with --alias or alias, acct: will + When account names are rewritten with --alias or alias, acct: will match either the old or the new account name. Queries and valuation - When amounts are converted to other commodities in cost or value - reports, cur: and amt: match the old commodity symbol and the old - amount quantity, not the new ones (except in hledger 1.22.0 where it's + When amounts are converted to other commodities in cost or value + reports, cur: and amt: match the old commodity symbol and the old + amount quantity, not the new ones (except in hledger 1.22.0 where it's reversed, see #1625). Querying with account aliases @@ -1184,39 +1182,39 @@ QUERIES will match either the old or the new account name. Querying with cost or value - When amounts are converted to other commodities in cost or value - reports, note that cur: matches the new commodity symbol, and not the + When amounts are converted to other commodities in cost or value + reports, note that cur: matches the new commodity symbol, and not the old one, and amt: matches the new quantity, and not the old one. Note: - this changed in hledger 1.22, previously it was the reverse, see the + this changed in hledger 1.22, previously it was the reverse, see the discussion at #1625. COST - This section is about recording the cost of things, in transactions - where one commodity is exchanged for another. Eg an exchange of cur- + This section is about recording the cost of things, in transactions + where one commodity is exchanged for another. Eg an exchange of cur- rency, or a stock purchase or sale. First, a quick glossary: - o Conversion - an exchange of one currency or commodity for another. - Eg a foreign currency exchange, or a purchase or sale of stock or + o Conversion - an exchange of one currency or commodity for another. + Eg a foreign currency exchange, or a purchase or sale of stock or cryptocurrency. - o Conversion transaction - a transaction involving one or more conver- + o Conversion transaction - a transaction involving one or more conver- sions. o Conversion rate - the cost per unit of one commodity in the other, ie the exchange rate. - o Cost - how much of one commodity was paid to acquire the other. And - more generally, in hledger docs: the amount exchanged in the "sec- + o Cost - how much of one commodity was paid to acquire the other. And + more generally, in hledger docs: the amount exchanged in the "sec- ondary" commodity (usually your base currency), whether in a purchase - or a sale, and whether expressed per unit or in total. Or, the @/@@ + or a sale, and whether expressed per unit or in total. Or, the @/@@ notation used to represent this. o Transaction price - another name for the cost expressed with hledger's cost notation. -B: Convert to cost - As discussed a little further on in Transaction prices, when recording - a transaction you can also record the amount's cost in another commod- + As discussed a little further on in Transaction prices, when recording + a transaction you can also record the amount's cost in another commod- ity, by adding @ UNITPRICE or @@ TOTALPRICE. Then you can see a report with amounts converted to cost, by adding the @@ -1235,8 +1233,8 @@ COST Notes: - -B is sensitive to the order of postings when a transaction price is - inferred: the inferred price will be in the commodity of the last + -B is sensitive to the order of postings when a transaction price is + inferred: the inferred price will be in the commodity of the last amount. So if example 3's postings are reversed, while the transaction is equivalent, -B shows something different: @@ -1248,13 +1246,13 @@ COST EUR-100 assets:dollars # <- the dollars' selling price EUR100 assets:euros - The @/@@ cost notation is convenient, but has some drawbacks: it does - not truly balance the transaction, so it disrupts the accounting equa- + The @/@@ cost notation is convenient, but has some drawbacks: it does + not truly balance the transaction, so it disrupts the accounting equa- tion and tends to causes a non-zero total in balance reports. Equity conversion postings By contrast, conventional double entry bookkeeping (DEB) uses a differ- - ent notation: an extra pair of equity postings to balance conversion + ent notation: an extra pair of equity postings to balance conversion transactions. In this style, the above entry might be written: 2022-01-01 one hundred euros purchased at $1.35 each @@ -1263,16 +1261,16 @@ COST equity:conversion EUR-100 assets:euros EUR100 - This style is more correct, but it's also more verbose and makes cost + This style is more correct, but it's also more verbose and makes cost reporting more difficult for PTA tools. - Happily, current hledger can read either notation, or convert one to + Happily, current hledger can read either notation, or convert one to the other when needed, so you can use the one you prefer. Inferring equity postings from cost With --infer-equity, hledger detects transactions written with PTA cost - notation and adds equity conversion postings to them (and temporarily - permits the coexistence of equity conversion postings and cost nota- + notation and adds equity conversion postings to them (and temporarily + permits the coexistence of equity conversion postings and cost nota- tion, which normally would cause an unbalanced transaction error). Eg: 2022-01-01 @@ -1289,17 +1287,17 @@ COST The conversion account names can be changed with the conversion account type declaration. - --infer-equity is useful when when transactions have been recorded - using PTA cost notation, to help preserve the accounting equation and - balance reports' zero total, or to produce more conventional journal + --infer-equity is useful when when transactions have been recorded + using PTA cost notation, to help preserve the accounting equation and + balance reports' zero total, or to produce more conventional journal entries for sharing with non-PTA-users. Experimental Inferring cost from equity postings - The reverse operation is possible using --infer-costs, which detects - transactions written with equity conversion postings and adds PTA cost - notation to them (and temporarily permits the coexistence of equity + The reverse operation is possible using --infer-costs, which detects + transactions written with equity conversion postings and adds PTA cost + notation to them (and temporarily permits the coexistence of equity conversion postings and cost notation). Eg: 2022-01-01 @@ -1315,8 +1313,8 @@ COST equity:conversion EUR-100 assets:euros EUR100 - --infer-costs is useful when combined with -B/--cost, allowing cost - reporting even when transactions have been recorded using equity post- + --infer-costs is useful when combined with -B/--cost, allowing cost + reporting even when transactions have been recorded using equity post- ings: $ hledger print --infer-costs -B @@ -1326,15 +1324,15 @@ COST Notes: - Postings will be recognised as equity conversion postings if they are - 1. to account(s) declared with type V (Conversion; or if no such - accounts are declared, accounts named equity:conversion, equity:trade, - equity:trading, or subaccounts of these) 2. adjacent 3. and exactly + Postings will be recognised as equity conversion postings if they are + 1. to account(s) declared with type V (Conversion; or if no such + accounts are declared, accounts named equity:conversion, equity:trade, + equity:trading, or subaccounts of these) 2. adjacent 3. and exactly matching the amounts of two non-conversion postings. - The total cost is appended to the first matching posting in the trans- - action. If you need to assign it to a different posting, or if you - have several different sets of conversion postings in one transaction, + The total cost is appended to the first matching posting in the trans- + action. If you need to assign it to a different posting, or if you + have several different sets of conversion postings in one transaction, you may need to write the costs explicitly yourself. Eg: 2022-01-01 @@ -1360,31 +1358,31 @@ COST Experimental When to infer cost/equity - Inferring equity postings or costs is still fairly new, so not enabled - by default. We're not sure yet if that should change. Here are two + Inferring equity postings or costs is still fairly new, so not enabled + by default. We're not sure yet if that should change. Here are two suggestions to try, experience reports welcome: - 1. When you use -B, always use --infer-costs as well. Eg: hledger bal + 1. When you use -B, always use --infer-costs as well. Eg: hledger bal -B --infer-costs - 2. Always run hledger with both flags enabled. Eg: alias hl="hledger + 2. Always run hledger with both flags enabled. Eg: alias hl="hledger --infer-equity --infer-costs" How to record conversions - Essentially there are four ways to record a conversion transaction in + Essentially there are four ways to record a conversion transaction in hledger. Here are all of them, with pros and cons. Conversion with implicit cost - Let's assume 100 EUR is converted to 120 USD. You can just record the - outflow (100 EUR) and inflow (120 USD) in the appropriate asset + Let's assume 100 EUR is converted to 120 USD. You can just record the + outflow (100 EUR) and inflow (120 USD) in the appropriate asset account: 2021-01-01 assets:cash -100 EUR assets:cash 120 USD - hledger will assume this transaction is balanced, inferring that the - conversion rate must be 1 EUR = 1.20 USD. You can see the inferred + hledger will assume this transaction is balanced, inferring that the + conversion rate must be 1 EUR = 1.20 USD. You can see the inferred rate by using hledger print -x. Pro: @@ -1393,18 +1391,18 @@ COST Con: - o Less error checking - typos in amounts or commodity symbols may not + o Less error checking - typos in amounts or commodity symbols may not be detected o Conversion rate is not clear - o Disturbs the accounting equation, unless you add the --infer-equity + o Disturbs the accounting equation, unless you add the --infer-equity flag - You can prevent accidental implicit conversions due to a mistyped com- + You can prevent accidental implicit conversions due to a mistyped com- modity symbol, by using hledger check commodities. - You can prevent implicit conversions entirely, by using hledger check + You can prevent implicit conversions entirely, by using hledger check balancednoautoconversion, or -s/--strict. Conversion with explicit cost @@ -1427,16 +1425,16 @@ COST Con: - o Disturbs the accounting equation, unless you add the --infer-equity + o Disturbs the accounting equation, unless you add the --infer-equity flag Conversion with equity postings - In strict double entry bookkeeping, the above transaction is not bal- - anced in EUR or in USD, since some EUR disappears, and some USD + In strict double entry bookkeeping, the above transaction is not bal- + anced in EUR or in USD, since some EUR disappears, and some USD appears. This violates the accounting equation (A+L+E=0), and prevents reports like balancesheetequity from showing a zero total. - The proper way to make it balance is to add a balancing posting for + The proper way to make it balance is to add a balancing posting for each commodity, using an equity account: 2021-01-01 @@ -1462,8 +1460,8 @@ COST o Cost reporting requires adding the --infer-costs flag Conversion with equity postings and explicit cost - Here both equity postings and @ notation are used together. hledger - will usually complain about this redundancy, but when using the + Here both equity postings and @ notation are used together. hledger + will usually complain about this redundancy, but when using the --infer-costs flag it is accepted. 2021-01-01 @@ -1491,98 +1489,98 @@ COST o Not compatible with ledger Cost tips - o Recording the conversion rate explicitly is good because it makes + o Recording the conversion rate explicitly is good because it makes that clear and helps detect errors. - o Recording equity postings is good because it is correct bookkeeping + o Recording equity postings is good because it is correct bookkeeping and preserves the accounting equation. - o Combining these is possible by using the --infer-costs flag (which + o Combining these is possible by using the --infer-costs flag (which requires well-ordered postings). - o When you want to see the cost (or sale proceeds) of things, use -B - (or --cost). If you use equity conversion postings notation, use -B + o When you want to see the cost (or sale proceeds) of things, use -B + (or --cost). If you use equity conversion postings notation, use -B --infer-costs. - o If you use PTA cost notation, and you want to see a balanced balance + o If you use PTA cost notation, and you want to see a balanced balance sheet or print correct journal entries, use --infer-equity. o Conversion to cost is performed before valuation (described next). VALUATION - Instead of reporting amounts in their original commodity, hledger can + Instead of reporting amounts in their original commodity, hledger can convert them to cost/sale amount (using the conversion rate recorded in - the transaction), and/or to market value (using some market price on a - certain date). This is controlled by the --value=TYPE[,COMMODITY] - option, which will be described below. We also provide the simpler -V + the transaction), and/or to market value (using some market price on a + certain date). This is controlled by the --value=TYPE[,COMMODITY] + option, which will be described below. We also provide the simpler -V and -X COMMODITY options, and often one of these is all you need: -V: Value - The -V/--market flag converts amounts to market value in their default + The -V/--market flag converts amounts to market value in their default valuation commodity, using the market prices in effect on the valuation date(s), if any. More on these in a minute. -X: Value in specified commodity The -X/--exchange=COMM option is like -V, except you tell it which cur- - rency you want to convert to, and it tries to convert everything to + rency you want to convert to, and it tries to convert everything to that. Valuation date - Since market prices can change from day to day, market value reports + Since market prices can change from day to day, market value reports have a valuation date (or more than one), which determines which market prices will be used. For single period reports, if an explicit report end date is specified, - that will be used as the valuation date; otherwise the valuation date + that will be used as the valuation date; otherwise the valuation date is the journal's end date. - For multiperiod reports, each column/period is valued on the last day + For multiperiod reports, each column/period is valued on the last day of the period, by default. Market prices - To convert a commodity A to its market value in another commodity B, - hledger looks for a suitable market price (exchange rate) as follows, + To convert a commodity A to its market value in another commodity B, + hledger looks for a suitable market price (exchange rate) as follows, in this order of preference : - 1. A declared market price or inferred market price: A's latest market + 1. A declared market price or inferred market price: A's latest market price in B on or before the valuation date as declared by a P direc- - tive, or (with the --infer-market-prices flag) inferred from trans- + tive, or (with the --infer-market-prices flag) inferred from trans- action prices. 2. A reverse market price: the inverse of a declared or inferred market price from B to A. - 3. A forward chain of market prices: a synthetic price formed by com- + 3. A forward chain of market prices: a synthetic price formed by com- bining the shortest chain of "forward" (only 1 above) market prices, leading from A to B. - 4. Any chain of market prices: a chain of any market prices, including - both forward and reverse prices (1 and 2 above), leading from A to + 4. Any chain of market prices: a chain of any market prices, including + both forward and reverse prices (1 and 2 above), leading from A to B. - There is a limit to the length of these price chains; if hledger - reaches that length without finding a complete chain or exhausting all - possibilities, it will give up (with a "gave up" message visible in + There is a limit to the length of these price chains; if hledger + reaches that length without finding a complete chain or exhausting all + possibilities, it will give up (with a "gave up" message visible in --debug=2 output). That limit is currently 1000. - Amounts for which no suitable market price can be found, are not con- + Amounts for which no suitable market price can be found, are not con- verted. --infer-market-prices: market prices from transactions Normally, market value in hledger is fully controlled by, and requires, P directives in your journal. Since adding and updating those can be a - chore, and since transactions usually take place at close to market + chore, and since transactions usually take place at close to market value, why not use the recorded transaction prices as additional market prices (as Ledger does) ? We could produce value reports without need- ing P directives at all. - Adding the --infer-market-prices flag to -V, -X or --value enables - this. So for example, hledger bs -V --infer-market-prices will get - market prices both from P directives and from transactions. (And if + Adding the --infer-market-prices flag to -V, -X or --value enables + this. So for example, hledger bs -V --infer-market-prices will get + market prices both from P directives and from transactions. (And if both occur on the same day, the P directive takes precedence). There is a downside: value reports can sometimes be affected in confus- - ing/undesired ways by your journal entries. If this happens to you, + ing/undesired ways by your journal entries. If this happens to you, read all of this Valuation section carefully, and try adding --debug or --debug=2 to troubleshoot. @@ -1590,17 +1588,17 @@ VALUATION o multicommodity transactions with explicit prices (@/@@) - o multicommodity transactions with implicit prices (no @, two commodi- - ties, unbalanced). (With these, the order of postings matters. + o multicommodity transactions with implicit prices (no @, two commodi- + ties, unbalanced). (With these, the order of postings matters. hledger print -x can be useful for troubleshooting.) - o but not, currently, from "more correct" multicommodity transactions + o but not, currently, from "more correct" multicommodity transactions (no @, multiple commodities, balanced). There is another limitation (bug) currently: when a valuation commodity - is not specified, prices inferred with --infer-market-prices do not - help select a default valuation commodity, as P prices would. So con- - version might not happen because no valuation commodity was detected + is not specified, prices inferred with --infer-market-prices do not + help select a default valuation commodity, as P prices would. So con- + version might not happen because no valuation commodity was detected (--debug=2 will show this). To be safe, specify the valuation commmod- ity, eg: @@ -1611,34 +1609,34 @@ VALUATION Valuation commodity When you specify a valuation commodity (-X COMM or --value TYPE,COMM): - hledger will convert all amounts to COMM, wherever it can find a suit- + hledger will convert all amounts to COMM, wherever it can find a suit- able market price (including by reversing or chaining prices). - When you leave the valuation commodity unspecified (-V or --value + When you leave the valuation commodity unspecified (-V or --value TYPE): - For each commodity A, hledger picks a default valuation commodity as + For each commodity A, hledger picks a default valuation commodity as follows, in this order of preference: 1. The price commodity from the latest P-declared market price for A on or before valuation date. 2. The price commodity from the latest P-declared market price for A on - any date. (Allows conversion to proceed when there are inferred + any date. (Allows conversion to proceed when there are inferred prices before the valuation date.) - 3. If there are no P directives at all (any commodity or date) and the - --infer-market-prices flag is used: the price commodity from the + 3. If there are no P directives at all (any commodity or date) and the + --infer-market-prices flag is used: the price commodity from the latest transaction-inferred price for A on or before valuation date. This means: - o If you have P directives, they determine which commodities -V will + o If you have P directives, they determine which commodities -V will convert, and to what. - o If you have no P directives, and use the --infer-market-prices flag, + o If you have no P directives, and use the --infer-market-prices flag, transaction prices determine it. - Amounts for which no valuation commodity can be found are not con- + Amounts for which no valuation commodity can be found are not con- verted. Simple valuation examples @@ -1665,7 +1663,7 @@ VALUATION $ hledger -f t.j bal -N euros -V -e 2016/11/4 $110.00 assets:euros - What are they worth after 2016/12/21 ? (no report end date specified, + What are they worth after 2016/12/21 ? (no report end date specified, defaults to today) $ hledger -f t.j bal -N euros -V @@ -1685,31 +1683,31 @@ VALUATION The TYPE part selects cost or value and valuation date: --value=then - Convert amounts to their value in the default valuation commod- + Convert amounts to their value in the default valuation commod- ity, using market prices on each posting's date. --value=end - Convert amounts to their value in the default valuation commod- - ity, using market prices on the last day of the report period - (or if unspecified, the journal's end date); or in multiperiod + Convert amounts to their value in the default valuation commod- + ity, using market prices on the last day of the report period + (or if unspecified, the journal's end date); or in multiperiod reports, market prices on the last day of each subperiod. --value=now - Convert amounts to their value in the default valuation commod- - ity using current market prices (as of when report is gener- + Convert amounts to their value in the default valuation commod- + ity using current market prices (as of when report is gener- ated). --value=YYYY-MM-DD - Convert amounts to their value in the default valuation commod- + Convert amounts to their value in the default valuation commod- ity using market prices on this date. To select a different valuation commodity, add the optional ,COMM part: - a comma, then the target commodity's symbol. Eg: --value=now,EUR. + a comma, then the target commodity's symbol. Eg: --value=now,EUR. hledger will do its best to convert amounts to this commodity, deducing market prices as described above. More valuation examples - Here are some examples showing the effect of --value, as seen with + Here are some examples showing the effect of --value, as seen with print: P 2000-01-01 A 1 B @@ -1747,7 +1745,7 @@ VALUATION 2000-02-01 (a) 2 B - With no report period specified, that shows the value as of the last + With no report period specified, that shows the value as of the last day of the journal (2000-03-01): $ hledger -f- print --value=end @@ -1784,7 +1782,7 @@ VALUATION 2000-03-01 (a) 1 B - You may need to explicitly set a commodity's display style, when + You may need to explicitly set a commodity's display style, when reverse prices are used. Eg this output might be surprising: P 2000-01-01 A 2B @@ -1798,10 +1796,10 @@ VALUATION a 0 b 0 - Explanation: because there's no amount or commodity directive specify- - ing a display style for A, 0.5A gets the default style, which shows no + Explanation: because there's no amount or commodity directive specify- + ing a display style for A, 0.5A gets the default style, which shows no decimal digits. Because the displayed amount looks like zero, the com- - modity symbol and minus sign are not displayed either. Adding a com- + modity symbol and minus sign are not displayed either. Adding a com- modity directive sets a more useful display style for A: P 2000-01-01 A 2B @@ -1817,7 +1815,7 @@ VALUATION b -0.50A Interaction of valuation and queries - When matching postings based on queries in the presence of valuation, + When matching postings based on queries in the presence of valuation, the following happens. 1. The query is separated into two parts: @@ -1831,16 +1829,16 @@ VALUATION 3. Valuation is applied to the postings. - 4. The postings are matched to the other parts of the query based on + 4. The postings are matched to the other parts of the query based on post-valued amounts. See: 1625 Effect of valuation on reports - Here is a reference for how valuation is supposed to affect each part - of hledger's reports (and a glossary). (It's wide, you'll have to - scroll sideways.) It may be useful when troubleshooting. If you find - problems, please report them, ideally with a reproducible example. + Here is a reference for how valuation is supposed to affect each part + of hledger's reports (and a glossary). (It's wide, you'll have to + scroll sideways.) It may be useful when troubleshooting. If you find + problems, please report them, ideally with a reproducible example. Related: #329, #1083. @@ -1848,7 +1846,7 @@ VALUATION type --value=now ----------------------------------------------------------------------------------------------- print - posting cost value at value at posting value at value at + posting cost value at value at posting value at value at amounts report end date report or DATE/today or today journal end balance unchanged unchanged unchanged unchanged unchanged @@ -1865,9 +1863,7 @@ VALUATION with report report or posting was made report or interval journal journal start start - - - posting cost value at value at posting value at value at + posting cost value at value at posting value at value at amounts report or date report or DATE/today journal end journal end summary post- summarised value at sum of postings value at value at @@ -1880,20 +1876,21 @@ VALUATION balance (bs, bse, cf, is) - balance sums of value at value at posting value at value at + + balance sums of value at value at posting value at value at changes costs report end date report or DATE/today of - or today of journal end sums of post- + or today of journal end sums of post- sums of of sums of ings postings postings budget like balance like balance like balance like bal- like balance amounts changes changes changes ances changes (--budget) - grand total sum of dis- sum of dis- sum of displayed sum of dis- sum of dis- + grand total sum of dis- sum of dis- sum of displayed sum of dis- sum of dis- played val- played val- valued played val- played values ues ues ues balance (bs, - bse, cf, is) + bse, cf, is) with report interval starting bal- sums of value at sums of values of value at sums of post- @@ -1918,10 +1915,10 @@ VALUATION amounts changes/end changes/end changes/end bal- ances changes/end (--budget) balances balances ances balances row totals, sums, aver- sums, aver- sums, averages of sums, aver- sums, aver- - row averages ages of dis- ages of dis- displayed values ages of dis- ages of dis- + row averages ages of dis- ages of dis- displayed values ages of dis- ages of dis- (-T, -A) played val- played val- played val- played values ues ues ues - column totals sums of dis- sums of dis- sums of displayed sums of dis- sums of dis- + column totals sums of dis- sums of dis- sums of displayed sums of dis- sums of dis- played val- played val- values played val- played values ues ues ues grand total, sum, average sum, average sum, average of sum, average sum, average @@ -1936,43 +1933,43 @@ VALUATION cost calculated using price(s) recorded in the transaction(s). - value market value using available market price declarations, or the + value market value using available market price declarations, or the unchanged amount if no conversion rate can be found. report start - the first day of the report period specified with -b or -p or + the first day of the report period specified with -b or -p or date:, otherwise today. report or journal start - the first day of the report period specified with -b or -p or - date:, otherwise the earliest transaction date in the journal, + the first day of the report period specified with -b or -p or + date:, otherwise the earliest transaction date in the journal, otherwise today. report end - the last day of the report period specified with -e or -p or + the last day of the report period specified with -e or -p or date:, otherwise today. report or journal end - the last day of the report period specified with -e or -p or - date:, otherwise the latest transaction date in the journal, + the last day of the report period specified with -e or -p or + date:, otherwise the latest transaction date in the journal, otherwise today. report interval - a flag (-D/-W/-M/-Q/-Y) or period expression that activates the + a flag (-D/-W/-M/-Q/-Y) or period expression that activates the report's multi-period mode (whether showing one or many subperi- ods). PIVOTING Normally hledger sums amounts, and organizes them in a hierarchy, based - on account name. The --pivot FIELD option causes it to sum and orga- - nize hierarchy based on the value of some other field instead. FIELD - can be: status, code, description, payee, note, or the full name (case - insensitive) of any tag. As with account names, values containing + on account name. The --pivot FIELD option causes it to sum and orga- + nize hierarchy based on the value of some other field instead. FIELD + can be: status, code, description, payee, note, or the full name (case + insensitive) of any tag. As with account names, values containing colon:separated:parts will be displayed hierarchically in reports. - --pivot is a general option affecting all reports; you can think of + --pivot is a general option affecting all reports; you can think of hledger transforming the journal before any other processing, replacing - every posting's account name with the value of the specified field on + every posting's account name with the value of the specified field on that posting, inheriting it from the transaction or using a blank value if it's not present. @@ -1998,7 +1995,7 @@ PIVOTING -------------------- 0 - One way to show only amounts with a member: value (using a query, + One way to show only amounts with a member: value (using a query, described below): $ hledger balance --pivot member tag:member=. @@ -2006,7 +2003,7 @@ PIVOTING -------------------- -2 EUR - Another way (the acct: query matches against the pivoted "account + Another way (the acct: query matches against the pivoted "account name"): $ hledger balance --pivot member acct:. @@ -2015,10 +2012,10 @@ PIVOTING -2 EUR COMMANDS - hledger provides a number of commands for producing reports and manag- - ing your data. Run hledger with no arguments to list the commands - available, and hledger CMD to run a command. CMD can be the full com- - mand name, or its standard abbreviation shown in the commands list, or + hledger provides a number of commands for producing reports and manag- + ing your data. Run hledger with no arguments to list the commands + available, and hledger CMD to run a command. CMD can be the full com- + mand name, or its standard abbreviation shown in the commands list, or any unambiguous prefix of the name. Eg: hledger bal. Here are the built-in commands, with the most often-used in bold: @@ -2062,7 +2059,7 @@ COMMANDS o activity - show postings-per-interval bar charts - o balance (bal) - show balance changes/end balances/budgets in any + o balance (bal) - show balance changes/end balances/budgets in any accounts o codes - show transaction codes @@ -2085,10 +2082,10 @@ COMMANDS o print-unique - show only transactions with unique descriptions - o register (reg) - show postings in one or more accounts & running + o register (reg) - show postings in one or more accounts & running total - o register-match - show a recent posting that best matches a descrip- + o register-match - show a recent posting that best matches a descrip- tion o stats - show journal statistics @@ -2100,7 +2097,7 @@ COMMANDS Add-on commands: - Programs or scripts named hledger-SOMETHING in your PATH are add-on + Programs or scripts named hledger-SOMETHING in your PATH are add-on commands; these appear in the commands list with a + mark. The follow- ing add-on commands can be installed, eg by the hledger-install script: @@ -2112,7 +2109,7 @@ COMMANDS o interest - generates interest transactions - o stockquotes - downloads market prices. (Alpha quality, needs your + o stockquotes - downloads market prices. (Alpha quality, needs your help.) Next, the detailed command docs, in alphabetical order. @@ -2121,38 +2118,38 @@ COMMANDS accounts Show account names. - This command lists account names. By default it shows all known - accounts, either used in transactions or declared with account direc- + This command lists account names. By default it shows all known + accounts, either used in transactions or declared with account direc- tives. With query arguments, only matched account names and account names ref- erenced by matched postings are shown. - Or it can show just the used accounts (--used/-u), the declared - accounts (--declared/-d), the accounts declared but not used - (--unused), the accounts used but not declared (--undeclared), or the + Or it can show just the used accounts (--used/-u), the declared + accounts (--declared/-d), the accounts declared but not used + (--unused), the accounts used but not declared (--undeclared), or the first account matched by an account name pattern, if any (--find). - It shows a flat list by default. With --tree, it uses indentation to - show the account hierarchy. In flat mode you can add --drop N to omit - the first few account name components. Account names can be depth- + It shows a flat list by default. With --tree, it uses indentation to + show the account hierarchy. In flat mode you can add --drop N to omit + the first few account name components. Account names can be depth- clipped with depth:N or --depth N or -N. - With --types, it also shows each account's type, if it's known. (See + With --types, it also shows each account's type, if it's known. (See Declaring accounts > Account types.) - With --positions, it also shows the file and line number of each - account's declaration, if any, and the account's overall declaration - order; these may be useful when troubleshooting account display order. + With --positions, it also shows the file and line number of each + account's declaration, if any, and the account's overall declaration + order; these may be useful when troubleshooting account display order. - With --directives, it adds the account keyword, showing valid account - directives which can be pasted into a journal file. This is useful - together with --undeclared when updating your account declarations to + With --directives, it adds the account keyword, showing valid account + directives which can be pasted into a journal file. This is useful + together with --undeclared when updating your account declarations to satisfy hledger check accounts. - The --find flag can be used to look up a single account name, in the - same way that the aregister command does. It returns the alphanumeri- - cally-first matched account name, or if none can be found, it fails + The --find flag can be used to look up a single account name, in the + same way that the aregister command does. It returns the alphanumeri- + cally-first matched account name, or if none can be found, it fails with a non-zero exit code. Examples: @@ -2174,8 +2171,8 @@ COMMANDS activity Show an ascii barchart of posting counts per interval. - The activity command displays an ascii histogram showing transaction - counts by day, week, month or other reporting interval (by day is the + The activity command displays an ascii histogram showing transaction + counts by day, week, month or other reporting interval (by day is the default). With query arguments, it counts only matched transactions. Examples: @@ -2188,25 +2185,25 @@ COMMANDS add add - Prompt for transactions and add them to the journal. Any arguments + Prompt for transactions and add them to the journal. Any arguments will be used as default inputs for the first N prompts. - Many hledger users edit their journals directly with a text editor, or - generate them from CSV. For more interactive data entry, there is the - add command, which prompts interactively on the console for new trans- - actions, and appends them to the main journal file (which should be in - journal format). Existing transactions are not changed. This is one - of the few hledger commands that writes to the journal file (see also + Many hledger users edit their journals directly with a text editor, or + generate them from CSV. For more interactive data entry, there is the + add command, which prompts interactively on the console for new trans- + actions, and appends them to the main journal file (which should be in + journal format). Existing transactions are not changed. This is one + of the few hledger commands that writes to the journal file (see also import). To use it, just run hledger add and follow the prompts. You can add as - many transactions as you like; when you are finished, enter . or press + many transactions as you like; when you are finished, enter . or press control-d or control-c to exit. Features: - o add tries to provide useful defaults, using the most similar (by - description) recent transaction (filtered by the query, if any) as a + o add tries to provide useful defaults, using the most similar (by + description) recent transaction (filtered by the query, if any) as a template. o You can also set the initial defaults with command line arguments. @@ -2214,10 +2211,10 @@ COMMANDS o Readline-style edit keys can be used during data entry. o The tab key will auto-complete whenever possible - accounts, descrip- - tions, dates (yesterday, today, tomorrow). If the input area is + tions, dates (yesterday, today, tomorrow). If the input area is empty, it will insert the default value. - o If the journal defines a default commodity, it will be added to any + o If the journal defines a default commodity, it will be added to any bare numbers entered. o A parenthesised transaction code may be entered following a date. @@ -2226,7 +2223,7 @@ COMMANDS o If you make a mistake, enter < at any prompt to go one step backward. - o Input prompts are displayed in a different colour when the terminal + o Input prompts are displayed in a different colour when the terminal supports it. Example (see https://hledger.org/add.html for a detailed tutorial): @@ -2256,97 +2253,97 @@ COMMANDS Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ - On Microsoft Windows, the add command makes sure that no part of the + On Microsoft Windows, the add command makes sure that no part of the file path ends with a period, as that would cause problems (#1056). aregister aregister, areg - Show the transactions and running historical balance of a single + Show the transactions and running historical balance of a single account, with each transaction displayed as one line. aregister shows the overall transactions affecting a particular account - (and any subaccounts). Each report line represents one transaction in - this account. Transactions before the report start date are always + (and any subaccounts). Each report line represents one transaction in + this account. Transactions before the report start date are always included in the running balance (--historical mode is always on). - This is a more "real world", bank-like view than the register command - (which shows individual postings, possibly from multiple accounts, not + This is a more "real world", bank-like view than the register command + (which shows individual postings, possibly from multiple accounts, not necessarily in historical mode). As a quick rule of thumb: - use areg- ister for reviewing and reconciling real-world asset/liability accounts - use register for reviewing detailed revenues/expenses. - aregister requires one argument: the account to report on. You can - write either the full account name, or a case-insensitive regular - expression which will select the alphabetically first matched account. - (Eg if you have assets:aaa:checking and assets:bbb:checking accounts, + aregister requires one argument: the account to report on. You can + write either the full account name, or a case-insensitive regular + expression which will select the alphabetically first matched account. + (Eg if you have assets:aaa:checking and assets:bbb:checking accounts, hledger areg checking would select assets:aaa:checking.) - Transactions involving subaccounts of this account will also be shown. - aregister ignores depth limits, so its final total will always match a + Transactions involving subaccounts of this account will also be shown. + aregister ignores depth limits, so its final total will always match a balance report with similar arguments. - Any additional arguments form a query which will filter the transac- + Any additional arguments form a query which will filter the transac- tions shown. Note some queries will disturb the running balance, caus- ing it to be different from the account's real-world running balance. - An example: this shows the transactions and historical running balance + An example: this shows the transactions and historical running balance during july, in the first account whose name contains "checking": $ hledger areg checking date:jul Each aregister line item shows: - o the transaction's date (or the relevant posting's date if different, + o the transaction's date (or the relevant posting's date if different, see below) - o the names of all the other account(s) involved in this transaction + o the names of all the other account(s) involved in this transaction (probably abbreviated) o the total change to this account's balance from this transaction o the account's historical running balance after this transaction. - Transactions making a net change of zero are not shown by default; add + Transactions making a net change of zero are not shown by default; add the -E/--empty flag to show them. - For performance reasons, column widths are chosen based on the first - 1000 lines; this means unusually wide values in later lines can cause - visual discontinuities as column widths are adjusted. If you want to - ensure perfect alignment, at the cost of more time and memory, use the + For performance reasons, column widths are chosen based on the first + 1000 lines; this means unusually wide values in later lines can cause + visual discontinuities as column widths are adjusted. If you want to + ensure perfect alignment, at the cost of more time and memory, use the --align-all flag. - This command also supports the output destination and output format + This command also supports the output destination and output format options. The output formats supported are txt, csv, and json. aregister and custom posting dates - Transactions whose date is outside the report period can still be - shown, if they have a posting to this account dated inside the report - period. (And in this case it's the posting date that is shown.) This + Transactions whose date is outside the report period can still be + shown, if they have a posting to this account dated inside the report + period. (And in this case it's the posting date that is shown.) This ensures that aregister can show an accurate historical running balance, matching the one shown by register -H with the same arguments. - To filter strictly by transaction date instead, add the --txn-dates - flag. If you use this flag and some of your postings have custom + To filter strictly by transaction date instead, add the --txn-dates + flag. If you use this flag and some of your postings have custom dates, it's probably best to assume the running balance is wrong. balance balance, bal Show accounts and their balances. - balance is one of hledger's oldest and most versatile commands, for - listing account balances, balance changes, values, value changes and + balance is one of hledger's oldest and most versatile commands, for + listing account balances, balance changes, values, value changes and more, during one time period or many. Generally it shows a table, with rows representing accounts, and columns representing periods. - Note there are some higher-level variants of the balance command with - convenient defaults, which can be simpler to use: balancesheet, bal- + Note there are some higher-level variants of the balance command with + convenient defaults, which can be simpler to use: balancesheet, bal- ancesheetequity, cashflow and incomestatement. When you need more con- trol, then use balance. balance features - Here's a quick overview of the balance command's features, followed by - more detailed descriptions and examples. Many of these work with the + Here's a quick overview of the balance command's features, followed by + more detailed descriptions and examples. Many of these work with the higher-level commands as well. balance can show.. @@ -2397,7 +2394,7 @@ COMMANDS ..with.. - o totals (-T), averages (-A), percentages (-%), inverted sign + o totals (-T), averages (-A), percentages (-%), inverted sign (--invert) o rows and columns swapped (--transpose) @@ -2409,21 +2406,21 @@ COMMANDS o commodities displayed on the same line or multiple lines (--layout) This command supports the output destination and output format options, - with output formats txt, csv, json, and (multi-period reports only:) - html. In txt output in a colour-supporting terminal, negative amounts + with output formats txt, csv, json, and (multi-period reports only:) + html. In txt output in a colour-supporting terminal, negative amounts are shown in red. - The --related/-r flag shows the balance of the other postings in the + The --related/-r flag shows the balance of the other postings in the transactions of the postings which would normally be shown. Simple balance report - With no arguments, balance shows a list of all accounts and their - change of balance - ie, the sum of posting amounts, both inflows and - outflows - during the entire period of the journal. For real-world - accounts, this should also match their end balance at the end of the + With no arguments, balance shows a list of all accounts and their + change of balance - ie, the sum of posting amounts, both inflows and + outflows - during the entire period of the journal. For real-world + accounts, this should also match their end balance at the end of the journal period (more on this below). - Accounts are sorted by declaration order if any, and then alphabeti- + Accounts are sorted by declaration order if any, and then alphabeti- cally by account name. For instance (using examples/sample.journal): $ hledger -f examples/sample.journal bal @@ -2438,7 +2435,7 @@ COMMANDS 0 Accounts with a zero balance (and no non-zero subaccounts, in tree mode - - see below) are hidden by default. Use -E/--empty to show them + - see below) are hidden by default. Use -E/--empty to show them (revealing assets:bank:checking here): $ hledger -f examples/sample.journal bal -E @@ -2453,11 +2450,11 @@ COMMANDS -------------------- 0 - The total of the amounts displayed is shown as the last line, unless + The total of the amounts displayed is shown as the last line, unless -N/--no-total is used. Filtered balance report - You can show fewer accounts, a different time period, totals from + You can show fewer accounts, a different time period, totals from cleared transactions only, etc. by using query arguments or options to limit the postings being matched. Eg: @@ -2467,10 +2464,10 @@ COMMANDS $-2 List or tree mode - By default, or with -l/--flat, accounts are shown as a flat list with + By default, or with -l/--flat, accounts are shown as a flat list with their full names visible, as in the examples above. - With -t/--tree, the account hierarchy is shown, with subaccounts' + With -t/--tree, the account hierarchy is shown, with subaccounts' "leaf" names indented below their parent: $ hledger -f examples/sample.journal balance @@ -2490,26 +2487,26 @@ COMMANDS Notes: o "Boring" accounts are combined with their subaccount for more compact - output, unless --no-elide is used. Boring accounts have no balance - of their own and just one subaccount (eg assets:bank and liabilities + output, unless --no-elide is used. Boring accounts have no balance + of their own and just one subaccount (eg assets:bank and liabilities above). - o All balances shown are "inclusive", ie including the balances from - all subaccounts. Note this means some repetition in the output, + o All balances shown are "inclusive", ie including the balances from + all subaccounts. Note this means some repetition in the output, which requires explanation when sharing reports with non-plaintextac- - counting-users. A tree mode report's final total is the sum of the + counting-users. A tree mode report's final total is the sum of the top-level balances shown, not of all the balances shown. - o Each group of sibling accounts (ie, under a common parent) is sorted + o Each group of sibling accounts (ie, under a common parent) is sorted separately. Depth limiting - With a depth:NUM query, or --depth NUM option, or just -NUM (eg: -3) - balance reports will show accounts only to the specified depth, hiding - the deeper subaccounts. This can be useful for getting an overview + With a depth:NUM query, or --depth NUM option, or just -NUM (eg: -3) + balance reports will show accounts only to the specified depth, hiding + the deeper subaccounts. This can be useful for getting an overview without too much detail. - Account balances at the depth limit always include the balances from + Account balances at the depth limit always include the balances from any deeper subaccounts (even in list mode). Eg, limiting to depth 1: $ hledger -f examples/sample.journal balance -1 @@ -2521,7 +2518,7 @@ COMMANDS 0 Dropping top-level accounts - You can also hide one or more top-level account name parts, using + You can also hide one or more top-level account name parts, using --drop NUM. This can be useful for hiding repetitive top-level account names: @@ -2533,9 +2530,9 @@ COMMANDS Multi-period balance report - With a report interval (set by the -D/--daily, -W/--weekly, - -M/--monthly, -Q/--quarterly, -Y/--yearly, or -p/--period flag), bal- - ance shows a tabular report, with columns representing successive time + With a report interval (set by the -D/--daily, -W/--weekly, + -M/--monthly, -Q/--quarterly, -Y/--yearly, or -p/--period flag), bal- + ance shows a tabular report, with columns representing successive time periods (and a title): $ hledger -f examples/sample.journal bal --quarterly income expenses -E @@ -2556,21 +2553,21 @@ COMMANDS encompass the displayed subperiods (so that the first and last subpe- riods have the same duration as the others). - o Leading and trailing periods (columns) containing all zeroes are not + o Leading and trailing periods (columns) containing all zeroes are not shown, unless -E/--empty is used. - o Accounts (rows) containing all zeroes are not shown, unless + o Accounts (rows) containing all zeroes are not shown, unless -E/--empty is used. - o Amounts with many commodities are shown in abbreviated form, unless + o Amounts with many commodities are shown in abbreviated form, unless --no-elide is used. (experimental) - o Average and/or total columns can be added with the -A/--average and + o Average and/or total columns can be added with the -A/--average and -T/--row-total flags. o The --transpose flag can be used to exchange rows and columns. - o The --pivot FIELD option causes a different transaction field to be + o The --pivot FIELD option causes a different transaction field to be used as "account name". See PIVOTING. Multi-period reports with many periods can be too wide for easy viewing @@ -2584,32 +2581,32 @@ COMMANDS o Reduce the terminal's font size - o View with a pager like less, eg: hledger bal -D --color=yes | less + o View with a pager like less, eg: hledger bal -D --color=yes | less -RS - o Output as CSV and use a CSV viewer like visidata (hledger bal -D -O - csv | vd -f csv), Emacs' csv-mode (M-x csv-mode, C-c C-a), or a + o Output as CSV and use a CSV viewer like visidata (hledger bal -D -O + csv | vd -f csv), Emacs' csv-mode (M-x csv-mode, C-c C-a), or a spreadsheet (hledger bal -D -o a.csv && open a.csv) - o Output as HTML and view with a browser: hledger bal -D -o a.html && + o Output as HTML and view with a browser: hledger bal -D -o a.html && open a.html Showing declared accounts - With --declared, accounts which have been declared with an account - directive will be included in the balance report, even if they have no + With --declared, accounts which have been declared with an account + directive will be included in the balance report, even if they have no transactions. (Since they will have a zero balance, you will also need -E/--empty to see them.) - More precisely, leaf declared accounts (with no subaccounts) will be + More precisely, leaf declared accounts (with no subaccounts) will be included, since those are usually the more useful in reports. - The idea of this is to be able to see a useful "complete" balance - report, even when you don't have transactions in all of your declared + The idea of this is to be able to see a useful "complete" balance + report, even when you don't have transactions in all of your declared accounts yet. Data layout - The --layout option affects how multi-commodity amounts are displayed, - and some other things, influencing the overall layout of the report + The --layout option affects how multi-commodity amounts are displayed, + and some other things, influencing the overall layout of the report data: o --layout=wide[,WIDTH]: commodities are shown on a single line, possi- @@ -2621,11 +2618,11 @@ COMMANDS bols in a separate column o --layout=tidy: data is normalised to tidy form, with one row per data - value. We currently support this with CSV output only. In tidy - mode, totals and row averages are disabled (-N/--no-total is implied + value. We currently support this with CSV output only. In tidy + mode, totals and row averages are disabled (-N/--no-total is implied and -T/--row-total and -A/--average will be ignored). - These --layout modes are supported with some but not all of the output + These --layout modes are supported with some but not all of the output formats: @@ -2649,7 +2646,7 @@ COMMANDS ------------------++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- || 10.00 ITOT, 337.18 USD, 12.00 VEA, 106.00 VHT 70.00 GLD, 18.00 ITOT, -98.12 USD, 10.00 VEA, 18.00 VHT -11.00 ITOT, 4881.44 USD, 14.00 VEA, 170.00 VHT 70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT - o Limited wide layout. A width limit reduces the width, but some com- + o Limited wide layout. A width limit reduces the width, but some com- modities will be hidden: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide,32 @@ -2661,7 +2658,7 @@ COMMANDS ------------------++--------------------------------------------------------------------------------------------------------------------------- || 10.00 ITOT, 337.18 USD, 2 more.. 70.00 GLD, 18.00 ITOT, 3 more.. -11.00 ITOT, 3 more.. 70.00 GLD, 17.00 ITOT, 3 more.. - o Tall layout. Each commodity gets a new line (may be different in + o Tall layout. Each commodity gets a new line (may be different in each column), and account names are repeated: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=tall @@ -2681,7 +2678,7 @@ COMMANDS || 106.00 VHT 10.00 VEA 170.00 VHT 36.00 VEA || 18.00 VHT 294.00 VHT - o Bare layout. Commodity symbols are kept in one column, each commod- + o Bare layout. Commodity symbols are kept in one column, each commod- ity gets its own report row, account names are repeated: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=bare @@ -2701,7 +2698,7 @@ COMMANDS || VEA 12.00 10.00 14.00 36.00 || VHT 106.00 18.00 170.00 294.00 - o Bare layout also affects CSV output, which is useful for producing + o Bare layout also affects CSV output, which is useful for producing data that is easier to consume, eg when making charts: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=bare @@ -2717,10 +2714,10 @@ COMMANDS "total","VEA","36.00" "total","VHT","294.00" - o Tidy layout produces normalised "tidy data", where every variable is - a column and each row represents a single data point (see + o Tidy layout produces normalised "tidy data", where every variable is + a column and each row represents a single data point (see https://cran.r-project.org/web/packages/tidyr/vignettes/tidy- - data.html). This kind of data is the easiest to process with other + data.html). This kind of data is the easiest to process with other software: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy @@ -2742,21 +2739,21 @@ COMMANDS "Assets:US:ETrade","2014","2014-01-01","2014-12-31","VHT","170.00" Sorting by amount - With -S/--sort-amount, accounts with the largest (most positive) bal- - ances are shown first. Eg: hledger bal expenses -MAS shows your big- - gest averaged monthly expenses first. When more than one commodity is - present, they will be sorted by the alphabetically earliest commodity - first, and then by subsequent commodities (if an amount is missing a + With -S/--sort-amount, accounts with the largest (most positive) bal- + ances are shown first. Eg: hledger bal expenses -MAS shows your big- + gest averaged monthly expenses first. When more than one commodity is + present, they will be sorted by the alphabetically earliest commodity + first, and then by subsequent commodities (if an amount is missing a commodity, it is treated as 0). - Revenues and liability balances are typically negative, however, so -S - shows these in reverse order. To work around this, you can add - --invert to flip the signs. (Or, use one of the higher-level reports, - which flip the sign automatically. Eg: hledger incomestatement -MAS). + Revenues and liability balances are typically negative, however, so -S + shows these in reverse order. To work around this, you can add + --invert to flip the signs. (Or, use one of the higher-level reports, + which flip the sign automatically. Eg: hledger incomestatement -MAS). Percentages - With -%/--percent, balance reports show each account's value expressed + With -%/--percent, balance reports show each account's value expressed as a percentage of the (column) total: $ hledger -f examples/sample.journal bal expenses -Q -% @@ -2770,62 +2767,62 @@ COMMANDS || 0 100.0 % 0 0 Note it is not useful to calculate percentages if the amounts in a col- - umn have mixed signs. In this case, make a separate report for each + umn have mixed signs. In this case, make a separate report for each sign, eg: $ hledger bal -% amt:`>0` $ hledger bal -% amt:`<0` - Similarly, if the amounts in a column have mixed commodities, convert - them to one commodity with -B, -V, -X or --value, or make a separate + Similarly, if the amounts in a column have mixed commodities, convert + them to one commodity with -B, -V, -X or --value, or make a separate report for each commodity: $ hledger bal -% cur:\\$ $ hledger bal -% cur:EUR Balance change, end balance - It's important to be clear on the meaning of the numbers shown in bal- + It's important to be clear on the meaning of the numbers shown in bal- ance reports. Here is some terminology we use: - A balance change is the net amount added to, or removed from, an + A balance change is the net amount added to, or removed from, an account during some period. - An end balance is the amount accumulated in an account as of some date - (and some time, but hledger doesn't store that; assume end of day in + An end balance is the amount accumulated in an account as of some date + (and some time, but hledger doesn't store that; assume end of day in your timezone). It is the sum of previous balance changes. - We call it a historical end balance if it includes all balance changes + We call it a historical end balance if it includes all balance changes since the account was created. For a real world account, this means it - will match the "historical record", eg the balances reported in your + will match the "historical record", eg the balances reported in your bank statements or bank web UI. (If they are correct!) - In general, balance changes are what you want to see when reviewing + In general, balance changes are what you want to see when reviewing revenues and expenses, and historical end balances are what you want to see when reviewing or reconciling asset, liability and equity accounts. - balance shows balance changes by default. To see accurate historical + balance shows balance changes by default. To see accurate historical end balances: - 1. Initialise account starting balances with an "opening balances" - transaction (a transfer from equity to the account), unless the + 1. Initialise account starting balances with an "opening balances" + transaction (a transfer from equity to the account), unless the journal covers the account's full lifetime. 2. Include all of of the account's prior postings in the report, by not - specifying a report start date, or by using the -H/--historical + specifying a report start date, or by using the -H/--historical flag. (-H causes report start date to be ignored when summing post- ings.) Balance report types For more flexible reporting, there are three important option groups: - hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] + hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] ... - The first two are the most important: calculation type selects the - basic calculation to perform for each table cell, while accumulation + The first two are the most important: calculation type selects the + basic calculation to perform for each table cell, while accumulation type says which postings should be included in each cell's calculation. - Typically one or both of these are selected by default, so you don't - need to write them explicitly. A valuation type can be added if you + Typically one or both of these are selected by default, so you don't + need to write them explicitly. A valuation type can be added if you want to convert the basic report to value or cost. Calculation type: @@ -2836,27 +2833,27 @@ COMMANDS o --budget : like --sum but also show a goal amount o --valuechange : show the change in period-end historical balance val- - ues (caused by deposits, withdrawals, and/or market price fluctua- + ues (caused by deposits, withdrawals, and/or market price fluctua- tions) - o --gain : show the unrealised capital gain/loss, (the current valued + o --gain : show the unrealised capital gain/loss, (the current valued balance minus each amount's original cost) Accumulation type: - Which postings should be included in each cell's calculation. It is + Which postings should be included in each cell's calculation. It is one of: - o --change : postings from column start to column end, ie within the - cell's period. Typically used to see revenues/expenses. (default + o --change : postings from column start to column end, ie within the + cell's period. Typically used to see revenues/expenses. (default for balance, incomestatement) - o --cumulative : postings from report start to column end, eg to show + o --cumulative : postings from report start to column end, eg to show changes accumulated since the report's start date. Rarely used. - o --historical/-H : postings from journal start to column end, ie all + o --historical/-H : postings from journal start to column end, ie all postings from account creation to the end of the cell's period. Typ- ically used to see historical end balances of assets/liabili- - ties/equity. (default for balancesheet, balancesheetequity, cash- + ties/equity. (default for balancesheet, balancesheetequity, cash- flow) Valuation type: @@ -2869,7 +2866,7 @@ COMMANDS o --value=then[,COMM] : show value at transaction dates - o --value=end[,COMM] : show value at period end date(s) (default with + o --value=end[,COMM] : show value at period end date(s) (default with --valuechange, --gain) o --value=now[,COMM] : show value at today's date @@ -2878,13 +2875,13 @@ COMMANDS or one of their aliases: --cost/-B, --market/-V or --exchange/-X. - Most combinations of these options should produce reasonable reports, - but if you find any that seem wrong or misleading, let us know. The + Most combinations of these options should produce reasonable reports, + but if you find any that seem wrong or misleading, let us know. The following restrictions are applied: o --valuechange implies --value=end - o --valuechange makes --change the default when used with the bal- + o --valuechange makes --change the default when used with the bal- ancesheet/balancesheetequity commands o --cumulative or --historical disables --row-total/-T @@ -2893,6 +2890,11 @@ COMMANDS tion show: + + + + + Valua- no valuation --value= then --value= end --value= YYYY- tion: MM-DD /now >Accumu- @@ -2900,17 +2902,16 @@ COMMANDS v ------------------------------------------------------------------------------------ --change change in period sum of posting- period-end DATE-value of - date market val- value of change change in + date market val- value of change change in ues in period in period period - --cumu- change from sum of posting- period-end DATE-value of - lative report start to date market val- value of change change from + lative report start to date market val- value of change change from period end ues from report from report report start start to period start to period to period end end end --his- change from sum of posting- period-end DATE-value of - torical journal start to date market val- value of change change from - /-H period end (his- ues from journal from journal journal start + torical journal start to date market val- value of change change from + /-H period end (his- ues from journal from journal journal start torical end bal- start to period start to period to period end ance) end end @@ -2918,25 +2919,25 @@ COMMANDS Some frequently used balance options/reports are: o bal -M revenues expenses - Show revenues/expenses in each month. Also available as the incomes- + Show revenues/expenses in each month. Also available as the incomes- tatement command. o bal -M -H assets liabilities - Show historical asset/liability balances at each month end. Also + Show historical asset/liability balances at each month end. Also available as the balancesheet command. o bal -M -H assets liabilities equity - Show historical asset/liability/equity balances at each month end. + Show historical asset/liability/equity balances at each month end. Also available as the balancesheetequity command. o bal -M assets not:receivable - Show changes to liquid assets in each month. Also available as the + Show changes to liquid assets in each month. Also available as the cashflow command. Also: o bal -M expenses -2 -SA - Show monthly expenses summarised to depth 2 and sorted by average + Show monthly expenses summarised to depth 2 and sorted by average amount. o bal -M --budget expenses @@ -2950,12 +2951,12 @@ COMMANDS Show top gainers [or losers] last week Budget report - The --budget report type activates extra columns showing any budget - goals for each account and period. The budget goals are defined by - periodic transactions. This is very useful for comparing planned and + The --budget report type activates extra columns showing any budget + goals for each account and period. The budget goals are defined by + periodic transactions. This is very useful for comparing planned and actual income, expenses, time usage, etc. - For example, you can take average monthly expenses in the common + For example, you can take average monthly expenses in the common expense categories to construct a minimal monthly budget: ;; Budget @@ -3002,26 +3003,26 @@ COMMANDS This is different from a normal balance report in several ways: - o Only accounts with budget goals during the report period are shown, + o Only accounts with budget goals during the report period are shown, by default. - o In each column, in square brackets after the actual amount, budget - goal amounts are shown, and the actual/goal percentage. (Note: bud- + o In each column, in square brackets after the actual amount, budget + goal amounts are shown, and the actual/goal percentage. (Note: bud- get goals should be in the same commodity as the actual amount.) - o All parent accounts are always shown, even in list mode. Eg assets, + o All parent accounts are always shown, even in list mode. Eg assets, assets:bank, and expenses above. - o Amounts always include all subaccounts, budgeted or unbudgeted, even + o Amounts always include all subaccounts, budgeted or unbudgeted, even in list mode. - This means that the numbers displayed will not always add up! Eg above, - the expenses actual amount includes the gifts and supplies transac- - tions, but the expenses:gifts and expenses:supplies accounts are not - shown, as they have no budget amounts declared. + This means that the numbers displayed will not always add up! Eg + above, the expenses actual amount includes the gifts and supplies + transactions, but the expenses:gifts and expenses:supplies accounts are + not shown, as they have no budget amounts declared. - This can be confusing. When you need to make things clearer, use the - -E/--empty flag, which will reveal all accounts including unbudgeted + This can be confusing. When you need to make things clearer, use the + -E/--empty flag, which will reveal all accounts including unbudgeted ones, giving the full picture. Eg: $ hledger balance -M --budget --empty @@ -3063,12 +3064,12 @@ COMMANDS For more examples and notes, see Budgeting. Budget report start date - This might be a bug, but for now: when making budget reports, it's a + This might be a bug, but for now: when making budget reports, it's a good idea to explicitly set the report's start date to the first day of - a reporting period, because a periodic rule like ~ monthly generates - its transactions on the 1st of each month, and if your journal has no - regular transactions on the 1st, the default report start date could - exclude that budget goal, which can be a little surprising. Eg here + a reporting period, because a periodic rule like ~ monthly generates + its transactions on the 1st of each month, and if your journal has no + regular transactions on the 1st, the default report start date could + exclude that budget goal, which can be a little surprising. Eg here the default report period is just the day of 2020-01-15: ~ monthly in 2020 @@ -3087,9 +3088,9 @@ COMMANDS --------------++------------ || $400 - To avoid this, specify the budget report's period, or at least the - start date, with -b/-e/-p/date:, to ensure it includes the budget goal - transactions (periodic transactions) that you want. Eg, adding -b + To avoid this, specify the budget report's period, or at least the + start date, with -b/-e/-p/date:, to ensure it includes the budget goal + transactions (periodic transactions) that you want. Eg, adding -b 2020/1/1 to the above: $ hledger bal expenses --budget -b 2020/1/1 @@ -3102,12 +3103,12 @@ COMMANDS || $400 [80% of $500] Budgets and subaccounts - You can add budgets to any account in your account hierarchy. If you + You can add budgets to any account in your account hierarchy. If you have budgets on both parent account and some of its children, then bud- - get(s) of the child account(s) would be added to the budget of their + get(s) of the child account(s) would be added to the budget of their parent, much like account balances behave. - In the most simple case this means that once you add a budget to any + In the most simple case this means that once you add a budget to any account, all its parents would have budget as well. To illustrate this, consider the following budget: @@ -3117,13 +3118,13 @@ COMMANDS expenses:personal:electronics $100.00 liabilities - With this, monthly budget for electronics is defined to be $100 and - budget for personal expenses is an additional $1000, which implicitly + With this, monthly budget for electronics is defined to be $100 and + budget for personal expenses is an additional $1000, which implicitly means that budget for both expenses:personal and expenses is $1100. - Transactions in expenses:personal:electronics will be counted both - towards its $100 budget and $1100 of expenses:personal , and transac- - tions in any other subaccount of expenses:personal would be counted + Transactions in expenses:personal:electronics will be counted both + towards its $100 budget and $1100 of expenses:personal , and transac- + tions in any other subaccount of expenses:personal would be counted towards only towards the budget of expenses:personal. For example, let's consider these transactions: @@ -3149,9 +3150,9 @@ COMMANDS expenses:personal $30.00 liabilities - As you can see, we have transactions in expenses:personal:electron- - ics:upgrades and expenses:personal:train tickets, and since both of - these accounts are without explicitly defined budget, these transac- + As you can see, we have transactions in expenses:personal:electron- + ics:upgrades and expenses:personal:train tickets, and since both of + these accounts are without explicitly defined budget, these transac- tions would be counted towards budgets of expenses:personal:electronics and expenses:personal accordingly: @@ -3167,7 +3168,7 @@ COMMANDS -------------------------------++------------------------------- || 0 [ 0] - And with --empty, we can get a better picture of budget allocation and + And with --empty, we can get a better picture of budget allocation and consumption: $ hledger balance --budget -M --empty @@ -3186,28 +3187,28 @@ COMMANDS Selecting budget goals The budget report evaluates periodic transaction rules to generate spe- - cial "goal transactions", which generate the goal amounts for each - account in each report subperiod. When troubleshooting, you can use + cial "goal transactions", which generate the goal amounts for each + account in each report subperiod. When troubleshooting, you can use the print command to show these as forecasted transactions: $ hledger print --forecast=BUDGETREPORTPERIOD tag:generated - By default, the budget report uses all available periodic transaction - rules to generate goals. This includes rules with a different report - interval from your report. Eg if you have daily, weekly and monthly - periodic rules, all of these will contribute to the goals in a monthly + By default, the budget report uses all available periodic transaction + rules to generate goals. This includes rules with a different report + interval from your report. Eg if you have daily, weekly and monthly + periodic rules, all of these will contribute to the goals in a monthly budget report. - You can select a subset of periodic rules by providing an argument to - the --budget flag. --budget=DESCPAT will match all periodic rules + You can select a subset of periodic rules by providing an argument to + the --budget flag. --budget=DESCPAT will match all periodic rules whose description contains DESCPAT, a case-insensitive substring (not a - regular expression or query). This means you can give your periodic - rules descriptions (remember that two spaces are needed), and then + regular expression or query). This means you can give your periodic + rules descriptions (remember that two spaces are needed), and then select from multiple budgets defined in your journal. Customising single-period balance reports For single-period balance reports displayed in the terminal (only), you - can use --format FMT to customise the format and content of each line. + can use --format FMT to customise the format and content of each line. Eg: $ hledger -f examples/sample.journal balance --format "%20(account) %12(total)" @@ -3225,7 +3226,7 @@ COMMANDS 0 The FMT format string (plus a newline) specifies the formatting applied - to each account/balance pair. It may contain any suitable text, with + to each account/balance pair. It may contain any suitable text, with data fields interpolated like so: %[MIN][.MAX](FIELDNAME) @@ -3236,14 +3237,14 @@ COMMANDS o FIELDNAME must be enclosed in parentheses, and can be one of: - o depth_spacer - a number of spaces equal to the account's depth, or + o depth_spacer - a number of spaces equal to the account's depth, or if MIN is specified, MIN * depth spaces. o account - the account's name o total - the account's balance/posted total, right justified - Also, FMT can begin with an optional prefix to control how multi-com- + Also, FMT can begin with an optional prefix to control how multi-com- modity amounts are rendered: o %_ - render on multiple lines, bottom-aligned (the default) @@ -3252,34 +3253,34 @@ COMMANDS o %, - render on one line, comma-separated - There are some quirks. Eg in one-line mode, %(depth_spacer) has no - effect, instead %(account) has indentation built in. Experimentation + There are some quirks. Eg in one-line mode, %(depth_spacer) has no + effect, instead %(account) has indentation built in. Experimentation may be needed to get pleasing results. Some example formats: o %(total) - the account's total - o %-20.20(account) - the account's name, left justified, padded to 20 + o %-20.20(account) - the account's name, left justified, padded to 20 characters and clipped at 20 characters - o %,%-50(account) %25(total) - account name padded to 50 characters, - total padded to 20 characters, with multiple commodities rendered on + o %,%-50(account) %25(total) - account name padded to 50 characters, + total padded to 20 characters, with multiple commodities rendered on one line - o %20(total) %2(depth_spacer)%-(account) - the default format for the + o %20(total) %2(depth_spacer)%-(account) - the default format for the single-column balance report balancesheet balancesheet, bs - This command displays a balance sheet, showing historical ending bal- + This command displays a balance sheet, showing historical ending bal- ances of asset and liability accounts. (To see equity as well, use the - balancesheetequity command.) Amounts are shown with normal positive + balancesheetequity command.) Amounts are shown with normal positive sign, as in conventional financial statements. - This report shows accounts declared with the Asset, Cash or Liability - type (see account types). Or if no such accounts are declared, it - shows top-level accounts named asset or liability (case insensitive, + This report shows accounts declared with the Asset, Cash or Liability + type (see account types). Or if no such accounts are declared, it + shows top-level accounts named asset or liability (case insensitive, plurals allowed) and their subaccounts. Example: @@ -3304,24 +3305,24 @@ COMMANDS 0 This command is a higher-level variant of the balance command, and sup- - ports many of that command's features, such as multi-period reports. - It is similar to hledger balance -H assets liabilities, but with - smarter account detection, and liabilities displayed with their sign + ports many of that command's features, such as multi-period reports. + It is similar to hledger balance -H assets liabilities, but with + smarter account detection, and liabilities displayed with their sign flipped. - This command also supports the output destination and output format - options The output formats supported are txt, csv, html, and (experi- + This command also supports the output destination and output format + options The output formats supported are txt, csv, html, and (experi- mental) json. balancesheetequity balancesheetequity, bse - This command displays a balance sheet, showing historical ending bal- - ances of asset, liability and equity accounts. Amounts are shown with + This command displays a balance sheet, showing historical ending bal- + ances of asset, liability and equity accounts. Amounts are shown with normal positive sign, as in conventional financial statements. - This report shows accounts declared with the Asset, Cash, Liability or - Equity type (see account types). Or if no such accounts are declared, - it shows top-level accounts named asset, liability or equity (case + This report shows accounts declared with the Asset, Cash, Liability or + Equity type (see account types). Or if no such accounts are declared, + it shows top-level accounts named asset, liability or equity (case insensitive, plurals allowed) and their subaccounts. Example: @@ -3351,31 +3352,31 @@ COMMANDS 0 This command is a higher-level variant of the balance command, and sup- - ports many of that command's features, such as multi-period reports. + ports many of that command's features, such as multi-period reports. It is similar to hledger balance -H assets liabilities equity, but with - smarter account detection, and liabilities/equity displayed with their + smarter account detection, and liabilities/equity displayed with their sign flipped. - This command also supports the output destination and output format - options The output formats supported are txt, csv, html, and (experi- + This command also supports the output destination and output format + options The output formats supported are txt, csv, html, and (experi- mental) json. cashflow cashflow, cf - This command displays a cashflow statement, showing the inflows and - outflows affecting "cash" (ie, liquid, easily convertible) assets. - Amounts are shown with normal positive sign, as in conventional finan- + This command displays a cashflow statement, showing the inflows and + outflows affecting "cash" (ie, liquid, easily convertible) assets. + Amounts are shown with normal positive sign, as in conventional finan- cial statements. - This report shows accounts declared with the Cash type (see account + This report shows accounts declared with the Cash type (see account types). Or if no such accounts are declared, it shows accounts - o under a top-level account named asset (case insensitive, plural + o under a top-level account named asset (case insensitive, plural allowed) o whose name contains some variation of cash, bank, checking or saving. - More precisely: all accounts matching this case insensitive regular + More precisely: all accounts matching this case insensitive regular expression: ^assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|currentcash)(:|$) @@ -3399,22 +3400,22 @@ COMMANDS $-1 This command is a higher-level variant of the balance command, and sup- - ports many of that command's features, such as multi-period reports. - It is similar to hledger balance assets not:fixed not:investment + ports many of that command's features, such as multi-period reports. + It is similar to hledger balance assets not:fixed not:investment not:receivable, but with smarter account detection. - This command also supports the output destination and output format - options The output formats supported are txt, csv, html, and (experi- + This command also supports the output destination and output format + options The output formats supported are txt, csv, html, and (experi- mental) json. check check Check for various kinds of errors in your data. - hledger provides a number of built-in error checks to help prevent - problems in your data. Some of these are run automatically; or, you - can use this check command to run them on demand, with no output and a - zero exit code if all is well. Specify their names (or a prefix) as + hledger provides a number of built-in error checks to help prevent + problems in your data. Some of these are run automatically; or, you + can use this check command to run them on demand, with no output and a + zero exit code if all is well. Specify their names (or a prefix) as argument(s). Some examples: @@ -3423,7 +3424,7 @@ COMMANDS hledger check -s # basic + strict checks hledger check ordereddates payees # basic + two other checks - If you are an Emacs user, you can also configure flycheck-hledger to + If you are an Emacs user, you can also configure flycheck-hledger to run these checks, providing instant feedback as you edit the journal. Here are the checks currently available: @@ -3435,98 +3436,98 @@ COMMANDS o parseable - data files are well-formed and can be successfully parsed o balancedwithautoconversion - all transactions are balanced, inferring - missing amounts where necessary, and possibly converting commodities + missing amounts where necessary, and possibly converting commodities using transaction prices or automatically-inferred transaction prices - o assertions - all balance assertions in the journal are passing. + o assertions - all balance assertions in the journal are passing. (This check can be disabled with -I/--ignore-assertions.) Strict checks These additional checks are run when the -s/--strict (strict mode) flag - is used. Or, they can be run by giving their names as arguments to + is used. Or, they can be run by giving their names as arguments to check: o accounts - all account names used by transactions have been declared o commodities - all commodity symbols used have been declared - o balancednoautoconversion - transactions are balanced, possibly using + o balancednoautoconversion - transactions are balanced, possibly using explicit transaction prices but not inferred ones Other checks - These checks can be run only by giving their names as arguments to - check. They are more specialised and not desirable for everyone, + These checks can be run only by giving their names as arguments to + check. They are more specialised and not desirable for everyone, therefore optional: o ordereddates - transactions are ordered by date within each file o payees - all payees used by transactions have been declared - o recentassertions - all accounts with balance assertions have a bal- + o recentassertions - all accounts with balance assertions have a bal- ance assertion no more than 7 days before their latest posting o uniqueleafnames - all account leaf names are unique Custom checks - A few more checks are are available as separate add-on commands, in + A few more checks are are available as separate add-on commands, in https://github.com/simonmichael/hledger/tree/master/bin: - o hledger-check-tagfiles - all tag values containing / (a forward + o hledger-check-tagfiles - all tag values containing / (a forward slash) exist as file paths - o hledger-check-fancyassertions - more complex balance assertions are + o hledger-check-fancyassertions - more complex balance assertions are passing You could make similar scripts to perform your own custom checks. See: Cookbook -> Scripting. More about specific checks - hledger check recentassertions will complain if any balance-asserted + hledger check recentassertions will complain if any balance-asserted account does not have a balance assertion within 7 days before its lat- - est posting. This aims to prevent the situation where you are regu- - larly updating your journal, but forgetting to check your balances - against the real world, then one day must dig back through months of - data to find an error. It assumes that adding a balance assertion - requires/reminds you to check the real-world balance. That may not be - true if you auto-generate balance assertions from bank data; in that - case, I recommend to import transactions uncleared, then use the man- - ual-review-and-mark-cleared phase as a reminder to check the latest + est posting. This aims to prevent the situation where you are regu- + larly updating your journal, but forgetting to check your balances + against the real world, then one day must dig back through months of + data to find an error. It assumes that adding a balance assertion + requires/reminds you to check the real-world balance. That may not be + true if you auto-generate balance assertions from bank data; in that + case, I recommend to import transactions uncleared, then use the man- + ual-review-and-mark-cleared phase as a reminder to check the latest assertions against real-world balances. close close, equity - Prints a sample "closing" transaction bringing specified account bal- - ances to zero, and an inverse "opening" transaction restoring the same + Prints a sample "closing" transaction bringing specified account bal- + ances to zero, and an inverse "opening" transaction restoring the same account balances. - If like most people you split your journal files by time, eg by year: - at the end of the year you can use this command to "close out" your - asset and liability (and perhaps equity) balances in the old file, and - reinitialise them in the new file. This helps ensure that report bal- - ances remain correct whether you are including old files or not. - (Because all closing/opening transactions except the very first will + If like most people you split your journal files by time, eg by year: + at the end of the year you can use this command to "close out" your + asset and liability (and perhaps equity) balances in the old file, and + reinitialise them in the new file. This helps ensure that report bal- + ances remain correct whether you are including old files or not. + (Because all closing/opening transactions except the very first will cancel out - see example below.) Some people also use this command to close out revenue and expense bal- - ances at the end of an accounting period. This properly records the - period's profit/loss as "retained earnings" (part of equity), and + ances at the end of an accounting period. This properly records the + period's profit/loss as "retained earnings" (part of equity), and allows the accounting equation (A-L=E) to balance, which you could then check by the bse report's zero total. - You can print just the closing transaction by using the --close flag, + You can print just the closing transaction by using the --close flag, or just the opening transaction with the --open flag. Their descriptions are closing balances and opening balances by - default; you can customise these with the --close-desc and --open-desc + default; you can customise these with the --close-desc and --open-desc options. - Just one balancing equity posting is used by default, with the amount + Just one balancing equity posting is used by default, with the amount left implicit. The default account name is equity:opening/closing bal- - ances. You can customise the account name(s) with --close-acct and - --open-acct. (If you specify only one of these, it will be used for + ances. You can customise the account name(s) with --close-acct and + --open-acct. (If you specify only one of these, it will be used for both.) - With --x/--explicit, the equity posting's amount will be shown explic- + With --x/--explicit, the equity posting's amount will be shown explic- itly, and if it involves multiple commodities, there will be a separate equity posting for each commodity (as in the print command). @@ -3534,33 +3535,32 @@ COMMANDS balances (good for troubleshooting). close and prices - Transaction prices are ignored (and discarded) by closing/opening + Transaction prices are ignored (and discarded) by closing/opening transactions, by default. With --show-costs, they are preserved; there - will be a separate equity posting for each cost in each commodity. - This means balance -B reports will look the same after the transition. + will be a separate equity posting for each cost in each commodity. + This means balance -B reports will look the same after the transition. Note if you have many foreign currency or investment transactions, this will generate very large journal entries. close date - The default closing date is yesterday, or the journal's end date, + The default closing date is yesterday, or the journal's end date, whichever is later. - Unless you are running close on exactly the first day of the new - period, you'll want to override the closing date. This is done by - specifying a report end date, where "last day of the report period" - will be the closing date. The opening date is always the following - day. So to close on (end of) 2020-12-31 and open on (start of) + Unless you are running close on exactly the first day of the new + period, you'll want to override the closing date. This is done by + specifying a report end date, where "last day of the report period" + will be the closing date. The opening date is always the following + day. So to close on (end of) 2020-12-31 and open on (start of) 2021-01-01, any of these will work: - end date argument explanation - ----------------------------------------------- - -e 2021-01-01 end dates are exclusive - -e 2021 equivalent, per smart - dates - -p 2020 equivalent, the period's - begin date is ignored - date:2020 equivalent query + end date argu- explanation + ment + -------------------------------------------------------------------------- + -e 2021-01-01 end dates are exclusive + -e 2021 equivalent, per smart dates + -p 2020 equivalent, the period's begin date is ignored + date:2020 equivalent query Example: close asset/liability accounts for file transition Carrying asset/liability balances from 2020.journal into a new file for @@ -4065,17 +4065,18 @@ COMMANDS With -B/--cost, amounts with transaction prices are converted to cost using that price. This can be used for troubleshooting. - With -m/--match and a STR argument, print will show at most one trans- - action: the one one whose description is most similar to STR, and is - most recent. STR should contain at least two characters. If there is - no similar-enough match, no transaction will be shown. + With -m DESC/--match=DESC, print does a fuzzy search for the one trans- + action whose description is most similar to DESC, also preferring + recent tranactions. DESC should contain at least two characters. If + there is no similar-enough match, no transaction will be shown and the + program exit code will be non-zero. - With --new, hledger prints only transactions it has not seen on a pre- - vious run. This uses the same deduplication system as the import com- + With --new, hledger prints only transactions it has not seen on a pre- + vious run. This uses the same deduplication system as the import com- mand. (See import's docs for details.) - This command also supports the output destination and output format - options The output formats supported are txt, csv, and (experimental) + This command also supports the output destination and output format + options The output formats supported are txt, csv, and (experimental) json and sql. Here's an example of print's CSV output: @@ -4094,20 +4095,20 @@ COMMANDS "5","2008/12/31","","*","","pay off","","liabilities:debts","1","$","","1","","" "5","2008/12/31","","*","","pay off","","assets:bank:checking","-1","$","1","","","" - o There is one CSV record per posting, with the parent transaction's + o There is one CSV record per posting, with the parent transaction's fields repeated. o The "txnidx" (transaction index) field shows which postings belong to - the same transaction. (This number might change if transactions are - reordered within the file, files are parsed/included in a different + the same transaction. (This number might change if transactions are + reordered within the file, files are parsed/included in a different order, etc.) - o The amount is separated into "commodity" (the symbol) and "amount" + o The amount is separated into "commodity" (the symbol) and "amount" (numeric quantity) fields. o The numeric amount is repeated in either the "credit" or "debit" col- - umn, for convenience. (Those names are not accurate in the account- - ing sense; it just puts negative amounts under credit and zero or + umn, for convenience. (Those names are not accurate in the account- + ing sense; it just puts negative amounts under credit and zero or greater amounts under debit.) print-unique @@ -4131,14 +4132,14 @@ COMMANDS Show postings and their running total. The register command displays matched postings, across all accounts, in - date order, with their running total or running historical balance. - (See also the aregister command, which shows matched transactions in a + date order, with their running total or running historical balance. + (See also the aregister command, which shows matched transactions in a specific account.) register normally shows line per posting, but note that multi-commodity amounts will occupy multiple lines (one line per commodity). - It is typically used with a query selecting a particular account, to + It is typically used with a query selecting a particular account, to see that account's activity: $ hledger register checking @@ -4149,14 +4150,14 @@ COMMANDS With --date2, it shows and sorts by secondary date instead. - For performance reasons, column widths are chosen based on the first - 1000 lines; this means unusually wide values in later lines can cause - visual discontinuities as column widths are adjusted. If you want to - ensure perfect alignment, at the cost of more time and memory, use the + For performance reasons, column widths are chosen based on the first + 1000 lines; this means unusually wide values in later lines can cause + visual discontinuities as column widths are adjusted. If you want to + ensure perfect alignment, at the cost of more time and memory, use the --align-all flag. - The --historical/-H flag adds the balance from any undisplayed prior - postings to the running total. This is useful when you want to see + The --historical/-H flag adds the balance from any undisplayed prior + postings to the running total. This is useful when you want to see only recent activity, with a historically accurate running balance: $ hledger register checking -b 2008/6 --historical @@ -4166,30 +4167,30 @@ COMMANDS The --depth option limits the amount of sub-account detail displayed. - The --average/-A flag shows the running average posting amount instead + The --average/-A flag shows the running average posting amount instead of the running total (so, the final number displayed is the average for - the whole report period). This flag implies --empty (see below). It - is affected by --historical. It works best when showing just one + the whole report period). This flag implies --empty (see below). It + is affected by --historical. It works best when showing just one account and one commodity. - The --related/-r flag shows the other postings in the transactions of + The --related/-r flag shows the other postings in the transactions of the postings which would normally be shown. - The --invert flag negates all amounts. For example, it can be used on + The --invert flag negates all amounts. For example, it can be used on an income account where amounts are normally displayed as negative num- - bers. It's also useful to show postings on the checking account + bers. It's also useful to show postings on the checking account together with the related account: $ hledger register --related --invert assets:checking - With a reporting interval, register shows summary postings, one per + With a reporting interval, register shows summary postings, one per interval, aggregating the postings to each account: $ hledger register --monthly income 2008/01 income:salary $-1 $-1 2008/06 income:gifts $-1 $-2 - Periods with no activity, and summary postings with a zero amount, are + Periods with no activity, and summary postings with a zero amount, are not shown by default; use the --empty/-E flag to see them: $ hledger register --monthly income -E @@ -4206,7 +4207,7 @@ COMMANDS 2008/11 0 $-2 2008/12 0 $-2 - Often, you'll want to see just one line per interval. The --depth + Often, you'll want to see just one line per interval. The --depth option helps with this, causing subaccounts to be aggregated: $ hledger register --monthly assets --depth 1h @@ -4214,19 +4215,19 @@ COMMANDS 2008/06 assets $-1 0 2008/12 assets $-1 $-1 - Note when using report intervals, if you specify start/end dates these - will be adjusted outward if necessary to contain a whole number of - intervals. This ensures that the first and last intervals are full + Note when using report intervals, if you specify start/end dates these + will be adjusted outward if necessary to contain a whole number of + intervals. This ensures that the first and last intervals are full length and comparable to the others in the report. Custom register output - register uses the full terminal width by default, except on windows. - You can override this by setting the COLUMNS environment variable (not + register uses the full terminal width by default, except on windows. + You can override this by setting the COLUMNS environment variable (not a bash shell variable) or by using the --width/-w option. - The description and account columns normally share the space equally - (about half of (width - 40) each). You can adjust this by adding a - description width as part of --width's argument, comma-separated: + The description and account columns normally share the space equally + (about half of (width - 40) each). You can adjust this by adding a + description width as part of --width's argument, comma-separated: --width W,D . Here's a diagram (won't display correctly in --help): <--------------------------------- width (W) ----------------------------------> @@ -4242,28 +4243,28 @@ COMMANDS $ hledger reg -w 100,40 # set overall width 100, description width 40 $ hledger reg -w $COLUMNS,40 # use terminal width, & description width 40 - This command also supports the output destination and output format - options The output formats supported are txt, csv, and (experimental) + This command also supports the output destination and output format + options The output formats supported are txt, csv, and (experimental) json. register-match register-match Print the one posting whose transaction description is closest to DESC, - in the style of the register command. If there are multiple equally - good matches, it shows the most recent. Query options (options, not - arguments) can be used to restrict the search space. Helps ledger- + in the style of the register command. If there are multiple equally + good matches, it shows the most recent. Query options (options, not + arguments) can be used to restrict the search space. Helps ledger- autosync detect already-seen transactions when importing. rewrite rewrite Print all transactions, rewriting the postings of matched transactions. - For now the only rewrite available is adding new postings, like print + For now the only rewrite available is adding new postings, like print --auto. This is a start at a generic rewriter of transaction entries. It reads - the default journal and prints the transactions, like print, but adds + the default journal and prints the transactions, like print, but adds one or more specified postings to any transactions matching QUERY. The - posting amounts can be fixed, or a multiplier of the existing transac- + posting amounts can be fixed, or a multiplier of the existing transac- tion's first posting amount. Examples: @@ -4279,7 +4280,7 @@ COMMANDS (reserve:grocery) *0.25 ; reserve 25% for grocery (reserve:) *0.25 ; reserve 25% for grocery - Note the single quotes to protect the dollar sign from bash, and the + Note the single quotes to protect the dollar sign from bash, and the two spaces between account and amount. More: @@ -4289,16 +4290,16 @@ COMMANDS $ hledger rewrite -- expenses:gifts --add-posting '(budget:gifts) *-1"' $ hledger rewrite -- ^income --add-posting '(budget:foreign currency) *0.25 JPY; diversify' - Argument for --add-posting option is a usual posting of transaction - with an exception for amount specification. More precisely, you can + Argument for --add-posting option is a usual posting of transaction + with an exception for amount specification. More precisely, you can use '*' (star symbol) before the amount to indicate that that this is a - factor for an amount of original matched posting. If the amount - includes a commodity name, the new posting amount will be in the new - commodity; otherwise, it will be in the matched posting amount's com- + factor for an amount of original matched posting. If the amount + includes a commodity name, the new posting amount will be in the new + commodity; otherwise, it will be in the matched posting amount's com- modity. Re-write rules in a file - During the run this tool will execute so called "Automated Transac- + During the run this tool will execute so called "Automated Transac- tions" found in any journal it process. I.e instead of specifying this operations in command line you can put them in a journal file. @@ -4313,7 +4314,7 @@ COMMANDS budget:gifts *-1 assets:budget *1 - Note that '=' (equality symbol) that is used instead of date in trans- + Note that '=' (equality symbol) that is used instead of date in trans- actions you usually write. It indicates the query by which you want to match the posting to add new ones. @@ -4326,12 +4327,12 @@ COMMANDS --add-posting 'assets:budget *1' \ > rewritten-tidy-output.journal - It is important to understand that relative order of such entries in - journal is important. You can re-use result of previously added post- + It is important to understand that relative order of such entries in + journal is important. You can re-use result of previously added post- ings. Diff output format - To use this tool for batch modification of your journal files you may + To use this tool for batch modification of your journal files you may find useful output in form of unified diff. $ hledger rewrite -- --diff -f examples/sample.journal '^income' --add-posting '(liabilities:tax) *.33' @@ -4355,10 +4356,10 @@ COMMANDS If you'll pass this through patch tool you'll get transactions contain- ing the posting that matches your query be updated. Note that multiple - files might be update according to list of input files specified via + files might be update according to list of input files specified via --file options and include directives inside of these files. - Be careful. Whole transaction being re-formatted in a style of output + Be careful. Whole transaction being re-formatted in a style of output from hledger print. See also: @@ -4366,54 +4367,54 @@ COMMANDS https://github.com/simonmichael/hledger/issues/99 rewrite vs. print --auto - This command predates print --auto, and currently does much the same + This command predates print --auto, and currently does much the same thing, but with these differences: - o with multiple files, rewrite lets rules in any file affect all other - files. print --auto uses standard directive scoping; rules affect + o with multiple files, rewrite lets rules in any file affect all other + files. print --auto uses standard directive scoping; rules affect only child files. - o rewrite's query limits which transactions can be rewritten; all are + o rewrite's query limits which transactions can be rewritten; all are printed. print --auto's query limits which transactions are printed. - o rewrite applies rules specified on command line or in the journal. + o rewrite applies rules specified on command line or in the journal. print --auto applies rules specified in the journal. roi roi - Shows the time-weighted (TWR) and money-weighted (IRR) rate of return + Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on your investments. - At a minimum, you need to supply a query (which could be just an - account name) to select your investment(s) with --inv, and another + At a minimum, you need to supply a query (which could be just an + account name) to select your investment(s) with --inv, and another query to identify your profit and loss transactions with --pnl. - If you do not record changes in the value of your investment manually, - or do not require computation of time-weighted return (TWR), --pnl + If you do not record changes in the value of your investment manually, + or do not require computation of time-weighted return (TWR), --pnl could be an empty query (--pnl "" or --pnl STR where STR does not match any of your accounts). - This command will compute and display the internalized rate of return - (IRR) and time-weighted rate of return (TWR) for your investments for - the time period requested. Both rates of return are annualized before + This command will compute and display the internalized rate of return + (IRR) and time-weighted rate of return (TWR) for your investments for + the time period requested. Both rates of return are annualized before display, regardless of the length of reporting interval. - Price directives will be taken into account if you supply appropriate + Price directives will be taken into account if you supply appropriate --cost or --value flags (see VALUATION). Note, in some cases this report can fail, for these reasons: - o Error (NotBracketed): No solution for Internal Rate of Return (IRR). - Possible causes: IRR is huge (>1000000%), balance of investment + o Error (NotBracketed): No solution for Internal Rate of Return (IRR). + Possible causes: IRR is huge (>1000000%), balance of investment becomes negative at some point in time. - o Error (SearchFailed): Failed to find solution for Internal Rate of + o Error (SearchFailed): Failed to find solution for Internal Rate of Return (IRR). Either search does not converge to a solution, or con- verges too slowly. Examples: - o Using roi to compute total return of investment in stocks: + o Using roi to compute total return of investment in stocks: https://github.com/simonmichael/hledger/blob/master/examples/invest- ing/roi-unrealised.ledger @@ -4423,27 +4424,27 @@ COMMANDS Note that --inv and --pnl's argument is a query, and queries could have several space-separated terms (see QUERIES). - To indicate that all search terms form single command-line argument, + To indicate that all search terms form single command-line argument, you will need to put them in quotes (see Special characters): $ hledger roi --inv 'term1 term2 term3 ...' - If any query terms contain spaces themselves, you will need an extra + If any query terms contain spaces themselves, you will need an extra level of nested quoting, eg: $ hledger roi --inv="'Assets:Test 1'" --pnl="'Equity:Unrealized Profit and Loss'" Semantics of --inv and --pnl - Query supplied to --inv has to match all transactions that are related + Query supplied to --inv has to match all transactions that are related to your investment. Transactions not matching --inv will be ignored. In these transactions, ROI will conside postings that match --inv to be - "investment postings" and other postings (not matching --inv) will be - sorted into two categories: "cash flow" and "profit and loss", as ROI - needs to know which part of the investment value is your contributions + "investment postings" and other postings (not matching --inv) will be + sorted into two categories: "cash flow" and "profit and loss", as ROI + needs to know which part of the investment value is your contributions and which is due to the return on investment. - o "Cash flow" is depositing or withdrawing money, buying or selling + o "Cash flow" is depositing or withdrawing money, buying or selling assets, or otherwise converting between your investment commodity and any other commodity. Example: @@ -4461,12 +4462,12 @@ COMMANDS investment:snake oil = $57 equity:unrealized profit or loss - All non-investment postings are assumed to be "cash flow", unless they - match --pnl query. Changes in value of your investment due to "profit - and loss" postings will be considered as part of your investment + All non-investment postings are assumed to be "cash flow", unless they + match --pnl query. Changes in value of your investment due to "profit + and loss" postings will be considered as part of your investment return. - Example: if you use --inv snake --pnl equity:unrealized, then postings + Example: if you use --inv snake --pnl equity:unrealized, then postings in the example below would be classifed as: 2019-01-01 Snake Oil #1 @@ -4483,57 +4484,57 @@ COMMANDS snake oil $50 ; investment posting IRR and TWR explained - "ROI" stands for "return on investment". Traditionally this was com- - puted as a difference between current value of investment and its ini- + "ROI" stands for "return on investment". Traditionally this was com- + puted as a difference between current value of investment and its ini- tial value, expressed in percentage of the initial value. However, this approach is only practical in simple cases, where invest- - ments receives no in-flows or out-flows of money, and where rate of + ments receives no in-flows or out-flows of money, and where rate of growth is fixed over time. For more complex scenarios you need differ- - ent ways to compute rate of return, and this command implements two of + ent ways to compute rate of return, and this command implements two of them: IRR and TWR. - Internal rate of return, or "IRR" (also called "money-weighted rate of - return") takes into account effects of in-flows and out-flows. + Internal rate of return, or "IRR" (also called "money-weighted rate of + return") takes into account effects of in-flows and out-flows. Naively, if you are withdrawing from your investment, your future gains - would be smaller (in absolute numbers), and will be a smaller percent- - age of your initial investment, and if you are adding to your invest- - ment, you will receive bigger absolute gains (but probably at the same - rate of return). IRR is a way to compute rate of return for each + would be smaller (in absolute numbers), and will be a smaller percent- + age of your initial investment, and if you are adding to your invest- + ment, you will receive bigger absolute gains (but probably at the same + rate of return). IRR is a way to compute rate of return for each period between in-flow or out-flow of money, and then combine them in a - way that gives you a compound annual rate of return that investment is + way that gives you a compound annual rate of return that investment is expected to generate. - As mentioned before, in-flows and out-flows would be any cash that you + As mentioned before, in-flows and out-flows would be any cash that you personally put in or withdraw, and for the "roi" command, these are the - postings that match the query in the--inv argument and NOT match the + postings that match the query in the--inv argument and NOT match the query in the--pnl argument. - If you manually record changes in the value of your investment as - transactions that balance them against "profit and loss" (or "unreal- - ized gains") account or use price directives, then in order for IRR to - compute the precise effect of your in-flows and out-flows on the rate - of return, you will need to record the value of your investement on or + If you manually record changes in the value of your investment as + transactions that balance them against "profit and loss" (or "unreal- + ized gains") account or use price directives, then in order for IRR to + compute the precise effect of your in-flows and out-flows on the rate + of return, you will need to record the value of your investement on or close to the days when in- or out-flows occur. - In technical terms, IRR uses the same approach as computation of net + In technical terms, IRR uses the same approach as computation of net present value, and tries to find a discount rate that makes net present value of all the cash flows of your investment to add up to zero. This - could be hard to wrap your head around, especially if you haven't done + could be hard to wrap your head around, especially if you haven't done discounted cash flow analysis before. Implementation of IRR in hledger should produce results that match the XIRR formula in Excel. - Second way to compute rate of return that roi command implements is + Second way to compute rate of return that roi command implements is called "time-weighted rate of return" or "TWR". Like IRR, it will also - break the history of your investment into periods between in-flows, - out-flows and value changes, to compute rate of return per each period - and then a compound rate of return. However, internal workings of TWR + break the history of your investment into periods between in-flows, + out-flows and value changes, to compute rate of return per each period + and then a compound rate of return. However, internal workings of TWR are quite different. - TWR represents your investment as an imaginary "unit fund" where in- - flows/ out-flows lead to buying or selling "units" of your investment + TWR represents your investment as an imaginary "unit fund" where in- + flows/ out-flows lead to buying or selling "units" of your investment and changes in its value change the value of "investment unit". Change - in "unit price" over the reporting period gives you rate of return of + in "unit price" over the reporting period gives you rate of return of your investment. References: @@ -4544,22 +4545,22 @@ COMMANDS o Explanation of TWR - o Examples of computing IRR and TWR and discussion of the limitations + o Examples of computing IRR and TWR and discussion of the limitations of both metrics stats stats Show journal and performance statistics. - The stats command displays summary information for the whole journal, - or a matched part of it. With a reporting interval, it shows a report + The stats command displays summary information for the whole journal, + or a matched part of it. With a reporting interval, it shows a report for each report period. - At the end, it shows (in the terminal) the overall run time and number - of transactions processed per second. Note these are approximate and - will vary based on machine, current load, data size, hledger version, - haskell lib versions, GHC version.. but they may be of interest. The - stats command's run time is similar to that of a single-column balance + At the end, it shows (in the terminal) the overall run time and number + of transactions processed per second. Note these are approximate and + will vary based on machine, current load, data size, hledger version, + haskell lib versions, GHC version.. but they may be of interest. The + stats command's run time is similar to that of a single-column balance report. Example: @@ -4580,7 +4581,7 @@ COMMANDS Run time : 0.12 s Throughput : 8342 txns/s - This command also supports output destination and output format selec- + This command also supports output destination and output format selec- tion. tags @@ -4590,22 +4591,22 @@ COMMANDS This command lists the tag names used in the journal, whether on trans- actions, postings, or account declarations. - With a TAGREGEX argument, only tag names matching this regular expres- + With a TAGREGEX argument, only tag names matching this regular expres- sion (case insensitive, infix matched) are shown. - With QUERY arguments, only transactions and accounts matching this + With QUERY arguments, only transactions and accounts matching this query are considered. If the query involves transaction fields (date:, desc:, amt:, ...), the search is restricted to the matched transactions and their accounts. - With the --values flag, the tags' unique non-empty values are listed + With the --values flag, the tags' unique non-empty values are listed instead. With -E/--empty, blank/empty values are also shown. - With --parsed, tags or values are shown in the order they were parsed, - with duplicates included. (Except, tags from account declarations are + With --parsed, tags or values are shown in the order they were parsed, + with duplicates included. (Except, tags from account declarations are always shown first.) - Tip: remember, accounts also acquire tags from their parents, postings + Tip: remember, accounts also acquire tags from their parents, postings also acquire tags from their account and transaction, transactions also acquire tags from their postings. @@ -4613,13 +4614,13 @@ COMMANDS test Run built-in unit tests. - This command runs the unit tests built in to hledger and hledger-lib, - printing the results on stdout. If any test fails, the exit code will + This command runs the unit tests built in to hledger and hledger-lib, + printing the results on stdout. If any test fails, the exit code will be non-zero. - This is mainly used by hledger developers, but you can also use it to - sanity-check the installed hledger executable on your platform. All - tests are expected to pass - if you ever see a failure, please report + This is mainly used by hledger developers, but you can also use it to + sanity-check the installed hledger executable on your platform. All + tests are expected to pass - if you ever see a failure, please report as a bug! This command also accepts tasty test runner options, written after a -- @@ -4628,7 +4629,7 @@ COMMANDS $ hledger test -- -pData.Amount --color=never - For help on these, see https://github.com/feuerbach/tasty#options (-- + For help on these, see https://github.com/feuerbach/tasty#options (-- --help currently doesn't show them). Add-on commands @@ -4636,16 +4637,16 @@ COMMANDS o whose name starts with hledger- - o whose name ends with a recognised file extension: .bat,.com,.exe, + o whose name ends with a recognised file extension: .bat,.com,.exe, .hs,.lhs,.pl,.py,.rb,.rkt,.sh or none o and (on unix, mac) which are executable by the current user. - Add-ons are a relatively easy way to add local features or experiment - with new ideas. They can be written in any language, but haskell - scripts have a big advantage: they can use the same hledger library - functions that built-in commands use for command-line options, parsing - and reporting. Some experimental/example add-on scripts can be found + Add-ons are a relatively easy way to add local features or experiment + with new ideas. They can be written in any language, but haskell + scripts have a big advantage: they can use the same hledger library + functions that built-in commands use for command-line options, parsing + and reporting. Some experimental/example add-on scripts can be found in the hledger repo's bin/ directory. Note in a hledger command line, add-on command flags must have a double @@ -4669,17 +4670,17 @@ COMMANDS JOURNAL FORMAT hledger's default file format, representing a General Journal. - hledger's usual data source is a plain text file containing journal - entries in hledger journal format. This file represents a standard - accounting general journal. I use file names ending in .journal, but + hledger's usual data source is a plain text file containing journal + entries in hledger journal format. This file represents a standard + accounting general journal. I use file names ending in .journal, but that's not required. The journal file contains a number of transaction entries, each describing a transfer of money (or any commodity) between two or more named accounts, in a simple format readable by both hledger and humans. - hledger's journal format is a compatible subset, mostly, of ledger's - journal format, so hledger can work with compatible ledger journal - files as well. It's safe, and encouraged, to run both hledger and + hledger's journal format is a compatible subset, mostly, of ledger's + journal format, so hledger can work with compatible ledger journal + files as well. It's safe, and encouraged, to run both hledger and ledger on the same journal file, eg to validate the results you're get- ting. @@ -4687,25 +4688,25 @@ JOURNAL FORMAT the add or web or import commands to create and update it. Many users, though, edit the journal file with a text editor, and track - changes with a version control system such as git. Editor addons such - as ledger-mode or hledger-mode for Emacs, vim-ledger for Vim, and + changes with a version control system such as git. Editor addons such + as ledger-mode or hledger-mode for Emacs, vim-ledger for Vim, and hledger-vscode for Visual Studio Code, make this easier, adding colour, formatting, tab completion, and useful commands. See Editor configura- tion at hledger.org for the full list. - Here's a description of each part of the file format (and hledger's - data model). These are mostly in the order you'll use them, but in - some cases related concepts have been grouped together for easy refer- - ence, or linked before they are introduced, so feel free to skip over + Here's a description of each part of the file format (and hledger's + data model). These are mostly in the order you'll use them, but in + some cases related concepts have been grouped together for easy refer- + ence, or linked before they are introduced, so feel free to skip over anything that looks unnecessary right now. Transactions - Transactions are the main unit of information in a journal file. They - represent events, typically a movement of some quantity of commodities + Transactions are the main unit of information in a journal file. They + represent events, typically a movement of some quantity of commodities between two or more named accounts. - Each transaction is recorded as a journal entry, beginning with a sim- - ple date in column 0. This can be followed by any of the following + Each transaction is recorded as a journal entry, beginning with a sim- + ple date in column 0. This can be followed by any of the following optional fields, separated by spaces: o a status character (empty, !, or *) @@ -4714,11 +4715,11 @@ JOURNAL FORMAT o a description (any remaining text until end of line or a semicolon) - o a comment (any remaining text following a semicolon until end of + o a comment (any remaining text following a semicolon until end of line, and any following indented lines beginning with a semicolon) o 0 or more indented posting lines, describing what was transferred and - the accounts involved (indented comment lines are also allowed, but + the accounts involved (indented comment lines are also allowed, but not blank lines or non-indented lines). Here's a simple journal file containing one transaction: @@ -4729,35 +4730,35 @@ JOURNAL FORMAT Dates Simple dates - Dates in the journal file use simple dates format: YYYY-MM-DD or + Dates in the journal file use simple dates format: YYYY-MM-DD or YYYY/MM/DD or YYYY.MM.DD, with leading zeros optional. The year may be - omitted, in which case it will be inferred from the context: the cur- - rent transaction, the default year set with a default year directive, - or the current date when the command is run. Some examples: + omitted, in which case it will be inferred from the context: the cur- + rent transaction, the default year set with a default year directive, + or the current date when the command is run. Some examples: 2010-01-31, 2010/01/31, 2010.1.31, 1/31. - (The UI also accepts simple dates, as well as the more flexible smart + (The UI also accepts simple dates, as well as the more flexible smart dates documented in the hledger manual.) Secondary dates - Real-life transactions sometimes involve more than one date - eg the + Real-life transactions sometimes involve more than one date - eg the date you write a cheque, and the date it clears in your bank. When you - want to model this, for more accurate daily balances, you can specify + want to model this, for more accurate daily balances, you can specify individual posting dates. - Or, you can use the older secondary date feature (Ledger calls it aux- - iliary date or effective date). Note: we support this for compatibil- - ity, but I usually recommend avoiding this feature; posting dates are + Or, you can use the older secondary date feature (Ledger calls it aux- + iliary date or effective date). Note: we support this for compatibil- + ity, but I usually recommend avoiding this feature; posting dates are almost always clearer and simpler. A secondary date is written after the primary date, following an equals - sign. If the year is omitted, the primary date's year is assumed. - When running reports, the primary (left) date is used by default, but - with the --date2 flag (or --aux-date or --effective), the secondary + sign. If the year is omitted, the primary date's year is assumed. + When running reports, the primary (left) date is used by default, but + with the --date2 flag (or --aux-date or --effective), the secondary (right) date will be used instead. - The meaning of secondary dates is up to you, but it's best to follow a - consistent rule. Eg "primary = the bank's clearing date, secondary = + The meaning of secondary dates is up to you, but it's best to follow a + consistent rule. Eg "primary = the bank's clearing date, secondary = date the transaction was initiated, if different", as shown here: 2010/2/23=2/19 movie ticket @@ -4771,11 +4772,11 @@ JOURNAL FORMAT 2010-02-19 movie ticket assets:checking $-10 $-10 Posting dates - You can give individual postings a different date from their parent - transaction, by adding a posting comment containing a tag (see below) + You can give individual postings a different date from their parent + transaction, by adding a posting comment containing a tag (see below) like date:DATE. This is probably the best way to control posting dates - precisely. Eg in this example the expense should appear in May - reports, and the deduction from checking should be reported on 6/1 for + precisely. Eg in this example the expense should appear in May + reports, and the deduction from checking should be reported on 6/1 for easy bank reconciliation: 2015/5/30 @@ -4788,22 +4789,22 @@ JOURNAL FORMAT $ hledger -f t.j register checking 2015-06-01 assets:checking $-10 $-10 - DATE should be a simple date; if the year is not specified it will use - the year of the transaction's date. You can set the secondary date - similarly, with date2:DATE2. The date: or date2: tags must have a - valid simple date value if they are present, eg a date: tag with no + DATE should be a simple date; if the year is not specified it will use + the year of the transaction's date. You can set the secondary date + similarly, with date2:DATE2. The date: or date2: tags must have a + valid simple date value if they are present, eg a date: tag with no value is not allowed. Ledger's earlier, more compact bracketed date syntax is also supported: - [DATE], [DATE=DATE2] or [=DATE2]. hledger will attempt to parse any + [DATE], [DATE=DATE2] or [=DATE2]. hledger will attempt to parse any square-bracketed sequence of the 0123456789/-.= characters in this way. - With this syntax, DATE infers its year from the transaction and DATE2 + With this syntax, DATE infers its year from the transaction and DATE2 infers its year from DATE. Status - Transactions, or individual postings within a transaction, can have a - status mark, which is a single character before the transaction - description or posting account name, separated from it by a space, + Transactions, or individual postings within a transaction, can have a + status mark, which is a single character before the transaction + description or posting account name, separated from it by a space, indicating one of three statuses: @@ -4813,71 +4814,69 @@ JOURNAL FORMAT ! pending * cleared - When reporting, you can filter by status with the -U/--unmarked, - -P/--pending, and -C/--cleared flags; or the status:, status:!, and + When reporting, you can filter by status with the -U/--unmarked, + -P/--pending, and -C/--cleared flags; or the status:, status:!, and status:* queries; or the U, P, C keys in hledger-ui. - Note, in Ledger and in older versions of hledger, the "unmarked" state - is called "uncleared". As of hledger 1.3 we have renamed it to + Note, in Ledger and in older versions of hledger, the "unmarked" state + is called "uncleared". As of hledger 1.3 we have renamed it to unmarked for clarity. - To replicate Ledger and old hledger's behaviour of also matching pend- + To replicate Ledger and old hledger's behaviour of also matching pend- ing, combine -U and -P. - Status marks are optional, but can be helpful eg for reconciling with + Status marks are optional, but can be helpful eg for reconciling with real-world accounts. Some editor modes provide highlighting and short- - cuts for working with status. Eg in Emacs ledger-mode, you can toggle + cuts for working with status. Eg in Emacs ledger-mode, you can toggle transaction status with C-c C-e, or posting status with C-c C-c. - What "uncleared", "pending", and "cleared" actually mean is up to you. + What "uncleared", "pending", and "cleared" actually mean is up to you. Here's one suggestion: status meaning -------------------------------------------------------------------------- uncleared recorded but not yet reconciled; needs review - - pending tentatively reconciled (if needed, eg during a big reconcil- iation) cleared complete, reconciled as far as possible, and considered cor- rect - With this scheme, you would use -PC to see the current balance at your - bank, -U to see things which will probably hit your bank soon (like + With this scheme, you would use -PC to see the current balance at your + bank, -U to see things which will probably hit your bank soon (like uncashed checks), and no flags to see the most up-to-date state of your finances. Code - After the status mark, but before the description, you can optionally - write a transaction "code", enclosed in parentheses. This is a good - place to record a check number, or some other important transaction id + After the status mark, but before the description, you can optionally + write a transaction "code", enclosed in parentheses. This is a good + place to record a check number, or some other important transaction id or reference number. Description - A transaction's description is the rest of the line following the date - and status mark (or until a comment begins). Sometimes called the + A transaction's description is the rest of the line following the date + and status mark (or until a comment begins). Sometimes called the "narration" in traditional bookkeeping, it can be used for whatever you - wish, or left blank. Transaction descriptions can be queried, unlike + wish, or left blank. Transaction descriptions can be queried, unlike comments. Payee and note You can optionally include a | (pipe) character in descriptions to sub- divide the description into separate fields for payee/payer name on the - left (up to the first |) and an additional note field on the right - (after the first |). This may be worthwhile if you need to do more + left (up to the first |) and an additional note field on the right + (after the first |). This may be worthwhile if you need to do more precise querying and pivoting by payee or by note. Comments Lines in the journal beginning with a semicolon (;) or hash (#) or star - (*) are comments, and will be ignored. (Star comments cause org-mode - nodes to be ignored, allowing emacs users to fold and navigate their + (*) are comments, and will be ignored. (Star comments cause org-mode + nodes to be ignored, allowing emacs users to fold and navigate their journals with org-mode or orgstruct-mode.) - You can attach comments to a transaction by writing them after the - description and/or indented on the following lines (before the post- - ings). Similarly, you can attach comments to an individual posting by - writing them after the amount and/or indented on the following lines. + You can attach comments to a transaction by writing them after the + description and/or indented on the following lines (before the post- + ings). Similarly, you can attach comments to an individual posting by + writing them after the amount and/or indented on the following lines. Transaction and posting comments must begin with a semicolon (;). Some examples: @@ -4900,15 +4899,15 @@ JOURNAL FORMAT ; another comment line for posting 2 ; a file comment (because not indented) - You can also comment larger regions of a file using comment and end + You can also comment larger regions of a file using comment and end comment directives. Tags - Tags are a way to add extra labels or labelled data to transactions, + Tags are a way to add extra labels or labelled data to transactions, postings, or accounts, which you can then search or pivot on. They are written as a (optionally hyphenated) word immediately followed - by a full colon within a transaction or posting or account directive's + by a full colon within a transaction or posting or account directive's comment: account assets:checking ; accounttag: @@ -4924,16 +4923,16 @@ JOURNAL FORMAT o Tags on an account affect all postings to that account. - So in the example above, - the assets:checking account has one tag - (accounttag) - the transaction has two tags (transaction-tag, another- + So in the example above, - the assets:checking account has one tag + (accounttag) - the transaction has two tags (transaction-tag, another- transaction-tag) - the assets:checking posting has three tags (transac- tion-tag, another-transaction-tag, accounttag) - the expenses:food posting has three tags (transaction-tag, another-transaction-tag, post- ing-tag). - Tags can have a value, which is the text after the colon, until the - next comma or end of line, with surrounding whitespace stripped. So - here a-posting-tag's value is "the tag value", tag2's value is "foo", + Tags can have a value, which is the text after the colon, until the + next comma or end of line, with surrounding whitespace stripped. So + here a-posting-tag's value is "the tag value", tag2's value is "foo", and tag3's value is "" (the empty string): expenses:food $10 @@ -4942,44 +4941,44 @@ JOURNAL FORMAT A hledger tag value may not contain a comma. Postings - A posting is an addition of some amount to, or removal of some amount - from, an account. Each posting line begins with at least one space or + A posting is an addition of some amount to, or removal of some amount + from, an account. Each posting line begins with at least one space or tab (2 or 4 spaces is common), followed by: o (optional) a status character (empty, !, or *), followed by a space - o (required) an account name (any text, optionally containing single + o (required) an account name (any text, optionally containing single spaces, until end of line or a double space) o (optional) two or more spaces or tabs followed by an amount. - Positive amounts are being added to the account, negative amounts are + Positive amounts are being added to the account, negative amounts are being removed. The amounts within a transaction must always sum up to zero. As a con- - venience, one amount may be left blank; it will be inferred so as to + venience, one amount may be left blank; it will be inferred so as to balance the transaction. - Be sure to note the unusual two-space delimiter between account name - and amount. This makes it easy to write account names containing spa- - ces. But if you accidentally leave only one space (or tab) before the + Be sure to note the unusual two-space delimiter between account name + and amount. This makes it easy to write account names containing spa- + ces. But if you accidentally leave only one space (or tab) before the amount, the amount will be considered part of the account name. Virtual postings A posting with a parenthesised account name is called a virtual posting - or unbalanced posting, which means it is exempt from the usual rule + or unbalanced posting, which means it is exempt from the usual rule that a transaction's postings must balance add up to zero. - This is not part of double entry accounting, so you might choose to - avoid this feature. Or you can use it sparingly for certain special - cases where it can be convenient. Eg, you could set opening balances + This is not part of double entry accounting, so you might choose to + avoid this feature. Or you can use it sparingly for certain special + cases where it can be convenient. Eg, you could set opening balances without using a balancing equity account: 1/1 opening balances (assets:checking) $1000 (assets:savings) $2000 - A posting with a bracketed account name is called a balanced virtual + A posting with a bracketed account name is called a balanced virtual posting. The balanced virtual postings in a transaction must add up to zero (separately from other postings). Eg: @@ -4991,34 +4990,34 @@ JOURNAL FORMAT [assets:checking:available] $10 ; <- (something:else) $5 ; <- not required to balance - Ordinary non-parenthesised, non-bracketed postings are called real - postings. You can exclude virtual postings from reports with the + Ordinary non-parenthesised, non-bracketed postings are called real + postings. You can exclude virtual postings from reports with the -R/--real flag or real:1 query. Account names - Account names typically have several parts separated by a full colon, - from which hledger derives a hierarchical chart of accounts. They can - be anything you like, but in finance there are traditionally five top- + Account names typically have several parts separated by a full colon, + from which hledger derives a hierarchical chart of accounts. They can + be anything you like, but in finance there are traditionally five top- level accounts: assets, liabilities, revenue, expenses, and equity. - Account names may contain single spaces, eg: assets:accounts receiv- - able. Because of this, they must always be followed by two or more + Account names may contain single spaces, eg: assets:accounts receiv- + able. Because of this, they must always be followed by two or more spaces (or newline). Account names can be aliased. Amounts - After the account name, there is usually an amount. (Important: + After the account name, there is usually an amount. (Important: between account name and amount, there must be two or more spaces.) - hledger's amount format is flexible, supporting several international - formats. Here are some examples. Amounts have a number (the "quan- + hledger's amount format is flexible, supporting several international + formats. Here are some examples. Amounts have a number (the "quan- tity"): 1 ..and usually a currency symbol or commodity name (more on this below), - to the left or right of the quantity, with or without a separating + to the left or right of the quantity, with or without a separating space: $1 @@ -5026,13 +5025,13 @@ JOURNAL FORMAT 3 "green apples" Amounts can be preceded by a minus sign (or a plus sign, though plus is - the default), The sign can be written before or after a left-side com- + the default), The sign can be written before or after a left-side com- modity symbol: -$1 $-1 - One or more spaces between the sign and the number are acceptable when + One or more spaces between the sign and the number are acceptable when parsing (but they won't be displayed in output): + $1 @@ -5049,8 +5048,8 @@ JOURNAL FORMAT 1.23 1,23456780000009 - In the integer part of the quantity (left of the decimal mark), groups - of digits can optionally be separated by a digit group mark - a space, + In the integer part of the quantity (left of the decimal mark), groups + of digits can optionally be separated by a digit group mark - a space, comma, or period (different from the decimal mark): $1,000,000.00 @@ -5064,41 +5063,41 @@ JOURNAL FORMAT 1,000 1.000 - If you don't tell it otherwise, hledger will assume both of the above + If you don't tell it otherwise, hledger will assume both of the above are decimal marks, parsing both numbers as 1. - To prevent confusing parsing mistakes and undetected typos, especially - if your data contains digit group marks (eg, thousands separators), we + To prevent confusing parsing mistakes and undetected typos, especially + if your data contains digit group marks (eg, thousands separators), we recommend explicitly declaring the decimal mark character in each jour- - nal file, using a directive at the top of the file. The decimal-mark - directive is best, otherwise commodity directives will also work. + nal file, using a directive at the top of the file. The decimal-mark + directive is best, otherwise commodity directives will also work. These are described detail below. Commodity - Amounts in hledger have both a "quantity", which is a signed decimal + Amounts in hledger have both a "quantity", which is a signed decimal number, and a "commodity", which is a currency symbol, stock ticker, or any word or phrase describing something you are tracking. If the commodity name contains non-letters (spaces, numbers, or punctu- - ation), you must always write it inside double quotes ("green apples", + ation), you must always write it inside double quotes ("green apples", "ABC123"). - If you write just a bare number, that too will have a commodity, with + If you write just a bare number, that too will have a commodity, with name ""; we call that the "no-symbol commodity". - Actually, hledger combines these single-commodity amounts into more - powerful multi-commodity amounts, which are what it works with most of - the time. A multi-commodity amount could be, eg: 1 USD, 2 EUR, 3.456 - TSLA. In practice, you will only see multi-commodity amounts in + Actually, hledger combines these single-commodity amounts into more + powerful multi-commodity amounts, which are what it works with most of + the time. A multi-commodity amount could be, eg: 1 USD, 2 EUR, 3.456 + TSLA. In practice, you will only see multi-commodity amounts in hledger's output; you can't write them directly in the journal file. - (If you are writing scripts or working with hledger's internals, these + (If you are writing scripts or working with hledger's internals, these are the Amount and MixedAmount types.) Directives influencing number parsing and display - You can add decimal-mark and commodity directives to the journal, to - declare and control these things more explicitly and precisely. These - are described below, in JOURNAL FORMAT -> Declaring commodities. + You can add decimal-mark and commodity directives to the journal, to + declare and control these things more explicitly and precisely. These + are described below, in JOURNAL FORMAT -> Declaring commodities. Here's a quick example: # the decimal mark character used by all amounts in this file (all commodities) @@ -5113,48 +5112,48 @@ JOURNAL FORMAT Commodity display style For the amounts in each commodity, hledger chooses a consistent display - style to use in most reports. (Exceptions: price amounts, and all + style to use in most reports. (Exceptions: price amounts, and all amounts displayed by the print command, are displayed with all of their decimal digits visible.) A commodity's display style is inferred as follows. - First, if a default commodity is declared with D, this commodity and + First, if a default commodity is declared with D, this commodity and its style is applied to any no-symbol amounts in the journal. - Then each commodity's style is inferred from one of the following, in + Then each commodity's style is inferred from one of the following, in order of preference: - o The commodity directive for that commodity (including the no-symbol + o The commodity directive for that commodity (including the no-symbol commodity), if any. - o The amounts in that commodity seen in the journal's transactions. + o The amounts in that commodity seen in the journal's transactions. (Posting amounts only; prices and periodic or auto rules are ignored, currently.) - o The built-in fallback style, which looks like this: $1000.00. (Sym- + o The built-in fallback style, which looks like this: $1000.00. (Sym- bol on the left, period decimal mark, two decimal places.) A style is inferred from journal amounts as follows: - o Use the general style (decimal mark, symbol placement) of the first + o Use the general style (decimal mark, symbol placement) of the first amount - o Use the first-seen digit group style (digit group mark, digit group + o Use the first-seen digit group style (digit group mark, digit group sizes), if any o Use the maximum number of decimal places of all. - Transaction price amounts don't affect the commodity display style - directly, but occasionally they can do so indirectly (eg when a post- - ing's amount is inferred using a transaction price). If you find this + Transaction price amounts don't affect the commodity display style + directly, but occasionally they can do so indirectly (eg when a post- + ing's amount is inferred using a transaction price). If you find this causing problems, use a commodity directive to fix the display style. - To summarise: each commodity's amounts will be normalised to (a) the - style declared by a commodity directive, or (b) the style of the first - posting amount in the journal, with the first-seen digit group style - and the maximum-seen number of decimal places. So if your reports are - showing amounts in a way you don't like, eg with too many decimal + To summarise: each commodity's amounts will be normalised to (a) the + style declared by a commodity directive, or (b) the style of the first + posting amount in the journal, with the first-seen digit group style + and the maximum-seen number of decimal places. So if your reports are + showing amounts in a way you don't like, eg with too many decimal places, use a commodity directive. Some examples: # declare euro, dollar, bitcoin and no-symbol commodities and set their @@ -5164,34 +5163,34 @@ JOURNAL FORMAT commodity 1000.00000000 BTC commodity 1 000. - The inferred commodity style can be overridden by supplying a command + The inferred commodity style can be overridden by supplying a command line option. Rounding Amounts are stored internally as decimal numbers with up to 255 decimal - places, and displayed with the number of decimal places specified by - the commodity display style. Note, hledger uses banker's rounding: it - rounds to the nearest even number, eg 0.5 displayed with zero decimal - places is "0"). (Guaranteed since hledger 1.17.1; in older versions + places, and displayed with the number of decimal places specified by + the commodity display style. Note, hledger uses banker's rounding: it + rounds to the nearest even number, eg 0.5 displayed with zero decimal + places is "0"). (Guaranteed since hledger 1.17.1; in older versions this could vary if hledger was built with Decimal < 0.5.1.) Transaction prices (AKA Costs) - After a posting amount, you can note its cost or selling price in + After a posting amount, you can note its cost or selling price in another commodity, by writing either @ UNITPRICE or @@ TOTALPRICE after - it. This indicates a conversion transaction, where one commodity is + it. This indicates a conversion transaction, where one commodity is exchanged for another. - hledger docs have historically called this a "transaction price" - because it is specific to one transaction, unlike market prices which + hledger docs have historically called this a "transaction price" + because it is specific to one transaction, unlike market prices which are not. "Cost" is shorter and might be preferable; just remember this feature can represent either a buyer's cost, or a seller's price. - Costs are usually written explicitly with @ or @@, but can also be + Costs are usually written explicitly with @ or @@, but can also be inferred automatically for simple multi-commodity transactions. - As an example, here are several ways to record purchases of a foreign - currency in hledger, using the cost notation either explicitly or + As an example, here are several ways to record purchases of a foreign + currency in hledger, using the cost notation either explicitly or implicitly: 1. Write the price per unit, as @ UNITPRICE after the amount: @@ -5213,29 +5212,29 @@ JOURNAL FORMAT assets:euros EUR100 ; one hundred euros purchased assets:dollars $-135 ; for $135 - 4. Like 1, but the @ is parenthesised, i.e. (@); this is for compati- - bility with Ledger journals (Virtual posting costs), and is equiva- + 4. Like 1, but the @ is parenthesised, i.e. (@); this is for compati- + bility with Ledger journals (Virtual posting costs), and is equiva- lent to 1 in hledger. 5. Like 2, but as in 4 the @@ is parenthesised, i.e. (@@); in hledger, this is equivalent to 2. - Amounts can be converted to cost at report time using the -B/--cost + Amounts can be converted to cost at report time using the -B/--cost flag; this is discussed more in the COST section. Lot prices, lot dates - Ledger allows another kind of price, lot price (four variants: {UNIT- + Ledger allows another kind of price, lot price (four variants: {UNIT- PRICE}, {{TOTALPRICE}}, {=FIXEDUNITPRICE}, {{=FIXEDTOTALPRICE}}), and/or a lot date ([DATE]) to be specified. These are normally used to - select a lot when selling investments. hledger will parse these, for - compatibility with Ledger journals, but currently ignores them. A - transaction price, lot price and/or lot date may appear in any order, + select a lot when selling investments. hledger will parse these, for + compatibility with Ledger journals, but currently ignores them. A + transaction price, lot price and/or lot date may appear in any order, after the posting amount and before the balance assertion if any. Balance assertions - hledger supports Ledger-style balance assertions in journal files. - These look like, for example, = EXPECTEDBALANCE following a posting's - amount. Eg here we assert the expected dollar balance in accounts a + hledger supports Ledger-style balance assertions in journal files. + These look like, for example, = EXPECTEDBALANCE following a posting's + amount. Eg here we assert the expected dollar balance in accounts a and b after each posting: 2013/1/1 @@ -5247,59 +5246,59 @@ JOURNAL FORMAT b $-1 =$-2 After reading a journal file, hledger will check all balance assertions - and report an error if any of them fail. Balance assertions can pro- - tect you from, eg, inadvertently disrupting reconciled balances while - cleaning up old entries. You can disable them temporarily with the + and report an error if any of them fail. Balance assertions can pro- + tect you from, eg, inadvertently disrupting reconciled balances while + cleaning up old entries. You can disable them temporarily with the -I/--ignore-assertions flag, which can be useful for troubleshooting or - for reading Ledger files. (Note: this flag currently does not disable + for reading Ledger files. (Note: this flag currently does not disable balance assignments, below). Assertions and ordering - hledger sorts an account's postings and assertions first by date and - then (for postings on the same day) by parse order. Note this is dif- + hledger sorts an account's postings and assertions first by date and + then (for postings on the same day) by parse order. Note this is dif- ferent from Ledger, which sorts assertions only by parse order. (Also, - Ledger assertions do not see the accumulated effect of repeated post- + Ledger assertions do not see the accumulated effect of repeated post- ings to the same account within a transaction.) So, hledger balance assertions keep working if you reorder differently- - dated transactions within the journal. But if you reorder same-dated - transactions or postings, assertions might break and require updating. + dated transactions within the journal. But if you reorder same-dated + transactions or postings, assertions might break and require updating. This order dependence does bring an advantage: precise control over the order of postings and assertions within a day, so you can assert intra- day balances. Assertions and multiple included files - Multiple files included with the include directive are processed as if - concatenated into one file, preserving their order and the posting - order within each file. It means that balance assertions in later + Multiple files included with the include directive are processed as if + concatenated into one file, preserving their order and the posting + order within each file. It means that balance assertions in later files will see balance from earlier files. - And if you have multiple postings to an account on the same day, split - across multiple files, and you want to assert the account's balance on + And if you have multiple postings to an account on the same day, split + across multiple files, and you want to assert the account's balance on that day, you'll need to put the assertion in the right file - the last one in the sequence, probably. Assertions and multiple -f files - Unlike include, when multiple files are specified on the command line - with multiple -f/--file options, balance assertions will not see bal- + Unlike include, when multiple files are specified on the command line + with multiple -f/--file options, balance assertions will not see bal- ance from earlier files. This can be useful when you do not want prob- lems in earlier files to disrupt valid assertions in later files. - If you do want assertions to see balance from earlier files, use + If you do want assertions to see balance from earlier files, use include, or concatenate the files temporarily. Assertions and commodities - The asserted balance must be a simple single-commodity amount, and in - fact the assertion checks only this commodity's balance within the - (possibly multi-commodity) account balance. This is how assertions + The asserted balance must be a simple single-commodity amount, and in + fact the assertion checks only this commodity's balance within the + (possibly multi-commodity) account balance. This is how assertions work in Ledger also. We could call this a "partial" balance assertion. To assert the balance of more than one commodity in an account, you can write multiple postings, each asserting one commodity's balance. - You can make a stronger "total" balance assertion by writing a double + You can make a stronger "total" balance assertion by writing a double equals sign (== EXPECTEDBALANCE). This asserts that there are no other - commodities in the account besides the asserted one (or at least, that + commodities in the account besides the asserted one (or at least, that their balance is 0). 2013/1/1 @@ -5318,7 +5317,7 @@ JOURNAL FORMAT a 0 == $1 It's not yet possible to make a complete assertion about a balance that - has multiple commodities. One workaround is to isolate each commodity + has multiple commodities. One workaround is to isolate each commodity into its own subaccount: 2013/1/1 @@ -5332,21 +5331,21 @@ JOURNAL FORMAT a:euro 0 == 1EUR Assertions and prices - Balance assertions ignore transaction prices, and should normally be + Balance assertions ignore transaction prices, and should normally be written without one: 2019/1/1 (a) $1 @ EUR1 = $1 - We do allow prices to be written there, however, and print shows them, - even though they don't affect whether the assertion passes or fails. - This is for backward compatibility (hledger's close command used to - generate balance assertions with prices), and because balance assign- + We do allow prices to be written there, however, and print shows them, + even though they don't affect whether the assertion passes or fails. + This is for backward compatibility (hledger's close command used to + generate balance assertions with prices), and because balance assign- ments do use them (see below). Assertions and subaccounts - The balance assertions above (= and ==) do not count the balance from - subaccounts; they check the account's exclusive balance only. You can + The balance assertions above (= and ==) do not count the balance from + subaccounts; they check the account's exclusive balance only. You can assert the balance including subaccounts by writing =* or ==*, eg: 2019/1/1 @@ -5360,10 +5359,10 @@ JOURNAL FORMAT are not affected by the --real/-R flag or real: query. Assertions and auto postings - Balance assertions are affected by the --auto flag, which generates + Balance assertions are affected by the --auto flag, which generates auto postings, which can alter account balances. Because auto postings are optional in hledger, accounts affected by them effectively have two - balances. But balance assertions can only test one or the other of + balances. But balance assertions can only test one or the other of these. So to avoid making fragile assertions, either: o assert the balance calculated with --auto, and always use --auto with @@ -5376,16 +5375,16 @@ JOURNAL FORMAT avoid auto postings entirely). Assertions and precision - Balance assertions compare the exactly calculated amounts, which are - not always what is shown by reports. Eg a commodity directive may - limit the display precision, but this will not affect balance asser- + Balance assertions compare the exactly calculated amounts, which are + not always what is shown by reports. Eg a commodity directive may + limit the display precision, but this will not affect balance asser- tions. Balance assertion failure messages show exact amounts. Balance assignments - Ledger-style balance assignments are also supported. These are like - balance assertions, but with no posting amount on the left side of the - equals sign; instead it is calculated automatically so as to satisfy - the assertion. This can be a convenience during data entry, eg when + Ledger-style balance assignments are also supported. These are like + balance assertions, but with no posting amount on the left side of the + equals sign; instead it is calculated automatically so as to satisfy + the assertion. This can be a convenience during data entry, eg when setting opening balances: ; starting a new journal, set asset account balances @@ -5403,14 +5402,14 @@ JOURNAL FORMAT expenses:misc The calculated amount depends on the account's balance in the commodity - at that point (which depends on the previously-dated postings of the - commodity to that account since the last balance assertion or assign- + at that point (which depends on the previously-dated postings of the + commodity to that account since the last balance assertion or assign- ment). Note that using balance assignments makes your journal a little less explicit; to know the exact amount posted, you have to run hledger or do the calculations yourself, instead of just reading it. Balance assignments and prices - A transaction price in a balance assignment will cause the calculated + A transaction price in a balance assignment will cause the calculated amount to have that price attached: 2019/1/1 @@ -5421,24 +5420,24 @@ JOURNAL FORMAT (a) $1 @ EUR2 = $1 @ EUR2 Directives - A directive is a line in the journal beginning with a special keyword, + A directive is a line in the journal beginning with a special keyword, that influences how the journal is processed, how things are displayed, - and so on. hledger's directives are based on (a subset of) Ledger's, - but there are many differences, and also some differences between + and so on. hledger's directives are based on (a subset of) Ledger's, + but there are many differences, and also some differences between hledger versions. Here are some more definitions: - o subdirective - Some directives support subdirectives, written + o subdirective - Some directives support subdirectives, written indented below the parent directive. - o decimal mark - The character to interpret as a decimal mark (period + o decimal mark - The character to interpret as a decimal mark (period or comma) when parsing amounts of a commodity. o display style - How to display amounts of a commodity in output: sym- bol side and spacing, digit groups, decimal mark, and number of deci- mal places. - Directives are not required when starting out with hledger, but you - will probably add some as your needs grow. Here is an overview of + Directives are not required when starting out with hledger, but you + will probably add some as your needs grow. Here is an overview of directives by purpose: @@ -5448,19 +5447,21 @@ JOURNAL FORMAT ----------------------------------------------------------------------------- READING/GENERATING DATA: Declare a commodity's or file's commodity, D, decimal- - decimal mark to help parse mark + decimal mark to help parse mark amounts accurately - Apply changes to the data while alias, apply account, --alias + Apply changes to the data while alias, apply account, --alias parsing comment, D, Y Inline extra data files include multiple -f/--file's - Generate extra transactions or ~ + Generate extra transactions or ~ budget goals Generate extra postings = CHECKING FOR ERRORS: - Define valid entities to allow account, commodity, + Define valid entities to allow account, commodity, stricter error checking payee DISPLAYING REPORTS: + + Declare accounts' display order account and accounting type Declare commodity display commodity, D -c/--commodity- @@ -5474,76 +5475,73 @@ JOURNAL FORMAT file end? ---------------------------------------------------------------------------------- - account Declares an account, for checking all entries in all files; - and its display order and type, for reports. Subdirectives: + account Declares an account, for checking all entries in all files; + and its display order and type, for reports. Subdirectives: any text, ignored. - alias Rewrites account names, in following entries until end of Y + alias Rewrites account names, in following entries until end of Y current file or end aliases. - apply Prepends a common parent account to all account names, in Y - account following entries until end of current file or end apply + apply Prepends a common parent account to all account names, in Y + account following entries until end of current file or end apply account. - comment Ignores part of the journal file, until end of current file Y + comment Ignores part of the journal file, until end of current file Y or end comment. - commod- Declares a commodity, for checking all entries in all files; N, Y - ity the decimal mark for parsing amounts of this commodity, for - following entries until end of current file; and its display + commod- Declares a commodity, for checking all entries in all files; N, Y + ity the decimal mark for parsing amounts of this commodity, for + following entries until end of current file; and its display style, for reports. Takes precedence over D. Subdirectives: format (alternate syntax). - D Sets a default commodity to use for no-symbol amounts, and Y - its decimal mark for parsing amounts of this commodity in - following entries until end of current file; and its display + D Sets a default commodity to use for no-symbol amounts, and Y + its decimal mark for parsing amounts of this commodity in + following entries until end of current file; and its display style, for reports. - deci- Declares the decimal mark, for parsing amounts of all com- Y - mal- modities in following entries until next decimal-mark or end - mark of current file. Included files can override. Takes prece- + deci- Declares the decimal mark, for parsing amounts of all com- Y + mal- modities in following entries until next decimal-mark or end + mark of current file. Included files can override. Takes prece- dence over commodity and D. include Includes entries and directives from another file, as if they were written inline. payee Declares a payee name, for checking all entries in all files. - P Declares a market price for a commodity on some date, for + P Declares a market price for a commodity on some date, for valuation reports. - Y Declares a year for yearless dates, for following entries Y + Y Declares a year for yearless dates, for following entries Y until end of current file. - ~ Declares a periodic transaction rule that generates future - (tilde) transactions with --forecast and budget goals with balance + ~ Declares a periodic transaction rule that generates future + (tilde) transactions with --forecast and budget goals with balance --budget. - - - - = Declares an auto posting rule that generates extra postings partly - (equals) on matched transactions with --auto, in current, parent, and + = Declares an auto posting rule that generates extra postings partly + (equals) on matched transactions with --auto, in current, parent, and child files (but not sibling files, see #1212). Directives and multiple files - If you use multiple -f/--file options, or the include directive, + If you use multiple -f/--file options, or the include directive, hledger will process multiple input files. But directives which affect - input typically have effect only until the end of the file in which + input typically have effect only until the end of the file in which they occur (and on any included files in that region). This may seem inconvenient, but it's intentional; it makes reports sta- - ble and deterministic, independent of the order of input. Otherwise - you could see different numbers if you happened to write -f options in - a different order, or if you moved includes around while cleaning up + ble and deterministic, independent of the order of input. Otherwise + you could see different numbers if you happened to write -f options in + a different order, or if you moved includes around while cleaning up your files. - It can be surprising though; for example, it means that alias direc- + It can be surprising though; for example, it means that alias direc- tives do not affect parent or sibling files (see below). Comment blocks - A line containing just comment starts a commented region of the file, + A line containing just comment starts a commented region of the file, and a line containing just end comment (or the end of the current file) ends it. See also comments. Including other files - You can pull in the content of additional files by writing an include + You can pull in the content of additional files by writing an include directive, like this: include FILEPATH - Only journal files can include, and only journal, timeclock or timedot + Only journal files can include, and only journal, timeclock or timedot files can be included (not CSV files, currently). - If the file path does not begin with a slash, it is relative to the + If the file path does not begin with a slash, it is relative to the current file's folder. A tilde means home directory, eg: include ~/main.journal. @@ -5551,18 +5549,18 @@ JOURNAL FORMAT The path may contain glob patterns to match multiple files, eg: include *.journal. - There is limited support for recursive wildcards: **/ (the slash is - required) matches 0 or more subdirectories. It's not super convenient - since you have to avoid include cycles and including directories, but + There is limited support for recursive wildcards: **/ (the slash is + required) matches 0 or more subdirectories. It's not super convenient + since you have to avoid include cycles and including directories, but this can be done, eg: include */**/*.journal. The path may also be prefixed to force a specific file format, overrid- - ing the file extension (as described in hledger.1 -> Input files): + ing the file extension (as described in hledger.1 -> Input files): include timedot:~/notes/2020*.md. Default year - You can set a default year to be used for subsequent dates which don't - specify a year. This is a line beginning with Y followed by the year. + You can set a default year to be used for subsequent dates which don't + specify a year. This is a line beginning with Y followed by the year. Eg: Y2009 ; set default year to 2009 @@ -5582,9 +5580,9 @@ JOURNAL FORMAT assets Declaring payees - The payee directive can be used to declare a limited set of payees - which may appear in transaction descriptions. The "payees" check will - report an error if any transaction refers to a payee that has not been + The payee directive can be used to declare a limited set of payees + which may appear in transaction descriptions. The "payees" check will + report an error if any transaction refers to a payee that has not been declared. Eg: payee Whole Foods @@ -5600,36 +5598,36 @@ JOURNAL FORMAT decimal-mark , - This prevents any ambiguity when parsing numbers in the file, so we - recommend it, especially if the file contains digit group marks (eg + This prevents any ambiguity when parsing numbers in the file, so we + recommend it, especially if the file contains digit group marks (eg thousands separators). Declaring commodities - You can use commodity directives to declare your commodities. In fact + You can use commodity directives to declare your commodities. In fact the commodity directive performs several functions at once: - 1. It declares commodities which may be used in the journal. This can - optionally be enforced, providing useful error checking. (Cf Com- + 1. It declares commodities which may be used in the journal. This can + optionally be enforced, providing useful error checking. (Cf Com- modity error checking) - 2. It declares which decimal mark character (period or comma), to - expect when parsing input - useful to disambiguate international - number formats in your data. Without this, hledger will parse both + 2. It declares which decimal mark character (period or comma), to + expect when parsing input - useful to disambiguate international + number formats in your data. Without this, hledger will parse both 1,000 and 1.000 as 1. (Cf Amounts) - 3. It declares how to render the commodity's amounts when displaying + 3. It declares how to render the commodity's amounts when displaying output - the decimal mark, any digit group marks, the number of dec- - imal places, symbol placement and so on. (Cf Commodity display + imal places, symbol placement and so on. (Cf Commodity display style) - You will run into one of the problems solved by commodity directives + You will run into one of the problems solved by commodity directives sooner or later, so we recommend using them, for robust and predictable parsing and display. - Generally you should put them at the top of your journal file (since + Generally you should put them at the top of your journal file (since for function 2, they affect only following amounts, cf #793). - A commodity directive is just the word commodity followed by a sample + A commodity directive is just the word commodity followed by a sample amount, like this: ;commodity SAMPLEAMOUNT @@ -5637,8 +5635,8 @@ JOURNAL FORMAT commodity $1000.00 commodity 1,000.0000 AAAA ; optional same-line comment - It may also be written on multiple lines, and use the format subdirec- - tive, as in Ledger. Note in this case the commodity symbol appears + It may also be written on multiple lines, and use the format subdirec- + tive, as in Ledger. Note in this case the commodity symbol appears twice; it must be the same in both places: ;commodity SYMBOL @@ -5650,11 +5648,11 @@ JOURNAL FORMAT commodity INR format INR 1,00,00,000.00 - Remember that if the commodity symbol contains spaces, numbers, or + Remember that if the commodity symbol contains spaces, numbers, or punctuation, it must be enclosed in double quotes (cf Commodity). - The amount's quantity does not matter; only the format is significant. - It must include a decimal mark - either a period or a comma - followed + The amount's quantity does not matter; only the format is significant. + It must include a decimal mark - either a period or a comma - followed by 0 or more decimal digits. A few more examples: @@ -5665,34 +5663,34 @@ JOURNAL FORMAT commodity INR 9,99,99,999.0 commodity 1 000 000. - Note hledger normally uses banker's rounding, so 0.5 displayed with + Note hledger normally uses banker's rounding, so 0.5 displayed with zero decimal digits is "0". (More at Commodity display style.) - Even in the presence of commodity directives, the commodity display + Even in the presence of commodity directives, the commodity display style can still be overridden by supplying a command line option. Commodity error checking - In strict mode, enabled with the -s/--strict flag, hledger will report - an error if a commodity symbol is used that has not been declared by a - commodity directive. This works similarly to account error checking, + In strict mode, enabled with the -s/--strict flag, hledger will report + an error if a commodity symbol is used that has not been declared by a + commodity directive. This works similarly to account error checking, see the notes there for more details. - Note, this disallows amounts without a commodity symbol, because cur- - rently it's not possible (?) to declare the "no-symbol" commodity with - a directive. This is one exception for convenience: zero amounts are + Note, this disallows amounts without a commodity symbol, because cur- + rently it's not possible (?) to declare the "no-symbol" commodity with + a directive. This is one exception for convenience: zero amounts are always allowed to have no commodity symbol. Default commodity The D directive sets a default commodity, to be used for any subsequent - commodityless amounts (ie, plain numbers) seen while parsing the jour- - nal. This effect lasts until the next D directive, or the end of the + commodityless amounts (ie, plain numbers) seen while parsing the jour- + nal. This effect lasts until the next D directive, or the end of the journal. - For compatibility/historical reasons, D also acts like a commodity + For compatibility/historical reasons, D also acts like a commodity directive (setting the commodity's decimal mark for parsing and display style for output). - The syntax is D AMOUNT. As with commodity, the amount must include a + The syntax is D AMOUNT. As with commodity, the amount must include a decimal mark (either period or comma). Eg: ; commodity-less amounts should be treated as dollars @@ -5706,23 +5704,23 @@ JOURNAL FORMAT If both commodity and D directives are found for a commodity, commodity takes precedence for setting decimal mark and display style. - If you are using D and also checking commodities, you will need to add + If you are using D and also checking commodities, you will need to add a commodity directive similar to the D. (The hledger check commodities command expects commodity directives, and ignores D). Declaring market prices - The P directive declares a market price, which is an exchange rate + The P directive declares a market price, which is an exchange rate between two commodities on a certain date. (In Ledger, they are called - "historical prices".) These are often obtained from a stock exchange, + "historical prices".) These are often obtained from a stock exchange, cryptocurrency exchange, or the foreign exchange market. The format is: P DATE COMMODITY1SYMBOL COMMODITY2AMOUNT - DATE is a simple date, COMMODITY1SYMBOL is the symbol of the commodity - being priced, and COMMODITY2AMOUNT is the amount (symbol and quantity) - of commodity 2 that one unit of commodity 1 is worth on this date. + DATE is a simple date, COMMODITY1SYMBOL is the symbol of the commodity + being priced, and COMMODITY2AMOUNT is the amount (symbol and quantity) + of commodity 2 that one unit of commodity 1 is worth on this date. Examples: # one euro was worth $1.35 from 2009-01-01 onward: @@ -5731,34 +5729,34 @@ JOURNAL FORMAT # and $1.40 from 2010-01-01 onward: P 2010-01-01 EUR $1.40 - The -V, -X and --value flags use these market prices to show amount + The -V, -X and --value flags use these market prices to show amount values in another commodity. See Valuation. Declaring accounts account directives can be used to declare accounts (ie, the places that - amounts are transferred from and to). Though not required, these dec- + amounts are transferred from and to). Though not required, these dec- larations can provide several benefits: o They can document your intended chart of accounts, providing a refer- ence. - o In strict mode, they restrict which accounts may be posted to by + o In strict mode, they restrict which accounts may be posted to by transactions, which helps detect typos. - o They control account display order in reports, allowing non-alpha- + o They control account display order in reports, allowing non-alpha- betic sorting (eg Revenues to appear above Expenses). - o They help with account name completion (in hledger add, hledger-web, + o They help with account name completion (in hledger add, hledger-web, hledger-iadd, ledger-mode, etc.) o They can store additional account information as comments, or as tags which can be used to filter or pivot reports. - o They can help hledger know your accounts' types (asset, liability, - equity, revenue, expense), affecting reports like balancesheet and + o They can help hledger know your accounts' types (asset, liability, + equity, revenue, expense), affecting reports like balancesheet and incomestatement. - They are written as the word account followed by a hledger-style + They are written as the word account followed by a hledger-style account name, eg: account assets:bank:checking @@ -5766,7 +5764,7 @@ JOURNAL FORMAT Account comments Comments, beginning with a semicolon: - o can be written on the same line, but only after two or more spaces + o can be written on the same line, but only after two or more spaces (because ; is allowed in account names) o and/or on the next lines, indented @@ -5780,42 +5778,42 @@ JOURNAL FORMAT ; some tags - type:A, acctnum:12345 Account subdirectives - Ledger-style indented subdirectives are also accepted, but currently + Ledger-style indented subdirectives are also accepted, but currently ignored: account assets:bank:checking format subdirective is ignored Account error checking - By default, accounts need not be declared; they come into existence - when a posting references them. This is convenient, but it means - hledger can't warn you when you mis-spell an account name in the jour- + By default, accounts need not be declared; they come into existence + when a posting references them. This is convenient, but it means + hledger can't warn you when you mis-spell an account name in the jour- nal. Usually you'll find that error later, as an extra account in bal- ance reports, or an incorrect balance when reconciling. - In strict mode, enabled with the -s/--strict flag, hledger will report - an error if any transaction uses an account name that has not been + In strict mode, enabled with the -s/--strict flag, hledger will report + an error if any transaction uses an account name that has not been declared by an account directive. Some notes: - o The declaration is case-sensitive; transactions must use the correct + o The declaration is case-sensitive; transactions must use the correct account name capitalisation. - o The account directive's scope is "whole file and below" (see direc- + o The account directive's scope is "whole file and below" (see direc- tives). This means it affects all of the current file, and any files - it includes, but not parent or sibling files. The position of + it includes, but not parent or sibling files. The position of account directives within the file does not matter, though it's usual to put them at the top. - o Accounts can only be declared in journal files, but will affect + o Accounts can only be declared in journal files, but will affect included files of all types. - o It's currently not possible to declare "all possible subaccounts" + o It's currently not possible to declare "all possible subaccounts" with a wildcard; every account posted to must be declared. Account display order - The order in which account directives are written influences the order - in which accounts appear in reports, hledger-ui, hledger-web etc. By - default accounts appear in alphabetical order, but if you add these + The order in which account directives are written influences the order + in which accounts appear in reports, hledger-ui, hledger-web etc. By + default accounts appear in alphabetical order, but if you add these account directives to the journal file: account assets @@ -5840,36 +5838,36 @@ JOURNAL FORMAT account other:zoo - would influence the position of zoo among other's subaccounts, but not + would influence the position of zoo among other's subaccounts, but not the position of other among the top-level accounts. This means: - o you will sometimes declare parent accounts (eg account other above) - that you don't intend to post to, just to customize their display + o you will sometimes declare parent accounts (eg account other above) + that you don't intend to post to, just to customize their display order - o sibling accounts stay together (you couldn't display x:y in between + o sibling accounts stay together (you couldn't display x:y in between a:b and a:c). Account types hledger knows that accounts come in several types: assets, liabilities, - expenses and so on. This enables easy reports like balancesheet and + expenses and so on. This enables easy reports like balancesheet and incomestatement, and filtering by account type with the type: query. As a convenience, hledger will detect these account types automatically - if you are using common english-language top-level account names - (described below). But generally we recommend you declare types + if you are using common english-language top-level account names + (described below). But generally we recommend you declare types explicitly, by adding a type: tag to your top-level account directives. - Subaccounts will inherit the type of their parent. The tag's value + Subaccounts will inherit the type of their parent. The tag's value should be one of the five main account types: o A or Asset (things you own) o L or Liability (things you owe) - o E or Equity (investment/ownership; balanced counterpart of assets & + o E or Equity (investment/ownership; balanced counterpart of assets & liabilities) - o R or Revenue (what you received money from, AKA income; technically + o R or Revenue (what you received money from, AKA income; technically part of Equity) o X or Expense (what you spend money on; technically part of Equity) @@ -5896,10 +5894,10 @@ JOURNAL FORMAT Here are some tips for working with account types. - o The rules for inferring types from account names are as follows. + o The rules for inferring types from account names are as follows. These are just a convenience that sometimes help new users get going; if they don't work for you, just ignore them and declare your account - types. See also Regular expressions. Note the Cash regexp changed + types. See also Regular expressions. Note the Cash regexp changed in hledger 1.24.99.2. If account's name contains this (CI) regular expression: | its type is: @@ -5912,25 +5910,25 @@ JOURNAL FORMAT ^(income|revenue)s?(:|$) | Revenue ^expenses?(:|$) | Expense - o If you declare any account types, it's a good idea to declare an - account for all of the account types, because a mixture of declared + o If you declare any account types, it's a good idea to declare an + account for all of the account types, because a mixture of declared and name-inferred types can disrupt certain reports. - o Certain uses of account aliases can disrupt account types. See + o Certain uses of account aliases can disrupt account types. See Rewriting accounts > Aliases and account types. o As mentioned above, subaccounts will inherit a type from their parent - account. More precisely, an account's type is decided by the first + account. More precisely, an account's type is decided by the first of these that exists: 1. A type: declaration for this account. - 2. A type: declaration in the parent accounts above it, preferring + 2. A type: declaration in the parent accounts above it, preferring the nearest. 3. An account type inferred from this account's name. - 4. An account type inferred from a parent account's name, preferring + 4. An account type inferred from a parent account's name, preferring the nearest parent. 5. Otherwise, it will have no type. @@ -5956,7 +5954,7 @@ JOURNAL FORMAT o customising reports Account aliases also rewrite account names in account directives. They - do not affect account names being entered via hledger add or hledger- + do not affect account names being entered via hledger add or hledger- web. Account aliases are very powerful. They are generally easy to use cor- @@ -5966,9 +5964,9 @@ JOURNAL FORMAT See also Rewrite account names. Basic aliases - To set an account alias, use the alias directive in your journal file. - This affects all subsequent journal entries in the current file or its - included files (but note: not sibling or parent files). The spaces + To set an account alias, use the alias directive in your journal file. + This affects all subsequent journal entries in the current file or its + included files (but note: not sibling or parent files). The spaces around the = are optional: alias OLD = NEW @@ -5976,17 +5974,17 @@ JOURNAL FORMAT Or, you can use the --alias 'OLD=NEW' option on the command line. This affects all entries. It's useful for trying out aliases interactively. - OLD and NEW are case sensitive full account names. hledger will - replace any occurrence of the old account name with the new one. Sub- + OLD and NEW are case sensitive full account names. hledger will + replace any occurrence of the old account name with the new one. Sub- accounts are also affected. Eg: alias checking = assets:bank:wells fargo:checking ; rewrites "checking" to "assets:bank:wells fargo:checking", or "checking:a" to "assets:bank:wells fargo:checking:a" Regex aliases - There is also a more powerful variant that uses a regular expression, - indicated by wrapping the pattern in forward slashes. (This is the - only place where hledger requires forward slashes around a regular + There is also a more powerful variant that uses a regular expression, + indicated by wrapping the pattern in forward slashes. (This is the + only place where hledger requires forward slashes around a regular expression.) Eg: @@ -5997,13 +5995,13 @@ JOURNAL FORMAT $ hledger --alias '/REGEX/=REPLACEMENT' ... - Any part of an account name matched by REGEX will be replaced by + Any part of an account name matched by REGEX will be replaced by REPLACEMENT. REGEX is case-insensitive as usual. - If you need to match a forward slash, escape it with a backslash, eg + If you need to match a forward slash, escape it with a backslash, eg /\/=:. - If REGEX contains parenthesised match groups, these can be referenced + If REGEX contains parenthesised match groups, these can be referenced by the usual backslash and number in REPLACEMENT: alias /^(.+):bank:([^:]+):(.*)/ = \1:\2 \3 @@ -6013,21 +6011,21 @@ JOURNAL FORMAT option argument), so it can contain trailing whitespace. Combining aliases - You can define as many aliases as you like, using journal directives + You can define as many aliases as you like, using journal directives and/or command line options. - Recursive aliases - where an account name is rewritten by one alias, - then by another alias, and so on - are allowed. Each alias sees the + Recursive aliases - where an account name is rewritten by one alias, + then by another alias, and so on - are allowed. Each alias sees the effect of previously applied aliases. - In such cases it can be important to understand which aliases will be - applied and in which order. For (each account name in) each journal + In such cases it can be important to understand which aliases will be + applied and in which order. For (each account name in) each journal entry, we apply: - 1. alias directives preceding the journal entry, most recently parsed + 1. alias directives preceding the journal entry, most recently parsed first (ie, reading upward from the journal entry, bottom to top) - 2. --alias options, in the order they appeared on the command line + 2. --alias options, in the order they appeared on the command line (left to right). In other words, for (an account name in) a given journal entry: @@ -6038,15 +6036,15 @@ JOURNAL FORMAT o aliases defined after/below the entry do not affect it. - This gives nearby aliases precedence over distant ones, and helps pro- - vide semantic stability - aliases will keep working the same way inde- + This gives nearby aliases precedence over distant ones, and helps pro- + vide semantic stability - aliases will keep working the same way inde- pendent of which files are being read and in which order. - In case of trouble, adding --debug=6 to the command line will show + In case of trouble, adding --debug=6 to the command line will show which aliases are being applied when. Aliases and multiple files - As explained at Directives and multiple files, alias directives do not + As explained at Directives and multiple files, alias directives do not affect parent or sibling files. Eg in this command, hledger -f a.aliases -f b.journal @@ -6079,7 +6077,7 @@ JOURNAL FORMAT end aliases Aliases can generate bad account names - Be aware that account aliases can produce malformed account names, + Be aware that account aliases can produce malformed account names, which could cause confusing reports or invalid print output. For exam- ple, you could erase all account names: @@ -6091,8 +6089,8 @@ JOURNAL FORMAT 2021-01-01 1 - The above print output is not a valid journal. Or you could insert an - illegal double space, causing print output that would give a different + The above print output is not a valid journal. Or you could insert an + illegal double space, causing print output that would give a different journal when reparsed: 2021-01-01 @@ -6106,25 +6104,25 @@ JOURNAL FORMAT Aliases and account types If an account with a type declaration (see Declaring accounts > Account - types) is renamed by an alias, normally the account type remains in + types) is renamed by an alias, normally the account type remains in effect. - However, renaming in a way that reshapes the account tree (eg renaming - parent accounts but not their children, or vice versa) could prevent + However, renaming in a way that reshapes the account tree (eg renaming + parent accounts but not their children, or vice versa) could prevent child accounts from inheriting the account type of their parents. - Secondly, if an account's type is being inferred from its name, renam- + Secondly, if an account's type is being inferred from its name, renam- ing it by an alias could prevent or alter that. - If you are using account aliases and the type: query is not matching - accounts as you expect, try troubleshooting with the accounts command, + If you are using account aliases and the type: query is not matching + accounts as you expect, try troubleshooting with the accounts command, eg something like: $ hledger accounts --alias assets=bassetts type:a Default parent account - You can specify a parent account which will be prepended to all - accounts within a section of the journal. Use the apply account and + You can specify a parent account which will be prepended to all + accounts within a section of the journal. Use the apply account and end apply account directives like so: apply account home @@ -6141,7 +6139,7 @@ JOURNAL FORMAT home:food $10 home:cash $-10 - If end apply account is omitted, the effect lasts to the end of the + If end apply account is omitted, the effect lasts to the end of the file. Included files are also affected, eg: apply account business @@ -6150,49 +6148,49 @@ JOURNAL FORMAT apply account personal include personal.journal - Prior to hledger 1.0, legacy account and end spellings were also sup- + Prior to hledger 1.0, legacy account and end spellings were also sup- ported. - A default parent account also affects account directives. It does not - affect account names being entered via hledger add or hledger-web. If - account aliases are present, they are applied after the default parent + A default parent account also affects account directives. It does not + affect account names being entered via hledger add or hledger-web. If + account aliases are present, they are applied after the default parent account. Periodic transactions - Periodic transaction rules describe transactions that recur. They - allow hledger to generate temporary future transactions to help with - forecasting, so you don't have to write out each one in the journal, + Periodic transaction rules describe transactions that recur. They + allow hledger to generate temporary future transactions to help with + forecasting, so you don't have to write out each one in the journal, and it's easy to try out different forecasts. - Periodic transactions can be a little tricky, so before you use them, + Periodic transactions can be a little tricky, so before you use them, read this whole section - or at least these tips: - 1. Two spaces accidentally added or omitted will cause you trouble - + 1. Two spaces accidentally added or omitted will cause you trouble - read about this below. - 2. For troubleshooting, show the generated transactions with hledger - print --forecast tag:generated or hledger register --forecast + 2. For troubleshooting, show the generated transactions with hledger + print --forecast tag:generated or hledger register --forecast tag:generated. - 3. Forecasted transactions will begin only after the last non-fore- + 3. Forecasted transactions will begin only after the last non-fore- casted transaction's date. - 4. Forecasted transactions will end 6 months from today, by default. + 4. Forecasted transactions will end 6 months from today, by default. See below for the exact start/end rules. - 5. period expressions can be tricky. Their documentation needs + 5. period expressions can be tricky. Their documentation needs improvement, but is worth studying. - 6. Some period expressions with a repeating interval must begin on a - natural boundary of that interval. Eg in weekly from DATE, DATE - must be a monday. ~ weekly from 2019/10/1 (a tuesday) will give an + 6. Some period expressions with a repeating interval must begin on a + natural boundary of that interval. Eg in weekly from DATE, DATE + must be a monday. ~ weekly from 2019/10/1 (a tuesday) will give an error. 7. Other period expressions with an interval are automatically expanded - to cover a whole number of that interval. (This is done to improve + to cover a whole number of that interval. (This is done to improve reports, but it also affects periodic transactions. Yes, it's a bit - inconsistent with the above.) Eg: ~ every 10th day of month from - 2020/01, which is equivalent to ~ every 10th day of month from + inconsistent with the above.) Eg: ~ every 10th day of month from + 2020/01, which is equivalent to ~ every 10th day of month from 2020/01/01, will be adjusted to start on 2019/12/10. Periodic transaction rules also have a second meaning: they are used to @@ -6207,14 +6205,14 @@ JOURNAL FORMAT expenses:rent $2000 assets:bank:checking - There is an additional constraint on the period expression: the start - date must fall on a natural boundary of the interval. Eg monthly from + There is an additional constraint on the period expression: the start + date must fall on a natural boundary of the interval. Eg monthly from 2018/1/1 is valid, but monthly from 2018/1/15 is not. Periodic rules and relative dates - Partial or relative dates (like 12/31, 25, tomorrow, last week, next - quarter) are usually not recommended in periodic rules, since the - results will change as time passes. If used, they will be interpreted + Partial or relative dates (like 12/31, 25, tomorrow, last week, next + quarter) are usually not recommended in periodic rules, since the + results will change as time passes. If used, they will be interpreted relative to, in order of preference: 1. the first day of the default year specified by a recent Y directive @@ -6223,11 +6221,11 @@ JOURNAL FORMAT 3. or the date on which you are running the report. - They will not be affected at all by report period or forecast period + They will not be affected at all by report period or forecast period dates. Two spaces between period expression and description! - If the period expression is followed by a transaction description, + If the period expression is followed by a transaction description, these must be separated by two or more spaces. This helps hledger know where the period expression ends, so that descriptions can not acciden- tally alter their meaning, as in this example: @@ -6241,35 +6239,35 @@ JOURNAL FORMAT So, - o Do write two spaces between your period expression and your transac- + o Do write two spaces between your period expression and your transac- tion description, if any. - o Don't accidentally write two spaces in the middle of your period + o Don't accidentally write two spaces in the middle of your period expression. Forecasting with periodic transactions - The --forecast flag activates any periodic transaction rules in the - journal. These will generate temporary additional transactions, usu- - ally recurring and in the future, which will appear in all reports. + The --forecast flag activates any periodic transaction rules in the + journal. These will generate temporary additional transactions, usu- + ally recurring and in the future, which will appear in all reports. hledger print --forecast is a good way to see them. - This can be useful for estimating balances into the future, perhaps + This can be useful for estimating balances into the future, perhaps experimenting with different scenarios. - It could also be useful for scripted data entry: you could describe - recurring transactions, and every so often copy the output of print + It could also be useful for scripted data entry: you could describe + recurring transactions, and every so often copy the output of print --forecast into the journal. - The generated transactions will have an extra tag, like generated- - transaction:~ PERIODICEXPR, indicating which periodic rule generated - them. There is also a similar, hidden tag, named _generated-transac- + The generated transactions will have an extra tag, like generated- + transaction:~ PERIODICEXPR, indicating which periodic rule generated + them. There is also a similar, hidden tag, named _generated-transac- tion:, which you can use to reliably match transactions generated "just now" (rather than printed in the past). The forecast transactions are generated within a forecast period, which - is independent of the report period. (Forecast period sets the bounds - for generated transactions, report period controls which transactions - are reported.) The forecast period begins on: + is independent of the report period. (Forecast period sets the bounds + for generated transactions, report period controls which transactions + are reported.) The forecast period begins on: o the start date provided within --forecast's argument, if any @@ -6277,7 +6275,7 @@ JOURNAL FORMAT o the report start date, if specified (with -b/-p/date:) - o the day after the latest ordinary transaction in the journal, if + o the day after the latest ordinary transaction in the journal, if any o otherwise today. @@ -6290,17 +6288,17 @@ JOURNAL FORMAT o otherwise 180 days (6 months) from today. - Note, this means that ordinary transactions will suppress periodic - transactions, by default; the periodic transactions will not start + Note, this means that ordinary transactions will suppress periodic + transactions, by default; the periodic transactions will not start until after the last ordinary transaction. This is usually convenient, but you can get around it in two ways: - o If you need to record some transactions in the future, make them - periodic transactions (with a single occurrence, eg: ~ YYYY-MM-DD) - rather than ordinary transactions. That way they won't suppress + o If you need to record some transactions in the future, make them + periodic transactions (with a single occurrence, eg: ~ YYYY-MM-DD) + rather than ordinary transactions. That way they won't suppress other periodic transactions. - o Or give --forecast a period expression argument. A forecast period + o Or give --forecast a period expression argument. A forecast period specified this way can overlap ordinary transactions, and need not be in the future. Some things to note: @@ -6309,25 +6307,25 @@ JOURNAL FORMAT o The period expression can specify the forecast period's start date, end date, or both. See also Report start & end date. - o The period expression should not specify a report interval. (Each + o The period expression should not specify a report interval. (Each periodic transaction rule specifies its own interval.) - Some examples: --forecast=202001-202004, --forecast=jan-, --fore- + Some examples: --forecast=202001-202004, --forecast=jan-, --fore- cast=2021. Budgeting with periodic transactions - With the --budget flag, currently supported by the balance command, - each periodic transaction rule declares recurring budget goals for the - specified accounts. Eg the first example above declares a goal of - spending $2000 on rent (and also, a goal of depositing $2000 into - checking) every month. Goals and actual performance can then be com- + With the --budget flag, currently supported by the balance command, + each periodic transaction rule declares recurring budget goals for the + specified accounts. Eg the first example above declares a goal of + spending $2000 on rent (and also, a goal of depositing $2000 into + checking) every month. Goals and actual performance can then be com- pared in budget reports. See also: Budgeting and Forecasting. Auto postings - "Automated postings" or "auto postings" are extra postings which get + "Automated postings" or "auto postings" are extra postings which get added automatically to transactions which match certain queries, defined by "auto posting rules", when you use the --auto flag. @@ -6338,27 +6336,27 @@ JOURNAL FORMAT ... ACCOUNT [AMOUNT] - except the first line is an equals sign (mnemonic: = suggests match- - ing), followed by a query (which matches existing postings), and each - "posting" line describes a posting to be generated, and the posting + except the first line is an equals sign (mnemonic: = suggests match- + ing), followed by a query (which matches existing postings), and each + "posting" line describes a posting to be generated, and the posting amounts can be: - o a normal amount with a commodity symbol, eg $2. This will be used + o a normal amount with a commodity symbol, eg $2. This will be used as-is. o a number, eg 2. The commodity symbol (if any) from the matched post- ing will be added to this. - o a numeric multiplier, eg *2 (a star followed by a number N). The + o a numeric multiplier, eg *2 (a star followed by a number N). The matched posting's amount (and total price, if any) will be multiplied by N. - o a multiplier with a commodity symbol, eg *$2 (a star, number N, and + o a multiplier with a commodity symbol, eg *$2 (a star, number N, and symbol S). The matched posting's amount will be multiplied by N, and its commodity symbol will be replaced with S. - Any query term containing spaces must be enclosed in single or double - quotes, as on the command line. Eg, note the quotes around the second + Any query term containing spaces must be enclosed in single or double + quotes, as on the command line. Eg, note the quotes around the second query term below: = expenses:groceries 'expenses:dining out' @@ -6397,29 +6395,29 @@ JOURNAL FORMAT Auto postings and multiple files An auto posting rule can affect any transaction in the current file, or - in any parent file or child file. Note, currently it will not affect + in any parent file or child file. Note, currently it will not affect sibling files (when multiple -f/--file are used - see #1212). Auto postings and dates - A posting date (or secondary date) in the matched posting, or (taking - precedence) a posting date in the auto posting rule itself, will also + A posting date (or secondary date) in the matched posting, or (taking + precedence) a posting date in the auto posting rule itself, will also be used in the generated posting. Auto postings and transaction balancing / inferred amounts / balance asser- tions Currently, auto postings are added: - o after missing amounts are inferred, and transactions are checked for + o after missing amounts are inferred, and transactions are checked for balancedness, o but before balance assertions are checked. - Note this means that journal entries must be balanced both before and + Note this means that journal entries must be balanced both before and after auto postings are added. This changed in hledger 1.12+; see #893 for background. - This also means that you cannot have more than one auto-posting with a - missing amount applied to a given transaction, as it will be unable to + This also means that you cannot have more than one auto-posting with a + missing amount applied to a given transaction, as it will be unable to infer amounts. Auto posting tags @@ -6428,11 +6426,11 @@ JOURNAL FORMAT o generated-posting:= QUERY - shows this was generated by an auto post- ing rule, and the query - o _generated-posting:= QUERY - a hidden tag, which does not appear in + o _generated-posting:= QUERY - a hidden tag, which does not appear in hledger's output. This can be used to match postings generated "just now", rather than generated in the past and saved to the journal. - Also, any transaction that has been changed by auto posting rules will + Also, any transaction that has been changed by auto posting rules will have these tags added: o modified: - this transaction was modified @@ -6443,66 +6441,66 @@ JOURNAL FORMAT CSV FORMAT How hledger reads CSV data, and the CSV rules file format. - hledger can read CSV files (Character Separated Value - usually comma, - semicolon, or tab) containing dated records as if they were journal + hledger can read CSV files (Character Separated Value - usually comma, + semicolon, or tab) containing dated records as if they were journal files, automatically converting each CSV record into a transaction. (To learn about writing CSV, see CSV output.) We describe each CSV file's format with a corresponding rules file. By - default this is named like the CSV file with a .rules extension added. - Eg when reading FILE.csv, hledger also looks for FILE.csv.rules in the - same directory as FILE.csv. You can specify a different rules file - with the --rules-file option. If a rules file is not found, hledger + default this is named like the CSV file with a .rules extension added. + Eg when reading FILE.csv, hledger also looks for FILE.csv.rules in the + same directory as FILE.csv. You can specify a different rules file + with the --rules-file option. If a rules file is not found, hledger will create a sample rules file, which you'll need to adjust. - This file contains rules describing the CSV data (header line, fields + This file contains rules describing the CSV data (header line, fields layout, date format etc.), and how to construct hledger journal entries (transactions) from it. Often there will also be a list of conditional rules for categorising transactions based on their descriptions. - Here's an overview of the CSV rules; these are described more fully + Here's an overview of the CSV rules; these are described more fully below, after the examples: skip skip one or more header lines or matched CSV records - fields list name CSV fields, assign them to hledger + fields list name CSV fields, assign them to hledger fields - field assignment assign a value to one hledger field, with + field assignment assign a value to one hledger field, with interpolation Field names hledger field names, used in the fields list and field assignments separator a custom field separator - if block apply some rules to CSV records matched by + if block apply some rules to CSV records matched by patterns - if table apply some rules to CSV records matched by + if table apply some rules to CSV records matched by patterns, alternate syntax end skip the remaining CSV records date-format how to parse dates in CSV records - decimal-mark the decimal mark used in CSV amounts, if + decimal-mark the decimal mark used in CSV amounts, if ambiguous - newest-first improve txn order when there are multiple - records, newest first, all with the same + newest-first improve txn order when there are multiple + records, newest first, all with the same date - intra-day-reversed improve txn order when each day's txns are + intra-day-reversed improve txn order when each day's txns are reverse of the overall date order include inline another CSV rules file - balance-type choose which type of balance assignments to + balance-type choose which type of balance assignments to use - Note, for best error messages when reading CSV files, use a .csv, .tsv + Note, for best error messages when reading CSV files, use a .csv, .tsv or .ssv file extension or file prefix - see File Extension below. There's an introductory Importing CSV data tutorial on hledger.org. Examples - Here are some sample hledger CSV rules files. See also the full col- + Here are some sample hledger CSV rules files. See also the full col- lection at: https://github.com/simonmichael/hledger/tree/master/examples/csv Basic - At minimum, the rules file must identify the date and amount fields, - and often it also specifies the date format and how many header lines + At minimum, the rules file must identify the date and amount fields, + and often it also specifies the date format and how many header lines there are. Here's a simple CSV file and a rules file for it: Date, Description, Id, Amount @@ -6521,8 +6519,8 @@ CSV FORMAT Default account names are chosen, since we didn't set them. Bank of Ireland - Here's a CSV with two amount fields (Debit and Credit), and a balance - field, which we can use to add balance assertions, which is not neces- + Here's a CSV with two amount fields (Debit and Credit), and a balance + field, which we can use to add balance assertions, which is not neces- sary but provides extra error checking: Date,Details,Debit,Credit,Balance @@ -6564,13 +6562,13 @@ CSV FORMAT assets:bank:boi:checking EUR-5.0 = EUR126.0 expenses:unknown EUR5.0 - The balance assertions don't raise an error above, because we're read- - ing directly from CSV, but they will be checked if these entries are + The balance assertions don't raise an error above, because we're read- + ing directly from CSV, but they will be checked if these entries are imported into a journal file. Amazon Here we convert amazon.com order history, and use an if block to gener- - ate a third posting if there's a fee. (In practice you'd probably get + ate a third posting if there's a fee. (In practice you'd probably get this data from your bank instead, but it's an example.) "Date","Type","To/From","Name","Status","Amount","Fees","Transaction ID" @@ -6622,7 +6620,7 @@ CSV FORMAT expenses:fees $1.00 Paypal - Here's a real-world rules file for (customised) Paypal CSV, with some + Here's a real-world rules file for (customised) Paypal CSV, with some Paypal-specific rules, and a second rules file included: "Date","Time","TimeZone","Name","Type","Status","Currency","Gross","Fee","Net","From Email Address","To Email Address","Transaction ID","Item Title","Item ID","Reference Txn ID","Receipt ID","Balance","Note" @@ -6777,9 +6775,9 @@ CSV FORMAT skip skip N - The word "skip" followed by a number (or no number, meaning 1) tells - hledger to ignore this many non-empty lines preceding the CSV data. - (Empty/blank lines are skipped automatically.) You'll need this when- + The word "skip" followed by a number (or no number, meaning 1) tells + hledger to ignore this many non-empty lines preceding the CSV data. + (Empty/blank lines are skipped automatically.) You'll need this when- ever your CSV data contains header lines. It also has a second purpose: it can be used inside if blocks to ignore @@ -6788,19 +6786,19 @@ CSV FORMAT fields list fields FIELDNAME1, FIELDNAME2, ... - A fields list (the word "fields" followed by comma-separated field - names) is the quick way to assign CSV field values to hledger fields. - (The other way is field assignments, see below.) A fields list does + A fields list (the word "fields" followed by comma-separated field + names) is the quick way to assign CSV field values to hledger fields. + (The other way is field assignments, see below.) A fields list does does two things: - 1. It names the CSV fields. This is optional, but can be convenient + 1. It names the CSV fields. This is optional, but can be convenient later for interpolating them. - 2. Whenever you use a standard hledger field name (defined below), the + 2. Whenever you use a standard hledger field name (defined below), the CSV value is assigned to that part of the hledger transaction. - Here's an example that says "use the 1st, 2nd and 4th fields as the - transaction's date, description and amount; name the last two fields + Here's an example that says "use the 1st, 2nd and 4th fields as the + transaction's date, description and amount; name the last two fields for later reference; and ignore the others": fields date, description, , amount, , , somefield, anotherfield @@ -6810,20 +6808,20 @@ CSV FORMAT o The fields list always use commas, even if your CSV data uses another separator character. - o Currently there must be least two items in the list (at least one + o Currently there must be least two items in the list (at least one comma). - o Field names may not contain spaces. Spaces before/after field names + o Field names may not contain spaces. Spaces before/after field names are optional. o Field names may contain _ (underscore) or - (hyphen). - o If the CSV contains column headings, it's a good idea to use these, + o If the CSV contains column headings, it's a good idea to use these, suitably modified, as the basis for your field names (eg lower-cased, with underscores instead of spaces). - o If some heading names match standard hledger fields, but you don't - want to set the hledger fields directly, alter those names, eg by + o If some heading names match standard hledger fields, but you don't + want to set the hledger fields directly, alter those names, eg by appending an underscore. o Fields you don't care about can be given a dummy name (eg: _ ), or no @@ -6832,15 +6830,15 @@ CSV FORMAT field assignment HLEDGERFIELDNAME FIELDVALUE - Field assignments are the more flexible way to assign CSV values to + Field assignments are the more flexible way to assign CSV values to hledger fields. They can be used instead of or in addition to a fields list (see above). - To assign a value to a hledger field, write the field name (any of the - standard hledger field/pseudo-field names, defined below), a space, - followed by a text value on the same line. This text value may inter- - polate CSV fields, referenced by their 1-based position in the CSV - record (%N), or by the name they were given in the fields list (%CSV- + To assign a value to a hledger field, write the field name (any of the + standard hledger field/pseudo-field names, defined below), a space, + followed by a text value on the same line. This text value may inter- + polate CSV fields, referenced by their 1-based position in the CSV + record (%N), or by the name they were given in the fields list (%CSV- FIELDNAME). Some examples: @@ -6853,15 +6851,15 @@ CSV FORMAT Tips: - o Interpolation strips outer whitespace (so a CSV value like " 1 " + o Interpolation strips outer whitespace (so a CSV value like " 1 " becomes 1 when interpolated) (#1051). - o Interpolations always refer to a CSV field - you can't interpolate a + o Interpolations always refer to a CSV field - you can't interpolate a hledger field. (See Referencing other fields below). Field names Here are the standard hledger field (and pseudo-field) names, which you - can use in a fields list and in field assignments. For more about the + can use in a fields list and in field assignments. For more about the transaction parts they refer to, see Transactions. date field @@ -6895,63 +6893,63 @@ CSV FORMAT Assigning to accountN, where N is 1 to 99, sets the account name of the Nth posting, and causes that posting to be generated. - Most often there are two postings, so you'll want to set account1 and - account2. Typically account1 is associated with the CSV file, and is - set once with a top-level assignment, while account2 is set based on + Most often there are two postings, so you'll want to set account1 and + account2. Typically account1 is associated with the CSV file, and is + set once with a top-level assignment, while account2 is set based on each transaction's description, and in conditional blocks. - If a posting's account name is left unset but its amount is set (see - below), a default account name will be chosen (like "expenses:unknown" + If a posting's account name is left unset but its amount is set (see + below), a default account name will be chosen (like "expenses:unknown" or "income:unknown"). amount field - amountN sets the amount of the Nth posting, and causes that posting to - be generated. By assigning to amount1, amount2, ... etc. you can + amountN sets the amount of the Nth posting, and causes that posting to + be generated. By assigning to amount1, amount2, ... etc. you can generate up to 99 postings. - amountN-in and amountN-out can be used instead, if the CSV uses sepa- - rate fields for debits and credits (inflows and outflows). hledger - assumes both of these CSV fields are unsigned, and will automatically - negate the "-out" value. If they are signed, see "Setting amounts" + amountN-in and amountN-out can be used instead, if the CSV uses sepa- + rate fields for debits and credits (inflows and outflows). hledger + assumes both of these CSV fields are unsigned, and will automatically + negate the "-out" value. If they are signed, see "Setting amounts" below. - amount, or amount-in and amount-out are a legacy mode, to keep pre- - hledger-1.17 CSV rules files working (and for occasional convenience). - They are suitable only for two-posting transactions; they set both - posting 1's and posting 2's amount. Posting 2's amount will be + amount, or amount-in and amount-out are a legacy mode, to keep pre- + hledger-1.17 CSV rules files working (and for occasional convenience). + They are suitable only for two-posting transactions; they set both + posting 1's and posting 2's amount. Posting 2's amount will be negated, and also converted to cost if there's a transaction price. If you have an existing rules file using the unnumbered form, you might - want to use the numbered form in certain conditional blocks, without - having to update and retest all the old rules. To facilitate this, - posting 1 ignores amount/amount-in/amount-out if any of + want to use the numbered form in certain conditional blocks, without + having to update and retest all the old rules. To facilitate this, + posting 1 ignores amount/amount-in/amount-out if any of amount1/amount1-in/amount1-out are assigned, and posting 2 ignores them - if any of amount2/amount2-in/amount2-out are assigned, avoiding con- + if any of amount2/amount2-in/amount2-out are assigned, avoiding con- flicts. currency field - currency sets a currency symbol, to be prepended to all postings' - amounts. You can use this if the CSV amounts do not have a currency + currency sets a currency symbol, to be prepended to all postings' + amounts. You can use this if the CSV amounts do not have a currency symbol, eg if it is in a separate column. - currencyN prepends a currency symbol to just the Nth posting's amount. + currencyN prepends a currency symbol to just the Nth posting's amount. balance field - balanceN sets a balance assertion amount (or if the posting amount is + balanceN sets a balance assertion amount (or if the posting amount is left empty, a balance assignment) on posting N. balance is a compatibility spelling for hledger <1.17; it is equivalent to balance1. - You can adjust the type of assertion/assignment with the balance-type + You can adjust the type of assertion/assignment with the balance-type rule (see below). See Tips below for more about setting amounts and currency. separator - You can use the separator rule to read other kinds of character-sepa- - rated data. The argument is any single separator character, or the - words tab or space (case insensitive). Eg, for comma-separated values + You can use the separator rule to read other kinds of character-sepa- + rated data. The argument is any single separator character, or the + words tab or space (case insensitive). Eg, for comma-separated values (CSV): separator , @@ -6964,7 +6962,7 @@ CSV FORMAT separator TAB - If the input file has a .csv, .ssv or .tsv file extension (or a csv:, + If the input file has a .csv, .ssv or .tsv file extension (or a csv:, ssv:, tsv: prefix), the appropriate separator will be inferred automat- ically, and you won't need this rule. @@ -6979,8 +6977,8 @@ CSV FORMAT RULE RULE - Conditional blocks ("if blocks") are a block of rules that are applied - only to CSV records which match certain patterns. They are often used + Conditional blocks ("if blocks") are a block of rules that are applied + only to CSV records which match certain patterns. They are often used for customising account names based on transaction descriptions. Matching the whole record @@ -6989,16 +6987,16 @@ CSV FORMAT REGEX REGEX is a case-insensitive regular expression that tries to match any- - where within the CSV record. It is a POSIX ERE (extended regular - expression) that also supports GNU word boundaries (\b, \B, \<, \>), - and nothing else. If you have trouble, be sure to check our doc: + where within the CSV record. It is a POSIX ERE (extended regular + expression) that also supports GNU word boundaries (\b, \B, \<, \>), + and nothing else. If you have trouble, be sure to check our doc: https://hledger.org/hledger.html#regular-expressions - Important note: the record that is matched is not the original record, - but a synthetic one, with any enclosing double quotes (but not enclos- + Important note: the record that is matched is not the original record, + but a synthetic one, with any enclosing double quotes (but not enclos- ing whitespace) removed, and always comma-separated (which means that a - field containing a comma will appear like two fields). Eg, if the - original record is 2020-01-01; "Acme, Inc."; 1,000, the REGEX will + field containing a comma will appear like two fields). Eg, if the + original record is 2020-01-01; "Acme, Inc."; 1,000, the REGEX will actually see 2020-01-01,Acme, Inc., 1,000). Matching individual fields @@ -7006,14 +7004,14 @@ CSV FORMAT %CSVFIELD REGEX - which matches just the content of a particular CSV field. CSVFIELD is - a percent sign followed by the field's name or column number, like + which matches just the content of a particular CSV field. CSVFIELD is + a percent sign followed by the field's name or column number, like %date or %1. Combining matchers A single matcher can be written on the same line as the "if"; or multi- ple matchers can be written on the following lines, non-indented. Mul- - tiple matchers are OR'd (any one of them can match), unless one begins + tiple matchers are OR'd (any one of them can match), unless one begins with an & symbol, in which case it is AND'ed with the previous matcher. if @@ -7022,8 +7020,8 @@ CSV FORMAT RULE Rules applied on successful match - After the patterns there should be one or more rules to apply, all - indented by at least one space. Three kinds of rule are allowed in + After the patterns there should be one or more rules to apply, all + indented by at least one space. Three kinds of rule are allowed in conditional blocks: o field assignments (to set a hledger field) @@ -7053,11 +7051,11 @@ CSV FORMAT MATCHER3,VALUE31,VALUE32,...,VALUE3n - Conditional tables ("if tables") are a different syntax to specify - field assignments that will be applied only to CSV records which match + Conditional tables ("if tables") are a different syntax to specify + field assignments that will be applied only to CSV records which match certain patterns. - MATCHER could be either field or record matcher, as described above. + MATCHER could be either field or record matcher, as described above. When MATCHER matches, values from that row would be assigned to the CSV fields named on the if line, in the same order. @@ -7081,17 +7079,17 @@ CSV FORMAT ... CSVFIELDNAMEn VALUE3n - Each line starting with MATCHER should contain enough (possibly empty) + Each line starting with MATCHER should contain enough (possibly empty) values for all the listed fields. - Rules would be checked and applied in the order they are listed in the + Rules would be checked and applied in the order they are listed in the table and, like with if blocks, later rules (in the same or another ta- ble) or if blocks could override the effect of any rule. - Instead of ',' you can use a variety of other non-alphanumeric charac- + Instead of ',' you can use a variety of other non-alphanumeric charac- ters as a separator. First character after if is taken to be the sepa- - rator for the rest of the table. It is the responsibility of the user - to ensure that separator does not occur inside MATCHERs and values - + rator for the rest of the table. It is the responsibility of the user + to ensure that separator does not occur inside MATCHERs and values - there is no way to escape separator. Example: @@ -7102,7 +7100,7 @@ CSV FORMAT 2020/01/12.*Plumbing LLC,expenses:house:upkeep,emergency plumbing call-out end - This rule can be used inside if blocks (only), to make hledger stop + This rule can be used inside if blocks (only), to make hledger stop reading this CSV file and move on to the next input file, or to command execution. Eg: @@ -7113,11 +7111,11 @@ CSV FORMAT date-format date-format DATEFMT - This is a helper for the date (and date2) fields. If your CSV dates - are not formatted like YYYY-MM-DD, YYYY/MM/DD or YYYY.MM.DD, you'll - need to add a date-format rule describing them with a strptime-style - date parsing pattern - see https://hackage.haskell.org/pack- - age/time/docs/Data-Time-Format.html#v:formatTime. The pattern must + This is a helper for the date (and date2) fields. If your CSV dates + are not formatted like YYYY-MM-DD, YYYY/MM/DD or YYYY.MM.DD, you'll + need to add a date-format rule describing them with a strptime-style + date parsing pattern - see https://hackage.haskell.org/pack- + age/time/docs/Data-Time-Format.html#v:formatTime. The pattern must parse the CSV date value completely. Some examples: # MM/DD/YY @@ -7137,25 +7135,25 @@ CSV FORMAT timezone timezone TIMEZONE - When CSV contains date-times that are implicitly in some time zone + When CSV contains date-times that are implicitly in some time zone other than yours, but containing no explicit time zone information, you - can use this rule to declare the CSV's native time zone, which helps + can use this rule to declare the CSV's native time zone, which helps prevent off-by-one dates. - When the CSV date-times do contain time zone information, you don't - need this rule; instead, use %Z in date-format (or %z, %EZ, %Ez; see + When the CSV date-times do contain time zone information, you don't + need this rule; instead, use %Z in date-format (or %z, %EZ, %Ez; see the formatTime link above). In either of these cases, hledger will do a time-zone-aware conversion, localising the CSV date-times to your current system time zone. If you prefer to localise to some other time zone, eg for reproducibility, you - can (on unix at least) set the output timezone with the TZ environment + can (on unix at least) set the output timezone with the TZ environment variable, eg: $ TZ=-1000 hledger print -f foo.csv # or TZ=-1000 hledger import foo.csv - timezone currently does not understand timezone names, except "UTC", - "GMT", "EST", "EDT", "CST", "CDT", "MST", "MDT", "PST", or "PDT". For + timezone currently does not understand timezone names, except "UTC", + "GMT", "EST", "EDT", "CST", "CDT", "MST", "MDT", "PST", or "PDT". For others, use numeric format: +HHMM or -HHMM. decimal-mark @@ -7165,18 +7163,18 @@ CSV FORMAT decimal-mark , - hledger automatically accepts either period or comma as a decimal mark - when parsing numbers (cf Amounts). However if any numbers in the CSV - contain digit group marks, such as thousand-separating commas, you - should declare the decimal mark explicitly with this rule, to avoid + hledger automatically accepts either period or comma as a decimal mark + when parsing numbers (cf Amounts). However if any numbers in the CSV + contain digit group marks, such as thousand-separating commas, you + should declare the decimal mark explicitly with this rule, to avoid misparsed numbers. newest-first hledger tries to ensure that the generated transactions will be ordered - chronologically, including intra-day transactions. Usually it can - auto-detect how the CSV records are ordered. But if it encounters CSV + chronologically, including intra-day transactions. Usually it can + auto-detect how the CSV records are ordered. But if it encounters CSV where all records are on the same date, it assumes that the records are - oldest first. If in fact the CSV's records are normally newest first, + oldest first. If in fact the CSV's records are normally newest first, like: 2022-10-01, txn 3... @@ -7190,8 +7188,8 @@ CSV FORMAT newest-first intra-day-reversed - CSV records for each day are sometimes ordered in reverse compared to - the overall date order. Eg, here dates are newest first, but the + CSV records for each day are sometimes ordered in reverse compared to + the overall date order. Eg, here dates are newest first, but the transactions on each date are oldest first: 2022-10-02, txn 3... @@ -7199,7 +7197,7 @@ CSV FORMAT 2022-10-01, txn 1... 2022-10-01, txn 2... - In this situation, add the intra-day-reversed rule, and hledger will + In this situation, add the intra-day-reversed rule, and hledger will compensate, improving the order of transactions. # transactions within each day are reversed with respect to the overall date order @@ -7208,9 +7206,9 @@ CSV FORMAT include include RULESFILE - This includes the contents of another CSV rules file at this point. - RULESFILE is an absolute file path or a path relative to the current - file's directory. This can be useful for sharing common rules between + This includes the contents of another CSV rules file at this point. + RULESFILE is an absolute file path or a path relative to the current + file's directory. This can be useful for sharing common rules between several rules files, eg: # someaccount.csv.rules @@ -7225,10 +7223,10 @@ CSV FORMAT balance-type Balance assertions generated by assigning to balanceN are of the simple - = type by default, which is a single-commodity, subaccount-excluding + = type by default, which is a single-commodity, subaccount-excluding assertion. You may find the subaccount-including variants more useful, - eg if you have created some virtual subaccounts of checking to help - with budgeting. You can select a different type of assertion with the + eg if you have created some virtual subaccounts of checking to help + with budgeting. You can select a different type of assertion with the balance-type rule: # balance assertions will consider all commodities and all subaccounts @@ -7243,18 +7241,18 @@ CSV FORMAT Tips Rapid feedback - It's a good idea to get rapid feedback while creating/troubleshooting + It's a good idea to get rapid feedback while creating/troubleshooting CSV rules. Here's a good way, using entr from eradman.com/entrproject: $ ls foo.csv* | entr bash -c 'echo ----; hledger -f foo.csv print desc:SOMEDESC' - A desc: query (eg) is used to select just one, or a few, transactions - of interest. "bash -c" is used to run multiple commands, so we can - echo a separator each time the command re-runs, making it easier to + A desc: query (eg) is used to select just one, or a few, transactions + of interest. "bash -c" is used to run multiple commands, so we can + echo a separator each time the command re-runs, making it easier to read the output. Valid CSV - hledger accepts CSV conforming to RFC 4180. When CSV values are + hledger accepts CSV conforming to RFC 4180. When CSV values are enclosed in quotes, note: o they must be double quotes (not single quotes) @@ -7262,9 +7260,9 @@ CSV FORMAT o spaces outside the quotes are not allowed File Extension - To help hledger identify the format and show the right error messages, - CSV/SSV/TSV files should normally be named with a .csv, .ssv or .tsv - filename extension. Or, the file path should be prefixed with csv:, + To help hledger identify the format and show the right error messages, + CSV/SSV/TSV files should normally be named with a .csv, .ssv or .tsv + filename extension. Or, the file path should be prefixed with csv:, ssv: or tsv:. Eg: $ hledger -f foo.ssv print @@ -7273,48 +7271,48 @@ CSV FORMAT $ cat foo | hledger -f ssv:- foo - You can override the file extension with a separator rule if needed. + You can override the file extension with a separator rule if needed. See also: Input files in the hledger manual. Reading multiple CSV files - If you use multiple -f options to read multiple CSV files at once, - hledger will look for a correspondingly-named rules file for each CSV - file. But if you use the --rules-file option, that rules file will be + If you use multiple -f options to read multiple CSV files at once, + hledger will look for a correspondingly-named rules file for each CSV + file. But if you use the --rules-file option, that rules file will be used for all the CSV files. Valid transactions After reading a CSV file, hledger post-processes and validates the gen- erated journal entries as it would for a journal file - balancing them, - applying balance assignments, and canonicalising amount styles. Any - errors at this stage will be reported in the usual way, displaying the + applying balance assignments, and canonicalising amount styles. Any + errors at this stage will be reported in the usual way, displaying the problem entry. There is one exception: balance assertions, if you have generated them, - will not be checked, since normally these will work only when the CSV - data is part of the main journal. If you do need to check balance + will not be checked, since normally these will work only when the CSV + data is part of the main journal. If you do need to check balance assertions generated from CSV right away, pipe into another hledger: $ hledger -f file.csv print | hledger -f- print Deduplicating, importing - When you download a CSV file periodically, eg to get your latest bank - transactions, the new file may overlap with the old one, containing + When you download a CSV file periodically, eg to get your latest bank + transactions, the new file may overlap with the old one, containing some of the same records. The import command will (a) detect the new transactions, and (b) append just those transactions to your main journal. It is idempotent, so you - don't have to remember how many times you ran it or with which version - of the CSV. (It keeps state in a hidden .latest.FILE.csv file.) This + don't have to remember how many times you ran it or with which version + of the CSV. (It keeps state in a hidden .latest.FILE.csv file.) This is the easiest way to import CSV data. Eg: # download the latest CSV files, then run this command. # Note, no -f flags needed here. $ hledger import *.csv [--dry] - This method works for most CSV files. (Where records have a stable + This method works for most CSV files. (Where records have a stable chronological order, and new records appear only at the new end.) - A number of other tools and workflows, hledger-specific and otherwise, + A number of other tools and workflows, hledger-specific and otherwise, exist for converting, deduplicating, classifying and managing CSV data. See: @@ -7335,13 +7333,13 @@ CSV FORMAT a. If both fields are unsigned: Assign to amountN-in and amountN-out. This sets posting N's amount - to whichever of these has a non-zero value, and negates the "-out" + to whichever of these has a non-zero value, and negates the "-out" value. b. If either field is signed (can contain a minus sign): - Use a conditional rule to flip the sign (of non-empty values). - Since hledger always negates amountN-out, if it was already nega- - tive, we must undo that by negating once more (but only if the + Use a conditional rule to flip the sign (of non-empty values). + Since hledger always negates amountN-out, if it was already nega- + tive, we must undo that by negating once more (but only if the field is non-empty): fields date, description, amount1-in, amount1-out @@ -7349,8 +7347,8 @@ CSV FORMAT amount1-out -%amount1-out c. If both fields, or neither field, can contain a non-zero value: - hledger normally expects exactly one of the fields to have a non- - zero value. Eg, the amountN-in/amountN-out rules would reject + hledger normally expects exactly one of the fields to have a non- + zero value. Eg, the amountN-in/amountN-out rules would reject value pairs like these: "", "" @@ -7358,7 +7356,7 @@ CSV FORMAT "1", "none" So, use smarter conditional rules to set the amount from the appro- - priate field. Eg, these rules would make it use only the value + priate field. Eg, these rules would make it use only the value containing non-zero digits, handling the above: fields date, description, in, out @@ -7369,7 +7367,7 @@ CSV FORMAT 3. If you want posting 2's amount converted to cost: Assign to amount (or to amount-in and amount-out). (This is the legacy - numberless syntax, which sets amount1 and amount2 and converts amount2 + numberless syntax, which sets amount1 and amount2 and converts amount2 to cost.) 4. If the CSV has the balance instead of the transaction amount: @@ -7377,15 +7375,15 @@ CSV FORMAT ance assignment. (Old syntax: balance, equivalent to balance1.) o If hledger guesses the wrong default account name: - When setting the amount via balance assertion, hledger may guess - the wrong default account name. So, set the account name explic- + When setting the amount via balance assertion, hledger may guess + the wrong default account name. So, set the account name explic- itly, eg: fields date, description, balance1 account1 assets:checking Amount signs - There is some special handling for amount signs, to simplify parsing + There is some special handling for amount signs, to simplify parsing and sign-flipping: o If an amount value begins with a plus sign: @@ -7394,17 +7392,17 @@ CSV FORMAT o If an amount value is parenthesised: it will be de-parenthesised and sign-flipped: (AMT) becomes -AMT - o If an amount value has two minus signs (or two sets of parentheses, + o If an amount value has two minus signs (or two sets of parentheses, or a minus sign and parentheses): they cancel out and will be removed: --AMT or -(AMT) becomes AMT - o If an amount value contains just a sign (or just a set of parenthe- + o If an amount value contains just a sign (or just a set of parenthe- ses): - that is removed, making it an empty value. "+" or "-" or "()" becomes + that is removed, making it an empty value. "+" or "-" or "()" becomes "". Setting currency/commodity - If the currency/commodity symbol is included in the CSV's amount + If the currency/commodity symbol is included in the CSV's amount field(s): 2020-01-01,foo,$123.00 @@ -7423,7 +7421,7 @@ CSV FORMAT 2020-01-01,foo,USD,123.00 You can assign that to the currency pseudo-field, which has the special - effect of prepending itself to every amount in the transaction (on the + effect of prepending itself to every amount in the transaction (on the left, with no separating space): fields date,description,currency,amount @@ -7432,7 +7430,7 @@ CSV FORMAT expenses:unknown USD123.00 income:unknown USD-123.00 - Or, you can use a field assignment to construct the amount yourself, + Or, you can use a field assignment to construct the amount yourself, with more control. Eg to put the symbol on the right, and separated by a space: @@ -7443,7 +7441,7 @@ CSV FORMAT expenses:unknown 123.00 USD income:unknown -123.00 USD - Note we used a temporary field name (cur) that is not currency - that + Note we used a temporary field name (cur) that is not currency - that would trigger the prepending effect, which we don't want here. Amount decimal places @@ -7451,13 +7449,13 @@ CSV FORMAT amount1 influence commodity display styles, such as the number of deci- mal places displayed in reports. - The original amounts as written in the CSV file do not affect display + The original amounts as written in the CSV file do not affect display style (because we don't yet reliably know their commodity). Referencing other fields - In field assignments, you can interpolate only CSV fields, not hledger - fields. In the example below, there's both a CSV field and a hledger - field named amount1, but %amount1 always means the CSV field, not the + In field assignments, you can interpolate only CSV fields, not hledger + fields. In the example below, there's both a CSV field and a hledger + field named amount1, but %amount1 always means the CSV field, not the hledger field: # Name the third CSV field "amount1" @@ -7469,7 +7467,7 @@ CSV FORMAT # Set comment to the CSV amount1 (not the amount1 assigned above) comment %amount1 - Here, since there's no CSV amount1 field, %amount1 will produce a lit- + Here, since there's no CSV amount1 field, %amount1 will produce a lit- eral "amount1": fields date,description,csvamount @@ -7477,7 +7475,7 @@ CSV FORMAT # Can't interpolate amount1 here comment %amount1 - When there are multiple field assignments to the same hledger field, + When there are multiple field assignments to the same hledger field, only the last one takes effect. Here, comment's value will be be B, or C if "something" is matched, but never A: @@ -7487,14 +7485,14 @@ CSV FORMAT comment C How CSV rules are evaluated - Here's how to think of CSV rules being evaluated (if you really need + Here's how to think of CSV rules being evaluated (if you really need to). First, - o include - all includes are inlined, from top to bottom, depth first. - (At each include point the file is inlined and scanned for further + o include - all includes are inlined, from top to bottom, depth first. + (At each include point the file is inlined and scanned for further includes, recursively, before proceeding.) - Then "global" rules are evaluated, top to bottom. If a rule is + Then "global" rules are evaluated, top to bottom. If a rule is repeated, the last one wins: o skip (at top level) @@ -7508,33 +7506,33 @@ CSV FORMAT Then for each CSV record in turn: - o test all if blocks. If any of them contain a end rule, skip all + o test all if blocks. If any of them contain a end rule, skip all remaining CSV records. Otherwise if any of them contain a skip rule, - skip that many CSV records. If there are multiple matched skip + skip that many CSV records. If there are multiple matched skip rules, the first one wins. - o collect all field assignments at top level and in matched if blocks. - When there are multiple assignments for a field, keep only the last + o collect all field assignments at top level and in matched if blocks. + When there are multiple assignments for a field, keep only the last one. - o compute a value for each hledger field - either the one that was - assigned to it (and interpolate the %CSVFIELDNAME references), or a + o compute a value for each hledger field - either the one that was + assigned to it (and interpolate the %CSVFIELDNAME references), or a default o generate a synthetic hledger transaction from these values. - This is all part of the CSV reader, one of several readers hledger can - use to parse input files. When all files have been read successfully, - the transactions are passed as input to whichever hledger command the + This is all part of the CSV reader, one of several readers hledger can + use to parse input files. When all files have been read successfully, + the transactions are passed as input to whichever hledger command the user specified. TIMECLOCK FORMAT The time logging format of timeclock.el, as read by hledger. - hledger can read time logs in timeclock format. As with Ledger, these + hledger can read time logs in timeclock format. As with Ledger, these are (a subset of) timeclock.el's format, containing clock-in and clock- - out entries as in the example below. The date is a simple date. The - time format is HH:MM[:SS][+-ZZZZ]. Seconds and timezone are optional. + out entries as in the example below. The date is a simple date. The + time format is HH:MM[:SS][+-ZZZZ]. Seconds and timezone are optional. The timezone, if present, must be four digits and is ignored (currently the time is always interpreted as a local time). @@ -7543,9 +7541,9 @@ TIMECLOCK FORMAT i 2015/03/31 22:21:45 another account o 2015/04/01 02:00:34 - hledger treats each clock-in/clock-out pair as a transaction posting - some number of hours to an account. Or if the session spans more than - one day, it is split into several transactions, one for each day. For + hledger treats each clock-in/clock-out pair as a transaction posting + some number of hours to an account. Or if the session spans more than + one day, it is split into several transactions, one for each day. For the above time log, hledger print generates these journal entries: $ hledger -f t.timeclock print @@ -7566,26 +7564,26 @@ TIMECLOCK FORMAT To generate time logs, ie to clock in and clock out, you could: - o use emacs and the built-in timeclock.el, or the extended timeclock- + o use emacs and the built-in timeclock.el, or the extended timeclock- x.el and perhaps the extras in ledgerutils.el o at the command line, use these bash aliases: shell alias ti="echo - i `date '+%Y-%m-%d %H:%M:%S'` \$* >>$TIMELOG" alias to="echo o + i `date '+%Y-%m-%d %H:%M:%S'` \$* >>$TIMELOG" alias to="echo o `date '+%Y-%m-%d %H:%M:%S'` >>$TIMELOG" o or use the old ti and to scripts in the ledger 2.x repository. These - rely on a "timeclock" executable which I think is just the ledger 2 + rely on a "timeclock" executable which I think is just the ledger 2 executable renamed. TIMEDOT FORMAT - timedot format is hledger's human-friendly time logging format. Com- + timedot format is hledger's human-friendly time logging format. Com- pared to timeclock format, it is o convenient for quick, approximate, and retroactive time logging o readable: you can see at a glance where time was spent. - A timedot file contains a series of day entries, which might look like + A timedot file contains a series of day entries, which might look like this: 2021-08-04 @@ -7593,7 +7591,7 @@ TIMEDOT FORMAT fos:hledger:timedot .. ; docs per:admin:finance - hledger reads this as three time transactions on this day, with each + hledger reads this as three time transactions on this day, with each dot representing a quarter-hour spent: $ hledger -f a.timedot print # .timedot file extension activates the timedot reader @@ -7616,45 +7614,45 @@ TIMEDOT FORMAT o a common transaction comment for this day, after a semicolon (;). - After the date line are zero or more optionally-indented time transac- + After the date line are zero or more optionally-indented time transac- tion lines, consisting of: o an account name - any word or phrase, usually a hledger-style account name. - o two or more spaces - a field separator, required if there is an + o two or more spaces - a field separator, required if there is an amount (as in journal format). - o a timedot amount - dots representing quarter hours, or a number rep- + o a timedot amount - dots representing quarter hours, or a number rep- resenting hours. o an optional comment beginning with semicolon. This is ignored. In more detail, timedot amounts can be: - o dots: zero or more period characters, each representing one quarter- - hour. Spaces are ignored and can be used for grouping. Eg: .... .. + o dots: zero or more period characters, each representing one quarter- + hour. Spaces are ignored and can be used for grouping. Eg: .... .. o a number, representing hours. Eg: 1.5 - o a number immediately followed by a unit symbol s, m, h, d, w, mo, or + o a number immediately followed by a unit symbol s, m, h, d, w, mo, or y, representing seconds, minutes, hours, days weeks, months or years. Eg 1.5h or 90m. The following equivalencies are assumed: - 60s = 1m, 60m = 1h, 24h = 1d, 7d = 1w, 30d = 1mo, 365d = 1y. (This - unit will not be visible in the generated transaction amount, which is + 60s = 1m, 60m = 1h, 24h = 1d, 7d = 1w, 30d = 1mo, 365d = 1y. (This + unit will not be visible in the generated transaction amount, which is always in hours.) - There is some added flexibility to help with keeping time log data in + There is some added flexibility to help with keeping time log data in the same file as your notes, todo lists, etc.: o Lines beginning with # or ;, and blank lines, are ignored. - o Lines not ending with a double-space and amount are parsed as trans- - actions with zero amount. (Most hledger reports hide these by + o Lines not ending with a double-space and amount are parsed as trans- + actions with zero amount. (Most hledger reports hide these by default; add -E to see them.) o One or more stars (*) followed by a space, at the start of a line, is - ignored. So date lines or time transaction lines can also be Org- + ignored. So date lines or time transaction lines can also be Org- mode headlines. o All Org-mode headlines before the first date line are ignored. @@ -7737,7 +7735,7 @@ TIMEDOT FORMAT A sample.timedot file. COMMON TASKS - Here are some quick examples of how to do some basic tasks with + Here are some quick examples of how to do some basic tasks with hledger. Getting help @@ -7747,38 +7745,38 @@ COMMON TASKS $ hledger --help # show common options $ hledger CMD --help # show common options and CMD's options and documentation - You can also view your hledger version's manual in several formats by + You can also view your hledger version's manual in several formats by using the help command. Eg: $ hledger help # show the hledger manual with info, man or $PAGER (best available) $ hledger help journal # show the journal topic in the hledger manual $ hledger help --help # show how the help command works - To view manuals and introductory docs on the web, visit - https://hledger.org. Chat and mail list support and discussion ar- + To view manuals and introductory docs on the web, visit + https://hledger.org. Chat and mail list support and discussion ar- chives can be found at https://hledger.org/support. Constructing command lines - hledger has an extensive and powerful command line interface. We + hledger has an extensive and powerful command line interface. We strive to keep it simple and ergonomic, but you may run into one of the confusing real world details described in OPTIONS, below. If that hap- pens, here are some tips that may help: - o command-specific options must go after the command (it's fine to put + o command-specific options must go after the command (it's fine to put all options there) (hledger CMD OPTS ARGS) - o running add-on executables directly simplifies command line parsing + o running add-on executables directly simplifies command line parsing (hledger-ui OPTS ARGS) o enclose "problematic" args in single quotes - o if needed, also add a backslash to hide regular expression metachar- + o if needed, also add a backslash to hide regular expression metachar- acters from the shell o to see how a misbehaving command is being parsed, add --debug=2. Starting a journal file - hledger looks for your accounting data in a journal file, + hledger looks for your accounting data in a journal file, $HOME/.hledger.journal by default: $ hledger stats @@ -7786,9 +7784,9 @@ COMMON TASKS Please create it first, eg with "hledger add" or a text editor. Or, specify an existing journal file with -f or LEDGER_FILE. - You can override this by setting the LEDGER_FILE environment variable. + You can override this by setting the LEDGER_FILE environment variable. It's a good practice to keep this important file under version control, - and to start a new file each year. So you could do something like + and to start a new file each year. So you could do something like this: $ mkdir ~/finance @@ -7812,20 +7810,20 @@ COMMON TASKS Market prices : 0 () Setting opening balances - Pick a starting date for which you can look up the balances of some - real-world assets (bank accounts, wallet..) and liabilities (credit + Pick a starting date for which you can look up the balances of some + real-world assets (bank accounts, wallet..) and liabilities (credit cards..). - To avoid a lot of data entry, you may want to start with just one or - two accounts, like your checking account or cash wallet; and pick a - recent starting date, like today or the start of the week. You can + To avoid a lot of data entry, you may want to start with just one or + two accounts, like your checking account or cash wallet; and pick a + recent starting date, like today or the start of the week. You can always come back later and add more accounts and older transactions, eg going back to january 1st. - Add an opening balances transaction to the journal, declaring the bal- + Add an opening balances transaction to the journal, declaring the bal- ances on this date. Here are two ways to do it: - o The first way: open the journal in any text editor and save an entry + o The first way: open the journal in any text editor and save an entry like this: 2020-01-01 * opening balances @@ -7835,19 +7833,19 @@ COMMON TASKS liabilities:creditcard $-50 = $-50 equity:opening/closing balances - These are start-of-day balances, ie whatever was in the account at + These are start-of-day balances, ie whatever was in the account at the end of the previous day. - The * after the date is an optional status flag. Here it means + The * after the date is an optional status flag. Here it means "cleared & confirmed". - The currency symbols are optional, but usually a good idea as you'll + The currency symbols are optional, but usually a good idea as you'll be dealing with multiple currencies sooner or later. - The = amounts are optional balance assertions, providing extra error + The = amounts are optional balance assertions, providing extra error checking. - o The second way: run hledger add and follow the prompts to record a + o The second way: run hledger add and follow the prompts to record a similar transaction: $ hledger add @@ -7884,18 +7882,18 @@ COMMON TASKS Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2020-01-01]: . - If you're using version control, this could be a good time to commit + If you're using version control, this could be a good time to commit the journal. Eg: $ git commit -m 'initial balances' 2020.journal Recording transactions - As you spend or receive money, you can record these transactions using - one of the methods above (text editor, hledger add) or by using the - hledger-iadd or hledger-web add-ons, or by using the import command to + As you spend or receive money, you can record these transactions using + one of the methods above (text editor, hledger add) or by using the + hledger-iadd or hledger-web add-ons, or by using the import command to convert CSV data downloaded from your bank. - Here are some simple transactions, see the hledger_journal(5) manual + Here are some simple transactions, see the hledger_journal(5) manual and hledger.org for more ideas: 2020/1/10 * gift received @@ -7911,22 +7909,22 @@ COMMON TASKS assets:bank:checking $1000 Reconciling - Periodically you should reconcile - compare your hledger-reported bal- - ances against external sources of truth, like bank statements or your - bank's website - to be sure that your ledger accurately represents the - real-world balances (and, that the real-world institutions have not - made a mistake!). This gets easy and fast with (1) practice and (2) - frequency. If you do it daily, it can take 2-10 minutes. If you let - it pile up, expect it to take longer as you hunt down errors and dis- + Periodically you should reconcile - compare your hledger-reported bal- + ances against external sources of truth, like bank statements or your + bank's website - to be sure that your ledger accurately represents the + real-world balances (and, that the real-world institutions have not + made a mistake!). This gets easy and fast with (1) practice and (2) + frequency. If you do it daily, it can take 2-10 minutes. If you let + it pile up, expect it to take longer as you hunt down errors and dis- crepancies. A typical workflow: - 1. Reconcile cash. Count what's in your wallet. Compare with what - hledger reports (hledger bal cash). If they are different, try to - remember the missing transaction, or look for the error in the - already-recorded transactions. A register report can be helpful - (hledger reg cash). If you can't find the error, add an adjustment + 1. Reconcile cash. Count what's in your wallet. Compare with what + hledger reports (hledger bal cash). If they are different, try to + remember the missing transaction, or look for the error in the + already-recorded transactions. A register report can be helpful + (hledger reg cash). If you can't find the error, add an adjustment transaction. Eg if you have $105 after the above, and can't explain the missing $2, it could be: @@ -7936,26 +7934,26 @@ COMMON TASKS 2. Reconcile checking. Log in to your bank's website. Compare today's (cleared) balance with hledger's cleared balance (hledger bal check- - ing -C). If they are different, track down the error or record the - missing transaction(s) or add an adjustment transaction, similar to + ing -C). If they are different, track down the error or record the + missing transaction(s) or add an adjustment transaction, similar to the above. Unlike the cash case, you can usually compare the trans- - action history and running balance from your bank with the one - reported by hledger reg checking -C. This will be easier if you - generally record transaction dates quite similar to your bank's + action history and running balance from your bank with the one + reported by hledger reg checking -C. This will be easier if you + generally record transaction dates quite similar to your bank's clearing dates. 3. Repeat for other asset/liability accounts. - Tip: instead of the register command, use hledger-ui to see a live- + Tip: instead of the register command, use hledger-ui to see a live- updating register while you edit the journal: hledger-ui --watch --reg- ister checking -C - After reconciling, it could be a good time to mark the reconciled - transactions' status as "cleared and confirmed", if you want to track - that, by adding the * marker. Eg in the paycheck transaction above, + After reconciling, it could be a good time to mark the reconciled + transactions' status as "cleared and confirmed", if you want to track + that, by adding the * marker. Eg in the paycheck transaction above, insert * between 2020-01-15 and paycheck - If you're using version control, this can be another good time to com- + If you're using version control, this can be another good time to com- mit: $ git commit -m 'txns' 2020.journal @@ -8027,7 +8025,7 @@ COMMON TASKS -------------------- 0 - Show only asset and liability balances, as a flat list, limited to + Show only asset and liability balances, as a flat list, limited to depth 2: $ hledger bal assets liabilities -2 @@ -8037,7 +8035,7 @@ COMMON TASKS -------------------- $4055 - Show the same thing without negative numbers, formatted as a simple + Show the same thing without negative numbers, formatted as a simple balance sheet: $ hledger bs -2 @@ -8104,15 +8102,15 @@ COMMON TASKS 2020-01-13 **** Migrating to a new file - At the end of the year, you may want to continue your journal in a new + At the end of the year, you may want to continue your journal in a new file, so that old transactions don't slow down or clutter your reports, - and to help ensure the integrity of your accounting history. See the + and to help ensure the integrity of your accounting history. See the close command. If using version control, don't forget to git add the new file. LIMITATIONS - The need to precede add-on command options with -- when invoked from + The need to precede add-on command options with -- when invoked from hledger is awkward. When input data contains non-ascii characters, a suitable system locale @@ -8128,36 +8126,36 @@ LIMITATIONS In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger add. - Not all of Ledger's journal file syntax is supported. See hledger and + Not all of Ledger's journal file syntax is supported. See hledger and Ledger > Differences > journal format. - On large data files, hledger is slower and uses more memory than + On large data files, hledger is slower and uses more memory than Ledger. TROUBLESHOOTING - Here are some issues you might encounter when you run hledger (and - remember you can also seek help from the IRC channel, mail list or bug + Here are some issues you might encounter when you run hledger (and + remember you can also seek help from the IRC channel, mail list or bug tracker): Successfully installed, but "No command 'hledger' found" stack and cabal install binaries into a special directory, which should - be added to your PATH environment variable. Eg on unix-like systems, + be added to your PATH environment variable. Eg on unix-like systems, that is ~/.local/bin and ~/.cabal/bin respectively. I set a custom LEDGER_FILE, but hledger is still using the default file - LEDGER_FILE should be a real environment variable, not just a shell - variable. The command env | grep LEDGER_FILE should show it. You may + LEDGER_FILE should be a real environment variable, not just a shell + variable. The command env | grep LEDGER_FILE should show it. You may need to use export. Here's an explanation. - Getting errors like "Illegal byte sequence" or "Invalid or incomplete - multibyte or wide character" or "commitAndReleaseBuffer: invalid argu- + Getting errors like "Illegal byte sequence" or "Invalid or incomplete + multibyte or wide character" or "commitAndReleaseBuffer: invalid argu- ment (invalid character)" - Programs compiled with GHC (hledger, haskell build tools, etc.) need to - have a UTF-8-aware locale configured in the environment, otherwise they - will fail with these kinds of errors when they encounter non-ascii + Programs compiled with GHC (hledger, haskell build tools, etc.) need + to have a UTF-8-aware locale configured in the environment, otherwise + they will fail with these kinds of errors when they encounter non-ascii characters. - To fix it, set the LANG environment variable to some locale which sup- + To fix it, set the LANG environment variable to some locale which sup- ports UTF-8. The locale you choose must be installed on your system. Here's an example of setting LANG temporarily, on Ubuntu GNU/Linux: @@ -8172,8 +8170,8 @@ TROUBLESHOOTING POSIX $ LANG=en_US.utf8 hledger -f my.journal print # ensure it is used for this command - If available, C.UTF-8 will also work. If your preferred locale isn't - listed by locale -a, you might need to install it. Eg on + If available, C.UTF-8 will also work. If your preferred locale isn't + listed by locale -a, you might need to install it. Eg on Ubuntu/Debian: $ apt-get install language-pack-fr @@ -8193,8 +8191,8 @@ TROUBLESHOOTING $ echo "export LANG=en_US.utf8" >>~/.bash_profile $ bash --login - Exact spelling and capitalisation may be important. Note the differ- - ence on MacOS (UTF-8, not utf8). Some platforms (eg ubuntu) allow + Exact spelling and capitalisation may be important. Note the differ- + ence on MacOS (UTF-8, not utf8). Some platforms (eg ubuntu) allow variant spellings, but others (eg macos) require it to be exact: $ locale -a | grep -iE en_us.*utf @@ -8204,7 +8202,7 @@ TROUBLESHOOTING 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) @@ -8222,4 +8220,4 @@ SEE ALSO -hledger-1.27.99 November 2022 HLEDGER(1) +hledger-1.28.99 December 2022 HLEDGER(1)