diff --git a/hledger-lib/.date.m4 b/hledger-lib/.date.m4 index bd0cdfe8d..fbc3c51ab 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_}}, {{December 2023}})m4_dnl +m4_define({{_monthyear_}}, {{January 2024}})m4_dnl diff --git a/hledger-ui/.date.m4 b/hledger-ui/.date.m4 index bd0cdfe8d..fbc3c51ab 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_}}, {{December 2023}})m4_dnl +m4_define({{_monthyear_}}, {{January 2024}})m4_dnl diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1 index 28823062e..c8219ea23 100644 --- a/hledger-ui/hledger-ui.1 +++ b/hledger-ui/hledger-ui.1 @@ -1,241 +1,241 @@ -.TH "HLEDGER-UI" "1" "December 2023" "hledger-ui-1.32.99 " "hledger User Manuals" +.TH "HLEDGER\-UI" "1" "January 2024" "hledger-ui-1.32.99 " "hledger User Manuals" .SH NAME -hledger-ui - robust, friendly plain text accounting (TUI version) +hledger\-ui \- robust, friendly plain text accounting (TUI version) .SH SYNOPSIS -\f[CR]hledger-ui [OPTS] [QUERYARGS]\f[R] +\f[CR]hledger\-ui [OPTS] [QUERYARGS]\f[R] .PD 0 .P .PD -\f[CR]hledger ui -- [OPTS] [QUERYARGS]\f[R] +\f[CR]hledger ui \-\- [OPTS] [QUERYARGS]\f[R] .SH DESCRIPTION This manual is for hledger\[aq]s terminal interface, version 1.32.99. See also the hledger manual for common concepts and file formats. .PP -hledger is a robust, user-friendly, cross-platform set of programs for -tracking money, time, or any other commodity, using double-entry +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. hledger is inspired by and largely compatible with ledger(1), and largely interconvertible with beancount(1). .PP -hledger-ui is hledger\[aq]s terminal interface, providing an efficient -full-window text UI for viewing accounts and transactions, and some +hledger\-ui is hledger\[aq]s terminal interface, providing an efficient +full\-window text UI for viewing accounts and transactions, and some limited data entry capability. -It is easier than hledger\[aq]s command-line interface, and sometimes +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[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. +\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.) +(See hledger(1) \-> Input for details.) .PP -Unlike hledger, hledger-ui hides all future-dated transactions by +Unlike hledger, hledger\-ui hides all future\-dated transactions by default. -They can be revealed, along with any rule-generated periodic -transactions, by pressing the F key (or starting with --forecast) to +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 Any QUERYARGS are interpreted as a hledger search query which filters the data. .PP -hledger-ui provides the following options: +hledger\-ui provides the following options: .TP -\f[CR]-w --watch\f[R] +\f[CR]\-w \-\-watch\f[R] watch for data and date changes and reload automatically .TP -\f[CR]--theme=default|terminal|greenterm\f[R] +\f[CR]\-\-theme=default|terminal|greenterm\f[R] use this custom display theme .TP -\f[CR]--menu\f[R] +\f[CR]\-\-menu\f[R] start in the menu screen .TP -\f[CR]--cash\f[R] +\f[CR]\-\-cash\f[R] start in the cash accounts screen .TP -\f[CR]--bs\f[R] +\f[CR]\-\-bs\f[R] start in the balance sheet accounts screen .TP -\f[CR]--is\f[R] +\f[CR]\-\-is\f[R] start in the income statement accounts screen .TP -\f[CR]--all\f[R] +\f[CR]\-\-all\f[R] start in the all accounts screen .TP -\f[CR]--register=ACCTREGEX\f[R] +\f[CR]\-\-register=ACCTREGEX\f[R] start in the (first) matched account\[aq]s register screen .TP -\f[CR]--change\f[R] +\f[CR]\-\-change\f[R] show period balances (changes) at startup instead of historical balances .TP -\f[CR]-l --flat\f[R] +\f[CR]\-l \-\-flat\f[R] show accounts as a flat list (default) .TP -\f[CR]-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\-ui also supports many of hledger\[aq]s general options (and the hledger manual\[aq]s command line tips also apply here): .SS General help options .TP -\f[CR]-h --help\f[R] +\f[CR]\-h \-\-help\f[R] show general or COMMAND help .TP -\f[CR]--man\f[R] +\f[CR]\-\-man\f[R] show general or COMMAND user manual with man .TP -\f[CR]--info\f[R] +\f[CR]\-\-info\f[R] show general or COMMAND user manual with info .TP -\f[CR]--version\f[R] +\f[CR]\-\-version\f[R] show general or ADDONCMD version .TP -\f[CR]--debug[=N]\f[R] -show debug output (levels 1-9, default: 1) +\f[CR]\-\-debug[=N]\f[R] +show debug output (levels 1\-9, default: 1) .SS General input options .TP -\f[CR]-f FILE --file=FILE\f[R] +\f[CR]\-f FILE \-\-file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[CR]$LEDGER_FILE\f[R] or +For stdin, use \- (default: \f[CR]$LEDGER_FILE\f[R] or \f[CR]$HOME/.hledger.journal\f[R]) .TP -\f[CR]--rules-file=RULESFILE\f[R] +\f[CR]\-\-rules\-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP -\f[CR]--separator=CHAR\f[R] +\f[CR]\-\-separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[CR]--alias=OLD=NEW\f[R] +\f[CR]\-\-alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[CR]--anon\f[R] +\f[CR]\-\-anon\f[R] anonymize accounts and payees .TP -\f[CR]--pivot FIELDNAME\f[R] +\f[CR]\-\-pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[CR]-I --ignore-assertions\f[R] +\f[CR]\-I \-\-ignore\-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[CR]-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[CR]-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[CR]-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[CR]-D --daily\f[R] +\f[CR]\-D \-\-daily\f[R] multiperiod/multicolumn report by day .TP -\f[CR]-W --weekly\f[R] +\f[CR]\-W \-\-weekly\f[R] multiperiod/multicolumn report by week .TP -\f[CR]-M --monthly\f[R] +\f[CR]\-M \-\-monthly\f[R] multiperiod/multicolumn report by month .TP -\f[CR]-Q --quarterly\f[R] +\f[CR]\-Q \-\-quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[CR]-Y --yearly\f[R] +\f[CR]\-Y \-\-yearly\f[R] multiperiod/multicolumn report by year .TP -\f[CR]-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[CR]--date2\f[R] +\f[CR]\-\-date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[CR]--today=DATE\f[R] +\f[CR]\-\-today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[CR]-U --unmarked\f[R] -include only unmarked postings/txns (can combine with -P or -C) +\f[CR]\-U \-\-unmarked\f[R] +include only unmarked postings/txns (can combine with \-P or \-C) .TP -\f[CR]-P --pending\f[R] +\f[CR]\-P \-\-pending\f[R] include only pending postings/txns .TP -\f[CR]-C --cleared\f[R] +\f[CR]\-C \-\-cleared\f[R] include only cleared postings/txns .TP -\f[CR]-R --real\f[R] -include only non-virtual postings +\f[CR]\-R \-\-real\f[R] +include only non\-virtual postings .TP -\f[CR]-NUM --depth=NUM\f[R] +\f[CR]\-NUM \-\-depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[CR]-E --empty\f[R] -show items with zero amount, normally hidden (and vice-versa in -hledger-ui/hledger-web) +\f[CR]\-E \-\-empty\f[R] +show items with zero amount, normally hidden (and vice\-versa in +hledger\-ui/hledger\-web) .TP -\f[CR]-B --cost\f[R] +\f[CR]\-B \-\-cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[CR]-V --market\f[R] +\f[CR]\-V \-\-market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[CR]-X --exchange=COMM\f[R] +\f[CR]\-X \-\-exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[CR]--value\f[R] -convert amounts to cost or market value, more flexibly than -B/-V/-X +\f[CR]\-\-value\f[R] +convert amounts to cost or market value, more flexibly than \-B/\-V/\-X .TP -\f[CR]--infer-equity\f[R] +\f[CR]\-\-infer\-equity\f[R] infer conversion equity postings from costs .TP -\f[CR]--infer-costs\f[R] +\f[CR]\-\-infer\-costs\f[R] infer costs from conversion equity postings .TP -\f[CR]--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[CR]--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. +Also, in hledger\-ui make future\-dated transactions visible. .TP -\f[CR]--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[CR]--verbose-tags\f[R] +\f[CR]\-\-verbose\-tags\f[R] add visible tags indicating transactions or postings which have been generated/modified .TP -\f[CR]--commodity-style\f[R] +\f[CR]\-\-commodity\-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP -\f[CR]--color=WHEN (or --colour=WHEN)\f[R] -Should color-supporting commands use ANSI color codes in text output. -\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting -terminal. +\f[CR]\-\-color=WHEN (or \-\-colour=WHEN)\f[R] +Should color\-supporting commands use ANSI color codes in text output. +\[aq]auto\[aq] (default): whenever stdout seems to be a +color\-supporting terminal. \[aq]always\[aq] or \[aq]yes\[aq]: always, useful eg when piping output -into \[aq]less -R\[aq]. +into \[aq]less \-R\[aq]. \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[CR]--pretty[=WHEN]\f[R] +\f[CR]\-\-pretty[=WHEN]\f[R] Show prettier output, e.g. -using unicode box-drawing characters. +using unicode box\-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], \[aq]n\[aq], \[aq]always\[aq], \[aq]never\[aq] also work). If you provide an argument you must use \[aq]=\[aq], e.g. -\[aq]--pretty=yes\[aq]. +\[aq]\-\-pretty=yes\[aq]. .PP When a reporting option appears more than once in the command line, the last one takes precedence. @@ -264,9 +264,9 @@ 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[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]) +Emacs\-style +(\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. @@ -274,36 +274,36 @@ faster you may want to adjust it. .PP With shift pressed, the cursor keys adjust the report period, limiting the transactions to be shown (by default, all are shown). -\f[CR]SHIFT-DOWN/UP\f[R] steps downward and upward through these +\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. +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[CR]/\f[R] and a +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[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 +(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[CR]\[rs]033[1;2B\f[R], click + and add this for Shift-Up: -\f[CR]\[rs]033[1;2A\f[R]. +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[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; +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[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[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 - +As mentioned above, by default hledger\-ui hides future transactions \- both ordinary transactions recorded in the journal, and periodic transactions generated by rule. \f[CR]F\f[R] toggles forecast mode, in which future/forecasted @@ -313,7 +313,7 @@ transactions are shown. restoring the app\[aq]s initial state at startup. Or, it cancels minibuffer data entry or the help dialog. .PP -\f[CR]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 @@ -325,17 +325,17 @@ screen and any previous screens. Disabling balance assertions temporarily can be useful for troubleshooting. .PP -\f[CR]a\f[R] runs command-line hledger\[aq]s add command, and reloads +\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[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[CR]hledger-iadd\f[R] is installed in +\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[CR]hledger\-iadd\f[R] is installed in $path. .PP \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. +(\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 @@ -349,37 +349,37 @@ market value (see hledger manual > Valuation flag). More specifically, .IP "1." 3 By default, the \f[CR]V\f[R] key toggles showing end value -(\f[CR]--value=end\f[R]) on or off. +(\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[CR]--value=then,EUR\f[R]), the \f[CR]V\f[R] key toggles that off or +If you started hledger\-ui with some other valuation (such as +\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[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/value tips: \- When showing end value, you can change the report +end 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 +\- There\[aq]s not yet any visual indicator that cost or value mode is active, other than the amount values. .PP \f[CR]q\f[R] quits the application. .PP -Additional screen-specific keys are described below. +Additional screen\-specific keys are described below. .SH SCREENS -At startup, hledger-ui shows a menu screen by default. +At startup, hledger\-ui shows a menu screen by default. From here you can navigate to other screens using the cursor keys: \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[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]). +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 -This is the top-most screen. +This is the top\-most screen. From here you can navigate to several screens listing accounts of various types. Note some of these may not show anything until you have configured @@ -427,8 +427,8 @@ This will be the running historical balance (what you would see on a bank\[aq]s website, eg) if not disturbed by a query. .RE .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 +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[CR]aregister\f[R]). So custom posting dates can cause the running balance to be temporarily inaccurate. @@ -453,8 +453,8 @@ activate all three, the filter is removed.) \f[CR]R\f[R] toggles real mode, in which virtual postings are ignored. .PP \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). +nonzero change are shown (hledger\-ui shows zero items by default, +unlike command\-line hledger). .PP Press \f[CR]RIGHT\f[R] to view the selected transaction in detail. .SS Transaction @@ -482,12 +482,12 @@ 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. +them until you exit and re\-enter it. 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. +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 This screen will appear if there is a problem, such as a parse error, when you press g to reload. @@ -496,35 +496,35 @@ normal operation. (Or, you can press escape to cancel the reload attempt.) .SH TIPS .SS Watch mode -One of hledger-ui\[aq]s best features is the auto-reloading -\f[CR]-w/--watch\f[R] mode. +One of hledger\-ui\[aq]s best features is the auto\-reloading +\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 This is very useful when reconciling. 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: +window; and hledger\-ui in watch mode in a terminal window, eg: .IP .EX -$ hledger-ui --watch --register checking -C +$ hledger\-ui \-\-watch \-\-register checking \-C .EE .PP As you mark things cleared in the editor, you can see the effect immediately without having to context switch. This leaves more mental bandwidth for your accounting. -Of course you can still interact with hledger-ui when needed, eg to +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[CR]--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. (Eg #836.) .PP -At least on mac, there can be a slow build-up of CPU usage over time, +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[CR]CTRL-z\f[R] \f[CR]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[CR]gedit\f[R], or on certain less common @@ -536,17 +536,17 @@ know.) If you are viewing files mounted from another machine, the system clocks on both machines should be roughly in agreement. .SS Debug output -You can add \f[CR]--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[CR]hledger-ui.log\f[R] in the current -directory. +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 \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[CR]-f/--file\f[R]. +with \f[CR]\-f/\-\-file\f[R]. Default: \f[CR]$HOME/.hledger.journal\f[R]. .SH BUGS We welcome bug reports in the hledger issue tracker (shortcut: @@ -555,15 +555,16 @@ http://bugs.hledger.org), or on the #hledger chat or hledger mail list .PP Some known issues: .PP -\f[CR]-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[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). +and re\-endter it (see SCREENS > Transaction above). .PP -\f[CR]--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.info b/hledger-ui/hledger-ui.info index a8cbba6ab..205110711 100644 --- a/hledger-ui/hledger-ui.info +++ b/hledger-ui/hledger-ui.info @@ -1,4 +1,4 @@ -This is hledger-ui.info, produced by makeinfo version 7.0.3 from stdin. +This is hledger-ui.info, produced by makeinfo version 7.1 from stdin. INFO-DIR-SECTION User Applications START-INFO-DIR-ENTRY @@ -673,47 +673,47 @@ above).  Tag Table: -Node: Top223 -Node: OPTIONS1832 -Ref: #options1930 -Node: General help options2953 -Ref: #general-help-options3102 -Node: General input options3384 -Ref: #general-input-options3569 -Node: General reporting options4271 -Ref: #general-reporting-options4435 -Node: MOUSE7825 -Ref: #mouse7920 -Node: KEYS8157 -Ref: #keys8250 -Node: SCREENS12905 -Ref: #screens13003 -Node: Menu13583 -Ref: #menu13676 -Node: Cash accounts13871 -Ref: #cash-accounts14013 -Node: Balance sheet accounts14197 -Ref: #balance-sheet-accounts14378 -Node: Income statement accounts14498 -Ref: #income-statement-accounts14684 -Node: All accounts14848 -Ref: #all-accounts14994 -Node: Register15176 -Ref: #register15300 -Node: Transaction17584 -Ref: #transaction17707 -Node: Error19124 -Ref: #error19218 -Node: TIPS19462 -Ref: #tips19561 -Node: Watch mode19603 -Ref: #watch-mode19710 -Node: Debug output21169 -Ref: #debug-output21280 -Node: ENVIRONMENT21492 -Ref: #environment21602 -Node: BUGS21793 -Ref: #bugs21876 +Node: Top221 +Node: OPTIONS1830 +Ref: #options1928 +Node: General help options2951 +Ref: #general-help-options3100 +Node: General input options3382 +Ref: #general-input-options3567 +Node: General reporting options4269 +Ref: #general-reporting-options4433 +Node: MOUSE7823 +Ref: #mouse7918 +Node: KEYS8155 +Ref: #keys8248 +Node: SCREENS12903 +Ref: #screens13001 +Node: Menu13581 +Ref: #menu13674 +Node: Cash accounts13869 +Ref: #cash-accounts14011 +Node: Balance sheet accounts14195 +Ref: #balance-sheet-accounts14376 +Node: Income statement accounts14496 +Ref: #income-statement-accounts14682 +Node: All accounts14846 +Ref: #all-accounts14992 +Node: Register15174 +Ref: #register15298 +Node: Transaction17582 +Ref: #transaction17705 +Node: Error19122 +Ref: #error19216 +Node: TIPS19460 +Ref: #tips19559 +Node: Watch mode19601 +Ref: #watch-mode19708 +Node: Debug output21167 +Ref: #debug-output21278 +Node: ENVIRONMENT21490 +Ref: #environment21600 +Node: BUGS21791 +Ref: #bugs21874  End Tag Table diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt index e2eb822c9..33724240e 100644 --- a/hledger-ui/hledger-ui.txt +++ b/hledger-ui/hledger-ui.txt @@ -20,23 +20,23 @@ DESCRIPTION hledger-ui is hledger's terminal interface, providing an efficient full-window text UI for viewing accounts and transactions, and some - limited data entry capability. It is easier than hledger's command- - line interface, and sometimes quicker and more convenient than the web - interface. + limited data entry capability. It is easier than hledger's com- + mand-line interface, and sometimes quicker and more convenient than the + web interface. - Like hledger, it reads from (and appends to) a journal file specified - by the LEDGER_FILE environment variable (defaulting to - $HOME/.hledger.journal); or you can specify files with -f options. It - can also read timeclock files, timedot files, or any CSV/SSV/TSV file + Like hledger, it reads from (and appends to) a journal file specified + by the LEDGER_FILE environment variable (defaulting to + $HOME/.hledger.journal); or you can specify files with -f 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.) - Unlike hledger, hledger-ui hides all future-dated transactions by de- - fault. They can be revealed, along with any rule-generated periodic - transactions, by pressing the F key (or starting with --forecast) to + Unlike hledger, hledger-ui hides all future-dated transactions by de- + fault. They can be revealed, along with any rule-generated periodic + transactions, by pressing the F key (or starting with --forecast) to enable "forecast mode". OPTIONS - Any QUERYARGS are interpreted as a hledger search query which filters + Any QUERYARGS are interpreted as a hledger search query which filters the data. hledger-ui provides the following options: @@ -61,7 +61,7 @@ OPTIONS start in the (first) matched account's register screen --change - show period balances (changes) at startup instead of historical + show period balances (changes) at startup instead of historical balances -l --flat @@ -70,7 +70,7 @@ OPTIONS -t --tree show accounts as a tree - hledger-ui also supports many of hledger's general options (and the + hledger-ui also supports many of hledger's general options (and the hledger manual's command line tips also apply here): General help options @@ -93,7 +93,7 @@ OPTIONS $LEDGER_FILE or $HOME/.hledger.journal) --rules-file=RULESFILE - Conversion rules file to use when reading CSV (default: + Conversion rules file to use when reading CSV (default: FILE.rules) --separator=CHAR @@ -112,7 +112,7 @@ OPTIONS assignments) -s --strict - do extra error checking (check that all posted accounts are de- + do extra error checking (check that all posted accounts are de- clared) General reporting options @@ -140,7 +140,7 @@ OPTIONS multiperiod/multicolumn report by year -p --period=PERIODEXP - set start date, end date, and/or reporting interval all at once + set start date, end date, and/or reporting interval all at once using period expressions syntax --date2 @@ -148,7 +148,7 @@ OPTIONS fects) --today=DATE - override today's date (affects relative smart dates, for + override today's date (affects relative smart dates, for tests/examples) -U --unmarked @@ -167,21 +167,21 @@ OPTIONS hide/aggregate accounts or postings more than NUM levels deep -E --empty - show items with zero amount, normally hidden (and vice-versa in + show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) -B --cost convert amounts to their cost/selling amount at transaction time -V --market - convert amounts to their market value in default valuation com- + convert amounts to their market value in default valuation com- modities -X --exchange=COMM convert amounts to their market value in commodity COMM --value - convert amounts to cost or market value, more flexibly than + convert amounts to cost or market value, more flexibly than -B/-V/-X --infer-equity @@ -191,32 +191,32 @@ OPTIONS infer costs from conversion equity postings --infer-market-prices - use costs as additional market prices, as if they were P direc- + use costs as additional market prices, as if they were P direc- tives --forecast - generate transactions from periodic rules, between the latest - recorded txn and 6 months from today, or during the specified - PERIOD (= is required). Auto posting rules will be applied to - these transactions as well. Also, in hledger-ui make future- - dated transactions visible. + generate transactions from periodic rules, between the latest + recorded txn and 6 months from today, or during the specified + PERIOD (= is required). Auto posting rules will be applied to + these transactions as well. Also, in hledger-ui make fu- + ture-dated transactions visible. - --auto generate extra postings by applying auto posting rules to all + --auto generate extra postings by applying auto posting rules to all txns (not just forecast txns) --verbose-tags - add visible tags indicating transactions or postings which have + add visible tags indicating transactions or postings which have been generated/modified --commodity-style - Override the commodity style in the output for the specified + Override the commodity style in the output for the specified commodity. For example 'EUR1.000,00'. --color=WHEN (or --colour=WHEN) - Should color-supporting commands use ANSI color codes in text - output. 'auto' (default): whenever stdout seems to be a color- - supporting terminal. 'always' or 'yes': always, useful eg when - piping output into 'less -R'. 'never' or 'no': never. A + Should color-supporting commands use ANSI color codes in text + output. 'auto' (default): whenever stdout seems to be a + color-supporting terminal. 'always' or 'yes': always, useful eg + when piping output into 'less -R'. 'never' or 'no': never. A NO_COLOR environment variable overrides this. --pretty[=WHEN] @@ -257,22 +257,22 @@ KEYS that.) With shift pressed, the cursor keys adjust the report period, limiting - the transactions to be shown (by default, all are shown). SHIFT- - DOWN/UP steps downward and upward through these standard report period - durations: year, quarter, month, week, day. Then, SHIFT-LEFT/RIGHT - moves to the previous/next period. T sets the report period to today. - With the -w/--watch option, when viewing a "current" period (the cur- - rent day, week, month, quarter, or year), the period will move automat- - ically to track the current date. To set a non-standard period, you - can use / and a date: query. + the transactions to be shown (by default, all are shown). + SHIFT-DOWN/UP steps downward and upward through these standard report + period durations: year, quarter, month, week, day. Then, + SHIFT-LEFT/RIGHT moves to the previous/next period. T sets the report + period to today. With the -w/--watch option, when viewing a "current" + period (the current day, week, month, quarter, or year), the period + will move automatically to track the current date. To set a non-stan- + dard period, you can use / and a date: query. - (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 cur- + (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 cur- rent terminal profile on the left, click Keyboard on the right, click + - and add this for Shift-Down: \033[1;2B, click + and add this for Shift- - Up: \033[1;2A. Press the Escape key to enter the \033 part, you can't - type it directly.) + and add this for Shift-Down: \033[1;2B, click + and add this for + Shift-Up: \033[1;2A. Press the Escape key to enter the \033 part, you + can't type it directly.) / 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 @@ -446,8 +446,8 @@ SCREENS show them until you exit and re-enter it. So eg to see the effect of using the E key, currently you must: - press E, edit and save the file, then exit the editor, returning to hledger-ui - press g to reload the - file (or use -w/--watch mode) - press LEFT then RIGHT to exit and re- - enter the transaction screen. + file (or use -w/--watch mode) - press LEFT then RIGHT to exit and + re-enter the transaction screen. Error This screen will appear if there is a problem, such as a parse error, @@ -537,4 +537,4 @@ LICENSE SEE ALSO hledger(1), hledger-ui(1), hledger-web(1), ledger(1) -hledger-ui-1.32.99 December 2023 HLEDGER-UI(1) +hledger-ui-1.32.99 January 2024 HLEDGER-UI(1) diff --git a/hledger-web/.date.m4 b/hledger-web/.date.m4 index bd0cdfe8d..fbc3c51ab 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_}}, {{December 2023}})m4_dnl +m4_define({{_monthyear_}}, {{January 2024}})m4_dnl diff --git a/hledger-web/hledger-web.1 b/hledger-web/hledger-web.1 index 21375856c..16609c107 100644 --- a/hledger-web/hledger-web.1 +++ b/hledger-web/hledger-web.1 @@ -1,34 +1,34 @@ -.TH "HLEDGER-WEB" "1" "December 2023" "hledger-web-1.32.99 " "hledger User Manuals" +.TH "HLEDGER\-WEB" "1" "January 2024" "hledger-web-1.32.99 " "hledger User Manuals" .SH NAME -hledger-web - robust, friendly plain text accounting (Web version) +hledger\-web \- robust, friendly plain text accounting (Web version) .SH SYNOPSIS -\f[CR]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[CR]hledger web -- [--serve|--serve-api] [OPTS] [ARGS]\f[R] +\f[CR]hledger web \-\- [\-\-serve|\-\-serve\-api] [OPTS] [ARGS]\f[R] .SH DESCRIPTION This manual is for hledger\[aq]s web interface, version 1.32.99. See also the hledger manual for common concepts and file formats. .PP -hledger is a robust, user-friendly, cross-platform set of programs for -tracking money, time, or any other commodity, using double-entry +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. hledger is inspired by and largely compatible with ledger(1), and largely interconvertible with beancount(1). .PP -hledger-web is a simple web application for browsing and adding +hledger\-web is a simple web application for browsing and adding transactions. -It provides a more user-friendly UI than the hledger CLI or hledger-ui +It provides a more user\-friendly UI than the hledger CLI or hledger\-ui TUI, showing more at once (accounts, the current account register, -balance charts) and allowing history-aware data entry, interactive +balance charts) and allowing history\-aware data entry, interactive searching, and bookmarking. .PP -hledger-web also lets you share a journal with multiple users, or even +hledger\-web also lets you share a journal with multiple users, or even the public web. There is no access control, so if you need that you should put it behind a suitable web proxy. @@ -39,260 +39,262 @@ every edit. Like hledger, it reads from (and appends to) a journal file specified by 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. +\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.) +(See hledger(1) \-> Input for details.) .PP -hledger-web can be run in three modes: +hledger\-web can be run in three modes: .IP \[bu] 2 Transient mode (the default): your default web browser will be opened to 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[CR]--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[CR]--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 +In all cases hledger\-web runs as a foreground process, logging requests to stdout. .SH OPTIONS -hledger-web provides the following options: +hledger\-web provides the following options: .TP -\f[CR]--serve\f[R] -serve and log requests, don\[aq]t browse or auto-exit after timeout +\f[CR]\-\-serve\f[R] +serve and log requests, don\[aq]t browse or auto\-exit after timeout .TP -\f[CR]--serve-api\f[R] -like --serve, but serve only the JSON web API, not the web UI +\f[CR]\-\-serve\-api\f[R] +like \-\-serve, but serve only the JSON web API, not the web UI .TP -\f[CR]--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[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). +permissions from the \f[CR]X\-Sandstorm\-Permissions\f[R] request +header). .TP -\f[CR]--cors=ORIGIN\f[R] -allow cross-origin requests from the specified origin; setting ORIGIN to -\[dq]*\[dq] allows requests from any origin +\f[CR]\-\-cors=ORIGIN\f[R] +allow cross\-origin requests from the specified origin; setting ORIGIN +to \[dq]*\[dq] allows requests from any origin .TP -\f[CR]--host=IPADDR\f[R] +\f[CR]\-\-host=IPADDR\f[R] listen on this IP address (default: 127.0.0.1) .PP By default the server listens on IP address \f[CR]127.0.0.1\f[R], which is accessible only to requests from the local machine.. -You can use \f[CR]--host\f[R] to listen on a different address +You can use \f[CR]\-\-host\f[R] to listen on a different address configured on the machine, eg to allow access from other machines. The special address \f[CR]0.0.0.0\f[R] causes it to listen on all addresses configured on the machine. .TP -\f[CR]--port=PORT\f[R] +\f[CR]\-\-port=PORT\f[R] listen on this TCP port (default: 5000) .PP -Similarly, you can use \f[CR]--port\f[R] to listen on a TCP port other +Similarly, you can use \f[CR]\-\-port\f[R] to listen on a TCP port other than 5000. -This is useful if you want to run multiple hledger-web instances on a +This is useful if you want to run multiple hledger\-web instances on a machine. .TP -\f[CR]--socket=SOCKETFILE\f[R] +\f[CR]\-\-socket=SOCKETFILE\f[R] listen on the given unix socket instead of an IP address and port (unix -only; implies --serve) +only; implies \-\-serve) .PP -When \f[CR]--socket\f[R] is used, hledger-web creates and communicates -via a socket file instead of a TCP port. +When \f[CR]\-\-socket\f[R] is used, hledger\-web creates and +communicates via a socket file instead of a TCP port. This can be more secure, respects unix file permissions, and makes -certain use cases easier, such as running per-user instances behind an +certain use cases easier, such as running per\-user instances behind an nginx reverse proxy. (Eg: \f[CR]proxy_pass http://unix:/tmp/hledger/${remote_user}.socket;\f[R].) .TP -\f[CR]--base-url=URL\f[R] +\f[CR]\-\-base\-url=URL\f[R] set the base url (default: http://IPADDR:PORT). .PP -You can use \f[CR]--base-url\f[R] to change the protocol, hostname, port -and path that appear in hledger-web\[aq]s hyperlinks. -This is useful eg when integrating hledger-web within a larger website. +You can use \f[CR]\-\-base\-url\f[R] to change the protocol, hostname, +port and path that appear in hledger\-web\[aq]s hyperlinks. +This is useful eg when integrating hledger\-web within a larger website. 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). Note this affects url generation but not route parsing. .TP -\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 +\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 -hledger-web also supports many of hledger\[aq]s general options. +hledger\-web also supports many of hledger\[aq]s general options. Query options and arguments may be used to set an initial filter, which although not shown in the UI, will restrict the data shown, in addition to any search query entered in the UI. .SS General help options .TP -\f[CR]-h --help\f[R] +\f[CR]\-h \-\-help\f[R] show general or COMMAND help .TP -\f[CR]--man\f[R] +\f[CR]\-\-man\f[R] show general or COMMAND user manual with man .TP -\f[CR]--info\f[R] +\f[CR]\-\-info\f[R] show general or COMMAND user manual with info .TP -\f[CR]--version\f[R] +\f[CR]\-\-version\f[R] show general or ADDONCMD version .TP -\f[CR]--debug[=N]\f[R] -show debug output (levels 1-9, default: 1) +\f[CR]\-\-debug[=N]\f[R] +show debug output (levels 1\-9, default: 1) .SS General input options .TP -\f[CR]-f FILE --file=FILE\f[R] +\f[CR]\-f FILE \-\-file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[CR]$LEDGER_FILE\f[R] or +For stdin, use \- (default: \f[CR]$LEDGER_FILE\f[R] or \f[CR]$HOME/.hledger.journal\f[R]) .TP -\f[CR]--rules-file=RULESFILE\f[R] +\f[CR]\-\-rules\-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP -\f[CR]--separator=CHAR\f[R] +\f[CR]\-\-separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[CR]--alias=OLD=NEW\f[R] +\f[CR]\-\-alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[CR]--anon\f[R] +\f[CR]\-\-anon\f[R] anonymize accounts and payees .TP -\f[CR]--pivot FIELDNAME\f[R] +\f[CR]\-\-pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[CR]-I --ignore-assertions\f[R] +\f[CR]\-I \-\-ignore\-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[CR]-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[CR]-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[CR]-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[CR]-D --daily\f[R] +\f[CR]\-D \-\-daily\f[R] multiperiod/multicolumn report by day .TP -\f[CR]-W --weekly\f[R] +\f[CR]\-W \-\-weekly\f[R] multiperiod/multicolumn report by week .TP -\f[CR]-M --monthly\f[R] +\f[CR]\-M \-\-monthly\f[R] multiperiod/multicolumn report by month .TP -\f[CR]-Q --quarterly\f[R] +\f[CR]\-Q \-\-quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[CR]-Y --yearly\f[R] +\f[CR]\-Y \-\-yearly\f[R] multiperiod/multicolumn report by year .TP -\f[CR]-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[CR]--date2\f[R] +\f[CR]\-\-date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[CR]--today=DATE\f[R] +\f[CR]\-\-today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[CR]-U --unmarked\f[R] -include only unmarked postings/txns (can combine with -P or -C) +\f[CR]\-U \-\-unmarked\f[R] +include only unmarked postings/txns (can combine with \-P or \-C) .TP -\f[CR]-P --pending\f[R] +\f[CR]\-P \-\-pending\f[R] include only pending postings/txns .TP -\f[CR]-C --cleared\f[R] +\f[CR]\-C \-\-cleared\f[R] include only cleared postings/txns .TP -\f[CR]-R --real\f[R] -include only non-virtual postings +\f[CR]\-R \-\-real\f[R] +include only non\-virtual postings .TP -\f[CR]-NUM --depth=NUM\f[R] +\f[CR]\-NUM \-\-depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[CR]-E --empty\f[R] -show items with zero amount, normally hidden (and vice-versa in -hledger-ui/hledger-web) +\f[CR]\-E \-\-empty\f[R] +show items with zero amount, normally hidden (and vice\-versa in +hledger\-ui/hledger\-web) .TP -\f[CR]-B --cost\f[R] +\f[CR]\-B \-\-cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[CR]-V --market\f[R] +\f[CR]\-V \-\-market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[CR]-X --exchange=COMM\f[R] +\f[CR]\-X \-\-exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[CR]--value\f[R] -convert amounts to cost or market value, more flexibly than -B/-V/-X +\f[CR]\-\-value\f[R] +convert amounts to cost or market value, more flexibly than \-B/\-V/\-X .TP -\f[CR]--infer-equity\f[R] +\f[CR]\-\-infer\-equity\f[R] infer conversion equity postings from costs .TP -\f[CR]--infer-costs\f[R] +\f[CR]\-\-infer\-costs\f[R] infer costs from conversion equity postings .TP -\f[CR]--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[CR]--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. +Also, in hledger\-ui make future\-dated transactions visible. .TP -\f[CR]--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[CR]--verbose-tags\f[R] +\f[CR]\-\-verbose\-tags\f[R] add visible tags indicating transactions or postings which have been generated/modified .TP -\f[CR]--commodity-style\f[R] +\f[CR]\-\-commodity\-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP -\f[CR]--color=WHEN (or --colour=WHEN)\f[R] -Should color-supporting commands use ANSI color codes in text output. -\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting -terminal. +\f[CR]\-\-color=WHEN (or \-\-colour=WHEN)\f[R] +Should color\-supporting commands use ANSI color codes in text output. +\[aq]auto\[aq] (default): whenever stdout seems to be a +color\-supporting terminal. \[aq]always\[aq] or \[aq]yes\[aq]: always, useful eg when piping output -into \[aq]less -R\[aq]. +into \[aq]less \-R\[aq]. \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[CR]--pretty[=WHEN]\f[R] +\f[CR]\-\-pretty[=WHEN]\f[R] Show prettier output, e.g. -using unicode box-drawing characters. +using unicode box\-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], \[aq]n\[aq], \[aq]always\[aq], \[aq]never\[aq] also work). If you provide an argument you must use \[aq]=\[aq], e.g. -\[aq]--pretty=yes\[aq]. +\[aq]\-\-pretty=yes\[aq]. .PP When a reporting option appears more than once in the command line, the last one takes precedence. .PP Some reporting options can also be written as query arguments. .SH PERMISSIONS -By default, hledger-web allows anyone who can reach it to view the +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[CR]--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 @@ -302,22 +304,24 @@ custom firewall rules .PP You can restrict what the users who reach it can do, by .IP \[bu] 2 -using the \f[CR]--capabilities=CAP[,CAP..]\f[R] flag when you start it, -enabling one or more of the following capabilities. +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[CR]view,add\f[R]: .RS 2 .IP \[bu] 2 -\f[CR]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[CR]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[CR]manage\f[R] - allows editing, uploading or downloading the main or -included files +\f[CR]manage\f[R] \- allows editing, uploading or downloading the main +or included files .RE .IP \[bu] 2 -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 +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 @@ -330,35 +334,35 @@ any files it includes. Note, unlike any other hledger command, in this mode you (or any visitor) can alter or wipe the data files. .PP -Normally whenever a file is changed in this way, hledger-web saves a +Normally whenever a file is changed in this way, hledger\-web saves a numbered backup (assuming file permissions allow it, the disk is not full, etc.) -hledger-web is not aware of version control systems, currently; if you +hledger\-web is not aware of version control systems, currently; if you use one, you\[aq]ll have to arrange to commit the changes yourself (eg with a cron job or a file watcher like entr). .PP -Changes which would leave the journal file(s) unparseable or non-valid +Changes which would leave the journal file(s) unparseable or non\-valid (eg with failing balance assertions) are prevented. (Probably. -This needs re-testing.) +This needs re\-testing.) .SH RELOADING -hledger-web detects changes made to the files by other means (eg if you -edit it directly, outside of hledger-web), and it will show the new data -when you reload the page or navigate to a new page. -If a change makes a file unparseable, hledger-web will display an error +hledger\-web detects changes made to the files by other means (eg if you +edit it directly, outside of hledger\-web), and it will show the new +data when you reload the page or navigate to a new page. +If a change makes a file unparseable, hledger\-web will display an error message until the file has been fixed. .PP (Note: if you are viewing files mounted from another machine, make sure that both machine clocks are roughly in step.) .SH JSON API -In addition to the web UI, hledger-web also serves a JSON API that can +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[CR]--serve-api\f[R] +If you want the JSON API only, you can use the \f[CR]\-\-serve\-api\f[R] flag. Eg: .IP .EX -$ hledger-web -f examples/sample.journal --serve-api +$ hledger\-web \-f examples/sample.journal \-\-serve\-api \&... .EE .PP @@ -375,11 +379,11 @@ You can get JSON data from these routes: .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): +(hledger\-web\[aq]s JSON does not include newlines, here we use python +to prettify it): .IP .EX -$ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool +$ curl \-s http://127.0.0.1:5000/accountnames | python \-m json.tool [ \[dq]assets\[dq], \[dq]assets:bank\[dq], @@ -400,12 +404,12 @@ $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool Or all transactions: .IP .EX -$ curl -s http://127.0.0.1:5000/transactions | python -m json.tool +$ curl \-s http://127.0.0.1:5000/transactions | python \-m json.tool [ { \[dq]tcode\[dq]: \[dq]\[dq], \[dq]tcomment\[dq]: \[dq]\[dq], - \[dq]tdate\[dq]: \[dq]2008-01-01\[dq], + \[dq]tdate\[dq]: \[dq]2008\-01\-01\[dq], \[dq]tdate2\[dq]: null, \[dq]tdescription\[dq]: \[dq]income\[dq], \[dq]tindex\[dq]: 1, @@ -436,21 +440,21 @@ 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[CR]/add\f[R], if hledger-web was started with the \f[CR]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[CR]/transactions\f[R] +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: +hledger\-lib, eg like so: .IP .EX -\&.../hledger$ stack ghci hledger-lib +\&.../hledger$ stack ghci hledger\-lib >>> writeJsonFile \[dq]txn.json\[dq] (head $ jtxns samplejournal) >>> :q .EE .PP -Here\[aq]s how it looks as of hledger-1.17 (remember, this JSON +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 .EX @@ -496,9 +500,9 @@ corresponds to hledger\[aq]s Transaction and related data types): \[dq]aprice\[dq]: null, \[dq]acommodity\[dq]: \[dq]$\[dq], \[dq]aquantity\[dq]: { - \[dq]floatingPoint\[dq]: -1, + \[dq]floatingPoint\[dq]: \-1, \[dq]decimalPlaces\[dq]: 10, - \[dq]decimalMantissa\[dq]: -10000000000 + \[dq]decimalMantissa\[dq]: \-10000000000 }, \[dq]aismultiplier\[dq]: false, \[dq]astyle\[dq]: { @@ -531,7 +535,7 @@ corresponds to hledger\[aq]s Transaction and related data types): ] ] }, - \[dq]tdate\[dq]: \[dq]2008-01-01\[dq], + \[dq]tdate\[dq]: \[dq]2008\-01\-01\[dq], \[dq]tcode\[dq]: \[dq]\[dq], \[dq]tindex\[dq]: 1, \[dq]tprecedingcomment\[dq]: \[dq]\[dq], @@ -545,11 +549,11 @@ And here\[aq]s how to test adding it with curl. This should add a new entry to your journal: .IP .EX -$ curl http://127.0.0.1:5000/add -X PUT -H \[aq]Content-Type: application/json\[aq] --data-binary \[at]txn.json +$ curl http://127.0.0.1:5000/add \-X PUT \-H \[aq]Content\-Type: application/json\[aq] \-\-data\-binary \[at]txn.json .EE .SH DEBUG OUTPUT .SS Debug output -You can add \f[CR]--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 @@ -561,10 +565,10 @@ stderr, eg: .PD 0 .P .PD -\f[CR]hledger-web --debug=3 2>hledger-web.log\f[R]. +\f[CR]hledger\-web \-\-debug=3 2>hledger\-web.log\f[R]. .SH ENVIRONMENT \f[B]LEDGER_FILE\f[R] The main journal file to use when not specified -with \f[CR]-f/--file\f[R]. +with \f[CR]\-f/\-\-file\f[R]. Default: \f[CR]$HOME/.hledger.journal\f[R]. .SH BUGS We welcome bug reports in the hledger issue tracker (shortcut: @@ -573,7 +577,7 @@ http://bugs.hledger.org), or on the #hledger chat or hledger mail list .PP Some known issues: .PP -Does not work well on small screens, or in text-mode browsers. +Does not work well on small screens, or in text\-mode browsers. .SH AUTHORS diff --git a/hledger-web/hledger-web.info b/hledger-web/hledger-web.info index 418aec9b5..6cd9600b8 100644 --- a/hledger-web/hledger-web.info +++ b/hledger-web/hledger-web.info @@ -1,4 +1,4 @@ -This is hledger-web.info, produced by makeinfo version 7.0.3 from stdin. +This is hledger-web.info, produced by makeinfo version 7.1 from stdin. INFO-DIR-SECTION User Applications START-INFO-DIR-ENTRY @@ -631,31 +631,31 @@ http://bugs.hledger.org), or on the #hledger chat or hledger mail list  Tag Table: -Node: Top225 -Node: OPTIONS2580 -Ref: #options2685 -Node: General help options5259 -Ref: #general-help-options5409 -Node: General input options5691 -Ref: #general-input-options5877 -Node: General reporting options6579 -Ref: #general-reporting-options6744 -Node: PERMISSIONS10134 -Ref: #permissions10273 -Node: EDITING UPLOADING DOWNLOADING11485 -Ref: #editing-uploading-downloading11666 -Node: RELOADING12500 -Ref: #reloading12634 -Node: JSON API13067 -Ref: #json-api13182 -Node: DEBUG OUTPUT18670 -Ref: #debug-output18795 -Node: Debug output18822 -Ref: #debug-output-118923 -Node: ENVIRONMENT19340 -Ref: #environment19459 -Node: BUGS19576 -Ref: #bugs19660 +Node: Top223 +Node: OPTIONS2578 +Ref: #options2683 +Node: General help options5257 +Ref: #general-help-options5407 +Node: General input options5689 +Ref: #general-input-options5875 +Node: General reporting options6577 +Ref: #general-reporting-options6742 +Node: PERMISSIONS10132 +Ref: #permissions10271 +Node: EDITING UPLOADING DOWNLOADING11483 +Ref: #editing-uploading-downloading11664 +Node: RELOADING12498 +Ref: #reloading12632 +Node: JSON API13065 +Ref: #json-api13180 +Node: DEBUG OUTPUT18668 +Ref: #debug-output18793 +Node: Debug output18820 +Ref: #debug-output-118921 +Node: ENVIRONMENT19338 +Ref: #environment19457 +Node: BUGS19574 +Ref: #bugs19658  End Tag Table diff --git a/hledger-web/hledger-web.txt b/hledger-web/hledger-web.txt index c21f449b5..010f464c8 100644 --- a/hledger-web/hledger-web.txt +++ b/hledger-web/hledger-web.txt @@ -238,8 +238,8 @@ OPTIONS 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. + these transactions as well. Also, in hledger-ui make fu- + ture-dated transactions visible. --auto generate extra postings by applying auto posting rules to all txns (not just forecast txns) @@ -254,15 +254,15 @@ OPTIONS --color=WHEN (or --colour=WHEN) Should color-supporting commands use ANSI color codes in text - output. 'auto' (default): whenever stdout seems to be a color- - supporting terminal. 'always' or 'yes': always, useful eg when - piping output into 'less -R'. 'never' or 'no': never. A + output. 'auto' (default): whenever stdout seems to be a + color-supporting terminal. 'always' or 'yes': always, useful eg + when piping output into 'less -R'. 'never' or 'no': never. A NO_COLOR environment variable overrides this. --pretty[=WHEN] - Show prettier output, e.g. using unicode box-drawing charac- - ters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', - 'never' also work). If you provide an argument you must use + Show prettier output, e.g. using unicode box-drawing charac- + ters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', + 'never' also work). If you provide an argument you must use '=', e.g. '--pretty=yes'. When a reporting option appears more than once in the command line, the @@ -271,13 +271,13 @@ OPTIONS Some reporting options can also be written as query arguments. PERMISSIONS - By default, hledger-web allows anyone who can reach it to view the + 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. You can restrict who can reach it by - o setting the IP address it listens on (see --host above). By default - it listens on 127.0.0.1, accessible to all users on the local ma- + o setting the IP address it listens on (see --host above). By default + it listens on 127.0.0.1, accessible to all users on the local ma- chine. o putting it behind an authenticating proxy, using eg apache or nginx @@ -287,44 +287,44 @@ PERMISSIONS You can restrict what the users who reach it can do, by o using the --capabilities=CAP[,CAP..] flag when you start it, enabling - one or more of the following capabilities. The default value is + one or more of the following capabilities. The default value is view,add: o view - allows viewing the journal file and all included files o add - allows adding new transactions to the main journal file - o manage - allows editing, uploading or downloading the main or in- + o manage - allows editing, uploading or downloading the main or in- cluded files - o using the --capabilities-header=HTTPHEADER flag to specify a HTTP - header from which it will read capabilities to enable. hledger-web - on Sandstorm uses the X-Sandstorm-Permissions header to integrate + o using the --capabilities-header=HTTPHEADER flag to specify a HTTP + header from which it will read capabilities to enable. hledger-web + on Sandstorm uses the X-Sandstorm-Permissions header to integrate with Sandstorm's permissions. This is disabled by default. EDITING, UPLOADING, DOWNLOADING - If you enable the manage capability mentioned above, you'll see a new - "spanner" button to the right of the search form. Clicking this will - let you edit, upload, or download the journal file or any files it in- + If you enable the manage capability mentioned above, you'll see a new + "spanner" button to the right of the search form. Clicking this will + let you edit, upload, or download the journal file or any files it in- cludes. - Note, unlike any other hledger command, in this mode you (or any visi- + Note, unlike any other hledger command, in this mode you (or any visi- tor) can alter or wipe the data files. - Normally whenever a file is changed in this way, hledger-web saves a - numbered backup (assuming file permissions allow it, the disk is not - full, etc.) hledger-web is not aware of version control systems, cur- - rently; if you use one, you'll have to arrange to commit the changes + Normally whenever a file is changed in this way, hledger-web saves a + numbered backup (assuming file permissions allow it, the disk is not + full, etc.) hledger-web is not aware of version control systems, cur- + rently; if you use one, you'll have to arrange to commit the changes yourself (eg with a cron job or a file watcher like entr). - Changes which would leave the journal file(s) unparseable or non-valid - (eg with failing balance assertions) are prevented. (Probably. This + Changes which would leave the journal file(s) unparseable or non-valid + (eg with failing balance assertions) are prevented. (Probably. This needs re-testing.) RELOADING hledger-web detects changes made to the files by other means (eg if you - edit it directly, outside of hledger-web), and it will show the new - data when you reload the page or navigate to a new page. If a change + edit it directly, outside of hledger-web), and it will show the new + data when you reload the page or navigate to a new page. If a change makes a file unparseable, hledger-web will display an error message un- til the file has been fixed. @@ -332,8 +332,8 @@ RELOADING that both machine clocks are roughly in step.) JSON API - 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 + In addition to the web UI, hledger-web also serves a JSON API that can + be used to get data or add new transactions. If you want the JSON API only, you can use the --serve-api flag. Eg: $ hledger-web -f examples/sample.journal --serve-api @@ -350,7 +350,7 @@ JSON API /accounttransactions/ACCOUNTNAME Eg, all account names in the journal (similar to the accounts command). - (hledger-web's JSON does not include newlines, here we use python to + (hledger-web's JSON does not include newlines, here we use python to prettify it): $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool @@ -391,25 +391,25 @@ JSON API "aprice": null, ... - Most of the JSON corresponds to hledger's data types; for details of - what the fields mean, see the Hledger.Data.Json haddock docs and click - on the various data types, eg Transaction. And for a higher level un- + Most of the JSON corresponds to hledger's data types; for details of + what the fields mean, see the Hledger.Data.Json haddock docs and click + on the various data types, eg Transaction. And for a higher level un- derstanding, see the journal docs. In some cases there is outer JSON corresponding to a "Report" type. To - understand that, go to the Hledger.Web.Handler.MiscR haddock and look - at the source for the appropriate handler to see what it returns. Eg + understand that, go to the Hledger.Web.Handler.MiscR haddock and look + at the source for the appropriate handler to see what it returns. Eg for /accounttransactions it's getAccounttransactionsR, returning a "ac- - countTransactionsReport ...". Looking up the haddock for that we can - see that /accounttransactions returns an AccountTransactionsReport, - which consists of a report title and a list of AccountTransactionsRe- + countTransactionsReport ...". Looking up the haddock for that we can + see that /accounttransactions returns an AccountTransactionsReport, + which consists of a report title and a list of AccountTransactionsRe- portItem (etc). - You can add a new transaction to the journal with a PUT request to - /add, if hledger-web was started with the add capability (enabled by + You can add a new transaction to the journal with a PUT request to + /add, if hledger-web was started with the add capability (enabled by default). The payload must be the full, exact JSON representation of a - hledger transaction (partial data won't do). You can get sample JSON - from hledger-web's /transactions or /accounttransactions, or you can + hledger transaction (partial data won't do). You can get sample JSON + from hledger-web's /transactions or /accounttransactions, or you can export it with hledger-lib, eg like so: .../hledger$ stack ghci hledger-lib @@ -505,28 +505,28 @@ JSON API "tstatus": "Unmarked" } - And here's how to test adding it with curl. This should add a new en- + And here's how to test adding it with curl. This should add a new en- try to your journal: $ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json DEBUG OUTPUT Debug output - You can add --debug[=N] to the command line to log debug output. N + You can add --debug[=N] to the command line to log debug output. N ranges from 1 (least output, the default) to 9 (maximum output). Typi- - cally you would start with 1 and increase until you are seeing enough. - Debug output goes to stderr, interleaved with the requests logged on + cally you would start with 1 and increase until you are seeing enough. + Debug output goes to stderr, interleaved with the requests logged on stdout. To capture debug output in a log file instead, you can usually redirect stderr, eg: hledger-web --debug=3 2>hledger-web.log. ENVIRONMENT - LEDGER_FILE The main journal file to use when not specified with + LEDGER_FILE The main journal file to use when not specified with -f/--file. Default: $HOME/.hledger.journal. 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: @@ -551,4 +551,4 @@ LICENSE SEE ALSO hledger(1), hledger-ui(1), hledger-web(1), ledger(1) -hledger-web-1.32.99 December 2023 HLEDGER-WEB(1) +hledger-web-1.32.99 January 2024 HLEDGER-WEB(1) diff --git a/hledger/.date.m4 b/hledger/.date.m4 index bd0cdfe8d..fbc3c51ab 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_}}, {{December 2023}})m4_dnl +m4_define({{_monthyear_}}, {{January 2024}})m4_dnl diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 036c1d077..168ee3400 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -1,11 +1,11 @@ .\"t -.TH "HLEDGER" "1" "December 2023" "hledger-1.32.99 " "hledger User Manuals" +.TH "HLEDGER" "1" "January 2024" "hledger-1.32.99 " "hledger User Manuals" .SH NAME -hledger - robust, friendly plain text accounting (CLI version) +hledger \- robust, friendly plain text accounting (CLI version) .SH SYNOPSIS \f[CR]hledger\f[R] .PD 0 @@ -15,10 +15,10 @@ hledger - robust, friendly plain text accounting (CLI version) .PD 0 .P .PD -\f[CR]hledger ADDONCMD -- [OPTS] [ARGS]\f[R] +\f[CR]hledger ADDONCMD \-\- [OPTS] [ARGS]\f[R] .SH DESCRIPTION -hledger is a robust, user-friendly, cross-platform set of programs for -tracking money, time, or any other commodity, using double-entry +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. hledger is inspired by and largely compatible with ledger(1), and largely interconvertible with beancount(1). @@ -38,27 +38,27 @@ You can also get it from hledger itself with .PD 0 .P .PD -\f[CR]hledger --man\f[R], \f[CR]hledger --info\f[R] or +\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[CR]hledger-*\f[R] executables as extra -subcommands. +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[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. +\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 .EX -2015-10-16 bought food +2015\-10\-16 bought food expenses:food $10 assets:cash .EE @@ -75,10 +75,10 @@ are outflow from it (\f[I]credit\f[R]). negative numbers as a result; this is normal.) .PP hledger\[cq]s add command can help you add transactions, or you can -install other data entry UIs like hledger-web or hledger-iadd. +install other data entry UIs like hledger\-web or hledger\-iadd. 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). +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[CR]hledger add\f[R] and follow the prompts, or save some entries like the above in \f[CR]$HOME/.hledger.journal\f[R], @@ -86,7 +86,7 @@ then try commands like: .PD 0 .P .PD -\f[CR]hledger print -x\f[R] +\f[CR]hledger print \-x\f[R] .PD 0 .P .PD @@ -112,10 +112,10 @@ balances\[dq] sections in PART 5: COMMON TASKS. .SH PART 1: USER INTERFACE .SH Input hledger reads one or more data files, each time you run it. -You can specify a file with \f[CR]-f\f[R], like so +You can specify a file with \f[CR]\-f\f[R], like so .IP .EX -$ hledger -f FILE print +$ hledger \-f FILE print .EE .PP Files are most often in hledger\[aq]s journal format, with the @@ -174,7 +174,7 @@ T} T{ \f[CR]csv\f[R] T}@T{ -CSV/SSV/TSV/character-separated values, for data import +CSV/SSV/TSV/character\-separated values, for data import T}@T{ \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] @@ -187,7 +187,7 @@ hledger detects the format automatically based on the file extensions shown above. If it can\[aq]t recognise the file extension, it assumes \f[CR]journal\f[R] format. -So for non-journal files, it\[aq]s important to use a recognised file +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. .PP @@ -196,23 +196,23 @@ with the format and a colon. Eg, to read a .dat file as csv format: .IP .EX -$ hledger -f csv:/some/csv-file.dat stats +$ hledger \-f csv:/some/csv\-file.dat stats .EE .SS Standard input -The file name \f[CR]-\f[R] means standard input: +The file name \f[CR]\-\f[R] means standard input: .IP .EX -$ cat FILE | hledger -f- print +$ cat FILE | hledger \-f\- print .EE .PP -If reading non-journal data in this way, you\[aq]ll need to add a file +If reading non\-journal data in this way, you\[aq]ll need to add a file format prefix, like: .IP .EX -$ echo \[aq]i 2009/13/1 08:00:00\[aq] | hledger print -f timeclock:- +$ echo \[aq]i 2009/13/1 08:00:00\[aq] | hledger print \-f timeclock:\- .EE .SS Multiple files -You can specify multiple \f[CR]-f\f[R] options, to read multiple files +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: @@ -226,7 +226,7 @@ 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[CR]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 hledger checks input files for valid data. By default, the most important errors are detected, while still @@ -238,8 +238,8 @@ Are all transactions balanced ? .IP \[bu] 2 Do all balance assertions pass ? .PP -With the \f[CR]-s\f[R]/\f[CR]--strict\f[R] flag, additional checks are -performed: +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[CR]account\f[R] directive ? @@ -250,7 +250,7 @@ Are all commodities declared with a \f[CR]commodity\f[R] directive ? .IP \[bu] 2 Are all commodity conversions declared explicitly ? .PP -You can use the check command to run individual checks -- the ones +You can use the check command to run individual checks \-\- the ones listed above and some more. .SH Commands hledger provides various subcommands for getting things done. @@ -267,9 +267,9 @@ To use a particular command, run 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[CR]hledger print -x\f[R]. +CMDOPTS are command\-specific options, if any. +Command\-specific options must be written after the command name. +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 @@ -277,194 +277,195 @@ the data in some way. 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[CR]hledger CMD -h\f[R]. -Eg: \f[CR]hledger bal -h\f[R]. -.SS Add-on commands -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], +terminal, run \f[CR]hledger CMD \-h\f[R]. +Eg: \f[CR]hledger bal \-h\f[R]. +.SS Add\-on commands +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. -If you used the hledger-install script, you will have several add-ons +If you used the hledger\-install script, you will have several add\-ons installed already. Some more can be found in hledger\[aq]s bin/ directory, documented at https://hledger.org/scripts.html. .PP -More precisely, add-on commands are programs or scripts in your -shell\[aq]s PATH, whose name starts with \[dq]hledger-\[dq] and ends +More precisely, add\-on commands are programs or scripts in your +shell\[aq]s PATH, whose name starts with \[dq]hledger\-\[dq] and ends with no extension or a recognised extension (\[dq].bat\[dq], \[dq].com\[dq], \[dq].exe\[dq], \[dq].hs\[dq], \[dq].js\[dq], \[dq].lhs\[dq], \[dq].lua\[dq], \[dq].php\[dq], \[dq].pl\[dq], \[dq].py\[dq], \[dq].rb\[dq], \[dq].rkt\[dq], or \[dq].sh\[dq]), and (on 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[CR]hledger ADDONCMD [-- ADDONCMDOPTS] [ADDONCMDARGS]\f[R]. -But note the double hyphen argument, required before add-on-specific +You can run add\-on commands using hledger, much like built\-in +commands: +\f[CR]hledger ADDONCMD [\-\- ADDONCMDOPTS] [ADDONCMDARGS]\f[R]. +But note the double hyphen argument, required before add\-on\-specific options. -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[CR]hledger\f[R]: \f[CR]hledger-ui --watch\f[R] or -\f[CR]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[CR]hledger\f[R]: \f[CR]hledger\-ui \-\-watch\f[R] or +\f[CR]hledger\-web \-\-serve\f[R]. .SH Options -Run \f[CR]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[CR]-h --help\f[R] +\f[CR]\-h \-\-help\f[R] show general or COMMAND help .TP -\f[CR]--man\f[R] +\f[CR]\-\-man\f[R] show general or COMMAND user manual with man .TP -\f[CR]--info\f[R] +\f[CR]\-\-info\f[R] show general or COMMAND user manual with info .TP -\f[CR]--version\f[R] +\f[CR]\-\-version\f[R] show general or ADDONCMD version .TP -\f[CR]--debug[=N]\f[R] -show debug output (levels 1-9, default: 1) +\f[CR]\-\-debug[=N]\f[R] +show debug output (levels 1\-9, default: 1) .SS General input options .TP -\f[CR]-f FILE --file=FILE\f[R] +\f[CR]\-f FILE \-\-file=FILE\f[R] use a different input file. -For stdin, use - (default: \f[CR]$LEDGER_FILE\f[R] or +For stdin, use \- (default: \f[CR]$LEDGER_FILE\f[R] or \f[CR]$HOME/.hledger.journal\f[R]) .TP -\f[CR]--rules-file=RULESFILE\f[R] +\f[CR]\-\-rules\-file=RULESFILE\f[R] Conversion rules file to use when reading CSV (default: FILE.rules) .TP -\f[CR]--separator=CHAR\f[R] +\f[CR]\-\-separator=CHAR\f[R] Field separator to expect when reading CSV (default: \[aq],\[aq]) .TP -\f[CR]--alias=OLD=NEW\f[R] +\f[CR]\-\-alias=OLD=NEW\f[R] rename accounts named OLD to NEW .TP -\f[CR]--anon\f[R] +\f[CR]\-\-anon\f[R] anonymize accounts and payees .TP -\f[CR]--pivot FIELDNAME\f[R] +\f[CR]\-\-pivot FIELDNAME\f[R] use some other field or tag for the account name .TP -\f[CR]-I --ignore-assertions\f[R] +\f[CR]\-I \-\-ignore\-assertions\f[R] disable balance assertion checks (note: does not disable balance assignments) .TP -\f[CR]-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[CR]-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[CR]-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[CR]-D --daily\f[R] +\f[CR]\-D \-\-daily\f[R] multiperiod/multicolumn report by day .TP -\f[CR]-W --weekly\f[R] +\f[CR]\-W \-\-weekly\f[R] multiperiod/multicolumn report by week .TP -\f[CR]-M --monthly\f[R] +\f[CR]\-M \-\-monthly\f[R] multiperiod/multicolumn report by month .TP -\f[CR]-Q --quarterly\f[R] +\f[CR]\-Q \-\-quarterly\f[R] multiperiod/multicolumn report by quarter .TP -\f[CR]-Y --yearly\f[R] +\f[CR]\-Y \-\-yearly\f[R] multiperiod/multicolumn report by year .TP -\f[CR]-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[CR]--date2\f[R] +\f[CR]\-\-date2\f[R] match the secondary date instead (see command help for other effects) .TP -\f[CR]--today=DATE\f[R] +\f[CR]\-\-today=DATE\f[R] override today\[aq]s date (affects relative smart dates, for tests/examples) .TP -\f[CR]-U --unmarked\f[R] -include only unmarked postings/txns (can combine with -P or -C) +\f[CR]\-U \-\-unmarked\f[R] +include only unmarked postings/txns (can combine with \-P or \-C) .TP -\f[CR]-P --pending\f[R] +\f[CR]\-P \-\-pending\f[R] include only pending postings/txns .TP -\f[CR]-C --cleared\f[R] +\f[CR]\-C \-\-cleared\f[R] include only cleared postings/txns .TP -\f[CR]-R --real\f[R] -include only non-virtual postings +\f[CR]\-R \-\-real\f[R] +include only non\-virtual postings .TP -\f[CR]-NUM --depth=NUM\f[R] +\f[CR]\-NUM \-\-depth=NUM\f[R] hide/aggregate accounts or postings more than NUM levels deep .TP -\f[CR]-E --empty\f[R] -show items with zero amount, normally hidden (and vice-versa in -hledger-ui/hledger-web) +\f[CR]\-E \-\-empty\f[R] +show items with zero amount, normally hidden (and vice\-versa in +hledger\-ui/hledger\-web) .TP -\f[CR]-B --cost\f[R] +\f[CR]\-B \-\-cost\f[R] convert amounts to their cost/selling amount at transaction time .TP -\f[CR]-V --market\f[R] +\f[CR]\-V \-\-market\f[R] convert amounts to their market value in default valuation commodities .TP -\f[CR]-X --exchange=COMM\f[R] +\f[CR]\-X \-\-exchange=COMM\f[R] convert amounts to their market value in commodity COMM .TP -\f[CR]--value\f[R] -convert amounts to cost or market value, more flexibly than -B/-V/-X +\f[CR]\-\-value\f[R] +convert amounts to cost or market value, more flexibly than \-B/\-V/\-X .TP -\f[CR]--infer-equity\f[R] +\f[CR]\-\-infer\-equity\f[R] infer conversion equity postings from costs .TP -\f[CR]--infer-costs\f[R] +\f[CR]\-\-infer\-costs\f[R] infer costs from conversion equity postings .TP -\f[CR]--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[CR]--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. +Also, in hledger\-ui make future\-dated transactions visible. .TP -\f[CR]--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[CR]--verbose-tags\f[R] +\f[CR]\-\-verbose\-tags\f[R] add visible tags indicating transactions or postings which have been generated/modified .TP -\f[CR]--commodity-style\f[R] +\f[CR]\-\-commodity\-style\f[R] Override the commodity style in the output for the specified commodity. For example \[aq]EUR1.000,00\[aq]. .TP -\f[CR]--color=WHEN (or --colour=WHEN)\f[R] -Should color-supporting commands use ANSI color codes in text output. -\[aq]auto\[aq] (default): whenever stdout seems to be a color-supporting -terminal. +\f[CR]\-\-color=WHEN (or \-\-colour=WHEN)\f[R] +Should color\-supporting commands use ANSI color codes in text output. +\[aq]auto\[aq] (default): whenever stdout seems to be a +color\-supporting terminal. \[aq]always\[aq] or \[aq]yes\[aq]: always, useful eg when piping output -into \[aq]less -R\[aq]. +into \[aq]less \-R\[aq]. \[aq]never\[aq] or \[aq]no\[aq]: never. A NO_COLOR environment variable overrides this. .TP -\f[CR]--pretty[=WHEN]\f[R] +\f[CR]\-\-pretty[=WHEN]\f[R] Show prettier output, e.g. -using unicode box-drawing characters. +using unicode box\-drawing characters. Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq], \[aq]n\[aq], \[aq]always\[aq], \[aq]never\[aq] also work). If you provide an argument you must use \[aq]=\[aq], e.g. -\[aq]--pretty=yes\[aq]. +\[aq]\-\-pretty=yes\[aq]. .PP When a reporting option appears more than once in the command line, the last one takes precedence. @@ -476,13 +477,13 @@ Here are some details useful to know about for hledger command lines Feel free to skip this section until you need it. .SS Option repetition If options are repeated in a command line, hledger will generally use -the last (right-most) occurence. +the last (right\-most) occurence. .SS Special characters .SS Single escaping (shell metacharacters) -In shell command lines, characters significant to your shell - such as +In shell command lines, characters significant to your shell \- such as 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. +\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: @@ -502,15 +503,15 @@ 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) -Characters significant in regular expressions (described below) - such +Characters significant in regular expressions (described below) \- such 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 +\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. +typically also a shell metacharacter, both shell\-escaping and +regex\-escaping will be needed. Eg to match a literal \f[CR]$\f[R] sign while using the bash shell: .IP .EX @@ -522,13 +523,13 @@ or: .EX $ hledger balance cur:\[rs]\[rs]$ .EE -.SS Triple escaping (for add-on commands) -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. +.SS Triple escaping (for add\-on commands) +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[CR]$\f[R] sign while using the bash shell and -running an add-on command (\f[CR]ui\f[R]): +running an add\-on command (\f[CR]ui\f[R]): .IP .EX $ hledger ui cur:\[aq]\[rs]\[rs]$\[aq] @@ -556,56 +557,56 @@ T}@T{ \f[CR]\[rs]$\f[R] T} T{ -double-escaped: +double\-escaped: T}@T{ \f[CR]\[rs]\[rs]$\f[R] T} T{ -triple-escaped: +triple\-escaped: T}@T{ \f[CR]\[rs]\[rs]\[rs]\[rs]$\f[R] T} .TE .PP -Or, you can avoid the extra escaping by running the add-on executable +Or, you can avoid the extra escaping by running the add\-on executable directly: .IP .EX -$ hledger-ui cur:\[rs]\[rs]$ +$ hledger\-ui cur:\[rs]\[rs]$ .EE .SS Less escaping Options and arguments are sometimes used in places other than the shell -command line, where shell-escaping is not needed, so there you should +command line, where shell\-escaping is not needed, so there you should use one less level of escaping. Those places include: .IP \[bu] 2 an \[at]argumentfile .IP \[bu] 2 -hledger-ui\[aq]s filter field +hledger\-ui\[aq]s filter field .IP \[bu] 2 -hledger-web\[aq]s search form +hledger\-web\[aq]s search form .IP \[bu] 2 GHCI\[aq]s prompt (used by developers). .SS Unicode characters -hledger is expected to handle non-ascii characters correctly: +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, -by all hledger tools (add, iadd, hledger-web\[aq]s search/add/edit +by all hledger tools (add, iadd, hledger\-web\[aq]s search/add/edit forms, etc.) .IP \[bu] 2 -they should be displayed correctly by all hledger tools, and on-screen +they should be displayed correctly by all hledger tools, and on\-screen alignment should be preserved. .PP -This requires a well-configured environment. +This requires a well\-configured environment. Here are some tips: .IP \[bu] 2 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[CR]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). +This step is essential \- without it, hledger will quit on encountering +a non\-ascii character (as with all GHC\-compiled programs). .IP \[bu] 2 your terminal software (eg Terminal.app, iTerm, CMD.exe, xterm..) must support unicode @@ -627,12 +628,12 @@ A regular expression (regexp) is a small piece of text where certain 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. +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[CR]/\f[R] search, +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). @@ -642,7 +643,7 @@ Account name queries (quoted for command line use): .IP .EX Regular expression: Matches: -------------------- ------------------------------------------------------------ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- bank assets:bank, assets:bank:savings, expenses:art:banksy, ... :bank assets:bank:savings, expenses:art:banksy :bank: assets:bank:savings @@ -665,8 +666,8 @@ 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 +cur:....? amounts with 4\-or\-more\-character symbols +tag:.=202[1\-3] things with any tag whose value contains 2021, 2022 or 2023 .EE .PP Account name aliases: accept \f[CR].\f[R] instead of \f[CR]:\f[R] as @@ -676,23 +677,23 @@ account separator: alias /\[rs]./=: replaces all periods in account names with colons .EE .PP -Show multiple top-level accounts combined as one: +Show multiple top\-level accounts combined as one: .IP .EX ---alias=\[aq]/\[ha][\[ha]:]+/=combined\[aq] ( [\[ha]:] matches any character other than : ) +\-\-alias=\[aq]/\[ha][\[ha]:]+/=combined\[aq] ( [\[ha]:] matches any character other than : ) .EE .PP -Show accounts with the second-level part removed: +Show accounts with the second\-level part removed: .IP .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 +\-\-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] .EE .PP -CSV rules: match CSV records containing dining-related MCC codes: +CSV rules: match CSV records containing dining\-related MCC codes: .IP .EX if \[rs]?MCC581[124] @@ -705,7 +706,7 @@ if %amount \[rs]b3\[rs].99 & %date (29|30|31|01|02|03)$ .EE .SS hledger\[aq]s regular expressions -hledger\[aq]s regular expressions come from the regex-tdfa library. +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: .IP "1." 3 @@ -731,13 +732,14 @@ above. .PP Some things to note: .IP \[bu] 2 -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]). +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[CR]$\f[R] as a literal character, prepend a backslash. -Eg to search for amounts with the dollar sign in hledger-web, write +Eg to search for amounts with the dollar sign in hledger\-web, write \f[CR]cur:\[rs]$\f[R]. .IP \[bu] 2 On the command line, some metacharacters like \f[CR]$\f[R] have a @@ -766,13 +768,13 @@ $ hledger print > foo.txt .EE .PP Some commands (print, register, stats, the balance commands) also -provide the \f[CR]-o/--output-file\f[R] option, which does the same +provide the \f[CR]\-o/\-\-output\-file\f[R] option, which does the same thing without needing the shell. Eg: .IP .EX -$ hledger print -o foo.txt -$ hledger print -o - # write to stdout (the default) +$ hledger print \-o foo.txt +$ hledger print \-o \- # write to stdout (the default) .EE .SS Output format Some commands offer other kinds of output, not just text on the @@ -783,7 +785,7 @@ Here are those commands and the formats currently supported: tab(@); lw(16.1n) lw(14.5n) lw(14.5n) lw(16.1n) lw(4.8n) lw(4.0n). T{ -- +\- T}@T{ txt T}@T{ @@ -893,31 +895,31 @@ T}@T{ T} .TE .IP \[bu] 2 -\f[I]1 Also affected by the balance commands\[aq] \f[CI]--layout\f[I] +\f[I]1 Also affected by the balance commands\[aq] \f[CI]\-\-layout\f[I] option.\f[R] .IP \[bu] 2 \f[I]2 \f[CI]balance\f[I] does not support html output without a report -interval or with \f[CI]--budget\f[I].\f[R] +interval or with \f[CI]\-\-budget\f[I].\f[R] .PP -The output format is selected by the \f[CR]-O/--output-format=FMT\f[R] -option: +The output format is selected by the +\f[CR]\-O/\-\-output\-format=FMT\f[R] option: .IP .EX -$ hledger print -O csv # print CSV on stdout +$ hledger print \-O csv # print CSV on stdout .EE .PP or by the filename extension of an output file specified with the -\f[CR]-o/--output-file=FILE.FMT\f[R] option: +\f[CR]\-o/\-\-output\-file=FILE.FMT\f[R] option: .IP .EX -$ hledger balancesheet -o foo.csv # write CSV to foo.csv +$ hledger balancesheet \-o foo.csv # write CSV to foo.csv .EE .PP -The \f[CR]-O\f[R] option can be combined with \f[CR]-o\f[R] to override -the file extension, if needed: +The \f[CR]\-O\f[R] option can be combined with \f[CR]\-o\f[R] to +override the file extension, if needed: .IP .EX -$ hledger balancesheet -o foo.txt -O csv # write CSV to foo.txt +$ hledger balancesheet \-o foo.txt \-O csv # write CSV to foo.txt .EE .PP Some notes about the various output formats: @@ -931,17 +933,17 @@ 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 -This is not yet much used; real-world feedback is welcome. +This is not yet much used; real\-world feedback is welcome. .IP \[bu] 2 Our JSON is rather large and verbose, since it is a faithful representation of hledger\[aq]s internal data types. To understand the JSON, read the Haskell type definitions, which are mostly in -https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs. +https://github.com/simonmichael/hledger/blob/master/hledger\-lib/Hledger/Data/Types.hs. .IP \[bu] 2 hledger represents quantities as Decimal values storing up to 255 significant digits, eg for repeating decimals. -Such numbers can arise in practice (from automatically-calculated +Such numbers can arise in practice (from automatically\-calculated transaction prices), and would break most JSON consumers. So in JSON, we show quantities as simple Numbers with at most 10 decimal places. @@ -952,7 +954,7 @@ otherwise, please let us know. (Cf #1195) .SS SQL output .IP \[bu] 2 -This is not yet much used; real-world feedback is welcome. +This is not yet much used; real\-world feedback is welcome. .IP \[bu] 2 SQL output is expected to work at least with SQLite, MySQL and Postgres. .IP \[bu] 2 @@ -962,7 +964,7 @@ Eg: .RS 2 .IP .EX -$ hledger print -O sql | sed \[aq]s/id serial/id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL/g\[aq] | ... +$ hledger print \-O sql | sed \[aq]s/id serial/id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL/g\[aq] | ... .EE .RE .IP \[bu] 2 @@ -976,15 +978,15 @@ completely as otherwise your postings will be duped. 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[CR]-c/--commodity-style\f[R] -option (except for cost amounts and amounts displayed by the -\f[CR]print\f[R] command, which are always displayed with all decimal -digits). +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[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 .EX -$ hledger print -c \[aq]$1.000,0\[aq] +$ hledger print \-c \[aq]$1.000,0\[aq] .EE .PP This option can repeated to set the display style for multiple @@ -994,7 +996,7 @@ Its argument is as described in the commodity directive. In terminal output, some commands can produce colour when the terminal supports it: .IP \[bu] 2 -if the \f[CR]--color/--colour\f[R] option is given a value of +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 @@ -1003,12 +1005,12 @@ colour will not be used; .IP \[bu] 2 otherwise, colour will be used if the output (terminal or file) supports it. -.SS Box-drawing -In terminal output, you can enable unicode box-drawing characters to +.SS Box\-drawing +In terminal output, you can enable unicode box\-drawing characters to render prettier tables: .IP \[bu] 2 -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 +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. @@ -1023,10 +1025,10 @@ specifically, .IP \[bu] 2 when listing commands, with \f[CR]hledger\f[R] .IP \[bu] 2 -when showing help with \f[CR]hledger [CMD] --help\f[R], +when showing help with \f[CR]hledger [CMD] \-\-help\f[R], .IP \[bu] 2 when viewing manuals with \f[CR]hledger help\f[R] or -\f[CR]hledger --man\f[R]. +\f[CR]hledger \-\-man\f[R]. .PP Note the pager is expected to handle ANSI codes, which hledger uses eg for bold emphasis. @@ -1040,21 +1042,21 @@ to disable all ANSI output (see Colour). .SS Debug output We intend hledger to be relatively easy to troubleshoot, introspect and develop. -You can add \f[CR]--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[CR]-o/--output-file\f[R] (unless you redirect stderr to stdout, eg: -\f[CR]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 .EX -hledger bal --debug=3 2>hledger.log +hledger bal \-\-debug=3 2>hledger.log .EE .SH Environment These environment variables affect hledger: @@ -1064,16 +1066,16 @@ 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[CR]-f/--file\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[CR]--color/--colour\f[R] option. +overridden by an explicit \f[CR]\-\-color/\-\-colour\f[R] option. .SH PART 2: DATA FORMATS .SH Journal hledger\[aq]s default file format, representing a General Journal. -Here\[aq]s a cheatsheet/mini-tutorial, or you can skip ahead to About +Here\[aq]s a cheatsheet/mini\-tutorial, or you can skip ahead to About journal format. .SS Journal cheatsheet .IP @@ -1093,7 +1095,7 @@ These lines are commented. end comment -# Some but not all hledger entries can have same-line comments attached to them, +# Some but not all hledger entries can have same\-line comments attached to them, # from ; (semicolon) to end of line. ############################################################################### @@ -1104,11 +1106,11 @@ account actifs ; type:A, declare an account that is an Asset. 2+ spaces befo account passifs ; type:L, declare an account that is a Liability, and so on.. (ALERX) alias chkg = assets:checking commodity $0.00 -decimal-mark . +decimal\-mark . include /dev/null payee Whole Foods -P 2022-01-01 AAAA $1.40 -\[ti] monthly budget goals ; <- 2+ spaces between period expression and description +P 2022\-01\-01 AAAA $1.40 +\[ti] monthly budget goals ; <\- 2+ spaces between period expression and description expenses:food $400 expenses:home $1000 budgeted @@ -1119,52 +1121,52 @@ P 2022-01-01 AAAA $1.40 # They begin with a date. # DATE DESCRIPTION ; This is a transaction comment. -# ACCOUNT NAME 1 AMOUNT1 ; <- posting 1. This is a posting comment. -# ACCOUNT NAME 2 AMOUNT2 ; <- posting 2. Postings must be indented. +# ACCOUNT NAME 1 AMOUNT1 ; <\- posting 1. This is a posting comment. +# ACCOUNT NAME 2 AMOUNT2 ; <\- posting 2. Postings must be indented. # ; \[ha]\[ha] At least 2 spaces between account and amount. # ... ; Any number of postings is allowed. The amounts must balance (sum to 0). -2022-01-01 opening balances are declared this way +2022\-01\-01 opening balances are declared this way assets:checking $1000 ; Account names can be anything. lower case is easy to type. assets:savings $1000 ; assets, liabilities, equity, revenues, expenses are common. assets:cash:wallet $100 ; : indicates subaccounts. - liabilities:credit card $-200 ; liabilities, equity, revenues balances are usually negative. - equity ; One amount can be left blank; $-1900 is inferred here. + liabilities:credit card $\-200 ; liabilities, equity, revenues balances are usually negative. + equity ; One amount can be left blank; $\-1900 is inferred here. -2022-04-15 * (#12345) pay taxes +2022\-04\-15 * (#12345) pay taxes ; There can be a ! or * after the date meaning \[dq]pending\[dq] or \[dq]cleared\[dq]. ; There can be a transaction code (text in parentheses) after the date/status. ; Amounts\[aq] sign represents direction of flow, or credit/debit: - assets:checking $-500 ; minus means removed from this account (credit) + assets:checking $\-500 ; minus means removed from this account (credit) expenses:tax:us:2021 $500 ; plus means added to this account (debit) ; revenue/expense categories are also \[dq]accounts\[dq] -2022-01-01 ; The description is optional. +2022\-01\-01 ; The description is optional. ; Any currency/commodity symbols are allowed, on either side. - assets:cash:wallet GBP -10 + assets:cash:wallet GBP \-10 expenses:clothing GBP 10 - assets:gringotts -10 gold + assets:gringotts \-10 gold assets:pouch 10 gold - revenues:gifts -2 \[dq]Liquorice Wands\[dq] ; Complex symbols - assets:bag 2 \[dq]Liquorice Wands\[dq] ; must be double-quoted. + revenues:gifts \-2 \[dq]Liquorice Wands\[dq] ; Complex symbols + assets:bag 2 \[dq]Liquorice Wands\[dq] ; must be double\-quoted. -2022-01-01 Cost in another commodity can be noted with \[at] or \[at]\[at] - assets:investments 2.0 AAAA \[at] $1.50 ; \[at] means per-unit cost +2022\-01\-01 Cost in another commodity can be noted with \[at] or \[at]\[at] + assets:investments 2.0 AAAA \[at] $1.50 ; \[at] means per\-unit cost assets:investments 3.0 AAAA \[at]\[at] $4 ; \[at]\[at] means total cost - assets:checking $-7.00 + assets:checking $\-7.00 -2022-01-02 assert balances +2022\-01\-02 assert balances ; Balances can be asserted for extra error checking, in any transaction. assets:investments 0 AAAA = 5.0 AAAA assets:pouch 0 gold = 10 gold assets:savings $0 = $1000 -1999-12-31 Ordering transactions by date is recommended but not required. +1999\-12\-31 Ordering transactions by date is recommended but not required. ; Postings are not required. 2022.01.01 These date 2022/1/1 formats are -12/31 also allowed (but consistent YYYY-MM-DD is recommended). +12/31 also allowed (but consistent YYYY\-MM\-DD is recommended). .EE .SS About journal format hledger\[aq]s usual data source is a plain text file containing journal @@ -1190,9 +1192,10 @@ the add or web or import commands to create and update it. .PP Many users, though, edit the journal file with a text editor, and track changes with a version control system such as git. -Editor addons such as ledger-mode or hledger-mode for Emacs, vim-ledger -for Vim, and hledger-vscode for Visual Studio Code, make this easier, -adding colour, formatting, tab completion, and useful commands. +Editor addons such as ledger\-mode or hledger\-mode for Emacs, +vim\-ledger for Vim, and hledger\-vscode for Visual Studio Code, make +this easier, adding colour, formatting, tab completion, and useful +commands. See Editor configuration at hledger.org for the full list. .PP Here\[aq]s a description of each part of the file format (and @@ -1209,7 +1212,7 @@ 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[CR]#\f[R] for top-level notes +\f[CR]#\f[R] for top\-level notes .IP \[bu] 2 \f[CR];\f[R] for commenting out things temporarily .IP \[bu] 2 @@ -1222,13 +1225,13 @@ Eg: # a comment line ; another commentline comment -A multi-line comment block, +A multi\-line comment block, continuing until \[dq]end comment\[dq] directive or the end of the current file. end comment .EE .PP -Some hledger entries can have same-line comments attached to them, from +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 @@ -1252,24 +1255,24 @@ and any following indented lines beginning with a semicolon) .IP \[bu] 2 0 or more indented \f[I]posting\f[R] lines, describing what was transferred and the accounts involved (indented comment lines are also -allowed, but not blank lines or non-indented lines). +allowed, but not blank lines or non\-indented lines). .PP Here\[aq]s a simple journal file containing one transaction: .IP .EX 2008/01/01 income assets:bank:checking $1 - income:salary $-1 + income:salary $\-1 .EE .SS Dates .SS Simple dates Dates in the journal file use \f[I]simple dates\f[R] format: -\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. +\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[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], +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 @@ -1290,13 +1293,13 @@ reconciliation: .EE .IP .EX -$ hledger -f t.j register food -2015-05-30 expenses:food $10 $10 +$ hledger \-f t.j register food +2015\-05\-30 expenses:food $10 $10 .EE .IP .EX -$ hledger -f t.j register checking -2015-06-01 assets:checking $-10 $-10 +$ hledger \-f t.j register checking +2015\-06\-01 assets:checking $\-10 $\-10 .EE .PP DATE should be a simple date; if the year is not specified it will use @@ -1339,24 +1342,24 @@ T} .TE .PP When reporting, you can filter by status with the -\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]\-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. +keys in hledger\-ui. .PP Note, in Ledger and in older versions of hledger, the \[dq]unmarked\[dq] state is called \[dq]uncleared\[dq]. As of hledger 1.3 we have renamed it to unmarked for clarity. .PP To replicate Ledger and old hledger\[aq]s behaviour of also matching -pending, combine -U and -P. +pending, combine \-U and \-P. .PP Status marks are optional, but can be helpful eg for reconciling with -real-world accounts. +real\-world accounts. Some editor modes provide highlighting and shortcuts for working with status. -Eg in Emacs ledger-mode, you can toggle transaction status with C-c C-e, -or posting status with C-c C-c. +Eg in Emacs ledger\-mode, you can toggle transaction status with C\-c +C\-e, or posting status with C\-c C\-c. .PP What \[dq]uncleared\[dq], \[dq]pending\[dq], and \[dq]cleared\[dq] actually mean is up to you. @@ -1388,10 +1391,10 @@ complete, reconciled as far as possible, and considered correct T} .TE .PP -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 +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. +up\-to\-date state of your finances. .SS Code After the status mark, but before the description, you can optionally write a transaction \[dq]code\[dq], enclosed in parentheses. @@ -1417,7 +1420,7 @@ They are reproduced by \f[CR]print\f[R] but otherwise ignored, except they may contain tags, which are not ignored. .IP .EX -2012-01-01 something ; a transaction comment +2012\-01\-01 something ; a transaction comment ; a second line of transaction comment expenses 1 assets @@ -1443,8 +1446,8 @@ The amounts within a transaction must always sum up to zero. As a convenience, one amount may be left blank; it will be inferred so as to balance the transaction. .PP -Be sure to note the unusual two-space delimiter between account name and -amount. +Be sure to note the unusual two\-space delimiter between account name +and amount. 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. @@ -1526,12 +1529,12 @@ $1 .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 +the default), The sign can be written before or after a left\-side commodity symbol: .IP .EX --$1 -$-1 +\-$1 +$\-1 .EE .PP One or more spaces between the sign and the number are acceptable when @@ -1539,13 +1542,13 @@ parsing (but they won\[aq]t be displayed in output): .IP .EX + $1 -$- 1 +$\- 1 .EE .PP Scientific E notation is allowed: .IP .EX -1E-6 +1E\-6 EUR 1E3 .EE .SS Decimal marks, digit group marks @@ -1557,7 +1560,7 @@ A \f[I]decimal mark\f[R] can be written as a period or a comma: .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] - +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 .EX @@ -1575,7 +1578,7 @@ 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[CR]decimal-mark\f[R] +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 @@ -1584,35 +1587,35 @@ decimal number, and a \[dq]commodity\[dq], which is a currency symbol, stock ticker, or any word or phrase describing something you are tracking. .PP -If the commodity name contains non-letters (spaces, numbers, or +If the commodity name contains non\-letters (spaces, numbers, or punctuation), you must always write it inside double quotes (\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[CR]\[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 +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: +A multi\-commodity amount could be, eg: \f[CR]1 USD, 2 EUR, 3.456 TSLA\f[R]. -In practice, you will only see multi-commodity amounts in hledger\[aq]s +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[CR]Amount\f[R] and \f[CR]MixedAmount\f[R] types.) .SS Directives influencing number parsing and display -You can add \f[CR]decimal-mark\f[R] and \f[CR]commodity\f[R] directives +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 .EX # the decimal mark character used by all amounts in this file (all commodities) -decimal-mark . +decimal\-mark . -# display styles for the $, EUR, INR and no-symbol commodities: +# display styles for the $, EUR, INR and no\-symbol commodities: commodity $1,000.00 commodity EUR 1.000,00 commodity INR 9,99,99,999.00 @@ -1627,7 +1630,7 @@ This is inferred as follows: .PP 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. +no\-symbol amounts in the journal. .PP Then each commodity\[aq]s display style is determined from its \f[CR]commodity\f[R] directive. @@ -1653,12 +1656,12 @@ 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[CR]-c/--commodity-style\f[R] command line option. +\f[CR]\-c/\-\-commodity\-style\f[R] command line option. .SS Rounding Amounts are stored internally as decimal numbers with up to 255 decimal places. They are displayed with their original journal precisions by print and -print-like reports, and rounded to their display precision (the number +print\-like reports, and rounded to their display precision (the number of decimal digits specified by the commodity display style) by other reports. When rounding, hledger uses banker\[aq]s rounding (it rounds to the @@ -1680,7 +1683,7 @@ could be a purchase or a sale.) .PP 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. +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. .PP @@ -1695,7 +1698,7 @@ amount: .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 + assets:dollars ; balancing amount is \-$135.00 .EE .RE .IP "2." 3 @@ -1719,21 +1722,21 @@ making it \f[CR]€100 \[at]\[at] $135\f[R], as in example 2: .EX 2009/1/1 assets:euros €100 ; one hundred euros purchased - assets:dollars $-135 ; for $135 + assets:dollars $\-135 ; for $135 .EE .RE .PP Amounts can be converted to cost at report time using the -\f[CR]-B/--cost\f[R] flag; this is discussed more in the Cost reporting -section. +\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 not required to be. -This can be a little confusing, see discussion at --infer-market-prices: -market prices from transactions. +This can be a little confusing, see discussion at +\-\-infer\-market\-prices: market prices from transactions. .SS Other cost/lot notations A slight digression for Ledger and Beancount users. -Ledger has a number of cost/lot-related notations: +Ledger has a number of cost/lot\-related notations: .IP \[bu] 2 \f[CR]\[at] UNITCOST\f[R] and \f[CR]\[at]\[at] TOTALCOST\f[R] .RS 2 @@ -1825,13 +1828,13 @@ expresses the selling price for transaction balancing Currently, hledger accepts the \f[CR]{UNITCOST}\f[R]/\f[CR]{{TOTALCOST}}\f[R] notation but ignores it. .IP \[bu] 2 -variations: \f[CR]{}\f[R], \f[CR]{YYYY-MM-DD}\f[R], +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. +\f[CR]{UNITCOST, YYYY\-MM\-DD, \[dq]LABEL\[dq]}\f[R] etc. .PP Currently, hledger rejects these. .SS Balance assertions -hledger supports Ledger-style balance assertions in journal files. +hledger supports Ledger\-style balance assertions in journal files. 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 @@ -1840,11 +1843,11 @@ each posting: .EX 2013/1/1 a $1 =$1 - b =$-1 + b =$\-1 2013/1/2 a $1 =$2 - b $-1 =$-2 + b $\-1 =$\-2 .EE .PP After reading a journal file, hledger will check all balance assertions @@ -1852,7 +1855,7 @@ and report an error if any of them fail. Balance assertions can protect you from, eg, inadvertently disrupting reconciled balances while cleaning up old entries. You can disable them temporarily with the -\f[CR]-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). @@ -1865,12 +1868,12 @@ order. postings to the same account within a transaction.) .PP So, hledger balance assertions keep working if you reorder -differently-dated transactions within the journal. -But if you reorder same-dated transactions or postings, assertions might -break and require updating. +differently\-dated transactions within the journal. +But if you reorder same\-dated transactions or postings, assertions +might break and require updating. This order dependence does bring an advantage: precise control over the order of postings and assertions within a day, so you can assert -intra-day balances. +intra\-day balances. .SS Assertions and multiple included files Multiple files included with the \f[CR]include\f[R] directive are processed as if concatenated into one file, preserving their order and @@ -1880,11 +1883,11 @@ earlier files. .PP And if you have multiple postings to an account on the same day, split 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 - +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 +.SS Assertions and multiple \-f files 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 +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. @@ -1892,9 +1895,9 @@ disrupt valid assertions in later files. If you do want assertions to see balance from earlier files, use \f[CR]include\f[R], or concatenate the files temporarily. .SS Assertions and commodities -The asserted balance must be a simple single-commodity amount, and in +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. +(possibly multi\-commodity) account balance. This is how assertions work in Ledger also. We could call this a \[dq]partial\[dq] balance assertion. .PP @@ -1910,14 +1913,14 @@ the asserted one (or at least, that their balance is 0). 2013/1/1 a $1 a 1€ - b $-1 - c -1€ + b $\-1 + c \-1€ 2013/1/2 ; These assertions succeed a 0 = $1 a 0 = 1€ - b 0 == $-1 - c 0 == -1€ + b 0 == $\-1 + c 0 == \-1€ 2013/1/3 ; This assertion fails as \[aq]a\[aq] also contains 1€ a 0 == $1 @@ -1969,21 +1972,21 @@ You can assert the balance including subaccounts by writing .EE .SS Assertions and virtual postings Balance assertions always consider both real and virtual postings; they -are not affected by the \f[CR]--real/-R\f[R] flag or \f[CR]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 -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. +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[CR]--auto\f[R], and always use -\f[CR]--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[CR]--auto\f[R], and never -use \f[CR]--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). @@ -2000,7 +2003,7 @@ They are reproduced by \f[CR]print\f[R] but otherwise ignored, except they may contain tags, which are not ignored. .IP .EX -2012-01-01 +2012\-01\-01 expenses 1 ; a comment for posting 1 assets ; a comment for posting 2 @@ -2021,9 +2024,9 @@ two on the transaction, and one on the expenses posting: .EX account assets:checking ; accounttag: -2017/1/16 bought groceries ; transactiontag-1: - ; transactiontag-2: - assets:checking $-1 +2017/1/16 bought groceries ; transactiontag\-1: + ; transactiontag\-2: + assets:checking $\-1 expenses:food $1 ; postingtag: .EE .PP @@ -2053,7 +2056,7 @@ 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[CR]hledger tags TAGNAME --values\f[R], or match by tag value with a +\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 Besides transactions, there is something else you can put in a @@ -2093,7 +2096,7 @@ T} T{ Declare file\[aq]s decimal mark, to help parse amounts accurately T}@T{ -\f[CR]decimal-mark\f[R] +\f[CR]decimal\-mark\f[R] T} T{ Include other data files @@ -2148,22 +2151,22 @@ T} 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. +files if any, until the end of the current file \- and no further. You might find this inconvenient! For example, \f[CR]alias\f[R] directives do not affect parent or sibling files. But there are usually workarounds; for example, put \f[CR]alias\f[R] -directives in your top-most file, before including other files. +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; it allows reports to be stable and deterministic, independent of the 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. +of \-f options, or the positions of include directives in your files. .SS Directive effects Here are all hledger\[aq]s directives, with their effects and scope -summarised - nine main directives, plus four others which we consider -non-essential: +summarised \- nine main directives, plus four others which we consider +non\-essential: .PP .TS tab(@); @@ -2190,7 +2193,7 @@ T{ T}@T{ Rewrites account names, in following entries until end of current file or \f[CR]end aliases\f[R]. -Command line equivalent: \f[CR]--alias\f[R] +Command line equivalent: \f[CR]\-\-alias\f[R] T}@T{ Y T} @@ -2209,21 +2212,21 @@ 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[CR]decimal-mark\f[R] directive) 3. +\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 +which is also the precision to use for balanced\-transaction checking in this commodity. 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] +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[CB]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[CR]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[CR]commodity\f[R] and \f[CR]D\f[R]. @@ -2235,7 +2238,7 @@ T{ T}@T{ Includes entries and directives from another file, as if they were written inline. -Command line alternative: multiple \f[CR]-f/--file\f[R] +Command line alternative: multiple \f[CR]\-f/\-\-file\f[R] T}@T{ N T} @@ -2258,8 +2261,8 @@ T{ \f[B]\f[CB]\[ti]\f[B]\f[R] (tilde) T}@T{ Declares a periodic transaction rule that generates future transactions -with \f[CR]--forecast\f[R] and budget goals with -\f[CR]balance --budget\f[R]. +with \f[CR]\-\-forecast\f[R] and budget goals with +\f[CR]balance \-\-budget\f[R]. T}@T{ N T} @@ -2279,7 +2282,7 @@ T} T{ \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 +Sets a default commodity to use for no\-symbol amounts;and, if there is no \f[CR]commodity\f[R] directive for this commodity: its decimal mark, balancing precision, and display style, as above. T}@T{ @@ -2297,8 +2300,8 @@ T{ \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[CR]--auto\f[R], in current, parent, and child files -(but not sibling files, see #1212). +transactions with \f[CR]\-\-auto\f[R], in current, parent, and child +files (but not sibling files, see #1212). T}@T{ partly T} @@ -2320,11 +2323,11 @@ reference. In strict mode, they restrict which accounts may be posted to by transactions, which helps detect typos. .IP \[bu] 2 -They control account display order in reports, allowing non-alphabetic +They control account display order in reports, allowing non\-alphabetic sorting (eg Revenues to appear above Expenses). .IP \[bu] 2 -They help with account name completion (in hledger add, hledger-web, -hledger-iadd, ledger-mode, etc.) +They help with account name completion (in hledger add, hledger\-web, +hledger\-iadd, ledger\-mode, etc.) .IP \[bu] 2 They can store additional account information as comments, or as tags which can be used to filter or pivot reports. @@ -2334,7 +2337,7 @@ equity, revenue, expense), affecting reports like balancesheet and incomestatement. .PP They are written as the word \f[CR]account\f[R] followed by a -hledger-style account name, eg: +hledger\-style account name, eg: .IP .EX account assets:bank:checking @@ -2354,16 +2357,16 @@ 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 +The two\-space requirement for same\-line account comments is because \f[CR];\f[R] is allowed in account names. .IP .EX -account assets:bank:checking ; same-line comment, at least 2 spaces before the semicolon - ; next-line comment - ; some tags - type:A, acctnum:12345 +account assets:bank:checking ; same\-line comment, at least 2 spaces before the semicolon + ; next\-line comment + ; some tags \- type:A, acctnum:12345 .EE .SS Account subdirectives -Ledger-style indented subdirectives are also accepted, but currently +Ledger\-style indented subdirectives are also accepted, but currently ignored: .IP .EX @@ -2374,16 +2377,16 @@ account assets:bank:checking By default, accounts need not be declared; they come into existence when a posting references them. This is convenient, but it means hledger can\[aq]t warn you when you -mis-spell an account name in the journal. +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[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. +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: .IP \[bu] 2 -The declaration is case-sensitive; transactions must use the correct +The declaration is case\-sensitive; transactions must use the correct account name capitalisation. .IP \[bu] 2 The account directive\[aq]s scope is \[dq]whole file and below\[dq] (see @@ -2401,7 +2404,7 @@ subaccounts\[dq] with a wildcard; every account posted to must be declared. .SS Account display order The order in which account directives are written influences the order -in which accounts appear in reports, hledger-ui, hledger-web etc. +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 @@ -2416,7 +2419,7 @@ account expenses those accounts will be displayed in declaration order: .IP .EX -$ hledger accounts -1 +$ hledger accounts \-1 assets liabilities equity @@ -2436,7 +2439,7 @@ account other:zoo .PP 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. +\f[CR]other\f[R] among the top\-level accounts. This means: .IP \[bu] 2 you will sometimes declare parent accounts (eg \f[CR]account other\f[R] @@ -2452,10 +2455,10 @@ This enables easy reports like balancesheet and incomestatement, and 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 +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[CR]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 @@ -2506,7 +2509,7 @@ See also Regular expressions. .IP .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 \[ha]assets?(:|$) | Asset \[ha](debts?|liabilit(y|ies))(:|$) | Liability @@ -2519,7 +2522,7 @@ If account\[aq]s name contains this (CI) regular expression: | its ty .IP \[bu] 2 If you declare any account types, it\[aq]s a good idea to declare an account for all of the account types, because a mixture of declared and -name-inferred types can disrupt certain reports. +name\-inferred types can disrupt certain reports. .IP \[bu] 2 Certain uses of account aliases can disrupt account types. See Rewriting accounts > Aliases and account types. @@ -2547,7 +2550,7 @@ For troubleshooting, you can list accounts and their types with: .RS 2 .IP .EX -$ hledger accounts --types [ACCTPAT] [-DEPTH] [type:TYPECODES] +$ hledger accounts \-\-types [ACCTPAT] [\-DEPTH] [type:TYPECODES] .EE .RE .SS \f[CR]alias\f[R] directive @@ -2569,7 +2572,7 @@ customising reports .PP Account aliases also rewrite account names in account directives. They do not affect account names being entered via hledger add or -hledger-web. +hledger\-web. .PP Account aliases are very powerful. They are generally easy to use correctly, but you can also generate @@ -2587,7 +2590,7 @@ The spaces around the = are optional: alias OLD = NEW .EE .PP -Or, you can use the \f[CR]--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. @@ -2617,12 +2620,12 @@ alias /REGEX/ = REPLACEMENT or: .IP .EX -$ hledger --alias \[aq]/REGEX/=REPLACEMENT\[aq] ... +$ hledger \-\-alias \[aq]/REGEX/=REPLACEMENT\[aq] ... .EE .PP Any part of an account name matched by REGEX will be replaced by REPLACEMENT. -REGEX is case-insensitive as usual. +REGEX is case\-insensitive as usual. .PP If you need to match a forward slash, escape it with a backslash, eg \f[CR]/\[rs]/=:\f[R]. @@ -2641,8 +2644,8 @@ option argument), so it can contain trailing whitespace. You can define as many aliases as you like, using journal directives and/or command line options. .PP -Recursive aliases - where an account name is rewritten by one alias, -then by another alias, and so on - are allowed. +Recursive aliases \- where an account name is rewritten by one alias, +then by another alias, and so on \- are allowed. Each alias sees the effect of previously applied aliases. .PP In such cases it can be important to understand which aliases will be @@ -2652,7 +2655,7 @@ For (each account name in) each journal entry, we apply: \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[CR]--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: @@ -2664,18 +2667,18 @@ the next alias before/above that will be be applied next, and so on aliases defined after/below the entry do not affect it. .PP This gives nearby aliases precedence over distant ones, and helps -provide semantic stability - aliases will keep working the same way +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[CR]--debug=6\f[R] to the command line will -show which aliases are being applied when. +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 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 .EX -hledger -f a.aliases -f b.journal +hledger \-f a.aliases \-f b.journal .EE .PP account aliases defined in a.aliases will not affect b.journal. @@ -2684,19 +2687,19 @@ Including the aliases doesn\[aq]t work either: .EX include a.aliases -2023-01-01 ; not affected by a.aliases +2023\-01\-01 ; not affected by a.aliases foo 1 bar .EE .PP This means that account aliases should usually be declared at the start -of your top-most file, like this: +of your top\-most file, like this: .IP .EX alias foo=Foo alias bar=Bar -2023-01-01 ; affected by aliases above +2023\-01\-01 ; affected by aliases above foo 1 bar @@ -2715,14 +2718,14 @@ could cause confusing reports or invalid \f[CR]print\f[R] output. For example, you could erase all account names: .IP .EX -2021-01-01 +2021\-01\-01 a:aa 1 b .EE .IP .EX -$ hledger print --alias \[aq]/.*/=\[aq] -2021-01-01 +$ hledger print \-\-alias \[aq]/.*/=\[aq] +2021\-01\-01 1 .EE .PP @@ -2731,14 +2734,14 @@ Or you could insert an illegal double space, causing \f[CR]print\f[R] output that would give a different journal when reparsed: .IP .EX -2021-01-01 +2021\-01\-01 old 1 other .EE .IP .EX -$ hledger print --alias old=\[dq]new USD\[dq] | hledger -f- print -2021-01-01 +$ hledger print \-\-alias old=\[dq]new USD\[dq] | hledger \-f\- print +2021\-01\-01 new USD 1 other .EE @@ -2759,7 +2762,7 @@ matching accounts as you expect, try troubleshooting with the accounts command, eg something like: .IP .EX -$ hledger accounts --alias assets=bassetts type:a +$ hledger accounts \-\-alias assets=bassetts type:a .EE .SS \f[CR]commodity\f[R] directive The \f[CR]commodity\f[R] directive performs several functions: @@ -2778,14 +2781,14 @@ 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[CR]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[CR]commodity\f[R] directives at the top of -your journal file (because function 4 is position-sensitive). +your journal file (because function 4 is position\-sensitive). .SS Commodity directive syntax A commodity directive is normally the word \f[CR]commodity\f[R] followed by a sample amount (and optionally a comment). @@ -2795,7 +2798,7 @@ Eg: .EX commodity $1000.00 commodity 1.000,00 EUR -commodity 1 000 000.0000 ; the no-symbol commodity +commodity 1 000 000.0000 ; the no\-symbol commodity .EE .PP Commodities do not have tags (tags in the comment will be ignored). @@ -2824,7 +2827,7 @@ only a symbol (ie, just function 1 above): commodity $ commodity INR commodity \[dq]AAAA 2023\[dq] -commodity \[dq]\[dq] ; the no-symbol commodity +commodity \[dq]\[dq] ; the no\-symbol commodity .EE .PP Commodity directives may also be written with an indented @@ -2834,33 +2837,33 @@ Other subdirectives are currently ignored: .IP .EX ; display indian rupees with currency name on the left, -; thousands, lakhs and crores comma-separated, +; 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 .EE .SS Commodity error checking -In strict mode (\f[CR]-s\f[R]/\f[CR]--strict\f[R]) (or when you run +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[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. +.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 .EX -decimal-mark . +decimal\-mark . .EE .PP or .IP .EX -decimal-mark , +decimal\-mark , .EE .PP This prevents any ambiguity when parsing numbers in the file, so we @@ -2914,15 +2917,15 @@ of commodity 2 that one unit of commodity 1 is worth on this date. Examples: .IP .EX -# one euro was worth $1.35 from 2009-01-01 onward: -P 2009-01-01 € $1.35 +# 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 +# and $1.40 from 2010\-01\-01 onward: +P 2010\-01\-01 € $1.40 .EE .PP -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. +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[CR]payee\f[R] directive @@ -2946,7 +2949,7 @@ To declare the empty payee name, use \f[CR]\[dq]\[dq]\f[R]. payee \[dq]\[dq] .EE .PP -Ledger-style indented subdirectives, if any, are currently ignored. +Ledger\-style indented subdirectives, if any, are currently ignored. .SS \f[CR]tag\f[R] directive \f[CR]tag TAGNAME\f[R] .PP @@ -2956,7 +2959,7 @@ TAGNAME should be a valid tag name (no spaces). Eg: .IP .EX -tag item-id +tag item\-id .EE .PP Any indented subdirectives are currently ignored. @@ -2967,22 +2970,29 @@ 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 -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. +The \f[CR]\[ti]\f[R] directive declares a \[dq]periodic rule\[dq] which +generates temporary extra transactions, usually recurring at some +interval, when hledger is run with the \f[CR]\-\-forecast\f[R] flag. +These \[dq]forecast transactions\[dq] are useful for forecasting future +activity. +They exist only for the duration of the report, and only when +\f[CR]\-\-forecast\f[R] is used; they are not saved in the journal file +by hledger. .PP -Periodic transactions can be a little tricky, so before you use them, -read this whole section, or at least these tips: +Periodic rules also have a second use: with the \f[CR]\-\-budget\f[R] +flag they set budget goals for budgeting. +.PP +Periodic rules can be a little tricky, so before you use them, read this +whole section, or at least the following tips: .IP "1." 3 -Two spaces accidentally added or omitted will cause you trouble - read +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[CR]hledger print --forecast tag:generated\f[R] or -\f[CR]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 +Forecasted transactions will begin only after the last non\-forecasted transaction\[aq]s date. .IP "4." 3 Forecasted transactions will end 6 months from today, by default. @@ -3017,13 +3027,13 @@ wave.): assets:bank:checking # every 15th of month in 2023\[aq]s first quarter: -\[ti] monthly from 2023-04-15 to 2023-06-16 +\[ti] monthly from 2023\-04\-15 to 2023\-06\-16 expenses:utilities $400 assets:bank:checking .EE .PP The period expression is the same syntax used for specifying -multi-period reports, just interpreted differently; there, it specifies +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 @@ -3036,7 +3046,7 @@ If used, they will be interpreted relative to, in order of preference: 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[CR]--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 @@ -3066,68 +3076,65 @@ description, if any. Don\[aq]t accidentally write two spaces in the middle of your period expression. .SS Auto postings -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. -This can be useful for generating tax postings with a standard -percentage, for example. +The \f[CR]=\f[R] directive declares an \[dq]auto posting rule\[dq], +which adds extra postings to existing transactions. +(Remember, postings are the account name & amount lines below a +transaction\[aq]s date & description.) .PP -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[CR]--auto\f[R]). -.PP -An auto posting rule looks a bit like a transaction: +In the journal, an auto posting rule looks quite like a transaction, but +instead of date and description it has \f[CR]=\f[R] (mnemonic: +\[dq]match\[dq]) and a query, like this: .IP .EX = QUERY - ACCOUNT AMOUNT + ACCOUNT AMOUNT ... - ACCOUNT [AMOUNT] .EE .PP -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[CR]$2\f[R]. -This will be used as-is. -.IP \[bu] 2 -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[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[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. +Queries are just like command line queries; an account name substring is +most common. +Query terms containing spaces should be enclosed in single or double +quotes. .PP -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 -.EX -= expenses:groceries \[aq]expenses:dining out\[aq] - (budget:funds:dining out) *-1 -.EE +Each \f[CR]=\f[R] rule works like this: when hledger is run with the +\f[CR]\-\-auto\f[R] flag, wherever the QUERY matches a posting in the +journal, the rule\[aq]s postings are added to that transaction, +immediately below the matched posting. +Note these generated postings are temporary, existing only for the +duration of the report, and only when \f[CR]\-\-auto\f[R] is used; they +are not saved in the journal file by hledger. +.PP +Generated postings\[aq] amounts can depend on the matched posting\[aq]s +amount. +So auto postings can be useful for, eg, adding tax postings with a +standard percentage. +AMOUNT can be: +.IP \[bu] 2 +a number with no commodity symbol, like \f[CR]2\f[R]. +The matched posting\[aq]s commodity symbol will be added to this. +.IP \[bu] 2 +a normal amount with a commodity symbol, like \f[CR]$2\f[R]. +This will be used as\-is. +.IP \[bu] 2 +an asterisk followed by a number, like \f[CR]*2\f[R]. +This will multiply the matched posting\[aq]s amount (and total price, if +any) by the number. +.IP \[bu] 2 +an asterisk followed by an amount with commodity symbol, like +\f[CR]*$2\f[R]. +This multiplies and also replaces the commodity symbol with this new +one. .PP Some examples: .IP .EX ; every time I buy food, schedule a dollar donation = expenses:food - (liabilities:charity) $-1 + (liabilities:charity) $\-1 ; when I buy a gift, also deduct that amount from a budget envelope subaccount = expenses:gifts - assets:checking:gifts *-1 + assets:checking:gifts *\-1 assets:checking *1 2017/12/1 @@ -3140,23 +3147,32 @@ Some examples: .EE .IP .EX -$ hledger print --auto -2017-12-01 +$ hledger print \-\-auto +2017\-12\-01 expenses:food $10 assets:checking - (liabilities:charity) $-1 + (liabilities:charity) $\-1 -2017-12-14 +2017\-12\-14 expenses:gifts $20 assets:checking - assets:checking:gifts -$20 + assets:checking:gifts \-$20 assets:checking $20 .EE +.PP +Note that depending fully on generated data such as this has some +drawbacks \- it\[aq]s less portable, less future\-proof, less auditable +by others, and less robust (eg your balance assertions will depend on +whether you use or don\[aq]t use \f[CR]\-\-auto\f[R]). +An alternative is to use auto postings in \[dq]one time\[dq] fashion \- +use them to help build a complex journal entry, view it with +\f[CR]hledger print \-\-auto\f[R], and then copy that output into the +journal file to make it permanent. .SS Auto postings and multiple files An auto posting rule can affect any transaction in the current file, or in any parent file or child file. Note, currently it will not affect sibling files (when multiple -\f[CR]-f\f[R]/\f[CR]--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 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 @@ -3173,16 +3189,16 @@ Note this means that journal entries must be balanced both before and after auto postings are added. This changed in hledger 1.12+; see #893 for background. .PP -This also means that you cannot have more than one auto-posting with a +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 Automated postings will have some extra tags: .IP \[bu] 2 -\f[CR]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[CR]_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. @@ -3190,14 +3206,14 @@ 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[CR]modified:\f[R] - this transaction was modified +\f[CR]modified:\f[R] \- this transaction was modified .IP \[bu] 2 -\f[CR]_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 Tip: you can can make auto postings that will apply to forecast transactions but not recorded transactions, by adding -\f[CR]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 @@ -3208,7 +3224,7 @@ 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 -Ledger-style balance assignments are also supported. +Ledger\-style balance assignments are also supported. These are like balance assertions, but with no posting amount on the left side of the equals sign; instead it is calculated automatically so as to satisfy the assertion. @@ -3234,7 +3250,7 @@ or when adjusting a balance to reality: .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 +commodity at that point (which depends on the previously\-dated postings of the commodity to that account since the last balance assertion or assignment). .PP @@ -3242,11 +3258,11 @@ Downsides: using balance assignments makes your journal less explicit; to know the exact amount posted, you have to run hledger or do the calculations yourself, instead of just reading it. Also balance assignments\[aq] forcing of balances can hide errors. -These things make your financial data less portable, less future-proof, +These things make your financial data less portable, less future\-proof, and less trustworthy in an audit. -.SS Balance assignments and prices +.SS Balance assignments and costs A cost in a balance assignment will cause the calculated amount to have -that price attached: +that cost attached: .IP .EX 2019/1/1 @@ -3254,8 +3270,8 @@ that price attached: .EE .IP .EX -$ hledger print --explicit -2019-01-01 +$ hledger print \-\-explicit +2019\-01\-01 (a) $1 \[at] €2 = $1 \[at] €2 .EE .SS Balance assignments and multiple files @@ -3266,8 +3282,8 @@ file, but not from previous sibling or parent files. For setting posting dates and secondary posting dates, Ledger\[aq]s 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[CR]0123456789/-.=\f[R] characters in this way. +hledger will attempt to parse any square\-bracketed sequence of the +\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 @@ -3292,12 +3308,12 @@ The amount must include a decimal mark (either period or comma). Eg: .IP .EX -; commodity-less amounts should be treated as dollars +; 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 1/1 - a 5 ; <- commodity-less amount, parsed as $5 and displayed as $5.00 + a 5 ; <\- commodity\-less amount, parsed as $5 and displayed as $5.00 b .EE .PP @@ -3307,8 +3323,8 @@ 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[CR]decimal-mark\f[R] has highest priority, then \f[CR]commodity\f[R], -then \f[CR]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[CR]commodity\f[R] directive is required @@ -3319,7 +3335,7 @@ 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[CR]commodity\f[R] and -\f[CR]decimal-mark\f[R]. +\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 @@ -3342,13 +3358,13 @@ is equivalent to: .EX 2010/01/01 home:food $10 - home:cash $-10 + home:cash $\-10 .EE .PP \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. +Account names entered via hledger add or hledger\-web are not affected. .PP Account aliases, if any, are applied after the parent account is prepended. @@ -3358,7 +3374,7 @@ portable, and less trustworthy in an audit. .SS \f[CR]Y\f[R] directive \f[CR]Y YEAR\f[R] .PP -or (deprecated backward-compatible forms): +or (deprecated backward\-compatible forms): .PP \f[CR]year YEAR\f[R] \f[CR]apply year YEAR\f[R] .PP @@ -3396,8 +3412,8 @@ A secondary date is written after the primary date, following an equals sign. If the year is omitted, the primary date\[aq]s year is assumed. When running reports, the primary (left) date is used by default, but -with the \f[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 +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 @@ -3448,19 +3464,19 @@ least balanced. An example: .IP .EX -2022-01-01 buy food with cash, update budget envelope subaccounts, & something else - assets:cash $-10 ; <- these balance each other - expenses:food $7 ; <- - expenses:food $3 ; <- - [assets:checking:budget:food] $-10 ; <- and these balance each other - [assets:checking:available] $10 ; <- - (something:else) $5 ; <- this is not required to balance +2022\-01\-01 buy food with cash, update budget envelope subaccounts, & something else + assets:cash $\-10 ; <\- these balance each other + expenses:food $7 ; <\- + expenses:food $3 ; <\- + [assets:checking:budget:food] $\-10 ; <\- and these balance each other + [assets:checking:available] $10 ; <\- + (something:else) $5 ; <\- this is not required to balance .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[CR]-R/--real\f[R] flag or a \f[CR]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 These other Ledger directives are currently accepted but ignored. This allows hledger to read more Ledger files, but be aware that @@ -3483,14 +3499,14 @@ python PYTHONCODE tag NAME value EXPR ---command-line-flags +\-\-command\-line\-flags .EE .PP See also https://hledger.org/ledger.html for a detailed hledger/Ledger syntax comparison. .PP .SH CSV -hledger can read CSV files (Character Separated Value - usually comma, +hledger can read CSV files (Character Separated Value \- usually comma, semicolon, or tab) containing dated records, automatically converting each record into a transaction. .PP @@ -3512,8 +3528,8 @@ By default hledger looks for a rules file named like the CSV file with 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. +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. .PP @@ -3531,14 +3547,14 @@ Date, Description, Id, Amount # basic.csv.rules skip 1 fields date, description, , amount -date-format %d/%m/%Y +date\-format %d/%m/%Y .EE .IP .EX -$ hledger print -f basic.csv -2019-11-12 Foo +$ hledger print \-f basic.csv +2019\-11\-12 Foo expenses:unknown 10.23 - income:unknown -10.23 + income:unknown \-10.23 .EE .PP There\[aq]s an introductory Importing CSV data tutorial on hledger.org, @@ -3568,29 +3584,29 @@ T}@T{ skip one or more header lines at start of file T} T{ -\f[B]\f[CB]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 +declare how to parse CSV dates/date\-times T} T{ \f[B]\f[CB]timezone\f[B]\f[R] T}@T{ -declare the time zone of ambiguous CSV date-times +declare the time zone of ambiguous CSV date\-times T} T{ -\f[B]\f[CB]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[CB]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 +improve txn order when: same\-day txns are in opposite order to the overall file T} T{ -\f[B]\f[CB]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} @@ -3617,7 +3633,7 @@ T}@T{ conditionally assign values to hledger fields, using compact syntax T} T{ -\f[B]\f[CB]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} @@ -3631,10 +3647,10 @@ T} Working with CSV tips can be found below, including How CSV rules are evaluated. .SS \f[CR]source\f[R] -If you tell hledger to read a csv file with \f[CR]-f foo.csv\f[R], it +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[CR]-f foo.csv.rules\f[R], and it will look for data in +\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 @@ -3666,22 +3682,22 @@ source Checking1*.csv See also \[dq]Working with CSV > Reading files specified by rule\[dq]. .SS \f[CR]separator\f[R] You can use the \f[CR]separator\f[R] rule to read other kinds of -character-separated data. +character\-separated data. The argument is any single separator character, or the words \f[CR]tab\f[R] or \f[CR]space\f[R] (case insensitive). -Eg, for comma-separated values (CSV): +Eg, for comma\-separated values (CSV): .IP .EX separator , .EE .PP -or for semicolon-separated values (SSV): +or for semicolon\-separated values (SSV): .IP .EX separator ; .EE .PP -or for tab-separated values (TSV): +or for tab\-separated values (TSV): .IP .EX separator TAB @@ -3698,7 +3714,7 @@ skip N .EE .PP 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 +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 @@ -3709,41 +3725,41 @@ need to count those. true. Records skipped in this way are ignored, except they are still required to be valid CSV. -.SS \f[CR]date-format\f[R] +.SS \f[CR]date\-format\f[R] .IP .EX -date-format DATEFMT +date\-format DATEFMT .EE .PP 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], +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. +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 .EX # MM/DD/YY -date-format %m/%d/%y +date\-format %m/%d/%y .EE .IP .EX # D/M/YYYY -# The - makes leading zeros optional. -date-format %-d/%-m/%Y +# The \- makes leading zeros optional. +date\-format %\-d/%\-m/%Y .EE .IP .EX -# YYYY-Mmm-DD -date-format %Y-%h-%d +# YYYY\-Mmm\-DD +date\-format %Y\-%h\-%d .EE .IP .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 +date\-format %\-m/%\-d/%Y %l:%M %p some other junk .EE .SS \f[CR]timezone\f[R] .IP @@ -3751,86 +3767,87 @@ date-format %-m/%-d/%Y %l:%M %p some other junk timezone TIMEZONE .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 -use this rule to declare the CSV\[aq]s native time zone, which helps -prevent off-by-one dates. +When CSV contains date\-times that are implicitly in some time zone +other than yours, but containing no explicit time zone information, you +can use this rule to declare the CSV\[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[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). +When the CSV date\-times do contain time zone information, you don\[aq]t +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, -localising the CSV date-times to your current system time zone. +In either of these cases, hledger will do a time\-zone\-aware +conversion, localising the CSV date\-times to your current system time +zone. If you prefer to localise to some other time zone, eg for reproducibility, you can (on unix at least) set the output timezone with the TZ environment variable, eg: .IP .EX -$ TZ=-1000 hledger print -f foo.csv # or TZ=-1000 hledger import foo.csv +$ TZ=\-1000 hledger print \-f foo.csv # or TZ=\-1000 hledger import foo.csv .EE .PP \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[CR]newest-first\f[R] +For others, use numeric format: +HHMM or \-HHMM. +.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. +chronologically, including same\-day transactions. +Usually it can auto\-detect how the CSV records are ordered. But if it encounters CSV where all records are on the same date, it assumes that the records are oldest first. If in fact the CSV\[aq]s records are normally newest first, like: .IP .EX -2022-10-01, txn 3... -2022-10-01, txn 2... -2022-10-01, txn 1... +2022\-10\-01, txn 3... +2022\-10\-01, txn 2... +2022\-10\-01, txn 1... .EE .PP -you can add the \f[CR]newest-first\f[R] rule to help hledger generate +you can add the \f[CR]newest\-first\f[R] rule to help hledger generate the transactions in correct order. .IP .EX -# same-day CSV records are newest first -newest-first +# same\-day CSV records are newest first +newest\-first .EE -.SS \f[CR]intra-day-reversed\f[R] +.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[CR]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 +Eg, here the overall record order is newest first, but same\-day records are oldest first: .IP .EX -2022-10-02, txn 3... -2022-10-02, txn 4... -2022-10-01, txn 1... -2022-10-01, txn 2... +2022\-10\-02, txn 3... +2022\-10\-02, txn 4... +2022\-10\-01, txn 1... +2022\-10\-01, txn 2... .EE .IP .EX # transactions within each day are reversed with respect to the overall date order -intra-day-reversed +intra\-day\-reversed .EE -.SS \f[CR]decimal-mark\f[R] +.SS \f[CR]decimal\-mark\f[R] .IP .EX -decimal-mark . +decimal\-mark . .EE .PP or: .IP .EX -decimal-mark , +decimal\-mark , .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 +thousand\-separating commas, you should declare the decimal mark explicitly with this rule, to avoid misparsed numbers. .SS \f[CR]fields\f[R] list .IP @@ -3838,7 +3855,7 @@ explicitly with this rule, to avoid misparsed numbers. fields FIELDNAME1, FIELDNAME2, ... .EE .PP -A fields list (the word \f[CR]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 @@ -3868,14 +3885,14 @@ 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[CR]_\f[R] (underscore) or \f[CR]-\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 name. .PP If the CSV contains column headings, it\[aq]s convenient to use these -for your field names, suitably modified (eg lower-cased with spaces +for your field names, suitably modified (eg lower\-cased with spaces replaced by underscores). .PP Sometimes you may want to alter a CSV field name to avoid assigning to a @@ -3894,10 +3911,10 @@ hledger fields. They can be used instead of or in addition to a fields list (see above). .PP 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, +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[CR]%N\f[R]) or by the name they +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 @@ -3908,7 +3925,7 @@ Some examples: amount %4 USD # combine three fields to make a comment, containing note: and date: tags -comment note: %somefield - %anotherfield, date: %1 +comment note: %somefield \- %anotherfield, date: %1 .EE .PP Tips: @@ -3917,8 +3934,8 @@ Interpolation strips outer whitespace (so a CSV value like \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. +Interpolations always refer to a CSV field \- you can\[aq]t interpolate +a hledger field. (See Referencing other fields below). .SS Field names Note the two kinds of field names mentioned here, and used only in @@ -3976,7 +3993,7 @@ Assigning to \f[CR]date\f[R] sets the transaction date. \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[CR]\[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[CR]\[rs]n\f[R] will begin on a new line. .PP @@ -3988,7 +4005,7 @@ name of the Nth posting, and causes that posting to be generated. Most often there are two postings, so you\[aq]ll want to set \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 +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 @@ -4003,30 +4020,30 @@ 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[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 +\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]). -Whichever field has a non-zero value will be used as the amount of the +Whichever field has a non\-zero value will be used as the amount of the first and second postings. Here are some tips to avoid confusion: .RS 4 .IP \[bu] 2 -It\[aq]s not \[dq]amount-in for posting 1 and amount-out for posting -2\[dq], it is \[dq]extract a single amount from the amount-in or -amount-out field, and use that for posting 1 and (negated) for posting +It\[aq]s not \[dq]amount\-in for posting 1 and amount\-out for posting +2\[dq], it is \[dq]extract a single amount from the amount\-in or +amount\-out field, and use that for posting 1 and (negated) for posting 2\[dq]. .IP \[bu] 2 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; +\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. +non\-zero amount; the other field must contain a zero or nothing. .IP \[bu] 2 hledger assumes both CSV fields contain unsigned numbers, and it -automatically negates the amount-out values. +automatically negates the amount\-out values. .IP \[bu] 2 If the data doesn\[aq]t fit these requirements, you\[aq]ll probably need an if rule (see below). @@ -4042,11 +4059,11 @@ 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[CB]amountN-in\f[B]\f[R] and \f[B]\f[CB]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[CR]amount-in\f[R] and \f[CR]amount-out\f[R], and -those tips also apply here. +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[CR]fields\f[R] list can also do assignments. So in a fields list if you name a CSV field \[dq]amount\[dq], that @@ -4057,7 +4074,7 @@ like \[dq]amount_\[dq].) The above don\[aq]t handle every situation; if you need more 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. +and on amount\-setting generally. .SS currency field \f[CR]currency\f[R] sets a currency symbol, to be prepended to all postings\[aq] amounts. @@ -4074,7 +4091,7 @@ amount is left empty, a balance assignment) on posting N. equivalent to \f[CR]balance1\f[R]. .PP You can adjust the type of assertion/assignment with the -\f[CR]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[CR]if\f[R] block @@ -4112,10 +4129,10 @@ applied. They are usually field assignments, but the following special rules may also be used within an if block: .IP \[bu] 2 -\f[CR]skip\f[R] - skips the matched CSV record (generating no +\f[CR]skip\f[R] \- skips the matched CSV record (generating no transaction from it) .IP \[bu] 2 -\f[CR]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 @@ -4143,9 +4160,9 @@ if ,,,, .SS Matchers There are two kinds: .IP "1." 3 -A record matcher is a word or single-line text fragment or regular +A record matcher is a word or single\-line text fragment or regular expression (\f[CR]REGEX\f[R]), which hledger will try to match -case-insensitively anywhere within the CSV record. +case\-insensitively anywhere within the CSV record. .PD 0 .P .PD @@ -4164,7 +4181,7 @@ 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). +manual (https://hledger.org/hledger.html#regular\-expressions). .SS What matchers match With record matchers, it\[aq]s important to know that the record matched is not the original CSV record, but a modified one: separators will be @@ -4173,13 +4190,13 @@ whitespace) are removed. So for example, when reading an SSV file, if the original record was: .IP .EX -2023-01-01; \[dq]Acme, Inc.\[dq]; 1,000 +2023\-01\-01; \[dq]Acme, Inc.\[dq]; 1,000 .EE .PP the regex would see, and try to match, this modified record text: .IP .EX -2023-01-01,Acme, Inc., 1,000 +2023\-01\-01,Acme, Inc., 1,000 .EE .SS Combining matchers When an if block has multiple matchers, they are combined as follows: @@ -4209,8 +4226,8 @@ billing period (Month start), to match how they are presented in statements, using posting dates: .IP .EX -if %date (....-..)-.. - comment2 date:\[rs]1-01 +if %date (....\-..)\-.. + comment2 date:\[rs]1\-01 .EE .PP Another example: Read the expense account from the CSV field, but throw @@ -4236,7 +4253,7 @@ MATCHERC,VALUE1,VALUE2,... 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[CR],\f[R] or +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). @@ -4276,21 +4293,21 @@ Example: 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 +2023/01/12.*Plumbing LLC,expenses:house:upkeep,emergency plumbing call\-out .EE -.SS \f[CR]balance-type\f[R] +.SS \f[CR]balance\-type\f[R] Balance assertions generated by assigning to balanceN are of the simple -\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 +\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[CR]balance-type\f[R] rule: +\f[CR]balance\-type\f[R] rule: .IP .EX # balance assertions will consider all commodities and all subaccounts -balance-type ==* +balance\-type ==* .EE .PP Here are the balance assertion types for quick reference: @@ -4316,7 +4333,7 @@ eg: .EX # someaccount.csv.rules -## someaccount-specific rules +## someaccount\-specific rules fields date,description,amount account1 assets:someaccount account2 expenses:misc @@ -4332,13 +4349,13 @@ creating/troubleshooting CSV rules. Here\[aq]s a good way, using entr from eradman.com/entrproject: .IP .EX -$ ls foo.csv* | entr bash -c \[aq]echo ----; hledger -f foo.csv print desc:SOMEDESC\[aq] +$ ls foo.csv* | entr bash \-c \[aq]echo \-\-\-\-; hledger \-f foo.csv print desc:SOMEDESC\[aq] .EE .PP A desc: query (eg) is used to select just one, or a few, transactions of interest. -\[dq]bash -c\[dq] is used to run multiple commands, so we can echo a -separator each time the command re-runs, making it easier to read the +\[dq]bash \-c\[dq] is used to run multiple commands, so we can echo a +separator each time the command re\-runs, making it easier to read the output. .SS Valid CSV Note that hledger will only accept valid CSV conforming to RFC 4180, and @@ -4374,7 +4391,7 @@ the CSV reader (and the default field separator) by prefixing the file path with \f[CR]csv:\f[R], \f[CR]ssv:\f[R] or \f[CR]tsv:\f[R]: Eg: .IP .EX -$ hledger -f ssv:foo.dat print +$ hledger \-f ssv:foo.dat print .EE .PP You can also override the default field separator with a separator rule @@ -4385,17 +4402,17 @@ since hledger assumes journal format by default. Eg: .IP .EX -$ cat foo.dat | hledger -f ssv:- print +$ cat foo.dat | hledger \-f ssv:\- print .EE .SS Reading multiple CSV files -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 +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[CR]--rules-file\f[R] option, that rules file will -be used for all the CSV files. +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 Instead of specifying a CSV file in the command line, you can specify a -rules file, as in \f[CR]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. @@ -4406,21 +4423,21 @@ 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[CR]source Checking1*.csv\f[R] in -foo-checking.csv.rules, and then periodically follow a workflow like: +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[CR]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[CR]*\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 -After reading a CSV file, hledger post-processes and validates the -generated journal entries as it would for a journal file - balancing +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. Any errors at this stage will be reported in the usual way, displaying the problem entry. @@ -4432,7 +4449,7 @@ If you do need to check balance assertions generated from CSV right away, pipe into another hledger: .IP .EX -$ hledger -f file.csv print | hledger -f- print +$ hledger \-f file.csv print | hledger \-f\- print .EE .SS Deduplicating, importing When you download a CSV file periodically, eg to get your latest bank @@ -4449,24 +4466,24 @@ Eg: .IP .EX # download the latest CSV files, then run this command. -# Note, no -f flags needed here. -$ hledger import *.csv [--dry] +# Note, no \-f flags needed here. +$ hledger import *.csv [\-\-dry] .EE .PP This method works for most CSV files. (Where records have a stable chronological order, and new records appear only at the new end.) .PP -A number of other tools and workflows, hledger-specific and otherwise, +A number of other tools and workflows, hledger\-specific and otherwise, exist for converting, deduplicating, classifying and managing CSV data. See: .IP \[bu] 2 -https://hledger.org/cookbook.html#setups-and-workflows +https://hledger.org/cookbook.html#setups\-and\-workflows .IP \[bu] 2 -https://plaintextaccounting.org -> data import/conversion +https://plaintextaccounting.org \-> data import/conversion .SS Setting amounts Continuing from amount field above, here are more tips for -amount-setting: +amount\-setting: .IP "1." 3 \f[B]If the amount is in a single CSV field:\f[R] .PD 0 @@ -4490,7 +4507,7 @@ Eg: .IP .EX # assume a withdrawal unless Type contains \[dq]deposit\[dq]: -amount1 -%Amount +amount1 \-%Amount if %Type deposit amount1 %Amount .EE @@ -4507,10 +4524,10 @@ and Out):\f[R] .PD 0 .P .PD -Assign one field to \f[CR]amountN-in\f[R] and the other to -\f[CR]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. +whichever field value is non\-zero as posting N\[aq]s amount. .IP "b." 3 \f[B]If either field is signed:\f[R] .PD 0 @@ -4520,30 +4537,30 @@ You will probably need to override hledger\[aq]s sign for one or the other field, as in the following example: .IP .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 +# 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 .EE .IP "c." 3 -\f[B]If both fields can contain a non-zero value (or both can be +\f[B]If both fields can contain a non\-zero value (or both can be empty):\f[R] .PD 0 .P .PD -The -in/-out rules normally choose the value which is -non-zero/non-empty. +The \-in/\-out rules normally choose the value which is +non\-zero/non\-empty. 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 +Eg, to handle the above you could select the value containing non\-zero digits: .IP .EX fields date, description, in, out -if %in [1-9] +if %in [1\-9] amount1 %in -if %out [1-9] +if %out [1\-9] amount1 %out .EE .RE @@ -4552,8 +4569,8 @@ if %out [1-9] .PD 0 .P .PD -Use the unnumbered \f[CR]amount\f[R] (or \f[CR]amount-in\f[R] and -\f[CR]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 @@ -4581,16 +4598,16 @@ that will be removed: \f[CR]+AMT\f[R] becomes \f[CR]AMT\f[R] .PD 0 .P .PD -it will be de-parenthesised and sign-flipped: \f[CR](AMT)\f[R] becomes -\f[CR]-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[CR]--AMT\f[R] or -\f[CR]-(AMT)\f[R] becomes \f[CR]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] @@ -4598,7 +4615,7 @@ parentheses):\f[R] .P .PD that is removed, making it an empty value. -\f[CR]\[dq]+\[dq]\f[R] or \f[CR]\[dq]-\[dq]\f[R] or +\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 @@ -4608,7 +4625,7 @@ If the currency/commodity symbol is included in the CSV\[aq]s amount field(s): .IP .EX -2023-01-01,foo,$123.00 +2023\-01\-01,foo,$123.00 .EE .PP you don\[aq]t have to do anything special for the commodity symbol, it @@ -4620,18 +4637,18 @@ fields date,description,amount .EE .IP .EX -2023-01-01 foo +2023\-01\-01 foo expenses:unknown $123.00 - income:unknown $-123.00 + income:unknown $\-123.00 .EE .PP If the currency is provided as a separate CSV field: .IP .EX -2023-01-01,foo,USD,123.00 +2023\-01\-01,foo,USD,123.00 .EE .PP -You can assign that to the \f[CR]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 @@ -4640,9 +4657,9 @@ fields date,description,currency,amount .EE .IP .EX -2023-01-01 foo +2023\-01\-01 foo expenses:unknown USD123.00 - income:unknown USD-123.00 + income:unknown USD\-123.00 .EE .PP Or, you can use a field assignment to construct the amount yourself, @@ -4655,14 +4672,14 @@ amount %amt %cur .EE .IP .EX -2023-01-01 foo +2023\-01\-01 foo expenses:unknown 123.00 USD - income:unknown -123.00 USD + income:unknown \-123.00 USD .EE .PP 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. +\f[CR]currency\f[R] \- that would trigger the prepending effect, which +we don\[aq]t want here. .SS Amount decimal places Like amounts in a journal file, the amounts generated by CSV rules like \f[CR]amount1\f[R] influence commodity display styles, such as the @@ -4714,8 +4731,8 @@ Here\[aq]s how to think of CSV rules being evaluated (if you really need to). First, .IP \[bu] 2 -\f[CR]include\f[R] - all includes are inlined, from top to bottom, depth -first. +\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.) .PP @@ -4724,11 +4741,11 @@ If a rule is repeated, the last one wins: .IP \[bu] 2 \f[CR]skip\f[R] (at top level) .IP \[bu] 2 -\f[CR]date-format\f[R] +\f[CR]date\-format\f[R] .IP \[bu] 2 -\f[CR]newest-first\f[R] +\f[CR]newest\-first\f[R] .IP \[bu] 2 -\f[CR]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: @@ -4744,7 +4761,7 @@ 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 -compute a value for each hledger field - either the one that was +compute a value for each hledger field \- either the one that was assigned to it (and interpolate the %CSVFIELD references), or a default .IP \[bu] 2 generate a hledger transaction (journal entry) from these values. @@ -4777,25 +4794,25 @@ Date,Details,Debit,Credit,Balance .EE .IP .EX -# bankofireland-checking.csv.rules +# bankofireland\-checking.csv.rules # skip the header line skip # name the csv fields, and assign some of them as journal entry fields -fields date, description, amount-out, amount-in, balance +fields date, description, amount\-out, amount\-in, balance # We generate balance assertions by assigning to \[dq]balance\[dq] # above, but you may sometimes need to remove these because: # -# - the CSV balance differs from the true balance, +# \- the CSV balance differs from the true balance, # by up to 0.0000000000005 in my experience # -# - it is sometimes calculated based on non-chronological ordering, +# \- it is sometimes calculated based on non\-chronological ordering, # eg when multiple transactions clear on the same day # date is in UK/Ireland format -date-format %d/%m/%Y +date\-format %d/%m/%Y # set the currency currency EUR @@ -4805,13 +4822,13 @@ account1 assets:bank:boi:checking .EE .IP .EX -$ hledger -f bankofireland-checking.csv print -2012-12-07 LODGMENT 529898 +$ hledger \-f bankofireland\-checking.csv print +2012\-12\-07 LODGMENT 529898 assets:bank:boi:checking EUR10.0 = EUR131.2 - income:unknown EUR-10.0 + income:unknown EUR\-10.0 -2012-12-07 PAYMENT - assets:bank:boi:checking EUR-5.0 = EUR126.0 +2012\-12\-07 PAYMENT + assets:bank:boi:checking EUR\-5.0 = EUR126.0 expenses:unknown EUR5.0 .EE .PP @@ -4826,7 +4843,7 @@ The legacy \f[CR]amount\f[R] field name conveniently sets amount 2 .IP .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] +# 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] .EE .IP .EX @@ -4834,17 +4851,17 @@ The legacy \f[CR]amount\f[R] field name conveniently sets amount 2 skip 1 fields Timestamp,Transaction_Type,Asset,Quantity_Transacted,Spot_Price_Currency,Spot_Price_at_Transaction,Subtotal,Total,Fees_Spread,Notes date %Timestamp -date-format %Y-%m-%dT%T%Z +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 .EE .IP .EX -$ hledger print -f coinbase.csv -2021-12-30 Received 100.00 USDC from an external account +$ 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 + income:unknown \-74.000000 GBP .EE .SS Amazon Here we convert amazon.com order history, and use an if block to @@ -4859,7 +4876,7 @@ but it\[aq]s an example.) .EE .IP .EX -# amazon-orders.csv.rules +# amazon\-orders.csv.rules # skip one header line skip 1 @@ -4869,7 +4886,7 @@ skip 1 fields date, _, toorfrom, name, amzstatus, amzamount, fees, code # how to parse the date -date-format %b %-d, %Y +date\-format %b %\-d, %Y # combine two fields to make the description description %toorfrom %name @@ -4888,43 +4905,43 @@ amount2 %amzamount # and maybe refine it further: #include categorisation.rules -# add a third posting for fees, but only if they are non-zero. -if %fees [1-9] +# add a third posting for fees, but only if they are non\-zero. +if %fees [1\-9] account3 expenses:fees amount3 %fees .EE .IP .EX -$ hledger -f amazon-orders.csv print -2012-07-29 (16000000000000DGLNJPI1P9B8DKPVHL) To Foo. ; status:Completed +$ hledger \-f amazon\-orders.csv print +2012\-07\-29 (16000000000000DGLNJPI1P9B8DKPVHL) To Foo. ; status:Completed assets:amazon expenses:misc $20.00 -2012-07-30 (17LA58JSKRD4HDGLNJPI1P9B8DKPVHL) To Adapteva, Inc. ; status:Completed +2012\-07\-30 (17LA58JSKRD4HDGLNJPI1P9B8DKPVHL) To Adapteva, Inc. ; status:Completed assets:amazon expenses:misc $25.00 expenses:fees $1.00 .EE .SS Paypal -Here\[aq]s a real-world rules file for (customised) Paypal CSV, with -some Paypal-specific rules, and a second rules file included: +Here\[aq]s a real\-world rules file for (customised) Paypal CSV, with +some Paypal\-specific rules, and a second rules file included: .IP .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]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] -\[dq]10/01/2019\[dq],\[dq]08:57:01\[dq],\[dq]PDT\[dq],\[dq]Patreon\[dq],\[dq]PreApproved Payment Bill User Payment\[dq],\[dq]Completed\[dq],\[dq]USD\[dq],\[dq]-7.00\[dq],\[dq]0.00\[dq],\[dq]-7.00\[dq],\[dq]simon\[at]joyful.com\[dq],\[dq]support\[at]patreon.com\[dq],\[dq]2722394R5F586712G\[dq],\[dq]Patreon* Membership\[dq],\[dq]\[dq],\[dq]B-0PG93074E7M86381M\[dq],\[dq]\[dq],\[dq]-7.00\[dq],\[dq]\[dq] +\[dq]10/01/2019\[dq],\[dq]08:57:01\[dq],\[dq]PDT\[dq],\[dq]Patreon\[dq],\[dq]PreApproved Payment Bill User Payment\[dq],\[dq]Completed\[dq],\[dq]USD\[dq],\[dq]\-7.00\[dq],\[dq]0.00\[dq],\[dq]\-7.00\[dq],\[dq]simon\[at]joyful.com\[dq],\[dq]support\[at]patreon.com\[dq],\[dq]2722394R5F586712G\[dq],\[dq]Patreon* Membership\[dq],\[dq]\[dq],\[dq]B\-0PG93074E7M86381M\[dq],\[dq]\[dq],\[dq]\-7.00\[dq],\[dq]\[dq] \[dq]10/01/2019\[dq],\[dq]08:57:01\[dq],\[dq]PDT\[dq],\[dq]\[dq],\[dq]Bank Deposit to PP Account \[dq],\[dq]Pending\[dq],\[dq]USD\[dq],\[dq]7.00\[dq],\[dq]0.00\[dq],\[dq]7.00\[dq],\[dq]\[dq],\[dq]simon\[at]joyful.com\[dq],\[dq]71854087RG994194F\[dq],\[dq]Patreon* Membership\[dq],\[dq]\[dq],\[dq]2722394R5F586712G\[dq],\[dq]\[dq],\[dq]0.00\[dq],\[dq]\[dq] -\[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]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] +\[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] .EE .IP .EX -# paypal-custom.csv.rules +# paypal\-custom.csv.rules # Tips: -# Export from Activity -> Statements -> Custom -> Activity download +# Export from Activity \-> Statements \-> Custom \-> Activity download # Suggested transaction type: \[dq]Balance affecting\[dq] # Paypal\[aq]s default fields in 2018 were: # \[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]Shipping Address\[dq],\[dq]Address Status\[dq],\[dq]Item Title\[dq],\[dq]Item ID\[dq],\[dq]Shipping and Handling Amount\[dq],\[dq]Insurance Amount\[dq],\[dq]Sales Tax\[dq],\[dq]Option 1 Name\[dq],\[dq]Option 1 Value\[dq],\[dq]Option 2 Name\[dq],\[dq]Option 2 Value\[dq],\[dq]Reference Txn ID\[dq],\[dq]Invoice Number\[dq],\[dq]Custom Number\[dq],\[dq]Quantity\[dq],\[dq]Receipt ID\[dq],\[dq]Balance\[dq],\[dq]Address Line 1\[dq],\[dq]Address Line 2/District/Neighborhood\[dq],\[dq]Town/City\[dq],\[dq]State/Province/Region/County/Territory/Prefecture/Republic\[dq],\[dq]Zip/Postal Code\[dq],\[dq]Country\[dq],\[dq]Contact Phone Number\[dq],\[dq]Subject\[dq],\[dq]Note\[dq],\[dq]Country Code\[dq],\[dq]Balance Impact\[dq] @@ -4935,7 +4952,7 @@ fields date, time, timezone, description_, type, status_, currency, grossamount, skip 1 -date-format %-m/%-d/%Y +date\-format %\-m/%\-d/%Y # ignore some paypal events if @@ -4967,22 +4984,22 @@ amount1 %netamount # the second posting will be money sent to/received from other party # (account2 is set below) -amount2 -%grossamount +amount2 \-%grossamount # if there\[aq]s a fee, add a third posting for the money taken by paypal. -if %feeamount [1-9] +if %feeamount [1\-9] account3 expenses:banking:paypal - amount3 -%feeamount + amount3 \-%feeamount comment3 business: # choose an account for the second posting # override the default account names: # if the amount is positive, it\[aq]s income (a debit) -if %grossamount \[ha][\[ha]-] +if %grossamount \[ha][\[ha]\-] account2 income:unknown # if negative, it\[aq]s an expense (a credit) -if %grossamount \[ha]- +if %grossamount \[ha]\- account2 expenses:unknown # apply common rules for setting account2 & other tweaks @@ -5030,35 +5047,35 @@ if Google .EE .IP .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 +$ 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 expenses:online:apps $6.99 -2019-10-01 (0TU1544T080463733) Bank Deposit to PP Account for 60P57143A8206782E ; itemid:, fromemail:, toemail:simon\[at]joyful.com, time:03:46:20, type:Bank Deposit to PP Account, status:Pending +2019\-10\-01 (0TU1544T080463733) Bank Deposit to PP Account for 60P57143A8206782E ; itemid:, fromemail:, toemail:simon\[at]joyful.com, time:03:46:20, type:Bank Deposit to PP Account, status:Pending assets:online:paypal $6.99 = $0.00 - assets:bank:wf:pchecking $-6.99 + assets:bank:wf:pchecking $\-6.99 -2019-10-01 (2722394R5F586712G) Patreon Patreon* Membership ; itemid:, fromemail:simon\[at]joyful.com, toemail:support\[at]patreon.com, time:08:57:01, type:PreApproved Payment Bill User Payment, status:Completed - assets:online:paypal $-7.00 = $-7.00 +2019\-10\-01 (2722394R5F586712G) Patreon Patreon* Membership ; itemid:, fromemail:simon\[at]joyful.com, toemail:support\[at]patreon.com, time:08:57:01, type:PreApproved Payment Bill User Payment, status:Completed + assets:online:paypal $\-7.00 = $\-7.00 expenses:dues $7.00 -2019-10-01 (71854087RG994194F) Bank Deposit to PP Account for 2722394R5F586712G Patreon* Membership ; itemid:, fromemail:, toemail:simon\[at]joyful.com, time:08:57:01, type:Bank Deposit to PP Account, status:Pending +2019\-10\-01 (71854087RG994194F) Bank Deposit to PP Account for 2722394R5F586712G Patreon* Membership ; itemid:, fromemail:, toemail:simon\[at]joyful.com, time:08:57:01, type:Bank Deposit to PP Account, status:Pending assets:online:paypal $7.00 = $0.00 - assets:bank:wf:pchecking $-7.00 + assets:bank:wf:pchecking $\-7.00 -2019-10-19 (K9U43044RY432050M) Wikimedia Foundation, Inc. Monthly donation to the Wikimedia Foundation ; itemid:, fromemail:simon\[at]joyful.com, toemail:tle\[at]wikimedia.org, time:03:02:12, type:Subscription Payment, status:Completed - assets:online:paypal $-2.00 = $-2.00 +2019\-10\-19 (K9U43044RY432050M) Wikimedia Foundation, Inc. Monthly donation to the Wikimedia Foundation ; itemid:, fromemail:simon\[at]joyful.com, toemail:tle\[at]wikimedia.org, time:03:02:12, type:Subscription Payment, status:Completed + assets:online:paypal $\-2.00 = $\-2.00 expenses:dues $2.00 expenses:banking:paypal ; business: -2019-10-19 (3XJ107139A851061F) Bank Deposit to PP Account for K9U43044RY432050M ; itemid:, fromemail:, toemail:simon\[at]joyful.com, time:03:02:12, type:Bank Deposit to PP Account, status:Pending +2019\-10\-19 (3XJ107139A851061F) Bank Deposit to PP Account for K9U43044RY432050M ; itemid:, fromemail:, toemail:simon\[at]joyful.com, time:03:02:12, type:Bank Deposit to PP Account, status:Pending assets:online:paypal $2.00 = $0.00 - assets:bank:wf:pchecking $-2.00 + assets:bank:wf:pchecking $\-2.00 -2019-10-22 (6L8L1662YP1334033) Noble Benefactor Joyful Systems ; itemid:, fromemail:noble\[at]bene.fac.tor, toemail:simon\[at]joyful.com, time:05:07:06, type:Subscription Payment, status:Completed +2019\-10\-22 (6L8L1662YP1334033) Noble Benefactor Joyful Systems ; itemid:, fromemail:noble\[at]bene.fac.tor, toemail:simon\[at]joyful.com, time:05:07:06, type:Subscription Payment, status:Completed assets:online:paypal $9.41 = $9.41 - revenues:foss donations:darcshub $-10.00 ; business: + revenues:foss donations:darcshub $\-10.00 ; business: expenses:banking:paypal $0.59 ; business: .EE .SH Timeclock @@ -5066,9 +5083,9 @@ The time logging format of timeclock.el, as read by hledger. .PP hledger can read time logs in timeclock format. As with Ledger, these are (a subset of) timeclock.el\[aq]s format, -containing clock-in and clock-out entries as in the example below. +containing clock\-in and clock\-out entries as in the example below. The date is a simple date. -The time format is HH:MM[:SS][+-ZZZZ]. +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). @@ -5082,7 +5099,7 @@ i 2015/03/31 22:21:45 another:account o 2015/04/01 02:00:34 .EE .PP -hledger treats each clock-in/clock-out pair as a transaction posting +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. @@ -5090,32 +5107,32 @@ For the above time log, \f[CR]hledger print\f[R] generates these journal entries: .IP .EX -$ hledger -f t.timeclock print -2015-03-30 * optional description after 2 spaces ; optional comment, tags: +$ hledger \-f t.timeclock print +2015\-03\-30 * optional description after 2 spaces ; optional comment, tags: (some account) 0.33h -2015-03-31 * 22:21-23:59 +2015\-03\-31 * 22:21\-23:59 (another:account) 1.64h -2015-04-01 * 00:00-02:00 +2015\-04\-01 * 00:00\-02:00 (another:account) 2.01h .EE .PP Here is a sample.timeclock to download and some queries to try: .IP .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 +$ 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 .EE .PP To generate time logs, ie to clock in and clock out, you could: .IP \[bu] 2 -use emacs and the built-in timeclock.el, or the extended timeclock-x.el -and perhaps the extras in ledgerutils.el +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[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] +\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[CR]ti\f[R] and \f[CR]to\f[R] scripts in the ledger 2.x repository. @@ -5123,15 +5140,15 @@ These rely on a \[dq]timeclock\[dq] executable which I think is just the ledger 2 executable renamed. .PP .SH Timedot -\f[CR]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[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). +human\-readable (you can see at a glance where time was spent). A quick example: .IP .EX -2023-05-01 +2023\-05\-01 hom:errands .... .... ; two hours; the space is ignored fos:hledger:timedot .. ; half an hour per:admin:finance ; no time spent yet @@ -5142,24 +5159,24 @@ postings, where each dot represents \[dq]0.25\[dq]. No commodity symbol is assumed, but we typically interpret it as hours. .IP .EX -$ hledger -f a.timedot print # .timedot file extension (or timedot: prefix) is required -2023-05-01 * +$ 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 .EE .PP 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), +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 -\f[B]An account name\f[R] - any hledger-style account name, optionally +\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] - required if there is an amount (as in +\f[B]Two or more spaces\f[R] \- required if there is an amount (as in journal format). .IP \[bu] 2 \f[B]A timedot amount\f[R], which can be @@ -5183,10 +5200,10 @@ 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]. +with \f[CR]\-\-pivot t\f[R]. .RE .IP \[bu] 2 -\f[B]An optional comment\f[R] following a semicolon (a hledger-style +\f[B]An optional comment\f[R] following a semicolon (a hledger\-style posting comment). .PP There is some flexibility to help with keeping time log data and notes @@ -5197,7 +5214,7 @@ ignored. .IP \[bu] 2 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). +(hledger\[aq]s register reports will show these if you add \-E). .IP \[bu] 2 Before the first date line, lines beginning with \f[CR]*\f[R] (eg org headings) are ignored. @@ -5230,19 +5247,19 @@ biz:research . .EE .IP .EX -$ hledger -f a.timedot print date:2016/2/2 -2016-02-02 * +$ hledger \-f a.timedot print date:2016/2/2 +2016\-02\-02 * (inc:client1) 2.00 -2016-02-02 * +2016\-02\-02 * (biz:research) 0.25 .EE .IP .EX -$ hledger -f a.timedot bal --daily --tree -Balance changes in 2016-02-01-2016-02-03: +$ 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 + || 2016\-02\-01d 2016\-02\-02d 2016\-02\-03d ============++======================================== biz || 0.25 0.25 1.00 research || 0.25 0.25 1.00 @@ -5251,7 +5268,7 @@ Balance changes in 2016-02-01-2016-02-03: 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 @@ -5264,31 +5281,31 @@ Letters: # s support # l learning/research -2023-11-01 +2023\-11\-01 work:adm ccecces .EE .IP .EX -$ hledger -f a.timedot print -2023-11-01 +$ 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 +$ hledger \-f a.timedot bal 1.75 work:adm --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 1.75 .EE .IP .EX -$ hledger -f a.timedot bal --pivot t +$ hledger \-f a.timedot bal \-\-pivot t 1.00 c 0.50 e 0.25 s --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 1.75 .EE .PP @@ -5297,7 +5314,7 @@ Org: .EX * 2023 Work Diary ** Q1 -*** 2023-02-29 +*** 2023\-02\-29 **** DONE 0700 yoga **** UNPLANNED @@ -5305,8 +5322,8 @@ Org: hom:chores cleaning ... water plants - outdoor - one full watering can - indoor - light watering + outdoor \- one full watering can + indoor \- light watering **** TODO adm:planning: trip *** LATER @@ -5321,11 +5338,11 @@ fos.ledger .. .EE .IP .EX -$ hledger -f a.timedot --alias \[aq]/\[rs]./=:\[aq] bal -t +$ hledger \-f a.timedot \-\-alias \[aq]/\[rs]./=:\[aq] bal \-t 4.50 fos 4.00 hledger:timedot 0.50 ledger --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 4.50 .EE .SH PART 3: REPORTING CONCEPTS @@ -5333,38 +5350,38 @@ $ hledger -f a.timedot --alias \[aq]/\[rs]./=:\[aq] bal -t 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 +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 +2023\-01\-02 (a) $1000 .EE .IP .EX $ hledger print -2023-01-02 +2023\-01\-02 (a) $1,000. .EE .PP 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): +disabling digit group marks, eg with \-c/\-\-commodity (for each +affected commodity): .IP .EX -$ hledger print -c \[aq]$1000.00\[aq] -2023-01-02 +$ 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: +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 +$ hledger print \-c \[aq]$1,000.00\[aq] \-\-round=soft +2023\-01\-02 (a) $1,000.00 .EE .PP @@ -5372,7 +5389,7 @@ More generally: hledger output falls into three rough categories, which format amounts a little bit differently to suit different consumers: .PP \f[B]1. -\[dq]hledger-readable output\[dq] - should be readable by hledger (and +\[dq]hledger\-readable output\[dq] \- should be readable by hledger (and by humans)\f[R] .IP \[bu] 2 This is produced by reports that show full journal entries: @@ -5389,7 +5406,7 @@ It can be parsed reliably (by hledger and ledger2beancount at least, but perhaps not by Ledger..) .PP \f[B]2. -\[dq]human-readable output\[dq] - usually for humans\f[R] +\[dq]human\-readable output\[dq] \- usually for humans\f[R] .IP \[bu] 2 This is produced by all other reports. .IP \[bu] 2 @@ -5403,7 +5420,7 @@ know decimals are consistently not being shown, you can assume a single mark is a digit group mark). .PP \f[B]3. -\[dq]machine-readable output\[dq] - usually for other software\f[R] +\[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[CR]csv\f[R], \f[CR]tsv\f[R], \f[CR]json\f[R], or \f[CR]sql\f[R] is @@ -5412,7 +5429,7 @@ selected. It shows amounts as 1 or 2 do, but without digit group marks. .IP \[bu] 2 It can be parsed reliably (if needed, the decimal mark can be changed -with -c/--commodity-style). +with \-c/\-\-commodity\-style). .SH Time periods .SS Report start & end date By default, most hledger reports will show the full span of time @@ -5423,9 +5440,9 @@ 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[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). +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 Some notes: @@ -5435,11 +5452,11 @@ End dates are exclusive, as in Ledger, so you should write the date .IP \[bu] 2 As noted in reporting options: among start/end dates specified with \f[I]options\f[R], the last (i.e. -right-most) option takes precedence. +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[CR]date:\f[R] queries. -That is, \f[CR]date:2019-01 date:2019 -p\[aq]2000 to 2030\[aq]\f[R] +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 @@ -5451,23 +5468,23 @@ Examples: tab(@); lw(12.4n) lw(57.6n). T{ -\f[CR]-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[CR]-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[CR]-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[CR]-p thismonth\f[R] +\f[CR]\-p thismonth\f[R] T}@T{ all transactions in the current month T} @@ -5475,7 +5492,7 @@ T{ \f[CR]date:2016/3/17..\f[R] T}@T{ the above written as queries instead (\f[CR]..\f[R] can also be replaced -with \f[CR]-\f[R]) +with \f[CR]\-\f[R]) T} T{ \f[CR]date:..12/1\f[R] @@ -5494,7 +5511,7 @@ T} 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 -with english words, and have less-significant parts omitted (missing +with english words, and have less\-significant parts omitted (missing parts are inferred as 1). Some examples: .PP @@ -5502,10 +5519,10 @@ Some examples: tab(@); lw(24.2n) lw(45.8n). T{ -\f[CR]2004/10/1\f[R], \f[CR]2004-01-01\f[R], \f[CR]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 +Year is 4+ digits, month is 1\-12, day is 1\-31 T} T{ \f[CR]2004\f[R] @@ -5535,12 +5552,12 @@ T} T{ \f[CR]yesterday, today, tomorrow\f[R] T}@T{ --1, 0, 1 days from today +\-1, 0, 1 days from today T} T{ \f[CR]last/this/next day/week/month/quarter/year\f[R] T}@T{ --1, 0, 1 periods from the current period +\-1, 0, 1 periods from the current period T} T{ \f[CR]in n days/weeks/months/quarters/years\f[R] @@ -5555,7 +5572,7 @@ T} T{ \f[CR]n days/weeks/months/quarters/years ago\f[R] T}@T{ --n periods from the current period +\-n periods from the current period T} T{ \f[CR]20181201\f[R] @@ -5569,7 +5586,7 @@ T}@T{ T} .TE .PP -Some counterexamples - malformed digit sequences might give surprising +Some counterexamples \- malformed digit sequences might give surprising results: .PP .TS @@ -5578,12 +5595,12 @@ lw(11.4n) lw(58.6n). T{ \f[CR]201813\f[R] T}@T{ -6 digits with an invalid month is parsed as start of 6-digit year +6 digits with an invalid month is parsed as start of 6\-digit year T} T{ \f[CR]20181301\f[R] T}@T{ -8 digits with an invalid month is parsed as start of 8-digit year +8 digits with an invalid month is parsed as start of 8\-digit year T} T{ \f[CR]20181232\f[R] @@ -5597,29 +5614,30 @@ T}@T{ T} .TE .PP -\[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. +\[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[CR]--today\f[R].) +\f[CR]\-\-today\f[R].) .SS Report intervals A report interval can be specified so that reports like register, -balance or activity become multi-period, showing each subperiod as a +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: +The following standard intervals can be enabled with command\-line +flags: .IP \[bu] 2 -\f[CR]-D/--daily\f[R] +\f[CR]\-D/\-\-daily\f[R] .IP \[bu] 2 -\f[CR]-W/--weekly\f[R] +\f[CR]\-W/\-\-weekly\f[R] .IP \[bu] 2 -\f[CR]-M/--monthly\f[R] +\f[CR]\-M/\-\-monthly\f[R] .IP \[bu] 2 -\f[CR]-Q/--quarterly\f[R] +\f[CR]\-Q/\-\-quarterly\f[R] .IP \[bu] 2 -\f[CR]-Y/--yearly\f[R] +\f[CR]\-Y/\-\-yearly\f[R] .PP -More complex intervals can be specified using \f[CR]-p/--period\f[R], +More complex intervals can be specified using \f[CR]\-p/\-\-period\f[R], described below. .SS Date adjustment When there is a report interval (other than daily), report start/end @@ -5635,16 +5653,16 @@ 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[CR]-b\f[R], \f[CR]-e\f[R], \f[CR]-p\f[R] or \f[CR]date:\f[R], will +\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 +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 -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. +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 first quarter of 2009): @@ -5653,13 +5671,13 @@ first quarter of 2009): tab(@); l. T{ -\f[CR]-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 Several keywords like \[dq]from\[dq] and \[dq]to\[dq] are supported for readability; these are optional. -\[dq]to\[dq] can also be written as \[dq]..\[dq] or \[dq]-\[dq]. +\[dq]to\[dq] can also be written as \[dq]..\[dq] or \[dq]\-\[dq]. The spaces are also optional, as long as you don\[aq]t run two dates together. So the following are equivalent to the above: @@ -5668,13 +5686,13 @@ So the following are equivalent to the above: tab(@); l. T{ -\f[CR]-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[CR]-p2009/1/1to2009/4/1\f[R] +\f[CR]\-p2009/1/1to2009/4/1\f[R] T} T{ -\f[CR]-p2009/1/1..2009/4/1\f[R] +\f[CR]\-p2009/1/1..2009/4/1\f[R] T} .TE .PP @@ -5685,13 +5703,13 @@ equivalent to the above: tab(@); l. T{ -\f[CR]-p \[dq]1/1 4/1\[dq]\f[R] +\f[CR]\-p \[dq]1/1 4/1\[dq]\f[R] T} T{ -\f[CR]-p \[dq]jan-apr\[dq]\f[R] +\f[CR]\-p \[dq]jan\-apr\[dq]\f[R] T} T{ -\f[CR]-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 @@ -5702,22 +5720,22 @@ earliest or latest transaction date in the journal: tab(@); l l. T{ -\f[CR]-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[CR]-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[CR]-p \[dq]from 2009\[dq]\f[R] +\f[CR]\-p \[dq]from 2009\[dq]\f[R] T}@T{ the same T} T{ -\f[CR]-p \[dq]to 2009\[dq]\f[R] +\f[CR]\-p \[dq]to 2009\[dq]\f[R] T}@T{ everything before january 1, 2009 T} @@ -5729,34 +5747,34 @@ You can also specify a period by writing a single partial or full date: tab(@); lw(14.5n) lw(55.5n). T{ -\f[CR]-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[CR]-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[CR]-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} .TE .PP -or by using the \[dq]Q\[dq] quarter-year syntax (case insensitive): +or by using the \[dq]Q\[dq] quarter\-year syntax (case insensitive): .PP .TS tab(@); lw(15.3n) lw(54.7n). T{ -\f[CR]-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[CR]-p \[dq]q4\[dq]\f[R] +\f[CR]\-p \[dq]q4\[dq]\f[R] T}@T{ fourth quarter of the current year T} @@ -5769,13 +5787,13 @@ from the start/end dates (if any) by a space or the word \f[CR]in\f[R]: tab(@); l. T{ -\f[CR]-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[CR]-p \[dq]monthly in 2008\[dq]\f[R] +\f[CR]\-p \[dq]monthly in 2008\[dq]\f[R] T} T{ -\f[CR]-p \[dq]quarterly\[dq]\f[R] +\f[CR]\-p \[dq]quarterly\[dq]\f[R] T} .TE .SS More complex report intervals @@ -5797,8 +5815,8 @@ Weekly on a custom day: \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[CR]every WEEKDAYNAME\f[R] (full or three-letter english weekday name, -case insensitive) +\f[CR]every WEEKDAYNAME\f[R] (full or three\-letter english weekday +name, case insensitive) .PP Monthly on a custom day: .IP \[bu] 2 @@ -5810,7 +5828,7 @@ Yearly on a custom day: .IP \[bu] 2 \f[CR]every MM/DD [of year]\f[R] (month number and day of month number) .IP \[bu] 2 -\f[CR]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[CR]every DDth MONTHNAME [of year]\f[R] (equivalent to the above) @@ -5821,49 +5839,49 @@ Examples: tab(@); lw(26.8n) lw(43.2n). T{ -\f[CR]-p \[dq]bimonthly from 2008\[dq]\f[R] +\f[CR]\-p \[dq]bimonthly from 2008\[dq]\f[R] T}@T{ T} T{ -\f[CR]-p \[dq]every 2 weeks\[dq]\f[R] +\f[CR]\-p \[dq]every 2 weeks\[dq]\f[R] T}@T{ T} T{ -\f[CR]-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[CR]-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[CR]-p \[dq]every Tue\[dq]\f[R] +\f[CR]\-p \[dq]every Tue\[dq]\f[R] T}@T{ same T} T{ -\f[CR]-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[CR]-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[CR]-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[CR]-p \[dq]every 5th November\[dq]\f[R] +\f[CR]\-p \[dq]every 5th November\[dq]\f[R] T}@T{ same T} T{ -\f[CR]-p \[dq]every Nov 5th\[dq]\f[R] +\f[CR]\-p \[dq]every Nov 5th\[dq]\f[R] T}@T{ same T} @@ -5873,27 +5891,27 @@ Show historical balances at end of the 15th day of each month (N is an end date, exclusive as always): .IP .EX -$ hledger balance -H -p \[dq]every 16th day\[dq] +$ hledger balance \-H \-p \[dq]every 16th day\[dq] .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 .EX -$ hledger register checking -p \[dq]every 3rd day of week\[dq] +$ hledger register checking \-p \[dq]every 3rd day of week\[dq] .EE .SS Multiple weekday intervals This special form is also supported: .IP \[bu] 2 -\f[CR]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[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[CR]--forecast\f[R], to generate -periodic transactions on arbitrary days of the week. -It may be less useful with \f[CR]-p\f[R], since it divides each week +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[CR]\-p\f[R], since it divides each week into subperiods of unequal length, which is unusual. (Related: #1632) .PP @@ -5903,65 +5921,89 @@ Examples: tab(@); lw(17.8n) lw(52.2n). T{ -\f[CR]-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 +dates will be Mon, Wed, Fri; periods will be Mon\-Tue, Wed\-Thu, +Fri\-Sun T} T{ -\f[CR]-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 +Thu, Fri\-Sun T} T{ -\f[CR]-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 +dates will be Sat, Sun; periods will be Sat, Sun\-Fri T} .TE .SH Depth -With the \f[CR]--depth NUM\f[R] option (short form: \f[CR]-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[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 +\f[CR]depth:2\f[R], \f[CR]\-\-depth=2\f[R] or \f[CR]\-2\f[R] are equivalent. .SH Queries 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 -scope. -The syntax is as follows: +Most hledger commands accept query arguments, to restrict their scope. +Multiple query terms can be provided to build up a more complex query. .IP \[bu] 2 -Zero or more space-separated query terms. -These are most often account name substrings: +By default, a query term is interpreted as a case\-insensitive substring +pattern for matching account names: .RS 2 .PP -\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[CR]\[dq]personal care\[dq]\f[R] -.RE -.IP \[bu] 2 -Regular expressions are also supported: -.RS 2 -.PP -\f[CR]\[dq]\[ha]expenses\[rs]b\[dq]\f[R] +\f[CR]car:fuel\f[R] +.PD 0 +.P +.PD +\f[CR]dining groceries\f[R] .PD 0 .P .PD -\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: +Patterns containing spaces or other special characters must be enclosed +in single or double quotes: .RS 2 .PP -\f[CR]date:202312-\f[R] +\f[CR]\[aq]personal care\[aq]\f[R] +.PD 0 +.P +.PD +.RE +.IP \[bu] 2 +These patterns are actually regular expressions, so you can add regexp +metacharacters for more precision (see \[dq]Regular expressions\[dq] +above for details): +.RS 2 +.PP +\f[CR]\[aq]\[ha]expenses\[rs]b\[aq]\f[R] +.PD 0 +.P +.PD +\f[CR]\[aq]food$\[aq]\f[R] +.PD 0 +.P +.PD +\f[CR]\[aq]fuel|repair\[aq]\f[R] +.PD 0 +.P +.PD +\f[CR]\[aq]accounts (payable|receivable)\[aq]\f[R] +.PD 0 +.P +.PD +.RE +.IP \[bu] 2 +To match something other than account name, add one of the query type +prefixes described in \[dq]Query types\[dq] below: +.RS 2 +.PP +\f[CR]date:202312\-\f[R] .PD 0 .P .PD @@ -5977,48 +6019,66 @@ Add a query type prefix to match other parts of the data: .PD 0 .P .PD -\f[CR]\[dq]amt:>0\[dq]\f[R] -.RE -.IP \[bu] 2 -Add a \f[CR]not:\f[R] prefix to negate: -.RS 2 -.PP -\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[CR]date:2022 desc:amazon desc:amzn\f[R] +\f[CR]cur:\[rs]\[rs]$\f[R] .PD 0 .P .PD -(all transactions with \[dq]amazon\[dq] or \[dq]amzn\[dq] in description -during 2022) +\f[CR]amt:\[aq]>0\[aq]\f[R] +.PD 0 +.P +.PD +.RE +.IP \[bu] 2 +Add a \f[CR]not:\f[R] prefix to negate a term: +.RS 2 +.PP +\f[CR]not:status:\[aq]*\[aq]\f[R] +.PD 0 +.P +.PD +\f[CR]not:desc:\[aq]opening|closing\[aq]\f[R] +.PD 0 +.P +.PD +\f[CR]not:cur:USD\f[R] +.PD 0 +.P +.PD +.RE +.IP \[bu] 2 +Terms with different types are AND\-ed, terms with the same type are +OR\-ed (mostly; see \[dq]Combining query terms\[dq] below). +The following query: +.RS 2 +.PP +\f[CR]date:2022 desc:amazon desc:amzn\f[R] +.PP +is interpreted as: +.PP +\f[I]date is in 2022 AND ( transaction description contains +\[dq]amazon\[dq] OR \[dq]amzn\[dq] )\f[R] .RE .SS Query types Here are the types of query term available. Remember these can also be prefixed with \f[B]\f[CB]not:\f[B]\f[R] to convert them into a negative match. .PP -\f[B]\f[CB]acct:REGEX\f[B], \f[CB]REGEX\f[B]\f[R] +\f[B]\f[CB]acct:REGEX\f[B]\f[R] or \f[B]\f[CB]REGEX\f[B]\f[R] .PD 0 .P .PD -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[CR]expenses\f[R] or \f[CR]food\f[R]. +Match account names containing this case insensitive regular expression. +This is the default query type, so we usually don\[aq]t bother writing +the \[dq]acct:\[dq] prefix. .PP \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 +Match postings with a single\-commodity amount equal to, less than, or +greater than N. (Postings with multi\-commodity amounts are not tested and will always match.) -The comparison has two modes: if N is preceded by a + or - sign (or is +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 @@ -6035,7 +6095,7 @@ Match by transaction code (eg check number). Match postings or transactions including any amounts whose currency/commodity symbol is fully matched by REGEX. (For a partial match, use \f[CR].*REGEX.*\f[R]). -Note, to match special characters which are regex-significant, you need +Note, to match special characters which are regex\-significant, you need 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. @@ -6055,7 +6115,7 @@ Match transaction descriptions. .PD 0 .P .PD -Match dates (or with the \f[CR]--date2\f[R] flag, secondary dates) +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: @@ -6063,14 +6123,14 @@ Examples: .P .PD \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]. +\f[CR]date:2/1\-2/15\f[R], \f[CR]date:2021\-07\-27..nextquarter\f[R]. .PP \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[CR]--date2\f[R] flag). +\f[CR]\-\-date2\f[R] flag). .PP \f[B]\f[CB]depth:N\f[B]\f[R] .PD 0 @@ -6118,7 +6178,7 @@ Match unmarked, pending, or cleared transactions respectively. .P .PD Match by account type (see Declaring accounts > Account types). -\f[CR]TYPECODES\f[R] is one or more of the single-letter account type +\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). @@ -6144,10 +6204,10 @@ Transactions also acquire the tags of their postings. .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.) +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 -When given multiple space-separated query terms, most commands select +When given multiple space\-separated query terms, most commands select things which match: .IP \[bu] 2 any of the description terms AND @@ -6192,16 +6252,16 @@ the \[aq]A\[aq] tag Match transactions NOT involving the \[aq]expenses:food\[aq] account OR with the \[aq]A\[aq] tag AND involving the \[aq]expenses:drink\[aq] account. -(the AND is implicitly added by space-separation, following the rules +(the AND is implicitly added by space\-separation, following the rules above) .RS 2 .PP \f[CR]expr:\[dq]expenses:food OR (tag:A expenses:drink)\[dq]\f[R] .RE .SS Queries and command options -Some queries can also be expressed as command-line options: -\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. +Some queries can also be expressed as command\-line options: +\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 @@ -6210,7 +6270,7 @@ 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 -When account names are rewritten with \f[CR]--alias\f[R] or +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 @@ -6222,7 +6282,7 @@ Note: this changed in hledger 1.22, previously it was the reverse, see the discussion at #1625. .SH Pivoting Normally, hledger groups and sums amounts within each account. -The \f[CR]--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[CR]acct\f[R], @@ -6232,7 +6292,7 @@ When pivoting on a tag and a posting has multiple values of that tag, only the first value is 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, +Multiple, colon\-delimited fields can be pivoted simultaneously, generating a hierarchical account name. .PP Some examples: @@ -6240,7 +6300,7 @@ Some examples: .EX 2016/02/16 Yearly Dues Payment assets:bank account 2 EUR - income:dues -2 EUR ; member: John Doe, kind: Lifetime + income:dues \-2 EUR ; member: John Doe, kind: Lifetime .EE .PP Normal balance report showing account names: @@ -6248,47 +6308,47 @@ Normal balance report showing account names: .EX $ hledger balance 2 EUR assets:bank account - -2 EUR income:dues --------------------- + \-2 EUR income:dues +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP Pivoted balance report, using member: tag values instead: .IP .EX -$ hledger balance --pivot member +$ hledger balance \-\-pivot member 2 EUR - -2 EUR John Doe --------------------- + \-2 EUR John Doe +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP One way to show only amounts with a member: value (using a query): .IP .EX -$ hledger balance --pivot member tag:member=. - -2 EUR John Doe --------------------- - -2 EUR +$ hledger balance \-\-pivot member tag:member=. + \-2 EUR John Doe +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + \-2 EUR .EE .PP Another way (the acct: query matches against the pivoted \[dq]account name\[dq]): .IP .EX -$ hledger balance --pivot member acct:. - -2 EUR John Doe --------------------- - -2 EUR +$ hledger balance \-\-pivot member acct:. + \-2 EUR John Doe +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + \-2 EUR .EE .PP Hierarchical reports can be generated with multiple pivots: .IP .EX -$ hledger balance Income:Dues --pivot kind:member - -2 EUR Lifetime:John Doe --------------------- - -2 EUR +$ hledger balance Income:Dues \-\-pivot kind:member + \-2 EUR Lifetime:John Doe +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + \-2 EUR .EE .SH Generating data hledger has several features for generating data, such as: @@ -6296,20 +6356,20 @@ hledger has several features for generating data, such as: 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[CR]--forecast\f[R] option. +They are activated by the \f[CR]\-\-forecast\f[R] option. .IP \[bu] 2 -The balance command\[aq]s \f[CR]--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[CR]--auto\f[R] flag they are applied to transactions recorded in the -journal as well. +\f[CR]\-\-auto\f[R] flag they are applied to transactions recorded in +the journal as well. .IP \[bu] 2 -The \f[CR]--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[CR]--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. @@ -6319,42 +6379,42 @@ 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[CR]--verbose-tags\f[R] flag. +\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]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[CR]tag:_generated-transaction\f[R]. +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[CR]tag:_generated\-transaction\f[R]. .SH Forecasting 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. +record a bunch of future\-dated transactions. 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 -There is another way: with the \f[CR]--forecast\f[R] option, hledger can -generate temporary \[dq]forecast transactions\[dq] for reporting +that with \f[CR]\-f\f[R] only when you want to see them. +.SS \-\-forecast +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. Each rule can generate multiple recurring transactions, so by changing one rule you can change many forecasted transactions. -(These same rules can also generate budget goals, described in -Budgeting.) .PP Forecast transactions usually start after ordinary transactions end. -By default, they begin after your latest-dated ordinary transaction, or +By default, they begin after your latest\-dated ordinary transaction, or today, whichever is later, and they end six months from today. (The exact rules are a little more complicated, and are given below.) .PP This is the \[dq]forecast period\[dq], which need not be the same as the 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[CR]--forecast=..2099\f[R] or \f[CR]--forecast=2023-02-15..\f[R]. +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[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 \f[CR]print\f[R] is the best command for inspecting and troubleshooting @@ -6362,76 +6422,76 @@ forecast transactions. Eg: .IP .EX -\[ti] monthly from 2022-12-20 rent +\[ti] monthly from 2022\-12\-20 rent assets:bank:checking expenses:rent $1000 .EE .IP .EX -$ hledger print --forecast --today=2023/4/21 -2023-05-20 rent - ; generated-transaction: \[ti] monthly from 2022-12-20 +$ hledger print \-\-forecast \-\-today=2023/4/21 +2023\-05\-20 rent + ; generated\-transaction: \[ti] monthly from 2022\-12\-20 assets:bank:checking expenses:rent $1000 -2023-06-20 rent - ; generated-transaction: \[ti] monthly from 2022-12-20 +2023\-06\-20 rent + ; generated\-transaction: \[ti] monthly from 2022\-12\-20 assets:bank:checking expenses:rent $1000 -2023-07-20 rent - ; generated-transaction: \[ti] monthly from 2022-12-20 +2023\-07\-20 rent + ; generated\-transaction: \[ti] monthly from 2022\-12\-20 assets:bank:checking expenses:rent $1000 -2023-08-20 rent - ; generated-transaction: \[ti] monthly from 2022-12-20 +2023\-08\-20 rent + ; generated\-transaction: \[ti] monthly from 2022\-12\-20 assets:bank:checking expenses:rent $1000 -2023-09-20 rent - ; generated-transaction: \[ti] monthly from 2022-12-20 +2023\-09\-20 rent + ; generated\-transaction: \[ti] monthly from 2022\-12\-20 assets:bank:checking expenses:rent $1000 .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[CR]--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 Forecast transactions affect all reports, as you would expect. Eg: .IP .EX -$ hledger areg rent --forecast --today=2023/4/21 +$ hledger areg rent \-\-forecast \-\-today=2023/4/21 Transactions in expenses:rent and subaccounts: -2023-05-20 rent as:ba:checking $1000 $1000 -2023-06-20 rent as:ba:checking $1000 $2000 -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 +2023\-05\-20 rent as:ba:checking $1000 $1000 +2023\-06\-20 rent as:ba:checking $1000 $2000 +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 .EE .IP .EX -$ hledger bal -M expenses --forecast --today=2023/4/21 -Balance changes in 2023-05-01..2023-09-30: +$ hledger bal \-M expenses \-\-forecast \-\-today=2023/4/21 +Balance changes in 2023\-05\-01..2023\-09\-30: || May Jun Jul Aug Sep ===============++=================================== expenses:rent || $1000 $1000 $1000 $1000 $1000 ----------------++----------------------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- || $1000 $1000 $1000 $1000 $1000 .EE .SS Forecast tags -Forecast transactions generated by --forecast have a hidden tag, -\f[CR]_generated-transaction\f[R]. +Forecast transactions generated by \-\-forecast have a hidden tag, +\f[CR]_generated\-transaction\f[R]. So if you ever need to match forecast transactions, you could use -\f[CR]tag:_generated-transaction\f[R] (or just \f[CR]tag:generated\f[R]) -in a query. +\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[CR]--verbose-tags\f[R] flag. -Then, visible \f[CR]generated-transaction\f[R] tags will be added also, +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 @@ -6446,14 +6506,14 @@ the later of .IP \[bu] 2 the start date in the periodic transaction rule .IP \[bu] 2 -the start date in \f[CR]--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[CR]-b\f[R]/\f[CR]-p\f[R]/\f[CR]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 @@ -6467,58 +6527,58 @@ the earlier of .IP \[bu] 2 the end date in the periodic transaction rule .IP \[bu] 2 -the end date in \f[CR]--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[CR]-e\f[R]/\f[CR]-p\f[R]/\f[CR]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 -When --forecast is not doing what you expect, one of these tips should +When \-\-forecast is not doing what you expect, one of these tips should help: .IP \[bu] 2 -Remember to use the \f[CR]--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[CR]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 +Check for typos or too\-restrictive start/end dates in your periodic transaction rule. .IP \[bu] 2 Leave at least 2 spaces between the rule\[aq]s period expression and description fields. .IP \[bu] 2 -Check for future-dated ordinary transactions suppressing forecasted +Check for future\-dated ordinary transactions suppressing forecasted transactions. .IP \[bu] 2 -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] +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[CR]-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[CR]--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[CR]--debug=2\f[R] (eg). +Check inside the engine: add \f[CR]\-\-debug=2\f[R] (eg). .SH Budgeting -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. +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[CR]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 -In some transactions - for example a currency conversion, or a purchase -or sale of stock - one commodity is exchanged for another. +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 (when buying) or selling price (when selling). In hledger docs we just say \[dq]cost\[dq], for convenience; feel free @@ -6536,22 +6596,22 @@ described in Journal > Costs: \f[B]Variant 1\f[R] .IP .EX -2022-01-01 - assets:dollars $-135 +2022\-01\-01 + assets:dollars $\-135 assets:euros €100 \[at] $1.35 ; $1.35 per euro (unit cost) .EE .PP \f[B]Variant 2\f[R] .IP .EX -2022-01-01 - assets:dollars $-135 +2022\-01\-01 + assets:dollars $\-135 assets:euros €100 \[at]\[at] $135 ; $135 total cost .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 -the per-unit cost basis, and makes stock sales easier. +the per\-unit cost basis, and makes stock sales easier. .PP Costs can also be left implicit, and hledger will infer the cost that is consistent with a balanced transaction: @@ -6559,31 +6619,31 @@ consistent with a balanced transaction: \f[B]Variant 3\f[R] .IP .EX -2022-01-01 - assets:dollars $-135 +2022\-01\-01 + assets:dollars $\-135 assets:euros €100 .EE .PP 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]). +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. For example, if you accidentally wrote €10 instead of €100, hledger would not be able to detect the mistake. .IP \[bu] 2 -It is sensitive to the order of postings - if they were reversed, a +It is sensitive to the order of postings \- if they were reversed, a different entry would be inferred and reports would be different. .IP \[bu] 2 -The per-unit cost basis is not easy to read. +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[CR]-s\f[R] (strict +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 -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 +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). Ie they will be displayed \[dq]at cost\[dq] or \[dq]at sale price\[dq]. .PP @@ -6596,11 +6656,11 @@ 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 -There is a problem with the entries above - they are not conventional +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 +This shows up as a non\-zero grand total in balance reports like \f[CR]hledger bse\f[R]. .PP For most hledger users, this doesn\[aq]t matter in practice and can @@ -6614,47 +6674,47 @@ Of course you can do this in hledger as well: \f[B]Variant 4\f[R] .IP .EX -2022-01-01 - assets:dollars $-135 +2022\-01\-01 + assets:dollars $\-135 assets:euros €100 equity:conversion $135 - equity:conversion €-100 + equity:conversion €\-100 .EE .PP Now the transaction is perfectly balanced according to standard DEB, and \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[CR]--infer-costs\f[R] flag +not done by default \- you must add the \f[CR]\-\-infer\-costs\f[R] flag like so: .IP .EX -$ hledger print --infer-costs -2022-01-01 one hundred euros purchased at $1.35 each - assets:dollars $-135 \[at]\[at] €100 +$ 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 + equity:conversion €\-100 .EE .IP .EX -$ hledger bal --infer-costs -B - €-100 assets:dollars +$ hledger bal \-\-infer\-costs \-B + €\-100 assets:dollars €100 assets:euros --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP Here are some downsides of this kind of entry: .IP \[bu] 2 -The per-unit cost basis is not easy to read. +The per\-unit cost basis is not easy to read. .IP \[bu] 2 -Instead of \f[CR]-B\f[R] you must remember to type -\f[CR]-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[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. +\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. @@ -6662,43 +6722,43 @@ More on this below. 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[CR]--infer-equity\f[R] flag. +\f[CR]\-\-infer\-equity\f[R] flag. Eg: .IP .EX -2022-01-01 - assets:dollars -$135 +2022\-01\-01 + assets:dollars \-$135 assets:euros €100 \[at] $1.35 .EE .IP .EX -$ hledger print --infer-equity -2022-01-01 - assets:dollars $-135 +$ hledger print \-\-infer\-equity +2022\-01\-01 + assets:dollars $\-135 assets:euros €100 \[at] $1.35 - equity:conversion:$-€:€ €-100 - equity:conversion:$-€:$ $135.00 + equity:conversion:$\-€:€ €\-100 + equity:conversion:$\-€:$ $135.00 .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 +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[CR]V\f[R]/\f[CR]Conversion\f[R] account type. .SS Combining costs and equity conversion postings 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 -equation, revealing the per-unit cost basis, and providing more +This in theory gives the best of all worlds \- preserving the accounting +equation, revealing the per\-unit cost basis, and providing more flexibility in how you write the entry: .PP \f[B]Variant 5\f[R] .IP .EX -2022-01-01 one hundred euros purchased at $1.35 each - assets:dollars $-135 +2022\-01\-01 one hundred euros purchased at $1.35 each + assets:dollars $\-135 equity:conversion $135 - equity:conversion €-100 + equity:conversion €\-100 assets:euros €100 \[at] $1.35 .EE .PP @@ -6706,13 +6766,11 @@ All the other variants above can (usually) be rewritten to this final form with: .IP .EX -$ hledger print -x --infer-costs --infer-equity +$ hledger print \-x \-\-infer\-costs \-\-infer\-equity .EE .PP Downsides: .IP \[bu] 2 -This was added in hledger-1.29 and is still somewhat experimental. -.IP \[bu] 2 The precise format of the journal entry becomes more important. If hledger can\[aq]t detect and match up the cost and equity postings, it will give a transaction balancing error. @@ -6721,15 +6779,15 @@ 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 -\f[CR]--infer-costs\f[R] has certain requirements (unlike -\f[CR]--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. +Two non\-equity postings, in different commodities. Their order is significant: the cost will be added to the first of them. .IP \[bu] 2 Two postings to equity conversion accounts, next to one another, which -balance the two non-equity postings. +balance the two non\-equity postings. This balancing is checked to the same precision (number of decimal places) used in the conversion posting\[aq]s amount. Equity conversion accounts are: @@ -6743,9 +6801,9 @@ otherwise, accounts named \f[CR]equity:conversion\f[R], subaccounts. .RE .PP -And multiple such four-posting groups can coexist within a single +And multiple such four\-posting groups can coexist within a single transaction. -When \f[CR]--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 @@ -6754,12 +6812,12 @@ 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 ? -Should \f[CR]--infer-costs\f[R] and \f[CR]--infer-equity\f[R] be enabled -by default ? +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 .EX -alias h=\[dq]hledger --infer-equity --infer-costs\[dq] +alias h=\[dq]hledger \-\-infer\-equity \-\-infer\-costs\[dq] .EE .PP and let us know what problems you find. @@ -6769,19 +6827,19 @@ Instead of reporting amounts in their original commodity, hledger can convert them to cost/sale amount (using the conversion rate recorded in the transaction), and/or to market value (using some market price on a certain date). -This is controlled by the \f[CR]--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[CR]-V\f[R] and \f[CR]-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 -The \f[CR]-V/--market\f[R] flag converts amounts to market value in +.SS \-V: Value +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 -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 \-X: Value in specified commodity +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 Market prices can change from day to day. hledger will use the prices on a particular valuation date (or on more @@ -6800,10 +6858,10 @@ if it\[aq]s in the future) .IP \[bu] 2 For multiperiod reports, each period is valued on its last day. .PP -This can be customised with the --value option described below, which +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 +(Note, this has a bug in hledger\-ui <=1.31: turning on valuation with the \f[CR]V\f[R] key always resets it to \[dq]end\[dq].) .SS Finding market price To convert a commodity A to its market value in another commodity B, @@ -6812,8 +6870,8 @@ 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[CR]--infer-market-prices\f[R] -flag) inferred from costs. +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 @@ -6830,31 +6888,31 @@ 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[CR]--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 +.SS \-\-infer\-market\-prices: market prices from transactions Normally, market value in hledger is fully controlled by, and requires, P directives in your journal. Since adding and updating those can be a chore, and since transactions usually take place at close to market value, why not use the recorded costs as additional market prices (as Ledger does) ? -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. +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[CR]hledger bs -V --infer-market-prices\f[R] will get -market prices both from P directives and from transactions. +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[CR]--debug\f[R] or \f[CR]--debug=2\f[R] to -troubleshoot. +carefully, and try adding \f[CR]\-\-debug\f[R] or \f[CR]\-\-debug=2\f[R] +to troubleshoot. .PP -\f[CR]--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[CR]\[at]\f[R]/\f[CR]\[at]\[at]\f[R]) @@ -6862,54 +6920,55 @@ multicommodity transactions with explicit prices multicommodity transactions with implicit prices (no \f[CR]\[at]\f[R], two commodities, unbalanced). (With these, the order of postings matters. -\f[CR]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[CR]--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[CR]--infer-market-prices\f[R] do not -help select a default valuation commodity, as \f[CR]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[CR]--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[CR]-X EUR --infer-market-prices\f[R], not -\f[CR]-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[CR]--value=then,EUR --infer-market-prices\f[R], not -\f[CR]--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 .EX -2022-01-01 Positive Unit prices +2022\-01\-01 Positive Unit prices a A 1 - b B -1 \[at] A 1 + b B \-1 \[at] A 1 -2022-01-01 Positive Total prices +2022\-01\-01 Positive Total prices a A 1 - b B -1 \[at]\[at] A 1 + b B \-1 \[at]\[at] A 1 -2022-01-02 Negative unit prices +2022\-01\-02 Negative unit prices a A 1 - b B 1 \[at] A -1 + b B 1 \[at] A \-1 -2022-01-02 Negative total prices +2022\-01\-02 Negative total prices a A 1 - b B 1 \[at]\[at] A -1 + b B 1 \[at]\[at] A \-1 -2022-01-03 Double Negative unit prices - a A -1 - b B -1 \[at] A -1 +2022\-01\-03 Double Negative unit prices + a A \-1 + b B \-1 \[at] A \-1 -2022-01-03 Double Negative total prices - a A -1 - b B -1 \[at]\[at] A -1 +2022\-01\-03 Double Negative total prices + a A \-1 + b B \-1 \[at]\[at] A \-1 .EE .PP All of the transactions above are considered balanced (and on each day, @@ -6917,54 +6976,55 @@ the two transactions are considered equivalent). Here are the market prices inferred for B: .IP .EX -$ hledger -f- --infer-market-prices prices -P 2022-01-01 B A 1 -P 2022-01-01 B A 1.0 -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 +$ hledger \-f\- \-\-infer\-market\-prices prices +P 2022\-01\-01 B A 1 +P 2022\-01\-01 B A 1.0 +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 .EE .SS Valuation commodity -\f[B]When you specify a valuation commodity (\f[CB]-X COMM\f[B] or -\f[CB]--value TYPE,COMM\f[B]):\f[R] +\f[B]When you specify a valuation commodity (\f[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[CB]-V\f[B] -or \f[CB]--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 For each commodity A, hledger picks a default valuation commodity as follows, in this order of preference: .IP "1." 3 -The price commodity from the latest P-declared market price for A on or +The price commodity from the latest P\-declared market price for A on or before valuation date. .IP "2." 3 -The price commodity from the latest P-declared market price for A on any -date. +The price commodity from the latest P\-declared market price for A on +any date. (Allows conversion to proceed when there are inferred prices before the valuation date.) .IP "3." 3 If there are no P directives at all (any commodity or date) and the -\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. +\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[CR]-V\f[R] -will convert, and to what. +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[CR]--infer-market-prices\f[R] flag, costs determine it. +\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 -Here are some quick examples of \f[CR]-V\f[R]: +Here are some quick examples of \f[CR]\-V\f[R]: .IP .EX ; one euro is worth this many dollars from nov 1 @@ -6982,14 +7042,14 @@ P 2016/12/21 € $1.03 How many euros do I have ? .IP .EX -$ hledger -f t.j bal -N euros +$ hledger \-f t.j bal \-N euros €100 assets:euros .EE .PP What are they worth at end of nov 3 ? .IP .EX -$ hledger -f t.j bal -N euros -V -e 2016/11/4 +$ hledger \-f t.j bal \-N euros \-V \-e 2016/11/4 $110.00 assets:euros .EE .PP @@ -6997,133 +7057,134 @@ What are they worth after 2016/12/21 ? (no report end date specified, defaults to today) .IP .EX -$ hledger -f t.j bal -N euros -V +$ hledger \-f t.j bal \-N euros \-V $103.00 assets:euros .EE -.SS --value: Flexible valuation -\f[CR]-V\f[R] and \f[CR]-X\f[R] are special cases of the more general -\f[CR]--value\f[R] option: +.SS \-\-value: Flexible valuation +\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 .EX - --value=TYPE[,COMM] TYPE is then, end, now or YYYY-MM-DD. + \-\-value=TYPE[,COMM] TYPE is then, end, now or YYYY\-MM\-DD. COMM is an optional commodity symbol. Shows amounts converted to: - - default valuation commodity (or COMM) using market prices at posting dates - - 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 + \- default valuation commodity (or COMM) using market prices at posting dates + \- 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 .EE .PP The TYPE part selects cost or value and valuation date: .TP -\f[CR]--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[CR]--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[CR]--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[CR]--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[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]. +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 -Here are some examples showing the effect of \f[CR]--value\f[R], as seen -with \f[CR]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 .EX -P 2000-01-01 A 1 B -P 2000-02-01 A 2 B -P 2000-03-01 A 3 B -P 2000-04-01 A 4 B +P 2000\-01\-01 A 1 B +P 2000\-02\-01 A 2 B +P 2000\-03\-01 A 3 B +P 2000\-04\-01 A 4 B -2000-01-01 +2000\-01\-01 (a) 1 A \[at] 5 B -2000-02-01 +2000\-02\-01 (a) 1 A \[at] 6 B -2000-03-01 +2000\-03\-01 (a) 1 A \[at] 7 B .EE .PP Show the cost of each posting: .IP .EX -$ hledger -f- print --cost -2000-01-01 +$ hledger \-f\- print \-\-cost +2000\-01\-01 (a) 5 B -2000-02-01 +2000\-02\-01 (a) 6 B -2000-03-01 +2000\-03\-01 (a) 7 B .EE .PP -Show the value as of the last day of the report period (2000-02-29): +Show the value as of the last day of the report period (2000\-02\-29): .IP .EX -$ hledger -f- print --value=end date:2000/01-2000/03 -2000-01-01 +$ hledger \-f\- print \-\-value=end date:2000/01\-2000/03 +2000\-01\-01 (a) 2 B -2000-02-01 +2000\-02\-01 (a) 2 B .EE .PP With no report period specified, that shows the value as of the last day -of the journal (2000-03-01): +of the journal (2000\-03\-01): .IP .EX -$ hledger -f- print --value=end -2000-01-01 +$ hledger \-f\- print \-\-value=end +2000\-01\-01 (a) 3 B -2000-02-01 +2000\-02\-01 (a) 3 B -2000-03-01 +2000\-03\-01 (a) 3 B .EE .PP -Show the current value (the 2000-04-01 price is still in effect today): +Show the current value (the 2000\-04\-01 price is still in effect +today): .IP .EX -$ hledger -f- print --value=now -2000-01-01 +$ hledger \-f\- print \-\-value=now +2000\-01\-01 (a) 4 B -2000-02-01 +2000\-02\-01 (a) 4 B -2000-03-01 +2000\-03\-01 (a) 4 B .EE .PP Show the value on 2000/01/15: .IP .EX -$ hledger -f- print --value=2000-01-15 -2000-01-01 +$ hledger \-f\- print \-\-value=2000\-01\-15 +2000\-01\-01 (a) 1 B -2000-02-01 +2000\-02\-01 (a) 1 B -2000-03-01 +2000\-03\-01 (a) 1 B .EE .SS Interaction of valuation and queries @@ -7139,12 +7200,12 @@ all other parts. .RE .IP "2." 3 The postings are matched to the currency and amount queries based on -pre-valued amounts. +pre\-valued amounts. .IP "3." 3 Valuation is applied to the postings. .IP "4." 3 The postings are matched to the other parts of the query based on -post-valued amounts. +post\-valued amounts. .PP See: 1625 .SS Effect of valuation on reports @@ -7162,15 +7223,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[CR]-B\f[R], \f[CR]--cost\f[R] +\f[CR]\-B\f[R], \f[CR]\-\-cost\f[R] T}@T{ -\f[CR]-V\f[R], \f[CR]-X\f[R] +\f[CR]\-V\f[R], \f[CR]\-X\f[R] T}@T{ -\f[CR]--value=then\f[R] +\f[CR]\-\-value=then\f[R] T}@T{ -\f[CR]--value=end\f[R] +\f[CR]\-\-value=end\f[R] T}@T{ -\f[CR]--value=DATE\f[R], \f[CR]--value=now\f[R] +\f[CR]\-\-value=DATE\f[R], \f[CR]\-\-value=now\f[R] T} _ T{ @@ -7223,7 +7284,7 @@ T}@T{ T}@T{ T} T{ -starting balance (-H) +starting balance (\-H) T}@T{ cost T}@T{ @@ -7236,7 +7297,7 @@ T}@T{ value at DATE/today T} T{ -starting balance (-H) with report interval +starting balance (\-H) with report interval T}@T{ cost T}@T{ @@ -7316,7 +7377,7 @@ T}@T{ value at DATE/today of sums of postings T} T{ -budget amounts (--budget) +budget amounts (\-\-budget) T}@T{ like balance changes T}@T{ @@ -7357,7 +7418,7 @@ T}@T{ T}@T{ T} T{ -starting balances (-H) +starting balances (\-H) T}@T{ sums of costs of postings before report start T}@T{ @@ -7371,11 +7432,11 @@ T}@T{ sums of postings before report start T} T{ -balance changes (bal, is, bs --change, cf --change) +balance changes (bal, is, bs \-\-change, cf \-\-change) T}@T{ sums of costs of postings in period T}@T{ -same as --value=end +same as \-\-value=end T}@T{ sums of values of postings in period at respective posting dates T}@T{ @@ -7384,11 +7445,11 @@ T}@T{ value at DATE/today of sums of postings T} T{ -end balances (bal -H, is --H, bs, cf) +end balances (bal \-H, is \-\-H, bs, cf) T}@T{ sums of costs of postings from before report start to period end T}@T{ -same as --value=end +same as \-\-value=end T}@T{ sums of values of postings from before period start to period end at respective posting dates @@ -7398,7 +7459,7 @@ T}@T{ value at DATE/today of sums of postings T} T{ -budget amounts (--budget) +budget amounts (\-\-budget) T}@T{ like balance changes/end balances T}@T{ @@ -7411,7 +7472,7 @@ T}@T{ like balance changes/end balances T} T{ -row totals, row averages (-T, -A) +row totals, row averages (\-T, \-A) T}@T{ sums, averages of displayed values T}@T{ @@ -7458,8 +7519,8 @@ T}@T{ T} .TE .PP -\f[CR]--cumulative\f[R] is omitted to save space, it works like -\f[CR]-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 @@ -7471,112 +7532,113 @@ market value using available market price declarations, or the unchanged amount if no conversion rate can be found. .TP \f[I]report start\f[R] -the first day of the report period specified with -b or -p or date:, +the first day of the report period specified with \-b or \-p or date:, otherwise today. .TP \f[I]report or journal start\f[R] -the first day of the report period specified with -b or -p or date:, +the first day of the report period specified with \-b or \-p or date:, otherwise the earliest transaction date in the journal, otherwise today. .TP \f[I]report end\f[R] -the last day of the report period specified with -e or -p or date:, +the last day of the report period specified with \-e or \-p or date:, otherwise today. .TP \f[I]report or journal end\f[R] -the last day of the report period specified with -e or -p or date:, +the last day of the report period specified with \-e or \-p or date:, otherwise the latest transaction date in the journal, otherwise today. .TP \f[I]report interval\f[R] -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). +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 -Here are the built-in commands: +Here are the built\-in commands: .SS DATA ENTRY These data entry commands are the only ones which can modify your journal file. .IP \[bu] 2 -add - add transactions using terminal prompts +add \- add transactions using terminal prompts .IP \[bu] 2 -import - add new transactions from other files, eg CSV files +import \- add new transactions from other files, eg CSV files .SS DATA CREATION .IP \[bu] 2 -close - generate balance-zeroing/restoring transactions +close \- generate balance\-zeroing/restoring transactions .IP \[bu] 2 -rewrite - generate auto postings, like print --auto +rewrite \- generate auto postings, like print \-\-auto .SS DATA MANAGEMENT .IP \[bu] 2 -check - check for various kinds of error in the data +check \- check for various kinds of error in the data .IP \[bu] 2 -diff - compare account transactions in two journal files +diff \- compare account transactions in two journal files .SS REPORTS, FINANCIAL .IP \[bu] 2 -aregister (areg) - show transactions in a particular account +aregister (areg) \- show transactions in a particular account .IP \[bu] 2 -balancesheet (bs) - show assets, liabilities and net worth +balancesheet (bs) \- show assets, liabilities and net worth .IP \[bu] 2 -balancesheetequity (bse) - show assets, liabilities and equity +balancesheetequity (bse) \- show assets, liabilities and equity .IP \[bu] 2 -cashflow (cf) - show changes in liquid assets +cashflow (cf) \- show changes in liquid assets .IP \[bu] 2 -incomestatement (is) - show revenues and expenses +incomestatement (is) \- show revenues and expenses .SS REPORTS, VERSATILE .IP \[bu] 2 -balance (bal) - show balance changes, end balances, budgets, gains.. +balance (bal) \- show balance changes, end balances, budgets, gains.. .IP \[bu] 2 -print - show transactions or export journal data +print \- show transactions or export journal data .IP \[bu] 2 -register (reg) - show postings in one or more accounts & running total +register (reg) \- show postings in one or more accounts & running total .IP \[bu] 2 -roi - show return on investments +roi \- show return on investments .SS REPORTS, BASIC .IP \[bu] 2 -accounts - show account names +accounts \- show account names .IP \[bu] 2 -activity - show bar charts of posting counts per period +activity \- show bar charts of posting counts per period .IP \[bu] 2 -codes - show transaction codes +codes \- show transaction codes .IP \[bu] 2 -commodities - show commodity/currency symbols +commodities \- show commodity/currency symbols .IP \[bu] 2 -descriptions - show transaction descriptions +descriptions \- show transaction descriptions .IP \[bu] 2 -files - show input file paths +files \- show input file paths .IP \[bu] 2 -notes - show note parts of transaction descriptions +notes \- show note parts of transaction descriptions .IP \[bu] 2 -payees - show payee parts of transaction descriptions +payees \- show payee parts of transaction descriptions .IP \[bu] 2 -prices - show market prices +prices \- show market prices .IP \[bu] 2 -stats - show journal statistics +stats \- show journal statistics .IP \[bu] 2 -tags - show tag names +tags \- show tag names .IP \[bu] 2 -test - run self tests +test \- run self tests .SS HELP .IP \[bu] 2 -help - show the hledger manual with info/man/pager +help \- show the hledger manual with info/man/pager .IP \[bu] 2 -demo - show small hledger demos in the terminal +demo \- show small hledger demos in the terminal .PP \ -.SS ADD-ONS -And here are some typical add-on commands. -Some of these are installed by the hledger-install script. +.SS ADD\-ONS +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: .IP \[bu] 2 -ui - run hledger\[aq]s terminal UI +ui \- run hledger\[aq]s terminal UI .IP \[bu] 2 -web - run hledger\[aq]s web UI +web \- run hledger\[aq]s web UI .IP \[bu] 2 -iadd - add transactions using a TUI (currently hard to build) +iadd \- add transactions using a TUI (currently hard to build) .IP \[bu] 2 -interest - generate interest transactions +interest \- generate interest transactions .IP \[bu] 2 -stockquotes - download market prices from AlphaVantage +stockquotes \- download market prices from AlphaVantage .IP \[bu] 2 -Scripts and add-ons - check-fancyassertions, edit, fifo, git, move, +Scripts and add\-ons \- check\-fancyassertions, edit, fifo, git, move, pijul, plot, and more.. .PP Next, each command is described in detail, in alphabetical order. @@ -7590,39 +7652,40 @@ 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[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]). +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[CR]--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[CR]--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[CR]depth:N\f[R] or -\f[CR]--depth N\f[R] or \f[CR]-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[CR]--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[CR]--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[CR]--directives\f[R], it adds the \f[CR]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[CR]--undeclared\f[R] when updating your -account declarations to satisfy \f[CR]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[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. +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 @@ -7639,7 +7702,7 @@ liabilities:debts .EE .IP .EX -$ hledger accounts --undeclared --directives >> $LEDGER_FILE +$ hledger accounts \-\-undeclared \-\-directives >> $LEDGER_FILE $ hledger check accounts .EE .SS activity @@ -7653,11 +7716,11 @@ With query arguments, it counts only matched transactions. Examples: .IP .EX -$ hledger activity --quarterly -2008-01-01 ** -2008-04-01 ******* -2008-07-01 -2008-10-01 ** +$ hledger activity \-\-quarterly +2008\-01\-01 ** +2008\-04\-01 ******* +2008\-07\-01 +2008\-10\-01 ** .EE .SS add Prompt for transactions and add them to the journal. @@ -7675,7 +7738,7 @@ This is one of the few hledger commands that writes to the journal file .PP 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[CR].\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 @@ -7685,9 +7748,9 @@ template. .IP \[bu] 2 You can also set the initial defaults with command line arguments. .IP \[bu] 2 -Readline-style edit keys can be used during data entry. +Readline\-style edit keys can be used during data entry. .IP \[bu] 2 -The tab key will auto-complete whenever possible - accounts, +The tab key will auto\-complete whenever possible \- accounts, 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. @@ -7716,26 +7779,30 @@ An optional (CODE) may follow transaction dates. An optional ; COMMENT may follow descriptions or amounts. If you make a mistake, enter < at any prompt to go one step backward. To end a transaction, enter . when prompted. -To quit, enter . at a date prompt or press control-d or control-c. +To quit, enter . at a date prompt or press control\-d or control\-c. Date [2015/05/22]: Description: supermarket Account 1: expenses:food Amount 1: $10 Account 2: assets:checking -Amount 2 [$-10.0]: +Amount 2 [$\-10.0]: Account 3 (or . or enter to finish this transaction): . 2015/05/22 supermarket expenses:food $10 - assets:checking $-10.0 + assets:checking $\-10.0 Save this transaction to the journal ? [y]: Saved. -Starting the next transaction (. or ctrl-D/ctrl-C to quit) -Date [2015/05/22]: $ +Starting the next transaction (. or ctrl\-D/ctrl\-C to quit) +Date [2015/05/22]: $ .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). +If you enter a number with no commodity symbol, and you have declared a +default commodity with a \f[CR]D\f[R] directive, you might expect +\f[CR]add\f[R] to add this symbol for you. +It does not do this; we assume that if you are using a \f[CR]D\f[R] +directive you prefer not to see the commodity symbol repeated on amounts +in the journal. .SS aregister (areg) .PP @@ -7746,21 +7813,21 @@ account, with each transaction displayed as one line. 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[CR]--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 +This is a more \[dq]real world\[dq], bank\-like view than the \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[CR]aregister\f[R] for reviewing and -reconciling real-world asset/liability accounts - use +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[CR]aregister\f[R] requires one argument: the account to report on. -You can write either the full account name, or a case-insensitive +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 +When there are multiple matches, the alphabetically\-first choice can be 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 @@ -7775,7 +7842,7 @@ always match a balance report with similar arguments. Any additional arguments form a query which will filter the transactions shown. Note some queries will disturb the running balance, causing it to be -different from the account\[aq]s real-world running balance. +different from the account\[aq]s real\-world running balance. .PP An example: this shows the transactions and historical running balance during july, in the first account whose name contains @@ -7798,13 +7865,13 @@ 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[CR]-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[CR]--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. @@ -7816,15 +7883,15 @@ But sometimes transactions have postings with different dates. Also, not all of a transaction\[aq]s postings may be within the report period. To resolve this, aregister shows the earliest of the transaction\[aq]s -date and posting dates that is in-period, and the sum of the in-period +date and posting dates that is in\-period, and the sum of the in\-period 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[CR]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[CR]--txn-dates\f[R] flag, which filters strictly by -transaction date, ignoring posting dates. +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 (bal) @@ -7837,7 +7904,7 @@ 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[CR]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[CR]balancesheet\f[R], \f[CR]balancesheetequity\f[R], \f[CR]cashflow\f[R] and \f[CR]incomestatement\f[R]. @@ -7845,13 +7912,13 @@ When you need more control, then use \f[CR]balance\f[R]. .SS balance features 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. +Many of these work with the higher\-level commands as well. .PP \f[CR]balance\f[R] can show.. .IP \[bu] 2 -accounts as a list (\f[CR]-l\f[R]) or a tree (\f[CR]-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[CR]-[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 @@ -7859,77 +7926,78 @@ 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[CR]--budget\f[R]) +or actual and planned balance changes (\f[CR]\-\-budget\f[R]) .IP \[bu] 2 -or value of balance changes (\f[CR]-V\f[R]) +or value of balance changes (\f[CR]\-V\f[R]) .IP \[bu] 2 -or change of balance values (\f[CR]--valuechange\f[R]) +or change of balance values (\f[CR]\-\-valuechange\f[R]) .IP \[bu] 2 -or unrealised capital gain/loss (\f[CR]--gain\f[R]) +or unrealised capital gain/loss (\f[CR]\-\-gain\f[R]) .IP \[bu] 2 -or postings count (\f[CR]--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[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]) +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[CR]--cumulative\f[R]) +or accumulated since report start date (\f[CR]\-\-cumulative\f[R]) .IP \[bu] 2 -or accumulated since account creation (\f[CR]--historical/-H\f[R]) +or accumulated since account creation (\f[CR]\-\-historical/\-H\f[R]) .PP \&..possibly converted to.. .IP \[bu] 2 -cost (\f[CR]--value=cost[,COMM]\f[R]/\f[CR]--cost\f[R]/\f[CR]-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[CR]--value=then[,COMM]\f[R]) +(\f[CR]\-\-value=then[,COMM]\f[R]) .IP \[bu] 2 -or at period ends (\f[CR]--value=end[,COMM]\f[R]) +or at period ends (\f[CR]\-\-value=end[,COMM]\f[R]) .IP \[bu] 2 -or now (\f[CR]--value=now\f[R]) +or now (\f[CR]\-\-value=now\f[R]) .IP \[bu] 2 -or at some other date (\f[CR]--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[CR]-T\f[R]), averages (\f[CR]-A\f[R]), percentages -(\f[CR]-%\f[R]), inverted sign (\f[CR]--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[CR]--transpose\f[R]) +rows and columns swapped (\f[CR]\-\-transpose\f[R]) .IP \[bu] 2 -another field used as account name (\f[CR]--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[CR]--format\f[R]) +custom\-formatted line items (single\-period reports only) +(\f[CR]\-\-format\f[R]) .IP \[bu] 2 commodities displayed on the same line or multiple lines -(\f[CR]--layout\f[R]) +(\f[CR]\-\-layout\f[R]) .PP This command supports the output destination and output format options, 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 +\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[CR]--related\f[R]/\f[CR]-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 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. +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 single period. -You can also have multi-period reports, described later.) +You can also have multi\-period reports, described later.) .PP -For real-world accounts, these numbers will normally be their end +For real\-world accounts, these numbers will normally be their end balance at the end of the journal period; more on this below. .PP Accounts are sorted by declaration order if any, and then alphabetically @@ -7937,58 +8005,58 @@ by account name. For instance (using examples/sample.journal): .IP .EX -$ hledger -f examples/sample.journal bal +$ hledger \-f examples/sample.journal bal $1 assets:bank:saving - $-2 assets:cash + $\-2 assets:cash $1 expenses:food $1 expenses:supplies - $-1 income:gifts - $-1 income:salary + $\-1 income:gifts + $\-1 income:salary $1 liabilities:debts --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP -Accounts with a zero balance (and no non-zero subaccounts, in tree mode -- see below) are hidden by default. -Use \f[CR]-E/--empty\f[R] to show them (revealing +Accounts with a zero balance (and no non\-zero subaccounts, in tree mode +\- see below) are hidden by default. +Use \f[CR]\-E/\-\-empty\f[R] to show them (revealing \f[CR]assets:bank:checking\f[R] here): .IP .EX -$ hledger -f examples/sample.journal bal -E +$ hledger \-f examples/sample.journal bal \-E 0 assets:bank:checking $1 assets:bank:saving - $-2 assets:cash + $\-2 assets:cash $1 expenses:food $1 expenses:supplies - $-1 income:gifts - $-1 income:salary + $\-1 income:gifts + $\-1 income:salary $1 liabilities:debts --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP The total of the amounts displayed is shown as the last line, unless -\f[CR]-N\f[R]/\f[CR]--no-total\f[R] is used. +\f[CR]\-N\f[R]/\f[CR]\-\-no\-total\f[R] is used. .SS Balance report line format -For single-period balance reports displayed in the terminal (only), you -can use \f[CR]--format FMT\f[R] to customise the format and content of +For single\-period balance reports displayed in the terminal (only), you +can use \f[CR]\-\-format FMT\f[R] to customise the format and content of each line. Eg: .IP .EX -$ hledger -f examples/sample.journal balance --format \[dq]%20(account) %12(total)\[dq] - assets $-1 +$ hledger \-f examples/sample.journal balance \-\-format \[dq]%20(account) %12(total)\[dq] + assets $\-1 bank:saving $1 - cash $-2 + cash $\-2 expenses $2 food $1 supplies $1 - income $-2 - gifts $-1 - salary $-1 + income $\-2 + gifts $\-1 + salary $\-1 liabilities:debts $1 ---------------------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP @@ -8005,42 +8073,42 @@ MAX truncates at this width (optional) FIELDNAME must be enclosed in parentheses, and can be one of: .RS 2 .IP \[bu] 2 -\f[CR]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[CR]account\f[R] - the account\[aq]s name +\f[CR]account\f[R] \- the account\[aq]s name .IP \[bu] 2 -\f[CR]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: +multi\-commodity amounts are rendered: .IP \[bu] 2 -\f[CR]%_\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[CR]%\[ha]\f[R] - render on multiple lines, top-aligned +\f[CR]%\[ha]\f[R] \- render on multiple lines, top\-aligned .IP \[bu] 2 -\f[CR]%,\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[CR]%(depth_spacer)\f[R] has no effect, instead +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[CR]%(total)\f[R] - the account\[aq]s total +\f[CR]%(total)\f[R] \- the account\[aq]s total .IP \[bu] 2 -\f[CR]%-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[CR]%,%-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[CR]%20(total) %2(depth_spacer)%-(account)\f[R] - the default format -for the single-column balance report +\f[CR]%20(total) %2(depth_spacer)%\-(account)\f[R] \- the default +format for the single\-column balance report .SS Filtered balance report You can show fewer accounts, a different time period, totals from cleared transactions only, etc. @@ -8048,53 +8116,53 @@ by using query arguments or options to limit the postings being matched. Eg: .IP .EX -$ hledger -f examples/sample.journal bal --cleared assets date:200806 - $-2 assets:cash --------------------- - $-2 +$ hledger \-f examples/sample.journal bal \-\-cleared assets date:200806 + $\-2 assets:cash +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + $\-2 .EE .SS List or tree mode -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. +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[CR]-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 .EX -$ hledger -f examples/sample.journal balance - $-1 assets +$ hledger \-f examples/sample.journal balance + $\-1 assets $1 bank:saving - $-2 cash + $\-2 cash $2 expenses $1 food $1 supplies - $-2 income - $-1 gifts - $-1 salary + $\-2 income + $\-1 gifts + $\-1 salary $1 liabilities:debts --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP Notes: .IP \[bu] 2 \[dq]Boring\[dq] accounts are combined with their subaccount for more -compact output, unless \f[CR]--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[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. Note this means some repetition in the output, which requires -explanation when sharing reports with non-plaintextaccounting-users. -A tree mode report\[aq]s final total is the sum of the top-level +explanation when sharing reports with non\-plaintextaccounting\-users. +A tree mode report\[aq]s final total is the sum of the top\-level balances shown, not of all the balances shown. .IP \[bu] 2 Each group of sibling accounts (ie, under a common parent) is sorted separately. .SS Depth limiting -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 +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 @@ -8103,33 +8171,33 @@ deeper subaccounts (even in list mode). Eg, limiting to depth 1: .IP .EX -$ hledger -f examples/sample.journal balance -1 - $-1 assets +$ hledger \-f examples/sample.journal balance \-1 + $\-1 assets $2 expenses - $-2 income + $\-2 income $1 liabilities --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE -.SS Dropping top-level accounts -You can also hide one or more top-level account name parts, using -\f[CR]--drop NUM\f[R]. -This can be useful for hiding repetitive top-level account names: +.SS Dropping top\-level accounts +You can also hide one or more top\-level account name parts, using +\f[CR]\-\-drop NUM\f[R]. +This can be useful for hiding repetitive top\-level account names: .IP .EX -$ hledger -f examples/sample.journal bal expenses --drop 1 +$ hledger \-f examples/sample.journal bal expenses \-\-drop 1 $1 food $1 supplies --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- $2 .EE .PP .SS Showing declared accounts -With \f[CR]--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[CR]-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. @@ -8138,23 +8206,24 @@ 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 -With \f[CR]-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[CR]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[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 +\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[CR]hledger incomestatement -MAS\f[R]). +Eg: \f[CR]hledger incomestatement \-MAS\f[R]). .PP .SS Percentages -With \f[CR]-%/--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 @@ -8162,37 +8231,38 @@ column have mixed signs. In this case, make a separate report for each sign, eg: .IP .EX -$ hledger bal -% amt:\[ga]>0\[ga] -$ hledger bal -% amt:\[ga]<0\[ga] +$ hledger bal \-% amt:\[ga]>0\[ga] +$ hledger bal \-% amt:\[ga]<0\[ga] .EE .PP Similarly, if the amounts in a column have mixed commodities, convert -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: +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 .EX -$ hledger bal -% cur:\[rs]\[rs]$ -$ hledger bal -% cur:€ +$ hledger bal \-% cur:\[rs]\[rs]$ +$ hledger bal \-% cur:€ .EE -.SS Multi-period balance report -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): +.SS Multi\-period balance report +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 .EX -$ hledger -f examples/sample.journal bal --quarterly income expenses -E +$ hledger \-f examples/sample.journal bal \-\-quarterly income expenses \-E Balance changes in 2008: || 2008q1 2008q2 2008q3 2008q4 ===================++================================= expenses:food || 0 $1 0 0 expenses:supplies || 0 $1 0 0 - income:gifts || 0 $-1 0 0 - income:salary || $-1 0 0 0 --------------------++--------------------------------- - || $-1 $1 0 0 + income:gifts || 0 $\-1 0 0 + income:salary || $\-1 0 0 0 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + || $\-1 $1 0 0 .EE .PP Notes: @@ -8202,47 +8272,46 @@ 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[CR]-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[CR]-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[CR]--no-elide\f[R] is used. -\f[I](experimental)\f[R] +\f[CR]\-\-no\-elide\f[R] is used. .IP \[bu] 2 Average and/or total columns can be added with the -\f[CR]-A/--average\f[R] and \f[CR]-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[CR]--transpose\f[R] flag can be used to exchange rows and +The \f[CR]\-\-transpose\f[R] flag can be used to exchange rows and columns. .IP \[bu] 2 -The \f[CR]--pivot FIELD\f[R] option causes a different transaction field -to be used as \[dq]account name\[dq]. +The \f[CR]\-\-pivot FIELD\f[R] option causes a different transaction +field to be used as \[dq]account name\[dq]. See PIVOTING. .PP -Multi-period reports with many periods can be too wide for easy viewing +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[CR]-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[CR]-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[CR]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[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]) +(\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[CR]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 It\[aq]s important to be clear on the meaning of the numbers shown in balance reports. @@ -8276,13 +8345,13 @@ 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[CR]-H/--historical\f[R] flag. -(\f[CR]-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 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 +If the following seems complicated, don\[aq]t worry \- this is for advanced reporting, and it does take time and experimentation to get familiar with all the report modes. .PP @@ -8293,39 +8362,39 @@ There are three important option groups: The basic calculation to perform for each table cell. It is one of: .IP \[bu] 2 -\f[CR]--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[CR]--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[CR]--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[CR]--gain\f[R] : show the unrealised capital gain/loss, (the current -valued balance minus each amount\[aq]s original cost) +\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[CR]--count\f[R] : show the count of postings +\f[CR]\-\-count\f[R] : show the count of postings .SS Accumulation type 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[CR]--change\f[R] : calculate with postings from column start to +\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[CR]--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[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]. +\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]) @@ -8337,33 +8406,33 @@ It is one of: no valuation type : don\[aq]t convert to cost or value (\f[B]default\f[R]) .IP \[bu] 2 -\f[CR]--value=cost[,COMM]\f[R] : convert amounts to cost (then +\f[CR]\-\-value=cost[,COMM]\f[R] : convert amounts to cost (then optionally to some other commodity) .IP \[bu] 2 -\f[CR]--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[CR]--value=end[,COMM]\f[R] : convert amounts to market value on +\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[CB]--valuechange\f[B], \f[CB]--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[CR]--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[CR]--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[CR]-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[CR]-V/--market\f[R] : like --value=end +\f[CR]\-V/\-\-market\f[R] : like \-\-value=end .IP \[bu] 2 -\f[CR]-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 @@ -8371,13 +8440,14 @@ 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[CR]--valuechange\f[R] implies \f[CR]--value=end\f[R] +\f[CR]\-\-valuechange\f[R] implies \f[CR]\-\-value=end\f[R] .IP \[bu] 2 -\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 +\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[CR]--cumulative\f[R] or \f[CR]--historical\f[R] disables -\f[CR]--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: @@ -8390,49 +8460,49 @@ Valuation:> Accumulation:v T}@T{ no valuation T}@T{ -\f[CR]--value= then\f[R] +\f[CR]\-\-value= then\f[R] T}@T{ -\f[CR]--value= end\f[R] +\f[CR]\-\-value= end\f[R] T}@T{ -\f[CR]--value= YYYY-MM-DD /now\f[R] +\f[CR]\-\-value= YYYY\-MM\-DD /now\f[R] T} _ T{ -\f[CR]--change\f[R] +\f[CR]\-\-change\f[R] T}@T{ change in period T}@T{ -sum of posting-date market values in period +sum of posting\-date market values in period T}@T{ -period-end value of change in period +period\-end value of change in period T}@T{ -DATE-value of change in period +DATE\-value of change in period T} T{ -\f[CR]--cumulative\f[R] +\f[CR]\-\-cumulative\f[R] T}@T{ change from report start to period end T}@T{ -sum of posting-date market values from report start to period end +sum of posting\-date market values from report start to period end T}@T{ -period-end value of change from report start to period end +period\-end value of change from report start to period end T}@T{ -DATE-value of change from report start to period end +DATE\-value of change from report start to period end T} T{ -\f[CR]--historical /-H\f[R] +\f[CR]\-\-historical /\-H\f[R] T}@T{ change from journal start to period end (historical end balance) T}@T{ -sum of posting-date market values from journal start to period end +sum of posting\-date market values from journal start to period end T}@T{ -period-end value of change from journal start to period end +period\-end value of change from journal start to period end T}@T{ -DATE-value of change from journal start to period end +DATE\-value of change from journal start to period end T} .TE .SS Budget report -The \f[CR]--budget\f[R] report type is like a regular balance report, +The \f[CR]\-\-budget\f[R] report type is like a regular balance report, but with two main differences: .IP \[bu] 2 Budget goals and performance percentages are also shown, in brackets @@ -8457,16 +8527,16 @@ After recording some actual expenses, .IP .EX ;; Two months worth of expenses -2017-11-01 - income $-1950 +2017\-11\-01 + income $\-1950 expenses:bus $35 expenses:food:groceries $310 expenses:food:dining $42 expenses:movies $38 assets:bank:checking -2017-12-01 - income $-2100 +2017\-12\-01 + income $\-2100 expenses:bus $53 expenses:food:groceries $380 expenses:food:dining $32 @@ -8477,24 +8547,24 @@ After recording some actual expenses, we can see a budget report like this: .IP .EX -$ hledger bal -M --budget -Budget performance in 2017-11-01..2017-12-31: +$ hledger bal \-M \-\-budget +Budget performance in 2017\-11\-01..2017\-12\-31: || Nov Dec ===============++============================================ - || $-425 $-565 + || $\-425 $\-565 expenses || $425 [ 99% of $430] $565 [131% of $430] expenses:bus || $35 [117% of $30] $53 [177% of $30] expenses:food || $352 [ 88% of $400] $412 [103% of $400] ----------------++-------------------------------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- || 0 [ 0% of $430] 0 [ 0% of $430] .EE .PP -This is \[dq]goal-based budgeting\[dq]; you define goals for accounts +This is \[dq]goal\-based budgeting\[dq]; you define goals for accounts and periods, often recurring, and hledger shows performance relative to the goals. This contrasts with \[dq]envelope budgeting\[dq], which is more detailed -and strict - useful when cash is tight, but also quite a bit more work. +and strict \- useful when cash is tight, but also quite a bit more work. https://plaintextaccounting.org/Budgeting has more on this topic. .SS Using the budget report Historically this report has been confusing and fragile. @@ -8521,15 +8591,15 @@ Unbudgeted accounts \f[CR]expenses:movies\f[R] and The other unbudgeted accounts \f[CR]income\f[R] and \f[CR]assets:bank:checking\f[R] are grouped as \f[CR]\f[R]. .IP \[bu] 2 -\f[CR]--depth\f[R] or \f[CR]depth:\f[R] can be used to limit report +\f[CR]\-\-depth\f[R] or \f[CR]depth:\f[R] can be used to limit report depth in the usual way (but will not reveal unbudgeted subaccounts). .IP \[bu] 2 Amounts are always inclusive of subaccounts (even in -\f[CR]-l/--list\f[R] mode). +\f[CR]\-l/\-\-list\f[R] mode). .IP \[bu] 2 -Numbers displayed in a --budget report will not always agree with the +Numbers displayed in a \-\-budget report will not always agree with the totals, because of hidden unbudgeted accounts; this is normal. -\f[CR]-E/--empty\f[R] can be used to reveal the hidden accounts. +\f[CR]\-E/\-\-empty\f[R] can be used to reveal the hidden accounts. .IP \[bu] 2 In the periodic rules used for setting budget goals, unbalanced postings are convenient. @@ -8541,13 +8611,13 @@ It\[aq]s common to restrict them to just expenses. this is because of date surprises, discussed below.) .IP \[bu] 2 When you have multiple currencies, you may want to convert them to one -(\f[CR]-X COMM --infer-market-prices\f[R]) and/or show just one at a -time (\f[CR]cur:COMM\f[R]). +(\f[CR]\-X COMM \-\-infer\-market\-prices\f[R]) and/or show just one at +a time (\f[CR]cur:COMM\f[R]). If you do need to show multiple currencies at once, -\f[CR]--layout bare\f[R] can be helpful. +\f[CR]\-\-layout bare\f[R] can be helpful. .IP \[bu] 2 You can \[dq]roll over\[dq] amounts (actual and budgeted) to the next -period with \f[CR]--cumulative\f[R]. +period with \f[CR]\-\-cumulative\f[R]. .PP See also: https://hledger.org/budgeting.html. .SS Budget date surprises @@ -8562,32 +8632,32 @@ have no \f[CR]expenses:food\f[R] budget. \[ti] monthly in 2020 (expenses:food) $500 -2020-01-15 +2020\-01\-15 expenses:food $400 assets:checking .EE .IP .EX -$ hledger bal --budget expenses -Budget performance in 2020-01-15: +$ hledger bal \-\-budget expenses +Budget performance in 2020\-01\-15: - || 2020-01-15 + || 2020\-01\-15 ===============++==================== || $400 expenses:food || 0 [ 0% of $500] ----------------++-------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- || $400 [80% of $500] .EE .PP In this case, the budget goal transactions are generated on first days of of month (this can be seen with -\f[CR]hledger print --forecast tag:generated expenses\f[R]). +\f[CR]hledger print \-\-forecast tag:generated expenses\f[R]). Whereas the report period defaults to just the 15th day of january (this can be seen from the report table\[aq]s column headings). .PP To fix this kind of thing, be more explicit about the report period (and/or the periodic rules\[aq] dates). -In this case, adding \f[CR]-b 2020\f[R] does the trick. +In this case, adding \f[CR]\-b 2020\f[R] does the trick. .SS Selecting budget goals By default, the budget report uses all available periodic transaction rules to generate goals. @@ -8596,82 +8666,82 @@ 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[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 +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 between period expression and description), and then select from multiple budgets defined in your journal. .SS Budgeting vs forecasting -\f[CR]--budget\f[R] and \f[CR]--forecast\f[R] both use the periodic +\f[CR]\-\-budget\f[R] and \f[CR]\-\-forecast\f[R] both use the periodic transaction rules in the journal to generate temporary transactions for reporting purposes. -However they are separate features - though you can use both at the same -time if you want. +However they are separate features \- though you can use both at the +same time if you want. Here are some differences between them: .IP "1." 3 -\f[CR]--budget\f[R] is a command-specific option; it selects the +\f[CR]\-\-budget\f[R] is a command\-specific option; it selects the \f[B]budget report\f[R]. .RS 4 .PP -\f[CR]--forecast\f[R] is a general option; \f[B]forecasting works with +\f[CR]\-\-forecast\f[R] is a general option; \f[B]forecasting works with all reports\f[R]. .RE .IP "2." 3 -\f[CR]--budget\f[R] uses \f[B]all periodic rules\f[R]; -\f[CR]--budget=DESCPAT\f[R] uses \f[B]just the rules matched\f[R] by +\f[CR]\-\-budget\f[R] uses \f[B]all periodic rules\f[R]; +\f[CR]\-\-budget=DESCPAT\f[R] uses \f[B]just the rules matched\f[R] by DESCPAT. .RS 4 .PP -\f[CR]--forecast\f[R] uses \f[B]all periodic rules\f[R]. +\f[CR]\-\-forecast\f[R] uses \f[B]all periodic rules\f[R]. .RE .IP "3." 3 -\f[CR]--budget\f[R]\[aq]s budget goal transactions are invisible, except -that they produce \f[B]goal amounts\f[R]. +\f[CR]\-\-budget\f[R]\[aq]s budget goal transactions are invisible, +except that they produce \f[B]goal amounts\f[R]. .RS 4 .PP -\f[CR]--forecast\f[R]\[aq]s forecast transactions are visible, and +\f[CR]\-\-forecast\f[R]\[aq]s forecast transactions are visible, and \f[B]appear in reports\f[R]. .RE .IP "4." 3 -\f[CR]--budget\f[R] generates budget goal transactions \f[B]throughout +\f[CR]\-\-budget\f[R] generates budget goal transactions \f[B]throughout the report period\f[R], optionally restricted by periods specified in the periodic transaction rules. .RS 4 .PP -\f[CR]--forecast\f[R] generates forecast transactions from \f[B]after +\f[CR]\-\-forecast\f[R] generates forecast transactions from \f[B]after the last regular transaction\f[R], to the end of the report period; -while \f[CR]--forecast=PERIODEXPR\f[R] generates them \f[B]throughout +while \f[CR]\-\-forecast=PERIODEXPR\f[R] generates them \f[B]throughout the specified period\f[R]; both optionally restricted by periods specified in the periodic transaction rules. .RE .SS Balance report layout -The \f[CR]--layout\f[R] option affects how balance reports show -multi-commodity amounts and commodity symbols, which can improve +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[CR]--layout=wide[,WIDTH]\f[R]: commodities are shown on a single +\f[CR]\-\-layout=wide[,WIDTH]\f[R]: commodities are shown on a single line, optionally elided to WIDTH .IP \[bu] 2 -\f[CR]--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[CR]--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[CR]--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[CR]--layout\f[R] modes supported by each output format; -note only CSV output supports all of them: +Here are the \f[CR]\-\-layout\f[R] modes supported by each output +format; note only CSV output supports all of them: .PP .TS tab(@); l l l l l l. T{ -- +\- T}@T{ txt T}@T{ @@ -8735,14 +8805,14 @@ With many commodities, reports can be very wide: .RS 2 .IP .EX -$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide -Balance changes in 2012-01-01..2014-12-31: +$ hledger \-f examples/bcexample.hledger bal assets:us:etrade \-3 \-T \-Y \-\-layout=wide +Balance changes in 2012\-01\-01..2014\-12\-31: || 2012 2013 2014 Total ==================++==================================================================================================================================================================================================================== - 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 + 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 .EE .RE .IP \[bu] 2 @@ -8751,14 +8821,14 @@ A width limit reduces the width, but some commodities will be hidden: .RS 2 .IP .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: +$ hledger \-f examples/bcexample.hledger bal assets:us:etrade \-3 \-T \-Y \-\-layout=wide,32 +Balance changes in 2012\-01\-01..2014\-12\-31: || 2012 2013 2014 Total ==================++=========================================================================================================================== - 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.. + 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.. .EE .RE .IP \[bu] 2 @@ -8768,20 +8838,20 @@ account names are repeated: .RS 2 .IP .EX -$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=tall -Balance changes in 2012-01-01..2014-12-31: +$ hledger \-f examples/bcexample.hledger bal assets:us:etrade \-3 \-T \-Y \-\-layout=tall +Balance changes in 2012\-01\-01..2014\-12\-31: || 2012 2013 2014 Total ==================++================================================== - Assets:US:ETrade || 10.00 ITOT 70.00 GLD -11.00 ITOT 70.00 GLD + Assets:US:ETrade || 10.00 ITOT 70.00 GLD \-11.00 ITOT 70.00 GLD Assets:US:ETrade || 337.18 USD 18.00 ITOT 4881.44 USD 17.00 ITOT - Assets:US:ETrade || 12.00 VEA -98.12 USD 14.00 VEA 5120.50 USD + Assets:US:ETrade || 12.00 VEA \-98.12 USD 14.00 VEA 5120.50 USD Assets:US:ETrade || 106.00 VHT 10.00 VEA 170.00 VHT 36.00 VEA Assets:US:ETrade || 18.00 VHT 294.00 VHT -------------------++-------------------------------------------------- - || 10.00 ITOT 70.00 GLD -11.00 ITOT 70.00 GLD +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + || 10.00 ITOT 70.00 GLD \-11.00 ITOT 70.00 GLD || 337.18 USD 18.00 ITOT 4881.44 USD 17.00 ITOT - || 12.00 VEA -98.12 USD 14.00 VEA 5120.50 USD + || 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 .EE @@ -8793,20 +8863,20 @@ report row, account names are repeated: .RS 2 .IP .EX -$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=bare -Balance changes in 2012-01-01..2014-12-31: +$ hledger \-f examples/bcexample.hledger bal assets:us:etrade \-3 \-T \-Y \-\-layout=bare +Balance changes in 2012\-01\-01..2014\-12\-31: || Commodity 2012 2013 2014 Total ==================++============================================= Assets:US:ETrade || GLD 0 70.00 0 70.00 - Assets:US:ETrade || ITOT 10.00 18.00 -11.00 17.00 - Assets:US:ETrade || USD 337.18 -98.12 4881.44 5120.50 + Assets:US:ETrade || ITOT 10.00 18.00 \-11.00 17.00 + Assets:US:ETrade || USD 337.18 \-98.12 4881.44 5120.50 Assets:US:ETrade || VEA 12.00 10.00 14.00 36.00 Assets:US:ETrade || VHT 106.00 18.00 170.00 294.00 -------------------++--------------------------------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- || GLD 0 70.00 0 70.00 - || ITOT 10.00 18.00 -11.00 17.00 - || USD 337.18 -98.12 4881.44 5120.50 + || ITOT 10.00 18.00 \-11.00 17.00 + || 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 .EE @@ -8817,7 +8887,7 @@ that is easier to consume, eg for making charts: .RS 2 .IP .EX -$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=bare +$ 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] \[dq]Assets:US:ETrade\[dq],\[dq]ITOT\[dq],\[dq]17.00\[dq] @@ -8832,66 +8902,66 @@ $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout= .EE .RE .IP \[bu] 2 -Note: bare layout will sometimes display an extra row for the no-symbol +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[CR]hledger-bar\f[R] confusingly (workaround: add a -\f[CR]cur:\f[R] query to exclude the no-symbol row). +commodity\-less, usually). +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. See -https://cran.r-project.org/web/packages/tidyr/vignettes/tidy-data.html +https://cran.r\-project.org/web/packages/tidyr/vignettes/tidy\-data.html for more. This is the easiest kind of data for other software to consume. Here\[aq]s how it looks: .RS 2 .IP .EX -$ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy +$ 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] -\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]ITOT\[dq],\[dq]10.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]USD\[dq],\[dq]337.18\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]VEA\[dq],\[dq]12.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012-01-01\[dq],\[dq]2012-12-31\[dq],\[dq]VHT\[dq],\[dq]106.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]ITOT\[dq],\[dq]18.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]USD\[dq],\[dq]-98.12\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]VEA\[dq],\[dq]10.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013-01-01\[dq],\[dq]2013-12-31\[dq],\[dq]VHT\[dq],\[dq]18.00\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]GLD\[dq],\[dq]0\[dq] -\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014-01-01\[dq],\[dq]2014-12-31\[dq],\[dq]ITOT\[dq],\[dq]-11.00\[dq] -\[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] +\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012\-01\-01\[dq],\[dq]2012\-12\-31\[dq],\[dq]GLD\[dq],\[dq]0\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012\-01\-01\[dq],\[dq]2012\-12\-31\[dq],\[dq]ITOT\[dq],\[dq]10.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012\-01\-01\[dq],\[dq]2012\-12\-31\[dq],\[dq]USD\[dq],\[dq]337.18\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012\-01\-01\[dq],\[dq]2012\-12\-31\[dq],\[dq]VEA\[dq],\[dq]12.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2012\[dq],\[dq]2012\-01\-01\[dq],\[dq]2012\-12\-31\[dq],\[dq]VHT\[dq],\[dq]106.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013\-01\-01\[dq],\[dq]2013\-12\-31\[dq],\[dq]GLD\[dq],\[dq]70.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013\-01\-01\[dq],\[dq]2013\-12\-31\[dq],\[dq]ITOT\[dq],\[dq]18.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013\-01\-01\[dq],\[dq]2013\-12\-31\[dq],\[dq]USD\[dq],\[dq]\-98.12\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013\-01\-01\[dq],\[dq]2013\-12\-31\[dq],\[dq]VEA\[dq],\[dq]10.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2013\[dq],\[dq]2013\-01\-01\[dq],\[dq]2013\-12\-31\[dq],\[dq]VHT\[dq],\[dq]18.00\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014\-01\-01\[dq],\[dq]2014\-12\-31\[dq],\[dq]GLD\[dq],\[dq]0\[dq] +\[dq]Assets:US:ETrade\[dq],\[dq]2014\[dq],\[dq]2014\-01\-01\[dq],\[dq]2014\-12\-31\[dq],\[dq]ITOT\[dq],\[dq]\-11.00\[dq] +\[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] .EE .RE .SS Useful balance reports Some frequently used \f[CR]balance\f[R] options/reports are: .IP \[bu] 2 -\f[CR]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[CR]incomestatement\f[R] command. .IP \[bu] 2 -\f[CR]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[CR]balancesheet\f[R] command. .IP \[bu] 2 -\f[CR]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[CR]balancesheetequity\f[R] command. .IP \[bu] 2 -\f[CR]bal -M assets not:receivable\f[R] +\f[CR]bal \-M assets not:receivable\f[R] .PD 0 .P .PD @@ -8900,26 +8970,26 @@ Also available as the \f[CR]cashflow\f[R] command. .PP Also: .IP \[bu] 2 -\f[CR]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[CR]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[CR]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[CR]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 @@ -8935,7 +9005,7 @@ financial statements. .PP 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 +Or if no such accounts are declared, it shows top\-level accounts named \f[CR]asset\f[R] or \f[CR]liability\f[R] (case insensitive, plurals allowed) and their subaccounts. .PP @@ -8946,32 +9016,32 @@ $ hledger balancesheet Balance Sheet Assets: - $-1 assets + $\-1 assets $1 bank:saving - $-2 cash --------------------- - $-1 + $\-2 cash +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + $\-1 Liabilities: $1 liabilities:debts --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- $1 Total: --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP -This command is a higher-level variant of the \f[CR]balance\f[R] +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 +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[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]. +\f[CR]tsv\f[R], \f[CR]html\f[R], and \f[CR]json\f[R]. .SS balancesheetequity (bse) .PP @@ -8983,7 +9053,7 @@ financial statements. 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 +Or if no such accounts are declared, it shows top\-level accounts named \f[CR]asset\f[R], \f[CR]liability\f[R] or \f[CR]equity\f[R] (case insensitive, plurals allowed) and their subaccounts. .PP @@ -8994,32 +9064,32 @@ $ hledger balancesheetequity Balance Sheet With Equity Assets: - $-2 assets + $\-2 assets $1 bank:saving - $-3 cash --------------------- - $-2 + $\-3 cash +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + $\-2 Liabilities: $1 liabilities:debts --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- $1 Equity: $1 equity:owner --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- $1 Total: --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP -This command is a higher-level variant of the \f[CR]balance\f[R] +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. +multi\-period reports. It is similar to -\f[CR]hledger balance -H assets liabilities equity\f[R], but with +\f[CR]hledger balance \-H assets liabilities equity\f[R], but with smarter account detection, and liabilities/equity displayed with their sign flipped. .PP @@ -9039,7 +9109,7 @@ 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[CR]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[CR]cash\f[R], \f[CR]bank\f[R], @@ -9059,31 +9129,31 @@ $ hledger cashflow Cashflow Statement Cash flows: - $-1 assets + $\-1 assets $1 bank:saving - $-2 cash --------------------- - $-1 + $\-2 cash +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + $\-1 Total: --------------------- - $-1 +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + $\-1 .EE .PP -This command is a higher-level variant of the \f[CR]balance\f[R] +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. +multi\-period reports. It is similar to \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[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]. +\f[CR]tsv\f[R], \f[CR]html\f[R], and \f[CR]json\f[R]. .SS check Check for various kinds of errors in your data. .PP -hledger provides a number of built-in error checks to help prevent +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[CR]check\f[R] command to run them on demand, with no output and a @@ -9094,161 +9164,198 @@ Some examples: .IP .EX hledger check # basic checks -hledger check -s # basic + strict checks +hledger check \-s # basic + strict checks hledger check ordereddates payees # basic + two other checks .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. +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 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 +\f[B]parseable\f[R] \- data files are in a supported format, with no syntax errors and no invalid include directives. .IP \[bu] 2 -\f[B]autobalanced\f[R] - all transactions are balanced, after converting -to cost. +\f[B]autobalanced\f[R] \- all transactions are balanced, after +converting to cost. Missing amounts and missing costs are inferred automatically where possible. .IP \[bu] 2 -\f[B]assertions\f[R] - all balance assertions in the journal are +\f[B]assertions\f[R] \- all balance assertions in the journal are passing. (This check can be disabled with -\f[CR]-I\f[R]/\f[CR]--ignore-assertions\f[R].) +\f[CR]\-I\f[R]/\f[CR]\-\-ignore\-assertions\f[R].) .SS Strict checks These additional checks are run when the -\f[CR]-s\f[R]/\f[CR]--strict\f[R] (strict mode) flag is used. +\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[CR]check\f[R]: .IP \[bu] 2 -\f[B]balanced\f[R] - all transactions are balanced after converting to +\f[B]balanced\f[R] \- all transactions are balanced after converting to cost, without inferring missing costs. If conversion costs are required, they must be explicit. .IP \[bu] 2 -\f[B]accounts\f[R] - all account names used by transactions have been +\f[B]accounts\f[R] \- all account names used by transactions have been declared .IP \[bu] 2 -\f[B]commodities\f[R] - all commodity symbols used have been declared +\f[B]commodities\f[R] \- all commodity symbols used have been declared .SS Other checks These checks can be run only by giving their names as arguments to \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 +\f[B]ordereddates\f[R] \- transactions are ordered by date within each file .IP \[bu] 2 -\f[B]payees\f[R] - all payees used by transactions have been declared +\f[B]payees\f[R] \- all payees used by transactions have been declared .IP \[bu] 2 -\f[B]recentassertions\f[R] - all accounts with balance assertions have a -balance assertion within 7 days of their latest posting +\f[B]recentassertions\f[R] \- all accounts with balance assertions have +a balance assertion within 7 days of their latest posting .IP \[bu] 2 -\f[B]tags\f[R] - all tags used by transactions have been declared +\f[B]tags\f[R] \- all tags used by transactions have been declared .IP \[bu] 2 -\f[B]uniqueleafnames\f[R] - all account leaf names are unique +\f[B]uniqueleafnames\f[R] \- all account leaf names are unique .SS 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: .IP \[bu] 2 -\f[B]hledger-check-tagfiles\f[R] - all tag values containing / (a +\f[B]hledger\-check\-tagfiles\f[R] \- all tag values containing / (a forward slash) exist as file paths .IP \[bu] 2 -\f[B]hledger-check-fancyassertions\f[R] - more complex balance +\f[B]hledger\-check\-fancyassertions\f[R] \- more complex balance assertions are passing .PP You could make similar scripts to perform your own custom checks. -See: Cookbook -> Scripting. +See: Cookbook \-> Scripting. .SS More about specific checks \f[CR]hledger check recentassertions\f[R] will complain if any -balance-asserted account has postings more than 7 days after its latest +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 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 +the real\-world balance. +(That may not be true if you auto\-generate balance assertions from bank data; in that case, I recommend to import transactions uncleared, and when you manually review and clear them, also check the latest assertion -against the real-world balance.) +against the real\-world balance.) .SS close (equity) .PP -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. +A transaction\-generating command which generates several kinds of +\[dq]closing\[dq] and/or \[dq]opening\[dq] transactions useful in +certain situations. +It prints one or two transactions to stdout, but does not write them to +the journal file; you can append or copy them there when you are happy +with the output. .PP -By default, it prints a transaction that zeroes out ALE accounts (asset, -liability, equity accounts; this requires account types to be -configured); or if ACCTQUERY is provided, the accounts matched by that. -.PP -\f[I](experimental)\f[R] -.PP -This command has four main modes, corresponding to the most common use -cases: +This command is most often used when migrating balances to a new journal +file, at the start of a new financial year. +It can also be used to \[dq]retain earnings\[dq] (transfer revenues and +expenses to equity), or as a sort of generic mover of balances from any +group of accounts to some other account. +So it currently has six modes, selected by a mode flag. +Use only one of these flags at a time: .IP "1." 3 -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. +With \f[CR]\-\-close\f[R] (or no mode flag) it prints a \[dq]closing +balances\[dq] transaction that zeroes out all the asset, liability, and +equity account balances, by default (this requires inferred or declared +account types). +Or, it will zero out the accounts matched by any ACCTQUERY arguments you +provide. +All of the balances are transferred to a special \[dq]opening/closing +balances\[dq] equity account. .IP "2." 3 -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. +With \f[CR]\-\-open\f[R], it prints an opposite \[dq]opening +balances\[dq] transaction that restores the same account balances, +starting from zero. +This mode is similar to Ledger\[aq]s equity command. .IP "3." 3 -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[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. +With \f[CR]\-\-migrate\f[R], it prints both the closing and opening +transactions above. +This is a common way to migrate balances to a new file at year end; run +\f[CR]hledger close \-\-migrate \-e NEWYEAR\f[R] (\-e influences the +transaction date) and add the closing transaction at the end of the old +file, and the opening transaction at the start of the new file. +Doing this means you can include past year files in your reports at any +time without disturbing asset/liability/equity balances, because the +closing balances transaction cancels out the following opening balances +transaction. +You will sometimes need to exclude these transactions from reports, eg +to see an end of year balance sheet; a \f[CR]not:opening/closing\f[R] +query argument should do. +You should probably also use this query when \f[CR]close\f[R]\-ing, to +exclude the \[dq]opening/closing balances\[dq] account which might +otherwise cause problems. +Or you can just migrate assets and liabilities: +\f[CR]hledger close type:AL\f[R]. +Most people don\[aq]t need to migrate equity. +And revenues and expenses usually should not be migrated. .IP "4." 3 -With \f[CR]--retain\f[R], it prints a \[dq]retain earnings\[dq] -transaction that transfers RX (revenue and expense) balances to +With \f[CR]\-\-assert\f[R] it prints a \[dq]closing balances\[dq] +transaction that just asserts the current balances, without changing +them. +This can be useful as documention and to guard against errors and +changes. +.IP "5." 3 +With \f[CR]\-\-assign\f[R] it prints an \[dq]opening balances\[dq] +transaction that restores the account balances using balance +assignments. +Balance assignments work regardless of any previous balance, so a +preceding closing balances transaction is not needed. +This is an alternative to \f[CR]\-\-close\f[R] and \f[CR]\-\-open\f[R]: +at year end, \f[CR]hledger close \-\-assert \-e NEWYEAR\f[R] in the old +file (optional, but useful for error checking), and +\f[CR]hledger close \-\-assign \-e NEWYEAR\f[R] in the new file. +This might be more convenient, eg if you are often doing cleanups or +fixes which would break closing/opening transactions. +.IP "6." 3 +With \f[CR]\-\-retain\f[R], it prints a \[dq]retain earnings\[dq] +transaction that transfers revenue and expense balances to \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. +This is a traditional end\-of\-period bookkeeping operation also called +\[dq]closing the books\[dq]; in personal accounting you probably will +not need this but it could be useful if you want to see the accounting +equation (A=L+E) balanced. .PP -In all modes, the defaults can be overridden: +In all modes, the following things can be overridden: .IP \[bu] 2 the transaction descriptions can be changed with -\f[CR]--close-desc=DESC\f[R] and \f[CR]--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[CR]--close-acct=ACCT\f[R] and \f[CR]--open-acct=ACCT\f[R] +the account to transfer to and from can be changed with +\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[CR]ACCTQUERY\f[R] (account query arguments). .IP \[bu] 2 -the closing/opening dates can be changed with \f[CR]-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[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[CR]print -x\f[R]). +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[CR]print \-x\f[R]). .PP -With \f[CR]--show-costs\f[R], any amount costs are shown, with separate -postings for each cost. +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[CR]--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[CR]-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[CR]-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 Balance assertions will be generated, verifying that the accounts have @@ -9256,43 +9363,43 @@ 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[CR]-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[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 +(\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 .EX -2023-12-30 a purchase made in december, cleared in january +2023\-12\-30 a purchase made in december, cleared in january expenses:food 5 - assets:bank:checking -5 ; date: 2023-01-02 + assets:bank:checking \-5 ; date: 2023\-01\-02 .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: +account, in effect splitting the multi\-day transaction into two +single\-day transactions: .IP .EX ; in 2022.journal: -2022-12-30 a purchase made in december, cleared in january +2022\-12\-30 a purchase made in december, cleared in january expenses:food 5 - equity:pending -5 + equity:pending \-5 ; in 2023.journal: -2023-01-02 last year\[aq]s transaction cleared +2023\-01\-02 last year\[aq]s transaction cleared equity:pending 5 = 0 - assets:bank:checking -5 + assets:bank:checking \-5 .EE .SS Example: retain earnings -Record 2022\[aq]s revenues/expenses as retained earnings on 2022-12-31, -appending the generated transaction to the journal: +Record 2022\[aq]s revenues/expenses as retained earnings on +2022\-12\-31, appending the generated transaction to the journal: .IP .EX -$ hledger close --retain -f 2022.journal -p 2022 >> 2022.journal +$ hledger close \-\-retain \-f 2022.journal \-p 2022 >> 2022.journal .EE .PP Note 2022\[aq]s income statement will now show only zeroes, because @@ -9300,31 +9407,31 @@ revenues and expenses have been moved entirely to equity. To see them again, you could exclude the retain transaction: .IP .EX -$ hledger -f 2022.journal is not:desc:\[aq]retain earnings\[aq] +$ hledger \-f 2022.journal is not:desc:\[aq]retain earnings\[aq] .EE .SS Example: migrate balances to a new file -Close assets/liabilities/equity on 2022-12-31 and re-open them on -2023-01-01: +Close assets/liabilities/equity on 2022\-12\-31 and re\-open them on +2023\-01\-01: .IP .EX -$ hledger close --migrate -f 2022.journal -p 2022 +$ 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 .EE .PP Now 2022\[aq]s balance sheet will show only zeroes, indicating a balanced accounting equation. -(Unless you are using \[at]/\[at]\[at] notation - in that case, try -adding --infer-equity.) -To see the end-of-year balances again, you could exclude the closing +(Unless you are using \[at]/\[at]\[at] notation \- in that case, try +adding \-\-infer\-equity.) +To see the end\-of\-year balances again, you could exclude the closing transaction: .IP .EX -$ hledger -f 2022.journal bs not:desc:\[aq]closing balances\[aq] +$ hledger \-f 2022.journal bs not:desc:\[aq]closing balances\[aq] .EE .SS 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 \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 @@ -9337,23 +9444,23 @@ except the first, like this: .IP .EX ; 2021.journal -2021-06-01 first opening balances +2021\-06\-01 first opening balances \&... -2021-12-31 closing balances ; clopen:2022 +2021\-12\-31 closing balances ; clopen:2022 \&... .EE .IP .EX ; 2022.journal -2022-01-01 opening balances ; clopen:2022 +2022\-01\-01 opening balances ; clopen:2022 \&... -2022-12-31 closing balances ; clopen:2023 +2022\-12\-31 closing balances ; clopen:2023 \&... .EE .IP .EX ; 2023.journal -2023-01-01 opening balances ; clopen:2023 +2023\-01\-01 opening balances ; clopen:2023 \&... .EE .PP @@ -9368,17 +9475,17 @@ include 2023.journal .PP The \f[CR]clopen:\f[R] tag can exclude all but the first opening transaction. -To show a clean multi-year checking register: +To show a clean multi\-year checking register: .IP .EX -$ hledger -f all.journal areg checking not:tag:clopen +$ hledger \-f all.journal areg checking not:tag:clopen .EE .PP And the year values allow more precision. -To show 2022\[aq]s year-end balance sheet: +To show 2022\[aq]s year\-end balance sheet: .IP .EX -$ hledger -f all.journal bs -e2023 not:tag:clopen=2023 +$ hledger \-f all.journal bs \-e2023 not:tag:clopen=2023 .EE .SS codes List the codes seen in transactions, in the order parsed. @@ -9391,8 +9498,8 @@ 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[CR]-E\f[R]/\f[CR]--empty\f[R] flag, they will be printed as -blank lines. +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 @@ -9424,7 +9531,7 @@ $ hledger codes .EE .IP .EX -$ hledger codes -E +$ hledger codes \-E 123 124 @@ -9441,24 +9548,24 @@ Tips: .PP 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[CR]-s4\f[R] to play at 4x original speed or \f[CR]-s.5\f[R] to play -at half speed. +Use the \-s/\-\-speed SPEED option to set your preferred playback speed, +eg \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[CR]-- -i.1\f[R] to limit pauses or \f[CR]-- -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, . -to step forward (while paused), CTRL-c quit. +to step forward (while paused), CTRL\-c quit. .PP Examples: .IP .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 +$ hledger demo install \-s4 # play the \[dq]install\[dq] demo at 4x speed .EE .SS descriptions List the unique descriptions that appear in transactions. @@ -9495,13 +9602,13 @@ compare the bank data with your journal to find out the cause. Examples: .IP .EX -$ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro +$ hledger diff \-f $LEDGER_FILE \-f bank.csv assets:bank:giro These transactions are in the first file only: 2014/01/01 Opening Balances assets:bank:giro EUR ... ... - equity:opening balances EUR -... + equity:opening balances EUR \-... These transactions are in the second file only: .EE @@ -9527,9 +9634,10 @@ installed on your system. By default it chooses the best viewer found in $PATH, trying (in this 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. +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[CR]info\f[R], note that version 6 or greater is needed for TOPIC lookup. @@ -9540,17 +9648,17 @@ installing a newer version, eg with \f[CR]brew install texinfo\f[R] Examples .IP .EX -$ hledger help --help # show how the help command works +$ 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 +$ hledger help \-m journal # show it with man, even if info is installed .EE .SS 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 the transactions that would be added. -Or with --catchup, just mark all of the FILEs\[aq] current transactions -as imported, without importing them. +Or with \-\-dry\-run, just print the transactions that would be added. +Or with \-\-catchup, just mark all of the FILEs\[aq] current +transactions as imported, without importing them. .PP This command may append new transactions to the main journal file (which should be in journal format). @@ -9569,7 +9677,7 @@ files to your main journal, you will run 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 -\f[CR]import\f[R] does \f[I]time-based deduplication\f[R], to detect +\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].) @@ -9603,45 +9711,45 @@ succesful import). .PP 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 -see or manipulate these state files yourself. +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 see or manipulate these state files yourself. But if needed, you can delete them to reset the state (making all 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[CR]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 -With \f[CR]--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. +re\-parse it. Eg, to see any importable transactions which CSV rules have not categorised: .IP .EX -$ hledger import --dry bank.csv | hledger -f- -I print unknown +$ hledger import \-\-dry bank.csv | hledger \-f\- \-I print unknown .EE .PP or (live updating): .IP .EX -$ ls bank.csv* | entr bash -c \[aq]echo ====; hledger import --dry bank.csv | hledger -f- -I print unknown\[aq] +$ ls bank.csv* | entr bash \-c \[aq]echo ====; hledger import \-\-dry bank.csv | hledger \-f\- \-I print unknown\[aq] .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 actual import fails because of a problem in one of the files, leaving 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 +To prevent this, do a \-\-dry\-run first and fix any problems before the real import. .SS Importing balance assignments Entries added by import will have their posting amounts made explicit -(like \f[CR]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. @@ -9651,7 +9759,7 @@ probably generate incorrect posting amounts. To avoid this problem, use print instead of import: .IP .EX -$ hledger print IMPORTFILE [--new] >> $LEDGER_FILE +$ hledger print IMPORTFILE [\-\-new] >> $LEDGER_FILE .EE .PP (If you think import should leave amounts implicit like print does, @@ -9669,7 +9777,7 @@ financial statements. .PP 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 +Or if no such accounts are declared, it shows top\-level accounts named \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 @@ -9680,27 +9788,27 @@ $ hledger incomestatement Income Statement Revenues: - $-2 income - $-1 gifts - $-1 salary --------------------- - $-2 + $\-2 income + $\-1 gifts + $\-1 salary +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- + $\-2 Expenses: $2 expenses $1 food $1 supplies --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- $2 Total: --------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP -This command is a higher-level variant of the \f[CR]balance\f[R] +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. +multi\-period reports. It is similar to \f[CR]hledger balance \[aq](revenues|income)\[aq] expenses\f[R], but with smarter account detection, and revenues/income displayed with their @@ -9708,7 +9816,7 @@ sign flipped. .PP This command also supports the output destination and output format 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]. +\f[CR]tsv\f[R], \f[CR]html\f[R], and \f[CR]json\f[R]. .SS notes List the unique notes that appear in transactions. .PP @@ -9729,14 +9837,14 @@ Snacks List the unique payee/payer names that appear in transactions. .PP This command lists unique payee/payer names which have been declared -with payee directives (--declared), used in transaction descriptions -(--used), or both (the default). +with payee directives (\-\-declared), used in transaction descriptions +(\-\-used), or both (the default). .PP The payee/payer is the part of the transaction description before a | character (or if there is no |, the whole description). .PP You can add query arguments to select a subset of transactions. -This implies --used. +This implies \-\-used. .PP Example: .IP @@ -9748,49 +9856,49 @@ Person A .EE .SS prices Print the market prices declared with P directives. -With --infer-market-prices, also show any additional prices inferred +With \-\-infer\-market\-prices, also show any additional prices inferred from costs. -With --show-reverse, also show additional prices inferred by reversing -known prices. +With \-\-show\-reverse, also show additional prices inferred by +reversing known prices. .PP Price amounts are always displayed with their full precision, except for reverse prices which are limited to 8 decimal digits. .PP Prices can be filtered by a date:, cur: or amt: query. .PP -Generally if you run this command with --infer-market-prices ---show-reverse, it will show the same prices used internally to +Generally if you run this command with \-\-infer\-market\-prices +\-\-show\-reverse, 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. +report with \-\-debug=2. .SS print Show transaction journal entries, sorted by date. .PP The print command displays full journal entries (transactions) from the -journal file, sorted by date (or with \f[CR]--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. +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 -over the directives and inter-transaction comments. +over the directives and inter\-transaction comments. .PP Eg: .IP .EX -$ hledger print -f examples/sample.journal date:200806 +$ hledger print \-f examples/sample.journal date:200806 2008/06/01 gift assets:bank:checking $1 - income:gifts $-1 + income:gifts $\-1 2008/06/02 save assets:bank:saving $1 - assets:bank:checking $-1 + assets:bank:checking $\-1 2008/06/03 * eat & shop expenses:food $1 expenses:supplies $1 - assets:cash $-2 + assets:cash $\-2 .EE .SS print explicitness Normally, whether posting amounts are implicit or explicit is preserved. @@ -9799,41 +9907,43 @@ 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[CR]-x\f[R]/\f[CR]--explicit\f[R] flag to force +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[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]. +\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[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 +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. +single\-commodity postings, keeping the output parseable. .SS 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 Emacs). +Amounts are shown right\-aligned within each transaction (but not +aligned across all transactions; you can do that with ledger\-mode in +Emacs). .PP 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. .PP -With the \f[CR]--round\f[R] option, \f[CR]print\f[R] will try +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[CR]--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[CR]--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[CR]--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[CR]--round=all\f[R] round all amounts and costs +\f[CR]\-\-round=all\f[R] round all amounts and costs .PP -\f[CR]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[CR]hard\f[R] and \f[CR]all\f[R] can cause \f[CR]print\f[R] to show @@ -9847,8 +9957,8 @@ achieved with \f[CR]expr:\f[R] queries now): .IP .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\- reads from stdin. \-I/\-\-ignore\-assertions is sometimes needed. +$ hledger print assets:cash | hledger \-f\- \-I reg expenses:food .EE .PP There are some situations where print\[aq]s output can become @@ -9861,34 +9971,34 @@ Auto postings can generate postings with too many missing amounts. .IP \[bu] 2 Account aliases can generate bad account names. .SS print, other features -With \f[CR]-B\f[R]/\f[CR]--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[CR]--new\f[R], print shows only transactions it has not seen on -a previous run. +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[CR]-m DESC\f[R]/\f[CR]--match=DESC\f[R], print shows one recent -transaction whose description is most similar to DESC. +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. +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 This command also supports the output destination and output format 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[CR]beancount\f[R] format tries to produce -Beancount-compatible output, as follows: +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 (\f[CR]*\f[R]) status. .IP \[bu] 2 -Transactions\[aq] payee and note are backslash-escaped and -double-quote-escaped and 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 @@ -9897,11 +10007,12 @@ currency symbols like \f[CR]$\f[R] are converted to the corresponding currency names. .IP \[bu] 2 Account name parts are capitalised and unsupported characters are -replaced with \f[CR]-\f[R]. +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.) +(Use \f[CR]\-\-alias\f[R] options to bring your accounts into +compliance.) .IP \[bu] 2 An \f[CR]open\f[R] directive is generated for each account used, on the earliest transaction date. @@ -9919,19 +10030,19 @@ Directives are not converted. Here\[aq]s an example of print\[aq]s CSV output: .IP .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] +$ 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] -\[dq]1\[dq],\[dq]2008/01/01\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]income\[dq],\[dq]\[dq],\[dq]income:salary\[dq],\[dq]-1\[dq],\[dq]$\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq] +\[dq]1\[dq],\[dq]2008/01/01\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]income\[dq],\[dq]\[dq],\[dq]income:salary\[dq],\[dq]\-1\[dq],\[dq]$\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq] \[dq]2\[dq],\[dq]2008/06/01\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]gift\[dq],\[dq]\[dq],\[dq]assets:bank:checking\[dq],\[dq]1\[dq],\[dq]$\[dq],\[dq]\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq] -\[dq]2\[dq],\[dq]2008/06/01\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]gift\[dq],\[dq]\[dq],\[dq]income:gifts\[dq],\[dq]-1\[dq],\[dq]$\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq] +\[dq]2\[dq],\[dq]2008/06/01\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]gift\[dq],\[dq]\[dq],\[dq]income:gifts\[dq],\[dq]\-1\[dq],\[dq]$\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq] \[dq]3\[dq],\[dq]2008/06/02\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]save\[dq],\[dq]\[dq],\[dq]assets:bank:saving\[dq],\[dq]1\[dq],\[dq]$\[dq],\[dq]\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq] -\[dq]3\[dq],\[dq]2008/06/02\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]save\[dq],\[dq]\[dq],\[dq]assets:bank:checking\[dq],\[dq]-1\[dq],\[dq]$\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq] +\[dq]3\[dq],\[dq]2008/06/02\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]save\[dq],\[dq]\[dq],\[dq]assets:bank:checking\[dq],\[dq]\-1\[dq],\[dq]$\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq],\[dq]\[dq] \[dq]4\[dq],\[dq]2008/06/03\[dq],\[dq]\[dq],\[dq]*\[dq],\[dq]\[dq],\[dq]eat & shop\[dq],\[dq]\[dq],\[dq]expenses:food\[dq],\[dq]1\[dq],\[dq]$\[dq],\[dq]\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq] \[dq]4\[dq],\[dq]2008/06/03\[dq],\[dq]\[dq],\[dq]*\[dq],\[dq]\[dq],\[dq]eat & shop\[dq],\[dq]\[dq],\[dq]expenses:supplies\[dq],\[dq]1\[dq],\[dq]$\[dq],\[dq]\[dq],\[dq]1\[dq],\[dq]\[dq],\[dq]\[dq] -\[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]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] +\[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] .EE .IP \[bu] 2 There is one CSV record per posting, with the parent transaction\[aq]s @@ -9959,7 +10070,7 @@ date order, with their running total or running historical balance. (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 +register normally shows line per posting, but note that multi\-commodity amounts will occupy multiple lines (one line per commodity). .PP It is typically used with a query selecting a particular account, to see @@ -9969,92 +10080,92 @@ that account\[aq]s activity: $ 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 +2008/06/02 save assets:bank:checking $\-1 $1 +2008/12/31 pay off assets:bank:checking $\-1 0 .EE .PP -With \f[CR]--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[CR]--align-all\f[R] flag. +memory, use the \f[CR]\-\-align\-all\f[R] flag. .PP -The \f[CR]--historical\f[R]/\f[CR]-H\f[R] flag adds the balance from any -undisplayed prior postings to the running total. +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 .EX -$ hledger register checking -b 2008/6 --historical +$ 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 +2008/06/02 save assets:bank:checking $\-1 $1 +2008/12/31 pay off assets:bank:checking $\-1 0 .EE .PP -The \f[CR]--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[CR]--average\f[R]/\f[CR]-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[CR]--empty\f[R] (see below). -It is affected by \f[CR]--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[CR]--related\f[R]/\f[CR]-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[CR]--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 .EX -$ hledger register --related --invert assets:checking +$ hledger register \-\-related \-\-invert assets:checking .EE .PP With a reporting interval, register shows summary postings, one per interval, aggregating the postings to each account: .IP .EX -$ hledger register --monthly income -2008/01 income:salary $-1 $-1 -2008/06 income:gifts $-1 $-2 +$ hledger register \-\-monthly income +2008/01 income:salary $\-1 $\-1 +2008/06 income:gifts $\-1 $\-2 .EE .PP Periods with no activity, and summary postings with a zero amount, are -not shown by default; use the \f[CR]--empty\f[R]/\f[CR]-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 .EX -$ hledger register --monthly income -E -2008/01 income:salary $-1 $-1 -2008/02 0 $-1 -2008/03 0 $-1 -2008/04 0 $-1 -2008/05 0 $-1 -2008/06 income:gifts $-1 $-2 -2008/07 0 $-2 -2008/08 0 $-2 -2008/09 0 $-2 -2008/10 0 $-2 -2008/11 0 $-2 -2008/12 0 $-2 +$ hledger register \-\-monthly income \-E +2008/01 income:salary $\-1 $\-1 +2008/02 0 $\-1 +2008/03 0 $\-1 +2008/04 0 $\-1 +2008/05 0 $\-1 +2008/06 income:gifts $\-1 $\-2 +2008/07 0 $\-2 +2008/08 0 $\-2 +2008/09 0 $\-2 +2008/10 0 $\-2 +2008/11 0 $\-2 +2008/12 0 $\-2 .EE .PP Often, you\[aq]ll want to see just one line per interval. -The \f[CR]--depth\f[R] option helps with this, causing subaccounts to be -aggregated: +The \f[CR]\-\-depth\f[R] option helps with this, causing subaccounts to +be aggregated: .IP .EX -$ hledger register --monthly assets --depth 1h +$ hledger register \-\-monthly assets \-\-depth 1h 2008/01 assets $1 $1 -2008/06 assets $-1 0 -2008/12 assets $-1 $-1 +2008/06 assets $\-1 0 +2008/12 assets $\-1 $\-1 .EE .PP Note when using report intervals, if you specify start/end dates these @@ -10063,26 +10174,27 @@ intervals. This ensures that the first and last intervals are full length and comparable to the others in the report. .PP -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. +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. +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 register uses the full terminal width by default, except on windows. You can override this by setting the \f[CR]COLUMNS\f[R] environment variable (not a bash shell variable) or by using the -\f[CR]--width\f[R]/\f[CR]-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). +(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[CR]--width W,D\f[R] . -Here\[aq]s a diagram (won\[aq]t display correctly in --help): +\-\-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 .EX -<--------------------------------- width (W) ----------------------------------> -date (10) description (D) account (W-41-D) amount (12) balance (12) +<\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- width (W) \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-> +date (10) description (D) account (W\-41\-D) amount (12) balance (12) DDDDDDDDDD dddddddddddddddddddd aaaaaaaaaaaaaaaaaaa AAAAAAAAAAAA AAAAAAAAAAAA .EE .PP @@ -10090,20 +10202,20 @@ and some examples: .IP .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 +$ 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 +$ hledger reg \-w 100,40 # set overall width 100, description width 40 +$ hledger reg \-w $COLUMNS,40 # use terminal width, & description width 40 .EE .PP This command also supports the output destination and output format 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]. +\f[CR]tsv\f[R], and \f[CR]json\f[R]. .SS rewrite Print all transactions, rewriting the postings of matched transactions. For now the only rewrite available is adding new postings, like print ---auto. +\-\-auto. .PP This is a start at a generic rewriter of transaction entries. It reads the default journal and prints the transactions, like print, @@ -10115,9 +10227,9 @@ transaction\[aq]s first posting amount. Examples: .IP .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 +$ 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 .EE .PP rewrites.hledger may consist of entries like: @@ -10135,13 +10247,13 @@ spaces between account and amount. More: .IP .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] +$ 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] .EE .PP -Argument for \f[CR]--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[CR]\[aq]*\[aq]\f[R] (star symbol) before the amount to indicate that that this is a factor for an amount of @@ -10149,14 +10261,14 @@ 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 +.SS Re\-write rules in a file 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 .EX -$ rewrite-rules.journal +$ rewrite\-rules.journal .EE .PP Make contents look like this: @@ -10166,7 +10278,7 @@ Make contents look like this: (liabilities:tax) *.33 = expenses:gifts - budget:gifts *-1 + budget:gifts *\-1 assets:budget *1 .EE .PP @@ -10176,43 +10288,43 @@ It indicates the query by which you want to match the posting to add new ones. .IP .EX -$ hledger rewrite -- -f input.journal -f rewrite-rules.journal > rewritten-tidy-output.journal +$ hledger rewrite \-\- \-f input.journal \-f rewrite\-rules.journal > rewritten\-tidy\-output.journal .EE .PP This is something similar to the commands pipeline: .IP .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 +$ 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 .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. +You can re\-use result of previously added postings. .SS Diff output format To use this tool for batch modification of your journal files you may find useful output in form of unified diff. .IP .EX -$ hledger rewrite -- --diff -f examples/sample.journal \[aq]\[ha]income\[aq] --add-posting \[aq](liabilities:tax) *.33\[aq] +$ hledger rewrite \-\- \-\-diff \-f examples/sample.journal \[aq]\[ha]income\[aq] \-\-add\-posting \[aq](liabilities:tax) *.33\[aq] .EE .PP Output might look like: .IP .EX ---- /tmp/examples/sample.journal +\-\-\- /tmp/examples/sample.journal +++ /tmp/examples/sample.journal -\[at]\[at] -18,3 +18,4 \[at]\[at] +\[at]\[at] \-18,3 +18,4 \[at]\[at] 2008/01/01 income -- assets:bank:checking $1 +\- assets:bank:checking $1 + assets:bank:checking $1 income:salary + (liabilities:tax) 0 -\[at]\[at] -22,3 +23,4 \[at]\[at] +\[at]\[at] \-22,3 +23,4 \[at]\[at] 2008/06/01 gift -- assets:bank:checking $1 +\- assets:bank:checking $1 + assets:bank:checking $1 income:gifts + (liabilities:tax) 0 @@ -10221,55 +10333,55 @@ Output might look like: 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[CR]--file\f[R] options and \f[CR]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 +Whole transaction being re\-formatted in a style of output from \f[CR]hledger print\f[R]. .PP See also: .PP https://github.com/simonmichael/hledger/issues/99 -.SS rewrite vs. print --auto -This command predates print --auto, and currently does much the same +.SS rewrite vs. print \-\-auto +This command predates print \-\-auto, and currently does much the same thing, but with these differences: .IP \[bu] 2 with multiple files, rewrite lets rules in any file affect all other files. -print --auto uses standard directive scoping; rules affect only child +print \-\-auto uses standard directive scoping; rules affect only child files. .IP \[bu] 2 rewrite\[aq]s query limits which transactions can be rewritten; all are printed. -print --auto\[aq]s query limits which transactions are printed. +print \-\-auto\[aq]s query limits which transactions are printed. .IP \[bu] 2 rewrite applies rules specified on command line or in the journal. -print --auto applies rules specified in the journal. +print \-\-auto applies rules specified in the journal. .SS roi -Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on -your investments. +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[CR]--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[CR]--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[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). +or do not require computation of time\-weighted return (TWR), +\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 -(IRR, also known as money-weighted rate of return) and time-weighted +(IRR, also known as money\-weighted rate of return) and time\-weighted rate of return (TWR) for your investments for the time period requested. 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. .PP Price directives will be taken into account if you supply appropriate -\f[CR]--cost\f[R] or \f[CR]--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 @@ -10284,38 +10396,38 @@ Either search does not converge to a solution, or converges too slowly. Examples: .IP \[bu] 2 Using roi to compute total return of investment in stocks: -https://github.com/simonmichael/hledger/blob/master/examples/investing/roi-unrealised.ledger +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[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 +.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): +To indicate that all search terms form single command\-line argument, +you will need to put them in quotes (see Special characters): .IP .EX -$ hledger roi --inv \[aq]term1 term2 term3 ...\[aq] +$ hledger roi \-\-inv \[aq]term1 term2 term3 ...\[aq] .EE .PP If any query terms contain spaces themselves, you will need an extra level of nested quoting, eg: .IP .EX -$ hledger roi --inv=\[dq]\[aq]Assets:Test 1\[aq]\[dq] --pnl=\[dq]\[aq]Equity:Unrealized Profit and Loss\[aq]\[dq] +$ hledger roi \-\-inv=\[dq]\[aq]Assets:Test 1\[aq]\[dq] \-\-pnl=\[dq]\[aq]Equity:Unrealized Profit and Loss\[aq]\[dq] .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 +.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. +Transactions not matching \f[CR]\-\-inv\f[R] will be ignored. .PP In these transactions, ROI will conside postings that match -\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. +\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. .IP \[bu] 2 \[dq]Cash flow\[dq] is depositing or withdrawing money, buying or selling assets, or otherwise converting between your investment @@ -10324,11 +10436,11 @@ Example: .RS 2 .IP .EX -2019-01-01 Investing in Snake Oil - assets:cash -$100 +2019\-01\-01 Investing in Snake Oil + assets:cash \-$100 investment:snake oil -2020-01-01 Selling my Snake Oil +2020\-01\-01 Selling my Snake Oil assets:cash $10 investment:snake oil = 0 .EE @@ -10338,32 +10450,32 @@ Example: .RS 2 .IP .EX -2019-06-01 Snake Oil falls in value +2019\-06\-01 Snake Oil falls in value investment:snake oil = $57 equity:unrealized profit or loss .EE .RE .PP -All non-investment postings are assumed to be \[dq]cash flow\[dq], -unless they match \f[CR]--pnl\f[R] query. +All non\-investment postings are assumed to be \[dq]cash flow\[dq], +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[CR]--inv snake --pnl equity:unrealized\f[R], then -postings in the example below would be classifed as: +Example: if you use \f[CR]\-\-inv snake \-\-pnl equity:unrealized\f[R], +then postings in the example below would be classifed as: .IP .EX -2019-01-01 Snake Oil #1 - assets:cash -$100 ; cash flow posting +2019\-01\-01 Snake Oil #1 + assets:cash \-$100 ; cash flow posting investment:snake oil ; investment posting -2019-03-01 Snake Oil #2 - equity:unrealized pnl -$100 ; profit and loss posting +2019\-03\-01 Snake Oil #2 + equity:unrealized pnl \-$100 ; profit and loss posting snake oil ; investment posting -2019-07-01 Snake Oil #3 +2019\-07\-01 Snake Oil #3 equity:unrealized pnl ; profit and loss posting - cash -$100 ; cash flow posting + cash \-$100 ; cash flow posting snake oil $50 ; investment posting .EE .SS IRR and TWR explained @@ -10373,14 +10485,14 @@ investment and its initial value, expressed in percentage of the initial value. .PP However, this approach is only practical in simple cases, where -investments receives no in-flows or out-flows of money, and where rate +investments receives no in\-flows or out\-flows of money, and where rate of growth is fixed over time. For more complex scenarios you need different ways to compute rate of return, and this command implements two of them: IRR and TWR. .PP Internal rate of return, or \[dq]IRR\[dq] (also called -\[dq]money-weighted rate of return\[dq]) takes into account effects of -in-flows and out-flows, and the time between them. +\[dq]money\-weighted rate of return\[dq]) 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. @@ -10391,17 +10503,17 @@ And if you are adding to your investment, you will receive bigger absolute gains, which will be a bigger percentage of your initial investment, so your IRR will be larger. .PP -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 \[dq]roi\[dq] command, these -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. +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 \[dq]unrealized gains\[dq]) 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. +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. .PP 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 @@ -10412,20 +10524,21 @@ Implementation of IRR in hledger should produce results that match the \f[CR]=XIRR\f[R] formula in Excel. .PP 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 +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, -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. +Like IRR, it will account 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. .PP TWR represents your investment as an imaginary \[dq]unit fund\[dq] where -in-flows/ out-flows lead to buying or selling \[dq]units\[dq] of your +in\-flows/ out\-flows lead to buying or selling \[dq]units\[dq] of your investment and changes in its value change the value of \[dq]investment unit\[dq]. Change in \[dq]unit price\[dq] 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. +the effects of cash in\-flows and out\-flows. .PP References: .IP \[bu] 2 @@ -10452,16 +10565,16 @@ 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[CR]stats\f[R] command\[aq]s run time is similar to that of a -single-column balance report. +single\-column balance report. .PP Example: .IP .EX -$ hledger stats -f examples/1000x1000x10.journal +$ hledger stats \-f examples/1000x1000x10.journal Main file : /Users/simon/src/hledger/examples/1000x1000x10.journal Included files : -Transactions span : 2000-01-01 to 2002-09-27 (1000 days) -Last transaction : 2002-09-26 (6995 days ago) +Transactions span : 2000\-01\-01 to 2002\-09\-27 (1000 days) +Last transaction : 2002\-09\-26 (6995 days ago) Transactions : 1000 (1.0 per day) Transactions last 30 days: 0 (0.0 per day) Transactions last 7 days : 0 (0.0 per day) @@ -10474,8 +10587,8 @@ Run time : 0.12 s Throughput : 8342 txns/s .EE .PP -This command supports the -o/--output-file option (but not --O/--output-format selection). +This command supports the \-o/\-\-output\-file option (but not +\-O/\-\-output\-format selection). .SS tags List the tags used in the journal, or their values. .PP @@ -10490,11 +10603,11 @@ are considered. If the query involves transaction fields (date:, desc:, amt:, ...), the search is restricted to the matched transactions and their accounts. .PP -With the --values flag, the tags\[aq] unique non-empty values are listed -instead. -With -E/--empty, blank/empty values are also shown. +With the \-\-values flag, the tags\[aq] unique non\-empty values are +listed instead. +With \-E/\-\-empty, blank/empty values are also shown. .PP -With --parsed, tags or values are shown in the order they were parsed, +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.) .PP @@ -10502,28 +10615,28 @@ 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 -Run built-in unit tests. +Run built\-in unit tests. .PP -This command runs the unit tests built in to hledger and hledger-lib, +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. +If any test fails, the exit code will be non\-zero. .PP 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 +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! .PP -This command also accepts tasty test runner options, written after a -- -(double hyphen). +This command also accepts tasty test runner options, written after a +\-\- (double hyphen). Eg to run only the tests in Hledger.Data.Amount, with ANSI colour codes disabled: .IP .EX -$ hledger test -- -pData.Amount --color=never +$ hledger test \-\- \-pData.Amount \-\-color=never .EE .PP For help on these, see https://github.com/feuerbach/tasty#options -(\f[CR]-- --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 Here are some quick examples of how to do some basic tasks with hledger. @@ -10532,8 +10645,8 @@ Here\[aq]s how to list commands and view options and command docs: .IP .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 +$ hledger \-\-help # show common options +$ hledger CMD \-\-help # show CMD\[aq]s options, common options and CMD\[aq]s documentation .EE .PP You can also view your hledger version\[aq]s manual in several formats @@ -10543,7 +10656,7 @@ Eg: .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 +$ hledger help \-\-help # find out more about the help command .EE .PP To view manuals and introductory docs on the web, visit @@ -10556,11 +10669,11 @@ 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[CR]hledger CMD OPTS ARGS\f[R]) +command\-specific options must go after the command (it\[aq]s fine to +put 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[CR]hledger-ui OPTS ARGS\f[R]) +running add\-on executables directly simplifies command line parsing +(\f[CR]hledger\-ui OPTS ARGS\f[R]) .IP \[bu] 2 enclose \[dq]problematic\[dq] args in single quotes .IP \[bu] 2 @@ -10568,7 +10681,7 @@ 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[CR]--debug=2\f[R]. +\f[CR]\-\-debug=2\f[R]. .SS Starting a journal file hledger looks for your accounting data in a journal file, \f[CR]$HOME/.hledger.journal\f[R] by default: @@ -10577,7 +10690,7 @@ hledger looks for your accounting data in a journal file, $ 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. +Or, specify an existing journal file with \-f or LEDGER_FILE. .EE .PP You can override this by setting the \f[CR]LEDGER_FILE\f[R] environment @@ -10646,7 +10759,7 @@ persists across a reboot, and if you need to be an Administrator): .EE .SS Setting opening balances Pick a starting date for which you can look up the balances of some -real-world assets (bank accounts, wallet..) +real\-world assets (bank accounts, wallet..) and liabilities (credit cards..). .PP To avoid a lot of data entry, you may want to start with just one or two @@ -10664,15 +10777,15 @@ like this: .RS 2 .IP .EX -2023-01-01 * opening balances +2023\-01\-01 * opening balances assets:bank:checking $1000 = $1000 assets:bank:savings $2000 = $2000 assets:cash $100 = $100 - liabilities:creditcard $-50 = $-50 + liabilities:creditcard $\-50 = $\-50 equity:opening/closing balances .EE .PP -These are start-of-day balances, ie whatever was in the account at the +These are start\-of\-day balances, ie whatever was in the account at the end of the previous day. .PP The * after the date is an optional status flag. @@ -10698,31 +10811,31 @@ An optional (CODE) may follow transaction dates. An optional ; COMMENT may follow descriptions or amounts. If you make a mistake, enter < at any prompt to go one step backward. To end a transaction, enter . when prompted. -To quit, enter . at a date prompt or press control-d or control-c. -Date [2023-02-07]: 2023-01-01 +To quit, enter . at a date prompt or press control\-d or control\-c. +Date [2023\-02\-07]: 2023\-01\-01 Description: * opening balances Account 1: assets:bank:checking Amount 1: $1000 Account 2: assets:bank:savings -Amount 2 [$-1000]: $2000 +Amount 2 [$\-1000]: $2000 Account 3: assets:cash -Amount 3 [$-3000]: $100 +Amount 3 [$\-3000]: $100 Account 4: liabilities:creditcard -Amount 4 [$-3100]: $-50 +Amount 4 [$\-3100]: $\-50 Account 5: equity:opening/closing balances -Amount 5 [$-3050]: +Amount 5 [$\-3050]: Account 6 (or . or enter to finish this transaction): . -2023-01-01 * opening balances +2023\-01\-01 * opening balances assets:bank:checking $1000 assets:bank:savings $2000 assets:cash $100 - liabilities:creditcard $-50 - equity:opening/closing balances $-3050 + liabilities:creditcard $\-50 + equity:opening/closing balances $\-3050 Save this transaction to the journal ? [y]: Saved. -Starting the next transaction (. or ctrl-D/ctrl-C to quit) -Date [2023-01-01]: . +Starting the next transaction (. or ctrl\-D/ctrl\-C to quit) +Date [2023\-01\-01]: . .EE .RE .PP @@ -10731,13 +10844,13 @@ the journal. Eg: .IP .EX -$ git commit -m \[aq]initial balances\[aq] 2023.journal +$ git commit \-m \[aq]initial balances\[aq] 2023.journal .EE .SS 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 -convert CSV data downloaded from your bank. +hledger\-iadd or hledger\-web add\-ons, or by using the import command +to convert CSV data downloaded from your bank. .PP Here are some simple transactions, see the hledger_journal(5) manual and hledger.org for more ideas: @@ -10751,18 +10864,18 @@ hledger.org for more ideas: expenses:food $13 assets:cash -2023-01-15 paycheck +2023\-01\-15 paycheck income:salary assets:bank:checking $1000 .EE .SS Reconciling -Periodically you should reconcile - compare your hledger-reported +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 -the real-world balances (and, that the real-world institutions have not -made a mistake!). +bank\[aq]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 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 discrepancies. .PP @@ -10772,7 +10885,7 @@ Reconcile cash. Count what\[aq]s in your wallet. 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. +for the error in the already\-recorded transactions. 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 @@ -10780,8 +10893,8 @@ $2, it could be: .RS 4 .IP .EX -2023-01-16 * adjust cash - assets:cash $-2 = $105 +2023\-01\-16 * adjust cash + assets:cash $\-2 = $105 expenses:misc .EE .RE @@ -10789,32 +10902,32 @@ $2, it could be: Reconcile checking. Log in to your bank\[aq]s website. Compare today\[aq]s (cleared) balance with hledger\[aq]s cleared balance -(\f[CR]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[CR]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 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[CR]hledger-ui --watch --register checking -C\f[R] +Tip: instead of the register command, use hledger\-ui to see a +live\-updating register while you edit the journal: +\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[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] +\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 .EX -$ git commit -m \[aq]txns\[aq] 2023.journal +$ git commit \-m \[aq]txns\[aq] 2023.journal .EE .SS Reporting Here are some basic reports. @@ -10823,34 +10936,34 @@ Show all transactions: .IP .EX $ hledger print -2023-01-01 * opening balances +2023\-01\-01 * opening balances assets:bank:checking $1000 assets:bank:savings $2000 assets:cash $100 - liabilities:creditcard $-50 - equity:opening/closing balances $-3050 + liabilities:creditcard $\-50 + equity:opening/closing balances $\-3050 -2023-01-10 * gift received +2023\-01\-10 * gift received assets:cash $20 income:gifts -2023-01-12 * farmers market +2023\-01\-12 * farmers market expenses:food $13 assets:cash -2023-01-15 * paycheck +2023\-01\-15 * paycheck income:salary assets:bank:checking $1000 -2023-01-16 * adjust cash - assets:cash $-2 = $105 +2023\-01\-16 * adjust cash + assets:cash $\-2 = $105 expenses:misc .EE .PP Show account names, and their hierarchy: .IP .EX -$ hledger accounts --tree +$ hledger accounts \-\-tree assets bank checking @@ -10877,15 +10990,15 @@ $ hledger balance $2000 checking $2000 savings $105 cash - $-3050 equity:opening/closing balances + $\-3050 equity:opening/closing balances $15 expenses $13 food $2 misc - $-1020 income - $-20 gifts - $-1000 salary - $-50 liabilities:creditcard --------------------- + $\-1020 income + $\-20 gifts + $\-1000 salary + $\-50 liabilities:creditcard +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- 0 .EE .PP @@ -10893,11 +11006,11 @@ Show only asset and liability balances, as a flat list, limited to depth 2: .IP .EX -$ hledger bal assets liabilities -2 +$ hledger bal assets liabilities \-2 $4000 assets:bank $105 assets:cash - $-50 liabilities:creditcard --------------------- + $\-50 liabilities:creditcard +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- $4055 .EE .PP @@ -10905,22 +11018,22 @@ Show the same thing without negative numbers, formatted as a simple balance sheet: .IP .EX -$ hledger bs -2 -Balance Sheet 2023-01-16 +$ hledger bs \-2 +Balance Sheet 2023\-01\-16 - || 2023-01-16 + || 2023\-01\-16 ========================++============ Assets || -------------------------++------------ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\- assets:bank || $4000 assets:cash || $105 -------------------------++------------ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\- || $4105 ========================++============ Liabilities || -------------------------++------------ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\- liabilities:creditcard || $50 -------------------------++------------ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\- || $50 ========================++============ Net: || $4055 @@ -10933,22 +11046,22 @@ Show income and expense totals, formatted as an income statement: .IP .EX hledger is -Income Statement 2023-01-01-2023-01-16 +Income Statement 2023\-01\-01\-2023\-01\-16 - || 2023-01-01-2023-01-16 + || 2023\-01\-01\-2023\-01\-16 ===============++======================= Revenues || ----------------++----------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- income:gifts || $20 income:salary || $1000 ----------------++----------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- || $1020 ===============++======================= Expenses || ----------------++----------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- expenses:food || $13 expenses:misc || $2 ----------------++----------------------- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-++\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- || $15 ===============++======================= Net: || $1005 @@ -10960,19 +11073,19 @@ Show transactions affecting your wallet, with running total: .IP .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 +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 .EE .PP Show weekly posting counts as a bar chart: .IP .EX -$ hledger activity -W -2019-12-30 ***** -2023-01-06 **** -2023-01-13 **** +$ hledger activity \-W +2019\-12\-30 ***** +2023\-01\-06 **** +2023\-01\-13 **** .EE .SS Migrating to a new file At the end of the year, you may want to continue your journal in a new @@ -10989,16 +11102,16 @@ http://bugs.hledger.org), or on the #hledger chat or hledger mail list .PP Some known issues and limitations: .PP -The need to precede add-on command options with \f[CR]--\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 -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.) .PP 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 +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[CR]hledger add\f[R]. (Running in a WSL window should resolve these.) @@ -11046,15 +11159,15 @@ character)\[dq]\f[R] .P .PD Programs compiled with GHC (hledger, haskell build tools, etc.) -need the system locale to be UTF-8-aware, or they will fail when they -encounter non-ascii characters. +need the system locale to be UTF\-8\-aware, or they will fail when they +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. +UTF\-8 and which is installed on your system. .PP -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 +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], +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[CR]LANG\f[R] environment variable. @@ -11064,15 +11177,15 @@ your shell: .IP .EX $ echo \[dq]export LANG=en_US.utf8\[dq] >>\[ti]/.profile -# close and re-open terminal window +# close and re\-open terminal window .EE .PP If you are using Nix (not NixOS) for GHC and Hledger, you might need to set the \f[CR]LOCALE_ARCHIVE\f[R] variable: .IP .EX -$ echo \[dq]export LOCALE_ARCHIVE=${glibcLocales}/lib/locale/locale-archive\[dq] >>\[ti]/.profile -# close and re-open terminal window +$ echo \[dq]export LOCALE_ARCHIVE=${glibcLocales}/lib/locale/locale\-archive\[dq] >>\[ti]/.profile +# close and re\-open terminal window .EE .PP \f[B]COMPATIBILITY ISSUES: hledger gives an error with my Ledger diff --git a/hledger/hledger.info b/hledger/hledger.info index 50ac72c7e..b92adc545 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -1,4 +1,4 @@ -This is hledger.info, produced by makeinfo version 7.0.3 from stdin. +This is hledger.info, produced by makeinfo version 7.1 from stdin. INFO-DIR-SECTION User Applications START-INFO-DIR-ENTRY @@ -2911,12 +2911,18 @@ File: hledger.info, Node: Periodic transactions, Next: Auto postings, Prev: t 9.26 Periodic transactions ========================== -The '~' 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. +The '~' directive declares a "periodic rule" which generates temporary +extra transactions, usually recurring at some interval, when hledger is +run with the '--forecast' flag. These "forecast transactions" are +useful for forecasting future activity. They exist only for the +duration of the report, and only when '--forecast' is used; they are not +saved in the journal file by hledger. - Periodic transactions can be a little tricky, so before you use them, -read this whole section, or at least these tips: + Periodic rules also have a second use: with the '--budget' flag they +set budget goals for budgeting. + + Periodic rules can be a little tricky, so before you use them, read +this whole section, or at least the following tips: 1. Two spaces accidentally added or omitted will cause you trouble - read about this below. @@ -3022,47 +3028,46 @@ File: hledger.info, Node: Auto postings, Next: Other syntax, Prev: Periodic t 9.27 Auto postings ================== -The '=' 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's amount. This can be -useful for generating tax postings with a standard percentage, for -example. +The '=' directive declares an "auto posting rule", which adds extra +postings to existing transactions. (Remember, postings are the account +name & amount lines below a transaction's date & description.) - Note that depending on generated data is not ideal for financial -records (it'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 '--auto'). - - An auto posting rule looks a bit like a transaction: + In the journal, an auto posting rule looks quite like a transaction, +but instead of date and description it has '=' (mnemonic: "match") and a +query, like this: = QUERY - ACCOUNT AMOUNT + ACCOUNT AMOUNT ... - ACCOUNT [AMOUNT] - except the first line is an equals sign (mnemonic: '=' suggests -matching), followed by a query (which matches existing postings), and -each "posting" line describes a posting to be generated, and the posting -amounts can be: + Queries are just like command line queries; an account name substring +is most common. Query terms containing spaces should be enclosed in +single or double quotes. - * a normal amount with a commodity symbol, eg '$2'. This will be + Each '=' rule works like this: when hledger is run with the '--auto' +flag, wherever the QUERY matches a posting in the journal, the rule's +postings are added to that transaction, immediately below the matched +posting. Note these generated postings are temporary, existing only for +the duration of the report, and only when '--auto' is used; they are not +saved in the journal file by hledger. + + Generated postings' amounts can depend on the matched posting's +amount. So auto postings can be useful for, eg, adding tax postings +with a standard percentage. AMOUNT can be: + + * a number with no commodity symbol, like '2'. The matched posting's + commodity symbol will be added to this. + + * a normal amount with a commodity symbol, like '$2'. This will be used as-is. - * a number, eg '2'. The commodity symbol (if any) from the matched - posting will be added to this. - * a numeric multiplier, eg '*2' (a star followed by a number N). The - matched posting's amount (and total price, if any) will be - multiplied by N. - * a multiplier with a commodity symbol, eg '*$2' (a star, number N, - and symbol S). The matched posting's amount will be multiplied by - N, and its commodity symbol will be replaced with S. - Any query term containing spaces must be enclosed in single or double -quotes, as on the command line. Eg, note the quotes around the second -query term below: + * an asterisk followed by a number, like '*2'. This will multiply + the matched posting's amount (and total price, if any) by the + number. -= expenses:groceries 'expenses:dining out' - (budget:funds:dining out) *-1 + * an asterisk followed by an amount with commodity symbol, like + '*$2'. This multiplies and also replaces the commodity symbol with + this new one. Some examples: @@ -3095,6 +3100,14 @@ $ hledger print --auto assets:checking:gifts -$20 assets:checking $20 + Note that depending fully on generated data such as this has some +drawbacks - it's less portable, less future-proof, less auditable by +others, and less robust (eg your balance assertions will depend on +whether you use or don't use '--auto'). An alternative is to use auto +postings in "one time" fashion - use them to help build a complex +journal entry, view it with 'hledger print --auto', and then copy that +output into the journal file to make it permanent. + * Menu: * Auto postings and multiple files:: @@ -3245,17 +3258,17 @@ trustworthy in an audit. * Menu: -* Balance assignments and prices:: +* Balance assignments and costs:: * Balance assignments and multiple files::  -File: hledger.info, Node: Balance assignments and prices, Next: Balance assignments and multiple files, Up: Balance assignments +File: hledger.info, Node: Balance assignments and costs, Next: Balance assignments and multiple files, Up: Balance assignments -9.28.1.1 Balance assignments and prices -....................................... +9.28.1.1 Balance assignments and costs +...................................... A cost in a balance assignment will cause the calculated amount to have -that price attached: +that cost attached: 2019/1/1 (a) = $1 @ €2 @@ -3265,7 +3278,7 @@ $ hledger print --explicit (a) $1 @ €2 = $1 @ €2  -File: hledger.info, Node: Balance assignments and multiple files, Prev: Balance assignments and prices, Up: Balance assignments +File: hledger.info, Node: Balance assignments and multiple files, Prev: Balance assignments and costs, Up: Balance assignments 9.28.1.2 Balance assignments and multiple files ............................................... @@ -5755,41 +5768,56 @@ File: hledger.info, Node: Queries, Next: Pivoting, Prev: Depth, Up: Top ********** One of hledger'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 scope. The syntax is as follows: +subset of your data. Most hledger commands accept query arguments, to +restrict their scope. Multiple query terms can be provided to build up +a more complex query. - * Zero or more space-separated query terms. These are most often - account name substrings: + * By default, a query term is interpreted as a case-insensitive + substring pattern for matching account names: - 'utilities food:groceries' + 'car:fuel' + 'dining groceries' - * Terms with spaces or other special characters should be enclosed in - quotes: + * Patterns containing spaces or other special characters must be + enclosed in single or double quotes: - '"personal care"' + ''personal care'' - * Regular expressions are also supported: + * These patterns are actually regular expressions, so you can add + regexp metacharacters for more precision (see "Regular expressions" + above for details): - '"^expenses\b"' - '"accounts (payable|receivable)"' + ''^expenses\b'' + ''food$'' + ''fuel|repair'' + ''accounts (payable|receivable)'' - * Add a query type prefix to match other parts of the data: + * To match something other than account name, add one of the query + type prefixes described in "Query types" below: 'date:202312-' 'status:' 'desc:amazon' 'cur:USD' - '"amt:>0"' + 'cur:\\$' + 'amt:'>0'' - * Add a 'not:' prefix to negate: + * Add a 'not:' prefix to negate a term: + 'not:status:'*'' + 'not:desc:'opening|closing'' 'not:cur:USD' - * Multiple unlike terms are AND-ed, multiple like terms are OR-ed + * Terms with different types are AND-ed, terms with the same type are + OR-ed (mostly; see "Combining query terms" below). The following + query: 'date:2022 desc:amazon desc:amzn' - (all transactions with "amazon" or "amzn" in description during - 2022) + + is interpreted as: + + _date is in 2022 AND ( transaction description contains "amazon" OR + "amzn" )_ * Menu: @@ -5809,11 +5837,10 @@ File: hledger.info, Node: Query types, Next: Combining query terms, Up: Queri Here are the types of query term available. Remember these can also be prefixed with *'not:'* to convert them into a negative match. - *'acct:REGEX', 'REGEX'* -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 'expenses' or 'food'. + *'acct:REGEX'* or *'REGEX'* +Match account names containing this case insensitive regular expression. +This is the default query type, so we usually don't bother writing the +"acct:" prefix. *'amt:N, amt:N, amt:>=N'* Match postings with a single-commodity amount equal to, less than, or @@ -6113,8 +6140,7 @@ There is another way: with the '--forecast' option, hledger can generate temporary "forecast transactions" for reporting purposes, according to periodic transaction rules defined in the journal. Each rule can generate multiple recurring transactions, so by changing one rule you -can change many forecasted transactions. (These same rules can also -generate budget goals, described in Budgeting.) +can change many forecasted transactions. Forecast transactions usually start after ordinary transactions end. By default, they begin after your latest-dated ordinary transaction, or @@ -6494,8 +6520,6 @@ $ hledger print -x --infer-costs --infer-equity Downsides: - * This was added in hledger-1.29 and is still somewhat experimental. - * The precise format of the journal entry becomes more important. If hledger can't detect and match up the cost and equity postings, it will give a transaction balancing error. @@ -7411,8 +7435,11 @@ Saved. Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ - On Microsoft Windows, the add command makes sure that no part of the -file path ends with a period, as that would cause problems (#1056). + If you enter a number with no commodity symbol, and you have declared +a default commodity with a 'D' directive, you might expect 'add' to add +this symbol for you. It does not do this; we assume that if you are +using a 'D' directive you prefer not to see the commodity symbol +repeated on amounts in the journal.  File: hledger.info, Node: aregister, Next: balance, Prev: add, Up: PART 4 COMMANDS @@ -7912,7 +7939,7 @@ Balance changes in 2008: * Accounts (rows) containing all zeroes are not shown, unless '-E/--empty' is used. * Amounts with many commodities are shown in abbreviated form, unless - '--no-elide' is used. _(experimental)_ + '--no-elide' is used. * Average and/or total columns can be added with the '-A/--average' and '-T/--row-total' flags. * The '--transpose' flag can be used to exchange rows and columns. @@ -8559,7 +8586,7 @@ flipped. This command also supports the output destination and output format options The output formats supported are 'txt', 'csv', 'tsv', 'html', -and (experimental) 'json'. +and 'json'.  File: hledger.info, Node: balancesheetequity, Next: cashflow, Prev: balancesheet, Up: PART 4 COMMANDS @@ -8666,7 +8693,7 @@ not:receivable', but with smarter account detection. This command also supports the output destination and output format options The output formats supported are 'txt', 'csv', 'tsv', 'html', -and (experimental) 'json'. +and 'json'.  File: hledger.info, Node: check, Next: close, Prev: cashflow, Up: PART 4 COMMANDS @@ -8802,50 +8829,74 @@ File: hledger.info, Node: close, Next: codes, Prev: check, Up: PART 4 COMMAN (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 -end of accounting period. + A transaction-generating command which generates several kinds of +"closing" and/or "opening" transactions useful in certain situations. +It prints one or two transactions to stdout, but does not write them to +the journal file; you can append or copy them there when you are happy +with the output. - By default, it prints a transaction that zeroes out ALE accounts -(asset, liability, equity accounts; this requires account types to be -configured); or if ACCTQUERY is provided, the accounts matched by that. + This command is most often used when migrating balances to a new +journal file, at the start of a new financial year. It can also be used +to "retain earnings" (transfer revenues and expenses to equity), or as a +sort of generic mover of balances from any group of accounts to some +other account. So it currently has six modes, selected by a mode flag. +Use only one of these flags at a time: - _(experimental)_ - - 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 accounts matched by the provided ACCTQUERY - arguments. + 1. With '--close' (or no mode flag) it prints a "closing balances" + transaction that zeroes out all the asset, liability, and equity + account balances, by default (this requires inferred or declared + account types). Or, it will zero out the accounts matched by any + ACCTQUERY arguments you provide. All of the balances are + transferred to a special "opening/closing balances" equity account. 2. With '--open', it prints an opposite "opening balances" transaction - that restores those balances from zero. This is similar to - Ledger's equity command. + that restores the same account balances, starting from zero. This + mode 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 other out, preserving - correct balances during multi-file reporting. + transactions above. This is a common way to migrate balances to a + new file at year end; run 'hledger close --migrate -e NEWYEAR' (-e + influences the transaction date) and add the closing transaction at + the end of the old file, and the opening transaction at the start + of the new file. Doing this means you can include past year files + in your reports at any time without disturbing + asset/liability/equity balances, because the closing balances + transaction cancels out the following opening balances transaction. + You will sometimes need to exclude these transactions from reports, + eg to see an end of year balance sheet; a 'not:opening/closing' + query argument should do. You should probably also use this query + when 'close'-ing, to exclude the "opening/closing balances" account + which might otherwise cause problems. Or you can just migrate + assets and liabilities: 'hledger close type:AL'. Most people don't + need to migrate equity. And revenues and expenses usually should + not be migrated. - 4. With '--retain', it prints a "retain earnings" transaction that - transfers RX (revenue and expense) balances to 'equity:retained - earnings'. 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. + 4. With '--assert' it prints a "closing balances" transaction that + just asserts the current balances, without changing them. This can + be useful as documention and to guard against errors and changes. - In all modes, the defaults can be overridden: + 5. With '--assign' it prints an "opening balances" transaction that + restores the account balances using balance assignments. Balance + assignments work regardless of any previous balance, so a preceding + closing balances transaction is not needed. This is an alternative + to '--close' and '--open': at year end, 'hledger close --assert -e + NEWYEAR' in the old file (optional, but useful for error checking), + and 'hledger close --assign -e NEWYEAR' in the new file. This + might be more convenient, eg if you are often doing cleanups or + fixes which would break closing/opening transactions. + + 6. With '--retain', it prints a "retain earnings" transaction that + transfers revenue and expense balances to 'equity:retained + earnings'. This is a traditional end-of-period bookkeeping + operation also called "closing the books"; in personal accounting + you probably will not need this but it could be useful if you want + to see the accounting equation (A=L+E) balanced. + + In all modes, the following things can be overridden: * the transaction descriptions can be changed with '--close-desc=DESC' and '--open-desc=DESC' - * the account to transfer to/from can be changed with + * the account to transfer to and from can be changed with '--close-acct=ACCT' and '--open-acct=ACCT' * the accounts to be closed/opened can be changed with 'ACCTQUERY' (account query arguments). @@ -9367,7 +9418,7 @@ sign flipped. This command also supports the output destination and output format options The output formats supported are 'txt', 'csv', 'tsv', 'html', -and (experimental) 'json'. +and 'json'.  File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: PART 4 COMMANDS @@ -9575,8 +9626,8 @@ This command also supports the output destination and output format options The output formats supported are 'txt', 'beancount', 'csv', 'tsv', 'json' and 'sql'. - _Experimental:_ The 'beancount' format tries to produce -Beancount-compatible output, as follows: + The 'beancount' format tries to produce Beancount-compatible output, +as follows: * Transaction and postings with unmarked status are converted to cleared ('*') status. @@ -9770,7 +9821,7 @@ $ hledger reg -w $COLUMNS,40 # use terminal width, & description width 40 This command also supports the output destination and output format options The output formats supported are 'txt', 'csv', 'tsv', and -(experimental) 'json'. +'json'.  File: hledger.info, Node: rewrite, Next: roi, Prev: register, Up: PART 4 COMMANDS @@ -10766,659 +10817,659 @@ See hledger and Ledger for full details.  Tag Table: -Node: Top210 -Node: PART 1 USER INTERFACE3823 -Ref: #part-1-user-interface3962 -Node: Input3962 -Ref: #input4072 -Node: Data formats5021 -Ref: #data-formats5134 -Node: Standard input6496 -Ref: #standard-input6636 -Node: Multiple files6863 -Ref: #multiple-files7002 -Node: Strict mode7600 -Ref: #strict-mode7710 -Node: Commands8434 -Ref: #commands8536 -Node: Add-on commands9603 -Ref: #add-on-commands9705 -Node: Options10821 -Ref: #options10933 -Node: General help options11261 -Ref: #general-help-options11407 -Node: General input options11689 -Ref: #general-input-options11871 -Node: General reporting options12573 -Ref: #general-reporting-options12734 -Node: Command line tips16124 -Ref: #command-line-tips16254 -Node: Option repetition16513 -Ref: #option-repetition16657 -Node: Special characters16761 -Ref: #special-characters16934 -Node: Single escaping shell metacharacters17097 -Ref: #single-escaping-shell-metacharacters17338 -Node: Double escaping regular expression metacharacters17941 -Ref: #double-escaping-regular-expression-metacharacters18252 -Node: Triple escaping for add-on commands18778 -Ref: #triple-escaping-for-add-on-commands19038 -Node: Less escaping19682 -Ref: #less-escaping19836 -Node: Unicode characters20160 -Ref: #unicode-characters20335 -Node: Regular expressions21747 -Ref: #regular-expressions21920 -Node: hledger's regular expressions25016 -Ref: #hledgers-regular-expressions25175 -Node: Argument files26561 -Ref: #argument-files26697 -Node: Output27194 -Ref: #output27306 -Node: Output destination27433 -Ref: #output-destination27564 -Node: Output format27989 -Ref: #output-format28135 -Node: CSV output29732 -Ref: #csv-output29848 -Node: HTML output29951 -Ref: #html-output30089 -Node: JSON output30183 -Ref: #json-output30321 -Node: SQL output31243 -Ref: #sql-output31359 -Node: Commodity styles32094 -Ref: #commodity-styles32234 -Node: Colour32833 -Ref: #colour32951 -Node: Box-drawing33355 -Ref: #box-drawing33473 -Node: Paging33763 -Ref: #paging33877 -Node: Debug output34830 -Ref: #debug-output34936 -Node: Environment35599 -Ref: #environment35723 -Node: PART 2 DATA FORMATS36267 -Ref: #part-2-data-formats36410 -Node: Journal36410 -Ref: #journal36519 -Node: Journal cheatsheet37176 -Ref: #journal-cheatsheet37315 -Node: About journal format41300 -Ref: #about-journal-format41460 -Node: Comments43076 -Ref: #comments43206 -Node: Transactions44022 -Ref: #transactions44145 -Node: Dates45159 -Ref: #dates45266 -Node: Simple dates45311 -Ref: #simple-dates45427 -Node: Posting dates45927 -Ref: #posting-dates46045 -Node: Status47014 -Ref: #status47115 -Node: Code48823 -Ref: #code48926 -Node: Description49158 -Ref: #description49289 -Node: Payee and note49609 -Ref: #payee-and-note49715 -Node: Transaction comments50050 -Ref: #transaction-comments50203 -Node: Postings50566 -Ref: #postings50699 -Node: Account names51694 -Ref: #account-names51824 -Node: Amounts53498 -Ref: #amounts53613 -Node: Decimal marks digit group marks54598 -Ref: #decimal-marks-digit-group-marks54773 -Node: Commodity55632 -Ref: #commodity55819 -Node: Directives influencing number parsing and display56771 -Ref: #directives-influencing-number-parsing-and-display57030 -Node: Commodity display style57482 -Ref: #commodity-display-style57688 -Node: Rounding59098 -Ref: #rounding59216 -Node: Costs59666 -Ref: #costs59782 -Node: Other cost/lot notations61978 -Ref: #other-costlot-notations62110 -Node: Balance assertions64699 -Ref: #balance-assertions64850 -Node: Assertions and ordering65932 -Ref: #assertions-and-ordering66121 -Node: Assertions and multiple included files66821 -Ref: #assertions-and-multiple-included-files67081 -Node: Assertions and multiple -f files67581 -Ref: #assertions-and-multiple--f-files67832 -Node: Assertions and commodities68229 -Ref: #assertions-and-commodities68450 -Node: Assertions and costs69630 -Ref: #assertions-and-costs69833 -Node: Assertions and subaccounts70274 -Ref: #assertions-and-subaccounts70494 -Node: Assertions and virtual postings70818 -Ref: #assertions-and-virtual-postings71056 -Node: Assertions and auto postings71188 -Ref: #assertions-and-auto-postings71418 -Node: Assertions and precision72063 -Ref: #assertions-and-precision72245 -Node: Posting comments72512 -Ref: #posting-comments72658 -Node: Tags73035 -Ref: #tags73149 -Node: Tag values74342 -Ref: #tag-values74431 -Node: Directives75190 -Ref: #directives75317 -Node: Directives and multiple files76647 -Ref: #directives-and-multiple-files76825 -Node: Directive effects77592 -Ref: #directive-effects77746 -Node: account directive80759 -Ref: #account-directive80915 -Node: Account comments82313 -Ref: #account-comments82463 -Node: Account subdirectives82971 -Ref: #account-subdirectives83162 -Node: Account error checking83304 -Ref: #account-error-checking83502 -Node: Account display order84691 -Ref: #account-display-order84879 -Node: Account types85980 -Ref: #account-types86121 -Node: alias directive89748 -Ref: #alias-directive89909 -Node: Basic aliases90959 -Ref: #basic-aliases91090 -Node: Regex aliases91834 -Ref: #regex-aliases91991 -Node: Combining aliases92881 -Ref: #combining-aliases93059 -Node: Aliases and multiple files94335 -Ref: #aliases-and-multiple-files94539 -Node: end aliases directive95118 -Ref: #end-aliases-directive95337 -Node: Aliases can generate bad account names95486 -Ref: #aliases-can-generate-bad-account-names95734 -Node: Aliases and account types96319 -Ref: #aliases-and-account-types96511 -Node: commodity directive97207 -Ref: #commodity-directive97381 -Node: Commodity directive syntax98566 -Ref: #commodity-directive-syntax98751 -Node: Commodity error checking100202 -Ref: #commodity-error-checking100383 -Node: decimal-mark directive100677 -Ref: #decimal-mark-directive100859 -Node: include directive101256 -Ref: #include-directive101420 -Node: P directive102332 -Ref: #p-directive102477 -Node: payee directive103366 -Ref: #payee-directive103515 -Node: tag directive103988 -Ref: #tag-directive104143 -Node: Periodic transactions104611 -Ref: #periodic-transactions104776 -Node: Periodic rule syntax106482 -Ref: #periodic-rule-syntax106660 -Node: Periodic rules and relative dates107305 -Ref: #periodic-rules-and-relative-dates107571 -Node: Two spaces between period expression and description!108082 -Ref: #two-spaces-between-period-expression-and-description108359 -Node: Auto postings109043 -Ref: #auto-postings109191 -Node: Auto postings and multiple files111628 -Ref: #auto-postings-and-multiple-files111792 -Node: Auto postings and dates112193 -Ref: #auto-postings-and-dates112441 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions112616 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions112972 -Node: Auto posting tags113475 -Ref: #auto-posting-tags113757 -Node: Auto postings on forecast transactions only114393 -Ref: #auto-postings-on-forecast-transactions-only114639 -Node: Other syntax114886 -Ref: #other-syntax115002 -Node: Balance assignments115629 -Ref: #balance-assignments115785 -Node: Balance assignments and prices117158 -Ref: #balance-assignments-and-prices117373 -Node: Balance assignments and multiple files117584 -Ref: #balance-assignments-and-multiple-files117815 -Node: Bracketed posting dates118008 -Ref: #bracketed-posting-dates118192 -Node: D directive118706 -Ref: #d-directive118874 -Node: apply account directive120474 -Ref: #apply-account-directive120654 -Node: Y directive121341 -Ref: #y-directive121501 -Node: Secondary dates122329 -Ref: #secondary-dates122483 -Node: Star comments123297 -Ref: #star-comments123457 -Node: Valuation expressions123989 -Ref: #valuation-expressions124166 -Node: Virtual postings124288 -Ref: #virtual-postings124465 -Node: Other Ledger directives125902 -Ref: #other-ledger-directives126065 -Node: CSV126631 -Ref: #csv126724 -Node: CSV rules cheatsheet128804 -Ref: #csv-rules-cheatsheet128933 -Node: source130731 -Ref: #source130854 -Node: separator131734 -Ref: #separator131847 -Node: skip132387 -Ref: #skip132495 -Node: date-format133039 -Ref: #date-format133160 -Node: timezone133884 -Ref: #timezone134007 -Node: newest-first135012 -Ref: #newest-first135150 -Node: intra-day-reversed135727 -Ref: #intra-day-reversed135881 -Node: decimal-mark136329 -Ref: #decimal-mark136470 -Node: fields list136809 -Ref: #fields-list136948 -Node: Field assignment138619 -Ref: #field-assignment138763 -Node: Field names139840 -Ref: #field-names139971 -Node: date field141174 -Ref: #date-field141292 -Node: date2 field141340 -Ref: #date2-field141481 -Node: status field141537 -Ref: #status-field141680 -Node: code field141729 -Ref: #code-field141874 -Node: description field141919 -Ref: #description-field142079 -Node: comment field142138 -Ref: #comment-field142293 -Node: account field142586 -Ref: #account-field142736 -Node: amount field143306 -Ref: #amount-field143455 -Node: currency field146147 -Ref: #currency-field146300 -Node: balance field146557 -Ref: #balance-field146689 -Node: if block147061 -Ref: #if-block147182 -Node: Matchers148590 -Ref: #matchers148704 -Node: What matchers match149501 -Ref: #what-matchers-match149650 -Node: Combining matchers150090 -Ref: #combining-matchers150258 -Node: Match groups150744 -Ref: #match-groups150872 -Node: if table151619 -Ref: #if-table151741 -Node: balance-type153303 -Ref: #balance-type153432 -Node: include154132 -Ref: #include154259 -Node: Working with CSV154703 -Ref: #working-with-csv154850 -Node: Rapid feedback155257 -Ref: #rapid-feedback155390 -Node: Valid CSV155842 -Ref: #valid-csv155988 -Node: File Extension156720 -Ref: #file-extension156893 -Node: Reading CSV from standard input157457 -Ref: #reading-csv-from-standard-input157681 -Node: Reading multiple CSV files157845 -Ref: #reading-multiple-csv-files158076 -Node: Reading files specified by rule158317 -Ref: #reading-files-specified-by-rule158545 -Node: Valid transactions159716 -Ref: #valid-transactions159915 -Node: Deduplicating importing160543 -Ref: #deduplicating-importing160738 -Node: Setting amounts161774 -Ref: #setting-amounts161945 -Node: Amount signs164303 -Ref: #amount-signs164473 -Node: Setting currency/commodity165370 -Ref: #setting-currencycommodity165574 -Node: Amount decimal places166748 -Ref: #amount-decimal-places166954 -Node: Referencing other fields167266 -Ref: #referencing-other-fields167479 -Node: How CSV rules are evaluated168376 -Ref: #how-csv-rules-are-evaluated168593 -Node: Well factored rules170046 -Ref: #well-factored-rules170214 -Node: CSV rules examples170538 -Ref: #csv-rules-examples170673 -Node: Bank of Ireland170738 -Ref: #bank-of-ireland170875 -Node: Coinbase172337 -Ref: #coinbase172475 -Node: Amazon173522 -Ref: #amazon173647 -Node: Paypal175366 -Ref: #paypal175474 -Node: Timeclock183118 -Ref: #timeclock183223 -Node: Timedot185401 -Ref: #timedot185524 -Node: Timedot examples188629 -Ref: #timedot-examples188735 -Node: PART 3 REPORTING CONCEPTS190906 -Ref: #part-3-reporting-concepts191088 -Node: Amount formatting parseability191088 -Ref: #amount-formatting-parseability191285 -Node: Time periods193490 -Ref: #time-periods193629 -Node: Report start & end date193747 -Ref: #report-start-end-date193899 -Node: Smart dates195558 -Ref: #smart-dates195711 -Node: Report intervals197579 -Ref: #report-intervals197734 -Node: Date adjustment198152 -Ref: #date-adjustment198312 -Node: Period expressions199163 -Ref: #period-expressions199304 -Node: Period expressions with a report interval201068 -Ref: #period-expressions-with-a-report-interval201302 -Node: More complex report intervals201516 -Ref: #more-complex-report-intervals201761 -Node: Multiple weekday intervals203562 -Ref: #multiple-weekday-intervals203751 -Node: Depth204573 -Ref: #depth204675 -Node: Queries204971 -Ref: #queries205073 -Node: Query types206198 -Ref: #query-types206319 -Node: Combining query terms209655 -Ref: #combining-query-terms209832 -Node: Queries and command options211100 -Ref: #queries-and-command-options211299 -Node: Queries and valuation211548 -Ref: #queries-and-valuation211743 -Node: Querying with account aliases211972 -Ref: #querying-with-account-aliases212183 -Node: Querying with cost or value212313 -Ref: #querying-with-cost-or-value212490 -Node: Pivoting212791 -Ref: #pivoting212905 -Node: Generating data214682 -Ref: #generating-data214814 -Node: Forecasting216397 -Ref: #forecasting216522 -Node: --forecast217053 -Ref: #forecast217184 -Node: Inspecting forecast transactions218230 -Ref: #inspecting-forecast-transactions218432 -Node: Forecast reports219562 -Ref: #forecast-reports219735 -Node: Forecast tags220671 -Ref: #forecast-tags220831 -Node: Forecast period in detail221291 -Ref: #forecast-period-in-detail221485 -Node: Forecast troubleshooting222379 -Ref: #forecast-troubleshooting222547 -Node: Budgeting223450 -Ref: #budgeting223570 -Node: Cost reporting224007 -Ref: #cost-reporting224141 -Node: Recording costs224802 -Ref: #recording-costs224938 -Node: Reporting at cost226529 -Ref: #reporting-at-cost226704 -Node: Equity conversion postings227294 -Ref: #equity-conversion-postings227508 -Node: Inferring equity conversion postings229939 -Ref: #inferring-equity-conversion-postings230202 -Node: Combining costs and equity conversion postings230954 -Ref: #combining-costs-and-equity-conversion-postings231264 -Node: Requirements for detecting equity conversion postings232252 -Ref: #requirements-for-detecting-equity-conversion-postings232574 -Node: Infer cost and equity by default ?233774 -Ref: #infer-cost-and-equity-by-default234003 -Node: Value reporting234211 -Ref: #value-reporting234353 -Node: -V Value235127 -Ref: #v-value235259 -Node: -X Value in specified commodity235454 -Ref: #x-value-in-specified-commodity235655 -Node: Valuation date235804 -Ref: #valuation-date235981 -Node: Finding market price236764 -Ref: #finding-market-price236975 -Node: --infer-market-prices market prices from transactions238144 -Ref: #infer-market-prices-market-prices-from-transactions238426 -Node: Valuation commodity241188 -Ref: #valuation-commodity241407 -Node: Simple valuation examples242620 -Ref: #simple-valuation-examples242824 -Node: --value Flexible valuation243483 -Ref: #value-flexible-valuation243693 -Node: More valuation examples245337 -Ref: #more-valuation-examples245552 -Node: Interaction of valuation and queries246822 -Ref: #interaction-of-valuation-and-queries247069 -Node: Effect of valuation on reports247541 -Ref: #effect-of-valuation-on-reports247744 -Node: PART 4 COMMANDS255441 -Ref: #part-4-commands255590 -Node: Commands overview255969 -Ref: #commands-overview256103 -Node: DATA ENTRY256282 -Ref: #data-entry256406 -Node: DATA CREATION256605 -Ref: #data-creation256759 -Node: DATA MANAGEMENT256877 -Ref: #data-management257042 -Node: REPORTS FINANCIAL257163 -Ref: #reports-financial257338 -Node: REPORTS VERSATILE257643 -Ref: #reports-versatile257816 -Node: REPORTS BASIC258069 -Ref: #reports-basic258221 -Node: HELP258730 -Ref: #help258852 -Node: ADD-ONS258962 -Ref: #add-ons259068 -Node: accounts259647 -Ref: #accounts259780 -Node: activity261667 -Ref: #activity261786 -Node: add262160 -Ref: #add262270 -Node: aregister265081 -Ref: #aregister265202 -Node: aregister and posting dates268090 -Ref: #aregister-and-posting-dates268235 -Node: balance268991 -Ref: #balance269117 -Node: balance features270102 -Ref: #balance-features270242 -Node: Simple balance report272208 -Ref: #simple-balance-report272393 -Node: Balance report line format274018 -Ref: #balance-report-line-format274220 -Node: Filtered balance report276378 -Ref: #filtered-balance-report276570 -Node: List or tree mode276897 -Ref: #list-or-tree-mode277065 -Node: Depth limiting278410 -Ref: #depth-limiting278576 -Node: Dropping top-level accounts279177 -Ref: #dropping-top-level-accounts279377 -Node: Showing declared accounts279687 -Ref: #showing-declared-accounts279886 -Node: Sorting by amount280417 -Ref: #sorting-by-amount280584 -Node: Percentages281254 -Ref: #percentages281413 -Node: Multi-period balance report281961 -Ref: #multi-period-balance-report282161 -Node: Balance change end balance284436 -Ref: #balance-change-end-balance284645 -Node: Balance report types286073 -Ref: #balance-report-types286254 -Node: Calculation type286752 -Ref: #calculation-type286907 -Node: Accumulation type287456 -Ref: #accumulation-type287636 -Node: Valuation type288538 -Ref: #valuation-type288726 -Node: Combining balance report types289727 -Ref: #combining-balance-report-types289921 -Node: Budget report291759 -Ref: #budget-report291921 -Node: Using the budget report294064 -Ref: #using-the-budget-report294237 -Node: Budget date surprises296340 -Ref: #budget-date-surprises296540 -Node: Selecting budget goals297704 -Ref: #selecting-budget-goals297907 -Node: Budgeting vs forecasting298652 -Ref: #budgeting-vs-forecasting298829 -Node: Balance report layout300100 -Ref: #balance-report-layout300280 -Node: Useful balance reports308465 -Ref: #useful-balance-reports308625 -Node: balancesheet309710 -Ref: #balancesheet309855 -Node: balancesheetequity311182 -Ref: #balancesheetequity311340 -Node: cashflow312736 -Ref: #cashflow312867 -Node: check314302 -Ref: #check314416 -Node: Default checks315220 -Ref: #default-checks315346 -Node: Strict checks315843 -Ref: #strict-checks315988 -Node: Other checks316468 -Ref: #other-checks316610 -Node: Custom checks317143 -Ref: #custom-checks317300 -Node: More about specific checks317717 -Ref: #more-about-specific-checks317879 -Node: close318585 -Ref: #close318696 -Node: close and balance assertions322161 -Ref: #close-and-balance-assertions322339 -Node: Example retain earnings323490 -Ref: #example-retain-earnings323707 -Node: Example migrate balances to a new file324139 -Ref: #example-migrate-balances-to-a-new-file324404 -Node: Example excluding closing/opening transactions324980 -Ref: #example-excluding-closingopening-transactions325229 -Node: codes326447 -Ref: #codes326564 -Node: commodities327428 -Ref: #commodities327556 -Node: demo327626 -Ref: #demo327747 -Node: descriptions328663 -Ref: #descriptions328793 -Node: diff329084 -Ref: #diff329199 -Node: files330241 -Ref: #files330350 -Node: help330491 -Ref: #help-1330600 -Node: import331973 -Ref: #import332096 -Node: Deduplication333204 -Ref: #deduplication333329 -Node: Import testing335348 -Ref: #import-testing335513 -Node: Importing balance assignments336356 -Ref: #importing-balance-assignments336562 -Node: Commodity display styles337211 -Ref: #commodity-display-styles337384 -Node: incomestatement337513 -Ref: #incomestatement337655 -Node: notes338983 -Ref: #notes339105 -Node: payees339467 -Ref: #payees339582 -Node: prices340101 -Ref: #prices340216 -Node: print340869 -Ref: #print340984 -Node: print explicitness341960 -Ref: #print-explicitness342103 -Node: print amount style342882 -Ref: #print-amount-style343052 -Node: print parseability344104 -Ref: #print-parseability344276 -Node: print other features345025 -Ref: #print-other-features345204 -Node: print output format345725 -Ref: #print-output-format345873 -Node: register348992 -Ref: #register349114 -Node: Custom register output354145 -Ref: #custom-register-output354276 -Node: rewrite355620 -Ref: #rewrite355738 -Node: Re-write rules in a file357636 -Ref: #re-write-rules-in-a-file357799 -Node: Diff output format358948 -Ref: #diff-output-format359131 -Node: rewrite vs print --auto360223 -Ref: #rewrite-vs.-print---auto360383 -Node: roi360939 -Ref: #roi361046 -Node: Spaces and special characters in --inv and --pnl362858 -Ref: #spaces-and-special-characters-in---inv-and---pnl363098 -Node: Semantics of --inv and --pnl363586 -Ref: #semantics-of---inv-and---pnl363825 -Node: IRR and TWR explained365675 -Ref: #irr-and-twr-explained365835 -Node: stats369088 -Ref: #stats369196 -Node: tags370583 -Ref: #tags-1370690 -Node: test371699 -Ref: #test371792 -Node: PART 5 COMMON TASKS372534 -Ref: #part-5-common-tasks372680 -Node: Getting help372978 -Ref: #getting-help373119 -Node: Constructing command lines373879 -Ref: #constructing-command-lines374080 -Node: Starting a journal file374737 -Ref: #starting-a-journal-file374939 -Node: Setting LEDGER_FILE376141 -Ref: #setting-ledger_file376333 -Node: Setting opening balances377290 -Ref: #setting-opening-balances377491 -Node: Recording transactions380632 -Ref: #recording-transactions380821 -Node: Reconciling381377 -Ref: #reconciling381529 -Node: Reporting383786 -Ref: #reporting383935 -Node: Migrating to a new file387920 -Ref: #migrating-to-a-new-file388077 -Node: BUGS388376 -Ref: #bugs388466 -Node: Troubleshooting389345 -Ref: #troubleshooting389445 +Node: Top208 +Node: PART 1 USER INTERFACE3821 +Ref: #part-1-user-interface3960 +Node: Input3960 +Ref: #input4070 +Node: Data formats5019 +Ref: #data-formats5132 +Node: Standard input6494 +Ref: #standard-input6634 +Node: Multiple files6861 +Ref: #multiple-files7000 +Node: Strict mode7598 +Ref: #strict-mode7708 +Node: Commands8432 +Ref: #commands8534 +Node: Add-on commands9601 +Ref: #add-on-commands9703 +Node: Options10819 +Ref: #options10931 +Node: General help options11259 +Ref: #general-help-options11405 +Node: General input options11687 +Ref: #general-input-options11869 +Node: General reporting options12571 +Ref: #general-reporting-options12732 +Node: Command line tips16122 +Ref: #command-line-tips16252 +Node: Option repetition16511 +Ref: #option-repetition16655 +Node: Special characters16759 +Ref: #special-characters16932 +Node: Single escaping shell metacharacters17095 +Ref: #single-escaping-shell-metacharacters17336 +Node: Double escaping regular expression metacharacters17939 +Ref: #double-escaping-regular-expression-metacharacters18250 +Node: Triple escaping for add-on commands18776 +Ref: #triple-escaping-for-add-on-commands19036 +Node: Less escaping19680 +Ref: #less-escaping19834 +Node: Unicode characters20158 +Ref: #unicode-characters20333 +Node: Regular expressions21745 +Ref: #regular-expressions21918 +Node: hledger's regular expressions25014 +Ref: #hledgers-regular-expressions25173 +Node: Argument files26559 +Ref: #argument-files26695 +Node: Output27192 +Ref: #output27304 +Node: Output destination27431 +Ref: #output-destination27562 +Node: Output format27987 +Ref: #output-format28133 +Node: CSV output29730 +Ref: #csv-output29846 +Node: HTML output29949 +Ref: #html-output30087 +Node: JSON output30181 +Ref: #json-output30319 +Node: SQL output31241 +Ref: #sql-output31357 +Node: Commodity styles32092 +Ref: #commodity-styles32232 +Node: Colour32831 +Ref: #colour32949 +Node: Box-drawing33353 +Ref: #box-drawing33471 +Node: Paging33761 +Ref: #paging33875 +Node: Debug output34828 +Ref: #debug-output34934 +Node: Environment35597 +Ref: #environment35721 +Node: PART 2 DATA FORMATS36265 +Ref: #part-2-data-formats36408 +Node: Journal36408 +Ref: #journal36517 +Node: Journal cheatsheet37174 +Ref: #journal-cheatsheet37313 +Node: About journal format41298 +Ref: #about-journal-format41458 +Node: Comments43074 +Ref: #comments43204 +Node: Transactions44020 +Ref: #transactions44143 +Node: Dates45157 +Ref: #dates45264 +Node: Simple dates45309 +Ref: #simple-dates45425 +Node: Posting dates45925 +Ref: #posting-dates46043 +Node: Status47012 +Ref: #status47113 +Node: Code48821 +Ref: #code48924 +Node: Description49156 +Ref: #description49287 +Node: Payee and note49607 +Ref: #payee-and-note49713 +Node: Transaction comments50048 +Ref: #transaction-comments50201 +Node: Postings50564 +Ref: #postings50697 +Node: Account names51692 +Ref: #account-names51822 +Node: Amounts53496 +Ref: #amounts53611 +Node: Decimal marks digit group marks54596 +Ref: #decimal-marks-digit-group-marks54771 +Node: Commodity55630 +Ref: #commodity55817 +Node: Directives influencing number parsing and display56769 +Ref: #directives-influencing-number-parsing-and-display57028 +Node: Commodity display style57480 +Ref: #commodity-display-style57686 +Node: Rounding59096 +Ref: #rounding59214 +Node: Costs59664 +Ref: #costs59780 +Node: Other cost/lot notations61976 +Ref: #other-costlot-notations62108 +Node: Balance assertions64697 +Ref: #balance-assertions64848 +Node: Assertions and ordering65930 +Ref: #assertions-and-ordering66119 +Node: Assertions and multiple included files66819 +Ref: #assertions-and-multiple-included-files67079 +Node: Assertions and multiple -f files67579 +Ref: #assertions-and-multiple--f-files67830 +Node: Assertions and commodities68227 +Ref: #assertions-and-commodities68448 +Node: Assertions and costs69628 +Ref: #assertions-and-costs69831 +Node: Assertions and subaccounts70272 +Ref: #assertions-and-subaccounts70492 +Node: Assertions and virtual postings70816 +Ref: #assertions-and-virtual-postings71054 +Node: Assertions and auto postings71186 +Ref: #assertions-and-auto-postings71416 +Node: Assertions and precision72061 +Ref: #assertions-and-precision72243 +Node: Posting comments72510 +Ref: #posting-comments72656 +Node: Tags73033 +Ref: #tags73147 +Node: Tag values74340 +Ref: #tag-values74429 +Node: Directives75188 +Ref: #directives75315 +Node: Directives and multiple files76645 +Ref: #directives-and-multiple-files76823 +Node: Directive effects77590 +Ref: #directive-effects77744 +Node: account directive80757 +Ref: #account-directive80913 +Node: Account comments82311 +Ref: #account-comments82461 +Node: Account subdirectives82969 +Ref: #account-subdirectives83160 +Node: Account error checking83302 +Ref: #account-error-checking83500 +Node: Account display order84689 +Ref: #account-display-order84877 +Node: Account types85978 +Ref: #account-types86119 +Node: alias directive89746 +Ref: #alias-directive89907 +Node: Basic aliases90957 +Ref: #basic-aliases91088 +Node: Regex aliases91832 +Ref: #regex-aliases91989 +Node: Combining aliases92879 +Ref: #combining-aliases93057 +Node: Aliases and multiple files94333 +Ref: #aliases-and-multiple-files94537 +Node: end aliases directive95116 +Ref: #end-aliases-directive95335 +Node: Aliases can generate bad account names95484 +Ref: #aliases-can-generate-bad-account-names95732 +Node: Aliases and account types96317 +Ref: #aliases-and-account-types96509 +Node: commodity directive97205 +Ref: #commodity-directive97379 +Node: Commodity directive syntax98564 +Ref: #commodity-directive-syntax98749 +Node: Commodity error checking100200 +Ref: #commodity-error-checking100381 +Node: decimal-mark directive100675 +Ref: #decimal-mark-directive100857 +Node: include directive101254 +Ref: #include-directive101418 +Node: P directive102330 +Ref: #p-directive102475 +Node: payee directive103364 +Ref: #payee-directive103513 +Node: tag directive103986 +Ref: #tag-directive104141 +Node: Periodic transactions104609 +Ref: #periodic-transactions104774 +Node: Periodic rule syntax106763 +Ref: #periodic-rule-syntax106941 +Node: Periodic rules and relative dates107586 +Ref: #periodic-rules-and-relative-dates107852 +Node: Two spaces between period expression and description!108363 +Ref: #two-spaces-between-period-expression-and-description108640 +Node: Auto postings109324 +Ref: #auto-postings109472 +Node: Auto postings and multiple files112302 +Ref: #auto-postings-and-multiple-files112466 +Node: Auto postings and dates112867 +Ref: #auto-postings-and-dates113115 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions113290 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions113646 +Node: Auto posting tags114149 +Ref: #auto-posting-tags114431 +Node: Auto postings on forecast transactions only115067 +Ref: #auto-postings-on-forecast-transactions-only115313 +Node: Other syntax115560 +Ref: #other-syntax115676 +Node: Balance assignments116303 +Ref: #balance-assignments116459 +Node: Balance assignments and costs117831 +Ref: #balance-assignments-and-costs118043 +Node: Balance assignments and multiple files118253 +Ref: #balance-assignments-and-multiple-files118483 +Node: Bracketed posting dates118676 +Ref: #bracketed-posting-dates118860 +Node: D directive119374 +Ref: #d-directive119542 +Node: apply account directive121142 +Ref: #apply-account-directive121322 +Node: Y directive122009 +Ref: #y-directive122169 +Node: Secondary dates122997 +Ref: #secondary-dates123151 +Node: Star comments123965 +Ref: #star-comments124125 +Node: Valuation expressions124657 +Ref: #valuation-expressions124834 +Node: Virtual postings124956 +Ref: #virtual-postings125133 +Node: Other Ledger directives126570 +Ref: #other-ledger-directives126733 +Node: CSV127299 +Ref: #csv127392 +Node: CSV rules cheatsheet129472 +Ref: #csv-rules-cheatsheet129601 +Node: source131399 +Ref: #source131522 +Node: separator132402 +Ref: #separator132515 +Node: skip133055 +Ref: #skip133163 +Node: date-format133707 +Ref: #date-format133828 +Node: timezone134552 +Ref: #timezone134675 +Node: newest-first135680 +Ref: #newest-first135818 +Node: intra-day-reversed136395 +Ref: #intra-day-reversed136549 +Node: decimal-mark136997 +Ref: #decimal-mark137138 +Node: fields list137477 +Ref: #fields-list137616 +Node: Field assignment139287 +Ref: #field-assignment139431 +Node: Field names140508 +Ref: #field-names140639 +Node: date field141842 +Ref: #date-field141960 +Node: date2 field142008 +Ref: #date2-field142149 +Node: status field142205 +Ref: #status-field142348 +Node: code field142397 +Ref: #code-field142542 +Node: description field142587 +Ref: #description-field142747 +Node: comment field142806 +Ref: #comment-field142961 +Node: account field143254 +Ref: #account-field143404 +Node: amount field143974 +Ref: #amount-field144123 +Node: currency field146815 +Ref: #currency-field146968 +Node: balance field147225 +Ref: #balance-field147357 +Node: if block147729 +Ref: #if-block147850 +Node: Matchers149258 +Ref: #matchers149372 +Node: What matchers match150169 +Ref: #what-matchers-match150318 +Node: Combining matchers150758 +Ref: #combining-matchers150926 +Node: Match groups151412 +Ref: #match-groups151540 +Node: if table152287 +Ref: #if-table152409 +Node: balance-type153971 +Ref: #balance-type154100 +Node: include154800 +Ref: #include154927 +Node: Working with CSV155371 +Ref: #working-with-csv155518 +Node: Rapid feedback155925 +Ref: #rapid-feedback156058 +Node: Valid CSV156510 +Ref: #valid-csv156656 +Node: File Extension157388 +Ref: #file-extension157561 +Node: Reading CSV from standard input158125 +Ref: #reading-csv-from-standard-input158349 +Node: Reading multiple CSV files158513 +Ref: #reading-multiple-csv-files158744 +Node: Reading files specified by rule158985 +Ref: #reading-files-specified-by-rule159213 +Node: Valid transactions160384 +Ref: #valid-transactions160583 +Node: Deduplicating importing161211 +Ref: #deduplicating-importing161406 +Node: Setting amounts162442 +Ref: #setting-amounts162613 +Node: Amount signs164971 +Ref: #amount-signs165141 +Node: Setting currency/commodity166038 +Ref: #setting-currencycommodity166242 +Node: Amount decimal places167416 +Ref: #amount-decimal-places167622 +Node: Referencing other fields167934 +Ref: #referencing-other-fields168147 +Node: How CSV rules are evaluated169044 +Ref: #how-csv-rules-are-evaluated169261 +Node: Well factored rules170714 +Ref: #well-factored-rules170882 +Node: CSV rules examples171206 +Ref: #csv-rules-examples171341 +Node: Bank of Ireland171406 +Ref: #bank-of-ireland171543 +Node: Coinbase173005 +Ref: #coinbase173143 +Node: Amazon174190 +Ref: #amazon174315 +Node: Paypal176034 +Ref: #paypal176142 +Node: Timeclock183786 +Ref: #timeclock183891 +Node: Timedot186069 +Ref: #timedot186192 +Node: Timedot examples189297 +Ref: #timedot-examples189403 +Node: PART 3 REPORTING CONCEPTS191574 +Ref: #part-3-reporting-concepts191756 +Node: Amount formatting parseability191756 +Ref: #amount-formatting-parseability191953 +Node: Time periods194158 +Ref: #time-periods194297 +Node: Report start & end date194415 +Ref: #report-start-end-date194567 +Node: Smart dates196226 +Ref: #smart-dates196379 +Node: Report intervals198247 +Ref: #report-intervals198402 +Node: Date adjustment198820 +Ref: #date-adjustment198980 +Node: Period expressions199831 +Ref: #period-expressions199972 +Node: Period expressions with a report interval201736 +Ref: #period-expressions-with-a-report-interval201970 +Node: More complex report intervals202184 +Ref: #more-complex-report-intervals202429 +Node: Multiple weekday intervals204230 +Ref: #multiple-weekday-intervals204419 +Node: Depth205241 +Ref: #depth205343 +Node: Queries205639 +Ref: #queries205741 +Node: Query types207371 +Ref: #query-types207492 +Node: Combining query terms210726 +Ref: #combining-query-terms210903 +Node: Queries and command options212171 +Ref: #queries-and-command-options212370 +Node: Queries and valuation212619 +Ref: #queries-and-valuation212814 +Node: Querying with account aliases213043 +Ref: #querying-with-account-aliases213254 +Node: Querying with cost or value213384 +Ref: #querying-with-cost-or-value213561 +Node: Pivoting213862 +Ref: #pivoting213976 +Node: Generating data215753 +Ref: #generating-data215885 +Node: Forecasting217468 +Ref: #forecasting217593 +Node: --forecast218124 +Ref: #forecast218255 +Node: Inspecting forecast transactions219225 +Ref: #inspecting-forecast-transactions219427 +Node: Forecast reports220557 +Ref: #forecast-reports220730 +Node: Forecast tags221666 +Ref: #forecast-tags221826 +Node: Forecast period in detail222286 +Ref: #forecast-period-in-detail222480 +Node: Forecast troubleshooting223374 +Ref: #forecast-troubleshooting223542 +Node: Budgeting224445 +Ref: #budgeting224565 +Node: Cost reporting225002 +Ref: #cost-reporting225136 +Node: Recording costs225797 +Ref: #recording-costs225933 +Node: Reporting at cost227524 +Ref: #reporting-at-cost227699 +Node: Equity conversion postings228289 +Ref: #equity-conversion-postings228503 +Node: Inferring equity conversion postings230934 +Ref: #inferring-equity-conversion-postings231197 +Node: Combining costs and equity conversion postings231949 +Ref: #combining-costs-and-equity-conversion-postings232259 +Node: Requirements for detecting equity conversion postings233174 +Ref: #requirements-for-detecting-equity-conversion-postings233496 +Node: Infer cost and equity by default ?234696 +Ref: #infer-cost-and-equity-by-default234925 +Node: Value reporting235133 +Ref: #value-reporting235275 +Node: -V Value236049 +Ref: #v-value236181 +Node: -X Value in specified commodity236376 +Ref: #x-value-in-specified-commodity236577 +Node: Valuation date236726 +Ref: #valuation-date236903 +Node: Finding market price237686 +Ref: #finding-market-price237897 +Node: --infer-market-prices market prices from transactions239066 +Ref: #infer-market-prices-market-prices-from-transactions239348 +Node: Valuation commodity242110 +Ref: #valuation-commodity242329 +Node: Simple valuation examples243542 +Ref: #simple-valuation-examples243746 +Node: --value Flexible valuation244405 +Ref: #value-flexible-valuation244615 +Node: More valuation examples246259 +Ref: #more-valuation-examples246474 +Node: Interaction of valuation and queries247744 +Ref: #interaction-of-valuation-and-queries247991 +Node: Effect of valuation on reports248463 +Ref: #effect-of-valuation-on-reports248666 +Node: PART 4 COMMANDS256363 +Ref: #part-4-commands256512 +Node: Commands overview256891 +Ref: #commands-overview257025 +Node: DATA ENTRY257204 +Ref: #data-entry257328 +Node: DATA CREATION257527 +Ref: #data-creation257681 +Node: DATA MANAGEMENT257799 +Ref: #data-management257964 +Node: REPORTS FINANCIAL258085 +Ref: #reports-financial258260 +Node: REPORTS VERSATILE258565 +Ref: #reports-versatile258738 +Node: REPORTS BASIC258991 +Ref: #reports-basic259143 +Node: HELP259652 +Ref: #help259774 +Node: ADD-ONS259884 +Ref: #add-ons259990 +Node: accounts260569 +Ref: #accounts260702 +Node: activity262589 +Ref: #activity262708 +Node: add263082 +Ref: #add263192 +Node: aregister266178 +Ref: #aregister266299 +Node: aregister and posting dates269187 +Ref: #aregister-and-posting-dates269332 +Node: balance270088 +Ref: #balance270214 +Node: balance features271199 +Ref: #balance-features271339 +Node: Simple balance report273305 +Ref: #simple-balance-report273490 +Node: Balance report line format275115 +Ref: #balance-report-line-format275317 +Node: Filtered balance report277475 +Ref: #filtered-balance-report277667 +Node: List or tree mode277994 +Ref: #list-or-tree-mode278162 +Node: Depth limiting279507 +Ref: #depth-limiting279673 +Node: Dropping top-level accounts280274 +Ref: #dropping-top-level-accounts280474 +Node: Showing declared accounts280784 +Ref: #showing-declared-accounts280983 +Node: Sorting by amount281514 +Ref: #sorting-by-amount281681 +Node: Percentages282351 +Ref: #percentages282510 +Node: Multi-period balance report283058 +Ref: #multi-period-balance-report283258 +Node: Balance change end balance285515 +Ref: #balance-change-end-balance285724 +Node: Balance report types287152 +Ref: #balance-report-types287333 +Node: Calculation type287831 +Ref: #calculation-type287986 +Node: Accumulation type288535 +Ref: #accumulation-type288715 +Node: Valuation type289617 +Ref: #valuation-type289805 +Node: Combining balance report types290806 +Ref: #combining-balance-report-types291000 +Node: Budget report292838 +Ref: #budget-report293000 +Node: Using the budget report295143 +Ref: #using-the-budget-report295316 +Node: Budget date surprises297419 +Ref: #budget-date-surprises297619 +Node: Selecting budget goals298783 +Ref: #selecting-budget-goals298986 +Node: Budgeting vs forecasting299731 +Ref: #budgeting-vs-forecasting299908 +Node: Balance report layout301179 +Ref: #balance-report-layout301359 +Node: Useful balance reports309544 +Ref: #useful-balance-reports309704 +Node: balancesheet310789 +Ref: #balancesheet310934 +Node: balancesheetequity312246 +Ref: #balancesheetequity312404 +Node: cashflow313800 +Ref: #cashflow313931 +Node: check315351 +Ref: #check315465 +Node: Default checks316269 +Ref: #default-checks316395 +Node: Strict checks316892 +Ref: #strict-checks317037 +Node: Other checks317517 +Ref: #other-checks317659 +Node: Custom checks318192 +Ref: #custom-checks318349 +Node: More about specific checks318766 +Ref: #more-about-specific-checks318928 +Node: close319634 +Ref: #close319745 +Node: close and balance assertions325072 +Ref: #close-and-balance-assertions325250 +Node: Example retain earnings326401 +Ref: #example-retain-earnings326618 +Node: Example migrate balances to a new file327050 +Ref: #example-migrate-balances-to-a-new-file327315 +Node: Example excluding closing/opening transactions327891 +Ref: #example-excluding-closingopening-transactions328140 +Node: codes329358 +Ref: #codes329475 +Node: commodities330339 +Ref: #commodities330467 +Node: demo330537 +Ref: #demo330658 +Node: descriptions331574 +Ref: #descriptions331704 +Node: diff331995 +Ref: #diff332110 +Node: files333152 +Ref: #files333261 +Node: help333402 +Ref: #help-1333511 +Node: import334884 +Ref: #import335007 +Node: Deduplication336115 +Ref: #deduplication336240 +Node: Import testing338259 +Ref: #import-testing338424 +Node: Importing balance assignments339267 +Ref: #importing-balance-assignments339473 +Node: Commodity display styles340122 +Ref: #commodity-display-styles340295 +Node: incomestatement340424 +Ref: #incomestatement340566 +Node: notes341879 +Ref: #notes342001 +Node: payees342363 +Ref: #payees342478 +Node: prices342997 +Ref: #prices343112 +Node: print343765 +Ref: #print343880 +Node: print explicitness344856 +Ref: #print-explicitness344999 +Node: print amount style345778 +Ref: #print-amount-style345948 +Node: print parseability347000 +Ref: #print-parseability347172 +Node: print other features347921 +Ref: #print-other-features348100 +Node: print output format348621 +Ref: #print-output-format348769 +Node: register351872 +Ref: #register351994 +Node: Custom register output357025 +Ref: #custom-register-output357156 +Node: rewrite358485 +Ref: #rewrite358603 +Node: Re-write rules in a file360501 +Ref: #re-write-rules-in-a-file360664 +Node: Diff output format361813 +Ref: #diff-output-format361996 +Node: rewrite vs print --auto363088 +Ref: #rewrite-vs.-print---auto363248 +Node: roi363804 +Ref: #roi363911 +Node: Spaces and special characters in --inv and --pnl365723 +Ref: #spaces-and-special-characters-in---inv-and---pnl365963 +Node: Semantics of --inv and --pnl366451 +Ref: #semantics-of---inv-and---pnl366690 +Node: IRR and TWR explained368540 +Ref: #irr-and-twr-explained368700 +Node: stats371953 +Ref: #stats372061 +Node: tags373448 +Ref: #tags-1373555 +Node: test374564 +Ref: #test374657 +Node: PART 5 COMMON TASKS375399 +Ref: #part-5-common-tasks375545 +Node: Getting help375843 +Ref: #getting-help375984 +Node: Constructing command lines376744 +Ref: #constructing-command-lines376945 +Node: Starting a journal file377602 +Ref: #starting-a-journal-file377804 +Node: Setting LEDGER_FILE379006 +Ref: #setting-ledger_file379198 +Node: Setting opening balances380155 +Ref: #setting-opening-balances380356 +Node: Recording transactions383497 +Ref: #recording-transactions383686 +Node: Reconciling384242 +Ref: #reconciling384394 +Node: Reporting386651 +Ref: #reporting386800 +Node: Migrating to a new file390785 +Ref: #migrating-to-a-new-file390942 +Node: BUGS391241 +Ref: #bugs391331 +Node: Troubleshooting392210 +Ref: #troubleshooting392310  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 883036fd3..b679a386b 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -213,13 +213,13 @@ Commands hledger ADDONCMD [-- ADDONCMDOPTS] [ADDONCMDARGS]. But note the double hyphen argument, required before add-on-specific options. Eg: hledger ui -- --watch or hledger web -- --serve. If this causes difficulty, - you can always run the add-on directly, without using hledger: hledger- - ui --watch or hledger-web --serve. + you can always run the add-on directly, without using hledger: + hledger-ui --watch or hledger-web --serve. Options - Run hledger -h to see general command line help, and general options - which are common to most hledger commands. These options can be writ- - ten anywhere on the command line. They can be grouped into help, in- + Run hledger -h to see general command line help, and general options + which are common to most hledger commands. These options can be writ- + ten anywhere on the command line. They can be grouped into help, in- put, and reporting options: General help options @@ -242,7 +242,7 @@ Options $LEDGER_FILE or $HOME/.hledger.journal) --rules-file=RULESFILE - Conversion rules file to use when reading CSV (default: + Conversion rules file to use when reading CSV (default: FILE.rules) --separator=CHAR @@ -261,7 +261,7 @@ Options assignments) -s --strict - do extra error checking (check that all posted accounts are de- + do extra error checking (check that all posted accounts are de- clared) General reporting options @@ -289,7 +289,7 @@ Options multiperiod/multicolumn report by year -p --period=PERIODEXP - set start date, end date, and/or reporting interval all at once + set start date, end date, and/or reporting interval all at once using period expressions syntax --date2 @@ -297,7 +297,7 @@ Options fects) --today=DATE - override today's date (affects relative smart dates, for + override today's date (affects relative smart dates, for tests/examples) -U --unmarked @@ -316,21 +316,21 @@ Options hide/aggregate accounts or postings more than NUM levels deep -E --empty - show items with zero amount, normally hidden (and vice-versa in + show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) -B --cost convert amounts to their cost/selling amount at transaction time -V --market - convert amounts to their market value in default valuation com- + convert amounts to their market value in default valuation com- modities -X --exchange=COMM convert amounts to their market value in commodity COMM --value - convert amounts to cost or market value, more flexibly than + convert amounts to cost or market value, more flexibly than -B/-V/-X --infer-equity @@ -340,32 +340,32 @@ Options infer costs from conversion equity postings --infer-market-prices - use costs as additional market prices, as if they were P direc- + use costs as additional market prices, as if they were P direc- tives --forecast - generate transactions from periodic rules, between the latest - recorded txn and 6 months from today, or during the specified - PERIOD (= is required). Auto posting rules will be applied to - these transactions as well. Also, in hledger-ui make future- - dated transactions visible. + generate transactions from periodic rules, between the latest + recorded txn and 6 months from today, or during the specified + PERIOD (= is required). Auto posting rules will be applied to + these transactions as well. Also, in hledger-ui make fu- + ture-dated transactions visible. - --auto generate extra postings by applying auto posting rules to all + --auto generate extra postings by applying auto posting rules to all txns (not just forecast txns) --verbose-tags - add visible tags indicating transactions or postings which have + add visible tags indicating transactions or postings which have been generated/modified --commodity-style - Override the commodity style in the output for the specified + Override the commodity style in the output for the specified commodity. For example 'EUR1.000,00'. --color=WHEN (or --colour=WHEN) - Should color-supporting commands use ANSI color codes in text - output. 'auto' (default): whenever stdout seems to be a color- - supporting terminal. 'always' or 'yes': always, useful eg when - piping output into 'less -R'. 'never' or 'no': never. A + Should color-supporting commands use ANSI color codes in text + output. 'auto' (default): whenever stdout seems to be a + color-supporting terminal. 'always' or 'yes': always, useful eg + when piping output into 'less -R'. 'never' or 'no': never. A NO_COLOR environment variable overrides this. --pretty[=WHEN] @@ -465,8 +465,8 @@ Command line tips line, by all hledger tools (add, iadd, hledger-web's search/add/edit forms, etc.) - o they should be displayed correctly by all hledger tools, and on- - screen alignment should be preserved. + o they should be displayed correctly by all hledger tools, and + on-screen alignment should be preserved. This requires a well-configured environment. Here are some tips: @@ -669,8 +669,8 @@ Output o Our JSON is rather large and verbose, since it is a faithful repre- sentation of hledger's internal data types. To understand the JSON, read the Haskell type definitions, which are mostly in - https://github.com/simonmichael/hledger/blob/master/hledger- - lib/Hledger/Data/Types.hs. + https://github.com/simonmichael/hledger/blob/mas- + ter/hledger-lib/Hledger/Data/Types.hs. o hledger represents quantities as Decimal values storing up to 255 significant digits, eg for repeating decimals. Such numbers can @@ -1442,45 +1442,45 @@ Journal Ledger assertions do not see the accumulated effect of repeated post- ings to the same account within a transaction.) - So, hledger balance assertions keep working if you reorder differently- - dated transactions within the journal. But if you reorder same-dated - transactions or postings, assertions might break and require updating. - 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. + So, hledger balance assertions keep working if you reorder differ- + ently-dated transactions within the journal. But if you reorder + same-dated transactions or postings, assertions might break and require + updating. This order dependence does bring an advantage: precise con- + trol over the order of postings and assertions within a day, so you can + assert intra-day balances. Assertions and multiple included files - Multiple files included with the include directive are processed as if - concatenated into one file, preserving their order and the posting or- - der within each file. It means that balance assertions in later files + Multiple files included with the include directive are processed as if + concatenated into one file, preserving their order and the posting or- + der within each file. It means that balance assertions in later files will see balance from earlier files. - And if you have multiple postings to an account on the same day, split - across multiple files, and you want to assert the account's balance on + And if you have multiple postings to an account on the same day, split + across multiple files, and you want to assert the account's balance on that day, you'll need to put the assertion in the right file - the last one in the sequence, probably. Assertions and multiple -f files - Unlike include, when multiple files are specified on the command line - with multiple -f/--file options, balance assertions will not see bal- + Unlike include, when multiple files are specified on the command line + with multiple -f/--file options, balance assertions will not see bal- ance from earlier files. This can be useful when you do not want prob- lems in earlier files to disrupt valid assertions in later files. - If you do want assertions to see balance from earlier files, use in- + If you do want assertions to see balance from earlier files, use in- clude, or concatenate the files temporarily. Assertions and commodities - The asserted balance must be a simple single-commodity amount, and in - fact the assertion checks only this commodity's balance within the - (possibly multi-commodity) account balance. This is how assertions + The asserted balance must be a simple single-commodity amount, and in + fact the assertion checks only this commodity's balance within the + (possibly multi-commodity) account balance. This is how assertions work in Ledger also. We could call this a "partial" balance assertion. To assert the balance of more than one commodity in an account, you can write multiple postings, each asserting one commodity's balance. - You can make a stronger "total" balance assertion by writing a double + You can make a stronger "total" balance assertion by writing a double equals sign (== EXPECTEDBALANCE). This asserts that there are no other - commodities in the account besides the asserted one (or at least, that + commodities in the account besides the asserted one (or at least, that their balance is 0). 2013/1/1 @@ -1499,7 +1499,7 @@ Journal a 0 == $1 It's not yet possible to make a complete assertion about a balance that - has multiple commodities. One workaround is to isolate each commodity + has multiple commodities. One workaround is to isolate each commodity into its own subaccount: 2013/1/1 @@ -1519,15 +1519,15 @@ Journal 2019/1/1 (a) $1 @ 1 = $1 - We do allow costs to be written in balance assertion amounts, however, - and print shows them, but they don't affect whether the assertion - passes or fails. This is for backward compatibility (hledger's close - command used to generate balance assertions with costs), and because + We do allow costs to be written in balance assertion amounts, however, + and print shows them, but they don't affect whether the assertion + passes or fails. This is for backward compatibility (hledger's close + command used to generate balance assertions with costs), and because balance assignments do use costs (see below). Assertions and subaccounts - The balance assertions above (= and ==) do not count the balance from - subaccounts; they check the account's exclusive balance only. You can + The balance assertions above (= and ==) do not count the balance from + subaccounts; they check the account's exclusive balance only. You can assert the balance including subaccounts by writing =* or ==*, eg: 2019/1/1 @@ -1541,10 +1541,10 @@ Journal are not affected by the --real/-R flag or real: query. Assertions and auto postings - Balance assertions are affected by the --auto flag, which generates + Balance assertions are affected by the --auto flag, which generates auto postings, which can alter account balances. Because auto postings are optional in hledger, accounts affected by them effectively have two - balances. But balance assertions can only test one or the other of + balances. But balance assertions can only test one or the other of these. So to avoid making fragile assertions, either: o assert the balance calculated with --auto, and always use --auto with @@ -1557,15 +1557,15 @@ Journal avoid auto postings entirely). Assertions and precision - Balance assertions compare the exactly calculated amounts, which are - not always what is shown by reports. Eg a commodity directive may - limit the display precision, but this will not affect balance asser- + Balance assertions compare the exactly calculated amounts, which are + not always what is shown by reports. Eg a commodity directive may + limit the display precision, but this will not affect balance asser- tions. Balance assertion failure messages show exact amounts. Posting comments - Text following ;, at the end of a posting line, and/or on indented - lines immediately below it, form comments for that posting. They are - reproduced by print but otherwise ignored, except they may contain + Text following ;, at the end of a posting line, and/or on indented + lines immediately below it, form comments for that posting. They are + reproduced by print but otherwise ignored, except they may contain tags, which are not ignored. 2012-01-01 @@ -1575,14 +1575,14 @@ Journal ; a second comment line for posting 2 Tags - Tags are a way to add extra labels or labelled data to transactions, + Tags are a way to add extra labels or labelled data to transactions, postings, or accounts, which you can then search or pivot on. They are written as a word (optionally hyphenated) immediately followed - by a full colon, in a transaction or posting or account directive's - comment. (This is an exception to the usual rule that things in com- - ments are ignored.) Eg, here four different tags are recorded: one on - the checking account, two on the transaction, and one on the expenses + by a full colon, in a transaction or posting or account directive's + comment. (This is an exception to the usual rule that things in com- + ments are ignored.) Eg, here four different tags are recorded: one on + the checking account, two on the transaction, and one on the expenses posting: account assets:checking ; accounttag: @@ -1592,40 +1592,40 @@ Journal assets:checking $-1 expenses:food $1 ; postingtag: - Postings also inherit tags from their transaction and their account. - And transactions also acquire tags from their postings (and postings' - accounts). So in the example above, the expenses posting effectively + Postings also inherit tags from their transaction and their account. + And transactions also acquire tags from their postings (and postings' + accounts). 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 + transaction also has all four tags (by acquiring from the expenses posting). - You can list tag names with hledger tags [NAMEREGEX], or match by tag + You can list tag names with hledger tags [NAMEREGEX], or match by tag name with a tag:NAMEREGEX query. Tag values - 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 fol- + 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 fol- lowing posting, the three tags' values are "value 1", "value 2", and "" (empty) respectively: expenses:food $10 ; foo, tag1: value 1 , tag2:value 2, bar tag3: , baz - Note that tags can be repeated, and are additive rather than overrid- - ing: when the same tag name is seen again with a new value, the new - name:value pair is added to the tags. (It is not possible to override + Note that tags can be repeated, and are additive rather than overrid- + ing: when the same tag name is seen again with a new value, the new + name:value pair is added to the tags. (It is not possible to override a tag's value or remove a tag.) - You can list a tag's values with hledger tags TAGNAME --values, or + You can list a tag's values with hledger tags TAGNAME --values, or match by tag value with a tag:NAMEREGEX=VALUEREGEX query. Directives - Besides transactions, there is something else you can put in a journal - file: directives. These are declarations, beginning with a keyword, - that modify hledger's behaviour. Some directives can have more spe- - cific subdirectives, indented below them. hledger's directives are + Besides transactions, there is something else you can put in a journal + file: directives. These are declarations, beginning with a keyword, + that modify hledger's behaviour. Some directives can have more spe- + cific subdirectives, indented below them. hledger's directives are similar to Ledger's in many cases, but there are also many differences. - Directives are not required, but can be useful. Here are the main di- + Directives are not required, but can be useful. Here are the main di- rectives: purpose directive @@ -1633,16 +1633,16 @@ Journal READING DATA: Rewrite account names alias Comment out sections of the file comment - Declare file's decimal mark, to help decimal-mark + Declare file's decimal mark, to help decimal-mark parse amounts accurately Include other data files include GENERATING DATA: - Generate recurring transactions or bud- ~ + Generate recurring transactions or bud- ~ get goals - Generate extra postings on existing = + Generate extra postings on existing = transactions CHECKING FOR ERRORS: - Define valid entities to provide more account, commodity, payee, tag + Define valid entities to provide more account, commodity, payee, tag error checking REPORTING: Declare accounts' type and display order account @@ -1650,24 +1650,24 @@ Journal Declare market prices P Directives and multiple files - Directives vary in their scope, ie which journal entries and which in- + Directives vary in their scope, ie which journal entries and which in- put files they affect. Most often, a directive will affect the follow- - ing entries and included files if any, until the end of the current + ing entries and included files if any, until the end of the current file - and no further. You might find this inconvenient! For example, - alias directives do not affect parent or sibling files. But there are + alias directives do not affect parent or sibling files. But there are usually workarounds; for example, put alias directives in your top-most file, before including other files. - The restriction, though it may be annoying at first, is in a good + The restriction, though it may be annoying at first, is in a good cause; it allows reports to be stable and deterministic, independent of - the order of input. Without it, reports could show different numbers - depending on the order of -f options, or the positions of include di- + the order of input. Without it, reports could show different numbers + depending on the order of -f options, or the positions of include di- rectives in your files. Directive effects - Here are all hledger's directives, with their effects and scope sum- - marised - nine main directives, plus four others which we consider non- - essential: + Here are all hledger's directives, with their effects and scope sum- + marised - nine main directives, plus four others which we consider + non-essential: di- what it does ends rec- at @@ -1690,11 +1690,11 @@ Journal (Ledger-compatible syntax). Command line equivalent: -c/--com- modity-style deci- Declares the decimal mark, for parsing amounts of all commodi- Y - mal- ties in following entries until next decimal-mark or end of cur- - mark rent file. Included files can override. Takes precedence over + mal-mark ties in following entries until next decimal-mark or end of cur- + rent file. Included files can override. Takes precedence over commodity and D. - in- Includes entries and directives from another file, as if they N - clude were written inline. Command line alternative: multiple + include Includes entries and directives from another file, as if they N + were written inline. Command line alternative: multiple -f/--file payee Declares a payee name, for checking all entries in all files. N P Declares the market price of a commodity on some date, for value N @@ -1944,8 +1944,8 @@ Journal o customising reports Account aliases also rewrite account names in account directives. They - do not affect account names being entered via hledger add or hledger- - web. + do not affect account names being entered via hledger add or + hledger-web. Account aliases are very powerful. They are generally easy to use cor- rectly, but you can also generate invalid account names with them; more @@ -2284,12 +2284,18 @@ Journal declare and check your tags . Periodic transactions - The ~ 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. + The ~ directive declares a "periodic rule" which generates temporary + extra transactions, usually recurring at some interval, when hledger is + run with the --forecast flag. These "forecast transactions" are useful + for forecasting future activity. They exist only for the duration of + the report, and only when --forecast is used; they are not saved in the + journal file by hledger. - Periodic transactions can be a little tricky, so before you use them, - read this whole section, or at least these tips: + Periodic rules also have a second use: with the --budget flag they set + budget goals for budgeting. + + Periodic rules can be a little tricky, so before you use them, read + this whole section, or at least the following tips: 1. Two spaces accidentally added or omitted will cause you trouble - read about this below. @@ -2375,49 +2381,45 @@ Journal pression. Auto postings - The = 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 influ- - enced by the matched posting's amount. This can be useful for generat- - ing tax postings with a standard percentage, for example. + The = directive declares an "auto posting rule", which adds extra post- + ings to existing transactions. (Remember, postings are the account + name & amount lines below a transaction's date & description.) - Note that depending on generated data is not ideal for financial - records (it's less portable, less future-proof, less auditable by oth- - ers, and less robust, since other features like balance assertions will - depend on using or not using --auto). - - An auto posting rule looks a bit like a transaction: + In the journal, an auto posting rule looks quite like a transaction, + but instead of date and description it has = (mnemonic: "match") and a + query, like this: = QUERY - ACCOUNT AMOUNT + ACCOUNT AMOUNT ... - ACCOUNT [AMOUNT] - except the first line is an equals sign (mnemonic: = suggests match- - ing), followed by a query (which matches existing postings), and each - "posting" line describes a posting to be generated, and the posting - amounts can be: + Queries are just like command line queries; an account name substring + is most common. Query terms containing spaces should be enclosed in + single or double quotes. - o a normal amount with a commodity symbol, eg $2. This will be used + Each = rule works like this: when hledger is run with the --auto flag, + wherever the QUERY matches a posting in the journal, the rule's post- + ings are added to that transaction, immediately below the matched post- + ing. Note these generated postings are temporary, existing only for + the duration of the report, and only when --auto is used; they are not + saved in the journal file by hledger. + + Generated postings' amounts can depend on the matched posting's amount. + So auto postings can be useful for, eg, adding tax postings with a + standard percentage. AMOUNT can be: + + o a number with no commodity symbol, like 2. The matched posting's + commodity symbol will be added to this. + + o a normal amount with a commodity symbol, like $2. This will be used as-is. - o a number, eg 2. The commodity symbol (if any) from the matched post- - ing will be added to this. + o an asterisk followed by a number, like *2. This will multiply the + matched posting's amount (and total price, if any) by the number. - o a numeric multiplier, eg *2 (a star followed by a number N). The - matched posting's amount (and total price, if any) will be multiplied - by N. - - o a multiplier with a commodity symbol, eg *$2 (a star, number N, and - symbol S). The matched posting's amount will be multiplied by N, and - its commodity symbol will be replaced with S. - - Any query term containing spaces must be enclosed in single or double - quotes, as on the command line. Eg, note the quotes around the second - query term below: - - = expenses:groceries 'expenses:dining out' - (budget:funds:dining out) *-1 + o an asterisk followed by an amount with commodity symbol, like *$2. + This multiplies and also replaces the commodity symbol with this new + one. Some examples: @@ -2450,31 +2452,39 @@ Journal assets:checking:gifts -$20 assets:checking $20 + Note that depending fully on generated data such as this has some draw- + backs - it's less portable, less future-proof, less auditable by oth- + ers, and less robust (eg your balance assertions will depend on whether + you use or don't use --auto). An alternative is to use auto postings + in "one time" fashion - use them to help build a complex journal entry, + view it with hledger print --auto, and then copy that output into the + journal file to make it permanent. + Auto postings and multiple files An auto posting rule can affect any transaction in the current file, or - in any parent file or child file. Note, currently it will not affect + in any parent file or child file. Note, currently it will not affect sibling files (when multiple -f/--file are used - see #1212). Auto postings and dates - A posting date (or secondary date) in the matched posting, or (taking - precedence) a posting date in the auto posting rule itself, will also + A posting date (or secondary date) in the matched posting, or (taking + precedence) a posting date in the auto posting rule itself, will also be used in the generated posting. Auto postings and transaction balancing / inferred amounts / balance asser- tions Currently, auto postings are added: - o after missing amounts are inferred, and transactions are checked for + o after missing amounts are inferred, and transactions are checked for balancedness, o but before balance assertions are checked. - Note this means that journal entries must be balanced both before and + Note this means that journal entries must be balanced both before and after auto postings are added. This changed in hledger 1.12+; see #893 for background. - This also means that you cannot have more than one auto-posting with a - missing amount applied to a given transaction, as it will be unable to + This also means that you cannot have more than one auto-posting with a + missing amount applied to a given transaction, as it will be unable to infer amounts. Auto posting tags @@ -2483,11 +2493,11 @@ Journal o generated-posting:= QUERY - shows this was generated by an auto post- ing rule, and the query - o _generated-posting:= QUERY - a hidden tag, which does not appear in + o _generated-posting:= QUERY - a hidden tag, which does not appear in hledger's output. This can be used to match postings generated "just now", rather than generated in the past and saved to the journal. - Also, any transaction that has been changed by auto posting rules will + Also, any transaction that has been changed by auto posting rules will have these tags added: o modified: - this transaction was modified @@ -2496,24 +2506,24 @@ Journal tion was modified "just now". Auto postings on forecast transactions only - Tip: you can can make auto postings that will apply to forecast trans- - actions but not recorded transactions, by adding tag:_generated-trans- - action to their QUERY. This can be useful when generating new journal + Tip: you can can make auto postings that will apply to forecast trans- + actions but not recorded transactions, by adding tag:_generated-trans- + action to their QUERY. This can be useful when generating new journal entries to be saved in the journal. Other syntax - 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 special cases, - but in general, features in this section are considered less important - or even not recommended for most users. Downsides are mentioned to + 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 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. Balance assignments - Ledger-style balance assignments are also supported. These are like - balance assertions, but with no posting amount on the left side of the - equals sign; instead it is calculated automatically so as to satisfy - the assertion. This can be a convenience during data entry, eg when + Ledger-style balance assignments are also supported. These are like + balance assertions, but with no posting amount on the left side of the + equals sign; instead it is calculated automatically so as to satisfy + the assertion. This can be a convenience during data entry, eg when setting opening balances: ; starting a new journal, set asset account balances @@ -2531,20 +2541,20 @@ Journal expenses:misc The calculated amount depends on the account's balance in the commodity - at that point (which depends on the previously-dated postings of the - commodity to that account since the last balance assertion or assign- + at that point (which depends on the previously-dated postings of the + commodity to that account since the last balance assertion or assign- ment). - Downsides: using balance assignments makes your journal less explicit; + Downsides: using balance assignments makes your journal less explicit; to know the exact amount posted, you have to run hledger or do the cal- - culations yourself, instead of just reading it. Also balance assign- + culations yourself, instead of just reading it. Also balance assign- ments' forcing of balances can hide errors. These things make your fi- - nancial data less portable, less future-proof, and less trustworthy in + nancial data less portable, less future-proof, and less trustworthy in an audit. - Balance assignments and prices + Balance assignments and costs A cost in a balance assignment will cause the calculated amount to have - that price attached: + that cost attached: 2019/1/1 (a) = $1 @ 2 @@ -2554,31 +2564,31 @@ Journal (a) $1 @ 2 = $1 @ 2 Balance assignments and multiple files - Balance assignments handle multiple files like balance assertions. - They see balance from other files previously included from the current + 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. Bracketed posting dates - For setting posting dates and secondary posting dates, Ledger's brack- + For setting posting dates and secondary posting dates, Ledger's brack- eted date syntax is also supported: [DATE], [DATE=DATE2] or [=DATE2] in - posting comments. hledger will attempt to parse any square-bracketed - sequence of the 0123456789/-.= characters in this way. With this syn- - tax, DATE infers its year from the transaction and DATE2 infers its + posting comments. hledger will attempt to parse any square-bracketed + sequence of the 0123456789/-.= characters in this way. With this syn- + tax, DATE infers its year from the transaction and DATE2 infers its year from DATE. - Downsides: another syntax to learn, redundant with hledger's + Downsides: another syntax to learn, redundant with hledger's date:/date2: tags, and confusingly similar to Ledger's lot date syntax. D directive D AMOUNT - This directive sets a default commodity, to be used for any subsequent - commodityless amounts (ie, plain numbers) seen while parsing the jour- - nal. This effect lasts until the next D directive, or the end of the + This directive sets a default commodity, to be used for any subsequent + commodityless amounts (ie, plain numbers) seen while parsing the jour- + nal. This effect lasts until the next D directive, or the end of the journal. - For compatibility/historical reasons, D also acts like a commodity di- - rective (setting the commodity's decimal mark for parsing and display + For compatibility/historical reasons, D also acts like a commodity di- + rective (setting the commodity'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 deci- mal mark (either period or comma). Eg: @@ -2593,23 +2603,23 @@ Journal Interactions with other directives: - For setting a commodity's display style, a commodity directive has + For setting a commodity's display style, a commodity directive has highest priority, then a D directive. - For detecting a commodity's decimal mark during parsing, decimal-mark + For detecting a commodity's decimal mark during parsing, decimal-mark has highest priority, then commodity, then D. - For checking commodity symbols with the check command, a commodity di- + For checking commodity symbols with the check command, a commodity di- rective is required (hledger check commodities ignores D directives). - Downsides: omitting commodity symbols makes your financial data less - explicit, less portable, and less trustworthy in an audit. It is usu- - ally an unsustainable shortcut; sooner or later you will want to track - multiple commodities. D is overloaded with functions redundant with + Downsides: omitting commodity symbols makes your financial data less + explicit, less portable, and less trustworthy in an audit. It is usu- + ally an unsustainable shortcut; sooner or later you will want to track + multiple commodities. D is overloaded with functions redundant with commodity and decimal-mark. And it works differently from Ledger's D. apply account directive - This directive sets a default parent account, which will be prepended + This directive sets a default parent account, which will be prepended to all accounts in following entries, until an end apply account direc- tive or end of current file. Eg: @@ -2631,10 +2641,10 @@ Journal Account names entered via hledger add or hledger-web are not affected. - Account aliases, if any, are applied after the parent account is + Account aliases, if any, are applied after the parent account is prepended. - Downsides: this can make your financial data less explicit, less + Downsides: this can make your financial data less explicit, less portable, and less trustworthy in an audit. Y directive @@ -2644,7 +2654,7 @@ Journal year YEAR apply year YEAR - The space is optional. This sets a default year to be used for subse- + The space is optional. This sets a default year to be used for subse- quent dates which don't specify a year. Eg: Y2009 ; set default year to 2009 @@ -2665,57 +2675,57 @@ Journal Downsides: omitting the year (from primary transaction dates, at least) makes your financial data less explicit, less portable, and less trust- - worthy in an audit. Such dates can get separated from their corre- - sponding Y directive, eg when evaluating a region of the journal in - your editor. A missing Y directive makes reports dependent on today's + worthy in an audit. Such dates can get separated from their corre- + sponding Y directive, eg when evaluating a region of the journal in + your editor. A missing Y directive makes reports dependent on today's date. Secondary dates A secondary date is written after the primary date, following an equals - sign. If the year is omitted, the primary date's year is assumed. - When running reports, the primary (left) date is used by default, but - with the --date2 flag (or --aux-date or --effective), the secondary + sign. If the year is omitted, the primary date's year is assumed. + When running reports, the primary (left) date is used by default, but + with the --date2 flag (or --aux-date or --effective), the secondary (right) date will be used instead. - The meaning of secondary dates is up to you, but it's best to follow a - consistent rule. Eg "primary = the bank's clearing date, secondary = + The meaning of secondary dates is up to you, but it's best to follow a + consistent rule. Eg "primary = the bank's clearing date, secondary = date the transaction was initiated, if different". - Downsides: makes your financial data more complicated, less portable, + Downsides: makes your financial data more complicated, less portable, and less trustworthy in an audit. Keeping the meaning of the two dates - consistent requires discipline, and you have to remember which report- - ing mode is appropriate for a given report. Posting dates are simpler + consistent requires discipline, and you have to remember which report- + ing mode is appropriate for a given report. Posting dates are simpler and better. Star comments - Lines beginning with * (star/asterisk) are also comment lines. This + Lines beginning with * (star/asterisk) are also comment lines. This feature allows Emacs users to insert org headings in their journal, al- lowing them to fold/unfold/navigate it like an outline when viewed with org mode. - Downsides: another, unconventional comment syntax to learn. Decreases - your journal's portability. 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 + Downsides: another, unconventional comment syntax to learn. Decreases + your journal's portability. 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's features. Valuation expressions - Ledger allows a valuation function or value to be written in double + Ledger allows a valuation function or value to be written in double parentheses after an amount. hledger ignores these. Virtual postings - A posting with parentheses around the account name ((some:account)) is - called a unbalanced virtual posting. Such postings do not participate - in transaction balancing. (And if you write them without an amount, a - zero amount is always inferred.) These can occasionally be convenient - for special circumstances, but they violate double entry bookkeeping - and make your data less portable across applications, so many people + A posting with parentheses around the account name ((some:account)) is + called a unbalanced virtual posting. Such postings do not participate + in transaction balancing. (And if you write them without an amount, a + zero amount is always inferred.) These can occasionally be convenient + for special circumstances, but they violate double entry bookkeeping + and make your data less portable across applications, so many people avoid using them at all. - A posting with brackets around the account name ([some:account]) is - called a balanced virtual posting. The balanced virtual postings in a + A posting with brackets around the account name ([some:account]) is + called a balanced virtual posting. The balanced virtual postings in a transaction must add up to zero, just like ordinary postings, but sepa- - rately from them. These are not part of double entry bookkeeping ei- + rately from them. These are not part of double entry bookkeeping ei- ther, but they are at least balanced. An example: 2022-01-01 buy food with cash, update budget envelope subaccounts, & something else @@ -2726,13 +2736,13 @@ Journal [assets:checking:available] $10 ; <- (something:else) $5 ; <- this is not required to balance - Ordinary postings, whose account names are neither parenthesised nor - bracketed, are called real postings. You can exclude virtual postings + Ordinary postings, whose account names are neither parenthesised nor + bracketed, are called real postings. You can exclude virtual postings from reports with the -R/--real flag or a real:1 query. Other Ledger directives These other Ledger directives are currently accepted but ignored. This - allows hledger to read more Ledger files, but be aware that hledger's + allows hledger to read more Ledger files, but be aware that hledger's reports may differ from Ledger's if you use these. apply fixed COMM AMT @@ -2753,35 +2763,35 @@ Journal value EXPR --command-line-flags - See also https://hledger.org/ledger.html for a detailed hledger/Ledger + See also https://hledger.org/ledger.html for a detailed hledger/Ledger syntax comparison. CSV - hledger can read CSV files (Character Separated Value - usually comma, - semicolon, or tab) containing dated records, automatically converting + hledger can read CSV files (Character Separated Value - usually comma, + semicolon, or tab) containing dated records, automatically converting each record into a transaction. (To learn about writing CSV, see CSV output.) - For best error messages when reading CSV/TSV/SSV files, make sure they + For best error messages when reading CSV/TSV/SSV files, make sure they have a corresponding .csv, .tsv or .ssv file extension or use a hledger file prefix (see File Extension below). Each CSV file must be described by a corresponding rules file. - This contains rules describing the CSV data (header line, fields lay- - out, date format etc.), how to construct hledger transactions from it, - and how to categorise transactions based on description or other at- + This contains rules describing the CSV data (header line, fields lay- + out, date format etc.), how to construct hledger transactions from it, + and how to categorise transactions based on description or other at- tributes. - By default hledger looks for a rules file named like the CSV file with - an extra .rules extension, in the same directory. Eg when asked to + By default hledger looks for a rules file named like the CSV file with + an extra .rules extension, in the same directory. Eg when asked to read foo/FILE.csv, hledger looks for foo/FILE.csv.rules. You can spec- - ify a different rules file with the --rules-file option. If no rules - file is found, hledger will create a sample rules file, which you'll + ify a different rules file with the --rules-file option. If no rules + file is found, hledger will create a sample rules file, which you'll need to adjust. - At minimum, the rules file must identify the date and amount fields, - and often it also specifies the date format and how many header lines + At minimum, the rules file must identify the date and amount fields, + and often it also specifies the date format and how many header lines there are. Here's a simple CSV file and a rules file for it: Date, Description, Id, Amount @@ -2798,56 +2808,56 @@ CSV income:unknown -10.23 There's an introductory Importing CSV data tutorial on hledger.org, and - more CSV rules examples below, and a larger collection at + more CSV rules examples below, and a larger collection at https://github.com/simonmichael/hledger/tree/master/examples/csv. CSV rules cheatsheet The following kinds of rule can appear in the rules file, in any order. (Blank lines and lines beginning with # or ; or * are ignored.) - source optionally declare which file to read data + source optionally declare which file to read data from - separator declare the field separator, instead of rely- + separator declare the field separator, instead of rely- ing on file extension skip skip one or more header lines at start of file date-format declare how to parse CSV dates/date-times - timezone declare the time zone of ambiguous CSV date- - times - newest-first improve txn order when: there are multiple + timezone declare the time zone of ambiguous CSV + date-times + newest-first improve txn order when: there are multiple records, newest first, all with the same date - intra-day-reversed improve txn order when: same-day txns are in + intra-day-reversed improve txn order when: same-day txns are in opposite order to the overall file - decimal-mark declare the decimal mark used in CSV amounts, + decimal-mark declare the decimal mark used in CSV amounts, when ambiguous - fields list name CSV fields for easy reference, and op- + fields list name CSV fields for easy reference, and op- tionally assign their values to hledger fields - Field assignment assign a CSV value or interpolated text value + Field assignment assign a CSV value or interpolated text value to a hledger field if block conditionally assign values to hledger fields, or skip a record or end (skip rest of file) if table conditionally assign values to hledger fields, using compact syntax - balance-type select which type of balance assertions/as- + balance-type select which type of balance assertions/as- signments to generate include inline another CSV rules file - Working with CSV tips can be found below, including How CSV rules are + Working with CSV tips can be found below, including How CSV rules are evaluated. source - If you tell hledger to read a csv file with -f foo.csv, it will look - for rules in foo.csv.rules. Or, you can tell it to read the rules - file, with -f foo.csv.rules, and it will look for data in foo.csv + If you tell hledger to read a csv file with -f foo.csv, it will look + for rules in foo.csv.rules. Or, you can tell it to read the rules + file, with -f foo.csv.rules, and it will look for data in foo.csv (since 1.30). - These are mostly equivalent, but the second method provides some extra - features. For one, the data file can be missing, without causing an - error; it is just considered empty. And, you can specify a different + These are mostly equivalent, but the second method provides some extra + features. For one, the data file can be missing, without causing an + error; it is just considered empty. And, you can specify a different data file by adding a "source" rule: source ./Checking1.csv - If you specify just a file name with no path, hledger will look for it + If you specify just a file name with no path, hledger will look for it in your system's downloads directory (~/Downloads, currently): source Checking1.csv @@ -2860,9 +2870,9 @@ CSV See also "Working with CSV > Reading files specified by rule". separator - You can use the separator rule to read other kinds of character-sepa- - rated data. The argument is any single separator character, or the - words tab or space (case insensitive). Eg, for comma-separated values + You can use the separator rule to read other kinds of character-sepa- + rated data. The argument is any single separator character, or the + words tab or space (case insensitive). Eg, for comma-separated values (CSV): separator , @@ -2875,32 +2885,32 @@ CSV separator TAB - If the input file has a .csv, .ssv or .tsv file extension (or a csv:, + If the input file has a .csv, .ssv or .tsv file extension (or a csv:, ssv:, tsv: prefix), the appropriate separator will be inferred automat- ically, and you won't need this rule. skip skip N - The word skip 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'll need this whenever your CSV data contains header lines. - Note, empty and blank lines are skipped automatically, so you don't + The word skip 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'll need this whenever your CSV data contains header lines. + Note, empty and blank lines are skipped automatically, so you don't need to count those. - skip has a second meaning: it can be used inside if blocks (described - below), to skip one or more records whenever the condition is true. + skip 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. date-format date-format DATEFMT - This is a helper for the date (and date2) fields. If your CSV dates - are not formatted like YYYY-MM-DD, YYYY/MM/DD or YYYY.MM.DD, you'll - need to add a date-format rule describing them with a strptime-style - date parsing pattern - see https://hackage.haskell.org/pack- - age/time/docs/Data-Time-Format.html#v:formatTime. The pattern must + This is a helper for the date (and date2) fields. If your CSV dates + are not formatted like YYYY-MM-DD, YYYY/MM/DD or YYYY.MM.DD, you'll + need to add a date-format rule describing them with a strptime-style + date parsing pattern - see https://hackage.haskell.org/pack- + age/time/docs/Data-Time-Format.html#v:formatTime. The pattern must parse the CSV date value completely. Some examples: # MM/DD/YY @@ -2920,33 +2930,33 @@ CSV timezone timezone TIMEZONE - When CSV contains date-times that are implicitly in some time zone + When CSV contains date-times that are implicitly in some time zone other than yours, but containing no explicit time zone information, you - can use this rule to declare the CSV's native time zone, which helps + can use this rule to declare the CSV's native time zone, which helps prevent off-by-one dates. - When the CSV date-times do contain time zone information, you don't - need this rule; instead, use %Z in date-format (or %z, %EZ, %Ez; see + When the CSV date-times do contain time zone information, you don't + need this rule; instead, use %Z in date-format (or %z, %EZ, %Ez; see the formatTime link above). In either of these cases, hledger will do a time-zone-aware conversion, localising the CSV date-times to your current system time zone. If you prefer to localise to some other time zone, eg for reproducibility, you - can (on unix at least) set the output timezone with the TZ environment + can (on unix at least) set the output timezone with the TZ environment variable, eg: $ TZ=-1000 hledger print -f foo.csv # or TZ=-1000 hledger import foo.csv - timezone currently does not understand timezone names, except "UTC", - "GMT", "EST", "EDT", "CST", "CDT", "MST", "MDT", "PST", or "PDT". For + timezone currently does not understand timezone names, except "UTC", + "GMT", "EST", "EDT", "CST", "CDT", "MST", "MDT", "PST", or "PDT". For others, use numeric format: +HHMM or -HHMM. newest-first 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. But if it encounters CSV where - all records are on the same date, it assumes that the records are old- - est first. If in fact the CSV's records are normally newest first, + chronologically, including same-day transactions. Usually it can + auto-detect how the CSV records are ordered. But if it encounters CSV + where all records are on the same date, it assumes that the records are + oldest first. If in fact the CSV's records are normally newest first, like: 2022-10-01, txn 3... @@ -3139,9 +3149,9 @@ CSV 2. amount-in and amount-out work exactly like the above, but should be used when the CSV has two amount fields (such as "Debit" and - "Credit", or "Inflow" and "Outflow"). Whichever field has a non- - zero value will be used as the amount of the first and second post- - ings. Here are some tips to avoid confusion: + "Credit", or "Inflow" and "Outflow"). Whichever field has a + non-zero value will be used as the amount of the first and second + postings. Here are some tips to avoid confusion: o It's not "amount-in for posting 1 and amount-out for posting 2", it is "extract a single amount from the amount-in or amount-out @@ -3565,11 +3575,11 @@ CSV c. If both fields can contain a non-zero value (or both can be empty): - The -in/-out rules normally choose the value which is non-zero/non- - empty. Some value pairs can be ambiguous, such as 1 and none. 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: + The -in/-out rules normally choose the value which is + non-zero/non-empty. Some value pairs can be ambiguous, such as 1 + and none. For such cases, use conditional rules to help select the + amount. Eg, to handle the above you could select the value con- + taining non-zero digits: fields date, description, in, out if %in [1-9] @@ -3581,8 +3591,8 @@ CSV Use the unnumbered amount (or amount-in and amount-out) syntax. 4. If the CSV has only balance amounts, not transaction amounts: - Assign to balanceN, to set a balance assignment on the Nth posting, - causing the posting's amount to be calculated automatically. balance + Assign to balanceN, to set a balance assignment on the Nth posting, + causing the posting's amount to be calculated automatically. balance with no number is equivalent to balance1. In this situation hledger is more likely to guess the wrong default account name, so you may need to set that explicitly. @@ -3598,20 +3608,20 @@ CSV o If an amount value is parenthesised: it will be de-parenthesised and sign-flipped: (AMT) becomes -AMT - o If an amount value has two minus signs (or two sets of parentheses, + o If an amount value has two minus signs (or two sets of parentheses, or a minus sign and parentheses): they cancel out and will be removed: --AMT or -(AMT) becomes AMT - o If an amount value contains just a sign (or just a set of parenthe- + o If an amount value contains just a sign (or just a set of parenthe- ses): - that is removed, making it an empty value. "+" or "-" or "()" becomes + that is removed, making it an empty value. "+" or "-" or "()" becomes "". - It's not possible (without preprocessing the CSV) to set an amount to + It's not possible (without preprocessing the CSV) to set an amount to its absolute value, ie discard its sign. Setting currency/commodity - If the currency/commodity symbol is included in the CSV's amount + If the currency/commodity symbol is included in the CSV's amount field(s): 2023-01-01,foo,$123.00 @@ -3630,7 +3640,7 @@ CSV 2023-01-01,foo,USD,123.00 You can assign that to the currency pseudo-field, which has the special - effect of prepending itself to every amount in the transaction (on the + effect of prepending itself to every amount in the transaction (on the left, with no separating space): fields date,description,currency,amount @@ -3639,7 +3649,7 @@ CSV expenses:unknown USD123.00 income:unknown USD-123.00 - Or, you can use a field assignment to construct the amount yourself, + Or, you can use a field assignment to construct the amount yourself, with more control. Eg to put the symbol on the right, and separated by a space: @@ -3650,7 +3660,7 @@ CSV expenses:unknown 123.00 USD income:unknown -123.00 USD - Note we used a temporary field name (cur) that is not currency - that + Note we used a temporary field name (cur) that is not currency - that would trigger the prepending effect, which we don't want here. Amount decimal places @@ -3658,13 +3668,13 @@ CSV amount1 influence commodity display styles, such as the number of deci- mal places displayed in reports. - The original amounts as written in the CSV file do not affect display + The original amounts as written in the CSV file do not affect display style (because we don't yet reliably know their commodity). Referencing other fields - In field assignments, you can interpolate only CSV fields, not hledger - fields. In the example below, there's both a CSV field and a hledger - field named amount1, but %amount1 always means the CSV field, not the + In field assignments, you can interpolate only CSV fields, not hledger + fields. In the example below, there's both a CSV field and a hledger + field named amount1, but %amount1 always means the CSV field, not the hledger field: # Name the third CSV field "amount1" @@ -3676,7 +3686,7 @@ CSV # Set comment to the CSV amount1 (not the amount1 assigned above) comment %amount1 - Here, since there's no CSV amount1 field, %amount1 will produce a lit- + Here, since there's no CSV amount1 field, %amount1 will produce a lit- eral "amount1": fields date,description,csvamount @@ -3684,7 +3694,7 @@ CSV # Can't interpolate amount1 here comment %amount1 - When there are multiple field assignments to the same hledger field, + When there are multiple field assignments to the same hledger field, only the last one takes effect. Here, comment's value will be be B, or C if "something" is matched, but never A: @@ -3694,14 +3704,14 @@ CSV comment C How CSV rules are evaluated - Here's how to think of CSV rules being evaluated (if you really need + Here's how to think of CSV rules being evaluated (if you really need to). First, - o include - all includes are inlined, from top to bottom, depth first. - (At each include point the file is inlined and scanned for further + o include - all includes are inlined, from top to bottom, depth first. + (At each include point the file is inlined and scanned for further includes, recursively, before proceeding.) - Then "global" rules are evaluated, top to bottom. If a rule is re- + Then "global" rules are evaluated, top to bottom. If a rule is re- peated, the last one wins: o skip (at top level) @@ -3715,30 +3725,30 @@ CSV Then for each CSV record in turn: - o test all if blocks. If any of them contain a end rule, skip all re- - maining CSV records. Otherwise if any of them contain a skip rule, - skip that many CSV records. If there are multiple matched skip + o test all if blocks. If any of them contain a end rule, skip all re- + maining CSV records. Otherwise if any of them contain a skip rule, + skip that many CSV records. If there are multiple matched skip rules, the first one wins. - o collect all field assignments at top level and in matched if blocks. - When there are multiple assignments for a field, keep only the last + o collect all field assignments at top level and in matched if blocks. + When there are multiple assignments for a field, keep only the last one. - o compute a value for each hledger field - either the one that was as- + o compute a value for each hledger field - either the one that was as- signed to it (and interpolate the %CSVFIELD references), or a default o generate a hledger transaction (journal entry) from these values. - This is all part of the CSV reader, one of several readers hledger can - use to parse input files. When all files have been read successfully, - the transactions are passed as input to whichever hledger command the + This is all part of the CSV reader, one of several readers hledger can + use to parse input files. When all files have been read successfully, + the transactions are passed as input to whichever hledger command the user specified. Well factored rules - Some things than can help reduce duplication and complexity in rules + Some things than can help reduce duplication and complexity in rules files: - o Extracting common rules usable with multiple CSV files into a com- + o Extracting common rules usable with multiple CSV files into a com- mon.rules, and adding include common.rules to each CSV's rules file. o Splitting if blocks into smaller if blocks, extracting the frequently @@ -3746,8 +3756,8 @@ CSV CSV rules examples Bank of Ireland - Here's a CSV with two amount fields (Debit and Credit), and a balance - field, which we can use to add balance assertions, which is not neces- + Here's a CSV with two amount fields (Debit and Credit), and a balance + field, which we can use to add balance assertions, which is not neces- sary but provides extra error checking: Date,Details,Debit,Credit,Balance @@ -3789,13 +3799,13 @@ CSV assets:bank:boi:checking EUR-5.0 = EUR126.0 expenses:unknown EUR5.0 - The balance assertions don't raise an error above, because we're read- - ing directly from CSV, but they will be checked if these entries are + The balance assertions don't raise an error above, because we're read- + ing directly from CSV, but they will be checked if these entries are imported into a journal file. Coinbase - A simple example with some CSV from Coinbase. The spot price is - recorded using cost notation. The legacy amount field name conve- + A simple example with some CSV from Coinbase. The spot price is + recorded using cost notation. The legacy amount field name conve- niently sets amount 2 (posting 2's amount) to the total cost. # 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 @@ -3817,7 +3827,7 @@ CSV Amazon Here we convert amazon.com order history, and use an if block to gener- - ate a third posting if there's a fee. (In practice you'd probably get + ate a third posting if there's a fee. (In practice you'd probably get this data from your bank instead, but it's an example.) "Date","Type","To/From","Name","Status","Amount","Fees","Transaction ID" @@ -3869,7 +3879,7 @@ CSV expenses:fees $1.00 Paypal - Here's a real-world rules file for (customised) Paypal CSV, with some + Here's a real-world rules file for (customised) Paypal CSV, with some Paypal-specific rules, and a second rules file included: "Date","Time","TimeZone","Name","Type","Status","Currency","Gross","Fee","Net","From Email Address","To Email Address","Transaction ID","Item Title","Item ID","Reference Txn ID","Receipt ID","Balance","Note" @@ -4020,22 +4030,22 @@ CSV Timeclock The time logging format of timeclock.el, as read by hledger. - hledger can read time logs in timeclock format. As with Ledger, these - are (a subset of) timeclock.el's format, containing clock-in and clock- - out entries as in the example below. The date is a simple date. The - time format is HH:MM[:SS][+-ZZZZ]. Seconds and timezone are optional. - The timezone, if present, must be four digits and is ignored (currently - the time is always interpreted as a local time). Lines beginning with - # or ; or *, and blank lines, are ignored. + hledger can read time logs in timeclock format. As with Ledger, these + are (a subset of) timeclock.el's format, containing clock-in and + clock-out entries as in the example below. The date is a simple date. + The time format is HH:MM[:SS][+-ZZZZ]. Seconds and timezone are op- + tional. The timezone, if present, must be four digits and is ignored + (currently the time is always interpreted as a local time). Lines be- + ginning with # or ; or *, and blank lines, are ignored. 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 - hledger treats each clock-in/clock-out pair as a transaction posting - some number of hours to an account. Or if the session spans more than - one day, it is split into several transactions, one for each day. For + hledger treats each clock-in/clock-out pair as a transaction posting + some number of hours to an account. Or if the session spans more than + one day, it is split into several transactions, one for each day. For the above time log, hledger print generates these journal entries: $ hledger -f t.timeclock print @@ -4056,21 +4066,21 @@ Timeclock To generate time logs, ie to clock in and clock out, you could: - o use emacs and the built-in timeclock.el, or the extended timeclock- - x.el and perhaps the extras in ledgerutils.el + o use emacs and the built-in timeclock.el, or the extended time- + clock-x.el and perhaps the extras in ledgerutils.el o at the command line, use these bash aliases: shell alias ti="echo - i `date '+%Y-%m-%d %H:%M:%S'` \$* >>$TIMELOG" alias to="echo o + i `date '+%Y-%m-%d %H:%M:%S'` \$* >>$TIMELOG" alias to="echo o `date '+%Y-%m-%d %H:%M:%S'` >>$TIMELOG" o or use the old ti and to scripts in the ledger 2.x repository. These - rely on a "timeclock" executable which I think is just the ledger 2 + rely on a "timeclock" executable which I think is just the ledger 2 executable renamed. Timedot - timedot format is hledger's human-friendly time logging format. Com- - pared to timeclock format, it is more convenient for quick, approxi- - mate, and retroactive time logging, and more human-readable (you can + timedot format is hledger's human-friendly time logging format. Com- + 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 @@ -4089,53 +4099,53 @@ Timedot (per:admin:finance) 0 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 + 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 in- + o An account name - any hledger-style account name, optionally in- dented. - o Two or more spaces - required if there is an amount (as in journal + o Two or more spaces - required if there is an amount (as in journal format). o A timedot amount, which can be o empty (representing zero) - 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 + 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 = + converted to hours according to 60s = 1m, 60m = 1h, 24h = 1d, 7d = 1w, 30d = 1mo, 365d = 1y. - o one or more dots (period characters), each representing 0.25. - These are the dots in "timedot". Spaces are ignored and can be + 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 one or more letters. These are like dots but they also generate a + 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 An optional comment following a semicolon (a hledger-style posting + o An optional comment following a semicolon (a hledger-style posting comment). - There is some flexibility to help with keeping time log data and notes + 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 After the first date line, lines which do not contain a double space + 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 Before the first date line, lines beginning with * (eg org headings) - are ignored. And from the first date line onward, Emacs org mode + 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 + space) will be ignored. This means the time log can also be a org outline. Timedot examples @@ -4243,9 +4253,9 @@ Timedot PART 3: REPORTING CONCEPTS Amount formatting, parseability If you're wondering why your print report sometimes shows trailing dec- - imal marks, with no decimal digits; it does this when showing amounts + 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 + and allow them to be re-parsed reliably (see also Decimal marks, digit group marks. Eg: commodity $1,000.00 @@ -4258,7 +4268,7 @@ Amount formatting, parseability (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 + disabling digit group marks, eg with -c/--commodity (for each affected commodity): $ hledger print -c '$1000.00' @@ -4274,19 +4284,19 @@ Amount formatting, parseability More generally: hledger output falls into three rough categories, which format amounts a little bit differently to suit different consumers: - 1. "hledger-readable output" - should be readable by hledger (and by + 1. "hledger-readable output" - should be readable by hledger (and by humans) - o This is produced by reports that show full journal entries: print, + o This is produced by reports that show full journal entries: print, import, close, rewrite etc. - o It shows amounts with their original journal precisions, which may + o It shows amounts with their original journal precisions, which may not be consistent. - o It adds a trailing decimal mark when needed to avoid showing ambigu- + o It adds a trailing decimal mark when needed to avoid showing ambigu- ous amounts. - o It can be parsed reliably (by hledger and ledger2beancount at least, + o It can be parsed reliably (by hledger and ledger2beancount at least, but perhaps not by Ledger..) 2. "human-readable output" - usually for humans @@ -4298,13 +4308,13 @@ Amount formatting, parseability o It shows ambiguous amounts unmodified. - o It can be parsed reliably in the context of a known report (when you + o It can be parsed reliably in the context of a known report (when you know decimals are consistently not being shown, you can assume a sin- gle mark is a digit group mark). 3. "machine-readable output" - usually for other software - o This is produced by all reports when an output format like csv, tsv, + o This is produced by all reports when an output format like csv, tsv, json, or sql is selected. o It shows amounts as 1 or 2 do, but without digit group marks. @@ -4315,39 +4325,39 @@ Amount formatting, parseability Time periods Report start & end date By default, most hledger reports will show the full span of time repre- - sented by the journal. The report start date will be the earliest + sented by the journal. The report start date will be the earliest transaction or posting date, and the report end date will be the latest transaction, posting, or market price date. - 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 -b/--begin, + 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 -b/--begin, -e/--end, -p/--period or a date: query (described below). All of these accept the smart date syntax (below). Some notes: - o End dates are exclusive, as in Ledger, so you should write the date + o End dates are exclusive, as in Ledger, so you should write the date after the last day you want to see in the report. - o As noted in reporting options: among start/end dates specified with + o As noted in reporting options: among start/end dates specified with options, the last (i.e. right-most) option takes precedence. - o The effective report start and end dates are the intersection of the - start/end dates from options and that from date: queries. That is, - date:2019-01 date:2019 -p'2000 to 2030' yields January 2019, the + o The effective report start and end dates are the intersection of the + start/end dates from options and that from date: queries. That is, + date:2019-01 date:2019 -p'2000 to 2030' yields January 2019, the smallest common time span. - o In some cases a report interval will adjust start/end dates to fall + o In some cases a report interval will adjust start/end dates to fall on interval boundaries (see below). Examples: -b 2016/3/17 begin on St. Patrick's day 2016 - -e 12/1 end at the start of december 1st of the current year + -e 12/1 end at the start of december 1st of the current year (11/30 will be the last date included) -b thismonth all transactions on or after the 1st of the current month -p thismonth all transactions in the current month - date:2016/3/17.. the above written as queries instead (.. can also be re- + date:2016/3/17.. the above written as queries instead (.. can also be re- placed with -) date:..12/1 date:thismonth.. @@ -4355,11 +4365,11 @@ Time periods Smart dates hledger's user interfaces accept a "smart date" syntax for added conve- - nience. Smart dates optionally can be relative to today's date, be - written with english words, and have less-significant parts omitted + nience. Smart dates optionally can be relative to today's date, be + written with english words, and have less-significant parts omitted (missing parts are inferred as 1). Some examples: - 2004/10/1, 2004-01-01, exact date, several separators allowed. Year + 2004/10/1, 2004-01-01, exact date, several separators allowed. Year 2004.9.1 is 4+ digits, month is 1-12, day is 1-31 2004 start of year 2004/10 start of month @@ -4383,26 +4393,26 @@ Time periods 20181201 8 digit YYYYMMDD with valid year month and day 201812 6 digit YYYYMM with valid year and month - Some counterexamples - malformed digit sequences might give surprising + Some counterexamples - malformed digit sequences might give surprising results: - 201813 6 digits with an invalid month is parsed as start of + 201813 6 digits with an invalid month is parsed as start of 6-digit year - 20181301 8 digits with an invalid month is parsed as start of + 20181301 8 digits with an invalid month is parsed as start of 8-digit year 20181232 8 digits with an invalid day gives an error 201801012 9+ digits beginning with a valid YYYYMMDD gives an error - "Today's date" can be overridden with the --today option, in case it's + "Today's date" can be overridden with the --today option, in case it's needed for testing or for recreating old reports. (Except for periodic transaction rules, which are not affected by --today.) Report intervals - A report interval can be specified so that reports like register, bal- + A report interval can be specified so that reports like register, bal- ance or activity become multi-period, showing each subperiod as a sepa- rate row or column. - The following standard intervals can be enabled with command-line + The following standard intervals can be enabled with command-line flags: o -D/--daily @@ -4415,47 +4425,47 @@ Time periods o -Y/--yearly - More complex intervals can be specified using -p/--period, described + More complex intervals can be specified using -p/--period, described below. Date adjustment - 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. This is convenient for produc- + 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. This is convenient for produc- ing simple periodic reports. More precisely: - o an inferred start date will be adjusted earlier if needed to fall on + o an inferred start date will be adjusted earlier if needed to fall on a natural period boundary - o an inferred end date will be adjusted later if needed to make the + o an inferred end date will be adjusted later if needed to make the last period the same length as the others. By contrast, start/end dates which have been specified explicitly, with - -b, -e, -p or date:, 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's on a period boundary if you want to see simple report period + -b, -e, -p or date:, 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's on a period boundary if you want to see simple report period headings. Period expressions - The -p/--period option specifies a period expression, which is a com- + The -p/--period option specifies a period expression, which is a com- pact way of expressing a start date, end date, and/or report interval. - Here's a period expression with a start and end date (specifying the + Here's a period expression with a start and end date (specifying the first quarter of 2009): -p "from 2009/1/1 to 2009/4/1" - Several keywords like "from" and "to" are supported for readability; - these are optional. "to" can also be written as ".." or "-". The - spaces are also optional, as long as you don't run two dates together. + Several keywords like "from" and "to" are supported for readability; + these are optional. "to" can also be written as ".." or "-". The + spaces are also optional, as long as you don't run two dates together. So the following are equivalent to the above: -p "2009/1/1 2009/4/1" -p2009/1/1to2009/4/1 -p2009/1/1..2009/4/1 - Dates are smart dates, so if the current year is 2009, these are also + Dates are smart dates, so if the current year is 2009, these are also equivalent to the above: -p "1/1 4/1" @@ -4467,28 +4477,28 @@ Time periods -p "from 2009/1/1" everything after january 1, 2009 - -p "since 2009/1" the same, since is a syn- + -p "since 2009/1" the same, since is a syn- onym -p "from 2009" the same - -p "to 2009" everything before january + -p "to 2009" everything before january 1, 2009 You can also specify a period by writing a single partial or full date: -p "2009" the year 2009; equivalent to "2009/1/1 to 2010/1/1" - -p "2009/1" the month of january 2009; equivalent to "2009/1/1 to + -p "2009/1" the month of january 2009; equivalent to "2009/1/1 to 2009/2/1" - -p "2009/1/1" the first day of 2009; equivalent to "2009/1/1 to + -p "2009/1/1" the first day of 2009; equivalent to "2009/1/1 to 2009/1/2" or by using the "Q" quarter-year syntax (case insensitive): - -p "2009Q1" first quarter of 2009, equivalent to "2009/1/1 to + -p "2009Q1" first quarter of 2009, equivalent to "2009/1/1 to 2009/4/1" -p "q4" fourth quarter of the current year Period expressions with a report interval - A period expression can also begin with a report interval, separated + A period expression can also begin with a report interval, separated from the start/end dates (if any) by a space or the word in: -p "weekly from 2009/1/1 to 2009/4/1" @@ -4511,10 +4521,10 @@ Time periods Weekly on a custom day: - o every Nth day of week (th, nd, rd, or st are all accepted after the + o every Nth day of week (th, nd, rd, or st are all accepted after the number) - o every WEEKDAYNAME (full or three-letter english weekday name, case + o every WEEKDAYNAME (full or three-letter english weekday name, case insensitive) Monthly on a custom day: @@ -4527,7 +4537,7 @@ Time periods o every MM/DD [of year] (month number and day of month number) - o every MONTHNAME DDth [of year] (full or three-letter english month + o every MONTHNAME DDth [of year] (full or three-letter english month name, case insensitive, and day of month number) o every DDth MONTHNAME [of year] (equivalent to the above) @@ -4540,21 +4550,21 @@ Time periods 2009/03" -p "every 2nd day of week" periods will go from Tue to Tue -p "every Tue" same - -p "every 15th day" period boundaries will be on 15th of each + -p "every 15th day" period boundaries will be on 15th of each month - -p "every 2nd Monday" period boundaries will be on second Monday + -p "every 2nd Monday" period boundaries will be on second Monday of each month - -p "every 11/05" yearly periods with boundaries on 5th of + -p "every 11/05" yearly periods with boundaries on 5th of November -p "every 5th November" same -p "every Nov 5th" same - Show historical balances at end of the 15th day of each month (N is an + Show historical balances at end of the 15th day of each month (N is an end date, exclusive as always): $ hledger balance -H -p "every 16th day" - Group postings from the start of wednesday to end of the following + Group postings from the start of wednesday to end of the following tuesday (N is both (inclusive) start date and (exclusive) end date): $ hledger register checking -p "every 3rd day of week" @@ -4565,76 +4575,86 @@ Time periods o every WEEKDAYNAME,WEEKDAYNAME,... (full or three-letter english week- day names, case insensitive) - Also, weekday and weekendday are shorthand for mon,tue,wed,thu,fri and + Also, weekday and weekendday are shorthand for mon,tue,wed,thu,fri and sat,sun. - This is mainly intended for use with --forecast, to generate periodic + This is mainly intended for use with --forecast, to generate periodic transactions on arbitrary days of the week. It may be less useful with -p, since it divides each week into subperiods of unequal length, which is unusual. (Related: #1632) Examples: - -p "every dates will be Mon, Wed, Fri; periods will be Mon- - mon,wed,fri" Tue, Wed-Thu, Fri-Sun - -p "every weekday" dates will be Mon, Tue, Wed, Thu, Fri; periods will + -p "every dates will be Mon, Wed, Fri; periods will be + mon,wed,fri" Mon-Tue, Wed-Thu, Fri-Sun + -p "every weekday" dates will be Mon, Tue, Wed, Thu, Fri; periods will be Mon, Tue, Wed, Thu, Fri-Sun -p "every weekend- dates will be Sat, Sun; periods will be Sat, Sun-Fri day" Depth - With the --depth NUM option (short form: -NUM), reports will show ac- - counts only to the specified depth, hiding deeper subaccounts. Use - this when you want a summary with less detail. This flag has the same + With the --depth NUM option (short form: -NUM), reports will show ac- + counts 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 depth: query argument: depth:2, --depth=2 or -2 are equiva- lent. Queries One of hledger's strengths is being able to quickly report on a precise - subset of your data. Most hledger commands accept optional query argu- - ments to restrict their scope. The syntax is as follows: + subset of your data. Most hledger commands accept query arguments, to + restrict their scope. Multiple query terms can be provided to build up + a more complex query. - o Zero or more space-separated query terms. These are most often ac- - count name substrings: + o By default, a query term is interpreted as a case-insensitive sub- + string pattern for matching account names: - utilities food:groceries + car:fuel + dining groceries + o Patterns containing spaces or other special characters must be en- + closed in single or double quotes: - o Terms with spaces or other special characters should be enclosed in - quotes: + 'personal care' + o These patterns are actually regular expressions, so you can add reg- + exp metacharacters for more precision (see "Regular expressions" + above for details): - "personal care" - - o Regular expressions are also supported: - - "^expenses\b" - "accounts (payable|receivable)" - - o Add a query type prefix to match other parts of the data: + '^expenses\b' + 'food$' + 'fuel|repair' + 'accounts (payable|receivable)' + o To match something other than account name, add one of the query type + prefixes described in "Query types" below: date:202312- status: desc:amazon cur:USD - "amt:>0" - - o Add a not: prefix to negate: + cur:\\$ + amt:'>0' + o Add a not: prefix to negate a term: + not:status:'*' + not:desc:'opening|closing' not:cur:USD - - o Multiple unlike terms are AND-ed, multiple like terms are OR-ed + o Terms with different types are AND-ed, terms with the same type are + OR-ed (mostly; see "Combining query terms" below). The following + query: date:2022 desc:amazon desc:amzn - (all transactions with "amazon" or "amzn" in description during 2022) + + is interpreted as: + + date is in 2022 AND ( transaction description contains "amazon" OR + "amzn" ) Query types Here are the types of query term available. Remember these can also be prefixed with not: to convert them into a negative match. - acct:REGEX, REGEX - Match account names containing this (case insensitive) regular expres- - sion. This is the default query type when there is no prefix, and reg- - ular expression syntax is typically not needed, so usually we just - write an account name substring, like expenses or food. + acct:REGEX or REGEX + Match account names containing this case insensitive regular expres- + sion. This is the default query type, so we usually don't bother writ- + ing the "acct:" prefix. amt:N, amt:N, amt:>=N Match postings with a single-commodity amount equal to, less than, or @@ -4883,8 +4903,7 @@ Forecasting temporary "forecast transactions" for reporting purposes, according to periodic transaction rules defined in the journal. Each rule can gen- erate multiple recurring transactions, so by changing one rule you can - change many forecasted transactions. (These same rules can also gener- - ate budget goals, described in Budgeting.) + change many forecasted transactions. Forecast transactions usually start after ordinary transactions end. By default, they begin after your latest-dated ordinary transaction, or @@ -5210,8 +5229,6 @@ Cost reporting Downsides: - o This was added in hledger-1.29 and is still somewhat experimental. - o The precise format of the journal entry becomes more important. If hledger can't detect and match up the cost and equity postings, it will give a transaction balancing error. @@ -5840,8 +5857,8 @@ PART 4: COMMANDS It shows a flat list by default. With --tree, it uses indentation to show the account hierarchy. In flat mode you can add --drop N to omit - the first few account name components. Account names can be depth- - clipped with depth:N or --depth N or -N. + the first few account name components. Account names can be + depth-clipped with depth:N or --depth N or -N. With --types, it also shows each account's type, if it's known. (See Declaring accounts > Account types.) @@ -5959,81 +5976,84 @@ PART 4: COMMANDS Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ - On Microsoft Windows, the add command makes sure that no part of the - file path ends with a period, as that would cause problems (#1056). + If you enter a number with no commodity symbol, and you have declared a + default commodity with a D directive, you might expect add to add this + symbol for you. It does not do this; we assume that if you are using a + D directive you prefer not to see the commodity symbol repeated on + amounts in the journal. aregister (areg) - Show the transactions and running historical balance of a single ac- + Show the transactions and running historical balance of a single ac- count, with each transaction displayed as one line. aregister shows the overall transactions affecting a particular account - (and any subaccounts). Each report line represents one transaction in + (and any subaccounts). Each report line represents one transaction in this account. Transactions before the report start date are always in- cluded in the running balance (--historical mode is always on). - This is a more "real world", bank-like view than the register command - (which shows individual postings, possibly from multiple accounts, not + This is a more "real world", bank-like view than the register command + (which shows individual postings, possibly from multiple accounts, not necessarily in historical mode). As a quick rule of thumb: - use areg- ister for reviewing and reconciling real-world asset/liability accounts - use register for reviewing detailed revenues/expenses. - aregister requires one argument: the account to report on. You can - write either the full account name, or a case-insensitive regular ex- + aregister requires one argument: the account to report on. You can + write either the full account name, or a case-insensitive regular ex- pression which will select the alphabetically first matched account. When there are multiple matches, the alphabetically-first choice can be - surprising; eg if you have assets:per:checking 1 and assets:biz:check- - ing 2 accounts, hledger areg checking would select assets:biz:checking - 2. It's just a convenience to save typing, so if in doubt, write the + surprising; eg if you have assets:per:checking 1 and assets:biz:check- + ing 2 accounts, hledger areg checking would select assets:biz:checking + 2. It's just a convenience to save typing, so if in doubt, write the full account name, or a distinctive substring that matches uniquely. - Transactions involving subaccounts of this account will also be shown. - aregister ignores depth limits, so its final total will always match a + Transactions involving subaccounts of this account will also be shown. + aregister ignores depth limits, so its final total will always match a balance report with similar arguments. - Any additional arguments form a query which will filter the transac- + Any additional arguments form a query which will filter the transac- tions shown. Note some queries will disturb the running balance, caus- ing it to be different from the account's real-world running balance. - An example: this shows the transactions and historical running balance + An example: this shows the transactions and historical running balance during july, in the first account whose name contains "checking": $ hledger areg checking date:jul Each aregister line item shows: - o the transaction's date (or the relevant posting's date if different, + o the transaction's date (or the relevant posting's date if different, see below) - o the names of all the other account(s) involved in this transaction + o the names of all the other account(s) involved in this transaction (probably abbreviated) o the total change to this account's balance from this transaction o the account's historical running balance after this transaction. - Transactions making a net change of zero are not shown by default; add + Transactions making a net change of zero are not shown by default; add the -E/--empty flag to show them. - For performance reasons, column widths are chosen based on the first - 1000 lines; this means unusually wide values in later lines can cause - visual discontinuities as column widths are adjusted. If you want to - ensure perfect alignment, at the cost of more time and memory, use the + For performance reasons, column widths are chosen based on the first + 1000 lines; this means unusually wide values in later lines can cause + visual discontinuities as column widths are adjusted. If you want to + ensure perfect alignment, at the cost of more time and memory, use the --align-all flag. This command also supports the output destination and output format op- tions. The output formats supported are txt, csv, tsv, and json. aregister and posting dates - 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's postings may be within the report period. + 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's postings may be within the report period. To resolve this, aregister shows the earliest of the transaction's date and posting dates that is in-period, and the sum of the in-period post- - ings. In other words it will show a combined line item with just the - earliest date, and the running balance will (temporarily, until the + ings. In other words it will show a combined line item with just the + earliest date, and the running balance will (temporarily, until the transaction's last posting) be inaccurate. Use register -H if you need to see the individual postings. @@ -6046,19 +6066,19 @@ PART 4: COMMANDS Show accounts and their balances. - balance is one of hledger's oldest and most versatile commands, for - listing account balances, balance changes, values, value changes and + balance is one of hledger's oldest and most versatile commands, for + listing account balances, balance changes, values, value changes and more, during one time period or many. Generally it shows a table, with rows representing accounts, and columns representing periods. - Note there are some higher-level variants of the balance command with - convenient defaults, which can be simpler to use: balancesheet, bal- + Note there are some higher-level variants of the balance command with + convenient defaults, which can be simpler to use: balancesheet, bal- ancesheetequity, cashflow and incomestatement. When you need more con- trol, then use balance. balance features - Here's a quick overview of the balance command's features, followed by - more detailed descriptions and examples. Many of these work with the + Here's a quick overview of the balance command's features, followed by + more detailed descriptions and examples. Many of these work with the higher-level commands as well. balance can show.. @@ -6111,7 +6131,7 @@ PART 4: COMMANDS ..with.. - o totals (-T), averages (-A), percentages (-%), inverted sign (--in- + o totals (-T), averages (-A), percentages (-%), inverted sign (--in- vert) o rows and columns swapped (--transpose) @@ -6123,24 +6143,24 @@ PART 4: COMMANDS o commodities displayed on the same line or multiple lines (--layout) This command supports the output destination and output format options, - with output formats txt, csv, tsv, json, and (multi-period reports - only:) html. In txt output in a colour-supporting terminal, negative + with output formats txt, csv, tsv, json, and (multi-period reports + only:) html. In txt output in a colour-supporting terminal, negative amounts are shown in red. - The --related/-r flag shows the balance of the other postings in the + The --related/-r flag shows the balance of the other postings in the transactions of the postings which would normally be shown. Simple balance report - With no arguments, balance shows a list of all accounts and their - change of balance - ie, the sum of posting amounts, both inflows and - outflows - during the entire period of the journal. ("Simple" here - means just one column of numbers, covering a single period. You can + With no arguments, balance shows a list of all accounts and their + change of balance - ie, the sum of posting amounts, both inflows and + outflows - during the entire period of the journal. ("Simple" here + means just one column of numbers, covering a single period. You can also have multi-period reports, described later.) - For real-world accounts, these numbers will normally be their end bal- + For real-world accounts, these numbers will normally be their end bal- ance at the end of the journal period; more on this below. - Accounts are sorted by declaration order if any, and then alphabeti- + Accounts are sorted by declaration order if any, and then alphabeti- cally by account name. For instance (using examples/sample.journal): $ hledger -f examples/sample.journal bal @@ -6155,7 +6175,7 @@ PART 4: COMMANDS 0 Accounts with a zero balance (and no non-zero subaccounts, in tree mode - - see below) are hidden by default. Use -E/--empty to show them (re- + - see below) are hidden by default. Use -E/--empty to show them (re- vealing assets:bank:checking here): $ hledger -f examples/sample.journal bal -E @@ -6170,12 +6190,12 @@ PART 4: COMMANDS -------------------- 0 - The total of the amounts displayed is shown as the last line, unless + The total of the amounts displayed is shown as the last line, unless -N/--no-total is used. Balance report line format For single-period balance reports displayed in the terminal (only), you - can use --format FMT to customise the format and content of each line. + can use --format FMT to customise the format and content of each line. Eg: $ hledger -f examples/sample.journal balance --format "%20(account) %12(total)" @@ -6192,7 +6212,7 @@ PART 4: COMMANDS --------------------------------- 0 - The FMT format string specifies the formatting applied to each ac- + The FMT format string specifies the formatting applied to each ac- count/balance pair. It may contain any suitable text, with data fields interpolated like so: @@ -6204,14 +6224,14 @@ PART 4: COMMANDS o FIELDNAME must be enclosed in parentheses, and can be one of: - o depth_spacer - a number of spaces equal to the account's depth, or + o depth_spacer - a number of spaces equal to the account's depth, or if MIN is specified, MIN * depth spaces. o account - the account's name o total - the account's balance/posted total, right justified - Also, FMT can begin with an optional prefix to control how multi-com- + Also, FMT can begin with an optional prefix to control how multi-com- modity amounts are rendered: o %_ - render on multiple lines, bottom-aligned (the default) @@ -6221,25 +6241,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 + 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: @@ -6249,10 +6269,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 @@ -6272,26 +6292,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 @@ -6303,7 +6323,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: @@ -6314,53 +6334,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 @@ -6381,21 +6401,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 - --no-elide is used. (experimental) + o Amounts with many commodities are shown in abbreviated form, unless + --no-elide is used. - 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 @@ -6409,57 +6429,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 @@ -6471,57 +6491,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 @@ -6531,13 +6551,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 @@ -6545,24 +6565,24 @@ PART 4: COMMANDS For reference, here is what the combinations of accumulation and valua- tion show: - Valua- no valuation --value= then --value= end --value= YYYY- - tion:> MM-DD /now - Accumu- + Valua- no valuation --value= then --value= end --value= + tion:> YYYY-MM-DD + Accumu- /now lation:v ----------------------------------------------------------------------------------- - --change change in period sum of posting- period-end DATE-value of - 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 - 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 end bal- start to period start to period to period end - ance) end end + --change change in period sum of post- period-end DATE-value of + ing-date market value of change change in pe- + values in period in period riod + --cumu- change from re- sum of post- period-end DATE-value of + lative port start to ing-date market value of change change from + period end values from re- from report report start + port start to pe- start to period to period end + riod end end + --his- change from sum of post- period-end DATE-value of + torical journal start to ing-date market value of change change from + /-H period end (his- values from jour- from journal journal start + torical end bal- nal start to pe- start to period to period end + ance) riod end end Budget report The --budget report type is like a regular balance report, but with two @@ -6572,11 +6592,11 @@ PART 4: COMMANDS o Accounts which don't have budget goals are hidden by default. - This is useful for comparing planned and actual income, expenses, time + This is useful for comparing planned and actual income, expenses, time usage, etc. - Periodic transaction rules are used to define budget goals. For exam- - ple, here's a periodic rule defining monthly goals for bus travel and + Periodic transaction rules are used to define budget goals. For exam- + ple, here's a periodic rule defining monthly goals for bus travel and food expenses: ;; Budget @@ -6618,66 +6638,66 @@ PART 4: COMMANDS || 0 [ 0% of $430] 0 [ 0% of $430] This is "goal-based budgeting"; you define goals for accounts and peri- - ods, often recurring, and hledger shows performance relative to the - goals. This contrasts with "envelope budgeting", which is more de- - tailed and strict - useful when cash is tight, but also quite a bit - more work. https://plaintextaccounting.org/Budgeting has more on this + ods, often recurring, and hledger shows performance relative to the + goals. This contrasts with "envelope budgeting", which is more de- + tailed and strict - useful when cash is tight, but also quite a bit + more work. https://plaintextaccounting.org/Budgeting has more on this topic. Using the budget report - Historically this report has been confusing and fragile. hledger's - version should be relatively robust and intuitive, but you may still - find surprises. Here are more notes to help with learning and trou- + Historically this report has been confusing and fragile. hledger's + version should be relatively robust and intuitive, but you may still + find surprises. Here are more notes to help with learning and trou- bleshooting. - o In the above example, expenses:bus and expenses:food are shown be- + o In the above example, expenses:bus and expenses:food are shown be- cause they have budget goals during the report period. - o Their parent expenses is also shown, with budget goals aggregated + o Their parent expenses is also shown, with budget goals aggregated from the children. - o The subaccounts expenses:food:groceries and expenses:food:dining are - not shown since they have no budget goal of their own, but they con- + o The subaccounts expenses:food:groceries and expenses:food:dining are + not shown since they have no budget goal of their own, but they con- tribute to expenses:food's actual amount. - o Unbudgeted accounts expenses:movies and expenses:gifts are also not + o Unbudgeted accounts expenses:movies and expenses:gifts are also not shown, but they contribute to expenses's actual amount. - o The other unbudgeted accounts income and assets:bank:checking are + o The other unbudgeted accounts income and assets:bank:checking are grouped as . - o --depth or depth: can be used to limit report depth in the usual way + o --depth or depth: can be used to limit report depth in the usual way (but will not reveal unbudgeted subaccounts). o Amounts are always inclusive of subaccounts (even in -l/--list mode). o Numbers displayed in a --budget report will not always agree with the - totals, because of hidden unbudgeted accounts; this is normal. + totals, because of hidden unbudgeted accounts; this is normal. -E/--empty can be used to reveal the hidden accounts. o In the periodic rules used for setting budget goals, unbalanced post- ings are convenient. - o You can filter budget reports with the usual queries, eg to focus on - particular accounts. It's common to restrict them to just expenses. - (The account is occasionally hard to exclude; this is + o You can filter budget reports with the usual queries, eg to focus on + particular accounts. It's common to restrict them to just expenses. + (The account is occasionally hard to exclude; this is because of date surprises, discussed below.) - o When you have multiple currencies, you may want to convert them to - one (-X COMM --infer-market-prices) and/or show just one at a time - (cur:COMM). If you do need to show multiple currencies at once, + o When you have multiple currencies, you may want to convert them to + one (-X COMM --infer-market-prices) and/or show just one at a time + (cur:COMM). If you do need to show multiple currencies at once, --layout bare can be helpful. - o You can "roll over" amounts (actual and budgeted) to the next period + o You can "roll over" amounts (actual and budgeted) to the next period with --cumulative. See also: https://hledger.org/budgeting.html. Budget date surprises - With small data, or when starting out, some of the generated budget - goal transaction dates might fall outside the report periods. Eg with - the following journal and report, the first period appears to have no - expenses:food budget. (Also the account should be ex- + With small data, or when starting out, some of the generated budget + goal transaction dates might fall outside the report periods. Eg with + the following journal and report, the first period appears to have no + expenses:food budget. (Also the account should be ex- cluded by the expenses query, but isn't.): ~ monthly in 2020 @@ -6697,69 +6717,69 @@ PART 4: COMMANDS ---------------++-------------------- || $400 [80% of $500] - In this case, the budget goal transactions are generated on first days - of of month (this can be seen with hledger print --forecast tag:gener- - ated expenses). Whereas the report period defaults to just the 15th - day of january (this can be seen from the report table's column head- + In this case, the budget goal transactions are generated on first days + of of month (this can be seen with hledger print --forecast tag:gener- + ated expenses). Whereas the report period defaults to just the 15th + day of january (this can be seen from the report table's column head- ings). - To fix this kind of thing, be more explicit about the report period - (and/or the periodic rules' dates). In this case, adding -b 2020 does + To fix this kind of thing, be more explicit about the report period + (and/or the periodic rules' dates). In this case, adding -b 2020 does the trick. Selecting budget goals - 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 between period - expression and description), and then select from multiple budgets de- + regular expression or query). This means you can give your periodic + rules descriptions (remember that two spaces are needed between period + expression and description), and then select from multiple budgets de- fined in your journal. Budgeting vs forecasting - --budget and --forecast both use the periodic transaction rules in the - journal to generate temporary transactions for reporting purposes. - However they are separate features - though you can use both at the + --budget and --forecast both use the periodic transaction rules in the + journal to generate temporary transactions for reporting purposes. + However they are separate features - though you can use both at the same time if you want. Here are some differences between them: 1. --budget is a command-specific option; it selects the budget report. --forecast is a general option; forecasting works with all reports. - 2. --budget uses all periodic rules; --budget=DESCPAT uses just the + 2. --budget uses all periodic rules; --budget=DESCPAT uses just the rules matched by DESCPAT. --forecast uses all periodic rules. - 3. --budget's budget goal transactions are invisible, except that they + 3. --budget's budget goal transactions are invisible, except that they produce goal amounts. - --forecast's forecast transactions are visible, and appear in re- + --forecast's forecast transactions are visible, and appear in re- ports. - 4. --budget generates budget goal transactions throughout the report - period, optionally restricted by periods specified in the periodic + 4. --budget generates budget goal transactions throughout the report + period, optionally restricted by periods specified in the periodic transaction rules. --forecast generates forecast transactions from after the last reg- - ular transaction, to the end of the report period; while --fore- - cast=PERIODEXPR generates them throughout the specified period; - both optionally restricted by periods specified in the periodic + ular transaction, to the end of the report period; while --fore- + cast=PERIODEXPR generates them throughout the specified period; + both optionally restricted by periods specified in the periodic transaction rules. 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 @@ -6767,10 +6787,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 @@ -6793,7 +6813,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 @@ -6805,7 +6825,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 @@ -6825,7 +6845,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 @@ -6845,7 +6865,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 @@ -6863,14 +6883,14 @@ 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 - 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: + its own column and each row represents a single data point. See + https://cran.r-project.org/web/packages/tidyr/vi- + gnettes/tidy-data.html for more. This is the easiest kind of data + for other software to consume. Here's how it looks: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy "account","period","start_date","end_date","commodity","value" @@ -6966,8 +6986,7 @@ PART 4: COMMANDS flipped. This command also supports the output destination and output format op- - tions The output formats supported are txt, csv, tsv, html, and (exper- - imental) json. + tions The output formats supported are txt, csv, tsv, html, and json. balancesheetequity (bse) @@ -7062,8 +7081,7 @@ PART 4: COMMANDS not:receivable, but with smarter account detection. This command also supports the output destination and output format op- - tions The output formats supported are txt, csv, tsv, html, and (exper- - imental) json. + tions The output formats supported are txt, csv, tsv, html, and json. check Check for various kinds of errors in your data. @@ -7155,99 +7173,124 @@ 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 - end of accounting period. + A transaction-generating command which generates several kinds of + "closing" and/or "opening" transactions useful in certain situations. + It prints one or two transactions to stdout, but does not write them to + the journal file; you can append or copy them there when you are happy + with the output. - 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. + This command is most often used when migrating balances to a new jour- + nal file, at the start of a new financial year. It can also be used to + "retain earnings" (transfer revenues and expenses to equity), or as a + sort of generic mover of balances from any group of accounts to some + other account. So it currently has six modes, selected by a mode flag. + Use only one of these flags at a time: - (experimental) - - 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 - accounts matched by the provided ACCTQUERY arguments. + 1. With --close (or no mode flag) it prints a "closing balances" trans- + action that zeroes out all the asset, liability, and equity account + balances, by default (this requires inferred or declared account + types). Or, it will zero out the accounts matched by any ACCTQUERY + arguments you provide. All of the balances are transferred to a + special "opening/closing balances" equity account. 2. With --open, it prints an opposite "opening balances" transaction - that restores those balances from zero. This is similar to Ledger's - equity command. + that restores the same account balances, starting from zero. This + mode 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 - other out, preserving correct balances during multi-file reporting. + 3. With --migrate, it prints both the closing and opening transactions + above. This is a common way to migrate balances to a new file at + year end; run hledger close --migrate -e NEWYEAR (-e influences the + transaction date) and add the closing transaction at the end of the + old file, and the opening transaction at the start of the new file. + Doing this means you can include past year files in your reports at + any time without disturbing asset/liability/equity balances, because + the closing balances transaction cancels out the following opening + balances transaction. You will sometimes need to exclude these + transactions from reports, eg to see an end of year balance sheet; a + not:opening/closing query argument should do. You should probably + also use this query when close-ing, to exclude the "opening/closing + balances" account which might otherwise cause problems. Or you can + just migrate assets and liabilities: hledger close type:AL. Most + people don't need to migrate equity. And revenues and expenses usu- + ally should not be migrated. - 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 - (A=L+E) satisfied. + 4. With --assert it prints a "closing balances" transaction that just + asserts the current balances, without changing them. This can be + useful as documention and to guard against errors and changes. - In all modes, the defaults can be overridden: + 5. With --assign it prints an "opening balances" transaction that re- + stores the account balances using balance assignments. Balance as- + signments work regardless of any previous balance, so a preceding + closing balances transaction is not needed. This is an alternative + to --close and --open: at year end, hledger close --assert -e + NEWYEAR in the old file (optional, but useful for error checking), + and hledger close --assign -e NEWYEAR in the new file. This might + be more convenient, eg if you are often doing cleanups or fixes + which would break closing/opening transactions. + + 6. With --retain, it prints a "retain earnings" transaction that trans- + fers revenue and expense balances to equity:retained earnings. This + is a traditional end-of-period bookkeeping operation also called + "closing the books"; in personal accounting you probably will not + need this but it could be useful if you want to see the accounting + equation (A=L+E) balanced. + + In all modes, the following things can be overridden: 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 account to transfer to and 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- - day transactions: + To solve that you can transfer the money to and from a temporary ac- + count, in effect splitting the multi-day transaction into two sin- + gle-day transactions: ; in 2022.journal: 2022-12-30 a purchase made in december, cleared in january @@ -7265,36 +7308,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 @@ -7320,7 +7363,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 @@ -7333,13 +7376,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. @@ -7379,19 +7422,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: @@ -7404,7 +7447,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: @@ -7415,18 +7458,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. @@ -7443,30 +7486,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 @@ -7477,75 +7520,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 @@ -7561,17 +7604,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 @@ -7581,13 +7624,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: @@ -7614,21 +7657,20 @@ 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- - tions The output formats supported are txt, csv, tsv, html, and (exper- - imental) json. + tions The output formats supported are txt, csv, tsv, html, and json. notes 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: @@ -7640,14 +7682,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: @@ -7658,19 +7700,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 @@ -7679,9 +7721,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: @@ -7701,54 +7743,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. @@ -7757,7 +7799,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. @@ -7768,37 +7810,37 @@ 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, as follows: + The beancount format tries to produce Beancount-compatible output, as + follows: - o Transaction and postings with unmarked status are converted to + o Transaction and postings with unmarked status are converted to cleared (*) status. - o Transactions' payee and note are backslash-escaped and double-quote- - escaped and wrapped in double quotes. + o Transactions' payee and note are backslash-escaped and dou- + ble-quote-escaped and wrapped in double quotes. o Transaction tags are copied to Beancount #tag format. - o Commodity symbols are converted to upper case, and a small number of - currency symbols like $ are converted to the corresponding currency + o Commodity symbols are converted to upper case, and a small number of + currency symbols like $ are converted to the corresponding currency names. 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 + 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.) @@ -7831,20 +7873,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 @@ -7853,14 +7895,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 @@ -7871,14 +7913,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 @@ -7888,18 +7930,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 @@ -7911,7 +7953,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 @@ -7928,7 +7970,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 @@ -7936,22 +7978,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): @@ -7970,8 +8012,7 @@ 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- - tal) json. + tions The output formats supported are txt, csv, tsv, and json. rewrite Print all transactions, rewriting the postings of matched transactions. @@ -8249,12 +8290,12 @@ PART 4: COMMANDS 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 - 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 - your investment, and make TWR less sensitive than IRR to the effects of - cash in-flows and out-flows. + TWR represents your investment as an imaginary "unit fund" where + in-flows/ out-flows lead to buying or selling "units" of your invest- + ment and changes in its value change the value of "investment unit". + Change in "unit price" over the reporting period gives you rate of re- + turn of your investment, and make TWR less sensitive than IRR to the + effects of cash in-flows and out-flows. References: @@ -8301,8 +8342,8 @@ PART 4: COMMANDS Run time : 0.12 s Throughput : 8342 txns/s - This command supports the -o/--output-file option (but not -O/--output- - format selection). + This command supports the -o/--output-file option (but not -O/--out- + put-format selection). tags List the tags used in the journal, or their values. @@ -8310,35 +8351,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 -- @@ -8347,11 +8388,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 @@ -8361,37 +8402,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 @@ -8399,9 +8440,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 @@ -8427,28 +8468,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 @@ -8456,20 +8497,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 @@ -8479,19 +8520,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 @@ -8528,18 +8569,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 @@ -8555,22 +8596,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: @@ -8580,26 +8621,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 @@ -8671,7 +8712,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 @@ -8681,7 +8722,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 @@ -8748,70 +8789,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 @@ -8824,7 +8865,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. @@ -8845,4 +8886,4 @@ LICENSE SEE ALSO hledger(1), hledger-ui(1), hledger-web(1), ledger(1) -hledger-1.32.99 December 2023 HLEDGER(1) +hledger-1.32.99 January 2024 HLEDGER(1)