From e90483a75a0f755082c6e7d23bf580cc0ae809a0 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 1 Dec 2023 17:25:00 -1000 Subject: [PATCH] ;doc: update manuals --- hledger-lib/.date.m4 | 2 +- hledger-ui/.date.m4 | 2 +- hledger-ui/hledger-ui.1 | 314 +- hledger-ui/hledger-ui.txt | 2 +- hledger-web/.date.m4 | 2 +- hledger-web/hledger-web.1 | 257 +- hledger-web/hledger-web.txt | 2 +- hledger/.date.m4 | 2 +- hledger/hledger.1 | 5387 +++++++++++++++-------------------- hledger/hledger.info | 850 +++--- hledger/hledger.txt | 1380 ++++----- 11 files changed, 3685 insertions(+), 4515 deletions(-) diff --git a/hledger-lib/.date.m4 b/hledger-lib/.date.m4 index 52c2fb8c0..bd0cdfe8d 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 2023}})m4_dnl +m4_define({{_monthyear_}}, {{December 2023}})m4_dnl diff --git a/hledger-ui/.date.m4 b/hledger-ui/.date.m4 index 52c2fb8c0..bd0cdfe8d 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 2023}})m4_dnl +m4_define({{_monthyear_}}, {{December 2023}})m4_dnl diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1 index a52cff8e5..3338f712e 100644 --- a/hledger-ui/hledger-ui.1 +++ b/hledger-ui/hledger-ui.1 @@ -1,20 +1,17 @@ -.TH "HLEDGER-UI" "1" "November 2023" "hledger-ui-1.31.99 " "hledger User Manuals" +.TH "HLEDGER-UI" "1" "December 2023" "hledger-ui-1.31.99 " "hledger User Manuals" .SH NAME -.PP hledger-ui - robust, friendly plain text accounting (TUI version) .SH SYNOPSIS -.PP -\f[V]hledger-ui [OPTS] [QUERYARGS]\f[R] +\f[CR]hledger-ui [OPTS] [QUERYARGS]\f[R] .PD 0 .P .PD -\f[V]hledger ui -- [OPTS] [QUERYARGS]\f[R] +\f[CR]hledger ui -- [OPTS] [QUERYARGS]\f[R] .SH DESCRIPTION -.PP This manual is for hledger\[aq]s terminal interface, version 1.31.99. See also the hledger manual for common concepts and file formats. .PP @@ -31,9 +28,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 from (and appends to) a journal file specified by -the \f[V]LEDGER_FILE\f[R] environment variable (defaulting to -\f[V]$HOME/.hledger.journal\f[R]); or you can specify files with -\f[V]-f\f[R] options. +the \f[CR]LEDGER_FILE\f[R] environment variable (defaulting to +\f[CR]$HOME/.hledger.journal\f[R]); or you can specify files with +\f[CR]-f\f[R] options. It can also read timeclock files, timedot files, or any CSV/SSV/TSV file with a date field. (See hledger(1) -> Input for details.) @@ -44,187 +41,186 @@ They can be revealed, along with any rule-generated periodic transactions, by pressing the F key (or starting with --forecast) to enable \[dq]forecast mode\[dq]. .SH OPTIONS -.PP Any QUERYARGS are interpreted as a hledger search query which filters the data. .PP hledger-ui provides the following options: .TP -\f[V]-w --watch\f[R] +\f[CR]-w --watch\f[R] watch for data and date changes and reload automatically .TP -\f[V]--theme=default|terminal|greenterm\f[R] +\f[CR]--theme=default|terminal|greenterm\f[R] use this custom display theme .TP -\f[V]--menu\f[R] +\f[CR]--menu\f[R] start in the menu screen .TP -\f[V]--cash\f[R] +\f[CR]--cash\f[R] start in the cash accounts screen .TP -\f[V]--bs\f[R] +\f[CR]--bs\f[R] start in the balance sheet accounts screen .TP -\f[V]--is\f[R] +\f[CR]--is\f[R] start in the income statement accounts screen .TP -\f[V]--all\f[R] +\f[CR]--all\f[R] start in the all accounts screen .TP -\f[V]--register=ACCTREGEX\f[R] +\f[CR]--register=ACCTREGEX\f[R] start in the (first) matched account\[aq]s register screen .TP -\f[V]--change\f[R] +\f[CR]--change\f[R] show period balances (changes) at startup instead of historical balances .TP -\f[V]-l --flat\f[R] +\f[CR]-l --flat\f[R] show accounts as a flat list (default) .TP -\f[V]-t --tree\f[R] +\f[CR]-t --tree\f[R] show accounts as a tree .PP hledger-ui also supports many of hledger\[aq]s general options (and the hledger manual\[aq]s command line tips also apply here): .SS General help options .TP -\f[V]-h --help\f[R] +\f[CR]-h --help\f[R] show general or COMMAND help .TP -\f[V]--man\f[R] +\f[CR]--man\f[R] show general or COMMAND user manual with man .TP -\f[V]--info\f[R] +\f[CR]--info\f[R] show general or COMMAND user manual with info .TP -\f[V]--version\f[R] +\f[CR]--version\f[R] show general or ADDONCMD version .TP -\f[V]--debug[=N]\f[R] +\f[CR]--debug[=N]\f[R] show debug output (levels 1-9, default: 1) .SS General input options .TP -\f[V]-f FILE --file=FILE\f[R] +\f[CR]-f FILE --file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[V]$LEDGER_FILE\f[R] or -\f[V]$HOME/.hledger.journal\f[R]) +For stdin, use - (default: \f[CR]$LEDGER_FILE\f[R] or +\f[CR]$HOME/.hledger.journal\f[R]) .TP -\f[V]--rules-file=RULESFILE\f[R] +\f[CR]--rules-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP -\f[V]--separator=CHAR\f[R] +\f[CR]--separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[V]--alias=OLD=NEW\f[R] +\f[CR]--alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[V]--anon\f[R] +\f[CR]--anon\f[R] anonymize accounts and payees .TP -\f[V]--pivot FIELDNAME\f[R] +\f[CR]--pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[V]-I --ignore-assertions\f[R] +\f[CR]-I --ignore-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[V]-s --strict\f[R] +\f[CR]-s --strict\f[R] do extra error checking (check that all posted accounts are declared) .SS General reporting options .TP -\f[V]-b --begin=DATE\f[R] +\f[CR]-b --begin=DATE\f[R] include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) .TP -\f[V]-e --end=DATE\f[R] +\f[CR]-e --end=DATE\f[R] include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) .TP -\f[V]-D --daily\f[R] +\f[CR]-D --daily\f[R] multiperiod/multicolumn report by day .TP -\f[V]-W --weekly\f[R] +\f[CR]-W --weekly\f[R] multiperiod/multicolumn report by week .TP -\f[V]-M --monthly\f[R] +\f[CR]-M --monthly\f[R] multiperiod/multicolumn report by month .TP -\f[V]-Q --quarterly\f[R] +\f[CR]-Q --quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[V]-Y --yearly\f[R] +\f[CR]-Y --yearly\f[R] multiperiod/multicolumn report by year .TP -\f[V]-p --period=PERIODEXP\f[R] +\f[CR]-p --period=PERIODEXP\f[R] set start date, end date, and/or reporting interval all at once using period expressions syntax .TP -\f[V]--date2\f[R] +\f[CR]--date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[V]--today=DATE\f[R] +\f[CR]--today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[V]-U --unmarked\f[R] +\f[CR]-U --unmarked\f[R] include only unmarked postings/txns (can combine with -P or -C) .TP -\f[V]-P --pending\f[R] +\f[CR]-P --pending\f[R] include only pending postings/txns .TP -\f[V]-C --cleared\f[R] +\f[CR]-C --cleared\f[R] include only cleared postings/txns .TP -\f[V]-R --real\f[R] +\f[CR]-R --real\f[R] include only non-virtual postings .TP -\f[V]-NUM --depth=NUM\f[R] +\f[CR]-NUM --depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[V]-E --empty\f[R] +\f[CR]-E --empty\f[R] show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) .TP -\f[V]-B --cost\f[R] +\f[CR]-B --cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[V]-V --market\f[R] +\f[CR]-V --market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[V]-X --exchange=COMM\f[R] +\f[CR]-X --exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[V]--value\f[R] +\f[CR]--value\f[R] convert amounts to cost or market value, more flexibly than -B/-V/-X .TP -\f[V]--infer-equity\f[R] +\f[CR]--infer-equity\f[R] infer conversion equity postings from costs .TP -\f[V]--infer-costs\f[R] +\f[CR]--infer-costs\f[R] infer costs from conversion equity postings .TP -\f[V]--infer-market-prices\f[R] +\f[CR]--infer-market-prices\f[R] use costs as additional market prices, as if they were P directives .TP -\f[V]--forecast\f[R] +\f[CR]--forecast\f[R] generate transactions from periodic rules, between the latest recorded txn and 6 months from today, or during the specified PERIOD (= is required). Auto posting rules will be applied to these transactions as well. Also, in hledger-ui make future-dated transactions visible. .TP -\f[V]--auto\f[R] +\f[CR]--auto\f[R] generate extra postings by applying auto posting rules to all txns (not just forecast txns) .TP -\f[V]--verbose-tags\f[R] +\f[CR]--verbose-tags\f[R] add visible tags indicating transactions or postings which have been generated/modified .TP -\f[V]--commodity-style\f[R] +\f[CR]--commodity-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP -\f[V]--color=WHEN (or --colour=WHEN)\f[R] +\f[CR]--color=WHEN (or --colour=WHEN)\f[R] Should color-supporting commands use ANSI color codes in text output. \[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting terminal. @@ -233,7 +229,7 @@ into \[aq]less -R\[aq]. \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[V]--pretty[=WHEN]\f[R] +\f[CR]--pretty[=WHEN]\f[R] Show prettier output, e.g. using unicode box-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], @@ -246,7 +242,6 @@ last one takes precedence. .PP Some reporting options can also be written as query arguments. .SH MOUSE -.PP In most modern terminals, you can navigate through the screens with a mouse or touchpad: .IP \[bu] 2 @@ -256,166 +251,159 @@ Click on list items to go deeper .IP \[bu] 2 Click on the left margin (column 0) to go back. .SH KEYS -.PP Keyboard gives more control. .PP -\f[V]?\f[R] shows a help dialog listing all keys. +\f[CR]?\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[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. +Press \f[CR]?\f[R] again (or \f[CR]ESCAPE\f[R], or \f[CR]LEFT\f[R], or +\f[CR]q\f[R]) to close it. The following keys work on most screens: .PP -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] +The cursor keys navigate: \f[CR]RIGHT\f[R] or \f[CR]ENTER\f[R] goes +deeper, \f[CR]LEFT\f[R] returns to the previous screen, +\f[CR]UP\f[R]/\f[CR]DOWN\f[R]/\f[CR]PGUP\f[R]/\f[CR]PGDN\f[R]/\f[CR]HOME\f[R]/\f[CR]END\f[R] move up and down through lists. Emacs-style -(\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. +(\f[CR]CTRL-p\f[R]/\f[CR]CTRL-n\f[R]/\f[CR]CTRL-f\f[R]/\f[CR]CTRL-b\f[R]) +and VI-style (\f[CR]k\f[R],\f[CR]j\f[R],\f[CR]l\f[R],\f[CR]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. (If you\[aq]re on a mac, the karabiner app is one way to do that.) .PP With shift pressed, the cursor keys adjust the report period, limiting the transactions to be shown (by default, all are shown). -\f[V]SHIFT-DOWN/UP\f[R] steps downward and upward through these standard -report period durations: year, quarter, month, week, day. -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] +\f[CR]SHIFT-DOWN/UP\f[R] steps downward and upward through these +standard report period durations: year, quarter, month, week, day. +Then, \f[CR]SHIFT-LEFT/RIGHT\f[R] moves to the previous/next period. +\f[CR]T\f[R] sets the report period to today. +With the \f[CR]-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[V]/\f[R] and a -\f[V]date:\f[R] query. +To set a non-standard period, you can use \f[CR]/\f[R] and a +\f[CR]date:\f[R] query. .PP (Mac users: SHIFT-DOWN/UP keys do not work by default in Terminal, as of MacOS Monterey. You can configure them as follows: open Terminal, press CMD-comma to open preferences, click Profiles, select your current terminal profile on the left, click Keyboard on the right, click + and add this for -Shift-Down: \f[V]\[rs]033[1;2B\f[R], click + and add this for Shift-Up: -\f[V]\[rs]033[1;2A\f[R]. -Press the Escape key to enter the \f[V]\[rs]033\f[R] part, you can\[aq]t -type it directly.) +Shift-Down: \f[CR]\[rs]033[1;2B\f[R], click + and add this for Shift-Up: +\f[CR]\[rs]033[1;2A\f[R]. +Press the Escape key to enter the \f[CR]\[rs]033\f[R] part, you +can\[aq]t type it directly.) .PP -\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. +\f[CR]/\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[V]ENTER\f[R] to set it, or \f[V]ESCAPE\f[R]to cancel. +press \f[CR]ENTER\f[R] to set it, or \f[CR]ESCAPE\f[R]to cancel. There are also keys for quickly adjusting some common filters like account depth and transaction status (see below). -\f[V]BACKSPACE\f[R] or \f[V]DELETE\f[R] removes all filters, showing all -transactions. +\f[CR]BACKSPACE\f[R] or \f[CR]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[V]F\f[R] toggles forecast mode, in which future/forecasted +\f[CR]F\f[R] toggles forecast mode, in which future/forecasted transactions are shown. .PP -\f[V]ESCAPE\f[R] resets the UI state and jumps back to the top screen, +\f[CR]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[V]CTRL-l\f[R] redraws the screen and centers the selection if +\f[CR]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[V]g\f[R] reloads from the data file(s) and updates the current screen -and any previous screens. +\f[CR]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[V]I\f[R] toggles balance assertion checking. +\f[CR]I\f[R] toggles balance assertion checking. Disabling balance assertions temporarily can be useful for troubleshooting. .PP -\f[V]a\f[R] runs command-line hledger\[aq]s add command, and reloads the -updated file. +\f[CR]a\f[R] runs command-line hledger\[aq]s add command, and reloads +the updated file. This allows some basic data entry. .PP -\f[V]A\f[R] is like \f[V]a\f[R], but runs the hledger-iadd tool, which +\f[CR]A\f[R] is like \f[CR]a\f[R], but runs the hledger-iadd tool, which provides a terminal interface. -This key will be available if \f[V]hledger-iadd\f[R] is installed in +This key will be available if \f[CR]hledger-iadd\f[R] is installed in $path. .PP -\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. +\f[CR]E\f[R] runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default +(\f[CR]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[V]B\f[R] toggles cost mode, showing amounts converted to their +\f[CR]B\f[R] toggles cost mode, showing amounts converted to their cost\[aq]s commodity (see hledger manual > Cost reporting. .PP -\f[V]V\f[R] toggles value mode, showing amounts converted to their +\f[CR]V\f[R] toggles value mode, showing amounts converted to their market value (see hledger manual > Valuation flag). More specifically, .IP "1." 3 -By default, the \f[V]V\f[R] key toggles showing end value -(\f[V]--value=end\f[R]) on or off. +By default, the \f[CR]V\f[R] key toggles showing end value +(\f[CR]--value=end\f[R]) on or off. The valuation date will be the report end date if specified, otherwise today. .IP "2." 3 If you started hledger-ui with some other valuation (such as -\f[V]--value=then,EUR\f[R]), the \f[V]V\f[R] key toggles that off or on. +\f[CR]--value=then,EUR\f[R]), the \f[CR]V\f[R] key toggles that off or +on. .PP Cost/value tips: - When showing end value, you can change the report end -date without restarting, by pressing \f[V]/\f[R] and adding a query like -\f[V]date:..YYYY-MM-DD\f[R]. +date without restarting, by pressing \f[CR]/\f[R] and adding a query +like \f[CR]date:..YYYY-MM-DD\f[R]. - Either cost mode, or value mode, can be active, but not both at once. Cost mode takes precedence. - There\[aq]s not yet any visual indicator that cost or value mode is active, other than the amount values. .PP -\f[V]q\f[R] quits the application. +\f[CR]q\f[R] quits the application. .PP Additional screen-specific keys are described below. .SH SCREENS -.PP At startup, hledger-ui shows a menu screen by default. From here you can navigate to other screens using the cursor keys: -\f[V]UP\f[R]/\f[V]DOWN\f[R] to select, \f[V]RIGHT\f[R] to move to the -selected screen, \f[V]LEFT\f[R] to return to the previous screen. -Or you can use \f[V]ESC\f[R] to return directly to the top menu screen. +\f[CR]UP\f[R]/\f[CR]DOWN\f[R] to select, \f[CR]RIGHT\f[R] to move to the +selected screen, \f[CR]LEFT\f[R] to return to the previous screen. +Or you can use \f[CR]ESC\f[R] to return directly to the top menu screen. .PP You can also use a command line flag to specific a different startup -screen (\f[V]--cs\f[R], \f[V]--bs\f[R], \f[V]--is\f[R], \f[V]--all\f[R], -or \f[V]--register=ACCT\f[R]). +screen (\f[CR]--cs\f[R], \f[CR]--bs\f[R], \f[CR]--is\f[R], +\f[CR]--all\f[R], or \f[CR]--register=ACCT\f[R]). .SS Menu -.PP This is the top-most screen. From here you can navigate to several screens listing accounts of various types. Note some of these may not show anything until you have configured account types. .SS Cash accounts -.PP This screen shows \[dq]cash\[dq] (ie, liquid asset) accounts (like -\f[V]hledger balancesheet type:c\f[R]). +\f[CR]hledger balancesheet type:c\f[R]). It always shows balances (historical ending balances on the date shown in the title line). .SS Balance sheet accounts -.PP This screen shows asset, liability and equity accounts (like -\f[V]hledger balancesheetequity\f[R]). +\f[CR]hledger balancesheetequity\f[R]). It always shows balances. .SS Income statement accounts -.PP This screen shows revenue and expense accounts (like -\f[V]hledger incomestatement\f[R]). +\f[CR]hledger incomestatement\f[R]). It always shows changes (balance changes in the period shown in the title line). .SS All accounts -.PP This screen shows all accounts in your journal (unless filtered by a -query; like \f[V]hledger balance\f[R]). +query; like \f[CR]hledger balance\f[R]). It shows balances by default; you can toggle showing changes with the -\f[V]H\f[R] key. +\f[CR]H\f[R] key. .SS Register -.PP This screen shows the transactions affecting a particular account. Each line represents one transaction, and shows: .IP \[bu] 2 @@ -427,7 +415,7 @@ the overall change to the current account\[aq]s balance; positive for an inflow to this account, negative for an outflow. .IP \[bu] 2 the running total after the transaction. -With the \f[V]H\f[R] key you can toggle between +With the \f[CR]H\f[R] key you can toggle between .RS 2 .IP \[bu] 2 the period total, which is from just the transactions displayed @@ -441,7 +429,7 @@ bank\[aq]s website, eg) if not disturbed by a query. .PP Note, this screen combines each transaction\[aq]s in-period postings to a single line item, dated with the earliest in-period transaction or -posting date (like hledger\[aq]s \f[V]aregister\f[R]). +posting date (like hledger\[aq]s \f[CR]aregister\f[R]). So custom posting dates can cause the running balance to be temporarily inaccurate. (See hledger manual > aregister and posting dates.) @@ -452,25 +440,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[V]t\f[R] here also. +Tree mode/list mode can be toggled with \f[CR]t\f[R] here also. .PP -\f[V]U\f[R] toggles filtering by unmarked status, showing or hiding +\f[CR]U\f[R] toggles filtering by unmarked status, showing or hiding unmarked transactions. -Similarly, \f[V]P\f[R] toggles pending transactions, and \f[V]C\f[R] +Similarly, \f[CR]P\f[R] toggles pending transactions, and \f[CR]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[V]R\f[R] toggles real mode, in which virtual postings are ignored. +\f[CR]R\f[R] toggles real mode, in which virtual postings are ignored. .PP -\f[V]z\f[R] toggles nonzero mode, in which only transactions posting a +\f[CR]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[V]RIGHT\f[R] to view the selected transaction in detail. +Press \f[CR]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 (hledger_journal(5)). @@ -480,7 +467,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[V]UP\f[R] and \f[V]DOWN\f[R] will step through all transactions +\f[CR]UP\f[R] and \f[CR]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. @@ -490,19 +477,18 @@ 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). .PP -On this screen (and the register screen), the \f[V]E\f[R] key will open +On this screen (and the register screen), the \f[CR]E\f[R] key will open your text editor with the cursor positioned at the current transaction if possible. .PP This screen has a limitation with showing file updates: it will not show them until you exit and re-enter it. -So eg to see the effect of using the \f[V]E\f[R] key, currently you -must: - press \f[V]E\f[R], edit and save the file, then exit the editor, -returning to hledger-ui - press \f[V]g\f[R] to reload the file (or use -\f[V]-w/--watch\f[R] mode) - press \f[V]LEFT\f[R] then \f[V]RIGHT\f[R] -to exit and re-enter the transaction screen. +So eg to see the effect of using the \f[CR]E\f[R] key, currently you +must: - press \f[CR]E\f[R], edit and save the file, then exit the +editor, returning to hledger-ui - press \f[CR]g\f[R] to reload the file +(or use \f[CR]-w/--watch\f[R] mode) - press \f[CR]LEFT\f[R] then +\f[CR]RIGHT\f[R] to exit and re-enter the transaction screen. .SS Error -.PP 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 @@ -510,9 +496,8 @@ normal operation. (Or, you can press escape to cancel the reload attempt.) .SH TIPS .SS Watch mode -.PP One of hledger-ui\[aq]s best features is the auto-reloading -\f[V]-w/--watch\f[R] mode. +\f[CR]-w/--watch\f[R] mode. With this flag, it will update the display automatically whenever changes are saved to the data files. .PP @@ -521,11 +506,9 @@ A good workflow is to have your bank\[aq]s online register open in a browser window, for reference; the journal file open in an editor window; and hledger-ui in watch mode in a terminal window, eg: .IP -.nf -\f[C] +.EX $ hledger-ui --watch --register checking -C -\f[R] -.fi +.EE .PP As you mark things cleared in the editor, you can see the effect immediately without having to context switch. @@ -533,7 +516,7 @@ This leaves more mental bandwidth for your accounting. Of course you can still interact with hledger-ui when needed, eg to toggle cleared mode, or to explore the history. .PP -There are currently some limitations with \f[V]--watch\f[R]: +There are currently some limitations with \f[CR]--watch\f[R]: .PP It may not work correctly for you, depending on platform or system configuration. @@ -541,49 +524,46 @@ configuration. .PP At least on mac, there can be a slow build-up of CPU usage over time, until the program is restarted (or, suspending and restarting with -\f[V]CTRL-z\f[R] \f[V]fg\f[R] may be enough). +\f[CR]CTRL-z\f[R] \f[CR]fg\f[R] may be enough). .PP It will not detect file changes made by certain editors, such as -Jetbrains IDEs or \f[V]gedit\f[R], or on certain less common +Jetbrains IDEs or \f[CR]gedit\f[R], or on certain less common filesystems. -(To work around, press \f[V]g\f[R] to reload manually, or try -#1617\[aq]s \f[V]fs.inotify.max_user_watches\f[R] workaround and let us +(To work around, press \f[CR]g\f[R] to reload manually, or try +#1617\[aq]s \f[CR]fs.inotify.max_user_watches\f[R] workaround and let us know.) .PP If you are viewing files mounted from another machine, the system clocks on both machines should be roughly in agreement. .SS Debug output -.PP -You can add \f[V]--debug[=N]\f[R] to the command line to log debug +You can add \f[CR]--debug[=N]\f[R] to the command line to log debug output. -This will be logged to the file \f[V]hledger-ui.log\f[R] in the current +This will be logged to the file \f[CR]hledger-ui.log\f[R] in the current directory. N ranges from 1 (least output, the default) to 9 (maximum output). .SH ENVIRONMENT -.PP \f[B]COLUMNS\f[R] The screen width to use. Default: the full terminal width. .PP \f[B]LEDGER_FILE\f[R] The main journal file to use when not specified -with \f[V]-f/--file\f[R]. -Default: \f[V]$HOME/.hledger.journal\f[R]. +with \f[CR]-f/--file\f[R]. +Default: \f[CR]$HOME/.hledger.journal\f[R]. .SH BUGS -.PP We welcome bug reports in the hledger issue tracker (shortcut: http://bugs.hledger.org), or on the #hledger chat or hledger mail list (https://hledger.org/support). .PP Some known issues: .PP -\f[V]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin). +\f[CR]-f-\f[R] doesn\[aq]t work (hledger-ui can\[aq]t read from stdin). .PP -If you press \f[V]g\f[R] with large files, there could be a noticeable +If you press \f[CR]g\f[R] with large files, there could be a noticeable pause. .PP The Transaction screen does not update from file changes until you exit and re-endter it (see SCREENS > Transaction above). .PP -\f[V]--watch\f[R] is not yet fully robust on all platforms (see Watch +\f[CR]--watch\f[R] is not yet fully robust on all platforms (see Watch mode above). diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt index c381f10dd..6fd56e15e 100644 --- a/hledger-ui/hledger-ui.txt +++ b/hledger-ui/hledger-ui.txt @@ -537,4 +537,4 @@ LICENSE SEE ALSO hledger(1), hledger-ui(1), hledger-web(1), ledger(1) -hledger-ui-1.31.99 November 2023 HLEDGER-UI(1) +hledger-ui-1.31.99 December 2023 HLEDGER-UI(1) diff --git a/hledger-web/.date.m4 b/hledger-web/.date.m4 index 52c2fb8c0..bd0cdfe8d 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 2023}})m4_dnl +m4_define({{_monthyear_}}, {{December 2023}})m4_dnl diff --git a/hledger-web/hledger-web.1 b/hledger-web/hledger-web.1 index e840343b1..7776734ad 100644 --- a/hledger-web/hledger-web.1 +++ b/hledger-web/hledger-web.1 @@ -1,20 +1,17 @@ -.TH "HLEDGER-WEB" "1" "November 2023" "hledger-web-1.31.99 " "hledger User Manuals" +.TH "HLEDGER-WEB" "1" "December 2023" "hledger-web-1.31.99 " "hledger User Manuals" .SH NAME -.PP hledger-web - robust, friendly plain text accounting (Web version) .SH SYNOPSIS -.PP -\f[V]hledger-web [--serve|--serve-api] [OPTS] [ARGS]\f[R] +\f[CR]hledger-web [--serve|--serve-api] [OPTS] [ARGS]\f[R] .PD 0 .P .PD -\f[V]hledger web -- [--serve|--serve-api] [OPTS] [ARGS]\f[R] +\f[CR]hledger web -- [--serve|--serve-api] [OPTS] [ARGS]\f[R] .SH DESCRIPTION -.PP This manual is for hledger\[aq]s web interface, version 1.31.99. See also the hledger manual for common concepts and file formats. .PP @@ -40,9 +37,9 @@ instance, it writes a numbered backup of the main journal file (only) on every edit. .PP Like hledger, it reads from (and appends to) a journal file specified by -the \f[V]LEDGER_FILE\f[R] environment variable (defaulting to -\f[V]$HOME/.hledger.journal\f[R]); or you can specify files with -\f[V]-f\f[R] options. +the \f[CR]LEDGER_FILE\f[R] environment variable (defaulting to +\f[CR]$HOME/.hledger.journal\f[R]); or you can specify files with +\f[CR]-f\f[R] options. It can also read timeclock files, timedot files, or any CSV/SSV/TSV file with a date field. (See hledger(1) -> Input for details.) @@ -54,15 +51,14 @@ 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[V]--serve\f[R]: the app runs without stopping, and without +With \f[CR]--serve\f[R]: the app runs without stopping, and without opening a browser. .IP \[bu] 2 -With \f[V]--serve-api\f[R]: only the JSON API is served. +With \f[CR]--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. .SH OPTIONS -.PP Command-line options and arguments may be used to set an initial filter on the data. These filter options are not shown in the web UI, but it will be applied @@ -70,84 +66,82 @@ in addition to any search query entered there. .PP hledger-web provides the following options: .TP -\f[V]--serve\f[R] +\f[CR]--serve\f[R] serve and log requests, don\[aq]t browse or auto-exit after timeout .TP -\f[V]--serve-api\f[R] +\f[CR]--serve-api\f[R] like --serve, but serve only the JSON web API, without the server-side web UI .TP -\f[V]--host=IPADDR\f[R] +\f[CR]--host=IPADDR\f[R] listen on this IP address (default: 127.0.0.1) .TP -\f[V]--port=PORT\f[R] +\f[CR]--port=PORT\f[R] listen on this TCP port (default: 5000) .TP -\f[V]--socket=SOCKETFILE\f[R] +\f[CR]--socket=SOCKETFILE\f[R] use a unix domain socket file to listen for requests instead of a TCP socket. -Implies \f[V]--serve\f[R]. +Implies \f[CR]--serve\f[R]. It can only be used if the operating system can provide this type of socket. .TP -\f[V]--base-url=URL\f[R] +\f[CR]--base-url=URL\f[R] set the base url (default: http://IPADDR:PORT). Note: affects url generation but not route parsing. Can be useful if running behind a reverse web proxy that does path rewriting. .TP -\f[V]--file-url=URL\f[R] +\f[CR]--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[V]--allow=view|add|edit\f[R] +\f[CR]--allow=view|add|edit\f[R] set the user\[aq]s access level for changing data (default: -\f[V]add\f[R]). -It also accepts \f[V]sandstorm\f[R] for use on that platform (reads -permissions from the \f[V]X-Sandstorm-Permissions\f[R] request header). +\f[CR]add\f[R]). +It also accepts \f[CR]sandstorm\f[R] for use on that platform (reads +permissions from the \f[CR]X-Sandstorm-Permissions\f[R] request header). .TP -\f[V]--test\f[R] +\f[CR]--test\f[R] run hledger-web\[aq]s tests and exit. hspec test runner args may follow a --, eg: hledger-web --test -- --help .PP By default the server listens on IP address 127.0.0.1, accessible only to local requests. -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. +You can use \f[CR]--host\f[R] to change this, eg +\f[CR]--host 0.0.0.0\f[R] to listen on all configured addresses. .PP -Similarly, use \f[V]--port\f[R] to set a TCP port other than 5000, eg if -you are running multiple hledger-web instances. +Similarly, use \f[CR]--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[V]--socket\f[R] is used. -In this case, it creates an \f[V]AF_UNIX\f[R] socket file at the +Both of these options are ignored when \f[CR]--socket\f[R] is used. +In this case, it creates an \f[CR]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[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[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]: +As an example, \f[CR]nginx\f[R] as reverse proxy can use the variable +\f[CR]$remote_user\f[R] to derive a path from the username used in a +HTTP basic authentication. +The following \f[CR]proxy_pass\f[R] directive allows access to all +\f[CR]hledger-web\f[R] instances that created a socket in +\f[CR]/tmp/hledger/\f[R]: .IP -.nf -\f[C] +.EX proxy_pass http://unix:/tmp/hledger/${remote_user}.socket; -\f[R] -.fi +.EE .PP -You can use \f[V]--base-url\f[R] to change the protocol, hostname, port +You can use \f[CR]--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[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 +The default is \f[CR]http://HOST:PORT/\f[R] using the server\[aq]s +configured host address and TCP port (or \f[CR]http://HOST\f[R] if PORT is 80). .PP -With \f[V]--file-url\f[R] you can set a different base url for static +With \f[CR]--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. .PP @@ -155,144 +149,144 @@ hledger-web also supports many of hledger\[aq]s general options (and the hledger manual\[aq]s command line tips also apply here): .SS General help options .TP -\f[V]-h --help\f[R] +\f[CR]-h --help\f[R] show general or COMMAND help .TP -\f[V]--man\f[R] +\f[CR]--man\f[R] show general or COMMAND user manual with man .TP -\f[V]--info\f[R] +\f[CR]--info\f[R] show general or COMMAND user manual with info .TP -\f[V]--version\f[R] +\f[CR]--version\f[R] show general or ADDONCMD version .TP -\f[V]--debug[=N]\f[R] +\f[CR]--debug[=N]\f[R] show debug output (levels 1-9, default: 1) .SS General input options .TP -\f[V]-f FILE --file=FILE\f[R] +\f[CR]-f FILE --file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[V]$LEDGER_FILE\f[R] or -\f[V]$HOME/.hledger.journal\f[R]) +For stdin, use - (default: \f[CR]$LEDGER_FILE\f[R] or +\f[CR]$HOME/.hledger.journal\f[R]) .TP -\f[V]--rules-file=RULESFILE\f[R] +\f[CR]--rules-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP -\f[V]--separator=CHAR\f[R] +\f[CR]--separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[V]--alias=OLD=NEW\f[R] +\f[CR]--alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[V]--anon\f[R] +\f[CR]--anon\f[R] anonymize accounts and payees .TP -\f[V]--pivot FIELDNAME\f[R] +\f[CR]--pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[V]-I --ignore-assertions\f[R] +\f[CR]-I --ignore-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[V]-s --strict\f[R] +\f[CR]-s --strict\f[R] do extra error checking (check that all posted accounts are declared) .SS General reporting options .TP -\f[V]-b --begin=DATE\f[R] +\f[CR]-b --begin=DATE\f[R] include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) .TP -\f[V]-e --end=DATE\f[R] +\f[CR]-e --end=DATE\f[R] include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) .TP -\f[V]-D --daily\f[R] +\f[CR]-D --daily\f[R] multiperiod/multicolumn report by day .TP -\f[V]-W --weekly\f[R] +\f[CR]-W --weekly\f[R] multiperiod/multicolumn report by week .TP -\f[V]-M --monthly\f[R] +\f[CR]-M --monthly\f[R] multiperiod/multicolumn report by month .TP -\f[V]-Q --quarterly\f[R] +\f[CR]-Q --quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[V]-Y --yearly\f[R] +\f[CR]-Y --yearly\f[R] multiperiod/multicolumn report by year .TP -\f[V]-p --period=PERIODEXP\f[R] +\f[CR]-p --period=PERIODEXP\f[R] set start date, end date, and/or reporting interval all at once using period expressions syntax .TP -\f[V]--date2\f[R] +\f[CR]--date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[V]--today=DATE\f[R] +\f[CR]--today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[V]-U --unmarked\f[R] +\f[CR]-U --unmarked\f[R] include only unmarked postings/txns (can combine with -P or -C) .TP -\f[V]-P --pending\f[R] +\f[CR]-P --pending\f[R] include only pending postings/txns .TP -\f[V]-C --cleared\f[R] +\f[CR]-C --cleared\f[R] include only cleared postings/txns .TP -\f[V]-R --real\f[R] +\f[CR]-R --real\f[R] include only non-virtual postings .TP -\f[V]-NUM --depth=NUM\f[R] +\f[CR]-NUM --depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[V]-E --empty\f[R] +\f[CR]-E --empty\f[R] show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) .TP -\f[V]-B --cost\f[R] +\f[CR]-B --cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[V]-V --market\f[R] +\f[CR]-V --market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[V]-X --exchange=COMM\f[R] +\f[CR]-X --exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[V]--value\f[R] +\f[CR]--value\f[R] convert amounts to cost or market value, more flexibly than -B/-V/-X .TP -\f[V]--infer-equity\f[R] +\f[CR]--infer-equity\f[R] infer conversion equity postings from costs .TP -\f[V]--infer-costs\f[R] +\f[CR]--infer-costs\f[R] infer costs from conversion equity postings .TP -\f[V]--infer-market-prices\f[R] +\f[CR]--infer-market-prices\f[R] use costs as additional market prices, as if they were P directives .TP -\f[V]--forecast\f[R] +\f[CR]--forecast\f[R] generate transactions from periodic rules, between the latest recorded txn and 6 months from today, or during the specified PERIOD (= is required). Auto posting rules will be applied to these transactions as well. Also, in hledger-ui make future-dated transactions visible. .TP -\f[V]--auto\f[R] +\f[CR]--auto\f[R] generate extra postings by applying auto posting rules to all txns (not just forecast txns) .TP -\f[V]--verbose-tags\f[R] +\f[CR]--verbose-tags\f[R] add visible tags indicating transactions or postings which have been generated/modified .TP -\f[V]--commodity-style\f[R] +\f[CR]--commodity-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP -\f[V]--color=WHEN (or --colour=WHEN)\f[R] +\f[CR]--color=WHEN (or --colour=WHEN)\f[R] Should color-supporting commands use ANSI color codes in text output. \[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting terminal. @@ -301,7 +295,7 @@ into \[aq]less -R\[aq]. \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[V]--pretty[=WHEN]\f[R] +\f[CR]--pretty[=WHEN]\f[R] Show prettier output, e.g. using unicode box-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], @@ -314,13 +308,12 @@ last one takes precedence. .PP Some reporting options can also be written as query arguments. .SH PERMISSIONS -.PP By default, hledger-web allows anyone who can reach it to view the journal and to add new transactions, but not to change existing data. .PP You can restrict who can reach it by .IP \[bu] 2 -setting the IP address it listens on (see \f[V]--host\f[R] above). +setting the IP address it listens on (see \f[CR]--host\f[R] above). By default it listens on 127.0.0.1, accessible to all users on the local machine. .IP \[bu] 2 @@ -330,27 +323,26 @@ custom firewall rules .PP You can restrict what the users who reach it can do, by .IP \[bu] 2 -using the \f[V]--capabilities=CAP[,CAP..]\f[R] flag when you start it, +using the \f[CR]--capabilities=CAP[,CAP..]\f[R] flag when you start it, enabling one or more of the following capabilities. -The default value is \f[V]view,add\f[R]: +The default value is \f[CR]view,add\f[R]: .RS 2 .IP \[bu] 2 -\f[V]view\f[R] - allows viewing the journal file and all included files +\f[CR]view\f[R] - allows viewing the journal file and all included files .IP \[bu] 2 -\f[V]add\f[R] - allows adding new transactions to the main journal file +\f[CR]add\f[R] - allows adding new transactions to the main journal file .IP \[bu] 2 -\f[V]manage\f[R] - allows editing, uploading or downloading the main or +\f[CR]manage\f[R] - allows editing, uploading or downloading the main or included files .RE .IP \[bu] 2 -using the \f[V]--capabilities-header=HTTPHEADER\f[R] flag to specify a +using the \f[CR]--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[V]manage\f[R] capability mentioned above, +If you enable the \f[CR]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 @@ -371,7 +363,6 @@ Changes which would leave the journal file(s) unparseable or non-valid (Probably. This needs re-testing.) .SH RELOADING -.PP hledger-web detects changes made to the files by other means (eg if you edit it directly, outside of hledger-web), and it will show the new data when you reload the page or navigate to a new page. @@ -381,24 +372,20 @@ message until the file has been fixed. (Note: if you are viewing files mounted from another machine, make sure that both machine clocks are roughly in step.) .SH JSON API -.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[V]--serve-api\f[R] +If you want the JSON API only, you can use the \f[CR]--serve-api\f[R] flag. Eg: .IP -.nf -\f[C] +.EX $ hledger-web -f examples/sample.journal --serve-api \&... -\f[R] -.fi +.EE .PP You can get JSON data from these routes: .IP -.nf -\f[C] +.EX /version /accountnames /transactions @@ -406,15 +393,13 @@ You can get JSON data from these routes: /commodities /accounts /accounttransactions/ACCOUNTNAME -\f[R] -.fi +.EE .PP Eg, all account names in the journal (similar to the accounts command). (hledger-web\[aq]s JSON does not include newlines, here we use python to prettify it): .IP -.nf -\f[C] +.EX $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool [ \[dq]assets\[dq], @@ -431,13 +416,11 @@ $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool \[dq]liabilities\[dq], \[dq]liabilities:debts\[dq] ] -\f[R] -.fi +.EE .PP Or all transactions: .IP -.nf -\f[C] +.EX $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool [ { @@ -456,8 +439,7 @@ $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool \[dq]aismultiplier\[dq]: false, \[dq]aprice\[dq]: null, \&... -\f[R] -.fi +.EE .PP Most of the JSON corresponds to hledger\[aq]s data types; for details of what the fields mean, see the Hledger.Data.Json haddock docs and click @@ -468,34 +450,31 @@ 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[V]/accounttransactions\f[R] it\[aq]s getAccounttransactionsR, -returning a \[dq]\f[V]accountTransactionsReport ...\f[R]\[dq]. +Eg for \f[CR]/accounttransactions\f[R] it\[aq]s getAccounttransactionsR, +returning a \[dq]\f[CR]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[V]/add\f[R], if hledger-web was started with the \f[V]add\f[R] +\f[CR]/add\f[R], if hledger-web was started with the \f[CR]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[V]/transactions\f[R] -or \f[V]/accounttransactions\f[R], or you can export it with +You can get sample JSON from hledger-web\[aq]s \f[CR]/transactions\f[R] +or \f[CR]/accounttransactions\f[R], or you can export it with hledger-lib, eg like so: .IP -.nf -\f[C] +.EX \&.../hledger$ stack ghci hledger-lib >>> writeJsonFile \[dq]txn.json\[dq] (head $ jtxns samplejournal) >>> :q -\f[R] -.fi +.EE .PP Here\[aq]s how it looks as of hledger-1.17 (remember, this JSON corresponds to hledger\[aq]s Transaction and related data types): .IP -.nf -\f[C] +.EX { \[dq]tcomment\[dq]: \[dq]\[dq], \[dq]tpostings\[dq]: [ @@ -581,21 +560,17 @@ corresponds to hledger\[aq]s Transaction and related data types): \[dq]tdescription\[dq]: \[dq]income\[dq], \[dq]tstatus\[dq]: \[dq]Unmarked\[dq] } -\f[R] -.fi +.EE .PP And here\[aq]s how to test adding it with curl. This should add a new entry to your journal: .IP -.nf -\f[C] +.EX $ curl http://127.0.0.1:5000/add -X PUT -H \[aq]Content-Type: application/json\[aq] --data-binary \[at]txn.json -\f[R] -.fi +.EE .SH DEBUG OUTPUT .SS Debug output -.PP -You can add \f[V]--debug[=N]\f[R] to the command line to log debug +You can add \f[CR]--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 @@ -607,14 +582,12 @@ stderr, eg: .PD 0 .P .PD -\f[V]hledger-web --debug=3 2>hledger-web.log\f[R]. +\f[CR]hledger-web --debug=3 2>hledger-web.log\f[R]. .SH ENVIRONMENT -.PP \f[B]LEDGER_FILE\f[R] The main journal file to use when not specified -with \f[V]-f/--file\f[R]. -Default: \f[V]$HOME/.hledger.journal\f[R]. +with \f[CR]-f/--file\f[R]. +Default: \f[CR]$HOME/.hledger.journal\f[R]. .SH BUGS -.PP We welcome bug reports in the hledger issue tracker (shortcut: http://bugs.hledger.org), or on the #hledger chat or hledger mail list (https://hledger.org/support). diff --git a/hledger-web/hledger-web.txt b/hledger-web/hledger-web.txt index b8b0b6d46..16d859d2b 100644 --- a/hledger-web/hledger-web.txt +++ b/hledger-web/hledger-web.txt @@ -564,4 +564,4 @@ LICENSE SEE ALSO hledger(1), hledger-ui(1), hledger-web(1), ledger(1) -hledger-web-1.31.99 November 2023 HLEDGER-WEB(1) +hledger-web-1.31.99 December 2023 HLEDGER-WEB(1) diff --git a/hledger/.date.m4 b/hledger/.date.m4 index 52c2fb8c0..bd0cdfe8d 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 2023}})m4_dnl +m4_define({{_monthyear_}}, {{December 2023}})m4_dnl diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 49e7a1589..803337a98 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -1,25 +1,22 @@ .\"t -.TH "HLEDGER" "1" "November 2023" "hledger-1.31.99 " "hledger User Manuals" +.TH "HLEDGER" "1" "December 2023" "hledger-1.31.99 " "hledger User Manuals" .SH NAME -.PP hledger - robust, friendly plain text accounting (CLI version) .SH SYNOPSIS -.PP -\f[V]hledger\f[R] +\f[CR]hledger\f[R] .PD 0 .P .PD -\f[V]hledger COMMAND [OPTS] [ARGS]\f[R] +\f[CR]hledger COMMAND [OPTS] [ARGS]\f[R] .PD 0 .P .PD -\f[V]hledger ADDONCMD -- [OPTS] [ARGS]\f[R] +\f[CR]hledger ADDONCMD -- [OPTS] [ARGS]\f[R] .SH DESCRIPTION -.PP hledger is a robust, user-friendly, cross-platform set of programs for tracking money, time, or any other commodity, using double-entry accounting and a simple, editable file format. @@ -41,38 +38,36 @@ You can also get it from hledger itself with .PD 0 .P .PD -\f[V]hledger --man\f[R], \f[V]hledger --info\f[R] or -\f[V]hledger help [TOPIC]\f[R]. +\f[CR]hledger --man\f[R], \f[CR]hledger --info\f[R] or +\f[CR]hledger help [TOPIC]\f[R]. .PP The main function of the hledger CLI is to read plain text files describing financial transactions, crunch the numbers, and print a useful report on the terminal (or save it as HTML, CSV, JSON or SQL). Many reports are available, as subcommands. -hledger will also detect other \f[V]hledger-*\f[R] executables as extra +hledger will also detect other \f[CR]hledger-*\f[R] executables as extra subcommands. .PP hledger usually reads from (and appends to) a journal file specified by -the \f[V]LEDGER_FILE\f[R] environment variable (defaulting to -\f[V]$HOME/.hledger.journal\f[R]); or you can specify files with -\f[V]-f\f[R] options. +the \f[CR]LEDGER_FILE\f[R] environment variable (defaulting to +\f[CR]$HOME/.hledger.journal\f[R]); or you can specify files with +\f[CR]-f\f[R] options. It can also read timeclock files, timedot files, or any CSV/SSV/TSV file with a date field. .PP Here is a small journal file describing one transaction: .IP -.nf -\f[C] +.EX 2015-10-16 bought food expenses:food $10 assets:cash -\f[R] -.fi +.EE .PP Transactions are dated movements of money (etc.) between two or more \f[I]accounts\f[R]: bank accounts, your wallet, revenue/expense categories, people, etc. -You can choose any account names you wish, using \f[V]:\f[R] to indicate -subaccounts. +You can choose any account names you wish, using \f[CR]:\f[R] to +indicate subaccounts. There must be at least two spaces between account name and amount. Positive amounts are inflow to that account (\f[I]debit\f[R]), negatives are outflow from it (\f[I]credit\f[R]). @@ -85,53 +80,50 @@ For more extensive/efficient changes, use a text editor: Emacs + ledger-mode, VIM + vim-ledger, or VS Code + hledger-vscode are some good choices (see https://hledger.org/editors.html). .PP -To get started, run \f[V]hledger add\f[R] and follow the prompts, or -save some entries like the above in \f[V]$HOME/.hledger.journal\f[R], +To get started, run \f[CR]hledger add\f[R] and follow the prompts, or +save some entries like the above in \f[CR]$HOME/.hledger.journal\f[R], then try commands like: .PD 0 .P .PD -\f[V]hledger print -x\f[R] +\f[CR]hledger print -x\f[R] .PD 0 .P .PD -\f[V]hledger aregister assets\f[R] +\f[CR]hledger aregister assets\f[R] .PD 0 .P .PD -\f[V]hledger balance\f[R] +\f[CR]hledger balance\f[R] .PD 0 .P .PD -\f[V]hledger balancesheet\f[R] +\f[CR]hledger balancesheet\f[R] .PD 0 .P .PD -\f[V]hledger incomestatement\f[R]. +\f[CR]hledger incomestatement\f[R]. .PD 0 .P .PD -Run \f[V]hledger\f[R] to list the commands. +Run \f[CR]hledger\f[R] to list the commands. See also the \[dq]Starting a journal file\[dq] and \[dq]Setting opening balances\[dq] sections in PART 5: COMMON TASKS. .SH PART 1: USER INTERFACE .SH Input -.PP hledger reads one or more data files, each time you run it. -You can specify a file with \f[V]-f\f[R], like so +You can specify a file with \f[CR]-f\f[R], like so .IP -.nf -\f[C] +.EX $ hledger -f FILE print -\f[R] -.fi +.EE .PP Files are most often in hledger\[aq]s journal format, with the -\f[V].journal\f[R] file extension (\f[V].hledger\f[R] or \f[V].j\f[R] +\f[CR].journal\f[R] file extension (\f[CR].hledger\f[R] or \f[CR].j\f[R] also work); these files describe transactions, like an accounting general journal. .PP -When no file is specified, hledger looks for \f[V].hledger.journal\f[R] +When no file is specified, hledger looks for \f[CR].hledger.journal\f[R] in your home directory. .PP But most people prefer to keep financial files in a dedicated folder, @@ -139,12 +131,11 @@ perhaps with version control. Also, starting a new journal file each year is common (it\[aq]s not required, but helps keep things fast and organised). So we usually configure a different journal file, by setting the -\f[V]LEDGER_FILE\f[R] environment variable, to something like -\f[V]\[ti]/finance/2023.journal\f[R]. +\f[CR]LEDGER_FILE\f[R] environment variable, to something like +\f[CR]\[ti]/finance/2023.journal\f[R]. For more about how to do that on your system, see Common tasks > Setting LEDGER_FILE. .SS Data formats -.PP Usually the data file is in hledger\[aq]s journal format, but it can be in any of the supported file formats, which currently are: .PP @@ -160,33 +151,33 @@ Used for file extensions: T} _ T{ -\f[V]journal\f[R] +\f[CR]journal\f[R] T}@T{ hledger journal files and some Ledger journals, for transactions T}@T{ -\f[V].journal\f[R] \f[V].j\f[R] \f[V].hledger\f[R] \f[V].ledger\f[R] +\f[CR].journal\f[R] \f[CR].j\f[R] \f[CR].hledger\f[R] \f[CR].ledger\f[R] T} T{ -\f[V]timeclock\f[R] +\f[CR]timeclock\f[R] T}@T{ timeclock files, for precise time logging T}@T{ -\f[V].timeclock\f[R] +\f[CR].timeclock\f[R] T} T{ -\f[V]timedot\f[R] +\f[CR]timedot\f[R] T}@T{ timedot files, for approximate time logging T}@T{ -\f[V].timedot\f[R] +\f[CR].timedot\f[R] T} T{ -\f[V]csv\f[R] +\f[CR]csv\f[R] T}@T{ CSV/SSV/TSV/character-separated values, for data import T}@T{ -\f[V].csv\f[R] \f[V].ssv\f[R] \f[V].tsv\f[R] \f[V].csv.rules\f[R] -\f[V].ssv.rules\f[R] \f[V].tsv.rules\f[R] +\f[CR].csv\f[R] \f[CR].ssv\f[R] \f[CR].tsv\f[R] \f[CR].csv.rules\f[R] +\f[CR].ssv.rules\f[R] \f[CR].tsv.rules\f[R] T} .TE .PP @@ -195,7 +186,7 @@ These formats are described in more detail 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[V]journal\f[R] format. +\f[CR]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. @@ -204,33 +195,25 @@ You can also force a specific reader/format by prefixing the file path with the format and a colon. Eg, to read a .dat file as csv format: .IP -.nf -\f[C] +.EX $ hledger -f csv:/some/csv-file.dat stats -\f[R] -.fi +.EE .SS Standard input -.PP -The file name \f[V]-\f[R] means standard input: +The file name \f[CR]-\f[R] means standard input: .IP -.nf -\f[C] +.EX $ cat FILE | hledger -f- print -\f[R] -.fi +.EE .PP If reading non-journal data in this way, you\[aq]ll need to add a file format prefix, like: .IP -.nf -\f[C] +.EX $ echo \[aq]i 2009/13/1 08:00:00\[aq] | hledger print -f timeclock:- -\f[R] -.fi +.EE .SS Multiple files -.PP -You can specify multiple \f[V]-f\f[R] options, to read multiple files as -one big journal. +You can specify multiple \f[CR]-f\f[R] options, to read multiple files +as one big journal. When doing this, note that certain features (described below) will be affected: .IP \[bu] 2 @@ -243,9 +226,8 @@ Some directives will not affect previous or subsequent files. .PP If needed, you can work around these by using a single parent file which includes the others, or concatenating the files into one, eg: -\f[V]cat a.journal b.journal | hledger -f- CMD\f[R]. +\f[CR]cat a.journal b.journal | hledger -f- CMD\f[R]. .SS Strict mode -.PP hledger checks input files for valid data. By default, the most important errors are detected, while still accepting easy journal files without a lot of declarations: @@ -256,14 +238,14 @@ Are all transactions balanced ? .IP \[bu] 2 Do all balance assertions pass ? .PP -With the \f[V]-s\f[R]/\f[V]--strict\f[R] flag, additional checks are +With the \f[CR]-s\f[R]/\f[CR]--strict\f[R] flag, additional checks are performed: .IP \[bu] 2 -Are all accounts posted to, declared with an \f[V]account\f[R] directive -? +Are all accounts posted to, declared with an \f[CR]account\f[R] +directive ? (Account error checking) .IP \[bu] 2 -Are all commodities declared with a \f[V]commodity\f[R] directive ? +Are all commodities declared with a \f[CR]commodity\f[R] directive ? (Commodity error checking) .IP \[bu] 2 Are all commodity conversions declared explicitly ? @@ -271,35 +253,33 @@ Are all commodity conversions declared explicitly ? You can use the check command to run individual checks -- the ones listed above and some more. .SH Commands -.PP hledger provides various subcommands for getting things done. Most of these commands do not change the journal file; they just read it and output a report. A few commands assist with adding data and file management. .PP -To show the commands list, run \f[V]hledger\f[R] with no arguments. +To show the commands list, run \f[CR]hledger\f[R] with no arguments. The commands are described in detail in PART 4: COMMANDS, below. .PP To use a particular command, run -\f[V]hledger CMD [CMDOPTS] [CMDARGS]\f[R], +\f[CR]hledger CMD [CMDOPTS] [CMDARGS]\f[R], .IP \[bu] 2 CMD is the full command name, or its standard abbreviation shown in the commands list, or any unambiguous prefix of the name. .IP \[bu] 2 CMDOPTS are command-specific options, if any. Command-specific options must be written after the command name. -Eg: \f[V]hledger print -x\f[R]. +Eg: \f[CR]hledger print -x\f[R]. .IP \[bu] 2 CMDARGS are additional arguments to the command, if any. Most hledger commands accept arguments representing a query, to limit the data in some way. -Eg: \f[V]hledger reg assets:checking\f[R]. +Eg: \f[CR]hledger reg assets:checking\f[R]. .PP To list a command\[aq]s options, arguments, and documentation in the -terminal, run \f[V]hledger CMD -h\f[R]. -Eg: \f[V]hledger bal -h\f[R]. +terminal, run \f[CR]hledger CMD -h\f[R]. +Eg: \f[CR]hledger bal -h\f[R]. .SS Add-on commands -.PP In addition to the built-in commands, you can install \f[I]add-on commands\f[R]: programs or scripts named \[dq]hledger-SOMETHING\[dq], which will also appear in hledger\[aq]s commands list. @@ -317,159 +297,159 @@ with no extension or a recognised extension (\[dq].bat\[dq], unix and mac) which has executable permission for the current user. .PP You can run add-on commands using hledger, much like built-in commands: -\f[V]hledger ADDONCMD [-- ADDONCMDOPTS] [ADDONCMDARGS]\f[R]. +\f[CR]hledger ADDONCMD [-- ADDONCMDOPTS] [ADDONCMDARGS]\f[R]. But note the double hyphen argument, required before add-on-specific options. -Eg: \f[V]hledger ui -- --watch\f[R] or \f[V]hledger web -- --serve\f[R]. +Eg: \f[CR]hledger ui -- --watch\f[R] or +\f[CR]hledger web -- --serve\f[R]. If this causes difficulty, you can always run the add-on directly, -without using \f[V]hledger\f[R]: \f[V]hledger-ui --watch\f[R] or -\f[V]hledger-web --serve\f[R]. +without using \f[CR]hledger\f[R]: \f[CR]hledger-ui --watch\f[R] or +\f[CR]hledger-web --serve\f[R]. .SH Options -.PP -Run \f[V]hledger -h\f[R] to see general command line help, and general +Run \f[CR]hledger -h\f[R] to see general command line help, and general options which are common to most hledger commands. These options can be written anywhere on the command line. They can be grouped into help, input, and reporting options: .SS General help options .TP -\f[V]-h --help\f[R] +\f[CR]-h --help\f[R] show general or COMMAND help .TP -\f[V]--man\f[R] +\f[CR]--man\f[R] show general or COMMAND user manual with man .TP -\f[V]--info\f[R] +\f[CR]--info\f[R] show general or COMMAND user manual with info .TP -\f[V]--version\f[R] +\f[CR]--version\f[R] show general or ADDONCMD version .TP -\f[V]--debug[=N]\f[R] +\f[CR]--debug[=N]\f[R] show debug output (levels 1-9, default: 1) .SS General input options .TP -\f[V]-f FILE --file=FILE\f[R] +\f[CR]-f FILE --file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[V]$LEDGER_FILE\f[R] or -\f[V]$HOME/.hledger.journal\f[R]) +For stdin, use - (default: \f[CR]$LEDGER_FILE\f[R] or +\f[CR]$HOME/.hledger.journal\f[R]) .TP -\f[V]--rules-file=RULESFILE\f[R] +\f[CR]--rules-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP -\f[V]--separator=CHAR\f[R] +\f[CR]--separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[V]--alias=OLD=NEW\f[R] +\f[CR]--alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[V]--anon\f[R] +\f[CR]--anon\f[R] anonymize accounts and payees .TP -\f[V]--pivot FIELDNAME\f[R] +\f[CR]--pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[V]-I --ignore-assertions\f[R] +\f[CR]-I --ignore-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[V]-s --strict\f[R] +\f[CR]-s --strict\f[R] do extra error checking (check that all posted accounts are declared) .SS General reporting options .TP -\f[V]-b --begin=DATE\f[R] +\f[CR]-b --begin=DATE\f[R] include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) .TP -\f[V]-e --end=DATE\f[R] +\f[CR]-e --end=DATE\f[R] include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) .TP -\f[V]-D --daily\f[R] +\f[CR]-D --daily\f[R] multiperiod/multicolumn report by day .TP -\f[V]-W --weekly\f[R] +\f[CR]-W --weekly\f[R] multiperiod/multicolumn report by week .TP -\f[V]-M --monthly\f[R] +\f[CR]-M --monthly\f[R] multiperiod/multicolumn report by month .TP -\f[V]-Q --quarterly\f[R] +\f[CR]-Q --quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[V]-Y --yearly\f[R] +\f[CR]-Y --yearly\f[R] multiperiod/multicolumn report by year .TP -\f[V]-p --period=PERIODEXP\f[R] +\f[CR]-p --period=PERIODEXP\f[R] set start date, end date, and/or reporting interval all at once using period expressions syntax .TP -\f[V]--date2\f[R] +\f[CR]--date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[V]--today=DATE\f[R] +\f[CR]--today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[V]-U --unmarked\f[R] +\f[CR]-U --unmarked\f[R] include only unmarked postings/txns (can combine with -P or -C) .TP -\f[V]-P --pending\f[R] +\f[CR]-P --pending\f[R] include only pending postings/txns .TP -\f[V]-C --cleared\f[R] +\f[CR]-C --cleared\f[R] include only cleared postings/txns .TP -\f[V]-R --real\f[R] +\f[CR]-R --real\f[R] include only non-virtual postings .TP -\f[V]-NUM --depth=NUM\f[R] +\f[CR]-NUM --depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[V]-E --empty\f[R] +\f[CR]-E --empty\f[R] show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) .TP -\f[V]-B --cost\f[R] +\f[CR]-B --cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[V]-V --market\f[R] +\f[CR]-V --market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[V]-X --exchange=COMM\f[R] +\f[CR]-X --exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[V]--value\f[R] +\f[CR]--value\f[R] convert amounts to cost or market value, more flexibly than -B/-V/-X .TP -\f[V]--infer-equity\f[R] +\f[CR]--infer-equity\f[R] infer conversion equity postings from costs .TP -\f[V]--infer-costs\f[R] +\f[CR]--infer-costs\f[R] infer costs from conversion equity postings .TP -\f[V]--infer-market-prices\f[R] +\f[CR]--infer-market-prices\f[R] use costs as additional market prices, as if they were P directives .TP -\f[V]--forecast\f[R] +\f[CR]--forecast\f[R] generate transactions from periodic rules, between the latest recorded txn and 6 months from today, or during the specified PERIOD (= is required). Auto posting rules will be applied to these transactions as well. Also, in hledger-ui make future-dated transactions visible. .TP -\f[V]--auto\f[R] +\f[CR]--auto\f[R] generate extra postings by applying auto posting rules to all txns (not just forecast txns) .TP -\f[V]--verbose-tags\f[R] +\f[CR]--verbose-tags\f[R] add visible tags indicating transactions or postings which have been generated/modified .TP -\f[V]--commodity-style\f[R] +\f[CR]--commodity-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP -\f[V]--color=WHEN (or --colour=WHEN)\f[R] +\f[CR]--color=WHEN (or --colour=WHEN)\f[R] Should color-supporting commands use ANSI color codes in text output. \[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting terminal. @@ -478,7 +458,7 @@ into \[aq]less -R\[aq]. \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[V]--pretty[=WHEN]\f[R] +\f[CR]--pretty[=WHEN]\f[R] Show prettier output, e.g. using unicode box-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], @@ -491,90 +471,74 @@ last one takes precedence. .PP Some reporting options can also be written as query arguments. .SH Command line tips -.PP Here are some details useful to know about for hledger command lines (and elsewhere). Feel free to skip this section until you need it. .SS Option repetition -.PP If options are repeated in a command line, hledger will generally use the last (right-most) occurence. .SS Special characters .SS Single escaping (shell metacharacters) -.PP In shell command lines, characters significant to your shell - such as -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. +spaces, \f[CR]<\f[R], \f[CR]>\f[R], \f[CR](\f[R], \f[CR])\f[R], +\f[CR]|\f[R], \f[CR]$\f[R] and \f[CR]\[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. Eg to match an account name containing a space: .IP -.nf -\f[C] +.EX $ hledger register \[aq]credit card\[aq] -\f[R] -.fi +.EE .PP or: .IP -.nf -\f[C] +.EX $ hledger register credit\[rs] card -\f[R] -.fi +.EE .PP -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 +Windows users should keep in mind that \f[CR]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[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. +as \f[CR].\f[R], \f[CR]\[ha]\f[R], \f[CR]$\f[R], \f[CR][\f[R], +\f[CR]]\f[R], \f[CR](\f[R], \f[CR])\f[R], \f[CR]|\f[R], and +\f[CR]\[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[V]$\f[R] sign while using the bash shell: +Eg to match a literal \f[CR]$\f[R] sign while using the bash shell: .IP -.nf -\f[C] +.EX $ hledger balance cur:\[aq]\[rs]$\[aq] -\f[R] -.fi +.EE .PP or: .IP -.nf -\f[C] +.EX $ hledger balance cur:\[rs]\[rs]$ -\f[R] -.fi +.EE .SS Triple escaping (for add-on commands) -.PP 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[V]$\f[R] sign while using the bash shell and -running an add-on command (\f[V]ui\f[R]): +Eg to match a literal \f[CR]$\f[R] sign while using the bash shell and +running an add-on command (\f[CR]ui\f[R]): .IP -.nf -\f[C] +.EX $ hledger ui cur:\[aq]\[rs]\[rs]$\[aq] -\f[R] -.fi +.EE .PP or: .IP -.nf -\f[C] +.EX $ hledger ui cur:\[rs]\[rs]\[rs]\[rs]$ -\f[R] -.fi +.EE .PP If you wondered why \f[I]four\f[R] backslashes, perhaps this helps: .PP @@ -584,35 +548,32 @@ l l. T{ unescaped: T}@T{ -\f[V]$\f[R] +\f[CR]$\f[R] T} T{ escaped: T}@T{ -\f[V]\[rs]$\f[R] +\f[CR]\[rs]$\f[R] T} T{ double-escaped: T}@T{ -\f[V]\[rs]\[rs]$\f[R] +\f[CR]\[rs]\[rs]$\f[R] T} T{ triple-escaped: T}@T{ -\f[V]\[rs]\[rs]\[rs]\[rs]$\f[R] +\f[CR]\[rs]\[rs]\[rs]\[rs]$\f[R] T} .TE .PP Or, you can avoid the extra escaping by running the add-on executable directly: .IP -.nf -\f[C] +.EX $ hledger-ui cur:\[rs]\[rs]$ -\f[R] -.fi +.EE .SS Less escaping -.PP Options and arguments are sometimes used in places other than the shell command line, where shell-escaping is not needed, so there you should use one less level of escaping. @@ -626,7 +587,6 @@ hledger-web\[aq]s search form .IP \[bu] 2 GHCI\[aq]s prompt (used by developers). .SS Unicode characters -.PP hledger is expected to handle non-ascii characters correctly: .IP \[bu] 2 they should be parsed correctly in input files and on the command line, @@ -642,7 +602,7 @@ 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[V]export LANG=en_US.UTF-8\f[R]. +\f[CR]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). @@ -663,25 +623,24 @@ on our download page) might show display problems when run in a cygwin or msys terminal, and vice versa. (See eg #961). .SS Regular expressions -.PP A regular expression (regexp) is a small piece of text where certain -characters (like \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], \f[V]\[rs]\f[R]) -have special meanings, forming a tiny language for matching text -precisely - very useful in hledger and elsewhere. +characters (like \f[CR].\f[R], \f[CR]\[ha]\f[R], \f[CR]$\f[R], +\f[CR]+\f[R], \f[CR]*\f[R], \f[CR]()\f[R], \f[CR]|\f[R], \f[CR][]\f[R], +\f[CR]\[rs]\f[R]) have special meanings, forming a tiny language for +matching text precisely - very useful in hledger and elsewhere. To learn all about them, visit regular-expressions.info. .PP hledger supports regexps whenever you are entering a pattern to match something, eg in query arguments, account aliases, CSV if rules, -hledger-web\[aq]s search form, hledger-ui\[aq]s \f[V]/\f[R] search, etc. +hledger-web\[aq]s search form, hledger-ui\[aq]s \f[CR]/\f[R] search, +etc. You may need to wrap them in quotes, especially at the command line (see Special characters above). Here are some examples: .PP Account name queries (quoted for command line use): .IP -.nf -\f[C] +.EX Regular expression: Matches: ------------------- ------------------------------------------------------------ bank assets:bank, assets:bank:savings, expenses:art:banksy, ... @@ -697,69 +656,55 @@ bank assets:bank, assets:bank:savings, expenses:art:banksy, ... \[aq]my +bank\[aq] my bank, my bank, ... ( + matches 1 or more of the preceding thing ) \[aq]my *bank\[aq] mybank, my bank, my bank, ... ( * matches 0 or more of the preceding thing ) \[aq]b.nk\[aq] bank, bonk, b nk, ... ( . matches any character ) -\f[R] -.fi +.EE .PP Some other queries: .IP -.nf -\f[C] +.EX desc:\[aq]amazon|amzn|audible\[aq] Amazon transactions cur:EUR amounts with commodity symbol containing EUR cur:\[aq]\[rs]$\[aq] amounts with commodity symbol containing $ cur:\[aq]\[ha]\[rs]$$\[aq] only $ amounts, not eg AU$ or CA$ cur:....? amounts with 4-or-more-character symbols tag:.=202[1-3] things with any tag whose value contains 2021, 2022 or 2023 -\f[R] -.fi +.EE .PP -Account name aliases: accept \f[V].\f[R] instead of \f[V]:\f[R] as +Account name aliases: accept \f[CR].\f[R] instead of \f[CR]:\f[R] as account separator: .IP -.nf -\f[C] +.EX alias /\[rs]./=: replaces all periods in account names with colons -\f[R] -.fi +.EE .PP Show multiple top-level accounts combined as one: .IP -.nf -\f[C] +.EX --alias=\[aq]/\[ha][\[ha]:]+/=combined\[aq] ( [\[ha]:] matches any character other than : ) -\f[R] -.fi +.EE .PP Show accounts with the second-level part removed: .IP -.nf -\f[C] +.EX --alias \[aq]/\[ha]([\[ha]:]+):[\[ha]:]+/ = \[rs]1\[aq] match a top-level account and a second-level account and replace those with just the top-level account ( \[rs]1 in the replacement text means \[dq]whatever was matched by the first parenthesised part of the regexp\[dq] -\f[R] -.fi +.EE .PP CSV rules: match CSV records containing dining-related MCC codes: .IP -.nf -\f[C] +.EX if \[rs]?MCC581[124] -\f[R] -.fi +.EE .PP Match CSV records with a specific amount around the end/start of month: .IP -.nf -\f[C] +.EX if %amount \[rs]b3\[rs].99 & %date (29|30|31|01|02|03)$ -\f[R] -.fi +.EE .SS hledger\[aq]s regular expressions -.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 exactly what they support: @@ -771,72 +716,65 @@ being matched) .IP "3." 3 they are POSIX ERE (extended regular expressions) .IP "4." 3 -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]) +they also support GNU word boundaries (\f[CR]\[rs]b\f[R], +\f[CR]\[rs]B\f[R], \f[CR]\[rs]<\f[R], \f[CR]\[rs]>\f[R]) .IP "5." 3 backreferences are supported when doing text replacement in account aliases or CSV rules, where backreferences can be used in the replacement string to reference capturing groups in the search regexp. -Otherwise, if you write \f[V]\[rs]1\f[R], it will match the digit -\f[V]1\f[R]. +Otherwise, if you write \f[CR]\[rs]1\f[R], it will match the digit +\f[CR]1\f[R]. .IP "6." 3 -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 +they do not support mode modifiers (\f[CR](?s)\f[R]), character classes +(\f[CR]\[rs]w\f[R], \f[CR]\[rs]d\f[R]), or anything else not mentioned above. .PP Some things to note: .IP \[bu] 2 -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]). +In the \f[CR]alias\f[R] directive and \f[CR]--alias\f[R] option, regular +expressions must be enclosed in forward slashes (\f[CR]/REGEX/\f[R]). Elsewhere in hledger, these are not required. .IP \[bu] 2 -In queries, to match a regular expression metacharacter like \f[V]$\f[R] -as a literal character, prepend a backslash. +In queries, to match a regular expression metacharacter like +\f[CR]$\f[R] as a literal character, prepend a backslash. Eg to search for amounts with the dollar sign in hledger-web, write -\f[V]cur:\[rs]$\f[R]. +\f[CR]cur:\[rs]$\f[R]. .IP \[bu] 2 -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. +On the command line, some metacharacters like \f[CR]$\f[R] have a +special meaning to the shell and so must be escaped at least once more. See Special characters. .SS Argument files -.PP You can save a set of command line options and arguments in a file, and -then reuse them by writing \f[V]\[at]FILENAME\f[R] as a command line +then reuse them by writing \f[CR]\[at]FILENAME\f[R] as a command line argument. -Eg: \f[V]hledger bal \[at]foo.args\f[R]. +Eg: \f[CR]hledger bal \[at]foo.args\f[R]. .PP Inside the argument file, each line should contain just one option or argument. Don\[aq]t use spaces except inside quotes (or you\[aq]ll see a confusing -error); write \f[V]=\f[R] (or nothing) between a flag and its argument. +error); write \f[CR]=\f[R] (or nothing) between a flag and its argument. For the special characters mentioned above, use one less level of quoting than you would at the command prompt. .SH Output .SS Output destination -.PP hledger commands send their output to the terminal by default. You can of course redirect this, eg into a file, using standard shell syntax: .IP -.nf -\f[C] +.EX $ hledger print > foo.txt -\f[R] -.fi +.EE .PP Some commands (print, register, stats, the balance commands) also -provide the \f[V]-o/--output-file\f[R] option, which does the same thing -without needing the shell. +provide the \f[CR]-o/--output-file\f[R] option, which does the same +thing without needing the shell. Eg: .IP -.nf -\f[C] +.EX $ hledger print -o foo.txt $ hledger print -o - # write to stdout (the default) -\f[R] -.fi +.EE .SS Output format -.PP Some commands offer other kinds of output, not just text on the terminal. Here are those commands and the formats currently supported: @@ -955,38 +893,32 @@ T}@T{ T} .TE .IP \[bu] 2 -\f[I]1 Also affected by the balance commands\[aq] \f[VI]--layout\f[I] +\f[I]1 Also affected by the balance commands\[aq] \f[CI]--layout\f[I] option.\f[R] .IP \[bu] 2 -\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] +\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] .PP -The output format is selected by the \f[V]-O/--output-format=FMT\f[R] +The output format is selected by the \f[CR]-O/--output-format=FMT\f[R] option: .IP -.nf -\f[C] +.EX $ hledger print -O csv # print CSV on stdout -\f[R] -.fi +.EE .PP or by the filename extension of an output file specified with the -\f[V]-o/--output-file=FILE.FMT\f[R] option: +\f[CR]-o/--output-file=FILE.FMT\f[R] option: .IP -.nf -\f[C] +.EX $ hledger balancesheet -o foo.csv # write CSV to foo.csv -\f[R] -.fi +.EE .PP -The \f[V]-O\f[R] option can be combined with \f[V]-o\f[R] to override +The \f[CR]-O\f[R] option can be combined with \f[CR]-o\f[R] to override the file extension, if needed: .IP -.nf -\f[C] +.EX $ hledger balancesheet -o foo.txt -O csv # write CSV to foo.txt -\f[R] -.fi +.EE .PP Some notes about the various output formats: .SS CSV output @@ -995,7 +927,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[V]hledger.css\f[R] file in +HTML output can be styled by an optional \f[CR]hledger.css\f[R] file in the same directory. .SS JSON output .IP \[bu] 2 @@ -1025,142 +957,127 @@ This is not yet much used; real-world feedback is welcome. SQL output is expected to work at least with SQLite, MySQL and Postgres. .IP \[bu] 2 For SQLite, it will be more useful if you modify the generated -\f[V]id\f[R] field to be a PRIMARY KEY. +\f[CR]id\f[R] field to be a PRIMARY KEY. Eg: .RS 2 .IP -.nf -\f[C] +.EX $ hledger print -O sql | sed \[aq]s/id serial/id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL/g\[aq] | ... -\f[R] -.fi +.EE .RE .IP \[bu] 2 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[V]delete\f[R] or \f[V]truncate\f[R] SQL statements) or drop tables +\f[CR]delete\f[R] or \f[CR]truncate\f[R] SQL statements) or drop tables completely as otherwise your postings will be duped. .SS Commodity styles -.PP When displaying amounts, hledger infers a standard display style for each commodity/currency, as described below in Commodity display style. .PP -If needed, this can be overridden by a \f[V]-c/--commodity-style\f[R] +If needed, this can be overridden by a \f[CR]-c/--commodity-style\f[R] option (except for cost amounts and amounts displayed by the -\f[V]print\f[R] command, which are always displayed with all decimal +\f[CR]print\f[R] command, which are always displayed with all decimal digits). For example, the following will force dollar amounts to be displayed as shown: .IP -.nf -\f[C] +.EX $ hledger print -c \[aq]$1.000,0\[aq] -\f[R] -.fi +.EE .PP This option can repeated to set the display style for multiple commodities/currencies. Its argument is as described in the commodity directive. .SS Colour -.PP In terminal output, some commands can produce colour when the terminal supports it: .IP \[bu] 2 -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; +if the \f[CR]--color/--colour\f[R] option is given a value of +\f[CR]yes\f[R] or \f[CR]always\f[R] (or \f[CR]no\f[R] or +\f[CR]never\f[R]), colour will (or will not) be used; .IP \[bu] 2 -otherwise, if the \f[V]NO_COLOR\f[R] environment variable is set, colour -will not be used; +otherwise, if the \f[CR]NO_COLOR\f[R] environment variable is set, +colour will not be used; .IP \[bu] 2 otherwise, colour will be used if the output (terminal or file) supports it. .SS Box-drawing -.PP In terminal output, you can enable unicode box-drawing characters to render prettier tables: .IP \[bu] 2 -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 +if the \f[CR]--pretty\f[R] option is given a value of \f[CR]yes\f[R] or +\f[CR]always\f[R] (or \f[CR]no\f[R] or \f[CR]never\f[R]), unicode characters will (or will not) be used; .IP \[bu] 2 otherwise, unicode characters will not be used. .SS Paging -.PP When showing long output in the terminal, hledger will try to use the -pager specified by the \f[V]PAGER\f[R] environment variable, or -\f[V]less\f[R], or \f[V]more\f[R]. +pager specified by the \f[CR]PAGER\f[R] environment variable, or +\f[CR]less\f[R], or \f[CR]more\f[R]. (A pager is a helper program that shows one page at a time rather than scrolling everything off screen). Currently it does this only for help output, not for reports; specifically, .IP \[bu] 2 -when listing commands, with \f[V]hledger\f[R] +when listing commands, with \f[CR]hledger\f[R] .IP \[bu] 2 -when showing help with \f[V]hledger [CMD] --help\f[R], +when showing help with \f[CR]hledger [CMD] --help\f[R], .IP \[bu] 2 -when viewing manuals with \f[V]hledger help\f[R] or -\f[V]hledger --man\f[R]. +when viewing manuals with \f[CR]hledger help\f[R] or +\f[CR]hledger --man\f[R]. .PP Note the pager is expected to handle ANSI codes, which hledger uses eg for bold emphasis. -For the common pager \f[V]less\f[R] (and its \f[V]more\f[R] -compatibility mode), we add \f[V]R\f[R] to the \f[V]LESS\f[R] and -\f[V]MORE\f[R] environment variables to make this work. +For the common pager \f[CR]less\f[R] (and its \f[CR]more\f[R] +compatibility mode), we add \f[CR]R\f[R] to the \f[CR]LESS\f[R] and +\f[CR]MORE\f[R] environment variables to make this work. If you use a different pager, you might need to configure it similarly, to avoid seeing junk on screen (let us know). -Otherwise, you can set the \f[V]NO_COLOR\f[R] environment variable to 1 +Otherwise, you can set the \f[CR]NO_COLOR\f[R] environment variable to 1 to disable all ANSI output (see Colour). .SS Debug output -.PP We intend hledger to be relatively easy to troubleshoot, introspect and develop. -You can add \f[V]--debug[=N]\f[R] to any hledger command line to see +You can add \f[CR]--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[V]-o/--output-file\f[R] (unless you redirect stderr to stdout, eg: -\f[V]2>&1\f[R]). +\f[CR]-o/--output-file\f[R] (unless you redirect stderr to stdout, eg: +\f[CR]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 stderr, eg: .IP -.nf -\f[C] +.EX hledger bal --debug=3 2>hledger.log -\f[R] -.fi +.EE .SH Environment -.PP These environment variables affect hledger: .PP \f[B]COLUMNS\f[R] This is normally set by your terminal; some hledger -commands (\f[V]register\f[R]) will format their output to this width. +commands (\f[CR]register\f[R]) will format their output to this width. If not set, they will try to use the available terminal width. .PP \f[B]LEDGER_FILE\f[R] The main journal file to use when not specified -with \f[V]-f/--file\f[R]. -Default: \f[V]$HOME/.hledger.journal\f[R]. +with \f[CR]-f/--file\f[R]. +Default: \f[CR]$HOME/.hledger.journal\f[R]. .PP \f[B]NO_COLOR\f[R] If this environment variable is set (with any value), hledger will not use ANSI color codes in terminal output, unless -overridden by an explicit \f[V]--color/--colour\f[R] option. +overridden by an explicit \f[CR]--color/--colour\f[R] option. .SH PART 2: DATA FORMATS -.PP .SH Journal -.PP hledger\[aq]s default file format, representing a General Journal. Here\[aq]s a cheatsheet/mini-tutorial, or you can skip ahead to About journal format. .SS Journal cheatsheet .IP -.nf -\f[C] +.EX # Here is the main syntax of hledger\[aq]s journal format # (omitting extra Ledger compatibility syntax). # hledger journals contain comments, directives, and transactions, in any order: @@ -1248,14 +1165,12 @@ P 2022-01-01 AAAA $1.40 2022.01.01 These date 2022/1/1 formats are 12/31 also allowed (but consistent YYYY-MM-DD is recommended). -\f[R] -.fi +.EE .SS About journal format -.PP 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[V].journal\f[R], but that\[aq]s not +I use file names ending in \f[CR].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 @@ -1287,25 +1202,23 @@ A hledger journal file can contain three kinds of thing: file comments, transactions, and/or directives (counting periodic transaction rules and auto posting rules as directives). .SS Comments -.PP Lines in the journal will be ignored if they begin with a hash -(\f[V]#\f[R]) or a semicolon (\f[V];\f[R]). +(\f[CR]#\f[R]) or a semicolon (\f[CR];\f[R]). (See also Other syntax.) -hledger will also ignore regions beginning with a \f[V]comment\f[R] line -and ending with an \f[V]end comment\f[R] line (or file end). +hledger will also ignore regions beginning with a \f[CR]comment\f[R] +line and ending with an \f[CR]end comment\f[R] line (or file end). Here\[aq]s a suggestion for choosing between them: .IP \[bu] 2 -\f[V]#\f[R] for top-level notes +\f[CR]#\f[R] for top-level notes .IP \[bu] 2 -\f[V];\f[R] for commenting out things temporarily +\f[CR];\f[R] for commenting out things temporarily .IP \[bu] 2 -\f[V]comment\f[R] for quickly commenting large regions (remember +\f[CR]comment\f[R] for quickly commenting large regions (remember it\[aq]s there, or you might get confused) .PP Eg: .IP -.nf -\f[C] +.EX # a comment line ; another commentline comment @@ -1313,14 +1226,12 @@ A multi-line comment block, continuing until \[dq]end comment\[dq] directive or the end of the current file. end comment -\f[R] -.fi +.EE .PP Some hledger entries can have same-line comments attached to them, from ; (semicolon) to end of line. See Transaction comments, Posting comments, and Account comments below. .SS Transactions -.PP 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. @@ -1330,7 +1241,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[V]!\f[R], or \f[V]*\f[R]) +a status character (empty, \f[CR]!\f[R], or \f[CR]*\f[R]) .IP \[bu] 2 a code (any short number or text, enclosed in parentheses) .IP \[bu] 2 @@ -1345,68 +1256,57 @@ allowed, but not blank lines or non-indented lines). .PP Here\[aq]s a simple journal file containing one transaction: .IP -.nf -\f[C] +.EX 2008/01/01 income assets:bank:checking $1 income:salary $-1 -\f[R] -.fi +.EE .SS Dates .SS Simple dates -.PP Dates in the journal file use \f[I]simple dates\f[R] format: -\f[V]YYYY-MM-DD\f[R] or \f[V]YYYY/MM/DD\f[R] or \f[V]YYYY.MM.DD\f[R], +\f[CR]YYYY-MM-DD\f[R] or \f[CR]YYYY/MM/DD\f[R] or \f[CR]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 -\f[V]Y\f[R] directive, or the current date when the command is run. -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]. +\f[CR]Y\f[R] directive, or the current date when the command is run. +Some examples: \f[CR]2010-01-31\f[R], \f[CR]2010/01/31\f[R], +\f[CR]2010.1.31\f[R], \f[CR]1/31\f[R]. .PP (The UI also accepts simple dates, as well as the more flexible smart dates documented in the hledger manual.) .SS Posting dates -.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[V]date:DATE\f[R]. +like \f[CR]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 reconciliation: .IP -.nf -\f[C] +.EX 2015/5/30 expenses:food $10 ; food purchased on saturday 5/30 assets:checking ; bank cleared it on monday, date:6/1 -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger -f t.j register food 2015-05-30 expenses:food $10 $10 -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger -f t.j register checking 2015-06-01 assets:checking $-10 $-10 -\f[R] -.fi +.EE .PP DATE should be a simple date; if the year is not specified it will use the year of the transaction\[aq]s date. .PD 0 .P .PD -The \f[V]date:\f[R] tag must have a valid simple date value if it is -present, eg a \f[V]date:\f[R] tag with no value is not allowed. +The \f[CR]date:\f[R] tag must have a valid simple date value if it is +present, eg a \f[CR]date:\f[R] tag with no value is not allowed. .SS Status -.PP 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, @@ -1427,22 +1327,22 @@ T}@T{ unmarked T} T{ -\f[V]!\f[R] +\f[CR]!\f[R] T}@T{ pending T} T{ -\f[V]*\f[R] +\f[CR]*\f[R] T}@T{ cleared T} .TE .PP When reporting, you can filter by status with the -\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. +\f[CR]-U/--unmarked\f[R], \f[CR]-P/--pending\f[R], and +\f[CR]-C/--cleared\f[R] flags; or the \f[CR]status:\f[R], +\f[CR]status:!\f[R], and \f[CR]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] state is called \[dq]uncleared\[dq]. @@ -1488,54 +1388,47 @@ complete, reconciled as far as possible, and considered correct T} .TE .PP -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 +With this scheme, you would use \f[CR]-PC\f[R] to see the current +balance at your bank, \f[CR]-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 -.PP After the status mark, but before the description, you can optionally write a transaction \[dq]code\[dq], enclosed in parentheses. This is a good place to record a check number, or some other important transaction id or reference number. .SS Description -.PP A transaction\[aq]s description is the rest of the line following the date and status mark (or until a comment begins). Sometimes called the \[dq]narration\[dq] in traditional bookkeeping, it 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[V]|\f[R] (pipe) character in +You can optionally include a \f[CR]|\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[V]|\f[R]) and an -additional note field on the right (after the first \f[V]|\f[R]). +payee/payer name on the left (up to the first \f[CR]|\f[R]) and an +additional note field on the right (after the first \f[CR]|\f[R]). This may be worthwhile if you need to do more precise querying and pivoting by payee or by note. .SS Transaction comments -.PP -Text following \f[V];\f[R], after a transaction description, and/or on +Text following \f[CR];\f[R], after a transaction description, and/or on indented lines immediately below it, form comments for that transaction. -They are reproduced by \f[V]print\f[R] but otherwise ignored, except +They are reproduced by \f[CR]print\f[R] but otherwise ignored, except they may contain tags, which are not ignored. .IP -.nf -\f[C] +.EX 2012-01-01 something ; a transaction comment ; a second line of transaction comment expenses 1 assets -\f[R] -.fi +.EE .SS Postings -.PP 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: .IP \[bu] 2 -(optional) a status character (empty, \f[V]!\f[R], or \f[V]*\f[R]), +(optional) a status character (empty, \f[CR]!\f[R], or \f[CR]*\f[R]), followed by a space .IP \[bu] 2 (required) an account name (any text, optionally containing \f[B]single @@ -1556,7 +1449,6 @@ This makes it easy to write account names containing spaces. But if you accidentally leave only one space (or tab) before the amount, the amount will be considered part of the account name. .SS Account names -.PP Accounts are the main way of categorising things in hledger. As in Double Entry Bookkeeping, they can represent real world accounts (such as a bank account), or more abstract categories such as \[dq]money @@ -1564,38 +1456,34 @@ borrowed from Frank\[dq] or \[dq]money spent on electricity\[dq]. .PP You can use any account names you like, but we usually start with the traditional accounting categories, which in english are -\f[V]assets\f[R], \f[V]liabilities\f[R], \f[V]equity\f[R], -\f[V]revenues\f[R], \f[V]expenses\f[R]. +\f[CR]assets\f[R], \f[CR]liabilities\f[R], \f[CR]equity\f[R], +\f[CR]revenues\f[R], \f[CR]expenses\f[R]. (You might see these referred to as A, L, E, R, X for short.) .PP For more precise reporting, we usually divide the top level accounts into more detailed subaccounts, by writing a full colon between account name parts. -For example, from the account names \f[V]assets:bank:checking\f[R] and -\f[V]expenses:food\f[R], hledger will infer this hierarchy of five +For example, from the account names \f[CR]assets:bank:checking\f[R] and +\f[CR]expenses:food\f[R], hledger will infer this hierarchy of five accounts: .IP -.nf -\f[C] +.EX assets assets:bank assets:bank:checking expenses expenses:food -\f[R] -.fi +.EE .PP Shown as an outline, the hierarchical tree structure is more clear: .IP -.nf -\f[C] +.EX assets bank checking expenses food -\f[R] -.fi +.EE .PP hledger reports can summarise the account tree to any depth, so you can go as deep as you like with subcategories, but keeping your account @@ -1614,7 +1502,6 @@ meaning. Account names can be altered temporarily or permanently by account aliases. .SS Amounts -.PP After the account name, there is usually an amount. (Important: between account name and amount, there must be \f[B]two or more spaces\f[R].) @@ -1624,90 +1511,74 @@ international formats. Here are some examples. Amounts have a number (the \[dq]quantity\[dq]): .IP -.nf -\f[C] +.EX 1 -\f[R] -.fi +.EE .PP \&..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 space: .IP -.nf -\f[C] +.EX $1 4000 AAPL 3 \[dq]green apples\[dq] -\f[R] -.fi +.EE .PP 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 commodity symbol: .IP -.nf -\f[C] +.EX -$1 $-1 -\f[R] -.fi +.EE .PP One or more spaces between the sign and the number are acceptable when parsing (but they won\[aq]t be displayed in output): .IP -.nf -\f[C] +.EX + $1 $- 1 -\f[R] -.fi +.EE .PP Scientific E notation is allowed: .IP -.nf -\f[C] +.EX 1E-6 EUR 1E3 -\f[R] -.fi +.EE .SS Decimal marks, digit group marks -.PP A \f[I]decimal mark\f[R] can be written as a period or a comma: .IP -.nf -\f[C] +.EX 1.23 1,23 -\f[R] -.fi +.EE .PP In the integer part of the quantity (left of the decimal mark), groups of digits can optionally be separated by a \f[I]digit group mark\f[R] - a space, comma, or period (different from the decimal mark): .IP -.nf -\f[C] +.EX $1,000,000.00 EUR 2.000.000,00 INR 9,99,99,999.00 1 000 000.9455 -\f[R] -.fi +.EE .PP hledger is not biased towards period or comma decimal marks, so a number -containing just one period or comma, like \f[V]1,000\f[R] or -\f[V]1.000\f[R], is ambiguous. +containing just one period or comma, like \f[CR]1,000\f[R] or +\f[CR]1.000\f[R], is ambiguous. In such cases hledger assumes it is a decimal mark, parsing both of these as 1. .PP To disambiguate these and ensure accurate number parsing, especially if you use digit group marks, we recommend declaring the decimal mark. -You can declare it for each file with \f[V]decimal-mark\f[R] directives, -or for each commodity with \f[V]commodity\f[R] directives (described -below). +You can declare it for each file with \f[CR]decimal-mark\f[R] +directives, or for each commodity with \f[CR]commodity\f[R] directives +(described below). .SS Commodity -.PP Amounts in hledger have both a \[dq]quantity\[dq], which is a signed decimal number, and a \[dq]commodity\[dq], which is a currency symbol, stock ticker, or any word or phrase describing something you are @@ -1715,31 +1586,29 @@ tracking. .PP If the commodity name contains non-letters (spaces, numbers, or punctuation), you must always write it inside double quotes -(\f[V]\[dq]green apples\[dq]\f[R], \f[V]\[dq]ABC123\[dq]\f[R]). +(\f[CR]\[dq]green apples\[dq]\f[R], \f[CR]\[dq]ABC123\[dq]\f[R]). .PP If you write just a bare number, that too will have a commodity, with -name \f[V]\[dq]\[dq]\f[R]; we call that the \[dq]no-symbol +name \f[CR]\[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[V]1 USD, 2 EUR, 3.456 TSLA\f[R]. +\f[CR]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[V]Amount\f[R] and \f[V]MixedAmount\f[R] types.) +these are the \f[CR]Amount\f[R] and \f[CR]MixedAmount\f[R] types.) .SS Directives influencing number parsing and display -.PP -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 +You can add \f[CR]decimal-mark\f[R] and \f[CR]commodity\f[R] directives +to the journal, to declare and control these things more explicitly and precisely. These are described below, but here\[aq]s a quick example: .IP -.nf -\f[C] +.EX # the decimal mark character used by all amounts in this file (all commodities) decimal-mark . @@ -1748,28 +1617,26 @@ commodity $1,000.00 commodity EUR 1.000,00 commodity INR 9,99,99,999.00 commodity 1 000 000.9455 -\f[R] -.fi +.EE .PP .SS Commodity display style -.PP For the amounts in each commodity, hledger chooses a consistent display style (symbol placement, decimal mark and digit group marks, number of decimal digits) to use in most reports. This is inferred as follows: .PP -First, if there\[aq]s a \f[V]D\f[R] directive declaring a default +First, if there\[aq]s a \f[CR]D\f[R] directive declaring a default commodity, that commodity symbol and amount format is applied to all no-symbol amounts in the journal. .PP Then each commodity\[aq]s display style is determined from its -\f[V]commodity\f[R] directive. -We recommend always declaring commodities with \f[V]commodity\f[R] +\f[CR]commodity\f[R] directive. +We recommend always declaring commodities with \f[CR]commodity\f[R] directives, since they help ensure consistent display styles and precisions, and bring other benefits such as error checking for commodity symbols. .PP -But if a \f[V]commodity\f[R] directive is not present, hledger infers a +But if a \f[CR]commodity\f[R] directive is not present, hledger infers a commodity\[aq]s display styles from its amounts as they are written in the journal (excluding cost amounts and amounts in periodic transaction rules or auto posting rules). @@ -1782,13 +1649,12 @@ the digit group marks of the first amount with digit group marks and the maximum number of decimal digits seen across all amounts. .PP And as fallback if no applicable amounts are found, it would use a -default style, like \f[V]$1000.00\f[R] (symbol on the left with no +default style, like \f[CR]$1000.00\f[R] (symbol on the left with no space, period as decimal mark, and two decimal digits). .PP Finally, commodity styles can be overridden by the -\f[V]-c/--commodity-style\f[R] command line option. +\f[CR]-c/--commodity-style\f[R] command line option. .SS Rounding -.PP Amounts are stored internally as decimal numbers with up to 255 decimal places. They are displayed with their original journal precisions by print and @@ -1800,10 +1666,9 @@ nearest even digit). So eg 0.5 displayed with zero decimal digits appears as \[dq]0\[dq]. .PP .SS Costs -.PP After a posting amount, you can note its cost (when buying) or selling price (when selling) in another commodity, by writing either -\f[V]\[at] UNITPRICE\f[R] or \f[V]\[at]\[at] TOTALPRICE\f[R] after it. +\f[CR]\[at] UNITPRICE\f[R] or \f[CR]\[at]\[at] TOTALPRICE\f[R] after it. This indicates a conversion transaction, where one commodity is exchanged for another. .PP @@ -1813,8 +1678,8 @@ reminded that it is a price specific to a transaction, but we now just call it \[dq]cost\[dq], with the understanding that the transaction could be a purchase or a sale.) .PP -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 +Costs are usually written explicitly with \f[CR]\[at]\f[R] or +\f[CR]\[at]\[at]\f[R], but can also be inferred automatically for simple multi-commodity transactions. Note, if costs are inferred, the order of postings is significant; the first posting will have a cost attached, in the commodity of the second. @@ -1823,48 +1688,43 @@ 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[V]\[at] UNITPRICE\f[R] after the amount: -.RS 4 -.IP -.nf -\f[C] -2009/1/1 - assets:euros €100 \[at] $1.35 ; one hundred euros purchased at $1.35 each - assets:dollars ; balancing amount is -$135.00 -\f[R] -.fi -.RE -.IP "2." 3 -Write the total price, as \f[V]\[at]\[at] TOTALPRICE\f[R] after the +Write the price per unit, as \f[CR]\[at] UNITPRICE\f[R] after the amount: .RS 4 .IP -.nf -\f[C] +.EX +2009/1/1 + assets:euros €100 \[at] $1.35 ; one hundred euros purchased at $1.35 each + assets:dollars ; balancing amount is -$135.00 +.EE +.RE +.IP "2." 3 +Write the total price, as \f[CR]\[at]\[at] TOTALPRICE\f[R] after the +amount: +.RS 4 +.IP +.EX 2009/1/1 assets:euros €100 \[at]\[at] $135 ; one hundred euros purchased at $135 for the lot assets:dollars -\f[R] -.fi +.EE .RE .IP "3." 3 Specify amounts for all postings, using exactly two commodities, and let hledger infer the price that balances the transaction. Note the effect of posting order: the price is added to first posting, -making it \f[V]€100 \[at]\[at] $135\f[R], as in example 2: +making it \f[CR]€100 \[at]\[at] $135\f[R], as in example 2: .RS 4 .IP -.nf -\f[C] +.EX 2009/1/1 assets:euros €100 ; one hundred euros purchased assets:dollars $-135 ; for $135 -\f[R] -.fi +.EE .RE .PP Amounts can be converted to cost at report time using the -\f[V]-B/--cost\f[R] flag; this is discussed more in the Cost reporting +\f[CR]-B/--cost\f[R] flag; this is discussed more in the Cost reporting section. .PP Note that the cost normally should be a positive amount, though it\[aq]s @@ -1872,11 +1732,10 @@ not required to be. This can be a little confusing, see discussion at --infer-market-prices: market prices from transactions. .SS Other cost/lot notations -.PP A slight digression for Ledger and Beancount users. Ledger has a number of cost/lot-related notations: .IP \[bu] 2 -\f[V]\[at] UNITCOST\f[R] and \f[V]\[at]\[at] TOTALCOST\f[R] +\f[CR]\[at] UNITCOST\f[R] and \f[CR]\[at]\[at] TOTALCOST\f[R] .RS 2 .IP \[bu] 2 expresses a conversion rate, as in hledger @@ -1884,18 +1743,18 @@ expresses a conversion rate, as in hledger when buying, also creates a lot than can be selected at selling time .RE .IP \[bu] 2 -\f[V](\[at]) UNITCOST\f[R] and \f[V](\[at]\[at]) TOTALCOST\f[R] (virtual -cost) +\f[CR](\[at]) UNITCOST\f[R] and \f[CR](\[at]\[at]) TOTALCOST\f[R] +(virtual cost) .RS 2 .IP \[bu] 2 like the above, but also means \[dq]this cost was exceptional, don\[aq]t use it when inferring market prices\[dq]. .RE .PP -Currently, hledger treats the above like \f[V]\[at]\f[R] and -\f[V]\[at]\[at]\f[R]; the parentheses are ignored. +Currently, hledger treats the above like \f[CR]\[at]\f[R] and +\f[CR]\[at]\[at]\f[R]; the parentheses are ignored. .IP \[bu] 2 -\f[V]{=FIXEDUNITCOST}\f[R] and \f[V]{{=FIXEDTOTALCOST}}\f[R] (fixed +\f[CR]{=FIXEDUNITCOST}\f[R] and \f[CR]{{=FIXEDTOTALCOST}}\f[R] (fixed price) .RS 2 .IP \[bu] 2 @@ -1903,17 +1762,17 @@ when buying, means \[dq]this cost is also the fixed price, don\[aq]t let it fluctuate in value reports\[dq] .RE .IP \[bu] 2 -\f[V]{UNITCOST}\f[R] and \f[V]{{TOTALCOST}}\f[R] (lot price) +\f[CR]{UNITCOST}\f[R] and \f[CR]{{TOTALCOST}}\f[R] (lot price) .RS 2 .IP \[bu] 2 -can be used identically to \f[V]\[at] UNITCOST\f[R] and -\f[V]\[at]\[at] TOTALCOST\f[R], also creates a lot +can be used identically to \f[CR]\[at] UNITCOST\f[R] and +\f[CR]\[at]\[at] TOTALCOST\f[R], also creates a lot .IP \[bu] 2 -when selling, combined with \f[V]\[at] ...\f[R], specifies an investment -lot by its cost basis; does not check if that lot is present +when selling, combined with \f[CR]\[at] ...\f[R], specifies an +investment lot by its cost basis; does not check if that lot is present .RE .IP \[bu] 2 -and related: \f[V][YYYY/MM/DD]\f[R] (lot date) +and related: \f[CR][YYYY/MM/DD]\f[R] (lot date) .RS 2 .IP \[bu] 2 when buying, attaches this acquisition date to the lot @@ -1921,7 +1780,7 @@ when buying, attaches this acquisition date to the lot when selling, selects a lot by its acquisition date .RE .IP \[bu] 2 -\f[V](SOME TEXT)\f[R] (lot note) +\f[CR](SOME TEXT)\f[R] (lot note) .RS 2 .IP \[bu] 2 when buying, attaches this note to the lot @@ -1935,17 +1794,17 @@ the posting amount, but ignores them. .PP For Beancount users, the notation and behaviour is different: .IP \[bu] 2 -\f[V]\[at] UNITCOST\f[R] and \f[V]\[at]\[at] TOTALCOST\f[R] +\f[CR]\[at] UNITCOST\f[R] and \f[CR]\[at]\[at] TOTALCOST\f[R] .RS 2 .IP \[bu] 2 expresses a cost without creating a lot, as in hledger .IP \[bu] 2 when buying (augmenting) or selling (reducing) a lot, combined with -\f[V]{...}\f[R]: documents the cost/selling price (not used for +\f[CR]{...}\f[R]: documents the cost/selling price (not used for transaction balancing) .RE .IP \[bu] 2 -\f[V]{UNITCOST}\f[R] and \f[V]{{TOTALCOST}}\f[R] +\f[CR]{UNITCOST}\f[R] and \f[CR]{{TOTALCOST}}\f[R] .RS 2 .IP \[bu] 2 when buying (augmenting), expresses the cost for transaction balancing, @@ -1964,23 +1823,21 @@ expresses the selling price for transaction balancing .RE .PP Currently, hledger accepts the -\f[V]{UNITCOST}\f[R]/\f[V]{{TOTALCOST}}\f[R] notation but ignores it. +\f[CR]{UNITCOST}\f[R]/\f[CR]{{TOTALCOST}}\f[R] notation but ignores it. .IP \[bu] 2 -variations: \f[V]{}\f[R], \f[V]{YYYY-MM-DD}\f[R], -\f[V]{\[dq]LABEL\[dq]}\f[R], \f[V]{UNITCOST, \[dq]LABEL\[dq]}\f[R], -\f[V]{UNITCOST, YYYY-MM-DD, \[dq]LABEL\[dq]}\f[R] etc. +variations: \f[CR]{}\f[R], \f[CR]{YYYY-MM-DD}\f[R], +\f[CR]{\[dq]LABEL\[dq]}\f[R], \f[CR]{UNITCOST, \[dq]LABEL\[dq]}\f[R], +\f[CR]{UNITCOST, YYYY-MM-DD, \[dq]LABEL\[dq]}\f[R] etc. .PP Currently, hledger rejects these. .SS Balance assertions -.PP hledger supports Ledger-style balance assertions in journal files. -These look like, for example, \f[V]= EXPECTEDBALANCE\f[R] following a +These look like, for example, \f[CR]= 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: .IP -.nf -\f[C] +.EX 2013/1/1 a $1 =$1 b =$-1 @@ -1988,20 +1845,18 @@ each posting: 2013/1/2 a $1 =$2 b $-1 =$-2 -\f[R] -.fi +.EE .PP After reading a journal file, hledger will check all balance assertions 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[V]-I/--ignore-assertions\f[R] flag, which can be useful for +\f[CR]-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, described below). .SS Assertions and ordering -.PP hledger sorts an account\[aq]s postings and assertions first by date and then (for postings on the same day) by parse order. Note this is different from Ledger, which sorts assertions only by parse @@ -2017,8 +1872,7 @@ 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. .SS Assertions and multiple included files -.PP -Multiple files included with the \f[V]include\f[R] directive are +Multiple files included with the \f[CR]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 @@ -2029,17 +1883,15 @@ across multiple files, and you want to assert the account\[aq]s balance 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[V]include\f[R], when multiple files are specified on the -command line with multiple \f[V]-f/--file\f[R] options, balance +Unlike \f[CR]include\f[R], when multiple files are specified on the +command line with multiple \f[CR]-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[V]include\f[R], or concatenate the files temporarily. +\f[CR]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 fact the assertion checks only this commodity\[aq]s balance within the (possibly multi-commodity) account balance. @@ -2050,12 +1902,11 @@ 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[V]== EXPECTEDBALANCE\f[R]). +double equals sign (\f[CR]== 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 -.nf -\f[C] +.EX 2013/1/1 a $1 a 1€ @@ -2070,15 +1921,13 @@ the asserted one (or at least, that their balance is 0). 2013/1/3 ; This assertion fails as \[aq]a\[aq] also contains 1€ a 0 == $1 -\f[R] -.fi +.EE .PP It\[aq]s not yet possible to make a complete assertion about a balance that has multiple commodities. One workaround is to isolate each commodity into its own subaccount: .IP -.nf -\f[C] +.EX 2013/1/1 a:usd $1 a:euro 1€ @@ -2088,19 +1937,15 @@ One workaround is to isolate each commodity into its own subaccount: a 0 == 0 a:usd 0 == $1 a:euro 0 == 1€ -\f[R] -.fi +.EE .SS Assertions and prices -.PP Balance assertions ignore costs, and should normally be written without one: .IP -.nf -\f[C] +.EX 2019/1/1 (a) $1 \[at] €1 = $1 -\f[R] -.fi +.EE .PP We do allow prices to be written there, however, and print shows them, even though they don\[aq]t affect whether the assertion passes or fails. @@ -2108,69 +1953,59 @@ This is for backward compatibility (hledger\[aq]s close command used to 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[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[V]=*\f[R] -or \f[V]==*\f[R], eg: +The balance assertions above (\f[CR]=\f[R] and \f[CR]==\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[CR]=*\f[R] or \f[CR]==*\f[R], eg: .IP -.nf -\f[C] +.EX 2019/1/1 equity:opening balances checking:a 5 checking:b 5 checking 1 ==* 11 -\f[R] -.fi +.EE .SS Assertions and virtual postings -.PP Balance assertions always consider both real and virtual postings; they -are not affected by the \f[V]--real/-R\f[R] flag or \f[V]real:\f[R] +are not affected by the \f[CR]--real/-R\f[R] flag or \f[CR]real:\f[R] query. .SS Assertions and auto postings -.PP -Balance assertions \f[I]are\f[R] affected by the \f[V]--auto\f[R] flag, +Balance assertions \f[I]are\f[R] affected by the \f[CR]--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[V]--auto\f[R], and always use -\f[V]--auto\f[R] with that file +assert the balance calculated with \f[CR]--auto\f[R], and always use +\f[CR]--auto\f[R] with that file .IP \[bu] 2 -or assert the balance calculated without \f[V]--auto\f[R], and never use -\f[V]--auto\f[R] with that file +or assert the balance calculated without \f[CR]--auto\f[R], and never +use \f[CR]--auto\f[R] with that file .IP \[bu] 2 or avoid balance assertions on accounts affected by auto postings (or avoid auto postings entirely). .SS Assertions and precision -.PP 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 assertions. Balance assertion failure messages show exact amounts. .SS Posting comments -.PP -Text following \f[V];\f[R], at the end of a posting line, and/or on +Text following \f[CR];\f[R], at the end of a posting line, and/or on indented lines immediately below it, form comments for that posting. -They are reproduced by \f[V]print\f[R] but otherwise ignored, except +They are reproduced by \f[CR]print\f[R] but otherwise ignored, except they may contain tags, which are not ignored. .IP -.nf -\f[C] +.EX 2012-01-01 expenses 1 ; a comment for posting 1 assets ; a comment for posting 2 ; a second comment line for posting 2 -\f[R] -.fi +.EE .SS Tags -.PP Tags are a way to add extra labels or labelled data to transactions, postings, or accounts, which you can then search or pivot on. .PP @@ -2182,16 +2017,14 @@ ignored.) Eg, here four different tags are recorded: one on the checking account, two on the transaction, and one on the expenses posting: .IP -.nf -\f[C] +.EX account assets:checking ; accounttag: 2017/1/16 bought groceries ; transactiontag-1: ; transactiontag-2: assets:checking $-1 expenses:food $1 ; postingtag: -\f[R] -.fi +.EE .PP Postings also inherit tags from their transaction and their account. And transactions also acquire tags from their postings (and @@ -2200,21 +2033,18 @@ So in the example above, the expenses posting effectively has all four tags (by inheriting from account and transaction), and the transaction also has all four tags (by acquiring from the expenses posting). .PP -You can list tag names with \f[V]hledger tags [NAMEREGEX]\f[R], or match -by tag name with a \f[V]tag:NAMEREGEX\f[R] query. +You can list tag names with \f[CR]hledger tags [NAMEREGEX]\f[R], or +match by tag name with a \f[CR]tag:NAMEREGEX\f[R] query. .SS Tag values -.PP Tags can have a value, which is any text after the colon up until a comma or end of line (with surrounding whitespace removed). Note this means that hledger tag values can not contain commas. Eg in the following posting, the three tags\[aq] values are \[dq]value 1\[dq], \[dq]value 2\[dq], and \[dq]\[dq] (empty) respectively: .IP -.nf -\f[C] +.EX expenses:food $10 ; foo, tag1: value 1 , tag2:value 2, bar tag3: , baz -\f[R] -.fi +.EE .PP Note that tags can be repeated, and are additive rather than overriding: when the same tag name is seen again with a new value, the new @@ -2222,12 +2052,11 @@ name:value pair is added to the tags. (It is not possible to override a tag\[aq]s value or remove a tag.) .PP You can list a tag\[aq]s values with -\f[V]hledger tags TAGNAME --values\f[R], or match by tag value with a -\f[V]tag:NAMEREGEX=VALUEREGEX\f[R] query. +\f[CR]hledger tags TAGNAME --values\f[R], or match by tag value with a +\f[CR]tag:NAMEREGEX=VALUEREGEX\f[R] query. .SS Directives -.PP Besides transactions, there is something else you can put in a -\f[V]journal\f[R] file: directives. +\f[CR]journal\f[R] file: directives. These are declarations, beginning with a keyword, that modify hledger\[aq]s behaviour. Some directives can have more specific subdirectives, indented below @@ -2253,22 +2082,22 @@ T} T{ Rewrite account names T}@T{ -\f[V]alias\f[R] +\f[CR]alias\f[R] T} T{ Comment out sections of the file T}@T{ -\f[V]comment\f[R] +\f[CR]comment\f[R] T} T{ Declare file\[aq]s decimal mark, to help parse amounts accurately T}@T{ -\f[V]decimal-mark\f[R] +\f[CR]decimal-mark\f[R] T} T{ Include other data files T}@T{ -\f[V]include\f[R] +\f[CR]include\f[R] T} T{ \f[B]GENERATING DATA:\f[R] @@ -2277,12 +2106,12 @@ T} T{ Generate recurring transactions or budget goals T}@T{ -\f[V]\[ti]\f[R] +\f[CR]\[ti]\f[R] T} T{ Generate extra postings on existing transactions T}@T{ -\f[V]=\f[R] +\f[CR]=\f[R] T} T{ \f[B]CHECKING FOR ERRORS:\f[R] @@ -2291,7 +2120,8 @@ T} T{ Define valid entities to provide more error checking T}@T{ -\f[V]account\f[R], \f[V]commodity\f[R], \f[V]payee\f[R], \f[V]tag\f[R] +\f[CR]account\f[R], \f[CR]commodity\f[R], \f[CR]payee\f[R], +\f[CR]tag\f[R] T} T{ \f[B]REPORTING:\f[R] @@ -2300,29 +2130,28 @@ T} T{ Declare accounts\[aq] type and display order T}@T{ -\f[V]account\f[R] +\f[CR]account\f[R] T} T{ Declare commodity display styles T}@T{ -\f[V]commodity\f[R] +\f[CR]commodity\f[R] T} T{ Declare market prices T}@T{ -\f[V]P\f[R] +\f[CR]P\f[R] T} .TE .SS Directives and multiple files -.PP Directives vary in their scope, ie which journal entries and which input files they affect. Most often, a directive will affect the following entries and included files if any, until the end of the current file - and no further. You might find this inconvenient! -For example, \f[V]alias\f[R] directives do not affect parent or sibling +For example, \f[CR]alias\f[R] directives do not affect parent or sibling files. -But there are usually workarounds; for example, put \f[V]alias\f[R] +But there are usually workarounds; for example, put \f[CR]alias\f[R] directives in your top-most file, before including other files. .PP The restriction, though it may be annoying at first, is in a good cause; @@ -2331,7 +2160,6 @@ order of input. Without it, reports could show different numbers depending on the order of -f options, or the positions of include directives in your files. .SS Directive effects -.PP Here are all hledger\[aq]s directives, with their effects and scope summarised - nine main directives, plus four others which we consider non-essential: @@ -2348,7 +2176,7 @@ ends at file end? T} _ T{ -\f[B]\f[VB]account\f[B]\f[R] +\f[B]\f[CB]account\f[B]\f[R] T}@T{ Declares an account, for checking all entries in all files; and its display order and type. @@ -2357,68 +2185,68 @@ T}@T{ N T} T{ -\f[B]\f[VB]alias\f[B]\f[R] +\f[B]\f[CB]alias\f[B]\f[R] T}@T{ Rewrites account names, in following entries until end of current file -or \f[V]end aliases\f[R]. -Command line equivalent: \f[V]--alias\f[R] +or \f[CR]end aliases\f[R]. +Command line equivalent: \f[CR]--alias\f[R] T}@T{ Y T} T{ -\f[B]\f[VB]comment\f[B]\f[R] +\f[B]\f[CB]comment\f[B]\f[R] T}@T{ Ignores part of the journal file, until end of current file or -\f[V]end comment\f[R]. +\f[CR]end comment\f[R]. T}@T{ Y T} T{ -\f[B]\f[VB]commodity\f[B]\f[R] +\f[B]\f[CB]commodity\f[B]\f[R] T}@T{ Declares up to four things: 1. a commodity symbol, for checking all amounts in all files 2. the decimal mark for parsing amounts of this commodity, in the following -entries until end of current file (if there is no \f[V]decimal-mark\f[R] -directive) 3. +entries until end of current file (if there is no +\f[CR]decimal-mark\f[R] directive) 3. and the display style for amounts of this commodity 4. which is also the precision to use for balanced-transaction checking in this commodity. -Takes precedence over \f[V]D\f[R]. -Subdirectives: \f[V]format\f[R] (Ledger-compatible syntax). -Command line equivalent: \f[V]-c/--commodity-style\f[R] +Takes precedence over \f[CR]D\f[R]. +Subdirectives: \f[CR]format\f[R] (Ledger-compatible syntax). +Command line equivalent: \f[CR]-c/--commodity-style\f[R] T}@T{ N,Y,N,N T} T{ -\f[B]\f[VB]decimal-mark\f[B]\f[R] +\f[B]\f[CB]decimal-mark\f[B]\f[R] T}@T{ Declares the decimal mark, for parsing amounts of all commodities in -following entries until next \f[V]decimal-mark\f[R] or end of current +following entries until next \f[CR]decimal-mark\f[R] or end of current file. Included files can override. -Takes precedence over \f[V]commodity\f[R] and \f[V]D\f[R]. +Takes precedence over \f[CR]commodity\f[R] and \f[CR]D\f[R]. T}@T{ Y T} T{ -\f[B]\f[VB]include\f[B]\f[R] +\f[B]\f[CB]include\f[B]\f[R] T}@T{ Includes entries and directives from another file, as if they were written inline. -Command line alternative: multiple \f[V]-f/--file\f[R] +Command line alternative: multiple \f[CR]-f/--file\f[R] T}@T{ N T} T{ -\f[B]\f[VB]payee\f[B]\f[R] +\f[B]\f[CB]payee\f[B]\f[R] T}@T{ Declares a payee name, for checking all entries in all files. T}@T{ N T} T{ -\f[B]\f[VB]P\f[B]\f[R] +\f[B]\f[CB]P\f[B]\f[R] T}@T{ Declares the market price of a commodity on some date, for value reports. @@ -2426,11 +2254,11 @@ T}@T{ N T} T{ -\f[B]\f[VB]\[ti]\f[B]\f[R] (tilde) +\f[B]\f[CB]\[ti]\f[B]\f[R] (tilde) T}@T{ Declares a periodic transaction rule that generates future transactions -with \f[V]--forecast\f[R] and budget goals with -\f[V]balance --budget\f[R]. +with \f[CR]--forecast\f[R] and budget goals with +\f[CR]balance --budget\f[R]. T}@T{ N T} @@ -2440,24 +2268,24 @@ T}@T{ T}@T{ T} T{ -\f[B]\f[VB]apply account\f[B]\f[R] +\f[B]\f[CB]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[V]end apply account\f[R]. +entries until end of current file or \f[CR]end apply account\f[R]. T}@T{ Y T} T{ -\f[B]\f[VB]D\f[B]\f[R] +\f[B]\f[CB]D\f[B]\f[R] T}@T{ Sets a default commodity to use for no-symbol amounts;and, if there is -no \f[V]commodity\f[R] directive for this commodity: its decimal mark, +no \f[CR]commodity\f[R] directive for this commodity: its decimal mark, balancing precision, and display style, as above. T}@T{ Y,Y,N,N T} T{ -\f[B]\f[VB]Y\f[B]\f[R] +\f[B]\f[CB]Y\f[B]\f[R] T}@T{ Sets a default year to use for any yearless dates, in following entries until end of current file. @@ -2465,10 +2293,10 @@ T}@T{ Y T} T{ -\f[B]\f[VB]=\f[B]\f[R] (equals) +\f[B]\f[CB]=\f[B]\f[R] (equals) T}@T{ Declares an auto posting rule that generates extra postings on matched -transactions with \f[V]--auto\f[R], in current, parent, and child files +transactions with \f[CR]--auto\f[R], in current, parent, and child files (but not sibling files, see #1212). T}@T{ partly @@ -2480,9 +2308,8 @@ Other directives from Ledger\[aq]s file format are accepted but ignored. T}@T{ T} .TE -.SS \f[V]account\f[R] directive -.PP -\f[V]account\f[R] directives can be used to declare accounts (ie, the +.SS \f[CR]account\f[R] directive +\f[CR]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 @@ -2505,55 +2332,44 @@ 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[V]account\f[R] followed by a +They are written as the word \f[CR]account\f[R] followed by a hledger-style account name, eg: .IP -.nf -\f[C] +.EX account assets:bank:checking -\f[R] -.fi +.EE .PP Note, however, that accounts declared in account directives are not allowed to have surrounding brackets and parentheses, unlike accounts used in postings. So the following journal will not parse: .IP -.nf -\f[C] +.EX account (assets:bank:checking) -\f[R] -.fi +.EE .SS Account comments -.PP -Text following \f[B]two or more spaces\f[R] and \f[V];\f[R] at the end -of an account directive line, and/or following \f[V];\f[R] on indented +Text following \f[B]two or more spaces\f[R] and \f[CR];\f[R] at the end +of an account directive line, and/or following \f[CR];\f[R] on indented lines immediately below it, form comments for that account. They are ignored except they may contain tags, which are not ignored. .PP The two-space requirement for same-line account comments is because -\f[V];\f[R] is allowed in account names. +\f[CR];\f[R] is allowed in account names. .IP -.nf -\f[C] +.EX account assets:bank:checking ; same-line comment, at least 2 spaces before the semicolon ; next-line comment ; some tags - type:A, acctnum:12345 -\f[R] -.fi +.EE .SS Account subdirectives -.PP Ledger-style indented subdirectives are also accepted, but currently ignored: .IP -.nf -\f[C] +.EX account assets:bank:checking format subdirective is ignored -\f[R] -.fi +.EE .SS Account error checking -.PP By default, accounts need not be declared; they come into existence when a posting references them. This is convenient, but it means hledger can\[aq]t warn you when you @@ -2561,7 +2377,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[V]-s\f[R]/\f[V]--strict\f[R] flag, +In strict mode, enabled with the \f[CR]-s\f[R]/\f[CR]--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: @@ -2576,41 +2392,36 @@ 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[V]journal\f[R] files, but will +Accounts can only be declared in \f[CR]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 subaccounts\[dq] with a wildcard; every account posted to must be declared. .SS Account display order -.PP 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: .IP -.nf -\f[C] +.EX account assets account liabilities account equity account revenues account expenses -\f[R] -.fi +.EE .PP those accounts will be displayed in declaration order: .IP -.nf -\f[C] +.EX $ hledger accounts -1 assets liabilities equity revenues expenses -\f[R] -.fi +.EE .PP Any undeclared accounts are displayed last, in alphabetical order. .PP @@ -2618,63 +2429,59 @@ Sorting is done at each level of the account tree, within each group of sibling accounts under the same parent. And currently, this directive: .IP -.nf -\f[C] +.EX account other:zoo -\f[R] -.fi +.EE .PP -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. +would influence the position of \f[CR]zoo\f[R] among +\f[CR]other\f[R]\[aq]s subaccounts, but not the position of +\f[CR]other\f[R] among the top-level accounts. This means: .IP \[bu] 2 -you will sometimes declare parent accounts (eg \f[V]account other\f[R] +you will sometimes declare parent accounts (eg \f[CR]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[V]x:y\f[R] -in between \f[V]a:b\f[R] and \f[V]a:c\f[R]). +sibling accounts stay together (you couldn\[aq]t display \f[CR]x:y\f[R] +in between \f[CR]a:b\f[R] and \f[CR]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[V]type:\f[R] query. +filtering by account type with the \f[CR]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[V]type:\f[R] tag to your top-level account directives. +\f[CR]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[V]A\f[R] or \f[V]Asset\f[R] (things you own) +\f[CR]A\f[R] or \f[CR]Asset\f[R] (things you own) .IP \[bu] 2 -\f[V]L\f[R] or \f[V]Liability\f[R] (things you owe) +\f[CR]L\f[R] or \f[CR]Liability\f[R] (things you owe) .IP \[bu] 2 -\f[V]E\f[R] or \f[V]Equity\f[R] (investment/ownership; balanced +\f[CR]E\f[R] or \f[CR]Equity\f[R] (investment/ownership; balanced counterpart of assets & liabilities) .IP \[bu] 2 -\f[V]R\f[R] or \f[V]Revenue\f[R] (what you received money from, AKA +\f[CR]R\f[R] or \f[CR]Revenue\f[R] (what you received money from, AKA income; technically part of Equity) .IP \[bu] 2 -\f[V]X\f[R] or \f[V]Expense\f[R] (what you spend money on; technically +\f[CR]X\f[R] or \f[CR]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[V]C\f[R] or \f[V]Cash\f[R] (a subtype of Asset, indicating liquid +\f[CR]C\f[R] or \f[CR]Cash\f[R] (a subtype of Asset, indicating liquid assets for the cashflow report) .IP \[bu] 2 -\f[V]V\f[R] or \f[V]Conversion\f[R] (a subtype of Equity, for +\f[CR]V\f[R] or \f[CR]Conversion\f[R] (a subtype of Equity, for conversions (see Cost reporting).) .PP Here is a typical set of account type declarations: .IP -.nf -\f[C] +.EX account assets ; type: A account liabilities ; type: L account equity ; type: E @@ -2685,8 +2492,7 @@ account assets:bank ; type: C account assets:cash ; type: C account equity:conversion ; type: V -\f[R] -.fi +.EE .PP Here are some tips for working with account types. .IP \[bu] 2 @@ -2697,8 +2503,7 @@ types. See also Regular expressions. .RS 2 .IP -.nf -\f[C] +.EX If account\[aq]s name contains this (CI) regular expression: | its type is: --------------------------------------------------------------------|------------- \[ha]assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|current)(:|$) | Cash @@ -2708,8 +2513,7 @@ If account\[aq]s name contains this (CI) regular expression: | its ty \[ha]equity(:|$) | Equity \[ha](income|revenue)s?(:|$) | Revenue \[ha]expenses?(:|$) | Expense -\f[R] -.fi +.EE .RE .IP \[bu] 2 If you declare any account types, it\[aq]s a good idea to declare an @@ -2725,9 +2529,9 @@ More precisely, an account\[aq]s type is decided by the first of these that exists: .RS 2 .IP "1." 3 -A \f[V]type:\f[R] declaration for this account. +A \f[CR]type:\f[R] declaration for this account. .IP "2." 3 -A \f[V]type:\f[R] declaration in the parent accounts above it, +A \f[CR]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. @@ -2741,14 +2545,11 @@ Otherwise, it will have no type. For troubleshooting, you can list accounts and their types with: .RS 2 .IP -.nf -\f[C] +.EX $ hledger accounts --types [ACCTPAT] [-DEPTH] [type:TYPECODES] -\f[R] -.fi +.EE .RE -.SS \f[V]alias\f[R] directive -.PP +.SS \f[CR]alias\f[R] directive You can define account alias rules which rewrite your account names, or parts of them, before generating reports. This can be useful for: @@ -2775,20 +2576,17 @@ invalid account names with them; more on this below. .PP See also Rewrite account names. .SS Basic aliases -.PP -To set an account alias, use the \f[V]alias\f[R] directive in your +To set an account alias, use the \f[CR]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). The spaces around the = are optional: .IP -.nf -\f[C] +.EX alias OLD = NEW -\f[R] -.fi +.EE .PP -Or, you can use the \f[V]--alias \[aq]OLD=NEW\[aq]\f[R] option on the +Or, you can use the \f[CR]--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. @@ -2799,14 +2597,11 @@ one. Subaccounts are also affected. Eg: .IP -.nf -\f[C] +.EX alias checking = assets:bank:wells fargo:checking ; rewrites \[dq]checking\[dq] to \[dq]assets:bank:wells fargo:checking\[dq], or \[dq]checking:a\[dq] to \[dq]assets:bank:wells fargo:checking:a\[dq] -\f[R] -.fi +.EE .SS Regex aliases -.PP 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 @@ -2814,41 +2609,34 @@ regular expression.) .PP Eg: .IP -.nf -\f[C] +.EX alias /REGEX/ = REPLACEMENT -\f[R] -.fi +.EE .PP or: .IP -.nf -\f[C] +.EX $ hledger --alias \[aq]/REGEX/=REPLACEMENT\[aq] ... -\f[R] -.fi +.EE .PP Any part of an account name matched by REGEX will be replaced by REPLACEMENT. REGEX is case-insensitive as usual. .PP If you need to match a forward slash, escape it with a backslash, eg -\f[V]/\[rs]/=:\f[R]. +\f[CR]/\[rs]/=:\f[R]. .PP If REGEX contains parenthesised match groups, these can be referenced by the usual backslash and number in REPLACEMENT: .IP -.nf -\f[C] +.EX alias /\[ha](.+):bank:([\[ha]:]+):(.*)/ = \[rs]1:\[rs]2 \[rs]3 ; rewrites \[dq]assets:bank:wells fargo:checking\[dq] to \[dq]assets:wells fargo checking\[dq] -\f[R] -.fi +.EE .PP REPLACEMENT continues to the end of line (or on command line, to end of option argument), so it can contain trailing whitespace. .SS Combining aliases -.PP You can define as many aliases as you like, using journal directives and/or command line options. .PP @@ -2860,10 +2648,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[V]alias\f[R] directives preceding the journal entry, most recently +\f[CR]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[V]--alias\f[R] options, in the order they appeared on the command +\f[CR]--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: @@ -2878,38 +2666,32 @@ 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[V]--debug=6\f[R] to the command line will +In case of trouble, adding \f[CR]--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[V]alias\f[R] +As explained at Directives and multiple files, \f[CR]alias\f[R] directives do not affect parent or sibling files. Eg in this command, .IP -.nf -\f[C] +.EX hledger -f a.aliases -f b.journal -\f[R] -.fi +.EE .PP account aliases defined in a.aliases will not affect b.journal. Including the aliases doesn\[aq]t work either: .IP -.nf -\f[C] +.EX include a.aliases 2023-01-01 ; not affected by a.aliases foo 1 bar -\f[R] -.fi +.EE .PP This means that account aliases should usually be declared at the start of your top-most file, like this: .IP -.nf -\f[C] +.EX alias foo=Foo alias bar=Bar @@ -2918,62 +2700,48 @@ alias bar=Bar bar include c.journal ; also affected -\f[R] -.fi -.SS \f[V]end aliases\f[R] directive -.PP +.EE +.SS \f[CR]end aliases\f[R] directive You can clear (forget) all currently defined aliases (seen in the journal so far, or defined on the command line) with this directive: .IP -.nf -\f[C] +.EX end aliases -\f[R] -.fi +.EE .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[V]print\f[R] output. +could cause confusing reports or invalid \f[CR]print\f[R] output. For example, you could erase all account names: .IP -.nf -\f[C] +.EX 2021-01-01 a:aa 1 b -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger print --alias \[aq]/.*/=\[aq] 2021-01-01 1 -\f[R] -.fi +.EE .PP -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] +The above \f[CR]print\f[R] output is not a valid journal. +Or you could insert an illegal double space, causing \f[CR]print\f[R] output that would give a different journal when reparsed: .IP -.nf -\f[C] +.EX 2021-01-01 old 1 other -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger print --alias old=\[dq]new USD\[dq] | hledger -f- print 2021-01-01 new USD 1 other -\f[R] -.fi +.EE .SS Aliases and account types -.PP If an account with a type declaration (see Declaring accounts > Account types) is renamed by an alias, normally the account type remains in effect. @@ -2985,18 +2753,15 @@ 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[V]type:\f[R] query is not +If you are using account aliases and the \f[CR]type:\f[R] query is not matching accounts as you expect, try troubleshooting with the accounts command, eg something like: .IP -.nf -\f[C] +.EX $ hledger accounts --alias assets=bassetts type:a -\f[R] -.fi -.SS \f[V]commodity\f[R] directive -.PP -The \f[V]commodity\f[R] directive performs several functions: +.EE +.SS \f[CR]commodity\f[R] directive +The \f[CR]commodity\f[R] directive performs several functions: .IP "1." 3 It declares which commodity symbols may be used in the journal, enabling useful error checking with strict mode or the check command. @@ -3012,28 +2777,25 @@ decimal mark (period or comma), and the number of decimal places. .IP "4." 3 It sets which decimal mark (period or comma) to expect when parsing subsequent amounts in this commodity (if there is no -\f[V]decimal-mark\f[R] directive in effect. +\f[CR]decimal-mark\f[R] directive in effect. See Decimal marks, digit group marks above. For related dev discussion, see #793.) .PP Declaring commodities solves several common parsing/display problems, so we recommend it. -Generally you should put \f[V]commodity\f[R] directives at the top of +Generally you should put \f[CR]commodity\f[R] directives at the top of your journal file (because function 4 is position-sensitive). .SS Commodity directive syntax -.PP -A commodity directive is normally the word \f[V]commodity\f[R] followed +A commodity directive is normally the word \f[CR]commodity\f[R] followed by a sample amount (and optionally a comment). Only the amount\[aq]s symbol and format is significant. Eg: .IP -.nf -\f[C] +.EX commodity $1000.00 commodity 1.000,00 EUR commodity 1 000 000.0000 ; the no-symbol commodity -\f[R] -.fi +.EE .PP A commodity directive\[aq]s sample amount must always include a period or comma decimal mark (this rule helps disambiguate decimal marks and @@ -3041,90 +2803,73 @@ digit group marks). If you don\[aq]t want to show any decimal digits, write the decimal mark at the end: .IP -.nf -\f[C] +.EX commodity 1000. AAAA ; show AAAA with no decimals -\f[R] -.fi +.EE .PP Commodity symbols containing spaces, numbers, or punctuation must be enclosed in double quotes, as usual: .IP -.nf -\f[C] +.EX commodity 1.0000 \[dq]AAAA 2023\[dq] -\f[R] -.fi +.EE .PP Commodity directives normally include a sample amount, but can declare only a symbol (ie, just function 1 above): .IP -.nf -\f[C] +.EX commodity $ commodity INR commodity \[dq]AAAA 2023\[dq] commodity \[dq]\[dq] ; the no-symbol commodity -\f[R] -.fi +.EE .PP Commodity directives may also be written with an indented -\f[V]format\f[R] subdirective, as in Ledger. +\f[CR]format\f[R] subdirective, as in Ledger. The symbol is repeated and must be the same in both places. Other subdirectives are currently ignored: .IP -.nf -\f[C] +.EX ; display indian rupees with currency name on the left, ; thousands, lakhs and crores comma-separated, ; period as decimal point, and two decimal places. commodity INR format INR 1,00,00,000.00 an unsupported subdirective ; ignored by hledger -\f[R] -.fi +.EE .SS Commodity error checking -.PP -In strict mode (\f[V]-s\f[R]/\f[V]--strict\f[R]) (or when you run -\f[V]hledger check commodities\f[R]), hledger will report an error if an -undeclared commodity symbol is used. +In strict mode (\f[CR]-s\f[R]/\f[CR]--strict\f[R]) (or when you run +\f[CR]hledger check commodities\f[R]), hledger will report an error if +an undeclared commodity symbol is used. (With one exception: zero amounts are always allowed to have no commodity symbol.) It works like account error checking (described above). -.SS \f[V]decimal-mark\f[R] directive -.PP -You can use a \f[V]decimal-mark\f[R] directive - usually one per file, +.SS \f[CR]decimal-mark\f[R] directive +You can use a \f[CR]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 .IP -.nf -\f[C] +.EX decimal-mark . -\f[R] -.fi +.EE .PP or .IP -.nf -\f[C] +.EX decimal-mark , -\f[R] -.fi +.EE .PP 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). -.SS \f[V]include\f[R] directive -.PP +.SS \f[CR]include\f[R] directive You can pull in the content of additional files by writing an include directive, like this: .IP -.nf -\f[C] +.EX include FILEPATH -\f[R] -.fi +.EE .PP Only journal files can include, and only journal, timeclock or timedot files can be included (not CSV files, currently). @@ -3132,24 +2877,23 @@ 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[V]include \[ti]/main.journal\f[R]. +A tilde means home directory, eg: \f[CR]include \[ti]/main.journal\f[R]. .PP The path may contain glob patterns to match multiple files, eg: -\f[V]include *.journal\f[R]. +\f[CR]include *.journal\f[R]. .PP -There is limited support for recursive wildcards: \f[V]**/\f[R] (the +There is limited support for recursive wildcards: \f[CR]**/\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[V]include */**/*.journal\f[R]. +\f[CR]include */**/*.journal\f[R]. .PP The path may also be prefixed to force a specific file format, overriding the file extension (as described in Data formats): -\f[V]include timedot:\[ti]/notes/2023*.md\f[R]. -.SS \f[V]P\f[R] directive -.PP -The \f[V]P\f[R] directive declares a market price, which is a conversion -rate between two commodities on a certain date. +\f[CR]include timedot:\[ti]/notes/2023*.md\f[R]. +.SS \f[CR]P\f[R] directive +The \f[CR]P\f[R] directive declares a market price, which is a +conversion rate between two commodities on a certain date. This allows value reports to convert amounts of one commodity to their value in another, on or after that date. These prices are often obtained from a stock exchange, cryptocurrency @@ -3157,34 +2901,29 @@ exchange, the or foreign exchange market. .PP The format is: .IP -.nf -\f[C] +.EX P DATE COMMODITY1SYMBOL COMMODITY2AMOUNT -\f[R] -.fi +.EE .PP 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: .IP -.nf -\f[C] +.EX # one euro was worth $1.35 from 2009-01-01 onward: P 2009-01-01 € $1.35 # and $1.40 from 2010-01-01 onward: P 2010-01-01 € $1.40 -\f[R] -.fi +.EE .PP -The \f[V]-V\f[R], \f[V]-X\f[R] and \f[V]--value\f[R] flags use these +The \f[CR]-V\f[R], \f[CR]-X\f[R] and \f[CR]--value\f[R] flags use these market prices to show amount values in another commodity. See Value reporting. .PP -.SS \f[V]payee\f[R] directive -.PP -\f[V]payee PAYEE NAME\f[R] +.SS \f[CR]payee\f[R] directive +\f[CR]payee PAYEE NAME\f[R] .PP This directive can be used to declare a limited set of payees which may appear in transaction descriptions. @@ -3192,27 +2931,22 @@ The \[dq]payees\[dq] check will report an error if any transaction refers to a payee that has not been declared. Eg: .IP -.nf -\f[C] +.EX payee Whole Foods -\f[R] -.fi +.EE .PP Any indented subdirectives are currently ignored. -.SS \f[V]tag\f[R] directive -.PP -\f[V]tag TAGNAME\f[R] +.SS \f[CR]tag\f[R] directive +\f[CR]tag TAGNAME\f[R] .PP This directive can be used to declare a limited set of tag names allowed in tags. TAGNAME should be a valid tag name (no spaces). Eg: .IP -.nf -\f[C] +.EX tag item-id -\f[R] -.fi +.EE .PP Any indented subdirectives are currently ignored. .PP @@ -3222,8 +2956,7 @@ It is quite easy to accidentally create a tag through normal use of colons in comments(#comments]; if you want to prevent this, you can declare and check your tags . .SS Periodic transactions -.PP -The \f[V]\[ti]\f[R] directive declares recurring transactions. +The \f[CR]\[ti]\f[R] directive declares recurring transactions. Such directives allow hledger to generate temporary future transactions (visible in reports, not in the journal file) to help with forecasting or budgeting. @@ -3235,8 +2968,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[V]hledger print --forecast tag:generated\f[R] or -\f[V]hledger register --forecast tag:generated\f[R]. +\f[CR]hledger print --forecast tag:generated\f[R] or +\f[CR]hledger register --forecast tag:generated\f[R]. .IP "3." 3 Forecasted transactions will begin only after the last non-forecasted transaction\[aq]s date. @@ -3249,26 +2982,24 @@ 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[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. +Eg in \f[CR]weekly from DATE\f[R], DATE must be a monday. +\f[CR]\[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[V]\[ti] every 10th day of month from 2023/01\f[R], which is -equivalent to \f[V]\[ti] every 10th day of month from 2023/01/01\f[R], +Eg: \f[CR]\[ti] every 10th day of month from 2023/01\f[R], which is +equivalent to \f[CR]\[ti] every 10th day of month from 2023/01/01\f[R], will be adjusted to start on 2019/12/10. .SS Periodic rule syntax -.PP A periodic transaction rule looks like a normal journal entry, with the -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 +date replaced by a tilde (\f[CR]\[ti]\f[R]) followed by a period +expression (mnemonic: \f[CR]\[ti]\f[R] looks like a recurring sine wave.): .IP -.nf -\f[C] +.EX # every first of month \[ti] monthly expenses:rent $2000 @@ -3278,48 +3009,43 @@ wave.): \[ti] monthly from 2023-04-15 to 2023-06-16 expenses:utilities $400 assets:bank:checking -\f[R] -.fi +.EE .PP The period expression is the same syntax used for specifying multi-period reports, just interpreted differently; there, it specifies report periods; here it specifies recurrence dates (the periods\[aq] start dates). .SS Periodic rules and relative dates -.PP -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 +Partial or relative dates (like \f[CR]12/31\f[R], \f[CR]25\f[R], +\f[CR]tomorrow\f[R], \f[CR]last week\f[R], \f[CR]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[V]Y\f[R] +the first day of the default year specified by a recent \f[CR]Y\f[R] directive .IP "2." 3 -or the date specified with \f[V]--today\f[R] +or the date specified with \f[CR]--today\f[R] .IP "3." 3 or the date on which you are running the report. .PP They will not be affected at all by report period or forecast period dates. .SS Two spaces between period expression and description! -.PP If the period expression is followed by a transaction description, these must be separated by \f[B]two or more spaces\f[R]. This helps hledger know where the period expression ends, so that descriptions can not accidentally alter their meaning, as in this example: .IP -.nf -\f[C] +.EX ; 2 or more spaces needed here, so the period is not understood as \[dq]every 2 months in 2023\[dq] ; || ; vv \[ti] every 2 months in 2023, we will review assets:bank:checking $1500 income:acme inc -\f[R] -.fi +.EE .PP So, .IP \[bu] 2 @@ -3329,9 +3055,8 @@ description, if any. Don\[aq]t accidentally write two spaces in the middle of your period expression. .SS Auto postings -.PP -The \f[V]=\f[R] directive declares a rule for generating temporary extra -postings on transactions. +The \f[CR]=\f[R] directive declares a rule for generating temporary +extra postings on transactions. Wherever the rule matches an existing posting, it can add one or more companion postings below that one, optionally influenced by the matched posting\[aq]s amount. @@ -3341,36 +3066,34 @@ percentage, for example. Note that depending on generated data is not ideal for financial records (it\[aq]s less portable, less future-proof, less auditable by others, and less robust, since other features like balance assertions will -depend on using or not using \f[V]--auto\f[R]). +depend on using or not using \f[CR]--auto\f[R]). .PP An auto posting rule looks a bit like a transaction: .IP -.nf -\f[C] +.EX = QUERY ACCOUNT AMOUNT ... ACCOUNT [AMOUNT] -\f[R] -.fi +.EE .PP -except the first line is an equals sign (mnemonic: \f[V]=\f[R] suggests +except the first line is an equals sign (mnemonic: \f[CR]=\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[V]$2\f[R]. +a normal amount with a commodity symbol, eg \f[CR]$2\f[R]. This will be used as-is. .IP \[bu] 2 -a number, eg \f[V]2\f[R]. +a number, eg \f[CR]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[V]*2\f[R] (a star followed by a number N). +a numeric multiplier, eg \f[CR]*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[V]*$2\f[R] (a star, number +a multiplier with a commodity symbol, eg \f[CR]*$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. @@ -3379,17 +3102,14 @@ 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: .IP -.nf -\f[C] +.EX = expenses:groceries \[aq]expenses:dining out\[aq] (budget:funds:dining out) *-1 -\f[R] -.fi +.EE .PP Some examples: .IP -.nf -\f[C] +.EX ; every time I buy food, schedule a dollar donation = expenses:food (liabilities:charity) $-1 @@ -3406,11 +3126,9 @@ Some examples: 2017/12/14 expenses:gifts $20 assets:checking -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger print --auto 2017-12-01 expenses:food $10 @@ -3422,21 +3140,17 @@ $ hledger print --auto assets:checking assets:checking:gifts -$20 assets:checking $20 -\f[R] -.fi +.EE .SS Auto postings and multiple files -.PP 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[V]-f\f[R]/\f[V]--file\f[R] are used - see #1212). +\f[CR]-f\f[R]/\f[CR]--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 precedence) a posting date in the auto posting rule itself, will also be used in the generated posting. .SS Auto postings and transaction balancing / inferred amounts / balance assertions -.PP Currently, auto postings are added: .IP \[bu] 2 after missing amounts are inferred, and transactions are checked for @@ -3452,13 +3166,12 @@ 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. .SS Auto posting tags -.PP Automated postings will have some extra tags: .IP \[bu] 2 -\f[V]generated-posting:= QUERY\f[R] - shows this was generated by an +\f[CR]generated-posting:= QUERY\f[R] - shows this was generated by an auto posting rule, and the query .IP \[bu] 2 -\f[V]_generated-posting:= QUERY\f[R] - a hidden tag, which does not +\f[CR]_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. @@ -3466,19 +3179,17 @@ 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[V]modified:\f[R] - this transaction was modified +\f[CR]modified:\f[R] - this transaction was modified .IP \[bu] 2 -\f[V]_modified:\f[R] - a hidden tag not appearing in the comment; this +\f[CR]_modified:\f[R] - a hidden tag not appearing in the comment; this transaction was modified \[dq]just now\[dq]. .SS Auto postings on forecast transactions only -.PP Tip: you can can make auto postings that will apply to forecast transactions but not recorded transactions, by adding -\f[V]tag:_generated-transaction\f[R] to their QUERY. +\f[CR]tag:_generated-transaction\f[R] to their QUERY. This can be useful when generating new journal entries to be saved in the journal. .SS Other syntax -.PP hledger journal format supports quite a few other features, mainly to make interoperating with or converting from Ledger easier. Note some of the features below are powerful and can be useful in @@ -3486,7 +3197,6 @@ special cases, but in general, features in this section are considered less important or even not recommended for most users. Downsides are mentioned to help you decide if you want to use them. .SS Balance assignments -.PP 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 @@ -3494,27 +3204,23 @@ as to satisfy the assertion. This can be a convenience during data entry, eg when setting opening balances: .IP -.nf -\f[C] +.EX ; starting a new journal, set asset account balances 2016/1/1 opening balances assets:checking = $409.32 assets:savings = $735.24 assets:cash = $42 equity:opening balances -\f[R] -.fi +.EE .PP or when adjusting a balance to reality: .IP -.nf -\f[C] +.EX ; no cash left; update balance, record any untracked spending as a generic expense 2016/1/15 assets:cash = $0 expenses:misc -\f[R] -.fi +.EE .PP The calculated amount depends on the account\[aq]s balance in the commodity at that point (which depends on the previously-dated postings @@ -3528,62 +3234,53 @@ Also balance assignments\[aq] forcing of balances can hide errors. These things make your financial data less portable, less future-proof, and less trustworthy in an audit. .SS Balance assignments and prices -.PP A cost in a balance assignment will cause the calculated amount to have that price attached: .IP -.nf -\f[C] +.EX 2019/1/1 (a) = $1 \[at] €2 -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger print --explicit 2019-01-01 (a) $1 \[at] €2 = $1 \[at] €2 -\f[R] -.fi +.EE .SS Balance assignments and multiple files -.PP Balance assignments handle multiple files like balance assertions. They see balance from other files previously included from the current file, but not from previous sibling or parent files. .SS Bracketed posting dates -.PP For setting posting dates and secondary posting dates, Ledger\[aq]s -bracketed date syntax is also supported: \f[V][DATE]\f[R], -\f[V][DATE=DATE2]\f[R] or \f[V][=DATE2]\f[R] in posting comments. +bracketed date syntax is also supported: \f[CR][DATE]\f[R], +\f[CR][DATE=DATE2]\f[R] or \f[CR][=DATE2]\f[R] in posting comments. hledger will attempt to parse any square-bracketed sequence of the -\f[V]0123456789/-.=\f[R] characters in this way. +\f[CR]0123456789/-.=\f[R] characters in this way. With this syntax, DATE infers its year from the transaction and DATE2 infers its year from DATE. .PP Downsides: another syntax to learn, redundant with hledger\[aq]s -\f[V]date:\f[R]/\f[V]date2:\f[R] tags, and confusingly similar to +\f[CR]date:\f[R]/\f[CR]date2:\f[R] tags, and confusingly similar to Ledger\[aq]s lot date syntax. -.SS \f[V]D\f[R] directive -.PP -\f[V]D AMOUNT\f[R] +.SS \f[CR]D\f[R] directive +\f[CR]D AMOUNT\f[R] .PP This 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[V]D\f[R] directive, or the end of +This effect lasts until the next \f[CR]D\f[R] directive, or the end of the journal. .PP -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 compatibility/historical reasons, \f[CR]D\f[R] also acts like a +\f[CR]commodity\f[R] directive (setting the commodity\[aq]s decimal mark for parsing and display style for output). So its argument is not just a commodity symbol, but a full amount demonstrating the style. The amount must include a decimal mark (either period or comma). Eg: .IP -.nf -\f[C] +.EX ; commodity-less amounts should be treated as dollars ; (and displayed with the dollar sign on the left, thousands separators and two decimal places) D $1,000.00 @@ -3591,38 +3288,35 @@ D $1,000.00 1/1 a 5 ; <- commodity-less amount, parsed as $5 and displayed as $5.00 b -\f[R] -.fi +.EE .PP Interactions with other directives: .PP -For setting a commodity\[aq]s display style, a \f[V]commodity\f[R] -directive has highest priority, then a \f[V]D\f[R] directive. +For setting a commodity\[aq]s display style, a \f[CR]commodity\f[R] +directive has highest priority, then a \f[CR]D\f[R] directive. .PP For detecting a commodity\[aq]s decimal mark during parsing, -\f[V]decimal-mark\f[R] has highest priority, then \f[V]commodity\f[R], -then \f[V]D\f[R]. +\f[CR]decimal-mark\f[R] has highest priority, then \f[CR]commodity\f[R], +then \f[CR]D\f[R]. .PP For checking commodity symbols with the check command, a -\f[V]commodity\f[R] directive is required -(\f[V]hledger check commodities\f[R] ignores \f[V]D\f[R] directives). +\f[CR]commodity\f[R] directive is required +(\f[CR]hledger check commodities\f[R] ignores \f[CR]D\f[R] directives). .PP Downsides: omitting commodity symbols makes your financial data less explicit, less portable, and less trustworthy in an audit. It is usually an unsustainable shortcut; sooner or later you will want to track multiple commodities. -D is overloaded with functions redundant with \f[V]commodity\f[R] and -\f[V]decimal-mark\f[R]. -And it works differently from Ledger\[aq]s \f[V]D\f[R]. -.SS \f[V]apply account\f[R] directive -.PP +D is overloaded with functions redundant with \f[CR]commodity\f[R] and +\f[CR]decimal-mark\f[R]. +And it works differently from Ledger\[aq]s \f[CR]D\f[R]. +.SS \f[CR]apply account\f[R] directive This directive sets a default parent account, which will be prepended to -all accounts in following entries, until an \f[V]end apply account\f[R] +all accounts in following entries, until an \f[CR]end apply account\f[R] directive or end of current file. Eg: .IP -.nf -\f[C] +.EX apply account home 2010/1/1 @@ -3630,21 +3324,18 @@ apply account home cash end apply account -\f[R] -.fi +.EE .PP is equivalent to: .IP -.nf -\f[C] +.EX 2010/01/01 home:food $10 home:cash $-10 -\f[R] -.fi +.EE .PP -\f[V]account\f[R] directives are also affected, and so is any -\f[V]include\f[R]d content. +\f[CR]account\f[R] directives are also affected, and so is any +\f[CR]include\f[R]d content. .PP Account names entered via hledger add or hledger-web are not affected. .PP @@ -3653,21 +3344,19 @@ prepended. .PP Downsides: this can make your financial data less explicit, less portable, and less trustworthy in an audit. -.SS \f[V]Y\f[R] directive -.PP -\f[V]Y YEAR\f[R] +.SS \f[CR]Y\f[R] directive +\f[CR]Y YEAR\f[R] .PP or (deprecated backward-compatible forms): .PP -\f[V]year YEAR\f[R] \f[V]apply year YEAR\f[R] +\f[CR]year YEAR\f[R] \f[CR]apply year YEAR\f[R] .PP The space is optional. This sets a default year to be used for subsequent dates which don\[aq]t specify a year. Eg: .IP -.nf -\f[C] +.EX Y2009 ; set default year to 2009 12/15 ; equivalent to 2009/12/15 @@ -3683,8 +3372,7 @@ year 2010 ; change default year to 2010 1/31 ; equivalent to 2010/1/31 expenses 1 assets -\f[R] -.fi +.EE .PP Downsides: omitting the year (from primary transaction dates, at least) makes your financial data less explicit, less portable, and less @@ -3693,13 +3381,13 @@ Such dates can get separated from their corresponding Y directive, eg when evaluating a region of the journal in your editor. A missing Y directive makes reports dependent on today\[aq]s date. .SS Secondary dates -.PP 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[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. +with the \f[CR]--date2\f[R] flag (or \f[CR]--aux-date\f[R] or +\f[CR]--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. @@ -3713,8 +3401,8 @@ you have to remember which reporting mode is appropriate for a given report. Posting dates are simpler and better. .SS Star comments -.PP -Lines beginning with \f[V]*\f[R] (star/asterisk) are also comment lines. +Lines beginning with \f[CR]*\f[R] (star/asterisk) are also comment +lines. This feature allows Emacs users to insert org headings in their journal, allowing them to fold/unfold/navigate it like an outline when viewed with org mode. @@ -3725,14 +3413,12 @@ And switching to Emacs org mode just for folding/unfolding meant losing the benefits of ledger mode; nowadays you can add outshine mode to ledger mode to get folding without losing ledger mode\[aq]s features. .SS Valuation expressions -.PP Ledger allows a valuation function or value to be written in double parentheses after an amount. hledger ignores these. .SS Virtual postings -.PP A posting with parentheses around the account name -(\f[V](some:account)\f[R]) is called a \f[I]unbalanced virtual +(\f[CR](some:account)\f[R]) is called a \f[I]unbalanced virtual posting\f[R]. Such postings do not participate in transaction balancing. (And if you write them without an amount, a zero amount is always @@ -3742,7 +3428,7 @@ violate double entry bookkeeping and make your data less portable across applications, so many people avoid using them at all. .PP A posting with brackets around the account name -(\f[V][some:account]\f[R]) is called a \f[I]balanced virtual +(\f[CR][some:account]\f[R]) is called a \f[I]balanced virtual posting\f[R]. The balanced virtual postings in a transaction must add up to zero, just like ordinary postings, but separately from them. @@ -3750,8 +3436,7 @@ These are not part of double entry bookkeeping either, but they are at least balanced. An example: .IP -.nf -\f[C] +.EX 2022-01-01 buy food with cash, update budget envelope subaccounts, & something else assets:cash $-10 ; <- these balance each other expenses:food $7 ; <- @@ -3759,21 +3444,18 @@ An example: [assets:checking:budget:food] $-10 ; <- and these balance each other [assets:checking:available] $10 ; <- (something:else) $5 ; <- this is not required to balance -\f[R] -.fi +.EE .PP Ordinary postings, whose account names are neither parenthesised nor bracketed, are called \f[I]real postings\f[R]. You can exclude virtual postings from reports with the -\f[V]-R/--real\f[R] flag or a \f[V]real:1\f[R] query. +\f[CR]-R/--real\f[R] flag or a \f[CR]real:1\f[R] query. .SS Other Ledger directives -.PP These other Ledger directives are currently accepted but ignored. This allows hledger to read more Ledger files, but be aware that hledger\[aq]s reports may differ from Ledger\[aq]s if you use these. .IP -.nf -\f[C] +.EX apply fixed COMM AMT apply tag TAG assert EXPR @@ -3791,14 +3473,12 @@ python tag NAME value EXPR --command-line-flags -\f[R] -.fi +.EE .PP See also https://hledger.org/ledger.html for a detailed hledger/Ledger syntax comparison. .PP .SH CSV -.PP hledger can read CSV files (Character Separated Value - usually comma, semicolon, or tab) containing dated records, automatically converting each record into a transaction. @@ -3806,7 +3486,7 @@ each record into a transaction. (To learn about \f[I]writing\f[R] CSV, see CSV output.) .PP For best error messages when reading CSV/TSV/SSV files, make sure they -have a corresponding \f[V].csv\f[R], \f[V].tsv\f[R] or \f[V].ssv\f[R] +have a corresponding \f[CR].csv\f[R], \f[CR].tsv\f[R] or \f[CR].ssv\f[R] file extension or use a hledger file prefix (see File Extension below). .PP Each CSV file must be described by a corresponding \f[I]rules file\f[R]. @@ -3818,10 +3498,10 @@ date format etc.), how to construct hledger transactions from it, and how to categorise transactions based on description or other attributes. .PP By default hledger looks for a rules file named like the CSV file with -an extra \f[V].rules\f[R] extension, in the same directory. -Eg when asked to read \f[V]foo/FILE.csv\f[R], hledger looks for -\f[V]foo/FILE.csv.rules\f[R]. -You can specify a different rules file with the \f[V]--rules-file\f[R] +an extra \f[CR].rules\f[R] extension, in the same directory. +Eg when asked to read \f[CR]foo/FILE.csv\f[R], hledger looks for +\f[CR]foo/FILE.csv.rules\f[R]. +You can specify a different rules file with the \f[CR]--rules-file\f[R] option. If no rules file is found, hledger will create a sample rules file, which you\[aq]ll need to adjust. @@ -3831,87 +3511,80 @@ often it also specifies the date format and how many header lines there are. Here\[aq]s a simple CSV file and a rules file for it: .IP -.nf -\f[C] +.EX Date, Description, Id, Amount 12/11/2019, Foo, 123, 10.23 -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # basic.csv.rules skip 1 fields date, description, , amount date-format %d/%m/%Y -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger print -f basic.csv 2019-11-12 Foo expenses:unknown 10.23 income:unknown -10.23 -\f[R] -.fi +.EE .PP There\[aq]s an introductory Importing CSV data tutorial on hledger.org, and more CSV rules examples below, and a larger collection at https://github.com/simonmichael/hledger/tree/master/examples/csv. .SS CSV rules cheatsheet -.PP The following kinds of rule can appear in the rules file, in any order. -(Blank lines and lines beginning with \f[V]#\f[R] or \f[V];\f[R] or -\f[V]*\f[R] are ignored.) +(Blank lines and lines beginning with \f[CR]#\f[R] or \f[CR];\f[R] or +\f[CR]*\f[R] are ignored.) .PP .TS tab(@); lw(23.7n) lw(46.3n). T{ -\f[B]\f[VB]source\f[B]\f[R] +\f[B]\f[CB]source\f[B]\f[R] T}@T{ optionally declare which file to read data from T} T{ -\f[B]\f[VB]separator\f[B]\f[R] +\f[B]\f[CB]separator\f[B]\f[R] T}@T{ declare the field separator, instead of relying on file extension T} T{ -\f[B]\f[VB]skip\f[B]\f[R] +\f[B]\f[CB]skip\f[B]\f[R] T}@T{ skip one or more header lines at start of file T} T{ -\f[B]\f[VB]date-format\f[B]\f[R] +\f[B]\f[CB]date-format\f[B]\f[R] T}@T{ declare how to parse CSV dates/date-times T} T{ -\f[B]\f[VB]timezone\f[B]\f[R] +\f[B]\f[CB]timezone\f[B]\f[R] T}@T{ declare the time zone of ambiguous CSV date-times T} T{ -\f[B]\f[VB]newest-first\f[B]\f[R] +\f[B]\f[CB]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[VB]intra-day-reversed\f[B]\f[R] +\f[B]\f[CB]intra-day-reversed\f[B]\f[R] T}@T{ improve txn order when: same-day txns are in opposite order to the overall file T} T{ -\f[B]\f[VB]decimal-mark\f[B]\f[R] +\f[B]\f[CB]decimal-mark\f[B]\f[R] T}@T{ declare the decimal mark used in CSV amounts, when ambiguous T} T{ -\f[B]\f[VB]fields\f[B] list\f[R] +\f[B]\f[CB]fields\f[B] list\f[R] T}@T{ name CSV fields for easy reference, and optionally assign their values to hledger fields @@ -3922,23 +3595,23 @@ T}@T{ assign a CSV value or interpolated text value to a hledger field T} T{ -\f[B]\f[VB]if\f[B] block\f[R] +\f[B]\f[CB]if\f[B] block\f[R] T}@T{ -conditionally assign values to hledger fields, or \f[V]skip\f[R] a -record or \f[V]end\f[R] (skip rest of file) +conditionally assign values to hledger fields, or \f[CR]skip\f[R] a +record or \f[CR]end\f[R] (skip rest of file) T} T{ -\f[B]\f[VB]if\f[B] table\f[R] +\f[B]\f[CB]if\f[B] table\f[R] T}@T{ conditionally assign values to hledger fields, using compact syntax T} T{ -\f[B]\f[VB]balance-type\f[B]\f[R] +\f[B]\f[CB]balance-type\f[B]\f[R] T}@T{ select which type of balance assertions/assignments to generate T} T{ -\f[B]\f[VB]include\f[B]\f[R] +\f[B]\f[CB]include\f[B]\f[R] T}@T{ inline another CSV rules file T} @@ -3946,13 +3619,12 @@ T} .PP Working with CSV tips can be found below, including How CSV rules are evaluated. -.SS \f[V]source\f[R] -.PP -If you tell hledger to read a csv file with \f[V]-f foo.csv\f[R], it -will look for rules in \f[V]foo.csv.rules\f[R]. +.SS \f[CR]source\f[R] +If you tell hledger to read a csv file with \f[CR]-f foo.csv\f[R], it +will look for rules in \f[CR]foo.csv.rules\f[R]. Or, you can tell it to read the rules file, with -\f[V]-f foo.csv.rules\f[R], and it will look for data in -\f[V]foo.csv\f[R] (since 1.30). +\f[CR]-f foo.csv.rules\f[R], and it will look for data in +\f[CR]foo.csv\f[R] (since 1.30). .PP These are mostly equivalent, but the second method provides some extra features. @@ -3961,139 +3633,112 @@ just considered empty. And, you can specify a different data file by adding a \[dq]source\[dq] rule: .IP -.nf -\f[C] +.EX source ./Checking1.csv -\f[R] -.fi +.EE .PP If you specify just a file name with no path, hledger will look for it -in your system\[aq]s downloads directory (\f[V]\[ti]/Downloads\f[R], +in your system\[aq]s downloads directory (\f[CR]\[ti]/Downloads\f[R], currently): .IP -.nf -\f[C] +.EX source Checking1.csv -\f[R] -.fi +.EE .PP And if you specify a glob pattern, hledger will read the most recent of the matched files (useful with repeated downloads): .IP -.nf -\f[C] +.EX source Checking1*.csv -\f[R] -.fi +.EE .PP See also \[dq]Working with CSV > Reading files specified by rule\[dq]. -.SS \f[V]separator\f[R] -.PP -You can use the \f[V]separator\f[R] rule to read other kinds of +.SS \f[CR]separator\f[R] +You can use the \f[CR]separator\f[R] rule to read other kinds of character-separated data. The argument is any single separator character, or the words -\f[V]tab\f[R] or \f[V]space\f[R] (case insensitive). +\f[CR]tab\f[R] or \f[CR]space\f[R] (case insensitive). Eg, for comma-separated values (CSV): .IP -.nf -\f[C] +.EX separator , -\f[R] -.fi +.EE .PP or for semicolon-separated values (SSV): .IP -.nf -\f[C] +.EX separator ; -\f[R] -.fi +.EE .PP or for tab-separated values (TSV): .IP -.nf -\f[C] +.EX separator TAB -\f[R] -.fi +.EE .PP -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[V]skip\f[R] +If the input file has a \f[CR].csv\f[R], \f[CR].ssv\f[R] or +\f[CR].tsv\f[R] file extension (or a \f[CR]csv:\f[R], \f[CR]ssv:\f[R], +\f[CR]tsv:\f[R] prefix), the appropriate separator will be inferred +automatically, and you won\[aq]t need this rule. +.SS \f[CR]skip\f[R] .IP -.nf -\f[C] +.EX skip N -\f[R] -.fi +.EE .PP -The word \f[V]skip\f[R] followed by a number (or no number, meaning 1) +The word \f[CR]skip\f[R] followed by a number (or no number, meaning 1) tells hledger to ignore this many non-empty lines at the start of the input data. You\[aq]ll need this whenever your CSV data contains header lines. Note, empty and blank lines are skipped automatically, so you don\[aq]t need to count those. .PP -\f[V]skip\f[R] has a second meaning: it can be used inside if blocks +\f[CR]skip\f[R] has a second meaning: it can be used inside if blocks (described below), to skip one or more records whenever the condition is true. Records skipped in this way are ignored, except they are still required to be valid CSV. -.SS \f[V]date-format\f[R] +.SS \f[CR]date-format\f[R] .IP -.nf -\f[C] +.EX date-format DATEFMT -\f[R] -.fi +.EE .PP -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 +This is a helper for the \f[CR]date\f[R] (and \f[CR]date2\f[R]) fields. +If your CSV dates are not formatted like \f[CR]YYYY-MM-DD\f[R], +\f[CR]YYYY/MM/DD\f[R] or \f[CR]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. The pattern must parse the CSV date value completely. Some examples: .IP -.nf -\f[C] +.EX # MM/DD/YY date-format %m/%d/%y -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # D/M/YYYY # The - makes leading zeros optional. date-format %-d/%-m/%Y -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # YYYY-Mmm-DD date-format %Y-%h-%d -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # M/D/YYYY HH:MM AM some other junk # Note the time and junk must be fully parsed, though only the date is used. date-format %-m/%-d/%Y %l:%M %p some other junk -\f[R] -.fi -.SS \f[V]timezone\f[R] +.EE +.SS \f[CR]timezone\f[R] .IP -.nf -\f[C] +.EX timezone TIMEZONE -\f[R] -.fi +.EE .PP When CSV contains date-times that are implicitly in some time zone other than yours, but containing no explicit time zone information, you can @@ -4101,8 +3746,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[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 +need this rule; instead, use \f[CR]%Z\f[R] in \f[CR]date-format\f[R] (or +\f[CR]%z\f[R], \f[CR]%EZ\f[R], \f[CR]%Ez\f[R]; see the formatTime link above). .PP In either of these cases, hledger will do a time-zone-aware conversion, @@ -4111,19 +3756,16 @@ 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 variable, eg: .IP -.nf -\f[C] +.EX $ TZ=-1000 hledger print -f foo.csv # or TZ=-1000 hledger import foo.csv -\f[R] -.fi +.EE .PP -\f[V]timezone\f[R] currently does not understand timezone names, except +\f[CR]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[V]newest-first\f[R] -.PP +.SS \f[CR]newest-first\f[R] hledger tries to ensure that the generated transactions will be ordered chronologically, including same-day transactions. Usually it can auto-detect how the CSV records are ordered. @@ -4131,82 +3773,67 @@ 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\[aq]s records are normally newest first, like: .IP -.nf -\f[C] +.EX 2022-10-01, txn 3... 2022-10-01, txn 2... 2022-10-01, txn 1... -\f[R] -.fi +.EE .PP -you can add the \f[V]newest-first\f[R] rule to help hledger generate the -transactions in correct order. +you can add the \f[CR]newest-first\f[R] rule to help hledger generate +the transactions in correct order. .IP -.nf -\f[C] +.EX # same-day CSV records are newest first newest-first -\f[R] -.fi -.SS \f[V]intra-day-reversed\f[R] -.PP +.EE +.SS \f[CR]intra-day-reversed\f[R] If CSV records within a single day are ordered opposite to the overall -record order, you can add the \f[V]intra-day-reversed\f[R] rule to +record order, you can add the \f[CR]intra-day-reversed\f[R] rule to improve the order of journal entries. Eg, here the overall record order is newest first, but same-day records are oldest first: .IP -.nf -\f[C] +.EX 2022-10-02, txn 3... 2022-10-02, txn 4... 2022-10-01, txn 1... 2022-10-01, txn 2... -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # transactions within each day are reversed with respect to the overall date order intra-day-reversed -\f[R] -.fi -.SS \f[V]decimal-mark\f[R] +.EE +.SS \f[CR]decimal-mark\f[R] .IP -.nf -\f[C] +.EX decimal-mark . -\f[R] -.fi +.EE .PP or: .IP -.nf -\f[C] +.EX decimal-mark , -\f[R] -.fi +.EE .PP 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. -.SS \f[V]fields\f[R] list +.SS \f[CR]fields\f[R] list .IP -.nf -\f[C] +.EX fields FIELDNAME1, FIELDNAME2, ... -\f[R] -.fi +.EE .PP -A fields list (the word \f[V]fields\f[R] followed by comma-separated +A fields list (the word \f[CR]fields\f[R] followed by comma-separated field names) is optional, but convenient. It does two things: .IP "1." 3 It names the CSV field in each column. This can be convenient if you are referencing them in other rules, so -you can say \f[V]%SomeField\f[R] instead of remembering \f[V]%13\f[R]. +you can say \f[CR]%SomeField\f[R] instead of remembering \f[CR]%13\f[R]. .IP "2." 3 Whenever you use one of the special hledger field names (described below), it assigns the CSV value in this position to that hledger field. @@ -4217,11 +3844,9 @@ Here\[aq]s an example that says \[dq]use the 1st, 2nd and 4th fields as the transaction\[aq]s date, description and amount; name the last two fields for later reference; and ignore the others\[dq]: .IP -.nf -\f[C] +.EX fields date, description, , amount, , , somefield, anotherfield -\f[R] -.fi +.EE .PP In a fields list, the separator is always comma; it is unrelated to the CSV file\[aq]s separator. @@ -4232,7 +3857,7 @@ There must be least two items in the list (at least one comma). Field names may not contain spaces. Spaces before/after field names are optional. .IP \[bu] 2 -Field names may contain \f[V]_\f[R] (underscore) or \f[V]-\f[R] +Field names may contain \f[CR]_\f[R] (underscore) or \f[CR]-\f[R] (hyphen). .IP \[bu] 2 Fields you don\[aq]t care about can be given a dummy name or an empty @@ -4245,15 +3870,13 @@ replaced by underscores). Sometimes you may want to alter a CSV field name to avoid assigning to a hledger field with the same name. Eg you could call the CSV\[aq]s \[dq]balance\[dq] field -\f[V]balance_\f[R] to avoid directly setting hledger\[aq]s -\f[V]balance\f[R] field (and generating a balance assertion). +\f[CR]balance_\f[R] to avoid directly setting hledger\[aq]s +\f[CR]balance\f[R] field (and generating a balance assertion). .SS Field assignment .IP -.nf -\f[C] +.EX HLEDGERFIELD FIELDVALUE -\f[R] -.fi +.EE .PP Field assignments are the more flexible way to assign CSV values to hledger fields. @@ -4263,129 +3886,113 @@ 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 either by their -1-based position in the CSV record (\f[V]%N\f[R]) or by the name they -were given in the fields list (\f[V]%CSVFIELD\f[R]), and regular -expression match groups (\f[V]\[rs]N\f[R]). +1-based position in the CSV record (\f[CR]%N\f[R]) or by the name they +were given in the fields list (\f[CR]%CSVFIELD\f[R]), and regular +expression match groups (\f[CR]\[rs]N\f[R]). .PP Some examples: .IP -.nf -\f[C] +.EX # set the amount to the 4th CSV field, with \[dq] USD\[dq] appended amount %4 USD # combine three fields to make a comment, containing note: and date: tags comment note: %somefield - %anotherfield, date: %1 -\f[R] -.fi +.EE .PP Tips: .IP \[bu] 2 Interpolation strips outer whitespace (so a CSV value like -\f[V]\[dq] 1 \[dq]\f[R] becomes \f[V]1\f[R] when interpolated) (#1051). +\f[CR]\[dq] 1 \[dq]\f[R] becomes \f[CR]1\f[R] when interpolated) +(#1051). .IP \[bu] 2 Interpolations always refer to a CSV field - you can\[aq]t interpolate a hledger field. (See Referencing other fields below). .SS Field names -.PP Note the two kinds of field names mentioned here, and used only in hledger CSV rules files: .IP "1." 3 -\f[B]CSV field names\f[R] (\f[V]CSVFIELD\f[R] in these docs): you can +\f[B]CSV field names\f[R] (\f[CR]CSVFIELD\f[R] in these docs): you can optionally name the CSV columns for easy reference (since hledger doesn\[aq]t yet automatically recognise column headings in a CSV file), -by writing arbitrary names in a \f[V]fields\f[R] list, eg: +by writing arbitrary names in a \f[CR]fields\f[R] list, eg: .RS 4 .IP -.nf -\f[C] +.EX fields When, What, Some_Id, Net, Total, Foo, Bar -\f[R] -.fi +.EE .RE .IP "2." 3 -Special \f[B]hledger field names\f[R] (\f[V]HLEDGERFIELD\f[R] in these +Special \f[B]hledger field names\f[R] (\f[CR]HLEDGERFIELD\f[R] in these docs): you must set at least some of these to generate the hledger transaction from a CSV record, by writing them as the left hand side of a field assignment, eg: .RS 4 .IP -.nf -\f[C] +.EX date %When code %Some_Id description %What comment %Foo %Bar amount1 $ %Total -\f[R] -.fi +.EE .PP -or directly in a \f[V]fields\f[R] list: +or directly in a \f[CR]fields\f[R] list: .IP -.nf -\f[C] +.EX fields date, description, code, , amount1, Foo, Bar currency $ comment %Foo %Bar -\f[R] -.fi +.EE .RE .PP Here are all the special hledger field names available, and what happens when you assign values to them: .SS date field -.PP -Assigning to \f[V]date\f[R] sets the transaction date. +Assigning to \f[CR]date\f[R] sets the transaction date. .SS date2 field -.PP -\f[V]date2\f[R] sets the transaction\[aq]s secondary date, if any. +\f[CR]date2\f[R] sets the transaction\[aq]s secondary date, if any. .SS status field -.PP -\f[V]status\f[R] sets the transaction\[aq]s status, if any. +\f[CR]status\f[R] sets the transaction\[aq]s status, if any. .SS code field -.PP -\f[V]code\f[R] sets the transaction\[aq]s code, if any. +\f[CR]code\f[R] sets the transaction\[aq]s code, if any. .SS description field -.PP -\f[V]description\f[R] sets the transaction\[aq]s description, if any. +\f[CR]description\f[R] sets the transaction\[aq]s description, if any. .SS comment field +\f[CR]comment\f[R] sets the transaction\[aq]s comment, if any. .PP -\f[V]comment\f[R] sets the transaction\[aq]s comment, if any. -.PP -\f[V]commentN\f[R], where N is a number, sets the Nth posting\[aq]s +\f[CR]commentN\f[R], where N is a number, sets the Nth posting\[aq]s comment. .PP -You can assign multi-line comments by writing literal \f[V]\[rs]n\f[R] +You can assign multi-line comments by writing literal \f[CR]\[rs]n\f[R] in the code. -A comment starting with \f[V]\[rs]n\f[R] will begin on a new line. +A comment starting with \f[CR]\[rs]n\f[R] will begin on a new line. .PP Comments can contain tags, as usual. .SS account field -.PP -Assigning to \f[V]accountN\f[R], where N is 1 to 99, sets the account +Assigning to \f[CR]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[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, in conditional rules. +\f[CR]account1\f[R] and \f[CR]account2\f[R]. +Typically \f[CR]account1\f[R] is associated with the CSV file, and is +set once with a top-level assignment, while \f[CR]account2\f[R] is set +based on each transaction\[aq]s description, in conditional rules. .PP If a posting\[aq]s account name is left unset but its amount is set (see below), a default account name will be chosen (like \[dq]expenses:unknown\[dq] or \[dq]income:unknown\[dq]). .SS amount field -.PP There are several ways to set posting amounts from CSV, useful in different situations. .IP "1." 3 -\f[B]\f[VB]amount\f[B]\f[R] is the oldest and simplest. +\f[B]\f[CB]amount\f[B]\f[R] is the oldest and simplest. Assigning to this sets the amount of the first and second postings. In the second posting, the amount will be negated; also, if it has a cost attached, it will be converted to cost. .IP "2." 3 -\f[B]\f[VB]amount-in\f[B]\f[R] and \f[B]\f[VB]amount-out\f[B]\f[R] work +\f[B]\f[CB]amount-in\f[B]\f[R] and \f[B]\f[CB]amount-out\f[B]\f[R] work exactly like the above, but should be used when the CSV has two amount fields (such as \[dq]Debit\[dq] and \[dq]Credit\[dq], or \[dq]Inflow\[dq] and \[dq]Outflow\[dq]). @@ -4399,10 +4006,10 @@ It\[aq]s not \[dq]amount-in for posting 1 and amount-out for posting amount-out field, and use that for posting 1 and (negated) for posting 2\[dq]. .IP \[bu] 2 -Don\[aq]t use both \f[V]amount\f[R] and -\f[V]amount-in\f[R]/\f[V]amount-out\f[R] in the same rules file; choose -based on whether the amount is in a single CSV field or spread across -two fields. +Don\[aq]t use both \f[CR]amount\f[R] and +\f[CR]amount-in\f[R]/\f[CR]amount-out\f[R] in the same rules file; +choose based on whether the amount is in a single CSV field or spread +across two fields. .IP \[bu] 2 In each record, at most one of the two CSV fields should contain a non-zero amount; the other field must contain a zero or nothing. @@ -4414,7 +4021,7 @@ If the data doesn\[aq]t fit these requirements, you\[aq]ll probably need an if rule (see below). .RE .IP "3." 3 -\f[B]\f[VB]amountN\f[B]\f[R] (where N is a number from 1 to 99) sets the +\f[B]\f[CB]amountN\f[B]\f[R] (where N is a number from 1 to 99) sets the amount of only a single posting: the Nth posting in the transaction. You\[aq]ll usually need at least two such assignments to make a balanced transaction. @@ -4424,45 +4031,42 @@ The posting numbers don\[aq]t have to be consecutive; with if rules, higher posting numbers can be useful to ensure a certain order of postings. .IP "4." 3 -\f[B]\f[VB]amountN-in\f[B]\f[R] and \f[B]\f[VB]amountN-out\f[B]\f[R] +\f[B]\f[CB]amountN-in\f[B]\f[R] and \f[B]\f[CB]amountN-out\f[B]\f[R] work exactly like the above, but should be used when the CSV has two amount fields. -This is analogous to \f[V]amount-in\f[R] and \f[V]amount-out\f[R], and +This is analogous to \f[CR]amount-in\f[R] and \f[CR]amount-out\f[R], and those tips also apply here. .IP "5." 3 -Remember that a \f[V]fields\f[R] list can also do assignments. +Remember that a \f[CR]fields\f[R] list can also do assignments. So in a fields list if you name a CSV field \[dq]amount\[dq], that -counts as assigning to \f[V]amount\f[R]. +counts as assigning to \f[CR]amount\f[R]. (If you don\[aq]t want that, call it something else in the fields list, like \[dq]amount_\[dq].) .IP "6." 3 The above don\[aq]t handle every situation; if you need more -flexibility, use an \f[V]if\f[R] rule to set amounts conditionally. +flexibility, use an \f[CR]if\f[R] rule to set amounts conditionally. See \[dq]Working with CSV > Setting amounts\[dq] below for more on this and on amount-setting generally. .SS currency field -.PP -\f[V]currency\f[R] sets a currency symbol, to be prepended to all +\f[CR]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[V]currencyN\f[R] prepends a currency symbol to just the Nth +\f[CR]currencyN\f[R] prepends a currency symbol to just the Nth posting\[aq]s amount. .SS balance field -.PP -\f[V]balanceN\f[R] sets a balance assertion amount (or if the posting +\f[CR]balanceN\f[R] sets a balance assertion amount (or if the posting amount is left empty, a balance assignment) on posting N. .PP -\f[V]balance\f[R] is a compatibility spelling for hledger <1.17; it is -equivalent to \f[V]balance1\f[R]. +\f[CR]balance\f[R] is a compatibility spelling for hledger <1.17; it is +equivalent to \f[CR]balance1\f[R]. .PP You can adjust the type of assertion/assignment with the -\f[V]balance-type\f[R] rule (see below). +\f[CR]balance-type\f[R] rule (see below). .PP See Tips below for more about setting amounts and currency. -.SS \f[V]if\f[R] block -.PP +.SS \f[CR]if\f[R] block Rules can be applied conditionally, depending on patterns in the CSV data. This allows flexibility; in particular, it is how you can categorise @@ -4471,53 +4075,46 @@ description (for example). There are two ways to write conditional rules: \[dq]if blocks\[dq], described here, and \[dq]if tables\[dq], described below. .PP -An if block is the word \f[V]if\f[R] and one or more \[dq]matcher\[dq] +An if block is the word \f[CR]if\f[R] and one or more \[dq]matcher\[dq] expressions (can be a word or phrase), one per line, starting either on the same or next line; followed by one or more indented rules. Eg, .IP -.nf -\f[C] +.EX if MATCHER RULE -\f[R] -.fi +.EE .PP or .IP -.nf -\f[C] +.EX if MATCHER MATCHER MATCHER RULE RULE -\f[R] -.fi +.EE .PP If any of the matchers succeeds, all of the indented rules will be applied. They are usually field assignments, but the following special rules may also be used within an if block: .IP \[bu] 2 -\f[V]skip\f[R] - skips the matched CSV record (generating no transaction -from it) +\f[CR]skip\f[R] - skips the matched CSV record (generating no +transaction from it) .IP \[bu] 2 -\f[V]end\f[R] - skips the rest of the current CSV file. +\f[CR]end\f[R] - skips the rest of the current CSV file. .PP Some examples: .IP -.nf -\f[C] +.EX # if the record contains \[dq]groceries\[dq], set account2 to \[dq]expenses:groceries\[dq] if groceries account2 expenses:groceries -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # if the record contains any of these phrases, set account2 and a transaction comment as shown if monthly service fee @@ -4525,39 +4122,36 @@ atm transaction fee banking thru software account2 expenses:business:banking comment XXX deductible ? check it -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # if an empty record is seen (assuming five fields), ignore the rest of the CSV file if ,,,, end -\f[R] -.fi +.EE .SS Matchers -.PP There are two kinds: .IP "1." 3 A record matcher is a word or single-line text fragment or regular -expression (\f[V]REGEX\f[R]), which hledger will try to match +expression (\f[CR]REGEX\f[R]), which hledger will try to match case-insensitively anywhere within the CSV record. .PD 0 .P .PD -Eg: \f[V]whole foods\f[R] +Eg: \f[CR]whole foods\f[R] .IP "2." 3 A field matcher is preceded with a percent sign and CSV field name -(\f[V]%CSVFIELD REGEX\f[R]). +(\f[CR]%CSVFIELD REGEX\f[R]). hledger will try to match these just within the named CSV field. .PD 0 .P .PD -Eg: \f[V]%date 2023\f[R] +Eg: \f[CR]%date 2023\f[R] .PP The regular expression is (as usual in hledger) a POSIX extended regular -expression, that also supports 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]), and nothing else. +expression, that also supports GNU word boundaries (\f[CR]\[rs]b\f[R], +\f[CR]\[rs]B\f[R], \f[CR]\[rs]<\f[R], \f[CR]\[rs]>\f[R]), and nothing +else. If you have trouble, see \[dq]Regular expressions\[dq] in the hledger manual (https://hledger.org/hledger.html#regular-expressions). .PP @@ -4567,81 +4161,69 @@ converted to commas, and enclosing double quotes (but not enclosing whitespace) are removed. So for example, when reading an SSV file, if the original record was: .IP -.nf -\f[C] +.EX 2023-01-01; \[dq]Acme, Inc.\[dq]; 1,000 -\f[R] -.fi +.EE .PP the regex would see, and try to match, this modified record text: .IP -.nf -\f[C] +.EX 2023-01-01,Acme, Inc., 1,000 -\f[R] -.fi +.EE .PP When an if block has multiple matchers, they are combined as follows: .IP \[bu] 2 By default they are OR\[aq]d (any one of them can match) .IP \[bu] 2 -When a matcher is preceded by ampersand (\f[V]&\f[R]) it will be +When a matcher is preceded by ampersand (\f[CR]&\f[R]) it will be AND\[aq]ed with the previous matcher (both of them must match). .PP When a matcher is preceded by an exclamation mark (!), the matcher will be negated, ie it will exclude CSV records that match. .SS Match groups -.PP Matchers can define match groups: parenthesised portions of the regular expression which are available for reference in field assignments. -Groups are enclosed in regular parentheses (\f[V](\f[R] and \f[V])\f[R]) -and can be nested. +Groups are enclosed in regular parentheses (\f[CR](\f[R] and +\f[CR])\f[R]) and can be nested. Each group is available in field assignments using the token -\f[V]\[rs]N\f[R], where N is an index into the match groups for this +\f[CR]\[rs]N\f[R], where N is an index into the match groups for this conditional block (e.g. -\f[V]\[rs]1\f[R], \f[V]\[rs]2\f[R], etc.). +\f[CR]\[rs]1\f[R], \f[CR]\[rs]2\f[R], etc.). .PP Example: Warp credit card payment postings to the beginning of the billing period (Month start), to match how they are presented in statements, using posting dates: .IP -.nf -\f[C] +.EX if %date (....-..)-.. comment2 date:\[rs]1-01 -\f[R] -.fi +.EE .PP Another example: Read the expense account from the CSV field, but throw away a prefix: .IP -.nf -\f[C] +.EX if %account1 liabilities:family:(expenses:.*) account1 \[rs]1 -\f[R] -.fi -.SS \f[V]if\f[R] table -.PP +.EE +.SS \f[CR]if\f[R] table \[dq]if tables\[dq] are an alternative to if blocks; they can express many matchers and field assignments in a more compact tabular format, like this: .IP -.nf -\f[C] +.EX if,HLEDGERFIELD1,HLEDGERFIELD2,... MATCHERA,VALUE1,VALUE2,... MATCHERB,VALUE1,VALUE2,... MATCHERC,VALUE1,VALUE2,... -\f[R] -.fi +.EE .PP -The first character after \f[V]if\f[R] is taken to be this if +The first character after \f[CR]if\f[R] is taken to be this if table\[aq]s field separator. It is unrelated to the separator used in the CSV file. -It should be a non-alphanumeric character like \f[V],\f[R] or -\f[V]|\f[R] that does not appear anywhere else in the table (it should +It should be a non-alphanumeric character like \f[CR],\f[R] or +\f[CR]|\f[R] that does not appear anywhere else in the table (it should not be used in field names or matchers or values, and it cannot be escaped with a backslash). .PP @@ -4657,8 +4239,7 @@ line to the corresponding hledger fields; later lines can overrider earlier ones. It is equivalent to this sequence of if blocks: .IP -.nf -\f[C] +.EX if MATCHERA HLEDGERFIELD1 VALUE1 HLEDGERFIELD2 VALUE2 @@ -4673,63 +4254,52 @@ if MATCHERC HLEDGERFIELD1 VALUE1 HLEDGERFIELD2 VALUE2 ... -\f[R] -.fi +.EE .PP Example: .IP -.nf -\f[C] +.EX if,account2,comment atm transaction fee,expenses:business:banking,deductible? check it %description groceries,expenses:groceries, 2023/01/12.*Plumbing LLC,expenses:house:upkeep,emergency plumbing call-out -\f[R] -.fi -.SS \f[V]balance-type\f[R] -.PP +.EE +.SS \f[CR]balance-type\f[R] Balance assertions generated by assigning to balanceN are of the simple -\f[V]=\f[R] type by default, which is a single-commodity, +\f[CR]=\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[V]balance-type\f[R] rule: +\f[CR]balance-type\f[R] rule: .IP -.nf -\f[C] +.EX # balance assertions will consider all commodities and all subaccounts balance-type ==* -\f[R] -.fi +.EE .PP Here are the balance assertion types for quick reference: .IP -.nf -\f[C] +.EX = single commodity, exclude subaccounts =* single commodity, include subaccounts == multi commodity, exclude subaccounts ==* multi commodity, include subaccounts -\f[R] -.fi -.SS \f[V]include\f[R] +.EE +.SS \f[CR]include\f[R] .IP -.nf -\f[C] +.EX include RULESFILE -\f[R] -.fi +.EE .PP This includes the contents of another CSV rules file at this point. -\f[V]RULESFILE\f[R] is an absolute file path or a path relative to the +\f[CR]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: .IP -.nf -\f[C] +.EX # someaccount.csv.rules ## someaccount-specific rules @@ -4739,22 +4309,17 @@ account2 expenses:misc ## common rules include categorisation.rules -\f[R] -.fi +.EE .SS Working with CSV -.PP Some tips: .SS Rapid feedback -.PP It\[aq]s a good idea to get rapid feedback while creating/troubleshooting CSV rules. Here\[aq]s a good way, using entr from eradman.com/entrproject: .IP -.nf -\f[C] +.EX $ ls foo.csv* | entr bash -c \[aq]echo ----; hledger -f foo.csv print desc:SOMEDESC\[aq] -\f[R] -.fi +.EE .PP A desc: query (eg) is used to select just one, or a few, transactions of interest. @@ -4762,7 +4327,6 @@ interest. separator each time the command re-runs, making it easier to read the output. .SS Valid CSV -.PP Note that hledger will only accept valid CSV conforming to RFC 4180, and equivalent SSV and TSV formats (like RFC 4180 but with semicolon or tab as separators). @@ -4770,62 +4334,54 @@ This means, eg: .IP \[bu] 2 Values may be enclosed in double quotes, or not. Enclosing in single quotes is not allowed. -(Eg \f[V]\[aq]A\[aq],\[aq]B\[aq]\f[R] is rejected.) +(Eg \f[CR]\[aq]A\[aq],\[aq]B\[aq]\f[R] is rejected.) .IP \[bu] 2 When values are enclosed in double quotes, spaces outside the quotes are not allowed. -(Eg \f[V]\[dq]A\[dq], \[dq]B\[dq]\f[R] is rejected.) +(Eg \f[CR]\[dq]A\[dq], \[dq]B\[dq]\f[R] is rejected.) .IP \[bu] 2 When values are not enclosed in quotes, they may not contain double quotes. -(Eg \f[V]A\[dq]A, B\f[R] is rejected.) +(Eg \f[CR]A\[dq]A, B\f[R] is rejected.) .PP If your CSV/SSV/TSV is not valid in this sense, you\[aq]ll need to transform it before reading with hledger. Try using sed, or a more permissive CSV parser like python\[aq]s csv lib. .SS File Extension -.PP To help hledger choose the CSV file reader and show the right error messages (and choose the right field separator character by default), -it\[aq]s best if CSV/SSV/TSV files are named with a \f[V].csv\f[R], -\f[V].ssv\f[R] or \f[V].tsv\f[R] filename extension. +it\[aq]s best if CSV/SSV/TSV files are named with a \f[CR].csv\f[R], +\f[CR].ssv\f[R] or \f[CR].tsv\f[R] filename extension. (More about this at Data formats.) .PP When reading files with the \[dq]wrong\[dq] extension, you can ensure the CSV reader (and the default field separator) by prefixing the file -path with \f[V]csv:\f[R], \f[V]ssv:\f[R] or \f[V]tsv:\f[R]: Eg: +path with \f[CR]csv:\f[R], \f[CR]ssv:\f[R] or \f[CR]tsv:\f[R]: Eg: .IP -.nf -\f[C] +.EX $ hledger -f ssv:foo.dat print -\f[R] -.fi +.EE .PP You can also override the default field separator with a separator rule if needed. .SS Reading CSV from standard input -.PP You\[aq]ll need the file format prefix when reading CSV from stdin also, since hledger assumes journal format by default. Eg: .IP -.nf -\f[C] +.EX $ cat foo.dat | hledger -f ssv:- print -\f[R] -.fi +.EE .SS Reading multiple CSV files -.PP -If you use multiple \f[V]-f\f[R] options to read multiple CSV files at +If you use multiple \f[CR]-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[V]--rules-file\f[R] option, that rules file will +But if you use the \f[CR]--rules-file\f[R] option, that rules file will be used for all the CSV files. .SS Reading files specified by rule -.PP Instead of specifying a CSV file in the command line, you can specify a -rules file, as in \f[V]hledger -f foo.csv.rules CMD\f[R]. +rules file, as in \f[CR]hledger -f foo.csv.rules CMD\f[R]. By default this will read data from foo.csv in the same directory, but you can add a source rule to specify a different data file, perhaps located in your web browser\[aq]s download directory. @@ -4835,21 +4391,20 @@ CSV rules examples. But it helps remove some of the busywork of managing CSV downloads. Most of your financial institutions\[aq]s default CSV filenames are different and can be recognised by a glob pattern. -So you can put a rule like \f[V]source Checking1*.csv\f[R] in +So you can put a rule like \f[CR]source Checking1*.csv\f[R] in foo-checking.csv.rules, and then periodically follow a workflow like: .IP "1." 3 Download CSV from Foo\[aq]s website, using your browser\[aq]s defaults .IP "2." 3 -Run \f[V]hledger import foo-checking.csv.rules\f[R] to import any new +Run \f[CR]hledger import foo-checking.csv.rules\f[R] to import any new transactions .PP After import, you can: discard the CSV, or leave it where it is for a while, or move it into your archives, as you prefer. If you do nothing, next time your browser will save something like -Checking1-2.csv, and hledger will use that because of the \f[V]*\f[R] +Checking1-2.csv, and hledger will use that because of the \f[CR]*\f[R] wild card and because it is the most recent. .SS Valid transactions -.PP After reading a CSV file, hledger post-processes and validates the generated journal entries as it would for a journal file - balancing them, applying balance assignments, and canonicalising amount styles. @@ -4862,13 +4417,10 @@ data is part of the main journal. If you do need to check balance assertions generated from CSV right away, pipe into another hledger: .IP -.nf -\f[C] +.EX $ hledger -f file.csv print | hledger -f- print -\f[R] -.fi +.EE .SS Deduplicating, importing -.PP 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. @@ -4877,17 +4429,15 @@ 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[V].latest.FILE.csv\f[R] file.) +(It keeps state in a hidden \f[CR].latest.FILE.csv\f[R] file.) This is the easiest way to import CSV data. Eg: .IP -.nf -\f[C] +.EX # download the latest CSV files, then run this command. # Note, no -f flags needed here. $ hledger import *.csv [--dry] -\f[R] -.fi +.EE .PP This method works for most CSV files. (Where records have a stable chronological order, and new records appear @@ -4901,7 +4451,6 @@ https://hledger.org/cookbook.html#setups-and-workflows .IP \[bu] 2 https://plaintextaccounting.org -> data import/conversion .SS Setting amounts -.PP Continuing from amount field above, here are more tips for amount-setting: .IP "1." 3 @@ -4915,7 +4464,7 @@ amount-setting: .PD 0 .P .PD -Assign it to \f[V]amountN\f[R], to set the Nth posting\[aq]s amount. +Assign it to \f[CR]amountN\f[R], to set the Nth posting\[aq]s amount. N is usually 1 or 2 but can go up to 99. .IP "b." 3 \f[B]If another field indicates direction of flow:\f[R] @@ -4925,14 +4474,12 @@ N is usually 1 or 2 but can go up to 99. Use one or more conditional rules to set the appropriate amount sign. Eg: .IP -.nf -\f[C] +.EX # assume a withdrawal unless Type contains \[dq]deposit\[dq]: amount1 -%Amount if %Type deposit amount1 %Amount -\f[R] -.fi +.EE .RE .IP "2." 3 \f[B]If the amount is in two CSV fields (such as Debit and Credit, or In @@ -4946,8 +4493,8 @@ and Out):\f[R] .PD 0 .P .PD -Assign one field to \f[V]amountN-in\f[R] and the other to -\f[V]amountN-out\f[R]. +Assign one field to \f[CR]amountN-in\f[R] and the other to +\f[CR]amountN-out\f[R]. hledger will automatically negate the \[dq]out\[dq] field, and will use whichever field value is non-zero as posting N\[aq]s amount. .IP "b." 3 @@ -4958,14 +4505,12 @@ whichever field value is non-zero as posting N\[aq]s amount. You will probably need to override hledger\[aq]s sign for one or the other field, as in the following example: .IP -.nf -\f[C] +.EX # Negate the -out value, but only if it is not empty: fields date, description, amount1-in, amount1-out if %amount1-out [1-9] amount1-out -%amount1-out -\f[R] -.fi +.EE .IP "c." 3 \f[B]If both fields can contain a non-zero value (or both can be empty):\f[R] @@ -4974,67 +4519,64 @@ empty):\f[R] .PD The -in/-out rules normally choose the value which is non-zero/non-empty. -Some value pairs can be ambiguous, such as \f[V]1\f[R] and -\f[V]none\f[R]. +Some value pairs can be ambiguous, such as \f[CR]1\f[R] and +\f[CR]none\f[R]. For such cases, use conditional rules to help select the amount. Eg, to handle the above you could select the value containing non-zero digits: .IP -.nf -\f[C] +.EX fields date, description, in, out if %in [1-9] amount1 %in if %out [1-9] amount1 %out -\f[R] -.fi +.EE .RE .IP "3." 3 \f[B]If you want posting 2\[aq]s amount converted to cost:\f[R] .PD 0 .P .PD -Use the unnumbered \f[V]amount\f[R] (or \f[V]amount-in\f[R] and -\f[V]amount-out\f[R]) syntax. +Use the unnumbered \f[CR]amount\f[R] (or \f[CR]amount-in\f[R] and +\f[CR]amount-out\f[R]) syntax. .IP "4." 3 \f[B]If the CSV has only balance amounts, not transaction amounts:\f[R] .PD 0 .P .PD -Assign to \f[V]balanceN\f[R], to set a balance assignment on the Nth +Assign to \f[CR]balanceN\f[R], to set a balance assignment on the Nth posting, causing the posting\[aq]s amount to be calculated automatically. -\f[V]balance\f[R] with no number is equivalent to \f[V]balance1\f[R]. +\f[CR]balance\f[R] with no number is equivalent to \f[CR]balance1\f[R]. In this situation hledger is more likely to guess the wrong default account name, so you may need to set that explicitly. .SS Amount signs -.PP There is some special handling making it easier to parse and to reverse amount signs. (This only works for whole amounts, not for cost amounts such as COST in -\f[V]amount1 AMT \[at] COST\f[R]): +\f[CR]amount1 AMT \[at] COST\f[R]): .IP \[bu] 2 \f[B]If an amount value begins with a plus sign:\f[R] .PD 0 .P .PD -that will be removed: \f[V]+AMT\f[R] becomes \f[V]AMT\f[R] +that will be removed: \f[CR]+AMT\f[R] becomes \f[CR]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[V](AMT)\f[R] becomes -\f[V]-AMT\f[R] +it will be de-parenthesised and sign-flipped: \f[CR](AMT)\f[R] becomes +\f[CR]-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[V]--AMT\f[R] or \f[V]-(AMT)\f[R] -becomes \f[V]AMT\f[R] +they cancel out and will be removed: \f[CR]--AMT\f[R] or +\f[CR]-(AMT)\f[R] becomes \f[CR]AMT\f[R] .IP \[bu] 2 \f[B]If an amount value contains just a sign (or just a set of parentheses):\f[R] @@ -5042,106 +4584,86 @@ parentheses):\f[R] .P .PD that is removed, making it an empty value. -\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]. +\f[CR]\[dq]+\[dq]\f[R] or \f[CR]\[dq]-\[dq]\f[R] or +\f[CR]\[dq]()\[dq]\f[R] becomes \f[CR]\[dq]\[dq]\f[R]. .PP It\[aq]s not possible (without preprocessing the CSV) to set an amount to its absolute value, ie discard its sign. .SS Setting currency/commodity -.PP If the currency/commodity symbol is included in the CSV\[aq]s amount field(s): .IP -.nf -\f[C] +.EX 2023-01-01,foo,$123.00 -\f[R] -.fi +.EE .PP you don\[aq]t have to do anything special for the commodity symbol, it will be assigned as part of the amount. Eg: .IP -.nf -\f[C] +.EX fields date,description,amount -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX 2023-01-01 foo expenses:unknown $123.00 income:unknown $-123.00 -\f[R] -.fi +.EE .PP If the currency is provided as a separate CSV field: .IP -.nf -\f[C] +.EX 2023-01-01,foo,USD,123.00 -\f[R] -.fi +.EE .PP -You can assign that to the \f[V]currency\f[R] pseudo-field, which has +You can assign that to the \f[CR]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 -.nf -\f[C] +.EX fields date,description,currency,amount -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX 2023-01-01 foo expenses:unknown USD123.00 income:unknown USD-123.00 -\f[R] -.fi +.EE .PP 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: .IP -.nf -\f[C] +.EX fields date,description,cur,amt amount %amt %cur -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX 2023-01-01 foo expenses:unknown 123.00 USD income:unknown -123.00 USD -\f[R] -.fi +.EE .PP -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 +Note we used a temporary field name (\f[CR]cur\f[R]) that is not +\f[CR]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[V]amount1\f[R] influence commodity display styles, such as the number -of decimal places displayed in reports. +\f[CR]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 style (because we don\[aq]t yet reliably know their commodity). .SS Referencing other fields -.PP In field assignments, you can interpolate only CSV fields, not hledger fields. In the example below, there\[aq]s both a CSV field and a hledger field named amount1, but %amount1 always means the CSV field, not the hledger field: .IP -.nf -\f[C] +.EX # Name the third CSV field \[dq]amount1\[dq] fields date,description,amount1 @@ -5150,41 +4672,35 @@ amount1 %amount1 USD # Set comment to the CSV amount1 (not the amount1 assigned above) comment %amount1 -\f[R] -.fi +.EE .PP Here, since there\[aq]s no CSV amount1 field, %amount1 will produce a literal \[dq]amount1\[dq]: .IP -.nf -\f[C] +.EX fields date,description,csvamount amount1 %csvamount USD # Can\[aq]t interpolate amount1 here comment %amount1 -\f[R] -.fi +.EE .PP When there are multiple field assignments to the same hledger field, only the last one takes effect. Here, comment\[aq]s value will be be B, or C if \[dq]something\[dq] is matched, but never A: .IP -.nf -\f[C] +.EX comment A comment B if something comment C -\f[R] -.fi +.EE .SS How CSV rules are evaluated -.PP Here\[aq]s how to think of CSV rules being evaluated (if you really need to). First, .IP \[bu] 2 -\f[V]include\f[R] - all includes are inlined, from top to bottom, depth +\f[CR]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.) @@ -5192,25 +4708,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[V]skip\f[R] (at top level) +\f[CR]skip\f[R] (at top level) .IP \[bu] 2 -\f[V]date-format\f[R] +\f[CR]date-format\f[R] .IP \[bu] 2 -\f[V]newest-first\f[R] +\f[CR]newest-first\f[R] .IP \[bu] 2 -\f[V]fields\f[R] - names the CSV fields, optionally sets up initial +\f[CR]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[V]if\f[R] blocks. -If any of them contain a \f[V]end\f[R] rule, skip all remaining CSV +test all \f[CR]if\f[R] blocks. +If any of them contain a \f[CR]end\f[R] rule, skip all remaining CSV records. -Otherwise if any of them contain a \f[V]skip\f[R] rule, skip that many +Otherwise if any of them contain a \f[CR]skip\f[R] rule, skip that many CSV records. -If there are multiple matched \f[V]skip\f[R] rules, the first one wins. +If there are multiple matched \f[CR]skip\f[R] rules, the first one wins. .IP \[bu] 2 -collect all field assignments at top level and in matched \f[V]if\f[R] +collect all field assignments at top level and in matched \f[CR]if\f[R] blocks. When there are multiple assignments for a field, keep only the last one. .IP \[bu] 2 @@ -5225,33 +4741,28 @@ When all files have been read successfully, the transactions are passed as input to whichever hledger command the user specified. .PP .SS Well factored rules -.PP Some things than can help reduce duplication and complexity in rules files: .IP \[bu] 2 Extracting common rules usable with multiple CSV files into a -\f[V]common.rules\f[R], and adding \f[V]include common.rules\f[R] to +\f[CR]common.rules\f[R], and adding \f[CR]include common.rules\f[R] to each CSV\[aq]s rules file. .IP \[bu] 2 Splitting if blocks into smaller if blocks, extracting the frequently used parts. .SS CSV rules examples .SS Bank of Ireland -.PP Here\[aq]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 necessary but provides extra error checking: .IP -.nf -\f[C] +.EX Date,Details,Debit,Credit,Balance 07/12/2012,LODGMENT 529898,,10.0,131.21 07/12/2012,PAYMENT,5,,126 -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # bankofireland-checking.csv.rules # skip the header line @@ -5277,11 +4788,9 @@ currency EUR # set the base account for all txns account1 assets:bank:boi:checking -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger -f bankofireland-checking.csv print 2012-12-07 LODGMENT 529898 assets:bank:boi:checking EUR10.0 = EUR131.2 @@ -5290,28 +4799,23 @@ $ hledger -f bankofireland-checking.csv print 2012-12-07 PAYMENT assets:bank:boi:checking EUR-5.0 = EUR126.0 expenses:unknown EUR5.0 -\f[R] -.fi +.EE .PP The balance assertions don\[aq]t raise an error above, because we\[aq]re reading directly from CSV, but they will be checked if these entries are imported into a journal file. .SS Coinbase -.PP A simple example with some CSV from Coinbase. The spot price is recorded using cost notation. -The legacy \f[V]amount\f[R] field name conveniently sets amount 2 +The legacy \f[CR]amount\f[R] field name conveniently sets amount 2 (posting 2\[aq]s amount) to the total cost. .IP -.nf -\f[C] +.EX # Timestamp,Transaction Type,Asset,Quantity Transacted,Spot Price Currency,Spot Price at Transaction,Subtotal,Total (inclusive of fees and/or spread),Fees and/or Spread,Notes # 2021-12-30T06:57:59Z,Receive,USDC,100,GBP,0.740000,\[dq]\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]Received 100.00 USDC from an external account\[dq] -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # coinbase.csv.rules skip 1 fields Timestamp,Transaction_Type,Asset,Quantity_Transacted,Spot_Price_Currency,Spot_Price_at_Transaction,Subtotal,Total,Fees_Spread,Notes @@ -5320,34 +4824,27 @@ date-format %Y-%m-%dT%T%Z description %Notes account1 assets:coinbase:cc amount %Quantity_Transacted %Asset \[at] %Spot_Price_at_Transaction %Spot_Price_Currency -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger print -f coinbase.csv 2021-12-30 Received 100.00 USDC from an external account assets:coinbase:cc 100 USDC \[at] 0.740000 GBP income:unknown -74.000000 GBP -\f[R] -.fi +.EE .SS Amazon -.PP Here we convert amazon.com order history, and use an if block to generate a third posting if there\[aq]s a fee. (In practice you\[aq]d probably get this data from your bank instead, but it\[aq]s an example.) .IP -.nf -\f[C] +.EX \[dq]Date\[dq],\[dq]Type\[dq],\[dq]To/From\[dq],\[dq]Name\[dq],\[dq]Status\[dq],\[dq]Amount\[dq],\[dq]Fees\[dq],\[dq]Transaction ID\[dq] \[dq]Jul 29, 2012\[dq],\[dq]Payment\[dq],\[dq]To\[dq],\[dq]Foo.\[dq],\[dq]Completed\[dq],\[dq]$20.00\[dq],\[dq]$0.00\[dq],\[dq]16000000000000DGLNJPI1P9B8DKPVHL\[dq] \[dq]Jul 30, 2012\[dq],\[dq]Payment\[dq],\[dq]To\[dq],\[dq]Adapteva, Inc.\[dq],\[dq]Completed\[dq],\[dq]$25.00\[dq],\[dq]$1.00\[dq],\[dq]17LA58JSKRD4HDGLNJPI1P9B8DKPVHL\[dq] -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # amazon-orders.csv.rules # skip one header line @@ -5381,11 +4878,9 @@ amount2 %amzamount if %fees [1-9] account3 expenses:fees amount3 %fees -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger -f amazon-orders.csv print 2012-07-29 (16000000000000DGLNJPI1P9B8DKPVHL) To Foo. ; status:Completed assets:amazon @@ -5395,15 +4890,12 @@ $ hledger -f amazon-orders.csv print assets:amazon expenses:misc $25.00 expenses:fees $1.00 -\f[R] -.fi +.EE .SS Paypal -.PP Here\[aq]s a real-world rules file for (customised) Paypal CSV, with some Paypal-specific rules, and a second rules file included: .IP -.nf -\f[C] +.EX \[dq]Date\[dq],\[dq]Time\[dq],\[dq]TimeZone\[dq],\[dq]Name\[dq],\[dq]Type\[dq],\[dq]Status\[dq],\[dq]Currency\[dq],\[dq]Gross\[dq],\[dq]Fee\[dq],\[dq]Net\[dq],\[dq]From Email Address\[dq],\[dq]To Email Address\[dq],\[dq]Transaction ID\[dq],\[dq]Item Title\[dq],\[dq]Item ID\[dq],\[dq]Reference Txn ID\[dq],\[dq]Receipt ID\[dq],\[dq]Balance\[dq],\[dq]Note\[dq] \[dq]10/01/2019\[dq],\[dq]03:46:20\[dq],\[dq]PDT\[dq],\[dq]Calm Radio\[dq],\[dq]Subscription Payment\[dq],\[dq]Completed\[dq],\[dq]USD\[dq],\[dq]-6.99\[dq],\[dq]0.00\[dq],\[dq]-6.99\[dq],\[dq]simon\[at]joyful.com\[dq],\[dq]memberships\[at]calmradio.com\[dq],\[dq]60P57143A8206782E\[dq],\[dq]MONTHLY - $1 for the first 2 Months: Me - Order 99309. Item total: $1.00 USD first 2 months, then $6.99 / Month\[dq],\[dq]\[dq],\[dq]I-R8YLY094FJYR\[dq],\[dq]\[dq],\[dq]-6.99\[dq],\[dq]\[dq] \[dq]10/01/2019\[dq],\[dq]03:46:20\[dq],\[dq]PDT\[dq],\[dq]\[dq],\[dq]Bank Deposit to PP Account \[dq],\[dq]Pending\[dq],\[dq]USD\[dq],\[dq]6.99\[dq],\[dq]0.00\[dq],\[dq]6.99\[dq],\[dq]\[dq],\[dq]simon\[at]joyful.com\[dq],\[dq]0TU1544T080463733\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]60P57143A8206782E\[dq],\[dq]\[dq],\[dq]0.00\[dq],\[dq]\[dq] @@ -5412,11 +4904,9 @@ some Paypal-specific rules, and a second rules file included: \[dq]10/19/2019\[dq],\[dq]03:02:12\[dq],\[dq]PDT\[dq],\[dq]Wikimedia Foundation, Inc.\[dq],\[dq]Subscription Payment\[dq],\[dq]Completed\[dq],\[dq]USD\[dq],\[dq]-2.00\[dq],\[dq]0.00\[dq],\[dq]-2.00\[dq],\[dq]simon\[at]joyful.com\[dq],\[dq]tle\[at]wikimedia.org\[dq],\[dq]K9U43044RY432050M\[dq],\[dq]Monthly donation to the Wikimedia Foundation\[dq],\[dq]\[dq],\[dq]I-R5C3YUS3285L\[dq],\[dq]\[dq],\[dq]-2.00\[dq],\[dq]\[dq] \[dq]10/19/2019\[dq],\[dq]03:02:12\[dq],\[dq]PDT\[dq],\[dq]\[dq],\[dq]Bank Deposit to PP Account \[dq],\[dq]Pending\[dq],\[dq]USD\[dq],\[dq]2.00\[dq],\[dq]0.00\[dq],\[dq]2.00\[dq],\[dq]\[dq],\[dq]simon\[at]joyful.com\[dq],\[dq]3XJ107139A851061F\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]K9U43044RY432050M\[dq],\[dq]\[dq],\[dq]0.00\[dq],\[dq]\[dq] \[dq]10/22/2019\[dq],\[dq]05:07:06\[dq],\[dq]PDT\[dq],\[dq]Noble Benefactor\[dq],\[dq]Subscription Payment\[dq],\[dq]Completed\[dq],\[dq]USD\[dq],\[dq]10.00\[dq],\[dq]-0.59\[dq],\[dq]9.41\[dq],\[dq]noble\[at]bene.fac.tor\[dq],\[dq]simon\[at]joyful.com\[dq],\[dq]6L8L1662YP1334033\[dq],\[dq]Joyful Systems\[dq],\[dq]\[dq],\[dq]I-KC9VBGY2GWDB\[dq],\[dq]\[dq],\[dq]9.41\[dq],\[dq]\[dq] -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # paypal-custom.csv.rules # Tips: @@ -5498,11 +4988,9 @@ Bank Deposit to PP Account # Currency conversions if Currency Conversion account2 equity:currency conversion -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX # common.rules if @@ -5525,11 +5013,9 @@ Advent of Code if Google account2 expenses:online:apps description google | music -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger -f paypal-custom.csv print 2019-10-01 (60P57143A8206782E) Calm Radio MONTHLY - $1 for the first 2 Months: Me - Order 99309. Item total: $1.00 USD first 2 months, then $6.99 / Month ; itemid:, fromemail:simon\[at]joyful.com, toemail:memberships\[at]calmradio.com, time:03:46:20, type:Subscription Payment, status:Completed assets:online:paypal $-6.99 = $-6.99 @@ -5560,10 +5046,8 @@ $ hledger -f paypal-custom.csv print assets:online:paypal $9.41 = $9.41 revenues:foss donations:darcshub $-10.00 ; business: expenses:banking:paypal $0.59 ; business: -\f[R] -.fi +.EE .SH Timeclock -.PP The time logging format of timeclock.el, as read by hledger. .PP hledger can read time logs in timeclock format. @@ -5574,27 +5058,24 @@ 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). -Lines beginning with \f[V]#\f[R] or \f[V];\f[R] or \f[V]*\f[R], and +Lines beginning with \f[CR]#\f[R] or \f[CR];\f[R] or \f[CR]*\f[R], and blank lines, are ignored. .IP -.nf -\f[C] +.EX i 2015/03/30 09:00:00 some account optional description after 2 spaces ; optional comment, tags: o 2015/03/30 09:20:00 i 2015/03/31 22:21:45 another:account o 2015/04/01 02:00:34 -\f[R] -.fi +.EE .PP 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[V]hledger print\f[R] generates these journal +For the above time log, \f[CR]hledger print\f[R] generates these journal entries: .IP -.nf -\f[C] +.EX $ hledger -f t.timeclock print 2015-03-30 * optional description after 2 spaces ; optional comment, tags: (some account) 0.33h @@ -5604,18 +5085,15 @@ $ hledger -f t.timeclock print 2015-04-01 * 00:00-02:00 (another:account) 2.01h -\f[R] -.fi +.EE .PP Here is a sample.timeclock to download and some queries to try: .IP -.nf -\f[C] +.EX $ hledger -f sample.timeclock balance # current time balances $ hledger -f sample.timeclock register -p 2009/3 # sessions in march 2009 $ hledger -f sample.timeclock register -p weekly --depth 1 --empty # time summary by week -\f[R] -.fi +.EE .PP To generate time logs, ie to clock in and clock out, you could: .IP \[bu] 2 @@ -5623,119 +5101,109 @@ 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[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] +\f[CR]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[V]ti\f[R] and \f[V]to\f[R] scripts in the ledger 2.x +or use the old \f[CR]ti\f[R] and \f[CR]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. .PP .SH Timedot -.PP -\f[V]timedot\f[R] format is hledger\[aq]s human-friendly time logging +\f[CR]timedot\f[R] format is hledger\[aq]s human-friendly time logging format. -Compared to \f[V]timeclock\f[R] format, it is -.IP \[bu] 2 -convenient for quick, approximate, and retroactive time logging -.IP \[bu] 2 -readable: you can see at a glance where time was spent. -.PP -A timedot file contains a series of day entries, which might look like -this: +Compared to \f[CR]timeclock\f[R] format, it is more convenient for +quick, approximate, and retroactive time logging, and more +human-readable (you can see at a glance where time was spent). +A quick example: .IP -.nf -\f[C] +.EX 2023-05-01 -hom:errands .... .... ; two hours +hom:errands .... .... ; two hours; the space is ignored fos:hledger:timedot .. ; half an hour -per:admin:finance -\f[R] -.fi +per:admin:finance ; no time spent yet +.EE .PP hledger reads this as a transaction on this day with three (unbalanced) postings, where each dot represents \[dq]0.25\[dq]. -No commodity is assumed, but normally we interpret it as hours, with -each dot representing a quarter-hour. -It\[aq]s convenient, though not required, to group the dots in fours for -easy reading. +No commodity symbol is assumed, but we typically interpret it as hours. .IP -.nf -\f[C] +.EX $ hledger -f a.timedot print # .timedot file extension (or timedot: prefix) is required 2023-05-01 * (hom:errands) 2.00 ; two hours (fos:hledger:timedot) 0.50 ; half an hour (per:admin:finance) 0 -\f[R] -.fi +.EE .PP -A transaction begins with a non-indented \f[B]simple date\f[R] (Y-M-D, -Y/M/D, or Y.M.D). -It can optionally be preceded by one or more stars and a space, for -Emacs org mode compatibility. -It can optionally be followed on the same line by a transaction -description, and/or a transaction comment following a semicolon. +A timedot file contains a series of transactions (usually one per day). +Each begins with a \f[B]simple date\f[R] (Y-M-D, Y/M/D, or Y.M.D), +optionally be followed on the same line by a transaction description, +and/or a transaction comment following a semicolon. .PP After the date line are zero or more time postings, consisting of: .IP \[bu] 2 -an \f[B]account name\f[R] - any hledger-style account name, optionally -hierarchical, optionally indented. +\f[B]An account name\f[R] - any hledger-style account name, optionally +indented. .IP \[bu] 2 -\f[B]two or more spaces\f[R] - a field separator, required if there is -an amount (as in journal format). +\f[B]Two or more spaces\f[R] - required if there is an amount (as in +journal format). .IP \[bu] 2 -an optional \f[B]timedot amount\f[R] - dots representing quarter hours, -or a number representing hours, optionally with a unit suffix. +\f[B]A timedot amount\f[R], which can be +.RS 2 .IP \[bu] 2 -an optional \f[B]posting comment\f[R] following a semicolon. +empty (representing zero) +.IP \[bu] 2 +a number, optionally followed by a unit \f[CR]s\f[R], \f[CR]m\f[R], +\f[CR]h\f[R], \f[CR]d\f[R], \f[CR]w\f[R], \f[CR]mo\f[R], or +\f[CR]y\f[R], representing a precise number of seconds, minutes, hours, +days weeks, months or years (hours is assumed by default), which will be +converted to hours according to 60s = 1m, 60m = 1h, 24h = 1d, 7d = 1w, +30d = 1mo, 365d = 1y. +.IP \[bu] 2 +one or more dots (period characters), each representing 0.25. +These are the dots in \[dq]timedot\[dq]. +Spaces are ignored and can be used for grouping/alignment. +.IP \[bu] 2 +one or more letters. +These are like dots but they also generate a tag \f[CR]t:\f[R] (short +for \[dq]type\[dq]) with the letter as its value, and a separate posting +for each of the values. +This provides a second dimension of categorisation, viewable in reports +with \f[CR]--pivot t\f[R]. +.RE +.IP \[bu] 2 +\f[B]An optional comment\f[R] following a semicolon (a hledger-style +posting comment). .PP -Timedot amounts can be: +There is some flexibility to help with keeping time log data and notes +in the same file: .IP \[bu] 2 -\f[B]dots\f[R]: zero or more period characters (\f[V].\f[R]), each -representing 0.25. -Spaces are ignored and can be used for grouping. -Eg: \f[V].... ..\f[R] -.IP \[bu] 2 -or a \f[B]number\f[R]. -Eg: \f[V]1.5\f[R] -.IP \[bu] 2 -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]. -These are interpreted as seconds, minutes, hours, days weeks, months or -years, and converted to hours, assuming: -.PD 0 -.P -.PD -\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]. -Eg \f[V]90m\f[R] is parsed as \f[V]1.5\f[R]. -.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 -Blank lines and lines beginning with \f[V]#\f[R] or \f[V];\f[R] are +Blank lines and lines beginning with \f[CR]#\f[R] or \f[CR];\f[R] are ignored. .IP \[bu] 2 -Before the first date line, lines beginning with \f[V]*\f[R] are -ignored. +After the first date line, lines which do not contain a double space are +parsed as postings with zero amount. +(hledger\[aq]s register reports will show these if you add -E). .IP \[bu] 2 -From the first date line onward, one or more \f[V]*\f[R]\[aq]s followed -by a space at beginning of lines (ie, the headline prefix used by Emacs -Org mode) is ignored. -This means the time log can be kept under an Org headline, and date -lines or time transaction lines can be Org headlines. -.IP \[bu] 2 -Lines not ending with a double-space and amount are parsed as postings -with zero amount. -Note hledger\[aq]s register reports hide these by default (add -E to see -them). -.PP -More examples: +Before the first date line, lines beginning with \f[CR]*\f[R] (eg org +headings) are ignored. +And from the first date line onward, Emacs org mode heading prefixes at +the start of lines (one or more \f[CR]*\f[R]\[aq]s followed by a space) +will be ignored. +This means the time log can also be a org outline. +.SS Timedot examples +Numbers: .IP -.nf -\f[C] +.EX +2016/2/3 +inc:client1 4 +fos:hledger 3h +biz:research 60m +.EE +.PP +Dots: +.IP +.EX # on this day, 6h was spent on client work, 1.5h on haskell FOSS work, etc. 2016/2/1 inc:client1 .... .... .... .... .... .... @@ -5745,29 +5213,74 @@ biz:research . 2016/2/2 inc:client1 .... .... biz:research . -\f[R] -.fi +.EE .IP -.nf -\f[C] -2016/2/3 -inc:client1 4 -fos:hledger 3 -biz:research 1 -\f[R] -.fi +.EX +$ hledger -f a.timedot print date:2016/2/2 +2016-02-02 * + (inc:client1) 2.00 + +2016-02-02 * + (biz:research) 0.25 +.EE .IP -.nf -\f[C] -* Time log -** 2023-01-01 -*** adm:time . -*** adm:finance . -\f[R] -.fi +.EX +$ hledger -f a.timedot bal --daily --tree +Balance changes in 2016-02-01-2016-02-03: + + || 2016-02-01d 2016-02-02d 2016-02-03d +============++======================================== + biz || 0.25 0.25 1.00 + research || 0.25 0.25 1.00 + fos || 1.50 0 3.00 + haskell || 1.50 0 0 + hledger || 0 0 3.00 + inc || 6.00 2.00 4.00 + client1 || 6.00 2.00 4.00 +------------++---------------------------------------- + || 7.75 2.25 8.00 +.EE +.PP +Letters: .IP -.nf -\f[C] +.EX +# Activity types: +# c cleanup/catchup/repair +# e enhancement +# s support +# l learning/research + +2023-11-01 +work:adm ccecces +.EE +.IP +.EX +$ hledger -f a.timedot print +2023-11-01 + (work:adm) 1 ; t:c + (work:adm) 0.5 ; t:e + (work:adm) 0.25 ; t:s +.EE +.IP +.EX +$ hledger -f a.timedot bal + 1.75 work:adm +-------------------- + 1.75 +.EE +.IP +.EX +$ hledger -f a.timedot bal --pivot t + 1.00 c + 0.50 e + 0.25 s +-------------------- + 1.75 +.EE +.PP +Org: +.IP +.EX * 2023 Work Diary ** Q1 *** 2023-02-29 @@ -5783,71 +5296,63 @@ hom:chores **** TODO adm:planning: trip *** LATER -\f[R] -.fi +.EE .PP -Reporting: +Using \f[CR].\f[R] as account name separator: .IP -.nf -\f[C] -$ hledger -f a.timedot print date:2016/2/2 -2016-02-02 * - (inc:client1) 2.00 - -2016-02-02 * - (biz:research) 0.25 -\f[R] -.fi -.IP -.nf -\f[C] -$ hledger -f a.timedot bal --daily --tree -Balance changes in 2016-02-01-2016-02-03: - - || 2016-02-01d 2016-02-02d 2016-02-03d -============++======================================== - biz || 0.25 0.25 1.00 - research || 0.25 0.25 1.00 - fos || 1.50 0 3.00 - haskell || 1.50 0 0 - hledger || 0 0 3.00 - inc || 6.00 2.00 4.00 - client1 || 6.00 2.00 4.00 -------------++---------------------------------------- - || 7.75 2.25 8.00 -\f[R] -.fi -.PP -Using period instead of colon as account name separator: -.IP -.nf -\f[C] +.EX 2016/2/4 -fos.hledger.timedot 4 +fos.hledger.timedot 4h fos.ledger .. -\f[R] -.fi +.EE .IP -.nf -\f[C] -$ hledger -f a.timedot --alias /\[rs]\[rs]./=: bal --tree +.EX +$ hledger -f a.timedot --alias \[aq]/\[rs]./=:\[aq] bal -t 4.50 fos 4.00 hledger:timedot 0.50 ledger -------------------- 4.50 -\f[R] -.fi -.PP -A sample.timedot file. +.EE .SH PART 3: REPORTING CONCEPTS .SH Amount formatting, parseability +If you\[aq]re wondering why your \f[CR]print\f[R] report sometimes shows +trailing decimal marks, with no decimal digits; it does this when +showing amounts that have digit group marks but no decimal digits, to +disambiguate them and allow them to be re-parsed reliably (see also +Decimal marks, digit group marks. +Eg: +.IP +.EX +commodity $1,000.00 + +2023-01-02 + (a) $1000 +.EE +.IP +.EX +$ hledger print +2023-01-02 + (a) $1,000. +.EE .PP -If you\[aq]re wondering why your \f[V]print\f[R] report sometimes shows -trailing decimal marks, even when there are no decimal digits; it does -this to disambiguate ambiguous amounts (amounts which have one digit -group mark and no decimal digits), allowing them to be re-parsed -reliably. +If this is a problem (eg when exporting to Ledger), you can avoid it by +disabling digit group marks, eg with -c/--commodity (for each affected +commodity): +.IP +.EX +$ hledger print -c \[aq]$1000.00\[aq] +2023-01-02 + (a) $1000 +.EE +.PP +or by forcing print to always show decimal digits, with --round: +.IP +.EX +$ hledger print -c \[aq]$1,000.00\[aq] --round=soft +2023-01-02 + (a) $1,000.00 +.EE .PP More generally: hledger output falls into three rough categories, which format amounts a little bit differently to suit different consumers: @@ -5857,8 +5362,8 @@ format amounts a little bit differently to suit different consumers: by humans)\f[R] .IP \[bu] 2 This is produced by reports that show full journal entries: -\f[V]print\f[R], \f[V]import\f[R], \f[V]close\f[R], \f[V]rewrite\f[R] -etc. +\f[CR]print\f[R], \f[CR]import\f[R], \f[CR]close\f[R], +\f[CR]rewrite\f[R] etc. .IP \[bu] 2 It shows amounts with their original journal precisions, which may not be consistent. @@ -5887,7 +5392,7 @@ mark is a digit group mark). \[dq]machine-readable output\[dq] - usually for other software\f[R] .IP \[bu] 2 This is produced by all reports when an output format like -\f[V]csv\f[R], \f[V]tsv\f[R], \f[V]json\f[R], or \f[V]sql\f[R] is +\f[CR]csv\f[R], \f[CR]tsv\f[R], \f[CR]json\f[R], or \f[CR]sql\f[R] is selected. .IP \[bu] 2 It shows amounts as 1 or 2 do, but without digit group marks. @@ -5895,9 +5400,7 @@ It shows amounts as 1 or 2 do, but without digit group marks. It can be parsed reliably (if needed, the decimal mark can be changed with -c/--commodity-style). .SH Time periods -.PP .SS Report start & end date -.PP By default, most hledger reports will show the full span of time represented by the journal. The report start date will be the earliest transaction or posting date, @@ -5906,8 +5409,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[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 +You can specify a start and/or end date using \f[CR]-b/--begin\f[R], +\f[CR]-e/--end\f[R], \f[CR]-p/--period\f[R] or a \f[CR]date:\f[R] query (described below). All of these accept the smart date syntax (below). .PP @@ -5921,8 +5424,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[V]date:\f[R] queries. -That is, \f[V]date:2019-01 date:2019 -p\[aq]2000 to 2030\[aq]\f[R] +start/end dates from options and that from \f[CR]date:\f[R] queries. +That is, \f[CR]date:2019-01 date:2019 -p\[aq]2000 to 2030\[aq]\f[R] yields January 2019, the smallest common time span. .IP \[bu] 2 In some cases a report interval will adjust start/end dates to fall on @@ -5934,47 +5437,46 @@ Examples: tab(@); lw(12.4n) lw(57.6n). T{ -\f[V]-b 2016/3/17\f[R] +\f[CR]-b 2016/3/17\f[R] T}@T{ begin on St.\ Patrick\[cq]s day 2016 T} T{ -\f[V]-e 12/1\f[R] +\f[CR]-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[V]-b thismonth\f[R] +\f[CR]-b thismonth\f[R] T}@T{ all transactions on or after the 1st of the current month T} T{ -\f[V]-p thismonth\f[R] +\f[CR]-p thismonth\f[R] T}@T{ all transactions in the current month T} T{ -\f[V]date:2016/3/17..\f[R] +\f[CR]date:2016/3/17..\f[R] T}@T{ -the above written as queries instead (\f[V]..\f[R] can also be replaced -with \f[V]-\f[R]) +the above written as queries instead (\f[CR]..\f[R] can also be replaced +with \f[CR]-\f[R]) T} T{ -\f[V]date:..12/1\f[R] +\f[CR]date:..12/1\f[R] T}@T{ T} T{ -\f[V]date:thismonth..\f[R] +\f[CR]date:thismonth..\f[R] T}@T{ T} T{ -\f[V]date:thismonth\f[R] +\f[CR]date:thismonth\f[R] T}@T{ T} .TE .SS Smart dates -.PP hledger\[aq]s user interfaces accept a \[dq]smart date\[dq] syntax for added convenience. Smart dates optionally can be relative to today\[aq]s date, be written @@ -5986,68 +5488,68 @@ Some examples: tab(@); lw(24.2n) lw(45.8n). T{ -\f[V]2004/10/1\f[R], \f[V]2004-01-01\f[R], \f[V]2004.9.1\f[R] +\f[CR]2004/10/1\f[R], \f[CR]2004-01-01\f[R], \f[CR]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[V]2004\f[R] +\f[CR]2004\f[R] T}@T{ start of year T} T{ -\f[V]2004/10\f[R] +\f[CR]2004/10\f[R] T}@T{ start of month T} T{ -\f[V]10/1\f[R] +\f[CR]10/1\f[R] T}@T{ month and day in current year T} T{ -\f[V]21\f[R] +\f[CR]21\f[R] T}@T{ day in current month T} T{ -\f[V]october, oct\f[R] +\f[CR]october, oct\f[R] T}@T{ start of month in current year T} T{ -\f[V]yesterday, today, tomorrow\f[R] +\f[CR]yesterday, today, tomorrow\f[R] T}@T{ -1, 0, 1 days from today T} T{ -\f[V]last/this/next day/week/month/quarter/year\f[R] +\f[CR]last/this/next day/week/month/quarter/year\f[R] T}@T{ -1, 0, 1 periods from the current period T} T{ -\f[V]in n days/weeks/months/quarters/years\f[R] +\f[CR]in n days/weeks/months/quarters/years\f[R] T}@T{ n periods from the current period T} T{ -\f[V]n days/weeks/months/quarters/years ahead\f[R] +\f[CR]n days/weeks/months/quarters/years ahead\f[R] T}@T{ n periods from the current period T} T{ -\f[V]n days/weeks/months/quarters/years ago\f[R] +\f[CR]n days/weeks/months/quarters/years ago\f[R] T}@T{ -n periods from the current period T} T{ -\f[V]20181201\f[R] +\f[CR]20181201\f[R] T}@T{ 8 digit YYYYMMDD with valid year month and day T} T{ -\f[V]201812\f[R] +\f[CR]201812\f[R] T}@T{ 6 digit YYYYMM with valid year and month T} @@ -6060,54 +5562,52 @@ results: tab(@); lw(11.4n) lw(58.6n). T{ -\f[V]201813\f[R] +\f[CR]201813\f[R] T}@T{ 6 digits with an invalid month is parsed as start of 6-digit year T} T{ -\f[V]20181301\f[R] +\f[CR]20181301\f[R] T}@T{ 8 digits with an invalid month is parsed as start of 8-digit year T} T{ -\f[V]20181232\f[R] +\f[CR]20181232\f[R] T}@T{ 8 digits with an invalid day gives an error T} T{ -\f[V]201801012\f[R] +\f[CR]201801012\f[R] T}@T{ 9+ digits beginning with a valid YYYYMMDD gives an error T} .TE .PP -\[dq]Today\[aq]s date\[dq] can be overridden with the \f[V]--today\f[R] +\[dq]Today\[aq]s date\[dq] can be overridden with the \f[CR]--today\f[R] option, in case it\[aq]s needed for testing or for recreating old reports. (Except for periodic transaction rules, which are not affected by -\f[V]--today\f[R].) +\f[CR]--today\f[R].) .SS Report intervals -.PP A report interval can be specified so that reports like register, balance or activity become multi-period, showing each subperiod as a separate row or column. .PP The following standard intervals can be enabled with command-line flags: .IP \[bu] 2 -\f[V]-D/--daily\f[R] +\f[CR]-D/--daily\f[R] .IP \[bu] 2 -\f[V]-W/--weekly\f[R] +\f[CR]-W/--weekly\f[R] .IP \[bu] 2 -\f[V]-M/--monthly\f[R] +\f[CR]-M/--monthly\f[R] .IP \[bu] 2 -\f[V]-Q/--quarterly\f[R] +\f[CR]-Q/--quarterly\f[R] .IP \[bu] 2 -\f[V]-Y/--yearly\f[R] +\f[CR]-Y/--yearly\f[R] .PP -More complex intervals can be specified using \f[V]-p/--period\f[R], +More complex intervals can be specified using \f[CR]-p/--period\f[R], described below. .SS Date adjustment -.PP When there is a report interval (other than daily), report start/end dates which have been inferred, eg from the journal, are automatically adjusted to natural period boundaries. @@ -6121,16 +5621,15 @@ an inferred end date will be adjusted later if needed to make the last period the same length as the others. .PP By contrast, start/end dates which have been specified explicitly, with -\f[V]-b\f[R], \f[V]-e\f[R], \f[V]-p\f[R] or \f[V]date:\f[R], will not be -adjusted (since hledger 1.29). +\f[CR]-b\f[R], \f[CR]-e\f[R], \f[CR]-p\f[R] or \f[CR]date:\f[R], will +not be adjusted (since hledger 1.29). This makes it possible to specify non-standard report periods, but it also means that if you are specifying a start date, you should pick one that\[aq]s on a period boundary if you want to see simple report period headings. .SS Period expressions -.PP -The \f[V]-p/--period\f[R] option specifies a period expression, which is -a compact way of expressing a start date, end date, and/or report +The \f[CR]-p/--period\f[R] option specifies a period expression, which +is a compact way of expressing a start date, end date, and/or report interval. .PP Here\[aq]s a period expression with a start and end date (specifying the @@ -6140,7 +5639,7 @@ first quarter of 2009): tab(@); l. T{ -\f[V]-p \[dq]from 2009/1/1 to 2009/4/1\[dq]\f[R] +\f[CR]-p \[dq]from 2009/1/1 to 2009/4/1\[dq]\f[R] T} .TE .PP @@ -6155,13 +5654,13 @@ So the following are equivalent to the above: tab(@); l. T{ -\f[V]-p \[dq]2009/1/1 2009/4/1\[dq]\f[R] +\f[CR]-p \[dq]2009/1/1 2009/4/1\[dq]\f[R] T} T{ -\f[V]-p2009/1/1to2009/4/1\f[R] +\f[CR]-p2009/1/1to2009/4/1\f[R] T} T{ -\f[V]-p2009/1/1..2009/4/1\f[R] +\f[CR]-p2009/1/1..2009/4/1\f[R] T} .TE .PP @@ -6172,13 +5671,13 @@ equivalent to the above: tab(@); l. T{ -\f[V]-p \[dq]1/1 4/1\[dq]\f[R] +\f[CR]-p \[dq]1/1 4/1\[dq]\f[R] T} T{ -\f[V]-p \[dq]jan-apr\[dq]\f[R] +\f[CR]-p \[dq]jan-apr\[dq]\f[R] T} T{ -\f[V]-p \[dq]this year to 4/1\[dq]\f[R] +\f[CR]-p \[dq]this year to 4/1\[dq]\f[R] T} .TE .PP @@ -6189,22 +5688,22 @@ earliest or latest transaction date in the journal: tab(@); l l. T{ -\f[V]-p \[dq]from 2009/1/1\[dq]\f[R] +\f[CR]-p \[dq]from 2009/1/1\[dq]\f[R] T}@T{ everything after january 1, 2009 T} T{ -\f[V]-p \[dq]since 2009/1\[dq]\f[R] +\f[CR]-p \[dq]since 2009/1\[dq]\f[R] T}@T{ the same, since is a synonym T} T{ -\f[V]-p \[dq]from 2009\[dq]\f[R] +\f[CR]-p \[dq]from 2009\[dq]\f[R] T}@T{ the same T} T{ -\f[V]-p \[dq]to 2009\[dq]\f[R] +\f[CR]-p \[dq]to 2009\[dq]\f[R] T}@T{ everything before january 1, 2009 T} @@ -6216,17 +5715,17 @@ You can also specify a period by writing a single partial or full date: tab(@); lw(14.5n) lw(55.5n). T{ -\f[V]-p \[dq]2009\[dq]\f[R] +\f[CR]-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[V]-p \[dq]2009/1\[dq]\f[R] +\f[CR]-p \[dq]2009/1\[dq]\f[R] T}@T{ the month of january 2009; equivalent to \[lq]2009/1/1 to 2009/2/1\[rq] T} T{ -\f[V]-p \[dq]2009/1/1\[dq]\f[R] +\f[CR]-p \[dq]2009/1/1\[dq]\f[R] T}@T{ the first day of 2009; equivalent to \[lq]2009/1/1 to 2009/1/2\[rq] T} @@ -6238,71 +5737,69 @@ or by using the \[dq]Q\[dq] quarter-year syntax (case insensitive): tab(@); lw(15.3n) lw(54.7n). T{ -\f[V]-p \[dq]2009Q1\[dq]\f[R] +\f[CR]-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[V]-p \[dq]q4\[dq]\f[R] +\f[CR]-p \[dq]q4\[dq]\f[R] T}@T{ fourth quarter of the current year T} .TE .SS Period expressions with a report interval -.PP A period expression can also begin with a report interval, separated -from the start/end dates (if any) by a space or the word \f[V]in\f[R]: +from the start/end dates (if any) by a space or the word \f[CR]in\f[R]: .PP .TS tab(@); l. T{ -\f[V]-p \[dq]weekly from 2009/1/1 to 2009/4/1\[dq]\f[R] +\f[CR]-p \[dq]weekly from 2009/1/1 to 2009/4/1\[dq]\f[R] T} T{ -\f[V]-p \[dq]monthly in 2008\[dq]\f[R] +\f[CR]-p \[dq]monthly in 2008\[dq]\f[R] T} T{ -\f[V]-p \[dq]quarterly\[dq]\f[R] +\f[CR]-p \[dq]quarterly\[dq]\f[R] T} .TE .SS More complex report intervals -.PP Some more complex intervals can be specified within period expressions, such as: .IP \[bu] 2 -\f[V]biweekly\f[R] (every two weeks) +\f[CR]biweekly\f[R] (every two weeks) .IP \[bu] 2 -\f[V]fortnightly\f[R] +\f[CR]fortnightly\f[R] .IP \[bu] 2 -\f[V]bimonthly\f[R] (every two months) +\f[CR]bimonthly\f[R] (every two months) .IP \[bu] 2 -\f[V]every day|week|month|quarter|year\f[R] +\f[CR]every day|week|month|quarter|year\f[R] .IP \[bu] 2 -\f[V]every N days|weeks|months|quarters|years\f[R] +\f[CR]every N days|weeks|months|quarters|years\f[R] .PP Weekly on a custom day: .IP \[bu] 2 -\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) +\f[CR]every Nth day of week\f[R] (\f[CR]th\f[R], \f[CR]nd\f[R], +\f[CR]rd\f[R], or \f[CR]st\f[R] are all accepted after the number) .IP \[bu] 2 -\f[V]every WEEKDAYNAME\f[R] (full or three-letter english weekday name, +\f[CR]every WEEKDAYNAME\f[R] (full or three-letter english weekday name, case insensitive) .PP Monthly on a custom day: .IP \[bu] 2 -\f[V]every Nth day [of month]\f[R] +\f[CR]every Nth day [of month]\f[R] .IP \[bu] 2 -\f[V]every Nth WEEKDAYNAME [of month]\f[R] +\f[CR]every Nth WEEKDAYNAME [of month]\f[R] .PP Yearly on a custom day: .IP \[bu] 2 -\f[V]every MM/DD [of year]\f[R] (month number and day of month number) +\f[CR]every MM/DD [of year]\f[R] (month number and day of month number) .IP \[bu] 2 -\f[V]every MONTHNAME DDth [of year]\f[R] (full or three-letter english +\f[CR]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[V]every DDth MONTHNAME [of year]\f[R] (equivalent to the above) +\f[CR]every DDth MONTHNAME [of year]\f[R] (equivalent to the above) .PP Examples: .PP @@ -6310,49 +5807,49 @@ Examples: tab(@); lw(26.8n) lw(43.2n). T{ -\f[V]-p \[dq]bimonthly from 2008\[dq]\f[R] +\f[CR]-p \[dq]bimonthly from 2008\[dq]\f[R] T}@T{ T} T{ -\f[V]-p \[dq]every 2 weeks\[dq]\f[R] +\f[CR]-p \[dq]every 2 weeks\[dq]\f[R] T}@T{ T} T{ -\f[V]-p \[dq]every 5 months from 2009/03\[dq]\f[R] +\f[CR]-p \[dq]every 5 months from 2009/03\[dq]\f[R] T}@T{ T} T{ -\f[V]-p \[dq]every 2nd day of week\[dq]\f[R] +\f[CR]-p \[dq]every 2nd day of week\[dq]\f[R] T}@T{ periods will go from Tue to Tue T} T{ -\f[V]-p \[dq]every Tue\[dq]\f[R] +\f[CR]-p \[dq]every Tue\[dq]\f[R] T}@T{ same T} T{ -\f[V]-p \[dq]every 15th day\[dq]\f[R] +\f[CR]-p \[dq]every 15th day\[dq]\f[R] T}@T{ period boundaries will be on 15th of each month T} T{ -\f[V]-p \[dq]every 2nd Monday\[dq]\f[R] +\f[CR]-p \[dq]every 2nd Monday\[dq]\f[R] T}@T{ period boundaries will be on second Monday of each month T} T{ -\f[V]-p \[dq]every 11/05\[dq]\f[R] +\f[CR]-p \[dq]every 11/05\[dq]\f[R] T}@T{ yearly periods with boundaries on 5th of November T} T{ -\f[V]-p \[dq]every 5th November\[dq]\f[R] +\f[CR]-p \[dq]every 5th November\[dq]\f[R] T}@T{ same T} T{ -\f[V]-p \[dq]every Nov 5th\[dq]\f[R] +\f[CR]-p \[dq]every Nov 5th\[dq]\f[R] T}@T{ same T} @@ -6361,34 +5858,29 @@ T} Show historical balances at end of the 15th day of each month (N is an end date, exclusive as always): .IP -.nf -\f[C] +.EX $ hledger balance -H -p \[dq]every 16th day\[dq] -\f[R] -.fi +.EE .PP Group postings from the start of wednesday to end of the following tuesday (N is both (inclusive) start date and (exclusive) end date): .IP -.nf -\f[C] +.EX $ hledger register checking -p \[dq]every 3rd day of week\[dq] -\f[R] -.fi +.EE .SS Multiple weekday intervals -.PP This special form is also supported: .IP \[bu] 2 -\f[V]every WEEKDAYNAME,WEEKDAYNAME,...\f[R] (full or three-letter +\f[CR]every WEEKDAYNAME,WEEKDAYNAME,...\f[R] (full or three-letter english weekday names, case insensitive) .PP -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]. +Also, \f[CR]weekday\f[R] and \f[CR]weekendday\f[R] are shorthand for +\f[CR]mon,tue,wed,thu,fri\f[R] and \f[CR]sat,sun\f[R]. .PP -This is mainly intended for use with \f[V]--forecast\f[R], to generate +This is mainly intended for use with \f[CR]--forecast\f[R], to generate periodic transactions on arbitrary days of the week. -It may be less useful with \f[V]-p\f[R], since it divides each week into -subperiods of unequal length, which is unusual. +It may be less useful with \f[CR]-p\f[R], since it divides each week +into subperiods of unequal length, which is unusual. (Related: #1632) .PP Examples: @@ -6397,32 +5889,31 @@ Examples: tab(@); lw(17.8n) lw(52.2n). T{ -\f[V]-p \[dq]every mon,wed,fri\[dq]\f[R] +\f[CR]-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[V]-p \[dq]every weekday\[dq]\f[R] +\f[CR]-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[V]-p \[dq]every weekendday\[dq]\f[R] +\f[CR]-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[V]--depth NUM\f[R] option (short form: \f[V]-NUM\f[R]), +With the \f[CR]--depth NUM\f[R] option (short form: \f[CR]-NUM\f[R]), reports will show accounts only to the specified depth, hiding deeper subaccounts. Use this when you want a summary with less detail. -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. +This flag has the same effect as a \f[CR]depth:\f[R] query argument: +\f[CR]depth:2\f[R], \f[CR]--depth=2\f[R] or \f[CR]-2\f[R] are +equivalent. .SH Queries -.PP One of hledger\[aq]s strengths is being able to quickly report on a precise subset of your data. Most hledger commands accept optional query arguments to restrict their @@ -6433,58 +5924,58 @@ Zero or more space-separated query terms. These are most often account name substrings: .RS 2 .PP -\f[V]utilities food:groceries\f[R] +\f[CR]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[V]\[dq]personal care\[dq]\f[R] +\f[CR]\[dq]personal care\[dq]\f[R] .RE .IP \[bu] 2 Regular expressions are also supported: .RS 2 .PP -\f[V]\[dq]\[ha]expenses\[rs]b\[dq]\f[R] +\f[CR]\[dq]\[ha]expenses\[rs]b\[dq]\f[R] .PD 0 .P .PD -\f[V]\[dq]accounts (payable|receivable)\[dq]\f[R] +\f[CR]\[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[V]date:202312-\f[R] +\f[CR]date:202312-\f[R] .PD 0 .P .PD -\f[V]status:\f[R] +\f[CR]status:\f[R] .PD 0 .P .PD -\f[V]desc:amazon\f[R] +\f[CR]desc:amazon\f[R] .PD 0 .P .PD -\f[V]cur:USD\f[R] +\f[CR]cur:USD\f[R] .PD 0 .P .PD -\f[V]\[dq]amt:>0\[dq]\f[R] +\f[CR]\[dq]amt:>0\[dq]\f[R] .RE .IP \[bu] 2 -Add a \f[V]not:\f[R] prefix to negate: +Add a \f[CR]not:\f[R] prefix to negate: .RS 2 .PP -\f[V]not:cur:USD\f[R] +\f[CR]not:cur:USD\f[R] .RE .IP \[bu] 2 Multiple unlike terms are AND-ed, multiple like terms are OR-ed .RS 2 .PP -\f[V]date:2022 desc:amazon desc:amzn\f[R] +\f[CR]date:2022 desc:amazon desc:amzn\f[R] .PD 0 .P .PD @@ -6492,12 +5983,11 @@ Multiple unlike terms are AND-ed, multiple like terms are OR-ed during 2022) .RE .SS Query types -.PP Here are the types of query term available. -Remember these can also be prefixed with \f[B]\f[VB]not:\f[B]\f[R] to +Remember these can also be prefixed with \f[B]\f[CB]not:\f[B]\f[R] to convert them into a negative match. .PP -\f[B]\f[VB]acct:REGEX\f[B], \f[VB]REGEX\f[B]\f[R] +\f[B]\f[CB]acct:REGEX\f[B], \f[CB]REGEX\f[B]\f[R] .PD 0 .P .PD @@ -6505,78 +5995,77 @@ 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[V]expenses\f[R] or \f[V]food\f[R]. +account name substring, like \f[CR]expenses\f[R] or \f[CR]food\f[R]. .PP -\f[B]\f[VB]amt:N, amt:N, amt:>=N\f[B]\f[R] +\f[B]\f[CB]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.) +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. Otherwise, the absolute magnitudes are compared, ignoring sign. .PP -\f[B]\f[VB]code:REGEX\f[B]\f[R] +\f[B]\f[CB]code:REGEX\f[B]\f[R] .PD 0 .P .PD Match by transaction code (eg check number). .PP -\f[B]\f[VB]cur:REGEX\f[B]\f[R] +\f[B]\f[CB]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[V].*REGEX.*\f[R]). +(For a partial match, use \f[CR].*REGEX.*\f[R]). Note, to match special characters which are regex-significant, you need -to escape them with \f[V]\[rs]\f[R]. +to escape them with \f[CR]\[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[V]hledger print cur:\[rs]\[rs]$\f[R]. +\f[CR]hledger print cur:\[rs]\[rs]$\f[R]. .PP -\f[B]\f[VB]desc:REGEX\f[B]\f[R] +\f[B]\f[CB]desc:REGEX\f[B]\f[R] .PD 0 .P .PD Match transaction descriptions. .PP -\f[B]\f[VB]date:PERIODEXPR\f[B]\f[R] +\f[B]\f[CB]date:PERIODEXPR\f[B]\f[R] .PD 0 .P .PD -Match dates (or with the \f[V]--date2\f[R] flag, secondary dates) within -the specified period. +Match dates (or with the \f[CR]--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[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]. +\f[CR]date:2016\f[R], \f[CR]date:thismonth\f[R], +\f[CR]date:2/1-2/15\f[R], \f[CR]date:2021-07-27..nextquarter\f[R]. .PP -\f[B]\f[VB]date2:PERIODEXPR\f[B]\f[R] +\f[B]\f[CB]date2:PERIODEXPR\f[B]\f[R] .PD 0 .P .PD Match secondary dates within the specified period (independent of the -\f[V]--date2\f[R] flag). +\f[CR]--date2\f[R] flag). .PP -\f[B]\f[VB]depth:N\f[B]\f[R] +\f[B]\f[CB]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[VB]expr:\[dq]TERM AND NOT (TERM OR TERM)\[dq]\f[B]\f[R] (eg) +\f[B]\f[CB]expr:\[dq]TERM AND NOT (TERM OR TERM)\[dq]\f[B]\f[R] (eg) .PD 0 .P .PD @@ -6584,50 +6073,50 @@ Match with a boolean combination of queries (which must be enclosed in quotes). See Combining query terms below. .PP -\f[B]\f[VB]note:REGEX\f[B]\f[R] +\f[B]\f[CB]note:REGEX\f[B]\f[R] .PD 0 .P .PD Match transaction notes (the part of the description right of -\f[V]|\f[R], or the whole description if there\[aq]s no \f[V]|\f[R]). +\f[CR]|\f[R], or the whole description if there\[aq]s no \f[CR]|\f[R]). .PP -\f[B]\f[VB]payee:REGEX\f[B]\f[R] +\f[B]\f[CB]payee:REGEX\f[B]\f[R] .PD 0 .P .PD Match transaction payee/payer names (the part of the description left of -\f[V]|\f[R], or the whole description if there\[aq]s no \f[V]|\f[R]). +\f[CR]|\f[R], or the whole description if there\[aq]s no \f[CR]|\f[R]). .PP -\f[B]\f[VB]real:, real:0\f[B]\f[R] +\f[B]\f[CB]real:, real:0\f[B]\f[R] .PD 0 .P .PD Match real or virtual postings respectively. .PP -\f[B]\f[VB]status:, status:!, status:*\f[B]\f[R] +\f[B]\f[CB]status:, status:!, status:*\f[B]\f[R] .PD 0 .P .PD Match unmarked, pending, or cleared transactions respectively. .PP -\f[B]\f[VB]type:TYPECODES\f[B]\f[R] +\f[B]\f[CB]type:TYPECODES\f[B]\f[R] .PD 0 .P .PD Match by account type (see Declaring accounts > Account types). -\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). +\f[CR]TYPECODES\f[R] is one or more of the single-letter account type +codes \f[CR]ALERXCV\f[R], case insensitive. +Note \f[CR]type:A\f[R] and \f[CR]type:E\f[R] will also match their +respective subtypes \f[CR]C\f[R] (Cash) and \f[CR]V\f[R] (Conversion). Certain kinds of account alias can disrupt account types, see Rewriting accounts > Aliases and account types. .PP -\f[B]\f[VB]tag:REGEX[=REGEX]\f[B]\f[R] +\f[B]\f[CB]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[V]tag:.=REGEX\f[R].) +(To match only by value, use \f[CR]tag:.=REGEX\f[R].) .PP When querying by tag, note that: .IP \[bu] 2 @@ -6637,14 +6126,13 @@ 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[VB]inacct:ACCTNAME\f[B]\f[R] +(\f[B]\f[CB]inacct:ACCTNAME\f[B]\f[R] .PD 0 .P .PD 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 When given multiple space-separated query terms, most commands select things which match: .IP \[bu] 2 @@ -6677,14 +6165,14 @@ Match transactions with \[aq]cool\[aq] in the description AND with the \[aq]A\[aq] tag .RS 2 .PP -\f[V]expr:\[dq]desc:cool AND tag:A\[dq]\f[R] +\f[CR]expr:\[dq]desc:cool AND tag:A\[dq]\f[R] .RE .IP \[bu] 2 Match transactions NOT to the \[aq]expenses:food\[aq] account OR with the \[aq]A\[aq] tag .RS 2 .PP -\f[V]expr:\[dq]NOT expenses:food OR tag:A\[dq]\f[R] +\f[CR]expr:\[dq]NOT expenses:food OR tag:A\[dq]\f[R] .RE .IP \[bu] 2 Match transactions NOT involving the \[aq]expenses:food\[aq] account OR @@ -6694,166 +6182,146 @@ account. above) .RS 2 .PP -\f[V]expr:\[dq]expenses:food OR (tag:A expenses:drink)\[dq]\f[R] +\f[CR]expr:\[dq]expenses:food OR (tag:A expenses:drink)\[dq]\f[R] .RE .SS Queries and command options -.PP Some queries can also be expressed as command-line options: -\f[V]depth:2\f[R] is equivalent to \f[V]--depth 2\f[R], -\f[V]date:2023\f[R] is equivalent to \f[V]-p 2023\f[R], etc. +\f[CR]depth:2\f[R] is equivalent to \f[CR]--depth 2\f[R], +\f[CR]date:2023\f[R] is equivalent to \f[CR]-p 2023\f[R], etc. When you mix command options and query arguments, generally the resulting query is their intersection. .SS Queries and valuation -.PP When amounts are converted to other commodities in cost or value -reports, \f[V]cur:\f[R] and \f[V]amt:\f[R] match the old commodity +reports, \f[CR]cur:\f[R] and \f[CR]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[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. +When account names are rewritten with \f[CR]--alias\f[R] or +\f[CR]alias\f[R], note that \f[CR]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[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 +reports, note that \f[CR]cur:\f[R] matches the new commodity symbol, and +not the old one, and \f[CR]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. .SH Pivoting -.PP Normally, hledger groups and sums amounts within each account. -The \f[V]--pivot FIELD\f[R] option substitutes some other transaction +The \f[CR]--pivot FIELD\f[R] option substitutes some other transaction field for account names, causing amounts to be grouped and summed by that field\[aq]s value instead. -FIELD can be any of the transaction fields \f[V]acct\f[R], -\f[V]status\f[R], \f[V]code\f[R], \f[V]desc\f[R], \f[V]payee\f[R], -\f[V]note\f[R], or a tag name. +FIELD can be any of the transaction fields \f[CR]acct\f[R], +\f[CR]status\f[R], \f[CR]code\f[R], \f[CR]desc\f[R], \f[CR]payee\f[R], +\f[CR]note\f[R], or a tag name. When pivoting on a tag and a posting has multiple values of that tag, only the first value is displayed. -Values containing \f[V]colon:separated:parts\f[R] will be displayed +Values containing \f[CR]colon:separated:parts\f[R] will be displayed hierarchically, like account names. Multiple, colon-delimited fields can be pivoted simultaneously, generating a hierarchical account name. .PP Some examples: .IP -.nf -\f[C] +.EX 2016/02/16 Yearly Dues Payment assets:bank account 2 EUR income:dues -2 EUR ; member: John Doe, kind: Lifetime -\f[R] -.fi +.EE .PP Normal balance report showing account names: .IP -.nf -\f[C] +.EX $ hledger balance 2 EUR assets:bank account -2 EUR income:dues -------------------- 0 -\f[R] -.fi +.EE .PP Pivoted balance report, using member: tag values instead: .IP -.nf -\f[C] +.EX $ hledger balance --pivot member 2 EUR -2 EUR John Doe -------------------- 0 -\f[R] -.fi +.EE .PP One way to show only amounts with a member: value (using a query): .IP -.nf -\f[C] +.EX $ hledger balance --pivot member tag:member=. -2 EUR John Doe -------------------- -2 EUR -\f[R] -.fi +.EE .PP Another way (the acct: query matches against the pivoted \[dq]account name\[dq]): .IP -.nf -\f[C] +.EX $ hledger balance --pivot member acct:. -2 EUR John Doe -------------------- -2 EUR -\f[R] -.fi +.EE .PP Hierarchical reports can be generated with multiple pivots: .IP -.nf -\f[C] +.EX $ hledger balance Income:Dues --pivot kind:member -2 EUR Lifetime:John Doe -------------------- -2 EUR -\f[R] -.fi +.EE .SH Generating data -.PP hledger has several features for generating data, such as: .IP \[bu] 2 Periodic transaction rules can generate single or repeating transactions following a template. These are usually dated in the future, eg to help with forecasting. -They are activated by the \f[V]--forecast\f[R] option. +They are activated by the \f[CR]--forecast\f[R] option. .IP \[bu] 2 -The balance command\[aq]s \f[V]--budget\f[R] option uses these same +The balance command\[aq]s \f[CR]--budget\f[R] option uses these same periodic rules to generate goals for the budget report. .IP \[bu] 2 Auto posting rules can generate extra postings on certain matched transactions. They are always applied to forecast transactions; with the -\f[V]--auto\f[R] flag they are applied to transactions recorded in the +\f[CR]--auto\f[R] flag they are applied to transactions recorded in the journal as well. .IP \[bu] 2 -The \f[V]--infer-equity\f[R] flag infers missing conversion equity +The \f[CR]--infer-equity\f[R] flag infers missing conversion equity postings from \[at]/\[at]\[at] costs. -And the inverse \f[V]--infer-costs\f[R] flag infers missing +And the inverse \f[CR]--infer-costs\f[R] flag infers missing \[at]/\[at]\[at] costs from conversion equity postings. .PP Generated data of this kind is temporary, existing only at report time. -But you can see it in the output of \f[V]hledger print\f[R], and you can -save that to your journal, in effect converting it from temporary +But you can see it in the output of \f[CR]hledger print\f[R], and you +can save that to your journal, in effect converting it from temporary generated data to permanent recorded data. This could be useful as a data entry aid. .PP If you are wondering what data is being generated and why, add the -\f[V]--verbose-tags\f[R] flag. -In \f[V]hledger print\f[R] output you will see extra tags like -\f[V]generated-transaction\f[R], \f[V]generated-posting\f[R], and -\f[V]modified\f[R] on generated/modified data. -Also, even without \f[V]--verbose-tags\f[R], generated data always has +\f[CR]--verbose-tags\f[R] flag. +In \f[CR]hledger print\f[R] output you will see extra tags like +\f[CR]generated-transaction\f[R], \f[CR]generated-posting\f[R], and +\f[CR]modified\f[R] on generated/modified data. +Also, even without \f[CR]--verbose-tags\f[R], generated data always has equivalen hidden tags (with an underscore prefix), so eg you could match -generated transactions with \f[V]tag:_generated-transaction\f[R]. +generated transactions with \f[CR]tag:_generated-transaction\f[R]. .SH Forecasting -.PP Forecasting, or speculative future reporting, can be useful for estimating future balances, or for exploring different future scenarios. .PP The simplest and most flexible way to do it with hledger is to manually record a bunch of future-dated transactions. -You could keep these in a separate \f[V]future.journal\f[R] and include -that with \f[V]-f\f[R] only when you want to see them. +You could keep these in a separate \f[CR]future.journal\f[R] and include +that with \f[CR]-f\f[R] only when you want to see them. .SS --forecast -.PP -There is another way: with the \f[V]--forecast\f[R] option, hledger can +There is another way: with the \f[CR]--forecast\f[R] option, hledger can generate temporary \[dq]forecast transactions\[dq] for reporting purposes, according to periodic transaction rules defined in the journal. @@ -6872,24 +6340,20 @@ report period. You can override it - eg to forecast farther into the future, or to force forecast transactions to overlap your ordinary transactions - by giving the --forecast option a period expression argument, like -\f[V]--forecast=..2099\f[R] or \f[V]--forecast=2023-02-15..\f[R]. -Note that the \f[V]=\f[R] is required. +\f[CR]--forecast=..2099\f[R] or \f[CR]--forecast=2023-02-15..\f[R]. +Note that the \f[CR]=\f[R] is required. .SS Inspecting forecast transactions -.PP -\f[V]print\f[R] is the best command for inspecting and troubleshooting +\f[CR]print\f[R] is the best command for inspecting and troubleshooting forecast transactions. Eg: .IP -.nf -\f[C] +.EX \[ti] monthly from 2022-12-20 rent assets:bank:checking expenses:rent $1000 -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger print --forecast --today=2023/4/21 2023-05-20 rent ; generated-transaction: \[ti] monthly from 2022-12-20 @@ -6915,20 +6379,17 @@ $ hledger print --forecast --today=2023/4/21 ; generated-transaction: \[ti] monthly from 2022-12-20 assets:bank:checking expenses:rent $1000 -\f[R] -.fi +.EE .PP Here there are no ordinary transactions, so the forecasted transactions begin on the first occurence after today\[aq]s date. -(You won\[aq]t normally use \f[V]--today\f[R]; it\[aq]s just to make +(You won\[aq]t normally use \f[CR]--today\f[R]; it\[aq]s just to make these examples reproducible.) .SS Forecast reports -.PP Forecast transactions affect all reports, as you would expect. Eg: .IP -.nf -\f[C] +.EX $ hledger areg rent --forecast --today=2023/4/21 Transactions in expenses:rent and subaccounts: 2023-05-20 rent as:ba:checking $1000 $1000 @@ -6936,11 +6397,9 @@ Transactions in expenses:rent and subaccounts: 2023-07-20 rent as:ba:checking $1000 $3000 2023-08-20 rent as:ba:checking $1000 $4000 2023-09-20 rent as:ba:checking $1000 $5000 -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger bal -M expenses --forecast --today=2023/4/21 Balance changes in 2023-05-01..2023-09-30: @@ -6949,22 +6408,19 @@ Balance changes in 2023-05-01..2023-09-30: expenses:rent || $1000 $1000 $1000 $1000 $1000 ---------------++----------------------------------- || $1000 $1000 $1000 $1000 $1000 -\f[R] -.fi +.EE .SS Forecast tags -.PP Forecast transactions generated by --forecast have a hidden tag, -\f[V]_generated-transaction\f[R]. +\f[CR]_generated-transaction\f[R]. So if you ever need to match forecast transactions, you could use -\f[V]tag:_generated-transaction\f[R] (or just \f[V]tag:generated\f[R]) +\f[CR]tag:_generated-transaction\f[R] (or just \f[CR]tag:generated\f[R]) in a query. .PP -For troubleshooting, you can add the \f[V]--verbose-tags\f[R] flag. -Then, visible \f[V]generated-transaction\f[R] tags will be added also, -so you can view them with the \f[V]print\f[R] command. +For troubleshooting, you can add the \f[CR]--verbose-tags\f[R] flag. +Then, visible \f[CR]generated-transaction\f[R] tags will be added also, +so you can view them with the \f[CR]print\f[R] command. Their value indicates which periodic rule was responsible. .SS Forecast period, in detail -.PP Forecast start/end dates are chosen so as to do something useful by default in almost all situations, while also being flexible. Here are (with luck) the exact rules, to help with troubleshooting: @@ -6976,14 +6432,14 @@ the later of .IP \[bu] 2 the start date in the periodic transaction rule .IP \[bu] 2 -the start date in \f[V]--forecast\f[R]\[aq]s argument +the start date in \f[CR]--forecast\f[R]\[aq]s argument .RE .IP \[bu] 2 otherwise (if those are not available): the later of .RS 2 .IP \[bu] 2 the report start date specified with -\f[V]-b\f[R]/\f[V]-p\f[R]/\f[V]date:\f[R] +\f[CR]-b\f[R]/\f[CR]-p\f[R]/\f[CR]date:\f[R] .IP \[bu] 2 the day after the latest ordinary transaction in the journal .RE @@ -6997,23 +6453,22 @@ the earlier of .IP \[bu] 2 the end date in the periodic transaction rule .IP \[bu] 2 -the end date in \f[V]--forecast\f[R]\[aq]s argument +the end date in \f[CR]--forecast\f[R]\[aq]s argument .RE .IP \[bu] 2 otherwise: the report end date specified with -\f[V]-e\f[R]/\f[V]-p\f[R]/\f[V]date:\f[R] +\f[CR]-e\f[R]/\f[CR]-p\f[R]/\f[CR]date:\f[R] .IP \[bu] 2 otherwise: 180 days (\[ti]6 months) from today. .SS Forecast troubleshooting -.PP When --forecast is not doing what you expect, one of these tips should help: .IP \[bu] 2 -Remember to use the \f[V]--forecast\f[R] option. +Remember to use the \f[CR]--forecast\f[R] option. .IP \[bu] 2 Remember to have at least one periodic transaction rule in your journal. .IP \[bu] 2 -Test with \f[V]print --forecast\f[R]. +Test with \f[CR]print --forecast\f[R]. .IP \[bu] 2 Check for typos or too-restrictive start/end dates in your periodic transaction rule. @@ -7024,32 +6479,30 @@ description fields. Check for future-dated ordinary transactions suppressing forecasted transactions. .IP \[bu] 2 -Try setting explicit report start and/or end dates with \f[V]-b\f[R], -\f[V]-e\f[R], \f[V]-p\f[R] or \f[V]date:\f[R] +Try setting explicit report start and/or end dates with \f[CR]-b\f[R], +\f[CR]-e\f[R], \f[CR]-p\f[R] or \f[CR]date:\f[R] .IP \[bu] 2 -Try adding the \f[V]-E\f[R] flag to encourage display of empty +Try adding the \f[CR]-E\f[R] flag to encourage display of empty periods/zero transactions. .IP \[bu] 2 Try setting explicit forecast start and/or end dates with -\f[V]--forecast=START..END\f[R] +\f[CR]--forecast=START..END\f[R] .IP \[bu] 2 Consult Forecast period, in detail, above. .IP \[bu] 2 -Check inside the engine: add \f[V]--debug=2\f[R] (eg). +Check inside the engine: add \f[CR]--debug=2\f[R] (eg). .SH Budgeting -.PP -With the balance command\[aq]s \f[V]--budget\f[R] report, each periodic +With the balance command\[aq]s \f[CR]--budget\f[R] report, each periodic transaction rule generates recurring budget goals in specified accounts, and goals and actual performance can be compared. See the balance command\[aq]s doc below. .PP You can generate budget goals and forecast transactions at the same time, from the same or different periodic transaction rules: -\f[V]hledger bal -M --budget --forecast ...\f[R] +\f[CR]hledger bal -M --budget --forecast ...\f[R] .PP See also: Budgeting and Forecasting. .SH Cost reporting -.PP In some transactions - for example a currency conversion, or a purchase or sale of stock - one commodity is exchanged for another. In these transactions there is a conversion rate, also called the cost @@ -7058,34 +6511,29 @@ In hledger docs we just say \[dq]cost\[dq], for convenience; feel free to mentally translate to \[dq]conversion rate\[dq] or \[dq]selling price\[dq] if helpful. .SS Recording costs -.PP We\[aq]ll explore several ways of recording transactions involving costs. These are also summarised at hledger Cookbook > Cost notation. .PP Costs can be recorded explicitly in the journal, using the -\f[V]\[at] UNITCOST\f[R] or \f[V]\[at]\[at] TOTALCOST\f[R] notation +\f[CR]\[at] UNITCOST\f[R] or \f[CR]\[at]\[at] TOTALCOST\f[R] notation described in Journal > Costs: .PP \f[B]Variant 1\f[R] .IP -.nf -\f[C] +.EX 2022-01-01 assets:dollars $-135 assets:euros €100 \[at] $1.35 ; $1.35 per euro (unit cost) -\f[R] -.fi +.EE .PP \f[B]Variant 2\f[R] .IP -.nf -\f[C] +.EX 2022-01-01 assets:dollars $-135 assets:euros €100 \[at]\[at] $135 ; $135 total cost -\f[R] -.fi +.EE .PP Typically, writing the unit cost (variant 1) is preferable; it can be more effort, requiring more attention to decimal digits; but it reveals @@ -7096,16 +6544,14 @@ consistent with a balanced transaction: .PP \f[B]Variant 3\f[R] .IP -.nf -\f[C] +.EX 2022-01-01 assets:dollars $-135 assets:euros €100 -\f[R] -.fi +.EE .PP -Here, hledger will attach a \f[V]\[at]\[at] €100\f[R] cost to the first -amount (you can see it with \f[V]hledger print -x\f[R]). +Here, hledger will attach a \f[CR]\[at]\[at] €100\f[R] cost to the first +amount (you can see it with \f[CR]hledger print -x\f[R]). This form looks convenient, but there are downsides: .IP \[bu] 2 It sacrifices some error checking. @@ -7118,11 +6564,10 @@ different entry would be inferred and reports would be different. The per-unit cost basis is not easy to read. .PP So generally this kind of entry is not recommended. -You can make sure you have none of these by using \f[V]-s\f[R] (strict -mode), or by running \f[V]hledger check balanced\f[R]. +You can make sure you have none of these by using \f[CR]-s\f[R] (strict +mode), or by running \f[CR]hledger check balanced\f[R]. .SS Reporting at cost -.PP -Now when you add the \f[V]-B\f[R]/\f[V]--cost\f[R] flag to reports +Now when you add the \f[CR]-B\f[R]/\f[CR]--cost\f[R] flag to reports (\[dq]B\[dq] is from Ledger\[aq]s -B/--basis/--cost flag), any amounts which have been annotated with costs will be converted to their cost\[aq]s commodity (in the report output). @@ -7137,13 +6582,12 @@ This contrasts with market prices, which are ambient and fluctuating. Conversion to cost is performed before conversion to market value (described below). .SS Equity conversion postings -.PP There is a problem with the entries above - they are not conventional Double Entry Bookkeeping (DEB) notation, and because of the \[dq]magical\[dq] transformation of one commodity into another, they cause an imbalance in the Accounting Equation. This shows up as a non-zero grand total in balance reports like -\f[V]hledger bse\f[R]. +\f[CR]hledger bse\f[R]. .PP For most hledger users, this doesn\[aq]t matter in practice and can safely be ignored ! @@ -7155,91 +6599,79 @@ Of course you can do this in hledger as well: .PP \f[B]Variant 4\f[R] .IP -.nf -\f[C] +.EX 2022-01-01 assets:dollars $-135 assets:euros €100 equity:conversion $135 equity:conversion €-100 -\f[R] -.fi +.EE .PP Now the transaction is perfectly balanced according to standard DEB, and -\f[V]hledger bse\f[R]\[aq]s total will not be disrupted. +\f[CR]hledger bse\f[R]\[aq]s total will not be disrupted. .PP And, hledger can still infer the cost for cost reporting, but it\[aq]s -not done by default - you must add the \f[V]--infer-costs\f[R] flag like -so: +not done by default - you must add the \f[CR]--infer-costs\f[R] flag +like so: .IP -.nf -\f[C] +.EX $ hledger print --infer-costs 2022-01-01 one hundred euros purchased at $1.35 each assets:dollars $-135 \[at]\[at] €100 assets:euros €100 equity:conversion $135 equity:conversion €-100 -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger bal --infer-costs -B €-100 assets:dollars €100 assets:euros -------------------- 0 -\f[R] -.fi +.EE .PP Here are some downsides of this kind of entry: .IP \[bu] 2 The per-unit cost basis is not easy to read. .IP \[bu] 2 -Instead of \f[V]-B\f[R] you must remember to type -\f[V]-B --infer-costs\f[R]. +Instead of \f[CR]-B\f[R] you must remember to type +\f[CR]-B --infer-costs\f[R]. .IP \[bu] 2 -\f[V]--infer-costs\f[R] works only where hledger can identify the two +\f[CR]--infer-costs\f[R] works only where hledger can identify the two equity:conversion postings and match them up with the two non-equity postings. So writing the journal entry in a particular format becomes more important. More on this below. .SS Inferring equity conversion postings -.PP Can we go in the other direction ? Yes, if you have transactions written with the \[at]/\[at]\[at] cost notation, hledger can infer the missing equity postings, if you add the -\f[V]--infer-equity\f[R] flag. +\f[CR]--infer-equity\f[R] flag. Eg: .IP -.nf -\f[C] +.EX 2022-01-01 assets:dollars -$135 assets:euros €100 \[at] $1.35 -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger print --infer-equity 2022-01-01 assets:dollars $-135 assets:euros €100 \[at] $1.35 equity:conversion:$-€:€ €-100 equity:conversion:$-€:$ $135.00 -\f[R] -.fi +.EE .PP The equity account names will be \[dq]equity:conversion:A-B:A\[dq] and \[dq]equity:conversion:A-B:B\[dq] where A is the alphabetically first commodity symbol. You can customise the \[dq]equity:conversion\[dq] part by declaring an -account with the \f[V]V\f[R]/\f[V]Conversion\f[R] account type. +account with the \f[CR]V\f[R]/\f[CR]Conversion\f[R] account type. .SS Combining costs and equity conversion postings -.PP Finally, you can use both the \[at]/\[at]\[at] cost notation and equity postings at the same time. This in theory gives the best of all worlds - preserving the accounting @@ -7248,24 +6680,20 @@ flexibility in how you write the entry: .PP \f[B]Variant 5\f[R] .IP -.nf -\f[C] +.EX 2022-01-01 one hundred euros purchased at $1.35 each assets:dollars $-135 equity:conversion $135 equity:conversion €-100 assets:euros €100 \[at] $1.35 -\f[R] -.fi +.EE .PP All the other variants above can (usually) be rewritten to this final form with: .IP -.nf -\f[C] +.EX $ hledger print -x --infer-costs --infer-equity -\f[R] -.fi +.EE .PP Downsides: .IP \[bu] 2 @@ -7279,9 +6707,8 @@ The add command does not yet accept this kind of entry (#2056). .IP \[bu] 2 This is the most verbose form. .SS Requirements for detecting equity conversion postings -.PP -\f[V]--infer-costs\f[R] has certain requirements (unlike -\f[V]--infer-equity\f[R], which always works). +\f[CR]--infer-costs\f[R] has certain requirements (unlike +\f[CR]--infer-equity\f[R], which always works). It will infer costs only in transactions with: .IP \[bu] 2 Two non-equity postings, in different commodities. @@ -7295,16 +6722,16 @@ Equity conversion accounts are: .RS 2 .IP \[bu] 2 any accounts declared with account type -\f[V]V\f[R]/\f[V]Conversion\f[R], or their subaccounts +\f[CR]V\f[R]/\f[CR]Conversion\f[R], or their subaccounts .IP \[bu] 2 -otherwise, accounts named \f[V]equity:conversion\f[R], -\f[V]equity:trade\f[R], or \f[V]equity:trading\f[R], or their +otherwise, accounts named \f[CR]equity:conversion\f[R], +\f[CR]equity:trade\f[R], or \f[CR]equity:trading\f[R], or their subaccounts. .RE .PP And multiple such four-posting groups can coexist within a single transaction. -When \f[V]--infer-costs\f[R] fails, it does not infer a cost in that +When \f[CR]--infer-costs\f[R] fails, it does not infer a cost in that transaction, and does not raise an error (ie, it infers costs where it can). .PP @@ -7313,42 +6740,35 @@ postings, has all the same requirements. When reading such an entry fails, hledger raises an \[dq]unbalanced transaction\[dq] error. .SS Infer cost and equity by default ? -.PP -Should \f[V]--infer-costs\f[R] and \f[V]--infer-equity\f[R] be enabled +Should \f[CR]--infer-costs\f[R] and \f[CR]--infer-equity\f[R] be enabled by default ? Try using them always, eg with a shell alias: .IP -.nf -\f[C] +.EX alias h=\[dq]hledger --infer-equity --infer-costs\[dq] -\f[R] -.fi +.EE .PP and let us know what problems you find. .PP .SH Value reporting -.PP 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[V]--value=TYPE[,COMMODITY]\f[R] option, +This is controlled by the \f[CR]--value=TYPE[,COMMODITY]\f[R] option, which will be described below. -We also provide the simpler \f[V]-V\f[R] and \f[V]-X COMMODITY\f[R] +We also provide the simpler \f[CR]-V\f[R] and \f[CR]-X COMMODITY\f[R] options, and often one of these is all you need: .SS -V: Value -.PP -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. +The \f[CR]-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[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. +The \f[CR]-X/--exchange=COMM\f[R] option is like \f[CR]-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 -.PP Market prices can change from day to day. hledger will use the prices on a particular valuation date (or on more than one date). @@ -7370,17 +6790,17 @@ This can be customised with the --value option described below, which can select either \[dq]then\[dq], \[dq]end\[dq], \[dq]now\[dq], or \[dq]custom\[dq] dates. (Note, this has a bug in hledger-ui <=1.31: turning on valuation with -the \f[V]V\f[R] key always resets it to \[dq]end\[dq].) +the \f[CR]V\f[R] key always resets it to \[dq]end\[dq].) .SS Finding market price -.PP 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: .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[V]--infer-market-prices\f[R] +declared by a P directive, or (with the \f[CR]--infer-market-prices\f[R] flag) inferred from costs. +\ .IP "2." 3 A \f[I]reverse market price\f[R]: the inverse of a declared or inferred market price from B to A. @@ -7396,63 +6816,61 @@ 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[V]--debug=2\f[R] output). +in \f[CR]--debug=2\f[R] output). That limit is currently 1000. .PP Amounts for which no suitable market price can be found, are not converted. .SS --infer-market-prices: market prices from transactions -.PP 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 value, why not use the recorded costs as additional market prices (as Ledger does) ? -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. +Adding the \f[CR]--infer-market-prices\f[R] flag to \f[CR]-V\f[R], +\f[CR]-X\f[R] or \f[CR]--value\f[R] enables this. .PP -So for example, \f[V]hledger bs -V --infer-market-prices\f[R] will get +So for example, \f[CR]hledger bs -V --infer-market-prices\f[R] will get market prices both from P directives and from transactions. 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 Value reporting section -carefully, and try adding \f[V]--debug\f[R] or \f[V]--debug=2\f[R] to +carefully, and try adding \f[CR]--debug\f[R] or \f[CR]--debug=2\f[R] to troubleshoot. .PP -\f[V]--infer-market-prices\f[R] can infer market prices from: +\f[CR]--infer-market-prices\f[R] can infer market prices from: .IP \[bu] 2 multicommodity transactions with explicit prices -(\f[V]\[at]\f[R]/\f[V]\[at]\[at]\f[R]) +(\f[CR]\[at]\f[R]/\f[CR]\[at]\[at]\f[R]) .IP \[bu] 2 -multicommodity transactions with implicit prices (no \f[V]\[at]\f[R], +multicommodity transactions with implicit prices (no \f[CR]\[at]\f[R], two commodities, unbalanced). (With these, the order of postings matters. -\f[V]hledger print -x\f[R] can be useful for troubleshooting.) +\f[CR]hledger print -x\f[R] can be useful for troubleshooting.) .IP \[bu] 2 multicommodity transactions with equity postings, if cost is inferred -with \f[V]--infer-costs\f[R]. +with \f[CR]--infer-costs\f[R]. .PP There is a limitation (bug) currently: when a valuation commodity 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. +specified, prices inferred with \f[CR]--infer-market-prices\f[R] do not +help select a default valuation commodity, as \f[CR]P\f[R] prices would. So conversion might not happen because no valuation commodity was -detected (\f[V]--debug=2\f[R] will show this). +detected (\f[CR]--debug=2\f[R] will show this). To be safe, specify the valuation commmodity, eg: .IP \[bu] 2 -\f[V]-X EUR --infer-market-prices\f[R], not -\f[V]-V --infer-market-prices\f[R] +\f[CR]-X EUR --infer-market-prices\f[R], not +\f[CR]-V --infer-market-prices\f[R] .IP \[bu] 2 -\f[V]--value=then,EUR --infer-market-prices\f[R], not -\f[V]--value=then --infer-market-prices\f[R] +\f[CR]--value=then,EUR --infer-market-prices\f[R], not +\f[CR]--value=then --infer-market-prices\f[R] .PP Signed costs and market prices can be confusing. For reference, here is the current behaviour, since hledger 1.25. (If you think it should work differently, see #1870.) .IP -.nf -\f[C] +.EX 2022-01-01 Positive Unit prices a A 1 b B -1 \[at] A 1 @@ -7478,15 +6896,13 @@ For reference, here is the current behaviour, since hledger 1.25. 2022-01-03 Double Negative total prices a A -1 b B -1 \[at]\[at] A -1 -\f[R] -.fi +.EE .PP All of the transactions above are considered balanced (and on each day, the two transactions are considered equivalent). Here are the market prices inferred for B: .IP -.nf -\f[C] +.EX $ hledger -f- --infer-market-prices prices P 2022-01-01 B A 1 P 2022-01-01 B A 1.0 @@ -7494,20 +6910,18 @@ P 2022-01-02 B A -1 P 2022-01-02 B A -1.0 P 2022-01-03 B A -1 P 2022-01-03 B A -1.0 -\f[R] -.fi +.EE .SS Valuation commodity -.PP -\f[B]When you specify a valuation commodity (\f[VB]-X COMM\f[B] or -\f[VB]--value TYPE,COMM\f[B]):\f[R] +\f[B]When you specify a valuation commodity (\f[CB]-X COMM\f[B] or +\f[CB]--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[VB]-V\f[B] -or \f[VB]--value TYPE\f[B]):\f[R] +\f[B]When you leave the valuation commodity unspecified (\f[CB]-V\f[B] +or \f[CB]--value TYPE\f[B]):\f[R] .PD 0 .P .PD @@ -7523,24 +6937,22 @@ date. valuation date.) .IP "3." 3 If there are no P directives at all (any commodity or date) and the -\f[V]--infer-market-prices\f[R] flag is used: the price commodity from +\f[CR]--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[V]-V\f[R] +If you have P directives, they determine which commodities \f[CR]-V\f[R] will convert, and to what. .IP \[bu] 2 -If you have no P directives, and use the \f[V]--infer-market-prices\f[R] -flag, costs determine it. +If you have no P directives, and use the +\f[CR]--infer-market-prices\f[R] flag, costs 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[V]-V\f[R]: +Here are some quick examples of \f[CR]-V\f[R]: .IP -.nf -\f[C] +.EX ; one euro is worth this many dollars from nov 1 P 2016/11/01 € $1.10 @@ -7551,43 +6963,34 @@ P 2016/11/01 € $1.10 ; the euro is worth fewer dollars by dec 21 P 2016/12/21 € $1.03 -\f[R] -.fi +.EE .PP How many euros do I have ? .IP -.nf -\f[C] +.EX $ hledger -f t.j bal -N euros €100 assets:euros -\f[R] -.fi +.EE .PP What are they worth at end of nov 3 ? .IP -.nf -\f[C] +.EX $ hledger -f t.j bal -N euros -V -e 2016/11/4 $110.00 assets:euros -\f[R] -.fi +.EE .PP What are they worth after 2016/12/21 ? (no report end date specified, defaults to today) .IP -.nf -\f[C] +.EX $ hledger -f t.j bal -N euros -V $103.00 assets:euros -\f[R] -.fi +.EE .SS --value: Flexible valuation -.PP -\f[V]-V\f[R] and \f[V]-X\f[R] are special cases of the more general -\f[V]--value\f[R] option: +\f[CR]-V\f[R] and \f[CR]-X\f[R] are special cases of the more general +\f[CR]--value\f[R] option: .IP -.nf -\f[C] +.EX --value=TYPE[,COMM] TYPE is then, end, now or YYYY-MM-DD. COMM is an optional commodity symbol. Shows amounts converted to: @@ -7595,41 +6998,38 @@ $ hledger -f t.j bal -N euros -V - default valuation commodity (or COMM) using market prices at period end(s) - default valuation commodity (or COMM) using current market prices - default valuation commodity (or COMM) using market prices at some date -\f[R] -.fi +.EE .PP The TYPE part selects cost or value and valuation date: .TP -\f[V]--value=then\f[R] +\f[CR]--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[V]--value=end\f[R] +\f[CR]--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[V]--value=now\f[R] +\f[CR]--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[V]--value=YYYY-MM-DD\f[R] +\f[CR]--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[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]. +\f[CR],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]. 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[V]--value\f[R], as seen -with \f[V]print\f[R]: +Here are some examples showing the effect of \f[CR]--value\f[R], as seen +with \f[CR]print\f[R]: .IP -.nf -\f[C] +.EX P 2000-01-01 A 1 B P 2000-02-01 A 2 B P 2000-03-01 A 3 B @@ -7643,13 +7043,11 @@ P 2000-04-01 A 4 B 2000-03-01 (a) 1 A \[at] 7 B -\f[R] -.fi +.EE .PP Show the cost of each posting: .IP -.nf -\f[C] +.EX $ hledger -f- print --cost 2000-01-01 (a) 5 B @@ -7659,27 +7057,23 @@ $ hledger -f- print --cost 2000-03-01 (a) 7 B -\f[R] -.fi +.EE .PP Show the value as of the last day of the report period (2000-02-29): .IP -.nf -\f[C] +.EX $ hledger -f- print --value=end date:2000/01-2000/03 2000-01-01 (a) 2 B 2000-02-01 (a) 2 B -\f[R] -.fi +.EE .PP With no report period specified, that shows the value as of the last day of the journal (2000-03-01): .IP -.nf -\f[C] +.EX $ hledger -f- print --value=end 2000-01-01 (a) 3 B @@ -7689,13 +7083,11 @@ $ hledger -f- print --value=end 2000-03-01 (a) 3 B -\f[R] -.fi +.EE .PP Show the current value (the 2000-04-01 price is still in effect today): .IP -.nf -\f[C] +.EX $ hledger -f- print --value=now 2000-01-01 (a) 4 B @@ -7705,13 +7097,11 @@ $ hledger -f- print --value=now 2000-03-01 (a) 4 B -\f[R] -.fi +.EE .PP Show the value on 2000/01/15: .IP -.nf -\f[C] +.EX $ hledger -f- print --value=2000-01-15 2000-01-01 (a) 1 B @@ -7721,17 +7111,15 @@ $ hledger -f- print --value=2000-01-15 2000-03-01 (a) 1 B -\f[R] -.fi +.EE .SS Interaction of valuation and queries -.PP When matching postings based on queries in the presence of valuation, the following happens. .IP "1." 3 The query is separated into two parts: .RS 4 .IP "1." 3 -the currency (\f[V]cur:\f[R]) or amount (\f[V]amt:\f[R]). +the currency (\f[CR]cur:\f[R]) or amount (\f[CR]amt:\f[R]). .IP "2." 3 all other parts. .RE @@ -7746,7 +7134,6 @@ post-valued amounts. .PP See: 1625 .SS Effect of valuation on reports -.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.) @@ -7761,15 +7148,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[V]-B\f[R], \f[V]--cost\f[R] +\f[CR]-B\f[R], \f[CR]--cost\f[R] T}@T{ -\f[V]-V\f[R], \f[V]-X\f[R] +\f[CR]-V\f[R], \f[CR]-X\f[R] T}@T{ -\f[V]--value=then\f[R] +\f[CR]--value=then\f[R] T}@T{ -\f[V]--value=end\f[R] +\f[CR]--value=end\f[R] T}@T{ -\f[V]--value=DATE\f[R], \f[V]--value=now\f[R] +\f[CR]--value=DATE\f[R], \f[CR]--value=now\f[R] T} _ T{ @@ -8057,8 +7444,8 @@ T}@T{ T} .TE .PP -\f[V]--cumulative\f[R] is omitted to save space, it works like -\f[V]-H\f[R] but with a zero starting balance. +\f[CR]--cumulative\f[R] is omitted to save space, it works like +\f[CR]-H\f[R] but with a zero starting balance. .PP \f[B]Glossary:\f[R] .TP @@ -8090,10 +7477,8 @@ a flag (-D/-W/-M/-Q/-Y) or period expression that activates the report\[aq]s multi-period mode (whether showing one or many subperiods). .SH PART 4: COMMANDS .SS Commands overview -.PP Here are the built-in commands: .SS DATA ENTRY -.PP These data entry commands are the only ones which can modify your journal file. .IP \[bu] 2 @@ -8161,8 +7546,8 @@ help - show the hledger manual with info/man/pager .IP \[bu] 2 demo - show small hledger demos in the terminal .PP +\ .SS ADD-ONS -.PP And here are some typical add-on commands. Some of these are installed by the hledger-install script. If installed, they will appear in hledger\[aq]s commands list: @@ -8182,7 +7567,6 @@ pijul, plot, and more.. .PP Next, each command is described in detail, in alphabetical order. .SS accounts -.PP Show account names. .PP This command lists account names. @@ -8192,44 +7576,43 @@ 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[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]). +Or it can show just the used accounts (\f[CR]--used\f[R]/\f[CR]-u\f[R]), +the declared accounts (\f[CR]--declared\f[R]/\f[CR]-d\f[R]), the +accounts declared but not used (\f[CR]--unused\f[R]), the accounts used +but not declared (\f[CR]--undeclared\f[R]), or the first account matched +by an account name pattern, if any (\f[CR]--find\f[R]). .PP It shows a flat list by default. -With \f[V]--tree\f[R], it uses indentation to show the account +With \f[CR]--tree\f[R], it uses indentation to show the account hierarchy. -In flat mode you can add \f[V]--drop N\f[R] to omit the first few +In flat mode you can add \f[CR]--drop N\f[R] to omit the first few account name components. -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]. +Account names can be depth-clipped with \f[CR]depth:N\f[R] or +\f[CR]--depth N\f[R] or \f[CR]-N\f[R]. .PP -With \f[V]--types\f[R], it also shows each account\[aq]s type, if +With \f[CR]--types\f[R], it also shows each account\[aq]s type, if it\[aq]s known. (See Declaring accounts > Account types.) .PP -With \f[V]--positions\f[R], it also shows the file and line number of +With \f[CR]--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[V]--directives\f[R], it adds the \f[V]account\f[R] keyword, +With \f[CR]--directives\f[R], it adds the \f[CR]account\f[R] keyword, showing valid account directives which can be pasted into a journal file. -This is useful together with \f[V]--undeclared\f[R] when updating your -account declarations to satisfy \f[V]hledger check accounts\f[R]. +This is useful together with \f[CR]--undeclared\f[R] when updating your +account declarations to satisfy \f[CR]hledger check accounts\f[R]. .PP -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. +The \f[CR]--find\f[R] flag can be used to look up a single account name, +in the same way that the \f[CR]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 Examples: .IP -.nf -\f[C] +.EX $ hledger accounts assets:bank:checking assets:bank:saving @@ -8239,17 +7622,13 @@ expenses:supplies income:gifts income:salary liabilities:debts -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger accounts --undeclared --directives >> $LEDGER_FILE $ hledger check accounts -\f[R] -.fi +.EE .SS activity -.PP Show an ascii barchart of posting counts per interval. .PP The activity command displays an ascii histogram showing transaction @@ -8259,33 +7638,30 @@ With query arguments, it counts only matched transactions. .PP Examples: .IP -.nf -\f[C] +.EX $ hledger activity --quarterly 2008-01-01 ** 2008-04-01 ******* 2008-07-01 2008-10-01 ** -\f[R] -.fi +.EE .SS add -.PP Prompt for transactions and add them to the journal. 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[V]add\f[R] command, +For more interactive data entry, there is the \f[CR]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[V]import\f[R]). +(see also \f[CR]import\f[R]). .PP -To use it, just run \f[V]hledger add\f[R] and follow the prompts. +To use it, just run \f[CR]hledger add\f[R] and follow the prompts. You can add as many transactions as you like; when you are finished, -enter \f[V].\f[R] or press control-d or control-c to exit. +enter \f[CR].\f[R] or press control-d or control-c to exit. .PP Features: .IP \[bu] 2 @@ -8298,8 +7674,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, -payees/descriptions, dates (\f[V]yesterday\f[R], \f[V]today\f[R], -\f[V]tomorrow\f[R]). +payees/descriptions, dates (\f[CR]yesterday\f[R], \f[CR]today\f[R], +\f[CR]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 @@ -8309,7 +7685,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[V]<\f[R] at any prompt to go one step +If you make a mistake, enter \f[CR]<\f[R] at any prompt to go one step backward. .IP \[bu] 2 Input prompts are displayed in a different colour when the terminal @@ -8317,8 +7693,7 @@ supports it. .PP Example (see https://hledger.org/add.html for a detailed tutorial): .IP -.nf -\f[C] +.EX $ hledger add Adding transactions to journal file /src/hledger/examples/sample.journal Any command line arguments will be used as defaults. @@ -8343,47 +7718,45 @@ Save this transaction to the journal ? [y]: Saved. Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ -\f[R] -.fi +.EE .PP 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). .SS aregister -.PP (areg) .PP Show the transactions and running historical balance of a single account, with each transaction displayed as one line. .PP -\f[V]aregister\f[R] shows the overall transactions affecting a +\f[CR]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[V]--historical\f[R] mode is always on). +running balance (\f[CR]--historical\f[R] mode is always on). .PP This is a more \[dq]real world\[dq], bank-like view than the -\f[V]register\f[R] command (which shows individual postings, possibly +\f[CR]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[V]aregister\f[R] for reviewing and -reconciling real-world asset/liability accounts - use \f[V]register\f[R] -for reviewing detailed revenues/expenses. +As a quick rule of thumb: - use \f[CR]aregister\f[R] for reviewing and +reconciling real-world asset/liability accounts - use +\f[CR]register\f[R] for reviewing detailed revenues/expenses. .PP -\f[V]aregister\f[R] requires one argument: the account to report on. +\f[CR]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. .PP When there are multiple matches, the alphabetically-first choice can be -surprising; eg if you have \f[V]assets:per:checking 1\f[R] and -\f[V]assets:biz:checking 2\f[R] accounts, -\f[V]hledger areg checking\f[R] would select -\f[V]assets:biz:checking 2\f[R]. +surprising; eg if you have \f[CR]assets:per:checking 1\f[R] and +\f[CR]assets:biz:checking 2\f[R] accounts, +\f[CR]hledger areg checking\f[R] would select +\f[CR]assets:biz:checking 2\f[R]. It\[aq]s just a convenience to save typing, so if in doubt, write the full account name, or a distinctive substring that matches uniquely. .PP Transactions involving subaccounts of this account will also be shown. -\f[V]aregister\f[R] ignores depth limits, so its final total will always -match a balance report with similar arguments. +\f[CR]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 shown. @@ -8394,13 +7767,11 @@ An example: this shows the transactions and historical running balance during july, in the first account whose name contains \[dq]checking\[dq]: .IP -.nf -\f[C] +.EX $ hledger areg checking date:jul -\f[R] -.fi +.EE .PP -Each \f[V]aregister\f[R] line item shows: +Each \f[CR]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) @@ -8413,20 +7784,19 @@ 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[V]-E/--empty\f[R] flag to show them. +the \f[CR]-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[V]--align-all\f[R] flag. +memory, use the \f[CR]--align-all\f[R] flag. .PP This command also supports the output destination and output format options. -The output formats supported are \f[V]txt\f[R], \f[V]csv\f[R], -\f[V]tsv\f[R], and \f[V]json\f[R]. +The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R], +\f[CR]tsv\f[R], and \f[CR]json\f[R]. .SS aregister and posting dates -.PP aregister always shows one line (and date and amount) per transaction. But sometimes transactions have postings with different dates. Also, not all of a transaction\[aq]s postings may be within the report @@ -8437,39 +7807,37 @@ postings. In other words it will show a combined line item with just the earliest date, and the running balance will (temporarily, until the transaction\[aq]s last posting) be inaccurate. -Use \f[V]register -H\f[R] if you need to see the individual postings. +Use \f[CR]register -H\f[R] if you need to see the individual postings. .PP -There is also a \f[V]--txn-dates\f[R] flag, which filters strictly by +There is also a \f[CR]--txn-dates\f[R] flag, which filters strictly by transaction date, ignoring posting dates. This too can cause an inaccurate running balance. .SS balance -.PP (bal) .PP Show accounts and their balances. .PP -\f[V]balance\f[R] is one of hledger\[aq]s oldest and most versatile +\f[CR]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[V]balance\f[R] +Note there are some higher-level variants of the \f[CR]balance\f[R] command with convenient defaults, which can be simpler to use: -\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]. +\f[CR]balancesheet\f[R], \f[CR]balancesheetequity\f[R], +\f[CR]cashflow\f[R] and \f[CR]incomestatement\f[R]. +When you need more control, then use \f[CR]balance\f[R]. .SS balance features -.PP -Here\[aq]s a quick overview of the \f[V]balance\f[R] command\[aq]s +Here\[aq]s a quick overview of the \f[CR]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[V]balance\f[R] can show.. +\f[CR]balance\f[R] can show.. .IP \[bu] 2 -accounts as a list (\f[V]-l\f[R]) or a tree (\f[V]-t\f[R]) +accounts as a list (\f[CR]-l\f[R]) or a tree (\f[CR]-t\f[R]) .IP \[bu] 2 -optionally depth-limited (\f[V]-[1-9]\f[R]) +optionally depth-limited (\f[CR]-[1-9]\f[R]) .IP \[bu] 2 sorted by declaration order and name, or by amount .PP @@ -8477,70 +7845,70 @@ 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[V]--budget\f[R]) +or actual and planned balance changes (\f[CR]--budget\f[R]) .IP \[bu] 2 -or value of balance changes (\f[V]-V\f[R]) +or value of balance changes (\f[CR]-V\f[R]) .IP \[bu] 2 -or change of balance values (\f[V]--valuechange\f[R]) +or change of balance values (\f[CR]--valuechange\f[R]) .IP \[bu] 2 -or unrealised capital gain/loss (\f[V]--gain\f[R]) +or unrealised capital gain/loss (\f[CR]--gain\f[R]) .IP \[bu] 2 -or postings count (\f[V]--count\f[R]) +or postings count (\f[CR]--count\f[R]) .PP \&..in.. .IP \[bu] 2 one time period (the whole journal period by default) .IP \[bu] 2 -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]) +or multiple periods (\f[CR]-D\f[R], \f[CR]-W\f[R], \f[CR]-M\f[R], +\f[CR]-Q\f[R], \f[CR]-Y\f[R], \f[CR]-p INTERVAL\f[R]) .PP \&..either.. .IP \[bu] 2 per period (the default) .IP \[bu] 2 -or accumulated since report start date (\f[V]--cumulative\f[R]) +or accumulated since report start date (\f[CR]--cumulative\f[R]) .IP \[bu] 2 -or accumulated since account creation (\f[V]--historical/-H\f[R]) +or accumulated since account creation (\f[CR]--historical/-H\f[R]) .PP \&..possibly converted to.. .IP \[bu] 2 -cost (\f[V]--value=cost[,COMM]\f[R]/\f[V]--cost\f[R]/\f[V]-B\f[R]) +cost (\f[CR]--value=cost[,COMM]\f[R]/\f[CR]--cost\f[R]/\f[CR]-B\f[R]) .IP \[bu] 2 -or market value, as of transaction dates (\f[V]--value=then[,COMM]\f[R]) +or market value, as of transaction dates +(\f[CR]--value=then[,COMM]\f[R]) .IP \[bu] 2 -or at period ends (\f[V]--value=end[,COMM]\f[R]) +or at period ends (\f[CR]--value=end[,COMM]\f[R]) .IP \[bu] 2 -or now (\f[V]--value=now\f[R]) +or now (\f[CR]--value=now\f[R]) .IP \[bu] 2 -or at some other date (\f[V]--value=YYYY-MM-DD\f[R]) +or at some other date (\f[CR]--value=YYYY-MM-DD\f[R]) .PP \&..with.. .IP \[bu] 2 -totals (\f[V]-T\f[R]), averages (\f[V]-A\f[R]), percentages -(\f[V]-%\f[R]), inverted sign (\f[V]--invert\f[R]) +totals (\f[CR]-T\f[R]), averages (\f[CR]-A\f[R]), percentages +(\f[CR]-%\f[R]), inverted sign (\f[CR]--invert\f[R]) .IP \[bu] 2 -rows and columns swapped (\f[V]--transpose\f[R]) +rows and columns swapped (\f[CR]--transpose\f[R]) .IP \[bu] 2 -another field used as account name (\f[V]--pivot\f[R]) +another field used as account name (\f[CR]--pivot\f[R]) .IP \[bu] 2 custom-formatted line items (single-period reports only) -(\f[V]--format\f[R]) +(\f[CR]--format\f[R]) .IP \[bu] 2 commodities displayed on the same line or multiple lines -(\f[V]--layout\f[R]) +(\f[CR]--layout\f[R]) .PP This command supports the output destination and output format options, -with output formats \f[V]txt\f[R], \f[V]csv\f[R], \f[V]tsv\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 +with output formats \f[CR]txt\f[R], \f[CR]csv\f[R], \f[CR]tsv\f[R], +\f[CR]json\f[R], and (multi-period reports only:) \f[CR]html\f[R]. +In \f[CR]txt\f[R] output in a colour-supporting terminal, negative amounts are shown in red. .PP -The \f[V]--related\f[R]/\f[V]-r\f[R] flag shows the balance of the +The \f[CR]--related\f[R]/\f[CR]-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[V]balance\f[R] shows a list of all accounts and +With no arguments, \f[CR]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. (\[dq]Simple\[dq] here means just one column of numbers, covering a @@ -8554,8 +7922,7 @@ Accounts are sorted by declaration order if any, and then alphabetically by account name. For instance (using examples/sample.journal): .IP -.nf -\f[C] +.EX $ hledger -f examples/sample.journal bal $1 assets:bank:saving $-2 assets:cash @@ -8566,16 +7933,14 @@ $ hledger -f examples/sample.journal bal $1 liabilities:debts -------------------- 0 -\f[R] -.fi +.EE .PP Accounts with a zero balance (and no non-zero subaccounts, in tree mode - see below) are hidden by default. -Use \f[V]-E/--empty\f[R] to show them (revealing -\f[V]assets:bank:checking\f[R] here): +Use \f[CR]-E/--empty\f[R] to show them (revealing +\f[CR]assets:bank:checking\f[R] here): .IP -.nf -\f[C] +.EX $ hledger -f examples/sample.journal bal -E 0 assets:bank:checking $1 assets:bank:saving @@ -8587,20 +7952,17 @@ $ hledger -f examples/sample.journal bal -E $1 liabilities:debts -------------------- 0 -\f[R] -.fi +.EE .PP The total of the amounts displayed is shown as the last line, unless -\f[V]-N\f[R]/\f[V]--no-total\f[R] is used. +\f[CR]-N\f[R]/\f[CR]--no-total\f[R] is used. .SS Balance report line format -.PP For single-period balance reports displayed in the terminal (only), you -can use \f[V]--format FMT\f[R] to customise the format and content of +can use \f[CR]--format FMT\f[R] to customise the format and content of each line. Eg: .IP -.nf -\f[C] +.EX $ hledger -f examples/sample.journal balance --format \[dq]%20(account) %12(total)\[dq] assets $-1 bank:saving $1 @@ -8614,14 +7976,13 @@ $ hledger -f examples/sample.journal balance --format \[dq]%20(account) %12(tota liabilities:debts $1 --------------------------------- 0 -\f[R] -.fi +.EE .PP The FMT format string specifies the formatting applied to each account/balance pair. It may contain any suitable text, with data fields interpolated like so: .PP -\f[V]%[MIN][.MAX](FIELDNAME)\f[R] +\f[CR]%[MIN][.MAX](FIELDNAME)\f[R] .IP \[bu] 2 MIN pads with spaces to at least this width (optional) .IP \[bu] 2 @@ -8630,67 +7991,62 @@ MAX truncates at this width (optional) FIELDNAME must be enclosed in parentheses, and can be one of: .RS 2 .IP \[bu] 2 -\f[V]depth_spacer\f[R] - a number of spaces equal to the account\[aq]s +\f[CR]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[V]account\f[R] - the account\[aq]s name +\f[CR]account\f[R] - the account\[aq]s name .IP \[bu] 2 -\f[V]total\f[R] - the account\[aq]s balance/posted total, right +\f[CR]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[V]%_\f[R] - render on multiple lines, bottom-aligned (the default) +\f[CR]%_\f[R] - render on multiple lines, bottom-aligned (the default) .IP \[bu] 2 -\f[V]%\[ha]\f[R] - render on multiple lines, top-aligned +\f[CR]%\[ha]\f[R] - render on multiple lines, top-aligned .IP \[bu] 2 -\f[V]%,\f[R] - render on one line, comma-separated +\f[CR]%,\f[R] - render on one line, comma-separated .PP There are some quirks. -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. +Eg in one-line mode, \f[CR]%(depth_spacer)\f[R] has no effect, instead +\f[CR]%(account)\f[R] has indentation built in. +\ Experimentation may be needed to get pleasing results. .PP Some example formats: .IP \[bu] 2 -\f[V]%(total)\f[R] - the account\[aq]s total +\f[CR]%(total)\f[R] - the account\[aq]s total .IP \[bu] 2 -\f[V]%-20.20(account)\f[R] - the account\[aq]s name, left justified, +\f[CR]%-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[V]%,%-50(account) %25(total)\f[R] - account name padded to 50 +\f[CR]%,%-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[V]%20(total) %2(depth_spacer)%-(account)\f[R] - the default format +\f[CR]%20(total) %2(depth_spacer)%-(account)\f[R] - the default format for the single-column balance report .SS Filtered balance report -.PP 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: .IP -.nf -\f[C] +.EX $ hledger -f examples/sample.journal bal --cleared assets date:200806 $-2 assets:cash -------------------- $-2 -\f[R] -.fi +.EE .SS List or tree mode -.PP -By default, or with \f[V]-l/--flat\f[R], accounts are shown as a flat +By default, or with \f[CR]-l/--flat\f[R], accounts are shown as a flat list with their full names visible, as in the examples above. .PP -With \f[V]-t/--tree\f[R], the account hierarchy is shown, with +With \f[CR]-t/--tree\f[R], the account hierarchy is shown, with subaccounts\[aq] \[dq]leaf\[dq] names indented below their parent: .IP -.nf -\f[C] +.EX $ hledger -f examples/sample.journal balance $-1 assets $1 bank:saving @@ -8704,15 +8060,14 @@ $ hledger -f examples/sample.journal balance $1 liabilities:debts -------------------- 0 -\f[R] -.fi +.EE .PP Notes: .IP \[bu] 2 \[dq]Boring\[dq] accounts are combined with their subaccount for more -compact output, unless \f[V]--no-elide\f[R] is used. +compact output, unless \f[CR]--no-elide\f[R] is used. Boring accounts have no balance of their own and just one subaccount (eg -\f[V]assets:bank\f[R] and \f[V]liabilities\f[R] above). +\f[CR]assets:bank\f[R] and \f[CR]liabilities\f[R] above). .IP \[bu] 2 All balances shown are \[dq]inclusive\[dq], ie including the balances from all subaccounts. @@ -8724,9 +8079,8 @@ balances shown, not of all the balances shown. Each group of sibling accounts (ie, under a common parent) is sorted separately. .SS Depth limiting -.PP -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 +With a \f[CR]depth:NUM\f[R] query, or \f[CR]--depth NUM\f[R] option, or +just \f[CR]-NUM\f[R] (eg: \f[CR]-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 @@ -8734,8 +8088,7 @@ Account balances at the depth limit always include the balances from any deeper subaccounts (even in list mode). Eg, limiting to depth 1: .IP -.nf -\f[C] +.EX $ hledger -f examples/sample.journal balance -1 $-1 assets $2 expenses @@ -8743,31 +8096,26 @@ $ hledger -f examples/sample.journal balance -1 $1 liabilities -------------------- 0 -\f[R] -.fi +.EE .SS Dropping top-level accounts -.PP You can also hide one or more top-level account name parts, using -\f[V]--drop NUM\f[R]. +\f[CR]--drop NUM\f[R]. This can be useful for hiding repetitive top-level account names: .IP -.nf -\f[C] +.EX $ hledger -f examples/sample.journal bal expenses --drop 1 $1 food $1 supplies -------------------- $2 -\f[R] -.fi +.EE .PP .SS Showing declared accounts -.PP -With \f[V]--declared\f[R], accounts which have been declared with an +With \f[CR]--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[V]-E/--empty\f[R] to see them.) +\f[CR]-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. @@ -8776,58 +8124,50 @@ The idea of this is to be able to see a useful \[dq]complete\[dq] balance report, even when you don\[aq]t have transactions in all of your declared accounts yet. .SS Sorting by amount -.PP -With \f[V]-S/--sort-amount\f[R], accounts with the largest (most +With \f[CR]-S/--sort-amount\f[R], accounts with the largest (most positive) balances are shown first. -Eg: \f[V]hledger bal expenses -MAS\f[R] shows your biggest averaged +Eg: \f[CR]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[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. +\f[CR]-S\f[R] shows these in reverse order. +To work around this, you can add \f[CR]--invert\f[R] to flip the signs. (Or, use one of the higher-level reports, which flip the sign automatically. -Eg: \f[V]hledger incomestatement -MAS\f[R]). +Eg: \f[CR]hledger incomestatement -MAS\f[R]). .PP .SS Percentages -.PP -With \f[V]-%/--percent\f[R], balance reports show each account\[aq]s +With \f[CR]-%/--percent\f[R], balance reports show each account\[aq]s value expressed as a percentage of the (column) total. .PP Note it is not useful to calculate percentages if the amounts in a column have mixed signs. In this case, make a separate report for each sign, eg: .IP -.nf -\f[C] +.EX $ hledger bal -% amt:\[ga]>0\[ga] $ hledger bal -% amt:\[ga]<0\[ga] -\f[R] -.fi +.EE .PP Similarly, if the amounts in a column have mixed commodities, convert -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: +them to one commodity with \f[CR]-B\f[R], \f[CR]-V\f[R], \f[CR]-X\f[R] +or \f[CR]--value\f[R], or make a separate report for each commodity: .IP -.nf -\f[C] +.EX $ hledger bal -% cur:\[rs]\[rs]$ $ hledger bal -% cur:€ -\f[R] -.fi +.EE .SS Multi-period balance report -.PP -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): +With a report interval (set by the \f[CR]-D/--daily\f[R], +\f[CR]-W/--weekly\f[R], \f[CR]-M/--monthly\f[R], +\f[CR]-Q/--quarterly\f[R], \f[CR]-Y/--yearly\f[R], or +\f[CR]-p/--period\f[R] flag), \f[CR]balance\f[R] shows a tabular report, +with columns representing successive time periods (and a title): .IP -.nf -\f[C] +.EX $ hledger -f examples/sample.journal bal --quarterly income expenses -E Balance changes in 2008: @@ -8839,8 +8179,7 @@ Balance changes in 2008: income:salary || $-1 0 0 0 -------------------++--------------------------------- || $-1 $1 0 0 -\f[R] -.fi +.EE .PP Notes: .IP \[bu] 2 @@ -8849,21 +8188,22 @@ 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[V]-E/--empty\f[R] is used. +shown, unless \f[CR]-E/--empty\f[R] is used. .IP \[bu] 2 Accounts (rows) containing all zeroes are not shown, unless -\f[V]-E/--empty\f[R] is used. +\f[CR]-E/--empty\f[R] is used. .IP \[bu] 2 Amounts with many commodities are shown in abbreviated form, unless -\f[V]--no-elide\f[R] is used. +\f[CR]--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[V]-A/--average\f[R] and \f[V]-T/--row-total\f[R] flags. +\f[CR]-A/--average\f[R] and \f[CR]-T/--row-total\f[R] flags. .IP \[bu] 2 -The \f[V]--transpose\f[R] flag can be used to exchange rows and columns. +The \f[CR]--transpose\f[R] flag can be used to exchange rows and +columns. .IP \[bu] 2 -The \f[V]--pivot FIELD\f[R] option causes a different transaction field +The \f[CR]--pivot FIELD\f[R] option causes a different transaction field to be used as \[dq]account name\[dq]. See PIVOTING. .PP @@ -8871,26 +8211,25 @@ 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[V]-N/--no-total\f[R] +Hide the totals row with \f[CR]-N/--no-total\f[R] .IP \[bu] 2 -Convert to a single currency with \f[V]-V\f[R] +Convert to a single currency with \f[CR]-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[V]hledger bal -D --color=yes | less -RS\f[R] +\f[CR]hledger bal -D --color=yes | less -RS\f[R] .IP \[bu] 2 Output as CSV and use a CSV viewer like visidata -(\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]) +(\f[CR]hledger bal -D -O csv | vd -f csv\f[R]), Emacs\[aq] csv-mode +(\f[CR]M-x csv-mode, C-c C-a\f[R]), or a spreadsheet +(\f[CR]hledger bal -D -o a.csv && open a.csv\f[R]) .IP \[bu] 2 Output as HTML and view with a browser: -\f[V]hledger bal -D -o a.html && open a.html\f[R] +\f[CR]hledger bal -D -o a.html && open a.html\f[R] .SS Balance change, end balance -.PP It\[aq]s important to be clear on the meaning of the numbers shown in balance reports. Here is some terminology we use: @@ -8914,7 +8253,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[V]balance\f[R] shows balance changes by default. +\f[CR]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] @@ -8923,11 +8262,10 @@ 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[V]-H/--historical\f[R] flag. -(\f[V]-H\f[R] causes report start date to be ignored when summing +\f[CR]-H/--historical\f[R] flag. +(\f[CR]-H\f[R] causes report start date to be ignored when summing postings.) .SS Balance report types -.PP The balance command is quite flexible; here is the full detail on how to control what it reports. If the following seems complicated, don\[aq]t worry - this is for @@ -8936,51 +8274,48 @@ familiar with all the report modes. .PP There are three important option groups: .PP -\f[V]hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] ...\f[R] +\f[CR]hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] ...\f[R] .SS Calculation type -.PP The basic calculation to perform for each table cell. It is one of: .IP \[bu] 2 -\f[V]--sum\f[R] : sum the posting amounts (\f[B]default\f[R]) +\f[CR]--sum\f[R] : sum the posting amounts (\f[B]default\f[R]) .IP \[bu] 2 -\f[V]--budget\f[R] : sum the amounts, but also show the budget goal +\f[CR]--budget\f[R] : sum the amounts, but also show the budget goal amount (for each account/period) .IP \[bu] 2 -\f[V]--valuechange\f[R] : show the change in period-end historical +\f[CR]--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[V]--gain\f[R] : show the unrealised capital gain/loss, (the current +\f[CR]--gain\f[R] : show the unrealised capital gain/loss, (the current valued balance minus each amount\[aq]s original cost) .IP \[bu] 2 -\f[V]--count\f[R] : show the count of postings +\f[CR]--count\f[R] : show the count of postings .SS Accumulation type -.PP How amounts should accumulate across report periods. Another way to say it: which time period\[aq]s postings should contribute to each cell\[aq]s calculation. It is one of: .IP \[bu] 2 -\f[V]--change\f[R] : calculate with postings from column start to column -end, ie \[dq]just this column\[dq]. +\f[CR]--change\f[R] : calculate with postings from column start to +column end, ie \[dq]just this column\[dq]. Typically used to see revenues/expenses. (\f[B]default for balance, incomestatement\f[R]) .IP \[bu] 2 -\f[V]--cumulative\f[R] : calculate with postings from report start to +\f[CR]--cumulative\f[R] : calculate with postings from report start to column end, ie \[dq]previous columns plus this column\[dq]. Typically used to show changes accumulated since the report\[aq]s start date. Not often used. .IP \[bu] 2 -\f[V]--historical/-H\f[R] : calculate with postings from journal start +\f[CR]--historical/-H\f[R] : calculate with postings from journal start to column end, ie \[dq]all postings from before report start date until this column\[aq]s end\[dq]. Typically used to see historical end balances of assets/liabilities/equity. (\f[B]default for balancesheet, balancesheetequity, cashflow\f[R]) .SS Valuation type -.PP Which kind of value or cost conversion should be applied, if any, before displaying the report. It is one of: @@ -8988,48 +8323,47 @@ It is one of: no valuation type : don\[aq]t convert to cost or value (\f[B]default\f[R]) .IP \[bu] 2 -\f[V]--value=cost[,COMM]\f[R] : convert amounts to cost (then optionally -to some other commodity) +\f[CR]--value=cost[,COMM]\f[R] : convert amounts to cost (then +optionally to some other commodity) .IP \[bu] 2 -\f[V]--value=then[,COMM]\f[R] : convert amounts to market value on +\f[CR]--value=then[,COMM]\f[R] : convert amounts to market value on transaction dates .IP \[bu] 2 -\f[V]--value=end[,COMM]\f[R] : convert amounts to market value on period -end date(s) +\f[CR]--value=end[,COMM]\f[R] : convert amounts to market value on +period end date(s) .PD 0 .P .PD -(\f[B]default with \f[VB]--valuechange\f[B], \f[VB]--gain\f[B]\f[R]) +(\f[B]default with \f[CB]--valuechange\f[B], \f[CB]--gain\f[B]\f[R]) .IP \[bu] 2 -\f[V]--value=now[,COMM]\f[R] : convert amounts to market value on +\f[CR]--value=now[,COMM]\f[R] : convert amounts to market value on today\[aq]s date .IP \[bu] 2 -\f[V]--value=YYYY-MM-DD[,COMM]\f[R] : convert amounts to market value on -another date +\f[CR]--value=YYYY-MM-DD[,COMM]\f[R] : convert amounts to market value +on another date .PP or one of the equivalent simpler flags: .IP \[bu] 2 -\f[V]-B/--cost\f[R] : like --value=cost (though, note --cost and --value -are independent options which can both be used at once) +\f[CR]-B/--cost\f[R] : like --value=cost (though, note --cost and +--value are independent options which can both be used at once) .IP \[bu] 2 -\f[V]-V/--market\f[R] : like --value=end +\f[CR]-V/--market\f[R] : like --value=end .IP \[bu] 2 -\f[V]-X COMM/--exchange COMM\f[R] : like --value=end,COMM +\f[CR]-X COMM/--exchange COMM\f[R] : like --value=end,COMM .PP See Cost reporting and Value reporting for more about these. .SS Combining balance report types -.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[V]--valuechange\f[R] implies \f[V]--value=end\f[R] +\f[CR]--valuechange\f[R] implies \f[CR]--value=end\f[R] .IP \[bu] 2 -\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 +\f[CR]--valuechange\f[R] makes \f[CR]--change\f[R] the default when used +with the \f[CR]balancesheet\f[R]/\f[CR]balancesheetequity\f[R] commands .IP \[bu] 2 -\f[V]--cumulative\f[R] or \f[V]--historical\f[R] disables -\f[V]--row-total/-T\f[R] +\f[CR]--cumulative\f[R] or \f[CR]--historical\f[R] disables +\f[CR]--row-total/-T\f[R] .PP For reference, here is what the combinations of accumulation and valuation show: @@ -9042,15 +8376,15 @@ Valuation:> Accumulation:v T}@T{ no valuation T}@T{ -\f[V]--value= then\f[R] +\f[CR]--value= then\f[R] T}@T{ -\f[V]--value= end\f[R] +\f[CR]--value= end\f[R] T}@T{ -\f[V]--value= YYYY-MM-DD /now\f[R] +\f[CR]--value= YYYY-MM-DD /now\f[R] T} _ T{ -\f[V]--change\f[R] +\f[CR]--change\f[R] T}@T{ change in period T}@T{ @@ -9061,7 +8395,7 @@ T}@T{ DATE-value of change in period T} T{ -\f[V]--cumulative\f[R] +\f[CR]--cumulative\f[R] T}@T{ change from report start to period end T}@T{ @@ -9072,7 +8406,7 @@ T}@T{ DATE-value of change from report start to period end T} T{ -\f[V]--historical /-H\f[R] +\f[CR]--historical /-H\f[R] T}@T{ change from journal start to period end (historical end balance) T}@T{ @@ -9084,8 +8418,7 @@ DATE-value of change from journal start to period end T} .TE .SS Budget report -.PP -The \f[V]--budget\f[R] report type activates extra columns showing any +The \f[CR]--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 useful for comparing planned and actual income, expenses, time @@ -9094,8 +8427,7 @@ usage, etc. For example, you can take average monthly expenses in the common expense categories to construct a minimal monthly budget: .IP -.nf -\f[C] +.EX ;; Budget \[ti] monthly income $2000 @@ -9119,13 +8451,11 @@ categories to construct a minimal monthly budget: expenses:bus $53 expenses:gifts $100 assets:bank:checking -\f[R] -.fi +.EE .PP You can now see a monthly budget report: .IP -.nf -\f[C] +.EX $ hledger balance -M --budget Budget performance in 2017/11/01-2017/12/31: @@ -9141,8 +8471,7 @@ Budget performance in 2017/11/01-2017/12/31: income || $1950 [ 98% of $2000] $2100 [ 105% of $2000] ----------------------++---------------------------------------------------- || 0 [ 0] 0 [ 0] -\f[R] -.fi +.EE .PP This is different from a normal balance report in several ways. Currently: @@ -9161,19 +8490,18 @@ After each actual amount, the corresponding goal amount and percentage of goal reached are also shown, in square brackets. .PP 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 +Eg above, the \f[CR]expenses\f[R] actual amount includes the gifts and +supplies transactions, but the \f[CR]expenses:gifts\f[R] and +\f[CR]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[V]-E/--empty\f[R] flag, -which will reveal all accounts including unbudgeted ones, giving the -full picture. +When you need to make things clearer, use the \f[CR]-E/--empty\f[R] +flag, which will reveal all accounts including unbudgeted ones, giving +the full picture. Eg: .IP -.nf -\f[C] +.EX $ hledger balance -M --budget --empty Budget performance in 2017/11/01-2017/12/31: @@ -9191,14 +8519,12 @@ Budget performance in 2017/11/01-2017/12/31: income || $1950 [ 98% of $2000] $2100 [ 105% of $2000] ----------------------++---------------------------------------------------- || 0 [ 0] 0 [ 0] -\f[R] -.fi +.EE .PP You can roll over unspent budgets to next period with -\f[V]--cumulative\f[R]: +\f[CR]--cumulative\f[R]: .IP -.nf -\f[C] +.EX $ hledger balance -M --budget --cumulative Budget performance in 2017/11/01-2017/12/31: @@ -9214,55 +8540,46 @@ Budget performance in 2017/11/01-2017/12/31: income || $1950 [ 98% of $2000] $4050 [ 101% of $4000] ----------------------++---------------------------------------------------- || 0 [ 0] 0 [ 0] -\f[R] -.fi +.EE .PP It\[aq]s common to limit budgets/budget reports to just expenses .IP -.nf -\f[C] +.EX hledger bal -M --budget expenses -\f[R] -.fi +.EE .PP or just revenues and expenses (eg, using account types): .IP -.nf -\f[C] +.EX hledger bal -M --budget type:rx -\f[R] -.fi +.EE .PP It\[aq]s also common to limit or convert them to a single currency -(\f[V]cur:COMM\f[R] or \f[V]-X COMM [--infer-market-prices]\f[R]). -If showing multiple currencies, \f[V]--layout bare\f[R] or -\f[V]--layout tall\f[R] can help. +(\f[CR]cur:COMM\f[R] or \f[CR]-X COMM [--infer-market-prices]\f[R]). +If showing multiple currencies, \f[CR]--layout bare\f[R] or +\f[CR]--layout tall\f[R] can help. .PP For more examples and notes, see Budgeting. .SS Budget report start date -.PP 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[V]\[ti] monthly\f[R] generates its transactions on the 1st of each +\f[CR]\[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. Eg here the default report period is just the day of 2020-01-15: .IP -.nf -\f[C] +.EX \[ti] monthly in 2020 (expenses:food) $500 2020-01-15 expenses:food $400 assets:checking -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger bal expenses --budget Budget performance in 2020-01-15: @@ -9271,17 +8588,16 @@ Budget performance in 2020-01-15: || $400 --------------++------------ || $400 -\f[R] -.fi +.EE .PP To avoid this, specify the budget report\[aq]s period, or at least the -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[V]-b 2020/1/1\f[R] to the above: +start date, with +\f[CR]-b\f[R]/\f[CR]-e\f[R]/\f[CR]-p\f[R]/\f[CR]date:\f[R], to ensure it +includes the budget goal transactions (periodic transactions) that you +want. +Eg, adding \f[CR]-b 2020/1/1\f[R] to the above: .IP -.nf -\f[C] +.EX $ hledger bal expenses --budget -b 2020/1/1 Budget performance in 2020-01-01..2020-01-15: @@ -9290,10 +8606,8 @@ Budget performance in 2020-01-01..2020-01-15: expenses:food || $400 [80% of $500] ---------------++------------------------ || $400 [80% of $500] -\f[R] -.fi +.EE .SS Budgets and subaccounts -.PP 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 budget(s) of the child account(s) would be added to the budget of @@ -9304,30 +8618,27 @@ account, all its parents would have budget as well. .PP To illustrate this, consider the following budget: .IP -.nf -\f[C] +.EX \[ti] monthly from 2019/01 expenses:personal $1,000.00 expenses:personal:electronics $100.00 liabilities -\f[R] -.fi +.EE .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[V]expenses:personal\f[R] and -\f[V]expenses\f[R] is $1100. +means that budget for both \f[CR]expenses:personal\f[R] and +\f[CR]expenses\f[R] is $1100. .PP -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] +Transactions in \f[CR]expenses:personal:electronics\f[R] will be counted +both towards its $100 budget and $1100 of \f[CR]expenses:personal\f[R] , +and transactions in any other subaccount of \f[CR]expenses:personal\f[R] would be counted towards only towards the budget of -\f[V]expenses:personal\f[R]. +\f[CR]expenses:personal\f[R]. .PP For example, let\[aq]s consider these transactions: .IP -.nf -\f[C] +.EX \[ti] monthly from 2019/01 expenses:personal $1,000.00 expenses:personal:electronics $100.00 @@ -9348,18 +8659,16 @@ For example, let\[aq]s consider these transactions: 2019/01/03 Flowers expenses:personal $30.00 liabilities -\f[R] -.fi +.EE .PP As you can see, we have transactions in -\f[V]expenses:personal:electronics:upgrades\f[R] and -\f[V]expenses:personal:train tickets\f[R], and since both of these +\f[CR]expenses:personal:electronics:upgrades\f[R] and +\f[CR]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[V]expenses:personal:electronics\f[R] -and \f[V]expenses:personal\f[R] accordingly: +be counted towards budgets of \f[CR]expenses:personal:electronics\f[R] +and \f[CR]expenses:personal\f[R] accordingly: .IP -.nf -\f[C] +.EX $ hledger balance --budget -M Budget performance in 2019/01: @@ -9371,14 +8680,12 @@ Budget performance in 2019/01: liabilities || $-283.00 [ 26% of $-1100.00] -------------------------------++------------------------------- || 0 [ 0] -\f[R] -.fi +.EE .PP -And with \f[V]--empty\f[R], we can get a better picture of budget +And with \f[CR]--empty\f[R], we can get a better picture of budget allocation and consumption: .IP -.nf -\f[C] +.EX $ hledger balance --budget -M --empty Budget performance in 2019/01: @@ -9392,21 +8699,17 @@ Budget performance in 2019/01: liabilities || $-283.00 [ 26% of $-1100.00] ----------------------------------------++------------------------------- || 0 [ 0] -\f[R] -.fi +.EE .SS Selecting budget goals -.PP The budget report evaluates periodic transaction rules to generate special \[dq]goal transactions\[dq], which generate the goal amounts for each account in each report subperiod. -When troubleshooting, you can use \f[V]print --forecast\f[R] to show +When troubleshooting, you can use \f[CR]print --forecast\f[R] to show these as forecasted transactions: .IP -.nf -\f[C] +.EX $ hledger print --forecast=BUDGETREPORTPERIOD tag:generated -\f[R] -.fi +.EE .PP By default, the budget report uses all available periodic transaction rules to generate goals. @@ -9415,17 +8718,16 @@ 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[V]--budget\f[R] flag. -\f[V]--budget=DESCPAT\f[R] will match all periodic rules whose +the \f[CR]--budget\f[R] flag. +\f[CR]--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 two spaces are needed), and then select from multiple budgets defined in your journal. .SS Budget vs forecast -.PP -\f[V]hledger --forecast ...\f[R] and -\f[V]hledger balance --budget ...\f[R] are separate features, though +\f[CR]hledger --forecast ...\f[R] and +\f[CR]hledger balance --budget ...\f[R] are separate features, though both of them use the periodic transaction rules defined in the journal, and both of them generate temporary transactions for reporting purposes (\[dq]forecast transactions\[dq] and \[dq]budget goal transactions\[dq], @@ -9437,7 +8739,7 @@ CLI: .IP \[bu] 2 --forecast is a general hledger option, usable with any command .IP \[bu] 2 ---budget is a \f[V]balance\f[R] command option, usable only with that +--budget is a \f[CR]balance\f[R] command option, usable only with that command. .PP Visibility of generated transactions: @@ -9452,8 +8754,8 @@ Periodic transaction rules: .IP \[bu] 2 --forecast uses all available periodic transaction rules .IP \[bu] 2 ---budget uses all periodic rules (\f[V]--budget\f[R]) or a selected -subset (\f[V]--budget=DESCPAT\f[R]) +--budget uses all periodic rules (\f[CR]--budget\f[R]) or a selected +subset (\f[CR]--budget=DESCPAT\f[R]) .PP Period of generated transactions: .IP \[bu] 2 @@ -9461,9 +8763,9 @@ Period of generated transactions: .RS 2 .IP \[bu] 2 from after the last regular transaction to the end of the report period -(\f[V]--forecast\f[R]) +(\f[CR]--forecast\f[R]) .IP \[bu] 2 -or, during a specified period (\f[V]--forecast=PERIODEXPR\f[R]) +or, during a specified period (\f[CR]--forecast=PERIODEXPR\f[R]) .IP \[bu] 2 possibly further restricted by a period specified in the periodic transaction rule @@ -9480,25 +8782,24 @@ possibly restricted by a period specified in the periodic transaction rule. .RE .SS Balance report layout -.PP -The \f[V]--layout\f[R] option affects how balance reports show +The \f[CR]--layout\f[R] option affects how balance reports show multi-commodity amounts and commodity symbols, which can improve readability. It can also normalise the data for easy consumption by other programs. It has four possible values: .IP \[bu] 2 -\f[V]--layout=wide[,WIDTH]\f[R]: commodities are shown on a single line, -optionally elided to WIDTH +\f[CR]--layout=wide[,WIDTH]\f[R]: commodities are shown on a single +line, optionally elided to WIDTH .IP \[bu] 2 -\f[V]--layout=tall\f[R]: each commodity is shown on a separate line +\f[CR]--layout=tall\f[R]: each commodity is shown on a separate line .IP \[bu] 2 -\f[V]--layout=bare\f[R]: commodity symbols are in their own column, +\f[CR]--layout=bare\f[R]: commodity symbols are in their own column, amounts are bare numbers .IP \[bu] 2 -\f[V]--layout=tidy\f[R]: data is normalised to easily-consumed +\f[CR]--layout=tidy\f[R]: data is normalised to easily-consumed \[dq]tidy\[dq] form, with one row per data value .PP -Here are the \f[V]--layout\f[R] modes supported by each output format; +Here are the \f[CR]--layout\f[R] modes supported by each output format; note only CSV output supports all of them: .PP .TS @@ -9568,8 +8869,7 @@ Wide layout. With many commodities, reports can be very wide: .RS 2 .IP -.nf -\f[C] +.EX $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide Balance changes in 2012-01-01..2014-12-31: @@ -9578,16 +8878,14 @@ Balance changes in 2012-01-01..2014-12-31: Assets:US:ETrade || 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 ------------------++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- || 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 -\f[R] -.fi +.EE .RE .IP \[bu] 2 Limited wide layout. A width limit reduces the width, but some commodities will be hidden: .RS 2 .IP -.nf -\f[C] +.EX $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide,32 Balance changes in 2012-01-01..2014-12-31: @@ -9596,8 +8894,7 @@ Balance changes in 2012-01-01..2014-12-31: Assets:US:ETrade || 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.. ------------------++--------------------------------------------------------------------------------------------------------------------------- || 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.. -\f[R] -.fi +.EE .RE .IP \[bu] 2 Tall layout. @@ -9605,8 +8902,7 @@ Each commodity gets a new line (may be different in each column), and account names are repeated: .RS 2 .IP -.nf -\f[C] +.EX $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=tall Balance changes in 2012-01-01..2014-12-31: @@ -9623,8 +8919,7 @@ Balance changes in 2012-01-01..2014-12-31: || 12.00 VEA -98.12 USD 14.00 VEA 5120.50 USD || 106.00 VHT 10.00 VEA 170.00 VHT 36.00 VEA || 18.00 VHT 294.00 VHT -\f[R] -.fi +.EE .RE .IP \[bu] 2 Bare layout. @@ -9632,8 +8927,7 @@ Commodity symbols are kept in one column, each commodity gets its own report row, account names are repeated: .RS 2 .IP -.nf -\f[C] +.EX $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=bare Balance changes in 2012-01-01..2014-12-31: @@ -9650,16 +8944,14 @@ Balance changes in 2012-01-01..2014-12-31: || USD 337.18 -98.12 4881.44 5120.50 || VEA 12.00 10.00 14.00 36.00 || VHT 106.00 18.00 170.00 294.00 -\f[R] -.fi +.EE .RE .IP \[bu] 2 Bare layout also affects CSV output, which is useful for producing data that is easier to consume, eg for making charts: .RS 2 .IP -.nf -\f[C] +.EX $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=bare \[dq]account\[dq],\[dq]commodity\[dq],\[dq]balance\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq] @@ -9672,15 +8964,14 @@ $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout= \[dq]total\[dq],\[dq]USD\[dq],\[dq]5120.50\[dq] \[dq]total\[dq],\[dq]VEA\[dq],\[dq]36.00\[dq] \[dq]total\[dq],\[dq]VHT\[dq],\[dq]294.00\[dq] -\f[R] -.fi +.EE .RE .IP \[bu] 2 Note: bare layout will sometimes display an extra row for the no-symbol commodity, because of zero amounts (hledger treats zeroes as commodity-less, usually). -This can break \f[V]hledger-bar\f[R] confusingly (workaround: add a -\f[V]cur:\f[R] query to exclude the no-symbol row). +This can break \f[CR]hledger-bar\f[R] confusingly (workaround: add a +\f[CR]cur:\f[R] query to exclude the no-symbol row). .IP \[bu] 2 Tidy layout produces normalised \[dq]tidy data\[dq], where every variable has its own column and each row represents a single data point. @@ -9691,8 +8982,7 @@ This is the easiest kind of data for other software to consume. Here\[aq]s how it looks: .RS 2 .IP -.nf -\f[C] +.EX $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy \[dq]account\[dq],\[dq]period\[dq],\[dq]start_date\[dq],\[dq]end_date\[dq],\[dq]commodity\[dq],\[dq]value\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]GLD\[dq],\[dq]0\[dq] @@ -9710,69 +9000,66 @@ $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layo \[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]USD\[dq],\[dq]4881.44\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]VEA\[dq],\[dq]14.00\[dq] \[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]VHT\[dq],\[dq]170.00\[dq] -\f[R] -.fi +.EE .RE .SS Useful balance reports -.PP -Some frequently used \f[V]balance\f[R] options/reports are: +Some frequently used \f[CR]balance\f[R] options/reports are: .IP \[bu] 2 -\f[V]bal -M revenues expenses\f[R] +\f[CR]bal -M revenues expenses\f[R] .PD 0 .P .PD Show revenues/expenses in each month. -Also available as the \f[V]incomestatement\f[R] command. +Also available as the \f[CR]incomestatement\f[R] command. .IP \[bu] 2 -\f[V]bal -M -H assets liabilities\f[R] +\f[CR]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[V]balancesheet\f[R] command. +Also available as the \f[CR]balancesheet\f[R] command. .IP \[bu] 2 -\f[V]bal -M -H assets liabilities equity\f[R] +\f[CR]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[V]balancesheetequity\f[R] command. +Also available as the \f[CR]balancesheetequity\f[R] command. .IP \[bu] 2 -\f[V]bal -M assets not:receivable\f[R] +\f[CR]bal -M assets not:receivable\f[R] .PD 0 .P .PD Show changes to liquid assets in each month. -Also available as the \f[V]cashflow\f[R] command. +Also available as the \f[CR]cashflow\f[R] command. .PP Also: .IP \[bu] 2 -\f[V]bal -M expenses -2 -SA\f[R] +\f[CR]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[V]bal -M --budget expenses\f[R] +\f[CR]bal -M --budget expenses\f[R] .PD 0 .P .PD Show monthly expenses and budget goals. .IP \[bu] 2 -\f[V]bal -M --valuechange investments\f[R] +\f[CR]bal -M --valuechange investments\f[R] .PD 0 .P .PD Show monthly change in market value of investment assets. .IP \[bu] 2 -\f[V]bal investments --valuechange -D date:lastweek amt:\[aq]>1000\[aq] -STA [--invert]\f[R] +\f[CR]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 balancesheet -.PP (bs) .PP This command displays a balance sheet, showing historical ending @@ -9781,16 +9068,15 @@ balances of asset and liability accounts. Amounts are shown with normal positive sign, as in conventional financial statements. .PP -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). +This report shows accounts declared with the \f[CR]Asset\f[R], +\f[CR]Cash\f[R] or \f[CR]Liability\f[R] type (see account types). Or if no such accounts are declared, it shows top-level accounts named -\f[V]asset\f[R] or \f[V]liability\f[R] (case insensitive, plurals +\f[CR]asset\f[R] or \f[CR]liability\f[R] (case insensitive, plurals allowed) and their subaccounts. .PP Example: .IP -.nf -\f[C] +.EX $ hledger balancesheet Balance Sheet @@ -9809,21 +9095,19 @@ Liabilities: Total: -------------------- 0 -\f[R] -.fi +.EE .PP -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[V]hledger balance -H assets liabilities\f[R], but +This command is a higher-level variant of the \f[CR]balance\f[R] +command, and supports many of that command\[aq]s features, such as +multi-period reports. +It is similar to \f[CR]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[V]txt\f[R], \f[V]csv\f[R], -\f[V]tsv\f[R], \f[V]html\f[R], and (experimental) \f[V]json\f[R]. +options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R], +\f[CR]tsv\f[R], \f[CR]html\f[R], and (experimental) \f[CR]json\f[R]. .SS balancesheetequity -.PP (bse) .PP This command displays a balance sheet, showing historical ending @@ -9831,17 +9115,16 @@ 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[V]Asset\f[R], -\f[V]Cash\f[R], \f[V]Liability\f[R] or \f[V]Equity\f[R] type (see +This report shows accounts declared with the \f[CR]Asset\f[R], +\f[CR]Cash\f[R], \f[CR]Liability\f[R] or \f[CR]Equity\f[R] type (see account types). Or if no such accounts are declared, it shows top-level accounts named -\f[V]asset\f[R], \f[V]liability\f[R] or \f[V]equity\f[R] (case +\f[CR]asset\f[R], \f[CR]liability\f[R] or \f[CR]equity\f[R] (case insensitive, plurals allowed) and their subaccounts. .PP Example: .IP -.nf -\f[C] +.EX $ hledger balancesheetequity Balance Sheet With Equity @@ -9865,21 +9148,20 @@ Equity: Total: -------------------- 0 -\f[R] -.fi +.EE .PP -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[V]hledger balance -H assets liabilities equity\f[R], -but with smarter account detection, and liabilities/equity displayed -with their sign flipped. +This command is a higher-level variant of the \f[CR]balance\f[R] +command, and supports many of that command\[aq]s features, such as +multi-period reports. +It is similar to +\f[CR]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[V]txt\f[R], \f[V]csv\f[R], -\f[V]tsv\f[R], \f[V]html\f[R], and (experimental) \f[V]json\f[R]. +options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R], +\f[CR]tsv\f[R], \f[CR]html\f[R], and (experimental) \f[CR]json\f[R]. .SS cashflow -.PP (cf) .PP This command displays a cashflow statement, showing the inflows and @@ -9888,27 +9170,26 @@ assets. Amounts are shown with normal positive sign, as in conventional financial statements. .PP -This report shows accounts declared with the \f[V]Cash\f[R] type (see +This report shows accounts declared with the \f[CR]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[V]asset\f[R] (case insensitive, +under a top-level account named \f[CR]asset\f[R] (case insensitive, plural allowed) .IP \[bu] 2 -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]. +whose name contains some variation of \f[CR]cash\f[R], \f[CR]bank\f[R], +\f[CR]checking\f[R] or \f[CR]saving\f[R]. .PP More precisely: all accounts matching this case insensitive regular expression: .PP -\f[V]\[ha]assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|currentcash)(:|$)\f[R] +\f[CR]\[ha]assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|currentcash)(:|$)\f[R] .PP and their subaccounts. .PP An example cashflow report: .IP -.nf -\f[C] +.EX $ hledger cashflow Cashflow Statement @@ -9922,46 +9203,41 @@ Cash flows: Total: -------------------- $-1 -\f[R] -.fi +.EE .PP -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. +This command is a higher-level variant of the \f[CR]balance\f[R] +command, and supports many of that command\[aq]s features, such as +multi-period reports. It is similar to -\f[V]hledger balance assets not:fixed not:investment not:receivable\f[R], +\f[CR]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[V]txt\f[R], \f[V]csv\f[R], -\f[V]tsv\f[R], \f[V]html\f[R], and (experimental) \f[V]json\f[R]. +options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R], +\f[CR]tsv\f[R], \f[CR]html\f[R], and (experimental) \f[CR]json\f[R]. .SS check -.PP Check for various kinds of errors in your data. .PP 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[V]check\f[R] command to run them on demand, with no output and a zero -exit code if all is well. +\f[CR]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 Some examples: .IP -.nf -\f[C] +.EX hledger check # basic checks hledger check -s # basic + strict checks hledger check ordereddates payees # basic + two other checks -\f[R] -.fi +.EE .PP If you are an Emacs user, you can also configure flycheck-hledger to run these checks, providing instant feedback as you edit the journal. .PP Here are the checks currently available: .SS Default checks -.PP These checks are run automatically by (almost) all hledger commands: .IP \[bu] 2 \f[B]parseable\f[R] - data files are in a supported format, with no @@ -9975,13 +9251,12 @@ possible. \f[B]assertions\f[R] - all balance assertions in the journal are passing. (This check can be disabled with -\f[V]-I\f[R]/\f[V]--ignore-assertions\f[R].) +\f[CR]-I\f[R]/\f[CR]--ignore-assertions\f[R].) .SS Strict checks -.PP -These additional checks are run when the \f[V]-s\f[R]/\f[V]--strict\f[R] -(strict mode) flag is used. +These additional checks are run when the +\f[CR]-s\f[R]/\f[CR]--strict\f[R] (strict mode) flag is used. Or, they can be run by giving their names as arguments to -\f[V]check\f[R]: +\f[CR]check\f[R]: .IP \[bu] 2 \f[B]balanced\f[R] - all transactions are balanced after converting to cost, without inferring missing costs. @@ -9992,9 +9267,8 @@ declared .IP \[bu] 2 \f[B]commodities\f[R] - all commodity symbols used have been declared .SS Other checks -.PP These checks can be run only by giving their names as arguments to -\f[V]check\f[R]. +\f[CR]check\f[R]. They are more specialised and not desirable for everyone: .IP \[bu] 2 \f[B]ordereddates\f[R] - transactions are ordered by date within each @@ -10009,7 +9283,6 @@ balance assertion within 7 days of their latest posting .IP \[bu] 2 \f[B]uniqueleafnames\f[R] - all account leaf names are unique .SS Custom checks -.PP A few more checks are are available as separate add-on commands, in https://github.com/simonmichael/hledger/tree/master/bin: .IP \[bu] 2 @@ -10022,8 +9295,7 @@ assertions are passing You could make similar scripts to perform your own custom checks. See: Cookbook -> Scripting. .SS More about specific checks -.PP -\f[V]hledger check recentassertions\f[R] will complain if any +\f[CR]hledger check recentassertions\f[R] will complain if any balance-asserted account has postings more than 7 days after its latest balance assertion. This aims to prevent the situation where you are regularly updating your @@ -10036,7 +9308,6 @@ data; in that case, I recommend to import transactions uncleared, and when you manually review and clear them, also check the latest assertion against the real-world balance.) .SS close -.PP (equity) .PP Generate transactions which transfer account balances to and/or from @@ -10053,27 +9324,27 @@ configured); or if ACCTQUERY is provided, the accounts matched by that. This command has four main modes, corresponding to the most common use cases: .IP "1." 3 -With \f[V]--close\f[R] (default), it prints a \[dq]closing balances\[dq] -transaction that zeroes out ALE (asset, liability, equity) accounts by -default (this requires account types to be inferred or declared); or, -the accounts matched by the provided ACCTQUERY arguments. +With \f[CR]--close\f[R] (default), it prints a \[dq]closing +balances\[dq] transaction that zeroes out ALE (asset, liability, equity) +accounts by default (this requires account types to be inferred or +declared); or, the accounts matched by the provided ACCTQUERY arguments. .IP "2." 3 -With \f[V]--open\f[R], it prints an opposite \[dq]opening balances\[dq] +With \f[CR]--open\f[R], it prints an opposite \[dq]opening balances\[dq] transaction that restores those balances from zero. This is similar to Ledger\[aq]s equity command. .IP "3." 3 -With \f[V]--migrate\f[R], it prints both the closing and opening +With \f[CR]--migrate\f[R], it prints both the closing and opening transactions. This is the preferred way to migrate balances to a new file: run -\f[V]hledger close --migrate\f[R], add the closing transaction at the +\f[CR]hledger close --migrate\f[R], add the closing transaction at the end of the old file, and add the opening transaction at the start of the new file. The matching closing/opening transactions cancel each other out, preserving correct balances during multi-file reporting. .IP "4." 3 -With \f[V]--retain\f[R], it prints a \[dq]retain earnings\[dq] +With \f[CR]--retain\f[R], it prints a \[dq]retain earnings\[dq] transaction that transfers RX (revenue and expense) balances to -\f[V]equity:retained earnings\f[R]. +\f[CR]equity:retained earnings\f[R]. Businesses traditionally do this at the end of each accounting period; it is less necessary with computer-based accounting, but it could still be useful if you want to see the accounting equation (A=L+E) satisfied. @@ -10081,70 +9352,66 @@ be useful if you want to see the accounting equation (A=L+E) satisfied. In all modes, the defaults can be overridden: .IP \[bu] 2 the transaction descriptions can be changed with -\f[V]--close-desc=DESC\f[R] and \f[V]--open-desc=DESC\f[R] +\f[CR]--close-desc=DESC\f[R] and \f[CR]--open-desc=DESC\f[R] .IP \[bu] 2 the account to transfer to/from can be changed with -\f[V]--close-acct=ACCT\f[R] and \f[V]--open-acct=ACCT\f[R] +\f[CR]--close-acct=ACCT\f[R] and \f[CR]--open-acct=ACCT\f[R] .IP \[bu] 2 -the accounts to be closed/opened can be changed with \f[V]ACCTQUERY\f[R] -(account query arguments). +the accounts to be closed/opened can be changed with +\f[CR]ACCTQUERY\f[R] (account query arguments). .IP \[bu] 2 -the closing/opening dates can be changed with \f[V]-e DATE\f[R] (a +the closing/opening dates can be changed with \f[CR]-e DATE\f[R] (a report end date) .PP By default just one destination/source posting will be used, with its amount left implicit. -With \f[V]--x/--explicit\f[R], the amount will be shown explicitly, and +With \f[CR]--x/--explicit\f[R], the amount will be shown explicitly, and if it involves multiple commodities, a separate posting will be -generated for each of them (similar to \f[V]print -x\f[R]). +generated for each of them (similar to \f[CR]print -x\f[R]). .PP -With \f[V]--show-costs\f[R], any amount costs are shown, with separate +With \f[CR]--show-costs\f[R], any amount costs are shown, with separate postings for each cost. This is currently the best way to view investment lots. If you have many currency conversion or investment transactions, it can generate very large journal entries. .PP -With \f[V]--interleaved\f[R], each individual transfer is shown with +With \f[CR]--interleaved\f[R], each individual transfer is shown with source and destination postings next to each other. This could be useful for troubleshooting. .PP The default closing date is yesterday, or the journal\[aq]s end date, whichever is later. -You can change this by specifying a report end date with \f[V]-e\f[R]. +You can change this by specifying a report end date with \f[CR]-e\f[R]. The last day of the report period will be the closing date, eg -\f[V]-e 2024\f[R] means \[dq]close on 2023-12-31\[dq]. +\f[CR]-e 2024\f[R] means \[dq]close on 2023-12-31\[dq]. The opening date is always the day after the closing date. .SS close and balance assertions -.PP Balance assertions will be generated, verifying that the accounts have been reset to zero (and then restored to their previous balances, if there is an opening transaction). .PP These provide useful error checking, but you can ignore them temporarily -with \f[V]-I\f[R], or remove them if you prefer. +with \f[CR]-I\f[R], or remove them if you prefer. .PP You probably should avoid filtering transactions by status or realness -(\f[V]-C\f[R], \f[V]-R\f[R], \f[V]status:\f[R]), or generating postings -(\f[V]--auto\f[R]), with this command, since the balance assertions -would depend on these. +(\f[CR]-C\f[R], \f[CR]-R\f[R], \f[CR]status:\f[R]), or generating +postings (\f[CR]--auto\f[R]), with this command, since the balance +assertions would depend on these. .PP Note custom posting dates spanning the file boundary will disrupt the balance assertions: .IP -.nf -\f[C] +.EX 2023-12-30 a purchase made in december, cleared in january expenses:food 5 assets:bank:checking -5 ; date: 2023-01-02 -\f[R] -.fi +.EE .PP To solve that you can transfer the money to and from a temporary account, in effect splitting the multi-day transaction into two single-day transactions: .IP -.nf -\f[C] +.EX ; in 2022.journal: 2022-12-30 a purchase made in december, cleared in january expenses:food 5 @@ -10154,40 +9421,31 @@ single-day transactions: 2023-01-02 last year\[aq]s transaction cleared equity:pending 5 = 0 assets:bank:checking -5 -\f[R] -.fi +.EE .SS Example: retain earnings -.PP Record 2022\[aq]s revenues/expenses as retained earnings on 2022-12-31, appending the generated transaction to the journal: .IP -.nf -\f[C] +.EX $ hledger close --retain -f 2022.journal -p 2022 >> 2022.journal -\f[R] -.fi +.EE .PP Note 2022\[aq]s income statement will now show only zeroes, because revenues and expenses have been moved entirely to equity. To see them again, you could exclude the retain transaction: .IP -.nf -\f[C] +.EX $ hledger -f 2022.journal is not:desc:\[aq]retain earnings\[aq] -\f[R] -.fi +.EE .SS Example: migrate balances to a new file -.PP Close assets/liabilities/equity on 2022-12-31 and re-open them on 2023-01-01: .IP -.nf -\f[C] +.EX $ hledger close --migrate -f 2022.journal -p 2022 # copy/paste the closing transaction to the end of 2022.journal # copy/paste the opening transaction to the start of 2023.journal -\f[R] -.fi +.EE .PP Now 2022\[aq]s balance sheet will show only zeroes, indicating a balanced accounting equation. @@ -10196,84 +9454,68 @@ adding --infer-equity.) To see the end-of-year balances again, you could exclude the closing transaction: .IP -.nf -\f[C] +.EX $ hledger -f 2022.journal bs not:desc:\[aq]closing balances\[aq] -\f[R] -.fi +.EE .SS Example: excluding closing/opening transactions -.PP When combining many files for multi-year reports, the closing/opening transactions cause some noise in transaction-oriented reports like -\f[V]print\f[R] and \f[V]register\f[R]. -You can exclude them as shown above, but \f[V]not:desc:...\f[R] is not +\f[CR]print\f[R] and \f[CR]register\f[R]. +You can exclude them as shown above, but \f[CR]not:desc:...\f[R] is not ideal as it depends on consistent descriptions; also you will want to avoid excluding the very first opening transaction, which could be awkward. Here is one alternative, using tags: .PP -Add \f[V]clopen:\f[R] tags to all opening/closing balances transactions +Add \f[CR]clopen:\f[R] tags to all opening/closing balances transactions except the first, like this: .IP -.nf -\f[C] +.EX ; 2021.journal 2021-06-01 first opening balances \&... 2021-12-31 closing balances ; clopen:2022 \&... -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX ; 2022.journal 2022-01-01 opening balances ; clopen:2022 \&... 2022-12-31 closing balances ; clopen:2023 \&... -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX ; 2023.journal 2023-01-01 opening balances ; clopen:2023 \&... -\f[R] -.fi +.EE .PP Now, assuming a combined journal like: .IP -.nf -\f[C] +.EX ; all.journal include 2021.journal include 2022.journal include 2023.journal -\f[R] -.fi +.EE .PP -The \f[V]clopen:\f[R] tag can exclude all but the first opening +The \f[CR]clopen:\f[R] tag can exclude all but the first opening transaction. To show a clean multi-year checking register: .IP -.nf -\f[C] +.EX $ hledger -f all.journal areg checking not:tag:clopen -\f[R] -.fi +.EE .PP And the year values allow more precision. To show 2022\[aq]s year-end balance sheet: .IP -.nf -\f[C] +.EX $ hledger -f all.journal bs -e2023 not:tag:clopen=2023 -\f[R] -.fi +.EE .SS codes -.PP List the codes seen in transactions, in the order parsed. .PP This command prints the value of each transaction\[aq]s code field, in @@ -10284,15 +9526,14 @@ 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[V]-E\f[R]/\f[V]--empty\f[R] flag, they will be printed as +With the \f[CR]-E\f[R]/\f[CR]--empty\f[R] flag, they will be printed as blank lines. .PP You can add a query to select a subset of transactions. .PP Examples: .IP -.nf -\f[C] +.EX 2022/1/1 (123) Supermarket Food $5.00 Checking @@ -10308,32 +9549,25 @@ Examples: 2022/1/4 (126) Post Office Postage $3.21 Checking -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger codes 123 124 126 -\f[R] -.fi +.EE .IP -.nf -\f[C] +.EX $ hledger codes -E 123 124 126 -\f[R] -.fi +.EE .SS commodities -.PP List all commodity/currency symbols used or declared in the journal. .SS demo -.PP Play demos of hledger usage in the terminal, if asciinema is installed. .PP Run this command with no argument to list the demos. @@ -10343,12 +9577,12 @@ Tips: Make your terminal window large enough to see the demo clearly. .PP Use the -s/--speed SPEED option to set your preferred playback speed, eg -\f[V]-s4\f[R] to play at 4x original speed or \f[V]-s.5\f[R] to play at -half speed. +\f[CR]-s4\f[R] to play at 4x original speed or \f[CR]-s.5\f[R] to play +at half speed. The default speed is 2x. .PP Other asciinema options can be added following a double dash, eg -\f[V]-- -i.1\f[R] to limit pauses or \f[V]-- -h\f[R] to list +\f[CR]-- -i.1\f[R] to limit pauses or \f[CR]-- -h\f[R] to list asciinema\[aq]s other options. .PP During playback, several keys are available: SPACE to pause/unpause, . @@ -10356,15 +9590,12 @@ to step forward (while paused), CTRL-c quit. .PP Examples: .IP -.nf -\f[C] +.EX $ hledger demo # list available demos $ hledger demo 1 # play the first demo at default speed (2x) $ hledger demo install -s4 # play the \[dq]install\[dq] demo at 4x speed -\f[R] -.fi +.EE .SS descriptions -.PP List the unique descriptions that appear in transactions. .PP This command lists the unique descriptions that appear in transactions, @@ -10373,16 +9604,13 @@ You can add a query to select a subset of transactions. .PP Example: .IP -.nf -\f[C] +.EX $ hledger descriptions Store Name Gas Station | Petrol Person A -\f[R] -.fi +.EE .SS diff -.PP Compares a particular account\[aq]s transactions in two input files. It shows any transactions to this account which are in one file but not in the other. @@ -10401,8 +9629,7 @@ compare the bank data with your journal to find out the cause. .PP Examples: .IP -.nf -\f[C] +.EX $ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro These transactions are in the first file only: @@ -10412,22 +9639,20 @@ These transactions are in the first file only: equity:opening balances EUR -... These transactions are in the second file only: -\f[R] -.fi +.EE .SS files -.PP List all files included in the journal. With a REGEX argument, only file names matching the regular expression (case sensitive) are shown. .SS help -.PP -Show the hledger user manual in the terminal, with \f[V]info\f[R], -\f[V]man\f[R], or a pager. +Show the hledger user manual in the terminal, with \f[CR]info\f[R], +\f[CR]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[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]. +Eg: \f[CR]commands\f[R], \f[CR]print\f[R], \f[CR]forecast\f[R], +\f[CR]journal\f[R], \f[CR]amount\f[R], +\f[CR]\[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 @@ -10435,30 +9660,27 @@ browser, or when the appropriate hledger manual or viewing tools are not installed on your system. .PP By default it chooses the best viewer found in $PATH, trying (in this -order): \f[V]info\f[R], \f[V]man\f[R], \f[V]$PAGER\f[R], \f[V]less\f[R], -\f[V]more\f[R]. -You can force the use of info, man, or a pager with the \f[V]-i\f[R], -\f[V]-m\f[R], or \f[V]-p\f[R] flags, If no viewer can be found, or the +order): \f[CR]info\f[R], \f[CR]man\f[R], \f[CR]$PAGER\f[R], +\f[CR]less\f[R], \f[CR]more\f[R]. +You can force the use of info, man, or a pager with the \f[CR]-i\f[R], +\f[CR]-m\f[R], or \f[CR]-p\f[R] flags, If no viewer can be found, or the command is run non-interactively, it just prints the manual to stdout. .PP -If using \f[V]info\f[R], note that version 6 or greater is needed for +If using \f[CR]info\f[R], note that version 6 or greater is needed for TOPIC lookup. If you are on mac you will likely have info 4.8, and should consider -installing a newer version, eg with \f[V]brew install texinfo\f[R] +installing a newer version, eg with \f[CR]brew install texinfo\f[R] (#1770). .PP Examples .IP -.nf -\f[C] +.EX $ hledger help --help # show how the help command works $ hledger help # show the hledger manual with info, man or $PAGER $ hledger help journal # show the journal topic in the hledger manual $ hledger help -m journal # show it with man, even if info is installed -\f[R] -.fi +.EE .SS import -.PP Read new transactions added to each FILE provided as arguments since last run, and add them to the journal. Or with --dry-run, just print the transactions that would be added. @@ -10469,30 +9691,29 @@ 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[V]add\f[R]). +(see also \f[CR]add\f[R]). .PP -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). +Unlike other hledger commands, with \f[CR]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[V]hledger import bank.csv\f[R] or perhaps -\f[V]hledger import *.csv\f[R]. +\f[CR]hledger import bank.csv\f[R] or perhaps +\f[CR]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 -\f[V]import\f[R] does \f[I]time-based deduplication\f[R], to detect only -the new transactions since the last successful import. +\f[CR]import\f[R] does \f[I]time-based deduplication\f[R], to detect +only the new transactions since the last successful import. (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 downloaded data, which may overlap with previous downloads. Eg if every week (or every day) you download a bank\[aq]s last three months of CSV data, you can safely run -\f[V]hledger import thebank.csv\f[R] each time and only new transactions -will be imported. +\f[CR]hledger import thebank.csv\f[R] each time and only new +transactions will be imported. .PP Since the items being read (CSV records, eg) often do not come with unique identifiers, hledger detects new transactions by date, assuming @@ -10515,8 +9736,8 @@ hledger remembers the latest date processed in each input file by saving a hidden \[dq].latest.FILE\[dq] file in FILE\[aq]s directory (after a succesful import). .PP -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. +Eg when reading \f[CR]finance/bank.csv\f[R], it will look for and update +the \f[CR]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 @@ -10526,31 +9747,26 @@ 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[V]print --new\f[R], but this is less often used. +\f[CR]print --new\f[R], but this is less often used. .PP Related: CSV > Working with CSV > Deduplicating, importing. .SS Import testing -.PP -With \f[V]--dry-run\f[R], the transactions that will be imported are +With \f[CR]--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. Eg, to see any importable transactions which CSV rules have not categorised: .IP -.nf -\f[C] +.EX $ hledger import --dry bank.csv | hledger -f- -I print unknown -\f[R] -.fi +.EE .PP or (live updating): .IP -.nf -\f[C] +.EX $ ls bank.csv* | entr bash -c \[aq]echo ====; hledger import --dry bank.csv | hledger -f- -I print unknown\[aq] -\f[R] -.fi +.EE .PP Note: when importing from multiple files at once, it\[aq]s currently possible for some .latest files to be updated successfully, while the @@ -10559,9 +9775,8 @@ them out of sync (and causing some transactions to be missed). To prevent this, do a --dry-run first and fix any problems before the real import. .SS Importing balance assignments -.PP Entries added by import will have their posting amounts made explicit -(like \f[V]hledger print -x\f[R]). +(like \f[CR]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. @@ -10570,20 +9785,16 @@ institution that provides only balances and not posting amounts) will probably generate incorrect posting amounts. To avoid this problem, use print instead of import: .IP -.nf -\f[C] +.EX $ hledger print IMPORTFILE [--new] >> $LEDGER_FILE -\f[R] -.fi +.EE .PP (If you think import should leave amounts implicit like print does, please test it and send a pull request.) .SS Commodity display styles -.PP Imported amounts will be formatted according to the canonical commodity styles (declared or inferred) in the main journal file. .SS incomestatement -.PP (is) .PP This command displays an income statement, showing revenues and expenses @@ -10591,16 +9802,15 @@ 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[V]Revenue\f[R] or -\f[V]Expense\f[R] type (see account types). +This report shows accounts declared with the \f[CR]Revenue\f[R] or +\f[CR]Expense\f[R] type (see account types). Or if no such accounts are declared, it shows top-level accounts named -\f[V]revenue\f[R] or \f[V]income\f[R] or \f[V]expense\f[R] (case +\f[CR]revenue\f[R] or \f[CR]income\f[R] or \f[CR]expense\f[R] (case insensitive, plurals allowed) and their subaccounts. .PP Example: .IP -.nf -\f[C] +.EX $ hledger incomestatement Income Statement @@ -10621,22 +9831,20 @@ Expenses: Total: -------------------- 0 -\f[R] -.fi +.EE .PP -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. +This command is a higher-level variant of the \f[CR]balance\f[R] +command, and supports many of that command\[aq]s features, such as +multi-period reports. It is similar to -\f[V]hledger balance \[aq](revenues|income)\[aq] expenses\f[R], but with -smarter account detection, and revenues/income displayed with their sign -flipped. +\f[CR]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[V]txt\f[R], \f[V]csv\f[R], -\f[V]tsv\f[R], \f[V]html\f[R], and (experimental) \f[V]json\f[R]. +options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R], +\f[CR]tsv\f[R], \f[CR]html\f[R], and (experimental) \f[CR]json\f[R]. .SS notes -.PP List the unique notes that appear in transactions. .PP This command lists the unique notes that appear in transactions, in @@ -10647,15 +9855,12 @@ The note is the part of the transaction description after a | character .PP Example: .IP -.nf -\f[C] +.EX $ hledger notes Petrol Snacks -\f[R] -.fi +.EE .SS payees -.PP List the unique payee/payer names that appear in transactions. .PP This command lists unique payee/payer names which have been declared @@ -10670,16 +9875,13 @@ This implies --used. .PP Example: .IP -.nf -\f[C] +.EX $ hledger payees Store Name Gas Station Person A -\f[R] -.fi +.EE .SS prices -.PP Print the market prices declared with P directives. With --infer-market-prices, also show any additional prices inferred from costs. @@ -10697,11 +9899,10 @@ calculate value reports. But if in doubt, you can inspect those directly by running the value report with --debug=2. .SS print -.PP 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[V]--date2\f[R], by secondary +journal file, sorted by date (or with \f[CR]--date2\f[R], by secondary date). .PP Directives and inter-transaction comments are not shown, currently. @@ -10711,8 +9912,7 @@ over the directives and inter-transaction comments. .PP Eg: .IP -.nf -\f[C] +.EX $ hledger print -f examples/sample.journal date:200806 2008/06/01 gift assets:bank:checking $1 @@ -10726,29 +9926,26 @@ $ hledger print -f examples/sample.journal date:200806 expenses:food $1 expenses:supplies $1 assets:cash $-2 -\f[R] -.fi +.EE .SS print explicitness -.PP Normally, whether posting amounts are implicit or explicit is preserved. For example, when an amount is omitted in the journal, it will not appear in the output. Similarly, if a conversion cost is implied but not written, it will not appear in the output. .PP -You can use the \f[V]-x\f[R]/\f[V]--explicit\f[R] flag to force explicit -display of all amounts and costs. +You can use the \f[CR]-x\f[R]/\f[CR]--explicit\f[R] flag to force +explicit display of all amounts and costs. This can be useful for troubleshooting or for making your journal more readable and robust against data entry errors. -\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]. +\f[CR]-x\f[R] is also implied by using any of +\f[CR]-B\f[R],\f[CR]-V\f[R],\f[CR]-X\f[R],\f[CR]--value\f[R]. .PP -The \f[V]-x\f[R]/\f[V]--explicit\f[R] flag will cause any postings with -a multi-commodity amount (which can arise when a multi-commodity +The \f[CR]-x\f[R]/\f[CR]--explicit\f[R] flag will cause any postings +with a multi-commodity amount (which can arise when a multi-commodity transaction has an implicit amount) to be split into multiple single-commodity postings, keeping the output parseable. .SS print amount style -.PP Amounts are shown right-aligned within each transaction (but not aligned across all transactions; you can do that with ledger-mode in Emacs). .PP @@ -10757,40 +9954,37 @@ their symbol placement, decimal mark, and digit group marks will be made consistent. By default, decimal digits are shown as they are written in the journal. .PP -With the \f[V]--round\f[R] option, \f[V]print\f[R] will try increasingly -hard to display decimal digits according to the commodity display -styles: +With the \f[CR]--round\f[R] option, \f[CR]print\f[R] will try +increasingly hard to display decimal digits according to the commodity +display styles: .IP \[bu] 2 -\f[V]--round=none\f[R] show amounts with original precisions (default) +\f[CR]--round=none\f[R] show amounts with original precisions (default) .IP \[bu] 2 -\f[V]--round=soft\f[R] add/remove decimal zeros in amounts (except +\f[CR]--round=soft\f[R] add/remove decimal zeros in amounts (except costs) .IP \[bu] 2 -\f[V]--round=hard\f[R] round amounts (except costs), possibly hiding +\f[CR]--round=hard\f[R] round amounts (except costs), possibly hiding significant digits .IP \[bu] 2 -\f[V]--round=all\f[R] round all amounts and costs +\f[CR]--round=all\f[R] round all amounts and costs .PP -\f[V]soft\f[R] is good for non-lossy cleanup, formatting amounts more +\f[CR]soft\f[R] is good for non-lossy cleanup, formatting amounts more consistently where it\[aq]s safe to do so. .PP -\f[V]hard\f[R] and \f[V]all\f[R] can cause \f[V]print\f[R] to show +\f[CR]hard\f[R] and \f[CR]all\f[R] can cause \f[CR]print\f[R] to show invalid unbalanced journal entries; they may be useful eg for stronger cleanup, with manual fixups when needed. .SS print parseability -.PP print\[aq]s output is usually a valid hledger journal, and you can process it again with a second hledger command. This can be useful for certain kinds of search (though the same can be -achieved with \f[V]expr:\f[R] queries now): +achieved with \f[CR]expr:\f[R] queries now): .IP -.nf -\f[C] +.EX # Show running total of food expenses paid from cash. # -f- reads from stdin. -I/--ignore-assertions is sometimes needed. $ hledger print assets:cash | hledger -f- -I reg expenses:food -\f[R] -.fi +.EE .PP There are some situations where print\[aq]s output can become unparseable: @@ -10802,51 +9996,64 @@ Auto postings can generate postings with too many missing amounts. .IP \[bu] 2 Account aliases can generate bad account names. .SS print, other features -.PP -With \f[V]-B\f[R]/\f[V]--cost\f[R], amounts with costs are shown +With \f[CR]-B\f[R]/\f[CR]--cost\f[R], amounts with costs are shown converted to cost. .PP -With \f[V]--new\f[R], print shows only transactions it has not seen on a -previous run. -This uses the same deduplication system as the \f[V]import\f[R] command. +With \f[CR]--new\f[R], print shows only transactions it has not seen on +a previous run. +This uses the same deduplication system as the \f[CR]import\f[R] +command. (See import\[aq]s docs for details.) .PP -With \f[V]-m DESC\f[R]/\f[V]--match=DESC\f[R], print shows one recent +With \f[CR]-m DESC\f[R]/\f[CR]--match=DESC\f[R], print shows one recent transaction whose description is most similar to DESC. 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. .SS print output format -.PP This command also supports the output destination and output format -options The output formats supported are \f[V]txt\f[R], -\f[V]beancount\f[R], \f[V]csv\f[R], \f[V]tsv\f[R], \f[V]json\f[R] and -\f[V]sql\f[R]. +options The output formats supported are \f[CR]txt\f[R], +\f[CR]beancount\f[R], \f[CR]csv\f[R], \f[CR]tsv\f[R], \f[CR]json\f[R] +and \f[CR]sql\f[R]. .PP -\f[I]Experimental:\f[R] The \f[V]beancount\f[R] format tries to produce -Beancount-compatible output. -It is very basic and may require additional manual fixups: +\f[I]Experimental:\f[R] The \f[CR]beancount\f[R] format tries to produce +Beancount-compatible output, as follows: .IP \[bu] 2 Transaction and postings with unmarked status are converted to cleared -(\[ga]*\[ga]\[ga]) status. +(\f[CR]*\f[R]) status. .IP \[bu] 2 -Transactions\[aq] payee and or note are wrapped in double quotes. +Transactions\[aq] payee and note are backslash-escaped and +double-quote-escaped and wrapped in double quotes. .IP \[bu] 2 Transaction tags are copied to Beancount #tag format. .IP \[bu] 2 -Account name parts are capitalised, and if the first account name part -is not one of Assets, Liabilities, Equity, Income, or Expenses, -\[dq]Equity:\[dq] is prepended. +Commodity symbols are converted to upper case, and a small number of +currency symbols like \f[CR]$\f[R] are converted to the corresponding +currency names. .IP \[bu] 2 -The \f[V]$\f[R] commodity symbol is converted to \f[V]USD\f[R]. +Account name parts are capitalised and unsupported characters are +replaced with \f[CR]-\f[R]. +If an account name part does not begin with a letter, or if the first +part is not Assets, Liabilities, Equity, Income, or Expenses, an error +is raised. +(Use \f[CR]--alias\f[R] options to bring your accounts into compliance.) .IP \[bu] 2 -An \f[V]open\f[R] directive is generated for each account used, on the +An \f[CR]open\f[R] directive is generated for each account used, on the earliest transaction date. .PP +Some limitations: +.IP \[bu] 2 +Balance assertions are removed. +.IP \[bu] 2 +Balance assignments become missing amounts. +.IP \[bu] 2 +Virtual and balanced virtual postings become regular postings. +.IP \[bu] 2 +Directives are not converted. +.PP Here\[aq]s an example of print\[aq]s CSV output: .IP -.nf -\f[C] +.EX $ hledger print -Ocsv \[dq]txnidx\[dq],\[dq]date\[dq],\[dq]date2\[dq],\[dq]status\[dq],\[dq]code\[dq],\[dq]description\[dq],\[dq]comment\[dq],\[dq]account\[dq],\[dq]amount\[dq],\[dq]commodity\[dq],\[dq]credit\[dq],\[dq]debit\[dq],\[dq]posting-status\[dq],\[dq]posting-comment\[dq] \[dq]1\[dq],\[dq]2008/01/01\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]income\[dq],\[dq]\[dq],\[dq]assets:bank:checking\[dq],\[dq]1\[dq],\[dq]$\[dq],\[dq]\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq] @@ -10860,8 +10067,7 @@ $ hledger print -Ocsv \[dq]4\[dq],\[dq]2008/06/03\[dq],\[dq]\[dq],\[dq]*\[dq],\[dq]\[dq],\[dq]eat & shop\[dq],\[dq]\[dq],\[dq]assets:cash\[dq],\[dq]-2\[dq],\[dq]$\[dq],\[dq]2\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq] \[dq]5\[dq],\[dq]2008/12/31\[dq],\[dq]\[dq],\[dq]*\[dq],\[dq]\[dq],\[dq]pay off\[dq],\[dq]\[dq],\[dq]liabilities:debts\[dq],\[dq]1\[dq],\[dq]$\[dq],\[dq]\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq] \[dq]5\[dq],\[dq]2008/12/31\[dq],\[dq]\[dq],\[dq]*\[dq],\[dq]\[dq],\[dq]pay off\[dq],\[dq]\[dq],\[dq]assets:bank:checking\[dq],\[dq]-1\[dq],\[dq]$\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq] -\f[R] -.fi +.EE .IP \[bu] 2 There is one CSV record per posting, with the parent transaction\[aq]s fields repeated. @@ -10879,14 +10085,13 @@ The numeric amount is repeated in either the \[dq]credit\[dq] or (Those names are not accurate in the accounting sense; it just puts negative amounts under credit and zero or greater amounts under debit.) .SS register -.PP (reg) .PP 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[V]aregister\f[R] command, which shows matched +(See also the \f[CR]aregister\f[R] command, which shows matched transactions in a specific account.) .PP register normally shows line per posting, but note that multi-commodity @@ -10895,81 +10100,72 @@ amounts will occupy multiple lines (one line per commodity). It is typically used with a query selecting a particular account, to see that account\[aq]s activity: .IP -.nf -\f[C] +.EX $ hledger register checking 2008/01/01 income assets:bank:checking $1 $1 2008/06/01 gift assets:bank:checking $1 $2 2008/06/02 save assets:bank:checking $-1 $1 2008/12/31 pay off assets:bank:checking $-1 0 -\f[R] -.fi +.EE .PP -With \f[V]--date2\f[R], it shows and sorts by secondary date instead. +With \f[CR]--date2\f[R], it shows and sorts by secondary date instead. .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[V]--align-all\f[R] flag. +memory, use the \f[CR]--align-all\f[R] flag. .PP -The \f[V]--historical\f[R]/\f[V]-H\f[R] flag adds the balance from any +The \f[CR]--historical\f[R]/\f[CR]-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: .IP -.nf -\f[C] +.EX $ hledger register checking -b 2008/6 --historical 2008/06/01 gift assets:bank:checking $1 $2 2008/06/02 save assets:bank:checking $-1 $1 2008/12/31 pay off assets:bank:checking $-1 0 -\f[R] -.fi +.EE .PP -The \f[V]--depth\f[R] option limits the amount of sub-account detail +The \f[CR]--depth\f[R] option limits the amount of sub-account detail displayed. .PP -The \f[V]--average\f[R]/\f[V]-A\f[R] flag shows the running average +The \f[CR]--average\f[R]/\f[CR]-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[V]--empty\f[R] (see below). -It is affected by \f[V]--historical\f[R]. +This flag implies \f[CR]--empty\f[R] (see below). +It is affected by \f[CR]--historical\f[R]. It works best when showing just one account and one commodity. .PP -The \f[V]--related\f[R]/\f[V]-r\f[R] flag shows the \f[I]other\f[R] +The \f[CR]--related\f[R]/\f[CR]-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[V]--invert\f[R] flag negates all amounts. +The \f[CR]--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 with the related account: .IP -.nf -\f[C] +.EX $ hledger register --related --invert assets:checking -\f[R] -.fi +.EE .PP With a reporting interval, register shows summary postings, one per interval, aggregating the postings to each account: .IP -.nf -\f[C] +.EX $ hledger register --monthly income 2008/01 income:salary $-1 $-1 2008/06 income:gifts $-1 $-2 -\f[R] -.fi +.EE .PP Periods with no activity, and summary postings with a zero amount, are -not shown by default; use the \f[V]--empty\f[R]/\f[V]-E\f[R] flag to see -them: +not shown by default; use the \f[CR]--empty\f[R]/\f[CR]-E\f[R] flag to +see them: .IP -.nf -\f[C] +.EX $ hledger register --monthly income -E 2008/01 income:salary $-1 $-1 2008/02 0 $-1 @@ -10983,21 +10179,18 @@ $ hledger register --monthly income -E 2008/10 0 $-2 2008/11 0 $-2 2008/12 0 $-2 -\f[R] -.fi +.EE .PP Often, you\[aq]ll want to see just one line per interval. -The \f[V]--depth\f[R] option helps with this, causing subaccounts to be +The \f[CR]--depth\f[R] option helps with this, causing subaccounts to be aggregated: .IP -.nf -\f[C] +.EX $ hledger register --monthly assets --depth 1h 2008/01 assets $1 $1 2008/06 assets $-1 0 2008/12 assets $-1 $-1 -\f[R] -.fi +.EE .PP Note when using report intervals, if you specify start/end dates these will be adjusted outward if necessary to contain a whole number of @@ -11005,50 +10198,44 @@ intervals. This ensures that the first and last intervals are full length and comparable to the others in the report. .PP -With \f[V]-m DESC\f[R]/\f[V]--match=DESC\f[R], register does a fuzzy +With \f[CR]-m DESC\f[R]/\f[CR]--match=DESC\f[R], register does a fuzzy search for one recent posting whose description is most similar to DESC. DESC should contain at least two characters. If there is no similar-enough match, no posting will be shown and the program exit code will be non-zero. .SS Custom register output -.PP register uses the full terminal width by default, except on windows. -You can override this by setting the \f[V]COLUMNS\f[R] environment +You can override this by setting the \f[CR]COLUMNS\f[R] environment variable (not a bash shell variable) or by using the -\f[V]--width\f[R]/\f[V]-w\f[R] option. +\f[CR]--width\f[R]/\f[CR]-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[V]--width W,D\f[R] . +--width\[aq]s argument, comma-separated: \f[CR]--width W,D\f[R] . Here\[aq]s a diagram (won\[aq]t display correctly in --help): .IP -.nf -\f[C] +.EX <--------------------------------- width (W) ----------------------------------> date (10) description (D) account (W-41-D) amount (12) balance (12) DDDDDDDDDD dddddddddddddddddddd aaaaaaaaaaaaaaaaaaa AAAAAAAAAAAA AAAAAAAAAAAA -\f[R] -.fi +.EE .PP and some examples: .IP -.nf -\f[C] +.EX $ hledger reg # use terminal width (or 80 on windows) $ hledger reg -w 100 # use width 100 $ COLUMNS=100 hledger reg # set with one-time environment variable $ export COLUMNS=100; hledger reg # set till session end (or window resize) $ hledger reg -w 100,40 # set overall width 100, description width 40 $ hledger reg -w $COLUMNS,40 # use terminal width, & description width 40 -\f[R] -.fi +.EE .PP This command also supports the output destination and output format -options The output formats supported are \f[V]txt\f[R], \f[V]csv\f[R], -\f[V]tsv\f[R], and (experimental) \f[V]json\f[R]. +options The output formats supported are \f[CR]txt\f[R], \f[CR]csv\f[R], +\f[CR]tsv\f[R], and (experimental) \f[CR]json\f[R]. .SS rewrite -.PP Print all transactions, rewriting the postings of matched transactions. For now the only rewrite available is adding new postings, like print --auto. @@ -11062,113 +10249,94 @@ transaction\[aq]s first posting amount. .PP Examples: .IP -.nf -\f[C] +.EX $ hledger-rewrite.hs \[ha]income --add-posting \[aq](liabilities:tax) *.33 ; income tax\[aq] --add-posting \[aq](reserve:gifts) $100\[aq] $ hledger-rewrite.hs expenses:gifts --add-posting \[aq](reserve:gifts) *-1\[dq]\[aq] $ hledger-rewrite.hs -f rewrites.hledger -\f[R] -.fi +.EE .PP rewrites.hledger may consist of entries like: .IP -.nf -\f[C] +.EX = \[ha]income amt:<0 date:2017 (liabilities:tax) *0.33 ; tax on income (reserve:grocery) *0.25 ; reserve 25% for grocery (reserve:) *0.25 ; reserve 25% for grocery -\f[R] -.fi +.EE .PP Note the single quotes to protect the dollar sign from bash, and the two spaces between account and amount. .PP More: .IP -.nf -\f[C] +.EX $ hledger rewrite -- [QUERY] --add-posting \[dq]ACCT AMTEXPR\[dq] ... $ hledger rewrite -- \[ha]income --add-posting \[aq](liabilities:tax) *.33\[aq] $ hledger rewrite -- expenses:gifts --add-posting \[aq](budget:gifts) *-1\[dq]\[aq] $ hledger rewrite -- \[ha]income --add-posting \[aq](budget:foreign currency) *0.25 JPY; diversify\[aq] -\f[R] -.fi +.EE .PP -Argument for \f[V]--add-posting\f[R] option is a usual posting of +Argument for \f[CR]--add-posting\f[R] option is a usual posting of transaction with an exception for amount specification. -More precisely, you can use \f[V]\[aq]*\[aq]\f[R] (star symbol) before +More precisely, you can use \f[CR]\[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 in the new commodity; otherwise, it will be in the matched posting amount\[aq]s commodity. .SS Re-write rules in a file -.PP During the run this tool will execute so called \[dq]Automated Transactions\[dq] found in any journal it process. I.e instead of specifying this operations in command line you can put them in a journal file. .IP -.nf -\f[C] +.EX $ rewrite-rules.journal -\f[R] -.fi +.EE .PP Make contents look like this: .IP -.nf -\f[C] +.EX = \[ha]income (liabilities:tax) *.33 = expenses:gifts budget:gifts *-1 assets:budget *1 -\f[R] -.fi +.EE .PP -Note that \f[V]\[aq]=\[aq]\f[R] (equality symbol) that is used instead +Note that \f[CR]\[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. .IP -.nf -\f[C] +.EX $ hledger rewrite -- -f input.journal -f rewrite-rules.journal > rewritten-tidy-output.journal -\f[R] -.fi +.EE .PP This is something similar to the commands pipeline: .IP -.nf -\f[C] +.EX $ hledger rewrite -- -f input.journal \[aq]\[ha]income\[aq] --add-posting \[aq](liabilities:tax) *.33\[aq] \[rs] | hledger rewrite -- -f - expenses:gifts --add-posting \[aq]budget:gifts *-1\[aq] \[rs] --add-posting \[aq]assets:budget *1\[aq] \[rs] > rewritten-tidy-output.journal -\f[R] -.fi +.EE .PP It is important to understand that relative order of such entries in journal is important. You can re-use result of previously added postings. .SS Diff output format -.PP To use this tool for batch modification of your journal files you may find useful output in form of unified diff. .IP -.nf -\f[C] +.EX $ hledger rewrite -- --diff -f examples/sample.journal \[aq]\[ha]income\[aq] --add-posting \[aq](liabilities:tax) *.33\[aq] -\f[R] -.fi +.EE .PP Output might look like: .IP -.nf -\f[C] +.EX --- /tmp/examples/sample.journal +++ /tmp/examples/sample.journal \[at]\[at] -18,3 +18,4 \[at]\[at] @@ -11183,24 +10351,22 @@ Output might look like: + assets:bank:checking $1 income:gifts + (liabilities:tax) 0 -\f[R] -.fi +.EE .PP -If you\[aq]ll pass this through \f[V]patch\f[R] tool you\[aq]ll get +If you\[aq]ll pass this through \f[CR]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[V]--file\f[R] options and \f[V]include\f[R] +files specified via \f[CR]--file\f[R] options and \f[CR]include\f[R] directives inside of these files. .PP Be careful. Whole transaction being re-formatted in a style of output from -\f[V]hledger print\f[R]. +\f[CR]hledger print\f[R]. .PP See also: .PP https://github.com/simonmichael/hledger/issues/99 .SS rewrite vs. print --auto -.PP This command predates print --auto, and currently does much the same thing, but with these differences: .IP \[bu] 2 @@ -11216,19 +10382,18 @@ print --auto\[aq]s query limits which transactions are printed. rewrite applies rules specified on command line or in the journal. print --auto applies rules specified in the journal. .SS roi -.PP 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[V]--inv\f[R], and another +name) to select your investment(s) with \f[CR]--inv\f[R], and another query to identify your profit and loss transactions with -\f[V]--pnl\f[R]. +\f[CR]--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[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 +\f[CR]--pnl\f[R] could be an empty query (\f[CR]--pnl \[dq]\[dq]\f[R] or +\f[CR]--pnl STR\f[R] where \f[CR]STR\f[R] does not match any of your accounts). .PP This command will compute and display the internalized rate of return @@ -11239,7 +10404,7 @@ reported both as a rate over the chosen reporting period and as an annual rate. .PP Price directives will be taken into account if you supply appropriate -\f[V]--cost\f[R] or \f[V]--value\f[R] flags (see VALUATION). +\f[CR]--cost\f[R] or \f[CR]--value\f[R] flags (see VALUATION). .PP Note, in some cases this report can fail, for these reasons: .IP \[bu] 2 @@ -11257,37 +10422,32 @@ 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[V]--inv\f[R] and \f[V]--pnl\f[R] -.PP -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). +.SS Spaces and special characters in \f[CR]--inv\f[R] and \f[CR]--pnl\f[R] +Note that \f[CR]--inv\f[R] and \f[CR]--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 will need to put them in quotes (see Special characters): .IP -.nf -\f[C] +.EX $ hledger roi --inv \[aq]term1 term2 term3 ...\[aq] -\f[R] -.fi +.EE .PP If any query terms contain spaces themselves, you will need an extra level of nested quoting, eg: .IP -.nf -\f[C] +.EX $ 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[V]--inv\f[R] and \f[V]--pnl\f[R] -.PP -Query supplied to \f[V]--inv\f[R] has to match all transactions that are -related to your investment. -Transactions not matching \f[V]--inv\f[R] will be ignored. +.EE +.SS Semantics of \f[CR]--inv\f[R] and \f[CR]--pnl\f[R] +Query supplied to \f[CR]--inv\f[R] has to match all transactions that +are related to your investment. +Transactions not matching \f[CR]--inv\f[R] will be ignored. .PP In these transactions, ROI will conside postings that match -\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: +\f[CR]--inv\f[R] to be \[dq]investment postings\[dq] and other postings +(not matching \f[CR]--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. @@ -11298,8 +10458,7 @@ commodity and any other commodity. Example: .RS 2 .IP -.nf -\f[C] +.EX 2019-01-01 Investing in Snake Oil assets:cash -$100 investment:snake oil @@ -11307,32 +10466,28 @@ Example: 2020-01-01 Selling my Snake Oil assets:cash $10 investment:snake oil = 0 -\f[R] -.fi +.EE .RE .IP \[bu] 2 \[dq]Profit and loss\[dq] is change in the value of your investment: .RS 2 .IP -.nf -\f[C] +.EX 2019-06-01 Snake Oil falls in value investment:snake oil = $57 equity:unrealized profit or loss -\f[R] -.fi +.EE .RE .PP All non-investment postings are assumed to be \[dq]cash flow\[dq], -unless they match \f[V]--pnl\f[R] query. +unless they match \f[CR]--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[V]--inv snake --pnl equity:unrealized\f[R], then +Example: if you use \f[CR]--inv snake --pnl equity:unrealized\f[R], then postings in the example below would be classifed as: .IP -.nf -\f[C] +.EX 2019-01-01 Snake Oil #1 assets:cash -$100 ; cash flow posting investment:snake oil ; investment posting @@ -11345,10 +10500,8 @@ postings in the example below would be classifed as: equity:unrealized pnl ; profit and loss posting cash -$100 ; cash flow posting snake oil $50 ; investment posting -\f[R] -.fi +.EE .SS IRR and TWR explained -.PP \[dq]ROI\[dq] stands for \[dq]return on investment\[dq]. Traditionally this was computed as a difference between current value of investment and its initial value, expressed in percentage of the initial @@ -11375,8 +10528,8 @@ investment, so your IRR will be larger. .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[V]--inv\f[R] argument and -NOT match the query in the\f[V]--pnl\f[R] argument. +are the postings that match the query in the\f[CR]--inv\f[R] argument +and NOT match the query in the\f[CR]--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 @@ -11391,9 +10544,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[V]=XIRR\f[R] formula in Excel. +\f[CR]=XIRR\f[R] formula in Excel. .PP -Second way to compute rate of return that \f[V]roi\f[R] command +Second way to compute rate of return that \f[CR]roi\f[R] command implements is called \[dq]time-weighted rate of return\[dq] or \[dq]TWR\[dq]. Like IRR, it will account for the effect of your in-flows and out-flows, @@ -11422,7 +10575,6 @@ IRR vs TWR Examples of computing IRR and TWR and discussion of the limitations of both metrics .SS stats -.PP Show journal and performance statistics. .PP The stats command displays summary information for the whole journal, or @@ -11434,13 +10586,12 @@ 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[V]stats\f[R] command\[aq]s run time is similar to that of a +The \f[CR]stats\f[R] command\[aq]s run time is similar to that of a single-column balance report. .PP Example: .IP -.nf -\f[C] +.EX $ hledger stats -f examples/1000x1000x10.journal Main file : /Users/simon/src/hledger/examples/1000x1000x10.journal Included files : @@ -11456,13 +10607,11 @@ Market prices : 1000 (A) Run time : 0.12 s Throughput : 8342 txns/s -\f[R] -.fi +.EE .PP This command supports the -o/--output-file option (but not -O/--output-format selection). .SS tags -.PP List the tags used in the journal, or their values. .PP This command lists the tag names used in the journal, whether on @@ -11488,7 +10637,6 @@ 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. .SS test -.PP Run built-in unit tests. .PP This command runs the unit tests built in to hledger and hledger-lib, @@ -11505,58 +10653,49 @@ This command also accepts tasty test runner options, written after a -- Eg to run only the tests in Hledger.Data.Amount, with ANSI colour codes disabled: .IP -.nf -\f[C] +.EX $ hledger test -- -pData.Amount --color=never -\f[R] -.fi +.EE .PP For help on these, see https://github.com/feuerbach/tasty#options -(\f[V]-- --help\f[R] currently doesn\[aq]t show them). +(\f[CR]-- --help\f[R] currently doesn\[aq]t show them). .PP .SH PART 5: COMMON TASKS -.PP Here are some quick examples of how to do some basic tasks with hledger. .SS Getting help -.PP Here\[aq]s how to list commands and view options and command docs: .IP -.nf -\f[C] +.EX $ hledger # show available commands $ hledger --help # show common options $ hledger CMD --help # show CMD\[aq]s options, common options and CMD\[aq]s documentation -\f[R] -.fi +.EE .PP You can also view your hledger version\[aq]s manual in several formats by using the help command. Eg: .IP -.nf -\f[C] +.EX $ 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 # find out more about the help command -\f[R] -.fi +.EE .PP To view manuals and introductory docs on the web, visit https://hledger.org. Chat and mail list support and discussion archives can be found at https://hledger.org/support. .SS Constructing command lines -.PP hledger has a flexible command line interface. We strive to keep it simple and ergonomic, but if you run into one of the sharp edges described in OPTIONS, here are some tips that might help: .IP \[bu] 2 command-specific options must go after the command (it\[aq]s fine to put -common options there too: \f[V]hledger CMD OPTS ARGS\f[R]) +common options there too: \f[CR]hledger CMD OPTS ARGS\f[R]) .IP \[bu] 2 running add-on executables directly simplifies command line parsing -(\f[V]hledger-ui OPTS ARGS\f[R]) +(\f[CR]hledger-ui OPTS ARGS\f[R]) .IP \[bu] 2 enclose \[dq]problematic\[dq] args in single quotes .IP \[bu] 2 @@ -11564,29 +10703,25 @@ if needed, also add a backslash to hide regular expression metacharacters from the shell .IP \[bu] 2 to see how a misbehaving command line is being parsed, add -\f[V]--debug=2\f[R]. +\f[CR]--debug=2\f[R]. .SS Starting a journal file -.PP hledger looks for your accounting data in a journal file, -\f[V]$HOME/.hledger.journal\f[R] by default: +\f[CR]$HOME/.hledger.journal\f[R] by default: .IP -.nf -\f[C] +.EX $ hledger stats The hledger journal file \[dq]/Users/simon/.hledger.journal\[dq] was not found. Please create it first, eg with \[dq]hledger add\[dq] or a text editor. Or, specify an existing journal file with -f or LEDGER_FILE. -\f[R] -.fi +.EE .PP -You can override this by setting the \f[V]LEDGER_FILE\f[R] environment +You can override this by setting the \f[CR]LEDGER_FILE\f[R] environment variable (see below). It\[aq]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 this: .IP -.nf -\f[C] +.EX $ mkdir \[ti]/finance $ cd \[ti]/finance $ git init @@ -11606,54 +10741,45 @@ Payees/descriptions : 0 Accounts : 0 (depth 0) Commodities : 0 () Market prices : 0 () -\f[R] -.fi +.EE .SS Setting LEDGER_FILE -.PP -How to set \f[V]LEDGER_FILE\f[R] permanently depends on your setup: +How to set \f[CR]LEDGER_FILE\f[R] permanently depends on your setup: .PP On unix and mac, running these commands in the terminal will work for many people; adapt as needed: .IP -.nf -\f[C] +.EX $ echo \[aq]export LEDGER_FILE=\[ti]/finance/2023.journal\[aq] >> \[ti]/.profile $ source \[ti]/.profile -\f[R] -.fi +.EE .PP When correctly configured, in a new terminal window -\f[V]env | grep LEDGER_FILE\f[R] will show your file, and so will -\f[V]hledger files\f[R]. +\f[CR]env | grep LEDGER_FILE\f[R] will show your file, and so will +\f[CR]hledger files\f[R]. .PP On mac, this additional step might be helpful for GUI applications (like Emacs started from the dock): add an entry to -\f[V]\[ti]/.MacOSX/environment.plist\f[R] like +\f[CR]\[ti]/.MacOSX/environment.plist\f[R] like .IP -.nf -\f[C] +.EX { \[dq]LEDGER_FILE\[dq] : \[dq]\[ti]/finance/2023.journal\[dq] } -\f[R] -.fi +.EE .PP -and then run \f[V]killall Dock\f[R] in a terminal window (or restart the -machine). +and then run \f[CR]killall Dock\f[R] in a terminal window (or restart +the machine). .PP On Windows, see https://www.java.com/en/download/help/path.html, or try running these commands in a powershell window (let us know if it persists across a reboot, and if you need to be an Administrator): .IP -.nf -\f[C] +.EX > CD > MKDIR finance > SETX LEDGER_FILE \[dq]C:\[rs]Users\[rs]USERNAME\[rs]finance\[rs]2023.journal\[dq] -\f[R] -.fi +.EE .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..). @@ -11672,16 +10798,14 @@ The first way: open the journal in any text editor and save an entry like this: .RS 2 .IP -.nf -\f[C] +.EX 2023-01-01 * opening balances assets:bank:checking $1000 = $1000 assets:bank:savings $2000 = $2000 assets:cash $100 = $100 liabilities:creditcard $-50 = $-50 equity:opening/closing balances -\f[R] -.fi +.EE .PP These are start-of-day balances, ie whatever was in the account at the end of the previous day. @@ -11696,12 +10820,11 @@ The = amounts are optional balance assertions, providing extra error checking. .RE .IP \[bu] 2 -The second way: run \f[V]hledger add\f[R] and follow the prompts to +The second way: run \f[CR]hledger add\f[R] and follow the prompts to record a similar transaction: .RS 2 .IP -.nf -\f[C] +.EX $ hledger add Adding transactions to journal file /Users/simon/finance/2023.journal Any command line arguments will be used as defaults. @@ -11735,21 +10858,17 @@ Save this transaction to the journal ? [y]: Saved. Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2023-01-01]: . -\f[R] -.fi +.EE .RE .PP If you\[aq]re using version control, this could be a good time to commit the journal. Eg: .IP -.nf -\f[C] +.EX $ git commit -m \[aq]initial balances\[aq] 2023.journal -\f[R] -.fi +.EE .SS Recording transactions -.PP 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 @@ -11758,8 +10877,7 @@ convert CSV data downloaded from your bank. Here are some simple transactions, see the hledger_journal(5) manual and hledger.org for more ideas: .IP -.nf -\f[C] +.EX 2023/1/10 * gift received assets:cash $20 income:gifts @@ -11771,10 +10889,8 @@ hledger.org for more ideas: 2023-01-15 paycheck income:salary assets:bank:checking $1000 -\f[R] -.fi +.EE .SS Reconciling -.PP Periodically you should reconcile - compare your hledger-reported balances against external sources of truth, like bank statements or your bank\[aq]s website - to be sure that your ledger accurately represents @@ -11789,33 +10905,31 @@ A typical workflow: .IP "1." 3 Reconcile cash. Count what\[aq]s in your wallet. -Compare with what hledger reports (\f[V]hledger bal cash\f[R]). +Compare with what hledger reports (\f[CR]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[V]hledger reg cash\f[R]). +A register report can be helpful (\f[CR]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: .RS 4 .IP -.nf -\f[C] +.EX 2023-01-16 * adjust cash assets:cash $-2 = $105 expenses:misc -\f[R] -.fi +.EE .RE .IP "2." 3 Reconcile checking. Log in to your bank\[aq]s website. Compare today\[aq]s (cleared) balance with hledger\[aq]s cleared balance -(\f[V]hledger bal checking -C\f[R]). +(\f[CR]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[V]hledger reg checking -C\f[R]. +\f[CR]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 @@ -11823,30 +10937,26 @@ 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[V]hledger-ui --watch --register checking -C\f[R] +\f[CR]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[V]*\f[R] marker. -Eg in the paycheck transaction above, insert \f[V]*\f[R] between -\f[V]2023-01-15\f[R] and \f[V]paycheck\f[R] +to track that, by adding the \f[CR]*\f[R] marker. +Eg in the paycheck transaction above, insert \f[CR]*\f[R] between +\f[CR]2023-01-15\f[R] and \f[CR]paycheck\f[R] .PP If you\[aq]re using version control, this can be another good time to commit: .IP -.nf -\f[C] +.EX $ git commit -m \[aq]txns\[aq] 2023.journal -\f[R] -.fi +.EE .SS Reporting -.PP Here are some basic reports. .PP Show all transactions: .IP -.nf -\f[C] +.EX $ hledger print 2023-01-01 * opening balances assets:bank:checking $1000 @@ -11870,13 +10980,11 @@ $ hledger print 2023-01-16 * adjust cash assets:cash $-2 = $105 expenses:misc -\f[R] -.fi +.EE .PP Show account names, and their hierarchy: .IP -.nf -\f[C] +.EX $ hledger accounts --tree assets bank @@ -11893,13 +11001,11 @@ income salary liabilities creditcard -\f[R] -.fi +.EE .PP Show all account totals: .IP -.nf -\f[C] +.EX $ hledger balance $4105 assets $4000 bank @@ -11916,28 +11022,24 @@ $ hledger balance $-50 liabilities:creditcard -------------------- 0 -\f[R] -.fi +.EE .PP Show only asset and liability balances, as a flat list, limited to depth 2: .IP -.nf -\f[C] +.EX $ hledger bal assets liabilities -2 $4000 assets:bank $105 assets:cash $-50 liabilities:creditcard -------------------- $4055 -\f[R] -.fi +.EE .PP Show the same thing without negative numbers, formatted as a simple balance sheet: .IP -.nf -\f[C] +.EX $ hledger bs -2 Balance Sheet 2023-01-16 @@ -11957,16 +11059,14 @@ Balance Sheet 2023-01-16 || $50 ========================++============ Net: || $4055 -\f[R] -.fi +.EE .PP The final total is your \[dq]net worth\[dq] on the end date. -(Or use \f[V]bse\f[R] for a full balance sheet with equity.) +(Or use \f[CR]bse\f[R] for a full balance sheet with equity.) .PP Show income and expense totals, formatted as an income statement: .IP -.nf -\f[C] +.EX hledger is Income Statement 2023-01-01-2023-01-16 @@ -11987,51 +11087,44 @@ Income Statement 2023-01-01-2023-01-16 || $15 ===============++======================= Net: || $1005 -\f[R] -.fi +.EE .PP The final total is your net income during this period. .PP Show transactions affecting your wallet, with running total: .IP -.nf -\f[C] +.EX $ hledger register cash 2023-01-01 opening balances assets:cash $100 $100 2023-01-10 gift received assets:cash $20 $120 2023-01-12 farmers market assets:cash $-13 $107 2023-01-16 adjust cash assets:cash $-2 $105 -\f[R] -.fi +.EE .PP Show weekly posting counts as a bar chart: .IP -.nf -\f[C] +.EX $ hledger activity -W 2019-12-30 ***** 2023-01-06 **** 2023-01-13 **** -\f[R] -.fi +.EE .SS Migrating to a new file -.PP At the end of the year, you may want to continue your journal in a new 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[V]git add\f[R] the new +If using version control, don\[aq]t forget to \f[CR]git add\f[R] the new file. .SH BUGS -.PP We welcome bug reports in the hledger issue tracker (shortcut: http://bugs.hledger.org), or on the #hledger chat or hledger mail list (https://hledger.org/support). .PP Some known issues and limitations: .PP -The need to precede add-on command options with \f[V]--\f[R] when +The need to precede add-on command options with \f[CR]--\f[R] when invoked from hledger is awkward. (See Command options, Constructing command lines.) .PP @@ -12042,12 +11135,11 @@ data. On Microsoft Windows, depending whether you are running in a CMD window or a Cygwin/MSYS/Mintty window and how you installed hledger, non-ascii characters and colours may not be supported, and the tab key may not be -supported by \f[V]hledger add\f[R]. +supported by \f[CR]hledger add\f[R]. (Running in a WSL window should resolve these.) .PP When processing large data files, hledger uses more memory than Ledger. .SS Troubleshooting -.PP Here are some common issues you might encounter when you run hledger, and how to resolve them (and remember also you can usually get quick Support): @@ -12059,8 +11151,9 @@ found\[dq]\f[R] .PD Depending how you installed hledger, the executables may not be in your shell\[aq]s PATH. -Eg on unix systems, stack installs hledger in \f[V]\[ti]/.local/bin\f[R] -and cabal installs it in \f[V]\[ti]/.cabal/bin\f[R]. +Eg on unix systems, stack installs hledger in +\f[CR]\[ti]/.local/bin\f[R] and cabal installs it in +\f[CR]\[ti]/.cabal/bin\f[R]. You may need to add one of these directories to your shell\[aq]s PATH, and/or open a new terminal window. .PP @@ -12070,10 +11163,11 @@ using it\f[R] .P .PD .IP \[bu] 2 -\f[V]LEDGER_FILE\f[R] should be a real environment variable, not just a +\f[CR]LEDGER_FILE\f[R] should be a real environment variable, not just a shell variable. -Eg on unix, the command \f[V]env | grep LEDGER_FILE\f[R] should show it. -You may need to use \f[V]export\f[R] (see +Eg on unix, the command \f[CR]env | grep LEDGER_FILE\f[R] should show +it. +You may need to use \f[CR]export\f[R] (see https://stackoverflow.com/a/7411509). .IP \[bu] 2 You may need to force your shell to see the new configuration. @@ -12092,32 +11186,29 @@ encounter non-ascii characters. To fix it, set the LANG environment variable to a locale which supports UTF-8 and which is installed on your system. .PP -On unix, \f[V]locale -a\f[R] lists the installed locales. -Look for one which mentions \f[V]utf8\f[R], \f[V]UTF-8\f[R] or similar. -Some examples: \f[V]C.UTF-8\f[R], \f[V]en_US.utf-8\f[R], -\f[V]fr_FR.utf8\f[R]. +On unix, \f[CR]locale -a\f[R] lists the installed locales. +Look for one which mentions \f[CR]utf8\f[R], \f[CR]UTF-8\f[R] or +similar. +Some examples: \f[CR]C.UTF-8\f[R], \f[CR]en_US.utf-8\f[R], +\f[CR]fr_FR.utf8\f[R]. If necessary, use your system package manager to install one. -Then select it by setting the \f[V]LANG\f[R] environment variable. +Then select it by setting the \f[CR]LANG\f[R] environment variable. Note, exact spelling and capitalisation of the locale name may be important: Here\[aq]s one common way to configure this permanently for your shell: .IP -.nf -\f[C] +.EX $ echo \[dq]export LANG=en_US.utf8\[dq] >>\[ti]/.profile # close and re-open terminal window -\f[R] -.fi +.EE .PP If you are using Nix (not NixOS) for GHC and Hledger, you might need to -set the \f[V]LOCALE_ARCHIVE\f[R] variable: +set the \f[CR]LOCALE_ARCHIVE\f[R] variable: .IP -.nf -\f[C] +.EX $ echo \[dq]export LOCALE_ARCHIVE=${glibcLocales}/lib/locale/locale-archive\[dq] >>\[ti]/.profile # close and re-open terminal window -\f[R] -.fi +.EE .PP \f[B]COMPATIBILITY ISSUES: hledger gives an error with my Ledger file\f[R] diff --git a/hledger/hledger.info b/hledger/hledger.info index 7a010c7f4..1668e39c9 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -5138,24 +5138,18 @@ File: hledger.info, Node: Timedot, Next: PART 3 REPORTING CONCEPTS, Prev: Tim ********** 'timedot' format is hledger's human-friendly time logging format. -Compared to 'timeclock' format, it is - - * convenient for quick, approximate, and retroactive time logging - * readable: you can see at a glance where time was spent. - - A timedot file contains a series of day entries, which might look -like this: +Compared to 'timeclock' format, it is more convenient for quick, +approximate, and retroactive time logging, and more human-readable (you +can see at a glance where time was spent). A quick example: 2023-05-01 -hom:errands .... .... ; two hours +hom:errands .... .... ; two hours; the space is ignored fos:hledger:timedot .. ; half an hour -per:admin:finance +per:admin:finance ; no time spent yet hledger reads this as a transaction on this day with three (unbalanced) postings, where each dot represents "0.25". No commodity -is assumed, but normally we interpret it as hours, with each dot -representing a quarter-hour. It's convenient, though not required, to -group the dots in fours for easy reading. +symbol is assumed, but we typically interpret it as hours. $ hledger -f a.timedot print # .timedot file extension (or timedot: prefix) is required 2023-05-01 * @@ -5163,55 +5157,75 @@ $ hledger -f a.timedot print # .timedot file extension (or timedot: prefix) is (fos:hledger:timedot) 0.50 ; half an hour (per:admin:finance) 0 - A transaction begins with a non-indented *simple date* (Y-M-D, Y/M/D, -or Y.M.D). It can optionally be preceded by one or more stars and a -space, for Emacs org mode compatibility. It can optionally be followed -on the same line by a transaction description, and/or a transaction -comment following a semicolon. + A timedot file contains a series of transactions (usually one per +day). Each begins with a *simple date* (Y-M-D, Y/M/D, or Y.M.D), +optionally be followed on the same line by a transaction description, +and/or a transaction comment following a semicolon. After the date line are zero or more time postings, consisting of: - * an *account name* - any hledger-style account name, optionally - hierarchical, optionally indented. - * *two or more spaces* - a field separator, required if there is an - amount (as in journal format). - * an optional *timedot amount* - dots representing quarter hours, or - a number representing hours, optionally with a unit suffix. - * an optional *posting comment* following a semicolon. + * *An account name* - any hledger-style account name, optionally + indented. - Timedot amounts can be: + * *Two or more spaces* - required if there is an amount (as in + journal format). - * *dots*: zero or more period characters ('.'), each representing - 0.25. Spaces are ignored and can be used for grouping. Eg: '.... - ..' + * *A timedot amount*, which can be - * or a *number*. Eg: '1.5' + * empty (representing zero) - * or a *number immediately followed by a unit symbol* 's', 'm', 'h', - 'd', 'w', 'mo', or 'y'. These are interpreted as seconds, minutes, - hours, days weeks, months or years, and converted to hours, - assuming: - '60s' = '1m', '60m' = '1h', '24h' = '1d', '7d' = '1w', '30d' = - '1mo', '365d' = '1y'. Eg '90m' is parsed as '1.5'. + * a number, optionally followed by a unit 's', 'm', 'h', 'd', + 'w', 'mo', or 'y', representing a precise number of seconds, + minutes, hours, days weeks, months or years (hours is assumed + by default), which will be converted to hours according to 60s + = 1m, 60m = 1h, 24h = 1d, 7d = 1w, 30d = 1mo, 365d = 1y. - There is some added flexibility to help with keeping time log data in -the same file as your notes, todo lists, etc.: + * one or more dots (period characters), each representing 0.25. + These are the dots in "timedot". Spaces are ignored and can + be used for grouping/alignment. + + * one or more letters. These are like dots but they also + generate a tag 't:' (short for "type") with the letter as its + value, and a separate posting for each of the values. This + provides a second dimension of categorisation, viewable in + reports with '--pivot t'. + + * *An optional comment* following a semicolon (a hledger-style + posting comment). + + There is some flexibility to help with keeping time log data and +notes in the same file: * Blank lines and lines beginning with '#' or ';' are ignored. - * Before the first date line, lines beginning with '*' are ignored. + * After the first date line, lines which do not contain a double + space are parsed as postings with zero amount. (hledger's register + reports will show these if you add -E). - * From the first date line onward, one or more '*''s followed by a - space at beginning of lines (ie, the headline prefix used by Emacs - Org mode) is ignored. This means the time log can be kept under an - Org headline, and date lines or time transaction lines can be Org - headlines. + * Before the first date line, lines beginning with '*' (eg org + headings) are ignored. And from the first date line onward, Emacs + org mode heading prefixes at the start of lines (one or more '*''s + followed by a space) will be ignored. This means the time log can + also be a org outline. - * Lines not ending with a double-space and amount are parsed as - postings with zero amount. Note hledger's register reports hide - these by default (add -E to see them). +* Menu: - More examples: +* Timedot examples:: + + +File: hledger.info, Node: Timedot examples, Up: Timedot + +12.1 Timedot examples +===================== + +Numbers: + +2016/2/3 +inc:client1 4 +fos:hledger 3h +biz:research 60m + + Dots: # on this day, 6h was spent on client work, 1.5h on haskell FOSS work, etc. 2016/2/1 @@ -5223,34 +5237,6 @@ biz:research . inc:client1 .... .... biz:research . -2016/2/3 -inc:client1 4 -fos:hledger 3 -biz:research 1 - -* Time log -** 2023-01-01 -*** adm:time . -*** adm:finance . - -* 2023 Work Diary -** Q1 -*** 2023-02-29 -**** DONE -0700 yoga -**** UNPLANNED -**** BEGUN -hom:chores - cleaning ... - water plants - outdoor - one full watering can - indoor - light watering -**** TODO -adm:planning: trip -*** LATER - - Reporting: - $ hledger -f a.timedot print date:2016/2/2 2016-02-02 * (inc:client1) 2.00 @@ -5273,21 +5259,66 @@ Balance changes in 2016-02-01-2016-02-03: ------------++---------------------------------------- || 7.75 2.25 8.00 - Using period instead of colon as account name separator: + Letters: + +# Activity types: +# c cleanup/catchup/repair +# e enhancement +# s support +# l learning/research + +2023-11-01 +work:adm ccecces + +$ hledger -f a.timedot print +2023-11-01 + (work:adm) 1 ; t:c + (work:adm) 0.5 ; t:e + (work:adm) 0.25 ; t:s + +$ hledger -f a.timedot bal + 1.75 work:adm +-------------------- + 1.75 + +$ hledger -f a.timedot bal --pivot t + 1.00 c + 0.50 e + 0.25 s +-------------------- + 1.75 + + Org: + +* 2023 Work Diary +** Q1 +*** 2023-02-29 +**** DONE +0700 yoga +**** UNPLANNED +**** BEGUN +hom:chores + cleaning ... + water plants + outdoor - one full watering can + indoor - light watering +**** TODO +adm:planning: trip +*** LATER + + Using '.' as account name separator: 2016/2/4 -fos.hledger.timedot 4 +fos.hledger.timedot 4h fos.ledger .. -$ hledger -f a.timedot --alias /\\./=: bal --tree +$ hledger -f a.timedot --alias '/\./=:' bal -t 4.50 fos 4.00 hledger:timedot 0.50 ledger -------------------- 4.50 - A sample.timedot file. -  File: hledger.info, Node: PART 3 REPORTING CONCEPTS, Next: Amount formatting parseability, Prev: Timedot, Up: Top @@ -5301,9 +5332,33 @@ File: hledger.info, Node: Amount formatting parseability, Next: Time periods, ********************************** If you're wondering why your 'print' report sometimes shows trailing -decimal marks, even when there are no decimal digits; it does this to -disambiguate ambiguous amounts (amounts which have one digit group mark -and no decimal digits), allowing them to be re-parsed reliably. +decimal marks, with no decimal digits; it does this when showing amounts +that have digit group marks but no decimal digits, to disambiguate them +and allow them to be re-parsed reliably (see also Decimal marks, digit +group marks. Eg: + +commodity $1,000.00 + +2023-01-02 + (a) $1000 + +$ hledger print +2023-01-02 + (a) $1,000. + + If this is a problem (eg when exporting to Ledger), you can avoid it +by disabling digit group marks, eg with -c/-commodity (for each affected +commodity): + +$ hledger print -c '$1000.00' +2023-01-02 + (a) $1000 + + or by forcing print to always show decimal digits, with -round: + +$ hledger print -c '$1,000.00' --round=soft +2023-01-02 + (a) $1,000.00 More generally: hledger output falls into three rough categories, which format amounts a little bit differently to suit different @@ -9614,20 +9669,31 @@ options The output formats supported are 'txt', 'beancount', 'csv', 'tsv', 'json' and 'sql'. _Experimental:_ The 'beancount' format tries to produce -Beancount-compatible output. It is very basic and may require -additional manual fixups: +Beancount-compatible output, as follows: * Transaction and postings with unmarked status are converted to - cleared ('*") status. - * Transactions' payee and or note are wrapped in double quotes. + cleared ('*') status. + * Transactions' payee and note are backslash-escaped and + double-quote-escaped and wrapped in double quotes. * Transaction tags are copied to Beancount #tag format. - * Account name parts are capitalised, and if the first account name - part is not one of Assets, Liabilities, Equity, Income, or - Expenses, "Equity:" is prepended. - * The '$' commodity symbol is converted to 'USD'. + * Commodity symbols are converted to upper case, and a small number + of currency symbols like '$' are converted to the corresponding + currency names. + * Account name parts are capitalised and unsupported characters are + replaced with '-'. If an account name part does not begin with a + letter, or if the first part is not Assets, Liabilities, Equity, + Income, or Expenses, an error is raised. (Use '--alias' options to + bring your accounts into compliance.) * An 'open' directive is generated for each account used, on the earliest transaction date. + Some limitations: + + * Balance assertions are removed. + * Balance assignments become missing amounts. + * Virtual and balanced virtual postings become regular postings. + * Directives are not converted. + Here's an example of print's CSV output: $ hledger print -Ocsv @@ -11140,306 +11206,308 @@ Node: Timeclock182398 Ref: #timeclock182503 Node: Timedot184681 Ref: #timedot184804 -Node: PART 3 REPORTING CONCEPTS189673 -Ref: #part-3-reporting-concepts189855 -Node: Amount formatting parseability189855 -Ref: #amount-formatting-parseability190052 -Node: Time periods191756 -Ref: #time-periods191895 -Node: Report start & end date192013 -Ref: #report-start-end-date192165 -Node: Smart dates193824 -Ref: #smart-dates193977 -Node: Report intervals195845 -Ref: #report-intervals196000 -Node: Date adjustment196418 -Ref: #date-adjustment196578 -Node: Period expressions197429 -Ref: #period-expressions197570 -Node: Period expressions with a report interval199334 -Ref: #period-expressions-with-a-report-interval199568 -Node: More complex report intervals199782 -Ref: #more-complex-report-intervals200027 -Node: Multiple weekday intervals201828 -Ref: #multiple-weekday-intervals202017 -Node: Depth202839 -Ref: #depth202941 -Node: Queries203237 -Ref: #queries203339 -Node: Query types204464 -Ref: #query-types204585 -Node: Combining query terms207921 -Ref: #combining-query-terms208098 -Node: Queries and command options209366 -Ref: #queries-and-command-options209565 -Node: Queries and valuation209814 -Ref: #queries-and-valuation210009 -Node: Querying with account aliases210238 -Ref: #querying-with-account-aliases210449 -Node: Querying with cost or value210579 -Ref: #querying-with-cost-or-value210756 -Node: Pivoting211057 -Ref: #pivoting211171 -Node: Generating data212948 -Ref: #generating-data213080 -Node: Forecasting214663 -Ref: #forecasting214788 -Node: --forecast215319 -Ref: #forecast215450 -Node: Inspecting forecast transactions216496 -Ref: #inspecting-forecast-transactions216698 -Node: Forecast reports217828 -Ref: #forecast-reports218001 -Node: Forecast tags218937 -Ref: #forecast-tags219097 -Node: Forecast period in detail219557 -Ref: #forecast-period-in-detail219751 -Node: Forecast troubleshooting220645 -Ref: #forecast-troubleshooting220813 -Node: Budgeting221716 -Ref: #budgeting221836 -Node: Cost reporting222273 -Ref: #cost-reporting222407 -Node: Recording costs223068 -Ref: #recording-costs223204 -Node: Reporting at cost224795 -Ref: #reporting-at-cost224970 -Node: Equity conversion postings225560 -Ref: #equity-conversion-postings225774 -Node: Inferring equity conversion postings228205 -Ref: #inferring-equity-conversion-postings228468 -Node: Combining costs and equity conversion postings229220 -Ref: #combining-costs-and-equity-conversion-postings229530 -Node: Requirements for detecting equity conversion postings230518 -Ref: #requirements-for-detecting-equity-conversion-postings230840 -Node: Infer cost and equity by default ?232040 -Ref: #infer-cost-and-equity-by-default232269 -Node: Value reporting232477 -Ref: #value-reporting232619 -Node: -V Value233393 -Ref: #v-value233525 -Node: -X Value in specified commodity233720 -Ref: #x-value-in-specified-commodity233921 -Node: Valuation date234070 -Ref: #valuation-date234247 -Node: Finding market price235030 -Ref: #finding-market-price235241 -Node: --infer-market-prices market prices from transactions236410 -Ref: #infer-market-prices-market-prices-from-transactions236692 -Node: Valuation commodity239454 -Ref: #valuation-commodity239673 -Node: Simple valuation examples240886 -Ref: #simple-valuation-examples241090 -Node: --value Flexible valuation241749 -Ref: #value-flexible-valuation241959 -Node: More valuation examples243603 -Ref: #more-valuation-examples243818 -Node: Interaction of valuation and queries245088 -Ref: #interaction-of-valuation-and-queries245335 -Node: Effect of valuation on reports245807 -Ref: #effect-of-valuation-on-reports246010 -Node: PART 4 COMMANDS253707 -Ref: #part-4-commands253856 -Node: Commands overview254235 -Ref: #commands-overview254369 -Node: DATA ENTRY254548 -Ref: #data-entry254672 -Node: DATA CREATION254871 -Ref: #data-creation255025 -Node: DATA MANAGEMENT255143 -Ref: #data-management255308 -Node: REPORTS FINANCIAL255429 -Ref: #reports-financial255604 -Node: REPORTS VERSATILE255909 -Ref: #reports-versatile256082 -Node: REPORTS BASIC256335 -Ref: #reports-basic256487 -Node: HELP256996 -Ref: #help257118 -Node: ADD-ONS257228 -Ref: #add-ons257334 -Node: accounts257913 -Ref: #accounts258046 -Node: activity259933 -Ref: #activity260052 -Node: add260426 -Ref: #add260536 -Node: aregister263347 -Ref: #aregister263468 -Node: aregister and posting dates266356 -Ref: #aregister-and-posting-dates266501 -Node: balance267257 -Ref: #balance267383 -Node: balance features268368 -Ref: #balance-features268508 -Node: Simple balance report270474 -Ref: #simple-balance-report270659 -Node: Balance report line format272284 -Ref: #balance-report-line-format272486 -Node: Filtered balance report274644 -Ref: #filtered-balance-report274836 -Node: List or tree mode275163 -Ref: #list-or-tree-mode275331 -Node: Depth limiting276676 -Ref: #depth-limiting276842 -Node: Dropping top-level accounts277443 -Ref: #dropping-top-level-accounts277643 -Node: Showing declared accounts277953 -Ref: #showing-declared-accounts278152 -Node: Sorting by amount278683 -Ref: #sorting-by-amount278850 -Node: Percentages279520 -Ref: #percentages279679 -Node: Multi-period balance report280227 -Ref: #multi-period-balance-report280427 -Node: Balance change end balance282702 -Ref: #balance-change-end-balance282911 -Node: Balance report types284339 -Ref: #balance-report-types284520 -Node: Calculation type285018 -Ref: #calculation-type285173 -Node: Accumulation type285722 -Ref: #accumulation-type285902 -Node: Valuation type286804 -Ref: #valuation-type286992 -Node: Combining balance report types287993 -Ref: #combining-balance-report-types288187 -Node: Budget report290025 -Ref: #budget-report290187 -Node: Budget report start date295841 -Ref: #budget-report-start-date296019 -Node: Budgets and subaccounts297351 -Ref: #budgets-and-subaccounts297558 -Node: Selecting budget goals300998 -Ref: #selecting-budget-goals301197 -Node: Budget vs forecast302232 -Ref: #budget-vs-forecast302391 -Node: Balance report layout304021 -Ref: #balance-report-layout304201 -Node: Useful balance reports312386 -Ref: #useful-balance-reports312546 -Node: balancesheet313631 -Ref: #balancesheet313776 -Node: balancesheetequity315103 -Ref: #balancesheetequity315261 -Node: cashflow316657 -Ref: #cashflow316788 -Node: check318223 -Ref: #check318337 -Node: Default checks319141 -Ref: #default-checks319267 -Node: Strict checks319764 -Ref: #strict-checks319909 -Node: Other checks320389 -Ref: #other-checks320531 -Node: Custom checks321064 -Ref: #custom-checks321221 -Node: More about specific checks321638 -Ref: #more-about-specific-checks321800 -Node: close322506 -Ref: #close322617 -Node: close and balance assertions326082 -Ref: #close-and-balance-assertions326260 -Node: Example retain earnings327411 -Ref: #example-retain-earnings327628 -Node: Example migrate balances to a new file328060 -Ref: #example-migrate-balances-to-a-new-file328325 -Node: Example excluding closing/opening transactions328901 -Ref: #example-excluding-closingopening-transactions329150 -Node: codes330368 -Ref: #codes330485 -Node: commodities331349 -Ref: #commodities331477 -Node: demo331547 -Ref: #demo331668 -Node: descriptions332584 -Ref: #descriptions332714 -Node: diff333005 -Ref: #diff333120 -Node: files334162 -Ref: #files334271 -Node: help334412 -Ref: #help-1334521 -Node: import335894 -Ref: #import336017 -Node: Deduplication337125 -Ref: #deduplication337250 -Node: Import testing339269 -Ref: #import-testing339434 -Node: Importing balance assignments340277 -Ref: #importing-balance-assignments340483 -Node: Commodity display styles341132 -Ref: #commodity-display-styles341305 -Node: incomestatement341434 -Ref: #incomestatement341576 -Node: notes342904 -Ref: #notes343026 -Node: payees343388 -Ref: #payees343503 -Node: prices344022 -Ref: #prices344137 -Node: print344790 -Ref: #print344905 -Node: print explicitness345881 -Ref: #print-explicitness346024 -Node: print amount style346803 -Ref: #print-amount-style346973 -Node: print parseability348025 -Ref: #print-parseability348197 -Node: print other features348946 -Ref: #print-other-features349125 -Node: print output format349646 -Ref: #print-output-format349794 -Node: register352438 -Ref: #register352560 -Node: Custom register output357591 -Ref: #custom-register-output357722 -Node: rewrite359066 -Ref: #rewrite359184 -Node: Re-write rules in a file361082 -Ref: #re-write-rules-in-a-file361245 -Node: Diff output format362394 -Ref: #diff-output-format362577 -Node: rewrite vs print --auto363669 -Ref: #rewrite-vs.-print---auto363829 -Node: roi364385 -Ref: #roi364492 -Node: Spaces and special characters in --inv and --pnl366304 -Ref: #spaces-and-special-characters-in---inv-and---pnl366544 -Node: Semantics of --inv and --pnl367032 -Ref: #semantics-of---inv-and---pnl367271 -Node: IRR and TWR explained369121 -Ref: #irr-and-twr-explained369281 -Node: stats372534 -Ref: #stats372642 -Node: tags374029 -Ref: #tags-1374136 -Node: test375145 -Ref: #test375238 -Node: PART 5 COMMON TASKS375980 -Ref: #part-5-common-tasks376126 -Node: Getting help376424 -Ref: #getting-help376565 -Node: Constructing command lines377325 -Ref: #constructing-command-lines377526 -Node: Starting a journal file378183 -Ref: #starting-a-journal-file378385 -Node: Setting LEDGER_FILE379587 -Ref: #setting-ledger_file379779 -Node: Setting opening balances380736 -Ref: #setting-opening-balances380937 -Node: Recording transactions384078 -Ref: #recording-transactions384267 -Node: Reconciling384823 -Ref: #reconciling384975 -Node: Reporting387232 -Ref: #reporting387381 -Node: Migrating to a new file391366 -Ref: #migrating-to-a-new-file391523 -Node: BUGS391822 -Ref: #bugs391912 -Node: Troubleshooting392791 -Ref: #troubleshooting392891 +Node: Timedot examples187909 +Ref: #timedot-examples188015 +Node: PART 3 REPORTING CONCEPTS190186 +Ref: #part-3-reporting-concepts190368 +Node: Amount formatting parseability190368 +Ref: #amount-formatting-parseability190565 +Node: Time periods192770 +Ref: #time-periods192909 +Node: Report start & end date193027 +Ref: #report-start-end-date193179 +Node: Smart dates194838 +Ref: #smart-dates194991 +Node: Report intervals196859 +Ref: #report-intervals197014 +Node: Date adjustment197432 +Ref: #date-adjustment197592 +Node: Period expressions198443 +Ref: #period-expressions198584 +Node: Period expressions with a report interval200348 +Ref: #period-expressions-with-a-report-interval200582 +Node: More complex report intervals200796 +Ref: #more-complex-report-intervals201041 +Node: Multiple weekday intervals202842 +Ref: #multiple-weekday-intervals203031 +Node: Depth203853 +Ref: #depth203955 +Node: Queries204251 +Ref: #queries204353 +Node: Query types205478 +Ref: #query-types205599 +Node: Combining query terms208935 +Ref: #combining-query-terms209112 +Node: Queries and command options210380 +Ref: #queries-and-command-options210579 +Node: Queries and valuation210828 +Ref: #queries-and-valuation211023 +Node: Querying with account aliases211252 +Ref: #querying-with-account-aliases211463 +Node: Querying with cost or value211593 +Ref: #querying-with-cost-or-value211770 +Node: Pivoting212071 +Ref: #pivoting212185 +Node: Generating data213962 +Ref: #generating-data214094 +Node: Forecasting215677 +Ref: #forecasting215802 +Node: --forecast216333 +Ref: #forecast216464 +Node: Inspecting forecast transactions217510 +Ref: #inspecting-forecast-transactions217712 +Node: Forecast reports218842 +Ref: #forecast-reports219015 +Node: Forecast tags219951 +Ref: #forecast-tags220111 +Node: Forecast period in detail220571 +Ref: #forecast-period-in-detail220765 +Node: Forecast troubleshooting221659 +Ref: #forecast-troubleshooting221827 +Node: Budgeting222730 +Ref: #budgeting222850 +Node: Cost reporting223287 +Ref: #cost-reporting223421 +Node: Recording costs224082 +Ref: #recording-costs224218 +Node: Reporting at cost225809 +Ref: #reporting-at-cost225984 +Node: Equity conversion postings226574 +Ref: #equity-conversion-postings226788 +Node: Inferring equity conversion postings229219 +Ref: #inferring-equity-conversion-postings229482 +Node: Combining costs and equity conversion postings230234 +Ref: #combining-costs-and-equity-conversion-postings230544 +Node: Requirements for detecting equity conversion postings231532 +Ref: #requirements-for-detecting-equity-conversion-postings231854 +Node: Infer cost and equity by default ?233054 +Ref: #infer-cost-and-equity-by-default233283 +Node: Value reporting233491 +Ref: #value-reporting233633 +Node: -V Value234407 +Ref: #v-value234539 +Node: -X Value in specified commodity234734 +Ref: #x-value-in-specified-commodity234935 +Node: Valuation date235084 +Ref: #valuation-date235261 +Node: Finding market price236044 +Ref: #finding-market-price236255 +Node: --infer-market-prices market prices from transactions237424 +Ref: #infer-market-prices-market-prices-from-transactions237706 +Node: Valuation commodity240468 +Ref: #valuation-commodity240687 +Node: Simple valuation examples241900 +Ref: #simple-valuation-examples242104 +Node: --value Flexible valuation242763 +Ref: #value-flexible-valuation242973 +Node: More valuation examples244617 +Ref: #more-valuation-examples244832 +Node: Interaction of valuation and queries246102 +Ref: #interaction-of-valuation-and-queries246349 +Node: Effect of valuation on reports246821 +Ref: #effect-of-valuation-on-reports247024 +Node: PART 4 COMMANDS254721 +Ref: #part-4-commands254870 +Node: Commands overview255249 +Ref: #commands-overview255383 +Node: DATA ENTRY255562 +Ref: #data-entry255686 +Node: DATA CREATION255885 +Ref: #data-creation256039 +Node: DATA MANAGEMENT256157 +Ref: #data-management256322 +Node: REPORTS FINANCIAL256443 +Ref: #reports-financial256618 +Node: REPORTS VERSATILE256923 +Ref: #reports-versatile257096 +Node: REPORTS BASIC257349 +Ref: #reports-basic257501 +Node: HELP258010 +Ref: #help258132 +Node: ADD-ONS258242 +Ref: #add-ons258348 +Node: accounts258927 +Ref: #accounts259060 +Node: activity260947 +Ref: #activity261066 +Node: add261440 +Ref: #add261550 +Node: aregister264361 +Ref: #aregister264482 +Node: aregister and posting dates267370 +Ref: #aregister-and-posting-dates267515 +Node: balance268271 +Ref: #balance268397 +Node: balance features269382 +Ref: #balance-features269522 +Node: Simple balance report271488 +Ref: #simple-balance-report271673 +Node: Balance report line format273298 +Ref: #balance-report-line-format273500 +Node: Filtered balance report275658 +Ref: #filtered-balance-report275850 +Node: List or tree mode276177 +Ref: #list-or-tree-mode276345 +Node: Depth limiting277690 +Ref: #depth-limiting277856 +Node: Dropping top-level accounts278457 +Ref: #dropping-top-level-accounts278657 +Node: Showing declared accounts278967 +Ref: #showing-declared-accounts279166 +Node: Sorting by amount279697 +Ref: #sorting-by-amount279864 +Node: Percentages280534 +Ref: #percentages280693 +Node: Multi-period balance report281241 +Ref: #multi-period-balance-report281441 +Node: Balance change end balance283716 +Ref: #balance-change-end-balance283925 +Node: Balance report types285353 +Ref: #balance-report-types285534 +Node: Calculation type286032 +Ref: #calculation-type286187 +Node: Accumulation type286736 +Ref: #accumulation-type286916 +Node: Valuation type287818 +Ref: #valuation-type288006 +Node: Combining balance report types289007 +Ref: #combining-balance-report-types289201 +Node: Budget report291039 +Ref: #budget-report291201 +Node: Budget report start date296855 +Ref: #budget-report-start-date297033 +Node: Budgets and subaccounts298365 +Ref: #budgets-and-subaccounts298572 +Node: Selecting budget goals302012 +Ref: #selecting-budget-goals302211 +Node: Budget vs forecast303246 +Ref: #budget-vs-forecast303405 +Node: Balance report layout305035 +Ref: #balance-report-layout305215 +Node: Useful balance reports313400 +Ref: #useful-balance-reports313560 +Node: balancesheet314645 +Ref: #balancesheet314790 +Node: balancesheetequity316117 +Ref: #balancesheetequity316275 +Node: cashflow317671 +Ref: #cashflow317802 +Node: check319237 +Ref: #check319351 +Node: Default checks320155 +Ref: #default-checks320281 +Node: Strict checks320778 +Ref: #strict-checks320923 +Node: Other checks321403 +Ref: #other-checks321545 +Node: Custom checks322078 +Ref: #custom-checks322235 +Node: More about specific checks322652 +Ref: #more-about-specific-checks322814 +Node: close323520 +Ref: #close323631 +Node: close and balance assertions327096 +Ref: #close-and-balance-assertions327274 +Node: Example retain earnings328425 +Ref: #example-retain-earnings328642 +Node: Example migrate balances to a new file329074 +Ref: #example-migrate-balances-to-a-new-file329339 +Node: Example excluding closing/opening transactions329915 +Ref: #example-excluding-closingopening-transactions330164 +Node: codes331382 +Ref: #codes331499 +Node: commodities332363 +Ref: #commodities332491 +Node: demo332561 +Ref: #demo332682 +Node: descriptions333598 +Ref: #descriptions333728 +Node: diff334019 +Ref: #diff334134 +Node: files335176 +Ref: #files335285 +Node: help335426 +Ref: #help-1335535 +Node: import336908 +Ref: #import337031 +Node: Deduplication338139 +Ref: #deduplication338264 +Node: Import testing340283 +Ref: #import-testing340448 +Node: Importing balance assignments341291 +Ref: #importing-balance-assignments341497 +Node: Commodity display styles342146 +Ref: #commodity-display-styles342319 +Node: incomestatement342448 +Ref: #incomestatement342590 +Node: notes343918 +Ref: #notes344040 +Node: payees344402 +Ref: #payees344517 +Node: prices345036 +Ref: #prices345151 +Node: print345804 +Ref: #print345919 +Node: print explicitness346895 +Ref: #print-explicitness347038 +Node: print amount style347817 +Ref: #print-amount-style347987 +Node: print parseability349039 +Ref: #print-parseability349211 +Node: print other features349960 +Ref: #print-other-features350139 +Node: print output format350660 +Ref: #print-output-format350808 +Node: register353927 +Ref: #register354049 +Node: Custom register output359080 +Ref: #custom-register-output359211 +Node: rewrite360555 +Ref: #rewrite360673 +Node: Re-write rules in a file362571 +Ref: #re-write-rules-in-a-file362734 +Node: Diff output format363883 +Ref: #diff-output-format364066 +Node: rewrite vs print --auto365158 +Ref: #rewrite-vs.-print---auto365318 +Node: roi365874 +Ref: #roi365981 +Node: Spaces and special characters in --inv and --pnl367793 +Ref: #spaces-and-special-characters-in---inv-and---pnl368033 +Node: Semantics of --inv and --pnl368521 +Ref: #semantics-of---inv-and---pnl368760 +Node: IRR and TWR explained370610 +Ref: #irr-and-twr-explained370770 +Node: stats374023 +Ref: #stats374131 +Node: tags375518 +Ref: #tags-1375625 +Node: test376634 +Ref: #test376727 +Node: PART 5 COMMON TASKS377469 +Ref: #part-5-common-tasks377615 +Node: Getting help377913 +Ref: #getting-help378054 +Node: Constructing command lines378814 +Ref: #constructing-command-lines379015 +Node: Starting a journal file379672 +Ref: #starting-a-journal-file379874 +Node: Setting LEDGER_FILE381076 +Ref: #setting-ledger_file381268 +Node: Setting opening balances382225 +Ref: #setting-opening-balances382426 +Node: Recording transactions385567 +Ref: #recording-transactions385756 +Node: Reconciling386312 +Ref: #reconciling386464 +Node: Reporting388721 +Ref: #reporting388870 +Node: Migrating to a new file392855 +Ref: #migrating-to-a-new-file393012 +Node: BUGS393311 +Ref: #bugs393401 +Node: Troubleshooting394280 +Ref: #troubleshooting394380  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 9cce2457a..c507581a0 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -2307,8 +2307,8 @@ Journal 7. 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's a bit - inconsistent with the above.) Eg: ~ every 10th day of month from - 2023/01, which is equivalent to ~ every 10th day of month from + inconsistent with the above.) Eg: ~ every 10th day of month from + 2023/01, which is equivalent to ~ every 10th day of month from 2023/01/01, will be adjusted to start on 2019/12/10. Periodic rule syntax @@ -4056,25 +4056,18 @@ Timeclock Timedot 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 - this: + pared to timeclock format, it is more convenient for quick, approxi- + mate, and retroactive time logging, and more human-readable (you can + see at a glance where time was spent). A quick example: 2023-05-01 - hom:errands .... .... ; two hours + hom:errands .... .... ; two hours; the space is ignored fos:hledger:timedot .. ; half an hour - per:admin:finance + per:admin:finance ; no time spent yet hledger reads this as a transaction on this day with three (unbalanced) - postings, where each dot represents "0.25". No commodity is assumed, - but normally we interpret it as hours, with each dot representing a - quarter-hour. It's convenient, though not required, to group the dots - in fours for easy reading. + postings, where each dot represents "0.25". No commodity symbol is as- + sumed, but we typically interpret it as hours. $ hledger -f a.timedot print # .timedot file extension (or timedot: prefix) is required 2023-05-01 * @@ -4082,56 +4075,65 @@ Timedot (fos:hledger:timedot) 0.50 ; half an hour (per:admin:finance) 0 - A transaction begins with a non-indented simple date (Y-M-D, Y/M/D, or - Y.M.D). It can optionally be preceded by one or more stars and a - space, for Emacs org mode compatibility. It can optionally be followed - on the same line by a transaction description, and/or a transaction - comment following a semicolon. + A timedot file contains a series of transactions (usually one per day). + Each begins with a simple date (Y-M-D, Y/M/D, or Y.M.D), optionally be + followed on the same line by a transaction description, and/or a trans- + action comment following a semicolon. After the date line are zero or more time postings, consisting of: - o an account name - any hledger-style account name, optionally hierar- - chical, optionally indented. + o An account name - any hledger-style account name, optionally in- + dented. - o two or more spaces - a field separator, required if there is an - amount (as in journal format). + o Two or more spaces - required if there is an amount (as in journal + format). - o an optional timedot amount - dots representing quarter hours, or a - number representing hours, optionally with a unit suffix. + o A timedot amount, which can be - o an optional posting comment following a semicolon. + o empty (representing zero) - Timedot amounts can be: + o a number, optionally followed by a unit s, m, h, d, w, mo, or y, + representing a precise number of seconds, minutes, hours, days + weeks, months or years (hours is assumed by default), which will be + converted to hours according to 60s = 1m, 60m = 1h, 24h = 1d, 7d = + 1w, 30d = 1mo, 365d = 1y. - o dots: zero or more period characters (.), each representing 0.25. - Spaces are ignored and can be used for grouping. Eg: .... .. + o one or more dots (period characters), each representing 0.25. + These are the dots in "timedot". Spaces are ignored and can be + used for grouping/alignment. - o or a number. Eg: 1.5 + o one or more letters. These are like dots but they also generate a + tag t: (short for "type") with the letter as its value, and a sepa- + rate posting for each of the values. This provides a second dimen- + sion of categorisation, viewable in reports with --pivot t. - o or a number immediately followed by a unit symbol s, m, h, d, w, mo, - or y. These are interpreted as seconds, minutes, hours, days weeks, - months or years, and converted to hours, assuming: - 60s = 1m, 60m = 1h, 24h = 1d, 7d = 1w, 30d = 1mo, 365d = 1y. Eg 90m is - parsed as 1.5. + o An optional comment following a semicolon (a hledger-style posting + comment). - There is some added flexibility to help with keeping time log data in - the same file as your notes, todo lists, etc.: + There is some flexibility to help with keeping time log data and notes + in the same file: o Blank lines and lines beginning with # or ; are ignored. - o Before the first date line, lines beginning with * are ignored. + o After the first date line, lines which do not contain a double space + are parsed as postings with zero amount. (hledger's register reports + will show these if you add -E). - o From the first date line onward, one or more *'s followed by a space - at beginning of lines (ie, the headline prefix used by Emacs Org - mode) is ignored. This means the time log can be kept under an Org - headline, and date lines or time transaction lines can be Org head- - lines. + o Before the first date line, lines beginning with * (eg org headings) + are ignored. And from the first date line onward, Emacs org mode + heading prefixes at the start of lines (one or more *'s followed by a + space) will be ignored. This means the time log can also be a org + outline. - o Lines not ending with a double-space and amount are parsed as post- - ings with zero amount. Note hledger's register reports hide these by - default (add -E to see them). + Timedot examples + Numbers: - More examples: + 2016/2/3 + inc:client1 4 + fos:hledger 3h + biz:research 60m + + Dots: # on this day, 6h was spent on client work, 1.5h on haskell FOSS work, etc. 2016/2/1 @@ -4143,34 +4145,6 @@ Timedot inc:client1 .... .... biz:research . - 2016/2/3 - inc:client1 4 - fos:hledger 3 - biz:research 1 - - * Time log - ** 2023-01-01 - *** adm:time . - *** adm:finance . - - * 2023 Work Diary - ** Q1 - *** 2023-02-29 - **** DONE - 0700 yoga - **** UNPLANNED - **** BEGUN - hom:chores - cleaning ... - water plants - outdoor - one full watering can - indoor - light watering - **** TODO - adm:planning: trip - *** LATER - - Reporting: - $ hledger -f a.timedot print date:2016/2/2 2016-02-02 * (inc:client1) 2.00 @@ -4193,27 +4167,96 @@ Timedot ------------++---------------------------------------- || 7.75 2.25 8.00 - Using period instead of colon as account name separator: + Letters: + + # Activity types: + # c cleanup/catchup/repair + # e enhancement + # s support + # l learning/research + + 2023-11-01 + work:adm ccecces + + $ hledger -f a.timedot print + 2023-11-01 + (work:adm) 1 ; t:c + (work:adm) 0.5 ; t:e + (work:adm) 0.25 ; t:s + + $ hledger -f a.timedot bal + 1.75 work:adm + -------------------- + 1.75 + + $ hledger -f a.timedot bal --pivot t + 1.00 c + 0.50 e + 0.25 s + -------------------- + 1.75 + + Org: + + * 2023 Work Diary + ** Q1 + *** 2023-02-29 + **** DONE + 0700 yoga + **** UNPLANNED + **** BEGUN + hom:chores + cleaning ... + water plants + outdoor - one full watering can + indoor - light watering + **** TODO + adm:planning: trip + *** LATER + + Using . as account name separator: 2016/2/4 - fos.hledger.timedot 4 + fos.hledger.timedot 4h fos.ledger .. - $ hledger -f a.timedot --alias /\\./=: bal --tree + $ hledger -f a.timedot --alias '/\./=:' bal -t 4.50 fos 4.00 hledger:timedot 0.50 ledger -------------------- 4.50 - A sample.timedot file. - PART 3: REPORTING CONCEPTS Amount formatting, parseability If you're wondering why your print report sometimes shows trailing dec- - imal marks, even when there are no decimal digits; it does this to dis- - ambiguate ambiguous amounts (amounts which have one digit group mark - and no decimal digits), allowing them to be re-parsed reliably. + imal marks, with no decimal digits; it does this when showing amounts + that have digit group marks but no decimal digits, to disambiguate them + and allow them to be re-parsed reliably (see also Decimal marks, digit + group marks. Eg: + + commodity $1,000.00 + + 2023-01-02 + (a) $1000 + + $ hledger print + 2023-01-02 + (a) $1,000. + + If this is a problem (eg when exporting to Ledger), you can avoid it by + disabling digit group marks, eg with -c/--commodity (for each affected + commodity): + + $ hledger print -c '$1000.00' + 2023-01-02 + (a) $1000 + + or by forcing print to always show decimal digits, with --round: + + $ hledger print -c '$1,000.00' --round=soft + 2023-01-02 + (a) $1,000.00 More generally: hledger output falls into three rough categories, which format amounts a little bit differently to suit different consumers: @@ -4582,7 +4625,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 + 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. Oth- erwise, the absolute magnitudes are compared, ignoring sign. @@ -6165,25 +6208,25 @@ PART 4: COMMANDS o %, - render on one line, comma-separated There are some quirks. Eg in one-line mode, %(depth_spacer) has no ef- - fect, instead %(account) has indentation built in. Experimentation may - be needed to get pleasing results. + fect, 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 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: @@ -6193,10 +6236,10 @@ PART 4: 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 @@ -6216,26 +6259,26 @@ PART 4: 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 @@ -6247,7 +6290,7 @@ PART 4: 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: @@ -6258,53 +6301,53 @@ PART 4: COMMANDS $2 Showing declared accounts - With --declared, accounts which have been declared with an account di- - rective will be included in the balance report, even if they have no + With --declared, accounts which have been declared with an account di- + rective 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 re- + The idea of this is to be able to see a useful "complete" balance re- port, even when you don't have transactions in all of your declared ac- counts yet. 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 - biggest averaged monthly expenses first. When more than one commodity - is present, they will be sorted by the alphabetically earliest commod- - ity first, and then by subsequent commodities (if an amount is missing + With -S/--sort-amount, accounts with the largest (most positive) bal- + ances are shown first. Eg: hledger bal expenses -MAS shows your + biggest averaged monthly expenses first. When more than one commodity + is present, they will be sorted by the alphabetically earliest commod- + ity 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 --in- - vert to flip the signs. (Or, use one of the higher-level reports, + Revenues and liability balances are typically negative, however, so -S + shows these in reverse order. To work around this, you can add --in- + vert 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. 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: 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 @@ -6325,21 +6368,21 @@ PART 4: 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 @@ -6353,57 +6396,57 @@ PART 4: 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 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 ac- + A balance change is the net amount added to, or removed from, an ac- count 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 - The balance command is quite flexible; here is the full detail on how - to control what it reports. If the following seems complicated, don't - worry - this is for advanced reporting, and it does take time and ex- + The balance command is quite flexible; here is the full detail on how + to control what it reports. If the following seems complicated, don't + worry - this is for advanced reporting, and it does take time and ex- perimentation to get familiar with all the report modes. There are three important option groups: - hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] + hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] ... Calculation type @@ -6415,57 +6458,57 @@ PART 4: COMMANDS each account/period) 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) o --count : show the count of postings Accumulation type - How amounts should accumulate across report periods. Another way to - say it: which time period's postings should contribute to each cell's + How amounts should accumulate across report periods. Another way to + say it: which time period's postings should contribute to each cell's calculation. It is one of: - o --change : calculate with postings from column start to column end, - ie "just this column". Typically used to see revenues/expenses. + o --change : calculate with postings from column start to column end, + ie "just this column". Typically used to see revenues/expenses. (default for balance, incomestatement) - o --cumulative : calculate with postings from report start to column - end, ie "previous columns plus this column". Typically used to show + o --cumulative : calculate with postings from report start to column + end, ie "previous columns plus this column". Typically used to show changes accumulated since the report's start date. Not often used. - o --historical/-H : calculate with postings from journal start to col- - umn end, ie "all postings from before report start date until this - column's end". Typically used to see historical end balances of as- - sets/liabilities/equity. (default for balancesheet, balancesheete- + o --historical/-H : calculate with postings from journal start to col- + umn end, ie "all postings from before report start date until this + column's end". Typically used to see historical end balances of as- + sets/liabilities/equity. (default for balancesheet, balancesheete- quity, cashflow) Valuation type - Which kind of value or cost conversion should be applied, if any, be- + Which kind of value or cost conversion should be applied, if any, be- fore displaying the report. It is one of: o no valuation type : don't convert to cost or value (default) - o --value=cost[,COMM] : convert amounts to cost (then optionally to + o --value=cost[,COMM] : convert amounts to cost (then optionally to some other commodity) - o --value=then[,COMM] : convert amounts to market value on transaction + o --value=then[,COMM] : convert amounts to market value on transaction dates - o --value=end[,COMM] : convert amounts to market value on period end + o --value=end[,COMM] : convert amounts to market value on period end date(s) (default with --valuechange, --gain) o --value=now[,COMM] : convert amounts to market value on today's date - o --value=YYYY-MM-DD[,COMM] : convert amounts to market value on an- + o --value=YYYY-MM-DD[,COMM] : convert amounts to market value on an- other date or one of the equivalent simpler flags: - o -B/--cost : like --value=cost (though, note --cost and --value are + o -B/--cost : like --value=cost (though, note --cost and --value are independent options which can both be used at once) o -V/--market : like --value=end @@ -6475,13 +6518,13 @@ PART 4: COMMANDS See Cost reporting and Value reporting for more about these. Combining balance report types - 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 @@ -6495,26 +6538,26 @@ PART 4: COMMANDS lation:v ----------------------------------------------------------------------------------- --change change in period sum of posting- period-end DATE-value of - date market val- value of change change in pe- + date market val- value of change change in pe- ues in period in period riod - --cumu- change from re- sum of posting- period-end DATE-value of - lative port start to date market val- value of change change from + --cumu- change from re- sum of posting- period-end DATE-value of + lative port 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 Budget report - The --budget report type activates extra columns showing any budget + The --budget report type activates extra columns showing any budget goals for each account and period. The budget goals are defined by pe- - riodic transactions. This is useful for comparing planned and actual + riodic transactions. This is useful for comparing planned and actual income, expenses, time usage, etc. - For example, you can take average monthly expenses in the common ex- + For example, you can take average monthly expenses in the common ex- pense categories to construct a minimal monthly budget: ;; Budget @@ -6559,30 +6602,30 @@ PART 4: COMMANDS ----------------------++---------------------------------------------------- || 0 [ 0] 0 [ 0] - This is different from a normal balance report in several ways. Cur- + This is different from a normal balance report in several ways. Cur- rently: - o Accounts with budget goals during the report period, and their par- + o Accounts with budget goals during the report period, and their par- ents, are shown. o Their subaccounts are not shown (regardless of the depth setting). - o Accounts without budget goals, if any, are aggregated and shown as + o Accounts without budget goals, if any, are aggregated and shown as "". - o Amounts are always inclusive (subaccount-including), even in list + o Amounts are always inclusive (subaccount-including), even in list mode. - o After each actual amount, the corresponding goal amount and percent- + o After each actual amount, the corresponding goal amount and percent- age of goal reached are also shown, in square brackets. - This means that the numbers displayed will not always add up! Eg - above, the expenses actual amount includes the gifts and supplies + 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 @@ -6629,19 +6672,19 @@ PART 4: COMMANDS hledger bal -M --budget type:rx - It's also common to limit or convert them to a single currency - (cur:COMM or -X COMM [--infer-market-prices]). If showing multiple + It's also common to limit or convert them to a single currency + (cur:COMM or -X COMM [--infer-market-prices]). If showing multiple currencies, --layout bare or --layout tall can help. 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 @@ -6660,9 +6703,9 @@ PART 4: 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 @@ -6675,12 +6718,12 @@ PART 4: 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: @@ -6690,13 +6733,13 @@ PART 4: 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 to- + Transactions in expenses:personal:electronics will be counted both to- wards its $100 budget and $1100 of expenses:personal , and transactions - in any other subaccount of expenses:personal would be counted towards + 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: @@ -6722,9 +6765,9 @@ PART 4: 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: @@ -6740,7 +6783,7 @@ PART 4: 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 @@ -6759,29 +6802,29 @@ PART 4: COMMANDS Selecting budget goals The budget report evaluates periodic transaction rules to generate spe- - cial "goal transactions", which generate the goal amounts for each ac- - count in each report subperiod. When troubleshooting, you can use + cial "goal transactions", which generate the goal amounts for each ac- + count in each report subperiod. When troubleshooting, you can use print --forecast 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 se- + regular expression or query). This means you can give your periodic + rules descriptions (remember that two spaces are needed), and then se- lect from multiple budgets defined in your journal. Budget vs forecast - hledger --forecast ... and hledger balance --budget ... are separate - features, though both of them use the periodic transaction rules de- - fined in the journal, and both of them generate temporary transactions + hledger --forecast ... and hledger balance --budget ... are separate + features, though both of them use the periodic transaction rules de- + fined in the journal, and both of them generate temporary transactions for reporting purposes ("forecast transactions" and "budget goal trans- actions", respectively). You can use both features at the same time if you want. Here are some differences between them, as of hledger 1.29: @@ -6797,26 +6840,26 @@ PART 4: COMMANDS o forecast transactions are visible in any report, like ordinary trans- actions - o budget goal transactions are invisible except for the goal amounts + o budget goal transactions are invisible except for the goal amounts they produce in --budget reports. Periodic transaction rules: o --forecast uses all available periodic transaction rules - o --budget uses all periodic rules (--budget) or a selected subset + o --budget uses all periodic rules (--budget) or a selected subset (--budget=DESCPAT) Period of generated transactions: o --forecast generates forecast transactions - o from after the last regular transaction to the end of the report + o from after the last regular transaction to the end of the report period (--forecast) o or, during a specified period (--forecast=PERIODEXPR) - o possibly further restricted by a period specified in the periodic + o possibly further restricted by a period specified in the periodic transaction rule o and always restricted within the bounds of the report period @@ -6825,16 +6868,16 @@ PART 4: COMMANDS o throughout the report period - o possibly restricted by a period specified in the periodic transac- + o possibly restricted by a period specified in the periodic transac- tion rule. Balance report layout - The --layout option affects how balance reports show multi-commodity - amounts and commodity symbols, which can improve readability. It can + The --layout option affects how balance reports show multi-commodity + amounts and commodity symbols, which can improve readability. It can also normalise the data for easy consumption by other programs. It has four possible values: - o --layout=wide[,WIDTH]: commodities are shown on a single line, op- + o --layout=wide[,WIDTH]: commodities are shown on a single line, op- tionally elided to WIDTH o --layout=tall: each commodity is shown on a separate line @@ -6842,10 +6885,10 @@ PART 4: COMMANDS o --layout=bare: commodity symbols are in their own column, amounts are bare numbers - o --layout=tidy: data is normalised to easily-consumed "tidy" form, + o --layout=tidy: data is normalised to easily-consumed "tidy" form, with one row per data value - Here are the --layout modes supported by each output format; note only + Here are the --layout modes supported by each output format; note only CSV output supports all of them: - txt csv html json sql @@ -6868,7 +6911,7 @@ PART 4: 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 @@ -6880,7 +6923,7 @@ PART 4: 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 @@ -6900,7 +6943,7 @@ PART 4: 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 @@ -6920,7 +6963,7 @@ PART 4: 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 for making charts: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=bare @@ -6938,11 +6981,11 @@ PART 4: COMMANDS o Note: bare layout will sometimes display an extra row for the no-sym- bol commodity, because of zero amounts (hledger treats zeroes as com- - modity-less, usually). This can break hledger-bar confusingly + modity-less, usually). This can break hledger-bar confusingly (workaround: add a cur: query to exclude the no-symbol row). o Tidy layout produces normalised "tidy data", where every variable has - its own column and each row represents a single data point. See + its own column and each row represents a single data point. See https://cran.r-project.org/web/packages/tidyr/vignettes/tidy- data.html for more. This is the easiest kind of data for other soft- ware to consume. Here's how it looks: @@ -6969,25 +7012,25 @@ PART 4: 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 @@ -7003,14 +7046,14 @@ PART 4: COMMANDS 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: @@ -7035,9 +7078,9 @@ PART 4: 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 op- @@ -7047,13 +7090,13 @@ PART 4: COMMANDS 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 in- + 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 in- sensitive, plurals allowed) and their subaccounts. Example: @@ -7083,9 +7126,9 @@ PART 4: 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 op- @@ -7095,15 +7138,15 @@ PART 4: COMMANDS 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 al- + o under a top-level account named asset (case insensitive, plural al- lowed) o whose name contains some variation of cash, bank, checking or saving. @@ -7132,8 +7175,8 @@ PART 4: 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 op- @@ -7143,10 +7186,10 @@ PART 4: COMMANDS 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: @@ -7155,7 +7198,7 @@ PART 4: 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: @@ -7163,23 +7206,23 @@ PART 4: COMMANDS Default checks These checks are run automatically by (almost) all hledger commands: - o parseable - data files are in a supported format, with no syntax er- + o parseable - data files are in a supported format, with no syntax er- rors and no invalid include directives. - o autobalanced - all transactions are balanced, after converting to - cost. Missing amounts and missing costs are inferred automatically + o autobalanced - all transactions are balanced, after converting to + cost. Missing amounts and missing costs are inferred automatically where possible. - 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 balanced - all transactions are balanced after converting to cost, - without inferring missing costs. If conversion costs are required, + o balanced - all transactions are balanced after converting to cost, + without inferring missing costs. If conversion costs are required, they must be explicit. o accounts - all account names used by transactions have been declared @@ -7187,14 +7230,14 @@ PART 4: COMMANDS o commodities - all commodity symbols used have been declared Other checks - These checks can be run only by giving their names as arguments to + These checks can be run only by giving their names as arguments to check. They are more specialised and not desirable for everyone: 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 within 7 days of their latest posting o tags - all tags used by transactions have been declared @@ -7202,26 +7245,26 @@ PART 4: COMMANDS 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 - account has postings more than 7 days after its latest balance asser- - tion. This aims to prevent the situation where you are regularly up- - dating 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 + hledger check recentassertions will complain if any balance-asserted + account has postings more than 7 days after its latest balance asser- + tion. This aims to prevent the situation where you are regularly up- + dating 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 recom- mend to import transactions uncleared, and when you manually review and clear them, also check the latest assertion against the real-world bal- @@ -7230,98 +7273,98 @@ PART 4: COMMANDS close (equity) - Generate transactions which transfer account balances to and/or from - another account (typically equity). This can be useful for migrating - balances to a new journal file, or for merging earnings into equity at + Generate transactions which transfer account balances to and/or from + another account (typically equity). This can be useful for migrating + balances to a new journal file, or for merging earnings into equity at end of accounting period. - By default, it prints a transaction that zeroes out ALE accounts (as- + By default, it prints a transaction that zeroes out ALE accounts (as- set, liability, equity accounts; this requires account types to be con- figured); or if ACCTQUERY is provided, the accounts matched by that. (experimental) - This command has four main modes, corresponding to the most common use + This command has four main modes, corresponding to the most common use cases: - 1. With --close (default), it prints a "closing balances" transaction - that zeroes out ALE (asset, liability, equity) accounts by default - (this requires account types to be inferred or declared); or, the + 1. With --close (default), it prints a "closing balances" transaction + that zeroes out ALE (asset, liability, equity) accounts by default + (this requires account types to be inferred or declared); or, the accounts matched by the provided ACCTQUERY arguments. - 2. With --open, it prints an opposite "opening balances" transaction + 2. With --open, it prints an opposite "opening balances" transaction that restores those balances from zero. This is similar to Ledger's equity command. 3. With --migrate, it prints both the closing and opening transactions. - This is the preferred way to migrate balances to a new file: run - hledger close --migrate, add the closing transaction at the end of - the old file, and add the opening transaction at the start of the - new file. The matching closing/opening transactions cancel each + This is the preferred way to migrate balances to a new file: run + hledger close --migrate, add the closing transaction at the end of + the old file, and add the opening transaction at the start of the + new file. The matching closing/opening transactions cancel each other out, preserving correct balances during multi-file reporting. 4. With --retain, it prints a "retain earnings" transaction that trans- - fers RX (revenue and expense) balances to equity:retained earnings. - Businesses traditionally do this at the end of each accounting pe- - riod; it is less necessary with computer-based accounting, but it - could still be useful if you want to see the accounting equation + fers RX (revenue and expense) balances to equity:retained earnings. + Businesses traditionally do this at the end of each accounting pe- + riod; it is less necessary with computer-based accounting, but it + could still be useful if you want to see the accounting equation (A=L+E) satisfied. In all modes, the defaults can be overridden: - o the transaction descriptions can be changed with --close-desc=DESC + o the transaction descriptions can be changed with --close-desc=DESC and --open-desc=DESC o the account to transfer to/from can be changed with --close-acct=ACCT and --open-acct=ACCT - o the accounts to be closed/opened can be changed with ACCTQUERY (ac- + o the accounts to be closed/opened can be changed with ACCTQUERY (ac- count query arguments). - o the closing/opening dates can be changed with -e DATE (a report end + o the closing/opening dates can be changed with -e DATE (a report end date) - By default just one destination/source posting will be used, with its - amount left implicit. With --x/--explicit, the amount will be shown + By default just one destination/source posting will be used, with its + amount left implicit. With --x/--explicit, the amount will be shown explicitly, and if it involves multiple commodities, a separate posting will be generated for each of them (similar to print -x). - With --show-costs, any amount costs are shown, with separate postings + With --show-costs, any amount costs are shown, with separate postings for each cost. This is currently the best way to view investment lots. If you have many currency conversion or investment transactions, it can generate very large journal entries. - With --interleaved, each individual transfer is shown with source and - destination postings next to each other. This could be useful for + With --interleaved, each individual transfer is shown with source and + destination postings next to each other. This could be useful for troubleshooting. - The default closing date is yesterday, or the journal's end date, - whichever is later. You can change this by specifying a report end - date with -e. The last day of the report period will be the closing - date, eg -e 2024 means "close on 2023-12-31". The opening date is al- + The default closing date is yesterday, or the journal's end date, + whichever is later. You can change this by specifying a report end + date with -e. The last day of the report period will be the closing + date, eg -e 2024 means "close on 2023-12-31". The opening date is al- ways the day after the closing date. close and balance assertions - Balance assertions will be generated, verifying that the accounts have - been reset to zero (and then restored to their previous balances, if + Balance assertions will be generated, verifying that the accounts have + been reset to zero (and then restored to their previous balances, if there is an opening transaction). - These provide useful error checking, but you can ignore them temporar- + These provide useful error checking, but you can ignore them temporar- ily with -I, or remove them if you prefer. - You probably should avoid filtering transactions by status or realness - (-C, -R, status:), or generating postings (--auto), with this command, + You probably should avoid filtering transactions by status or realness + (-C, -R, status:), or generating postings (--auto), with this command, since the balance assertions would depend on these. - Note custom posting dates spanning the file boundary will disrupt the + Note custom posting dates spanning the file boundary will disrupt the balance assertions: 2023-12-30 a purchase made in december, cleared in january expenses:food 5 assets:bank:checking -5 ; date: 2023-01-02 - To solve that you can transfer the money to and from a temporary ac- - count, in effect splitting the multi-day transaction into two single- + To solve that you can transfer the money to and from a temporary ac- + count, in effect splitting the multi-day transaction into two single- day transactions: ; in 2022.journal: @@ -7340,36 +7383,36 @@ PART 4: COMMANDS $ hledger close --retain -f 2022.journal -p 2022 >> 2022.journal - Note 2022's income statement will now show only zeroes, because rev- - enues and expenses have been moved entirely to equity. To see them + Note 2022's income statement will now show only zeroes, because rev- + enues and expenses have been moved entirely to equity. To see them again, you could exclude the retain transaction: $ hledger -f 2022.journal is not:desc:'retain earnings' Example: migrate balances to a new file - Close assets/liabilities/equity on 2022-12-31 and re-open them on + Close assets/liabilities/equity on 2022-12-31 and re-open them on 2023-01-01: $ hledger close --migrate -f 2022.journal -p 2022 # copy/paste the closing transaction to the end of 2022.journal # copy/paste the opening transaction to the start of 2023.journal - Now 2022's balance sheet will show only zeroes, indicating a balanced - accounting equation. (Unless you are using @/@@ notation - in that - case, try adding --infer-equity.) To see the end-of-year balances + Now 2022's balance sheet will show only zeroes, indicating a balanced + accounting equation. (Unless you are using @/@@ notation - in that + case, try adding --infer-equity.) To see the end-of-year balances again, you could exclude the closing transaction: $ hledger -f 2022.journal bs not:desc:'closing balances' Example: excluding closing/opening transactions - When combining many files for multi-year reports, the closing/opening - transactions cause some noise in transaction-oriented reports like + When combining many files for multi-year reports, the closing/opening + transactions cause some noise in transaction-oriented reports like print and register. You can exclude them as shown above, but - not:desc:... is not ideal as it depends on consistent descriptions; - also you will want to avoid excluding the very first opening transac- + not:desc:... is not ideal as it depends on consistent descriptions; + also you will want to avoid excluding the very first opening transac- tion, which could be awkward. Here is one alternative, using tags: - Add clopen: tags to all opening/closing balances transactions except + Add clopen: tags to all opening/closing balances transactions except the first, like this: ; 2021.journal @@ -7395,7 +7438,7 @@ PART 4: COMMANDS include 2022.journal include 2023.journal - The clopen: tag can exclude all but the first opening transaction. To + The clopen: tag can exclude all but the first opening transaction. To show a clean multi-year checking register: $ hledger -f all.journal areg checking not:tag:clopen @@ -7408,13 +7451,13 @@ PART 4: COMMANDS codes List the codes seen in transactions, in the order parsed. - This command prints the value of each transaction's code field, in the - order transactions were parsed. The transaction code is an optional - value written in parentheses between the date and description, often + This command prints the value of each transaction's code field, in the + order transactions were parsed. The transaction code is an optional + value written in parentheses between the date and description, often used to store a cheque number, order number or similar. Transactions aren't required to have a code, and missing or empty codes - will not be shown by default. With the -E/--empty flag, they will be + will not be shown by default. With the -E/--empty flag, they will be printed as blank lines. You can add a query to select a subset of transactions. @@ -7454,19 +7497,19 @@ PART 4: COMMANDS demo Play demos of hledger usage in the terminal, if asciinema is installed. - Run this command with no argument to list the demos. To play a demo, + Run this command with no argument to list the demos. To play a demo, write its number or a prefix or substring of its title. Tips: Make your terminal window large enough to see the demo clearly. - Use the -s/--speed SPEED option to set your preferred playback speed, + Use the -s/--speed SPEED option to set your preferred playback speed, eg -s4 to play at 4x original speed or -s.5 to play at half speed. The default speed is 2x. - Other asciinema options can be added following a double dash, eg -- + Other asciinema options can be added following a double dash, eg -- -i.1 to limit pauses or -- -h to list asciinema's other options. - During playback, several keys are available: SPACE to pause/unpause, . + During playback, several keys are available: SPACE to pause/unpause, . to step forward (while paused), CTRL-c quit. Examples: @@ -7479,7 +7522,7 @@ PART 4: COMMANDS List the unique descriptions that appear in transactions. This command lists the unique descriptions that appear in transactions, - in alphabetic order. You can add a query to select a subset of trans- + in alphabetic order. You can add a query to select a subset of trans- actions. Example: @@ -7490,18 +7533,18 @@ PART 4: COMMANDS Person A diff - Compares a particular account's transactions in two input files. It + Compares a particular account's transactions in two input files. It shows any transactions to this account which are in one file but not in the other. 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.) + 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 mul- tiple bank transactions have been combined into a single journal entry. This is useful eg if you have downloaded an account's transactions from - your bank (eg as CSV data). When hledger and your bank disagree about + your bank (eg as CSV data). When hledger and your bank disagree about the account balance, you can compare the bank data with your journal to find out the cause. @@ -7518,30 +7561,30 @@ PART 4: COMMANDS These transactions are in the second file only: files - List all files included in the journal. With a REGEX argument, only + List all files included in the journal. With a REGEX argument, only file names matching the regular expression (case sensitive) are shown. help - Show the hledger user manual in the terminal, with info, man, 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 in- + Show the hledger user manual in the terminal, with info, man, 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 in- sensitive. Eg: commands, print, forecast, journal, amount, "auto post- ings". 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 - browser, or when the appropriate hledger manual or viewing tools are + browser, or when the appropriate hledger manual or viewing tools are not installed on your system. - By default it chooses the best viewer found in $PATH, trying (in this - order): info, man, $PAGER, less, more. You can force the use of info, - man, or a pager with the -i, -m, or -p flags, If no viewer can be + By default it chooses the best viewer found in $PATH, trying (in this + order): info, man, $PAGER, less, more. You can force the use of info, + man, or a pager with the -i, -m, or -p flags, If no viewer can be found, or the command is run non-interactively, it just prints the man- ual to stdout. - If using info, note that version 6 or greater is needed for TOPIC - lookup. If you are on mac you will likely have info 4.8, and should - consider installing a newer version, eg with brew install texinfo + If using info, note that version 6 or greater is needed for TOPIC + lookup. If you are on mac you will likely have info 4.8, and should + consider installing a newer version, eg with brew install texinfo (#1770). Examples @@ -7552,75 +7595,75 @@ PART 4: COMMANDS $ hledger help -m journal # show it with man, even if info is installed import - Read new transactions added to each FILE provided as arguments since - last run, and add them to the journal. Or with --dry-run, just print + Read new transactions added to each FILE provided as arguments since + last run, and add them to the journal. Or with --dry-run, just print the transactions that would be added. Or with --catchup, just mark all of the FILEs' current transactions as imported, without importing them. - 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 + 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 add). - Unlike other hledger commands, with import the journal file is an out- + Unlike other hledger commands, with import the journal file is an out- put 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 + 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 hledger import bank.csv or perhaps hledger import *.csv. Note you can import from any file format, though CSV files are the most common import source, and these docs focus on that case. Deduplication - import does time-based deduplication, to detect only the new transac- - tions since the last successful import. (This does not mean "ignore - transactions that look the same", but rather "ignore transactions that - have been seen before".) This is intended for when you are periodi- - cally importing downloaded data, which may overlap with previous down- - loads. Eg if every week (or every day) you download a bank's last + import does time-based deduplication, to detect only the new transac- + tions since the last successful import. (This does not mean "ignore + transactions that look the same", but rather "ignore transactions that + have been seen before".) This is intended for when you are periodi- + cally importing downloaded data, which may overlap with previous down- + loads. Eg if every week (or every day) you download a bank's last three months of CSV data, you can safely run hledger import thebank.csv each time and only new transactions will be imported. - Since the items being read (CSV records, eg) often do not come with - unique identifiers, hledger detects new transactions by date, assuming + Since the items being read (CSV records, eg) often do not come with + unique identifiers, hledger detects new transactions by date, assuming that: 1. new items always have the newest dates 2. item dates do not change across reads - 3. and items with the same date remain in the same relative order + 3. and items with the same date remain in the same relative order across reads. - These are often true of CSV files representing transactions, or true - enough so that it works pretty well in practice. 1 is important, but + These are often true of CSV files representing transactions, or true + enough so that it works pretty well in practice. 1 is important, but violations of 2 and 3 amongst the old transactions won't matter (and if - you import often, the new transactions will be few, so less likely to + you import often, the new transactions will be few, so less likely to be the ones affected). - hledger remembers the latest date processed in each input file by sav- + hledger remembers the latest date processed in each input file by sav- ing a hidden ".latest.FILE" file in FILE's directory (after a succesful import). - Eg when reading finance/bank.csv, it will look for and update the fi- - nance/.latest.bank.csv state file. The format is simple: one or more + Eg when reading finance/bank.csv, it will look for and update the fi- + nance/.latest.bank.csv state file. The format is simple: one or more lines containing the same ISO-format date (YYYY-MM-DD), meaning "I have - processed transactions up to this date, and this many of them on that + processed transactions up to this date, and this many of them on that date." Normally you won't see or manipulate these state files yourself. - But if needed, you can delete them to reset the state (making all - transactions "new"), or you can construct them to "catch up" to a cer- + But if needed, you can delete them to reset the state (making all + transactions "new"), or you can construct them to "catch up" to a cer- tain date. - Note deduplication (and updating of state files) can also be done by + Note deduplication (and updating of state files) can also be done by print --new, but this is less often used. Related: CSV > Working with CSV > Deduplicating, importing. Import testing - With --dry-run, the transactions that will be imported are printed to + With --dry-run, 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. Eg, to see any importable transactions which CSV rules have not + is valid journal format, like the print command, so you can re-parse + it. Eg, to see any importable transactions which CSV rules have not categorised: $ hledger import --dry bank.csv | hledger -f- -I print unknown @@ -7636,17 +7679,17 @@ PART 4: COMMANDS do a --dry-run first and fix any problems before the real import. Importing balance assignments - Entries added by import will have their posting amounts made explicit - (like hledger print -x). This means that any balance assignments in - imported files must be evaluated; but, imported files don't get to see - the main file's account balances. As a result, importing entries with + Entries added by import will have their posting amounts made explicit + (like hledger print -x). This means that any balance assignments in + imported files must be evaluated; but, imported files don't get to see + the main file's account balances. As a result, importing entries with balance assignments (eg from an institution that provides only balances - and not posting amounts) will probably generate incorrect posting + and not posting amounts) will probably generate incorrect posting amounts. To avoid this problem, use print instead of import: $ hledger print IMPORTFILE [--new] >> $LEDGER_FILE - (If you think import should leave amounts implicit like print does, + (If you think import should leave amounts implicit like print does, please test it and send a pull request.) Commodity display styles @@ -7656,13 +7699,13 @@ PART 4: COMMANDS incomestatement (is) - This command displays an income statement, showing revenues and ex- + This command displays an income statement, showing revenues and ex- penses during one or more periods. Amounts are shown with normal posi- tive sign, as in conventional financial statements. - This report shows accounts declared with the Revenue or Expense type - (see account types). Or if no such accounts are declared, it shows - top-level accounts named revenue or income or expense (case insensi- + This report shows accounts declared with the Revenue or Expense type + (see account types). Or if no such accounts are declared, it shows + top-level accounts named revenue or income or expense (case insensi- tive, plurals allowed) and their subaccounts. Example: @@ -7689,9 +7732,9 @@ PART 4: 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 '(revenues|income)' expenses, but with - smarter account detection, and revenues/income displayed with their + smarter account detection, and revenues/income displayed with their sign flipped. This command also supports the output destination and output format op- @@ -7702,8 +7745,8 @@ PART 4: COMMANDS List the unique notes that appear in transactions. This command lists the unique notes that appear in transactions, in al- - phabetic order. You can add a query to select a subset of transac- - tions. The note is the part of the transaction description after a | + phabetic order. You can add a query to select a subset of transac- + tions. The note is the part of the transaction description after a | character (or if there is no |, the whole description). Example: @@ -7715,14 +7758,14 @@ PART 4: COMMANDS payees List the unique payee/payer names that appear in transactions. - This command lists unique payee/payer names which have been declared - with payee directives (--declared), used in transaction descriptions + This command lists unique payee/payer names which have been declared + with payee directives (--declared), used in transaction descriptions (--used), or both (the default). - The payee/payer is the part of the transaction description before a | + The payee/payer is the part of the transaction description before a | character (or if there is no |, the whole description). - You can add query arguments to select a subset of transactions. This + You can add query arguments to select a subset of transactions. This implies --used. Example: @@ -7733,19 +7776,19 @@ PART 4: COMMANDS Person A prices - Print the market prices declared with P directives. With --infer-mar- - ket-prices, also show any additional prices inferred from costs. With + Print the market prices declared with P directives. With --infer-mar- + ket-prices, also show any additional prices inferred from costs. With --show-reverse, also show additional prices inferred by reversing known prices. - Price amounts are always displayed with their full precision, except + Price amounts are always displayed with their full precision, except for reverse prices which are limited to 8 decimal digits. Prices can be filtered by a date:, cur: or amt: query. Generally if you run this command with --infer-market-prices --show-re- - verse, it will show the same prices used internally to calculate value - reports. But if in doubt, you can inspect those directly by running + verse, it will show the same prices used internally to calculate value + reports. But if in doubt, you can inspect those directly by running the value report with --debug=2. print @@ -7754,9 +7797,9 @@ PART 4: COMMANDS The print command displays full journal entries (transactions) from the journal file, sorted by date (or with --date2, by secondary date). - Directives and inter-transaction comments are not shown, currently. + Directives and inter-transaction comments are not shown, currently. This means the print command is somewhat lossy, and if you are using it - to reformat/regenerate your journal you should take care to also copy + to reformat/regenerate your journal you should take care to also copy over the directives and inter-transaction comments. Eg: @@ -7776,54 +7819,54 @@ PART 4: COMMANDS assets:cash $-2 print explicitness - Normally, whether posting amounts are implicit or explicit is pre- + Normally, whether posting amounts are implicit or explicit is pre- served. For example, when an amount is omitted in the journal, it will - not appear in the output. Similarly, if a conversion cost is implied + not appear in the output. Similarly, if a conversion cost is implied but not written, it will not appear in the output. - You can use the -x/--explicit flag to force explicit display of all - amounts and costs. This can be useful for troubleshooting or for mak- - ing your journal more readable and robust against data entry errors. + You can use the -x/--explicit flag to force explicit display of all + amounts and costs. This can be useful for troubleshooting or for mak- + ing your journal more readable and robust against data entry errors. -x is also implied by using any of -B,-V,-X,--value. - The -x/--explicit flag will cause any postings with a multi-commodity - amount (which can arise when a multi-commodity transaction has an im- - plicit amount) to be split into multiple single-commodity postings, + The -x/--explicit flag will cause any postings with a multi-commodity + amount (which can arise when a multi-commodity transaction has an im- + plicit amount) to be split into multiple single-commodity postings, keeping the output parseable. print amount style - Amounts are shown right-aligned within each transaction (but not - aligned across all transactions; you can do that with ledger-mode in + Amounts are shown right-aligned within each transaction (but not + aligned across all transactions; you can do that with ledger-mode in Emacs). - Amounts will be (mostly) normalised to their commodity display style: - their symbol placement, decimal mark, and digit group marks will be - made consistent. By default, decimal digits are shown as they are + Amounts will be (mostly) normalised to their commodity display style: + their symbol placement, decimal mark, and digit group marks will be + made consistent. By default, decimal digits are shown as they are written in the journal. - With the --round option, print will try increasingly hard to display + With the --round option, print will try increasingly hard to display decimal digits according to the commodity display styles: o --round=none show amounts with original precisions (default) o --round=soft add/remove decimal zeros in amounts (except costs) - o --round=hard round amounts (except costs), possibly hiding signifi- + o --round=hard round amounts (except costs), possibly hiding signifi- cant digits o --round=all round all amounts and costs - soft is good for non-lossy cleanup, formatting amounts more consis- + soft is good for non-lossy cleanup, formatting amounts more consis- tently where it's safe to do so. - hard and all can cause print to show invalid unbalanced journal en- - tries; they may be useful eg for stronger cleanup, with manual fixups + hard and all can cause print to show invalid unbalanced journal en- + tries; they may be useful eg for stronger cleanup, with manual fixups when needed. print parseability - print's output is usually a valid hledger journal, and you can process + print's output is usually a valid hledger journal, and you can process it again with a second hledger command. This can be useful for certain - kinds of search (though the same can be achieved with expr: queries + kinds of search (though the same can be achieved with expr: queries now): # Show running total of food expenses paid from cash. @@ -7832,7 +7875,7 @@ PART 4: COMMANDS There are some situations where print's output can become unparseable: - o Value reporting affects posting amounts but not balance assertion or + o Value reporting affects posting amounts but not balance assertion or balance assignment amounts, potentially causing those to fail. o Auto postings can generate postings with too many missing amounts. @@ -7843,38 +7886,53 @@ PART 4: COMMANDS With -B/--cost, amounts with costs are shown converted to cost. With --new, print shows only transactions it has not seen on a previous - run. This uses the same deduplication system as the import command. + run. This uses the same deduplication system as the import command. (See import's docs for details.) With -m DESC/--match=DESC, print shows one recent transaction whose de- - scription is most similar to DESC. DESC should contain at least two - characters. If there is no similar-enough match, no transaction will + scription is most similar to DESC. 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. print output format This command also supports the output destination and output format op- - tions The output formats supported are txt, beancount, csv, tsv, json + tions The output formats supported are txt, beancount, csv, tsv, json and sql. - Experimental: The beancount format tries to produce Beancount-compati- - ble output. It is very basic and may require additional manual fixups: + Experimental: The beancount format tries to produce Beancount-compati- + ble output, as follows: - o Transaction and postings with unmarked status are converted to - cleared (`*``) status. + o Transaction and postings with unmarked status are converted to + cleared (*) status. - o Transactions' payee and or note are wrapped in double quotes. + o Transactions' payee and note are backslash-escaped and double-quote- + escaped and wrapped in double quotes. o Transaction tags are copied to Beancount #tag format. - o Account name parts are capitalised, and if the first account name - part is not one of Assets, Liabilities, Equity, Income, or Expenses, - "Equity:" is prepended. + o Commodity symbols are converted to upper case, and a small number of + currency symbols like $ are converted to the corresponding currency + names. - o The $ commodity symbol is converted to USD. + o Account name parts are capitalised and unsupported characters are re- + placed with -. If an account name part does not begin with a letter, + or if the first part is not Assets, Liabilities, Equity, Income, or + Expenses, an error is raised. (Use --alias options to bring your ac- + counts into compliance.) o An open directive is generated for each account used, on the earliest transaction date. + Some limitations: + + o Balance assertions are removed. + + o Balance assignments become missing amounts. + + o Virtual and balanced virtual postings become regular postings. + + o Directives are not converted. + Here's an example of print's CSV output: $ hledger print -Ocsv @@ -7891,20 +7949,20 @@ PART 4: 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.) register @@ -7913,14 +7971,14 @@ PART 4: 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 @@ -7931,14 +7989,14 @@ PART 4: 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 @@ -7948,18 +8006,18 @@ PART 4: 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 ac- + the whole report period). This flag implies --empty (see below). It + is affected by --historical. It works best when showing just one ac- count 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 to- + bers. It's also useful to show postings on the checking account to- gether with the related account: $ hledger register --related --invert assets:checking @@ -7971,7 +8029,7 @@ PART 4: COMMANDS 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 @@ -7988,7 +8046,7 @@ PART 4: COMMANDS 2008/11 0 $-2 2008/12 0 $-2 - Often, you'll want to see just one line per interval. The --depth op- + Often, you'll want to see just one line per interval. The --depth op- tion helps with this, causing subaccounts to be aggregated: $ hledger register --monthly assets --depth 1h @@ -7996,22 +8054,22 @@ PART 4: 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 in- - tervals. 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 in- + tervals. This ensures that the first and last intervals are full length and comparable to the others in the report. - With -m DESC/--match=DESC, register does a fuzzy search for one recent + With -m DESC/--match=DESC, register does a fuzzy search for one recent posting whose description is most similar to DESC. DESC should contain at least two characters. If there is no similar-enough match, no post- ing will be shown and the program exit code will be non-zero. 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 + The description and account columns normally share the space equally (about half of (width - 40) each). You can adjust this by adding a de- scription width as part of --width's argument, comma-separated: --width W,D . Here's a diagram (won't display correctly in --help): @@ -8030,18 +8088,18 @@ PART 4: COMMANDS $ hledger reg -w $COLUMNS,40 # use terminal width, & description width 40 This command also supports the output destination and output format op- - tions The output formats supported are txt, csv, tsv, and (experimen- + tions The output formats supported are txt, csv, tsv, and (experimen- tal) json. 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: @@ -8057,7 +8115,7 @@ PART 4: 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: @@ -8067,16 +8125,16 @@ PART 4: 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 in- + factor for an amount of original matched posting. If the amount in- cludes a commodity name, the new posting amount will be in the new com- - modity; otherwise, it will be in the matched posting amount's commod- + modity; otherwise, it will be in the matched posting amount's commod- ity. 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. @@ -8091,7 +8149,7 @@ PART 4: 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. @@ -8104,12 +8162,12 @@ PART 4: 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' @@ -8133,10 +8191,10 @@ PART 4: 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: @@ -8144,55 +8202,55 @@ PART 4: 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 - 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 ac- - count name) to select your investment(s) with --inv, and another query + At a minimum, you need to supply a query (which could be just an ac- + count 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, also known as money-weighted rate of return) and time-weighted - rate of return (TWR) for your investments for the time period re- - quested. IRR is always annualized due to the way it is computed, but - TWR is reported both as a rate over the chosen reporting period and as + This command will compute and display the internalized rate of return + (IRR, also known as money-weighted rate of return) and time-weighted + rate of return (TWR) for your investments for the time period re- + quested. IRR is always annualized due to the way it is computed, but + TWR is reported both as a rate over the chosen reporting period and as an annual rate. - 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 be- + o Error (NotBracketed): No solution for Internal Rate of Return (IRR). + Possible causes: IRR is huge (>1000000%), balance of investment be- comes 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 @@ -8202,28 +8260,28 @@ PART 4: 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 as- - sets, or otherwise converting between your investment commodity and + sets, or otherwise converting between your investment commodity and any other commodity. Example: 2019-01-01 Investing in Snake Oil @@ -8240,12 +8298,12 @@ PART 4: 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 re- + 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 re- turn. - 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 @@ -8262,57 +8320,57 @@ PART 4: 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, and the - time between them. Investment at a particular fixed interest rate is - going to give you more interest than the same amount invested at the - same interest rate, but made later in time. If you are withdrawing - from your investment, your future gains would be smaller (in absolute - numbers), and will be a smaller percentage of your initial investment, + Internal rate of return, or "IRR" (also called "money-weighted rate of + return") takes into account effects of in-flows and out-flows, and the + time between them. Investment at a particular fixed interest rate is + going to give you more interest than the same amount invested at the + same interest rate, but made later in time. If you are withdrawing + from your investment, your future gains would be smaller (in absolute + numbers), and will be a smaller percentage of your initial investment, so your IRR will be smaller. And if you are adding to your investment, you will receive bigger absolute gains, which will be a bigger percent- age of your initial investment, so your IRR will be larger. - 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 - called "time-weighted rate of return" or "TWR". Like IRR, it will ac- - count for the effect of your in-flows and out-flows, but unlike IRR it - will try to compute the true rate of return of the underlying asset, - compensating for the effect that deposits and withdrawas have on the + Second way to compute rate of return that roi command implements is + called "time-weighted rate of return" or "TWR". Like IRR, it will ac- + count for the effect of your in-flows and out-flows, but unlike IRR it + will try to compute the true rate of return of the underlying asset, + compensating for the effect that deposits and withdrawas have on the apparent rate of growth 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 + 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, and make TWR less sensitive than IRR to the effects of cash in-flows and out-flows. @@ -8326,21 +8384,21 @@ PART 4: COMMANDS o IRR vs 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 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: @@ -8370,35 +8428,35 @@ PART 4: 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. 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 -- @@ -8407,11 +8465,11 @@ PART 4: 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). PART 5: 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 @@ -8421,37 +8479,37 @@ PART 5: COMMON TASKS $ hledger --help # show common options $ hledger CMD --help # show CMD's options, common options and CMD's 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 # find out more about the help command - To view manuals and introductory docs on the web, visit - https://hledger.org. Chat and mail list support and discussion + To view manuals and introductory docs on the web, visit + https://hledger.org. Chat and mail list support and discussion archives can be found at https://hledger.org/support. Constructing command lines - hledger has a flexible command line interface. We strive to keep it - simple and ergonomic, but if you run into one of the sharp edges de- + hledger has a flexible command line interface. We strive to keep it + simple and ergonomic, but if you run into one of the sharp edges de- scribed in OPTIONS, here are some tips that might 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 common options there too: 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 line 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 @@ -8459,9 +8517,9 @@ PART 5: 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 - (see below). 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 + You can override this by setting the LEDGER_FILE environment variable + (see below). 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 this: $ mkdir ~/finance @@ -8487,28 +8545,28 @@ PART 5: COMMON TASKS Setting LEDGER_FILE How to set LEDGER_FILE permanently depends on your setup: - On unix and mac, running these commands in the terminal will work for + On unix and mac, running these commands in the terminal will work for many people; adapt as needed: $ echo 'export LEDGER_FILE=~/finance/2023.journal' >> ~/.profile $ source ~/.profile - When correctly configured, in a new terminal window env | grep + When correctly configured, in a new terminal window env | grep LEDGER_FILE will show your file, and so will hledger files. - On mac, this additional step might be helpful for GUI applications - (like Emacs started from the dock): add an entry to ~/.MacOSX/environ- + On mac, this additional step might be helpful for GUI applications + (like Emacs started from the dock): add an entry to ~/.MacOSX/environ- ment.plist like { "LEDGER_FILE" : "~/finance/2023.journal" } - and then run killall Dock in a terminal window (or restart the ma- + and then run killall Dock in a terminal window (or restart the ma- chine). On Windows, see https://www.java.com/en/download/help/path.html, or try - running these commands in a powershell window (let us know if it per- + running these commands in a powershell window (let us know if it per- sists across a reboot, and if you need to be an Administrator): > CD @@ -8516,20 +8574,20 @@ PART 5: COMMON TASKS > SETX LEDGER_FILE "C:\Users\USERNAME\finance\2023.journal" 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 + 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 re- - cent starting date, like today or the start of the week. You can al- - ways come back later and add more accounts and older transactions, eg + cent starting date, like today or the start of the week. You can al- + ways 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: 2023-01-01 * opening balances @@ -8539,19 +8597,19 @@ PART 5: 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 @@ -8588,18 +8646,18 @@ PART 5: COMMON TASKS Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2023-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' 2023.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: 2023/1/10 * gift received @@ -8615,22 +8673,22 @@ PART 5: 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 al- - ready-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 al- + ready-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: @@ -8640,26 +8698,26 @@ PART 5: 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 re- - ported by hledger reg checking -C. This will be easier if you gen- - erally record transaction dates quite similar to your bank's clear- + action history and running balance from your bank with the one re- + ported by hledger reg checking -C. This will be easier if you gen- + erally record transaction dates quite similar to your bank's clear- ing dates. 3. Repeat for other asset/liability accounts. - Tip: instead of the register command, use hledger-ui to see a live-up- + Tip: instead of the register command, use hledger-ui to see a live-up- dating register while you edit the journal: hledger-ui --watch --regis- ter 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 2023-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' 2023.journal @@ -8731,7 +8789,7 @@ PART 5: 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 @@ -8741,7 +8799,7 @@ PART 5: 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 @@ -8808,70 +8866,70 @@ PART 5: COMMON TASKS 2023-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. BUGS We welcome bug reports in the hledger issue tracker (shortcut: - http://bugs.hledger.org), or on the #hledger chat or hledger mail list + http://bugs.hledger.org), or on the #hledger chat or hledger mail list (https://hledger.org/support). Some known issues and 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. (See Command options, Constructing command lines.) - A UTF-8-aware system locale must be configured to work with non-ascii + A UTF-8-aware system locale must be configured to work with non-ascii data. (See Unicode characters, Troubleshooting.) On Microsoft Windows, depending whether you are running in a CMD window or a Cygwin/MSYS/Mintty window and how you installed hledger, non-ascii characters and colours may not be supported, and the tab key may not be - supported by hledger add. (Running in a WSL window should resolve + supported by hledger add. (Running in a WSL window should resolve these.) When processing large data files, hledger uses more memory than Ledger. Troubleshooting - Here are some common issues you might encounter when you run hledger, - and how to resolve them (and remember also you can usually get quick + Here are some common issues you might encounter when you run hledger, + and how to resolve them (and remember also you can usually get quick Support): PATH issues: I get an error like "No command 'hledger' found" Depending how you installed hledger, the executables may not be in your - shell's PATH. Eg on unix systems, stack installs hledger in ~/.lo- + shell's PATH. Eg on unix systems, stack installs hledger in ~/.lo- cal/bin and cabal installs it in ~/.cabal/bin. You may need to add one - of these directories to your shell's PATH, and/or open a new terminal + of these directories to your shell's PATH, and/or open a new terminal window. - LEDGER_FILE issues: I configured LEDGER_FILE but hledger is not using + LEDGER_FILE issues: I configured LEDGER_FILE but hledger is not using it - o LEDGER_FILE should be a real environment variable, not just a shell + o LEDGER_FILE should be a real environment variable, not just a shell variable. Eg on unix, the command env | grep LEDGER_FILE should show - it. You may need to use export (see https://stackover- + it. You may need to use export (see https://stackover- flow.com/a/7411509). - o You may need to force your shell to see the new configuration. A + o You may need to force your shell to see the new configuration. A simple way is to close your terminal window and open a new one. - LANG issues: I get errors like "Illegal byte sequence" or "Invalid or + LANG issues: I get errors like "Illegal byte sequence" or "Invalid or incomplete multibyte or wide character" or "commitAndReleaseBuffer: in- valid argument (invalid character)" - Programs compiled with GHC (hledger, haskell build tools, etc.) need - the system locale to be UTF-8-aware, or they will fail when they en- - counter non-ascii characters. To fix it, set the LANG environment - variable to a locale which supports UTF-8 and which is installed on + Programs compiled with GHC (hledger, haskell build tools, etc.) need + the system locale to be UTF-8-aware, or they will fail when they en- + counter non-ascii characters. To fix it, set the LANG environment + variable to a locale which supports UTF-8 and which is installed on your system. - On unix, locale -a lists the installed locales. Look for one which - mentions utf8, UTF-8 or similar. Some examples: C.UTF-8, en_US.utf-8, - fr_FR.utf8. If necessary, use your system package manager to install - one. Then select it by setting the LANG environment variable. Note, - exact spelling and capitalisation of the locale name may be important: + On unix, locale -a lists the installed locales. Look for one which + mentions utf8, UTF-8 or similar. Some examples: C.UTF-8, en_US.utf-8, + fr_FR.utf8. If necessary, use your system package manager to install + one. Then select it by setting the LANG environment variable. Note, + exact spelling and capitalisation of the locale name may be important: Here's one common way to configure this permanently for your shell: $ echo "export LANG=en_US.utf8" >>~/.profile @@ -8884,7 +8942,7 @@ BUGS # close and re-open terminal window COMPATIBILITY ISSUES: hledger gives an error with my Ledger file - Not all of Ledger's journal file syntax or feature set is supported. + Not all of Ledger's journal file syntax or feature set is supported. See hledger and Ledger for full details. @@ -8905,4 +8963,4 @@ LICENSE SEE ALSO hledger(1), hledger-ui(1), hledger-web(1), ledger(1) -hledger-1.31.99 November 2023 HLEDGER(1) +hledger-1.31.99 December 2023 HLEDGER(1)