diff --git a/hledger-lib/.date.m4 b/hledger-lib/.date.m4 index fe58c8a96..4be5270d1 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_}}, {{August 2021}})m4_dnl +m4_define({{_monthyear_}}, {{September 2021}})m4_dnl diff --git a/hledger-ui/.date.m4 b/hledger-ui/.date.m4 index fe58c8a96..4be5270d1 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_}}, {{August 2021}})m4_dnl +m4_define({{_monthyear_}}, {{September 2021}})m4_dnl diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1 index 846574ea0..06bcd6b0d 100644 --- a/hledger-ui/hledger-ui.1 +++ b/hledger-ui/hledger-ui.1 @@ -1,5 +1,5 @@ -.TH "HLEDGER-UI" "1" "August 2021" "hledger-ui-1.22.99 " "hledger User Manuals" +.TH "HLEDGER-UI" "1" "September 2021" "hledger-ui-1.22.99 " "hledger User Manuals" diff --git a/hledger-ui/hledger-ui.info b/hledger-ui/hledger-ui.info index 8611c3f60..f534c9d84 100644 --- a/hledger-ui/hledger-ui.info +++ b/hledger-ui/hledger-ui.info @@ -1,4 +1,5 @@ -This is hledger-ui.info, produced by makeinfo version 6.8 from stdin. +This is hledger-ui/hledger-ui.info, produced by makeinfo version 4.8 +from stdin. INFO-DIR-SECTION User Applications START-INFO-DIR-ENTRY @@ -6,36 +7,36 @@ START-INFO-DIR-ENTRY END-INFO-DIR-ENTRY  -File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir) +File: hledger-ui.info, Node: Top, Up: (dir) hledger-ui(1) ************* hledger-ui is a terminal interface (TUI) for the hledger accounting -tool. This manual is for hledger-ui 1.22.99. +tool. This manual is for hledger-ui 1.22.99. - 'hledger-ui [OPTIONS] [QUERYARGS]' -'hledger ui -- [OPTIONS] [QUERYARGS]' + `hledger-ui [OPTIONS] [QUERYARGS]' +`hledger ui -- [OPTIONS] [QUERYARGS]' hledger is a reliable, cross-platform set of programs for tracking money, time, or any other commodity, using double-entry accounting and a -simple, editable file format. hledger is inspired by and largely +simple, editable file format. hledger is inspired by and largely compatible with ledger(1). hledger-ui is hledger's terminal interface, providing an efficient full-window text UI for viewing accounts and transactions, and some -limited data entry capability. It is easier than hledger's command-line +limited data entry capability. It is easier than hledger's command-line interface, and sometimes quicker and more convenient than the web interface. Like hledger, it reads data from one or more files in hledger -journal, timeclock, timedot, or CSV format specified with '-f', or -'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps -'C:/Users/USER/.hledger.journal'). For more about this see hledger(1), +journal, timeclock, timedot, or CSV format specified with `-f', or +`$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps +`C:/Users/USER/.hledger.journal'). For more about this see hledger(1), hledger_journal(5) etc. Unlike hledger, hledger-ui hides all future-dated transactions by -default. They can be revealed, along with any rule-generated periodic +default. They can be revealed, along with any rule-generated periodic transactions, by pressing the F key (or starting with -forecast) to enable "forecast mode". @@ -55,146 +56,143 @@ File: hledger-ui.info, Node: OPTIONS, Next: KEYS, Prev: Top, Up: Top 1 OPTIONS ********* -Note: if invoking hledger-ui as a hledger subcommand, write '--' before +Note: if invoking hledger-ui as a hledger subcommand, write `--' before options as shown above. Any QUERYARGS are interpreted as a hledger search query which filters the data. -'--watch' - +`--watch' watch for data and date changes and reload automatically -'--theme=default|terminal|greenterm' +`--theme=default|terminal|greenterm' use this custom display theme -'--register=ACCTREGEX' +`--register=ACCTREGEX' start in the (first) matched account's register screen -'--change' +`--change' show period balances (changes) at startup instead of historical balances -'-l --flat' +`-l --flat' show accounts as a flat list (default) -'-t --tree' +`-t --tree' show accounts as a tree hledger input options: -'-f FILE --file=FILE' - - use a different input file. For stdin, use - (default: - '$LEDGER_FILE' or '$HOME/.hledger.journal') -'--rules-file=RULESFILE' +`-f FILE --file=FILE' + use a different input file. For stdin, use - (default: + `$LEDGER_FILE' or `$HOME/.hledger.journal') +`--rules-file=RULESFILE' Conversion rules file to use when reading CSV (default: FILE.rules) -'--separator=CHAR' +`--separator=CHAR' Field separator to expect when reading CSV (default: ',') -'--alias=OLD=NEW' +`--alias=OLD=NEW' rename accounts named OLD to NEW -'--anon' +`--anon' anonymize accounts and payees -'--pivot FIELDNAME' +`--pivot FIELDNAME' use some other field or tag for the account name -'-I --ignore-assertions' +`-I --ignore-assertions' disable balance assertion checks (note: does not disable balance assignments) -'-s --strict' +`-s --strict' do extra error checking (check that all posted accounts are declared) hledger reporting options: -'-b --begin=DATE' - +`-b --begin=DATE' include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) -'-e --end=DATE' +`-e --end=DATE' include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) -'-D --daily' +`-D --daily' multiperiod/multicolumn report by day -'-W --weekly' +`-W --weekly' multiperiod/multicolumn report by week -'-M --monthly' +`-M --monthly' multiperiod/multicolumn report by month -'-Q --quarterly' +`-Q --quarterly' multiperiod/multicolumn report by quarter -'-Y --yearly' +`-Y --yearly' multiperiod/multicolumn report by year -'-p --period=PERIODEXP' +`-p --period=PERIODEXP' set start date, end date, and/or reporting interval all at once using period expressions syntax -'--date2' +`--date2' match the secondary date instead (see command help for other effects) -'-U --unmarked' +`-U --unmarked' include only unmarked postings/txns (can combine with -P or -C) -'-P --pending' +`-P --pending' include only pending postings/txns -'-C --cleared' +`-C --cleared' include only cleared postings/txns -'-R --real' +`-R --real' include only non-virtual postings -'-NUM --depth=NUM' +`-NUM --depth=NUM' hide/aggregate accounts or postings more than NUM levels deep -'-E --empty' +`-E --empty' show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) -'-B --cost' +`-B --cost' convert amounts to their cost/selling amount at transaction time -'-V --market' +`-V --market' convert amounts to their market value in default valuation commodities -'-X --exchange=COMM' +`-X --exchange=COMM' convert amounts to their market value in commodity COMM -'--value' +`--value' convert amounts to cost or market value, more flexibly than -B/-V/-X -'--infer-market-prices' +`--infer-market-prices' use transaction prices (recorded with @ or @@) as additional market prices, as if they were P directives -'--auto' +`--auto' apply automated posting rules to modify transactions. -'--forecast' +`--forecast' generate future transactions from periodic transaction rules, for - the next 6 months or till report end date. In hledger-ui, also + the next 6 months or till report end date. In hledger-ui, also make ordinary future transactions visible. -'--color=WHEN (or --colour=WHEN)' +`--color=WHEN (or --colour=WHEN)' Should color-supporting commands use ANSI color codes in text output. 'auto' (default): whenever stdout seems to be a color-supporting terminal. 'always' or 'yes': always, useful eg - when piping output into 'less -R'. 'never' or 'no': never. A + when piping output into 'less -R'. 'never' or 'no': never. A NO_COLOR environment variable overrides this. When a reporting option appears more than once in the command line, @@ -204,25 +202,24 @@ the last one takes precedence. hledger help options: -'-h --help' - +`-h --help' show general or COMMAND help -'--man' +`--man' show general or COMMAND user manual with man -'--info' +`--info' show general or COMMAND user manual with info -'--version' +`--version' show general or ADDONCMD version -'--debug[=N]' +`--debug[=N]' show debug output (levels 1-9, default: 1) A @FILE argument will be expanded to the contents of FILE, which -should contain one command line option/argument per line. (To prevent -this, insert a '--' argument before.) +should contain one command line option/argument per line. (To prevent +this, insert a `--' argument before.)  File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top @@ -230,89 +227,89 @@ File: hledger-ui.info, Node: KEYS, Next: SCREENS, Prev: OPTIONS, Up: Top 2 KEYS ****** -'?' shows a help dialog listing all keys. (Some of these also appear in -the quick help at the bottom of each screen.) Press '?' again (or -'ESCAPE', or 'LEFT', or 'q') to close it. The following keys work on +`?' shows a help dialog listing all keys. (Some of these also appear in +the quick help at the bottom of each screen.) Press `?' again (or +`ESCAPE', or `LEFT', or `q') to close it. The following keys work on most screens: - The cursor keys navigate: 'right' (or 'enter') goes deeper, 'left' -returns to the previous screen, 'up'/'down'/'page up'/'page -down'/'home'/'end' move up and down through lists. Emacs-style -('ctrl-p'/'ctrl-n'/'ctrl-f'/'ctrl-b') movement keys are also supported + The cursor keys navigate: `right' (or `enter') goes deeper, `left' +returns to the previous screen, `up'/`down'/`page up'/`page +down'/`home'/`end' move up and down through lists. Emacs-style +(`ctrl-p'/`ctrl-n'/`ctrl-f'/`ctrl-b') movement keys are also supported (but not vi-style keys, since hledger-1.19, sorry!). A tip: movement speed is limited by your keyboard repeat rate, to move faster you may -want to adjust it. (If you're on a mac, the karabiner app is one way to +want to adjust it. (If you're on a mac, the karabiner app is one way to do that.) With shift pressed, the cursor keys adjust the report period, limiting the transactions to be shown (by default, all are shown). -'shift-down/up' steps downward and upward through these standard report -period durations: year, quarter, month, week, day. Then, -'shift-left/right' moves to the previous/next period. 'T' sets the -report period to today. With the '--watch' option, when viewing a +`shift-down/up' steps downward and upward through these standard report +period durations: year, quarter, month, week, day. Then, +`shift-left/right' moves to the previous/next period. `T' sets the +report period to today. With the `--watch' option, when viewing a "current" period (the current day, week, month, quarter, or year), the -period will move automatically to track the current date. To set a -non-standard period, you can use '/' and a 'date:' query. +period will move automatically to track the current date. To set a +non-standard period, you can use `/' and a `date:' query. - '/' lets you set a general filter query limiting the data shown, -using the same query terms as in hledger and hledger-web. While editing -the query, you can use CTRL-a/e/d/k, BS, cursor keys; press 'ENTER' to -set it, or 'ESCAPE'to cancel. There are also keys for quickly adjusting + `/' lets you set a general filter query limiting the data shown, +using the same query terms as in hledger and hledger-web. While editing +the query, you can use CTRL-a/e/d/k, BS, cursor keys; press `ENTER' to +set it, or `ESCAPE'to cancel. There are also keys for quickly adjusting some common filters like account depth and transaction status (see -below). 'BACKSPACE' or 'DELETE' removes all filters, showing all +below). `BACKSPACE' or `DELETE' removes all filters, showing all transactions. As mentioned above, by default hledger-ui hides future transactions - both ordinary transactions recorded in the journal, and periodic -transactions generated by rule. 'F' toggles forecast mode, in which +transactions generated by rule. `F' toggles forecast mode, in which future/forecasted transactions are shown. - 'ESCAPE' resets the UI state and jumps back to the top screen, -restoring the app's initial state at startup. Or, it cancels minibuffer + `ESCAPE' resets the UI state and jumps back to the top screen, +restoring the app's initial state at startup. Or, it cancels minibuffer data entry or the help dialog. - 'CTRL-l' redraws the screen and centers the selection if possible + `CTRL-l' redraws the screen and centers the selection if possible (selections near the top won't be centered, since we don't scroll above the top). - 'g' reloads from the data file(s) and updates the current screen and -any previous screens. (With large files, this could cause a noticeable + `g' reloads from the data file(s) and updates the current screen and +any previous screens. (With large files, this could cause a noticeable pause.) - 'I' toggles balance assertion checking. Disabling balance assertions + `I' toggles balance assertion checking. Disabling balance assertions temporarily can be useful for troubleshooting. - 'a' runs command-line hledger's add command, and reloads the updated -file. This allows some basic data entry. + `a' runs command-line hledger's add command, and reloads the updated +file. This allows some basic data entry. - 'A' is like 'a', but runs the hledger-iadd tool, which provides a -terminal interface. This key will be available if 'hledger-iadd' is + `A' is like `a', but runs the hledger-iadd tool, which provides a +terminal interface. This key will be available if `hledger-iadd' is installed in $path. - 'E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default ('emacsclient --a "" -nw') on the journal file. With some editors (emacs, vi), the + `E' runs $HLEDGER_UI_EDITOR, or $EDITOR, or a default (`emacsclient +-a "" -nw') on the journal file. With some editors (emacs, vi), the cursor will be positioned at the current transaction when invoked from the register and transaction screens, and at the error location (if possible) when invoked from the error screen. - 'B' toggles cost mode, showing amounts in their transaction price's -commodity (like toggling the '-B/--cost' flag). + `B' toggles cost mode, showing amounts in their transaction price's +commodity (like toggling the `-B/--cost' flag). - 'V' toggles value mode, showing amounts' current market value in -their default valuation commodity (like toggling the '-V/--market' -flag). Note, "current market value" means the value on the report end -date if specified, otherwise today. To see the value on another date, -you can temporarily set that as the report end date. Eg: to see a + `V' toggles value mode, showing amounts' current market value in +their default valuation commodity (like toggling the `-V/--market' +flag). Note, "current market value" means the value on the report end +date if specified, otherwise today. To see the value on another date, +you can temporarily set that as the report end date. Eg: to see a transaction as it was valued on july 30, go to the accounts or register -screen, press '/', and add 'date:-7/30' to the query. +screen, press `/', and add `date:-7/30' to the query. At most one of cost or value mode can be active at once. There's not yet any visual reminder when cost or value mode is -active; for now pressing 'b' 'b' 'v' should reliably reset to normal +active; for now pressing `b' `b' `v' should reliably reset to normal mode. - 'q' quits the application. + `q' quits the application. Additional screen-specific keys are described below. @@ -335,48 +332,47 @@ File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Up: SCRE 3.1 Accounts screen =================== -This is normally the first screen displayed. It lists accounts and -their balances, like hledger's balance command. By default, it shows -all accounts and their latest ending balances (including the balances of -subaccounts). If you specify a query on the command line, it shows just +This is normally the first screen displayed. It lists accounts and their +balances, like hledger's balance command. By default, it shows all +accounts and their latest ending balances (including the balances of +subaccounts). If you specify a query on the command line, it shows just the matched accounts and the balances from matched transactions. - Account names are shown as a flat list by default; press 't' to -toggle tree mode. In list mode, account balances are exclusive of + Account names are shown as a flat list by default; press `t' to +toggle tree mode. In list mode, account balances are exclusive of subaccounts, except where subaccounts are hidden by a depth limit (see -below). In tree mode, all account balances are inclusive of -subaccounts. +below). In tree mode, all account balances are inclusive of subaccounts. - To see less detail, press a number key, '1' to '9', to set a depth -limit. Or use '-' to decrease and '+'/'=' to increase the depth limit. -'0' shows even less detail, collapsing all accounts to a single total. -To remove the depth limit, set it higher than the maximum account depth, -or press 'ESCAPE'. + To see less detail, press a number key, `1' to `9', to set a depth +limit. Or use `-' to decrease and `+'/`=' to increase the depth limit. +`0' shows even less detail, collapsing all accounts to a single total. +To remove the depth limit, set it higher than the maximum account +depth, or press `ESCAPE'. - 'H' toggles between showing historical balances or period balances. + `H' toggles between showing historical balances or period balances. Historical balances (the default) are ending balances at the end of the report period, taking into account all transactions before that date (filtered by the filter query if any), including transactions before the -start of the report period. In other words, historical balances are -what you would see on a bank statement for that account (unless -disturbed by a filter query). Period balances ignore transactions -before the report start date, so they show the change in balance during -the report period. They are more useful eg when viewing a time log. +start of the report period. In other words, historical balances are what +you would see on a bank statement for that account (unless disturbed by +a filter query). Period balances ignore transactions before the report +start date, so they show the change in balance during the report period. +They are more useful eg when viewing a time log. - 'U' toggles filtering by unmarked status, including or excluding -unmarked postings in the balances. Similarly, 'P' toggles pending -postings, and 'C' toggles cleared postings. (By default, balances + `U' toggles filtering by unmarked status, including or excluding +unmarked postings in the balances. Similarly, `P' toggles pending +postings, and `C' toggles cleared postings. (By default, balances include all postings; if you activate one or two status filters, only those postings are included; and if you activate all three, the filter is removed.) - 'R' toggles real mode, in which virtual postings are ignored. + `R' toggles real mode, in which virtual postings are ignored. - 'Z' toggles nonzero mode, in which only accounts with nonzero + `Z' toggles nonzero mode, in which only accounts with nonzero balances are shown (hledger-ui shows zero items by default, unlike command-line hledger). - Press 'right' or 'enter' to view an account's transactions register. + Press `right' or `enter' to view an account's transactions register.  File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Accounts screen, Up: SCREENS @@ -385,44 +381,46 @@ File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: =================== This screen shows the transactions affecting a particular account, like -a check register. Each line represents one transaction and shows: +a check register. Each line represents one transaction and shows: - * the other account(s) involved, in abbreviated form. (If there are - both real and virtual postings, it shows only the accounts affected - by real postings.) + * the other account(s) involved, in abbreviated form. (If there are + both real and virtual postings, it shows only the accounts + affected by real postings.) * the overall change to the current account's balance; positive for an inflow to this account, negative for an outflow. * the running historical total or period total for the current - account, after the transaction. This can be toggled with 'H'. - Similar to the accounts screen, the historical total is affected by - transactions (filtered by the filter query) before the report start - date, while the period total is not. If the historical total is - not disturbed by a filter query, it will be the running historical - balance you would see on a bank register for the current account. + account, after the transaction. This can be toggled with `H'. + Similar to the accounts screen, the historical total is affected + by transactions (filtered by the filter query) before the report + start date, while the period total is not. If the historical total + is not disturbed by a filter query, it will be the running + historical balance you would see on a bank register for the + current account. + Transactions affecting this account's subaccounts will be included in the register if the accounts screen is in tree mode, or if it's in list mode but this account has subaccounts which are not shown due to a depth -limit. In other words, the register always shows the transactions -contributing to the balance shown on the accounts screen. Tree -mode/list mode can be toggled with 't' here also. +limit. In other words, the register always shows the transactions +contributing to the balance shown on the accounts screen. Tree mode/list +mode can be toggled with `t' here also. - 'U' toggles filtering by unmarked status, showing or hiding unmarked -transactions. Similarly, 'P' toggles pending transactions, and 'C' -toggles cleared transactions. (By default, transactions with all + `U' toggles filtering by unmarked status, showing or hiding unmarked +transactions. Similarly, `P' toggles pending transactions, and `C' +toggles cleared transactions. (By default, transactions with all statuses are shown; if you activate one or two status filters, only those transactions are shown; and if you activate all three, the filter is removed.) - 'R' toggles real mode, in which virtual postings are ignored. + `R' toggles real mode, in which virtual postings are ignored. - 'Z' toggles nonzero mode, in which only transactions posting a + `Z' toggles nonzero mode, in which only transactions posting a nonzero change are shown (hledger-ui shows zero items by default, unlike command-line hledger). - Press 'right' (or 'enter') to view the selected transaction in + Press `right' (or `enter') to view the selected transaction in detail.  @@ -440,11 +438,11 @@ description, comments, along with all of its account postings are shown. Simple transactions have two postings, but there can be more (or in certain cases, fewer). - 'up' and 'down' will step through all transactions listed in the -previous account register screen. In the title bar, the numbers in -parentheses show your position within that account register. They will + `up' and `down' will step through all transactions listed in the +previous account register screen. In the title bar, the numbers in +parentheses show your position within that account register. They will vary depending on which account register you came from (remember most -transactions appear in multiple account registers). The #N number +transactions appear in multiple account registers). The #N number preceding them is the transaction's position within the complete unfiltered journal, which is a more stable id (at least until the next reload). @@ -456,8 +454,8 @@ File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCRE ================ This screen will appear if there is a problem, such as a parse error, -when you press g to reload. Once you have fixed the problem, press g -again to reload and resume normal operation. (Or, you can press escape +when you press g to reload. Once you have fixed the problem, press g +again to reload and resume normal operation. (Or, you can press escape to cancel the reload attempt.)  @@ -477,20 +475,21 @@ File: hledger-ui.info, Node: Watch mode, Next: Watch mode limitations, Up: TI 4.1 Watch mode ============== -One of hledger-ui's best features is the auto-reloading '--watch' mode. +One of hledger-ui's best features is the auto-reloading `--watch' mode. With this flag, it will update the display automatically whenever changes are saved to the data files. - This is very useful when reconciling. A good workflow is to have -your bank's online register open in a browser window, for reference; the + This is very useful when reconciling. A good workflow is to have your +bank's online register open in a browser window, for reference; the journal file open in an editor window; and hledger-ui in watch mode in a terminal window, eg: + $ hledger-ui --watch --register checking -C 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 +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 toggle cleared mode, or to explore the history. @@ -501,28 +500,29 @@ File: hledger-ui.info, Node: Watch mode limitations, Prev: Watch mode, Up: TI ========================== There are situations in which it won't work, ie the display will not -update when you save a change (because the underlying 'inotify' library -does not support it). Here are some that we know of: +update when you save a change (because the underlying `inotify' library +does not support it). Here are some that we know of: - * Certain editors: saving with 'gedit', and perhaps any Gnome - application, won't be detected (#1617). Jetbrains IDEs, such as + * Certain editors: saving with `gedit', and perhaps any Gnome + application, won't be detected (#1617). Jetbrains IDEs, such as IDEA, also may not work (#911). - * Certain unusual filesystems might not be supported. (All the usual + * Certain unusual filesystems might not be supported. (All the usual ones on unix, mac and windows are supported.) + In such cases, the workaround is to switch to the hledger-ui window -and press 'g' each time you want it to reload. (Actually, see #1617 for +and press `g' each time you want it to reload. (Actually, see #1617 for another workaround, and let us know if it works for you.) - If you leave 'hledger-ui --watch' running for days, on certain + If you leave `hledger-ui --watch' running for days, on certain platforms (?), perhaps with many transactions in your journal (?), perhaps with large numbers of other files present (?), you may see it -gradually using more and more memory and CPU over time, as seen in 'top' -or Activity Monitor or Task Manager. +gradually using more and more memory and CPU over time, as seen in +`top' or Activity Monitor or Task Manager. - A workaround is to 'q'uit and restart it, or to suspend it ('CTRL-z') -and restart it ('fg') if your shell supports that. + A workaround is to `q'uit and restart it, or to suspend it +(`CTRL-z') and restart it (`fg') if your shell supports that.  File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: TIPS, Up: Top @@ -530,27 +530,28 @@ File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: TIPS, Up: Top 5 ENVIRONMENT ************* -*COLUMNS* The screen width to use. Default: the full terminal width. +*COLUMNS* The screen width to use. Default: the full terminal width. - *LEDGER_FILE* The journal file path when not specified with '-f'. -Default: '~/.hledger.journal' (on windows, perhaps -'C:/Users/USER/.hledger.journal'). + *LEDGER_FILE* The journal file path when not specified with `-f'. +Default: `~/.hledger.journal' (on windows, perhaps +`C:/Users/USER/.hledger.journal'). - A typical value is '~/DIR/YYYY.journal', where DIR is a -version-controlled finance directory and YYYY is the current year. Or -'~/DIR/current.journal', where current.journal is a symbolic link to + A typical value is `~/DIR/YYYY.journal', where DIR is a +version-controlled finance directory and YYYY is the current year. Or +`~/DIR/current.journal', where current.journal is a symbolic link to YYYY.journal. - On Mac computers, you can set this and other environment variables in -a more thorough way that also affects applications started from the GUI -(say, an Emacs dock icon). Eg on MacOS Catalina I have a -'~/.MacOSX/environment.plist' file containing + On Mac computers, you can set this and other environment variables +in a more thorough way that also affects applications started from the +GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a +`~/.MacOSX/environment.plist' file containing + { "LEDGER_FILE" : "~/finance/current.journal" } - To see the effect you may need to 'killall Dock', or reboot. + To see the effect you may need to `killall Dock', or reboot.  File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top @@ -559,9 +560,9 @@ File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top ******* Reads data from one or more files in hledger journal, timeclock, -timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or -'$HOME/.hledger.journal' (on windows, perhaps -'C:/Users/USER/.hledger.journal'). +timedot, or CSV format specified with `-f', or `$LEDGER_FILE', or +`$HOME/.hledger.journal' (on windows, perhaps +`C:/Users/USER/.hledger.journal').  File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top @@ -569,18 +570,18 @@ File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top 7 BUGS ****** -The need to precede options with '--' when invoked from hledger is +The need to precede options with `--' when invoked from hledger is awkward. - '-f-' doesn't work (hledger-ui can't read from stdin). + `-f-' doesn't work (hledger-ui can't read from stdin). - '-V' affects only the accounts screen. + `-V' affects only the accounts screen. - When you press 'g', the current and all previous screens are -regenerated, which may cause a noticeable pause with large files. Also + When you press `g', the current and all previous screens are +regenerated, which may cause a noticeable pause with large files. Also there is no visual indication that this is in progress. - '--watch' is not yet fully robust. It works well for normal usage, + `--watch' is not yet fully robust. It works well for normal usage, but many file changes in a short time (eg saving the file thousands of times with an editor macro) can cause problems at least on OSX. Symptoms include: unresponsive UI, periodic resetting of the cursor position, @@ -589,41 +590,37 @@ and possibly a small but persistent build-up of CPU usage until the program is restarted. Also, if you are viewing files mounted from another machine, -'--watch' requires that both machine clocks are roughly in step. +`--watch' requires that both machine clocks are roughly in step. +  Tag Table: -Node: Top221 -Node: OPTIONS1647 -Ref: #options1744 -Node: KEYS6145 -Ref: #keys6240 -Node: SCREENS10311 -Ref: #screens10409 -Node: Accounts screen10499 -Ref: #accounts-screen10627 -Node: Register screen12842 -Ref: #register-screen12997 -Node: Transaction screen14994 -Ref: #transaction-screen15152 -Node: Error screen16022 -Ref: #error-screen16144 -Node: TIPS16388 -Ref: #tips16487 -Node: Watch mode16539 -Ref: #watch-mode16656 -Node: Watch mode limitations17402 -Ref: #watch-mode-limitations17543 -Node: ENVIRONMENT18679 -Ref: #environment18790 -Node: FILES19597 -Ref: #files19696 -Node: BUGS19909 -Ref: #bugs19986 +Node: Top232 +Node: OPTIONS1637 +Ref: #options1734 +Node: KEYS6129 +Ref: #keys6224 +Node: SCREENS10273 +Ref: #screens10371 +Node: Accounts screen10461 +Ref: #accounts-screen10589 +Node: Register screen12793 +Ref: #register-screen12948 +Node: Transaction screen14943 +Ref: #transaction-screen15101 +Node: Error screen15968 +Ref: #error-screen16090 +Node: TIPS16332 +Ref: #tips16431 +Node: Watch mode16483 +Ref: #watch-mode16600 +Node: Watch mode limitations17344 +Ref: #watch-mode-limitations17485 +Node: ENVIRONMENT18618 +Ref: #environment18729 +Node: FILES19534 +Ref: #files19633 +Node: BUGS19846 +Ref: #bugs19923  End Tag Table - - -Local Variables: -coding: utf-8 -End: diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt index b89c12f6c..b3bc7a65b 100644 --- a/hledger-ui/hledger-ui.txt +++ b/hledger-ui/hledger-ui.txt @@ -504,4 +504,4 @@ SEE ALSO -hledger-ui-1.22.99 August 2021 HLEDGER-UI(1) +hledger-ui-1.22.99 September 2021 HLEDGER-UI(1) diff --git a/hledger-web/.date.m4 b/hledger-web/.date.m4 index fe58c8a96..4be5270d1 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_}}, {{August 2021}})m4_dnl +m4_define({{_monthyear_}}, {{September 2021}})m4_dnl diff --git a/hledger-web/hledger-web.1 b/hledger-web/hledger-web.1 index f93efd8d1..ad5876098 100644 --- a/hledger-web/hledger-web.1 +++ b/hledger-web/hledger-web.1 @@ -1,5 +1,5 @@ -.TH "HLEDGER-WEB" "1" "August 2021" "hledger-web-1.22.99 " "hledger User Manuals" +.TH "HLEDGER-WEB" "1" "September 2021" "hledger-web-1.22.99 " "hledger User Manuals" diff --git a/hledger-web/hledger-web.info b/hledger-web/hledger-web.info index c74c2a823..6be9839e0 100644 --- a/hledger-web/hledger-web.info +++ b/hledger-web/hledger-web.info @@ -1,4 +1,5 @@ -This is hledger-web.info, produced by makeinfo version 6.8 from stdin. +This is hledger-web/hledger-web.info, produced by makeinfo version 4.8 +from stdin. INFO-DIR-SECTION User Applications START-INFO-DIR-ENTRY @@ -6,7 +7,7 @@ START-INFO-DIR-ENTRY END-INFO-DIR-ENTRY  -File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir) +File: hledger-web.info, Node: Top, Up: (dir) hledger-web(1) ************** @@ -14,32 +15,31 @@ hledger-web(1) hledger-web is a web interface (WUI) for the hledger accounting tool. This manual is for hledger-web 1.22.99. - 'hledger-web [OPTIONS]' -'hledger web -- [OPTIONS]' + `hledger-web [OPTIONS]' +`hledger web -- [OPTIONS]' hledger is a reliable, cross-platform set of programs for tracking money, time, or any other commodity, using double-entry accounting and a -simple, editable file format. hledger is inspired by and largely +simple, editable file format. hledger is inspired by and largely compatible with ledger(1). - hledger-web is hledger's web interface. It starts a simple web + hledger-web is hledger's web interface. It starts a simple web application for browsing and adding transactions, and optionally opens -it in a web browser window if possible. It provides a more -user-friendly UI than the hledger CLI or hledger-ui interface, showing -more at once (accounts, the current account register, balance charts) -and allowing history-aware data entry, interactive searching, and -bookmarking. +it in a web browser window if possible. It provides a more user-friendly +UI than the hledger CLI or hledger-ui interface, showing more at once +(accounts, the current account register, balance charts) and allowing +history-aware data entry, interactive searching, and bookmarking. hledger-web also lets you share a ledger with multiple users, or even -the public web. There is no access control, so if you need that you -should put it behind a suitable web proxy. As a small protection -against data loss when running an unprotected instance, it writes a -numbered backup of the main journal file (only ?) on every edit. +the public web. There is no access control, so if you need that you +should put it behind a suitable web proxy. As a small protection against +data loss when running an unprotected instance, it writes a numbered +backup of the main journal file (only ?) on every edit. Like hledger, it reads data from one or more files in hledger -journal, timeclock, timedot, or CSV format specified with '-f', or -'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps -'C:/Users/USER/.hledger.journal'). For more about this see hledger(1). +journal, timeclock, timedot, or CSV format specified with `-f', or +`$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps +`C:/Users/USER/.hledger.journal'). For more about this see hledger(1). * Menu: @@ -59,168 +59,165 @@ File: hledger-web.info, Node: OPTIONS, Next: PERMISSIONS, Prev: Top, Up: Top ********* Command-line options and arguments may be used to set an initial filter -on the data. These filter options are not shown in the web UI, but it +on the data. These filter options are not shown in the web UI, but it will be applied in addition to any search query entered there. - Note: if invoking hledger-web as a hledger subcommand, write '--' + Note: if invoking hledger-web as a hledger subcommand, write `--' before options, as shown in the synopsis above. -'--serve' - +`--serve' serve and log requests, don't browse or auto-exit -'--serve-api' +`--serve-api' like -serve, but serve only the JSON web API, without the server-side web UI -'--host=IPADDR' +`--host=IPADDR' listen on this IP address (default: 127.0.0.1) -'--port=PORT' +`--port=PORT' listen on this TCP port (default: 5000) -'--socket=SOCKETFILE' +`--socket=SOCKETFILE' use a unix domain socket file to listen for requests instead of a - TCP socket. Implies '--serve'. It can only be used if the - operating system can provide this type of socket. -'--base-url=URL' + TCP socket. Implies `--serve'. It can only be used if the operating + system can provide this type of socket. +`--base-url=URL' set the base url (default: http://IPADDR:PORT). You would change this when sharing over the network, or integrating within a larger website. -'--file-url=URL' - set the static files url (default: BASEURL/static). hledger-web +`--file-url=URL' + set the static files url (default: BASEURL/static). hledger-web normally serves static files itself, but if you wanted to serve - them from another server for efficiency, you would set the url with - this. -'--capabilities=CAP[,CAP..]' + them from another server for efficiency, you would set the url + with this. +`--capabilities=CAP[,CAP..]' enable the view, add, and/or manage capabilities (default: view,add) -'--capabilities-header=HTTPHEADER' +`--capabilities-header=HTTPHEADER' read capabilities to enable from a HTTP header, like X-Sandstorm-Permissions (default: disabled) -'--test' - run hledger-web's tests and exit. hspec test runner args may +`--test' + run hledger-web's tests and exit. hspec test runner args may follow a -, eg: hledger-web -test - -help hledger input options: -'-f FILE --file=FILE' - - use a different input file. For stdin, use - (default: - '$LEDGER_FILE' or '$HOME/.hledger.journal') -'--rules-file=RULESFILE' +`-f FILE --file=FILE' + use a different input file. For stdin, use - (default: + `$LEDGER_FILE' or `$HOME/.hledger.journal') +`--rules-file=RULESFILE' Conversion rules file to use when reading CSV (default: FILE.rules) -'--separator=CHAR' +`--separator=CHAR' Field separator to expect when reading CSV (default: ',') -'--alias=OLD=NEW' +`--alias=OLD=NEW' rename accounts named OLD to NEW -'--anon' +`--anon' anonymize accounts and payees -'--pivot FIELDNAME' +`--pivot FIELDNAME' use some other field or tag for the account name -'-I --ignore-assertions' +`-I --ignore-assertions' disable balance assertion checks (note: does not disable balance assignments) -'-s --strict' +`-s --strict' do extra error checking (check that all posted accounts are declared) hledger reporting options: -'-b --begin=DATE' - +`-b --begin=DATE' include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) -'-e --end=DATE' +`-e --end=DATE' include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) -'-D --daily' +`-D --daily' multiperiod/multicolumn report by day -'-W --weekly' +`-W --weekly' multiperiod/multicolumn report by week -'-M --monthly' +`-M --monthly' multiperiod/multicolumn report by month -'-Q --quarterly' +`-Q --quarterly' multiperiod/multicolumn report by quarter -'-Y --yearly' +`-Y --yearly' multiperiod/multicolumn report by year -'-p --period=PERIODEXP' +`-p --period=PERIODEXP' set start date, end date, and/or reporting interval all at once using period expressions syntax -'--date2' +`--date2' match the secondary date instead (see command help for other effects) -'-U --unmarked' +`-U --unmarked' include only unmarked postings/txns (can combine with -P or -C) -'-P --pending' +`-P --pending' include only pending postings/txns -'-C --cleared' +`-C --cleared' include only cleared postings/txns -'-R --real' +`-R --real' include only non-virtual postings -'-NUM --depth=NUM' +`-NUM --depth=NUM' hide/aggregate accounts or postings more than NUM levels deep -'-E --empty' +`-E --empty' show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) -'-B --cost' +`-B --cost' convert amounts to their cost/selling amount at transaction time -'-V --market' +`-V --market' convert amounts to their market value in default valuation commodities -'-X --exchange=COMM' +`-X --exchange=COMM' convert amounts to their market value in commodity COMM -'--value' +`--value' convert amounts to cost or market value, more flexibly than -B/-V/-X -'--infer-market-prices' +`--infer-market-prices' use transaction prices (recorded with @ or @@) as additional market prices, as if they were P directives -'--auto' +`--auto' apply automated posting rules to modify transactions. -'--forecast' +`--forecast' generate future transactions from periodic transaction rules, for - the next 6 months or till report end date. In hledger-ui, also + the next 6 months or till report end date. In hledger-ui, also make ordinary future transactions visible. -'--color=WHEN (or --colour=WHEN)' +`--color=WHEN (or --colour=WHEN)' Should color-supporting commands use ANSI color codes in text output. 'auto' (default): whenever stdout seems to be a color-supporting terminal. 'always' or 'yes': always, useful eg - when piping output into 'less -R'. 'never' or 'no': never. A + when piping output into 'less -R'. 'never' or 'no': never. A NO_COLOR environment variable overrides this. When a reporting option appears more than once in the command line, @@ -230,62 +227,62 @@ the last one takes precedence. hledger help options: -'-h --help' - +`-h --help' show general or COMMAND help -'--man' +`--man' show general or COMMAND user manual with man -'--info' +`--info' show general or COMMAND user manual with info -'--version' +`--version' show general or ADDONCMD version -'--debug[=N]' +`--debug[=N]' show debug output (levels 1-9, default: 1) A @FILE argument will be expanded to the contents of FILE, which -should contain one command line option/argument per line. (To prevent -this, insert a '--' argument before.) +should contain one command line option/argument per line. (To prevent +this, insert a `--' argument before.) By default, hledger-web starts the web app in "transient mode" and -also opens it in your default web browser if possible. In this mode the +also opens it in your default web browser if possible. In this mode the web app will keep running for as long as you have it open in a browser window, and will exit after two minutes of inactivity (no requests and -no browser windows viewing it). With '--serve', it just runs the web -app without exiting, and logs requests to the console. With -'--serve-api', only the JSON web api (see below) is served, with the +no browser windows viewing it). With `--serve', it just runs the web +app without exiting, and logs requests to the console. With +`--serve-api', only the JSON web api (see below) is served, with the usual HTML server-side web UI disabled. By default the server listens on IP address 127.0.0.1, accessible -only to local requests. You can use '--host' to change this, eg '--host +only to local requests. You can use `--host' to change this, eg `--host 0.0.0.0' to listen on all configured addresses. - Similarly, use '--port' to set a TCP port other than 5000, eg if you + Similarly, use `--port' to set a TCP port other than 5000, eg if you are running multiple hledger-web instances. - Both of these options are ignored when '--socket' is used. In this -case, it creates an 'AF_UNIX' socket file at the supplied path and uses -that for communication. This is an alternative way of running multiple -hledger-web instances behind a reverse proxy that handles authentication -for different users. The path can be derived in a predictable way, eg -by using the username within the path. As an example, 'nginx' as -reverse proxy can use the variable '$remote_user' to derive a path from -the username used in a HTTP basic authentication. The following -'proxy_pass' directive allows access to all 'hledger-web' instances that -created a socket in '/tmp/hledger/': + Both of these options are ignored when `--socket' is used. In this +case, it creates an `AF_UNIX' socket file at the supplied path and uses +that for communication. This is an alternative way of running multiple +hledger-web instances behind a reverse proxy that handles +authentication for different users. The path can be derived in a +predictable way, eg by using the username within the path. As an +example, `nginx' as reverse proxy can use the variable `$remote_user' +to derive a path from the username used in a HTTP basic authentication. +The following `proxy_pass' directive allows access to all `hledger-web' +instances that created a socket in `/tmp/hledger/': + proxy_pass http://unix:/tmp/hledger/${remote_user}.socket; - You can use '--base-url' to change the protocol, hostname, port and + You can use `--base-url' to change the protocol, hostname, port and path that appear in hyperlinks, useful eg for integrating hledger-web -within a larger website. The default is 'http://HOST:PORT/' using the -server's configured host address and TCP port (or 'http://HOST' if PORT +within a larger website. The default is `http://HOST:PORT/' using the +server's configured host address and TCP port (or `http://HOST' if PORT is 80). - With '--file-url' you can set a different base url for static files, + With `--file-url' you can set a different base url for static files, eg for better caching or cookie-less serving on high performance websites. @@ -300,28 +297,32 @@ journal and to add new transactions, but not to change existing data. You can restrict who can reach it by - * setting the IP address it listens on (see '--host' above). By + * setting the IP address it listens on (see `--host' above). By default it listens on 127.0.0.1, accessible to all users on the local machine. + * putting it behind an authenticating proxy, using eg apache or nginx + * custom firewall rules You can restrict what the users who reach it can do, by - * using the '--capabilities=CAP[,CAP..]' flag when you start it, - enabling one or more of the following capabilities. The default - value is 'view,add': - * 'view' - allows viewing the journal file and all included + * using the `--capabilities=CAP[,CAP..]' flag when you start it, + enabling one or more of the following capabilities. The default + value is `view,add': + * `view' - allows viewing the journal file and all included files - * 'add' - allows adding new transactions to the main journal + + * `add' - allows adding new transactions to the main journal file - * 'manage' - allows editing, uploading or downloading the main + + * `manage' - allows editing, uploading or downloading the main or included files - * using the '--capabilities-header=HTTPHEADER' flag to specify a HTTP - header from which it will read capabilities to enable. hledger-web + * using the `--capabilities-header=HTTPHEADER' flag to specify a HTTP + header from which it will read capabilities to enable. hledger-web on Sandstorm uses the X-Sandstorm-Permissions header to integrate - with Sandstorm's permissions. This is disabled by default. + with Sandstorm's permissions. This is disabled by default.  File: hledger-web.info, Node: EDITING UPLOADING DOWNLOADING, Next: RELOADING, Prev: PERMISSIONS, Up: Top @@ -329,8 +330,8 @@ File: hledger-web.info, Node: EDITING UPLOADING DOWNLOADING, Next: RELOADING, 3 EDITING, UPLOADING, DOWNLOADING ********************************* -If you enable the 'manage' capability mentioned above, you'll see a new -"spanner" button to the right of the search form. Clicking this will +If you enable the `manage' capability mentioned above, you'll see a new +"spanner" button to the right of the search form. Clicking this will let you edit, upload, or download the journal file or any files it includes. @@ -339,13 +340,13 @@ visitor) can alter or wipe the data files. Normally whenever a file is changed in this way, hledger-web saves a numbered backup (assuming file permissions allow it, the disk is not -full, etc.) hledger-web is not aware of version control systems, +full, etc.) hledger-web is not aware of version control systems, currently; if you use one, you'll have to arrange to commit the changes yourself (eg with a cron job or a file watcher like entr). Changes which would leave the journal file(s) unparseable or non-valid (eg with failing balance assertions) are prevented. -(Probably. This needs re-testing.) +(Probably. This needs re-testing.)  File: hledger-web.info, Node: RELOADING, Next: JSON API, Prev: EDITING UPLOADING DOWNLOADING, Up: Top @@ -355,7 +356,7 @@ File: hledger-web.info, Node: RELOADING, Next: JSON API, Prev: EDITING UPLOAD hledger-web detects changes made to the files by other means (eg if you edit it directly, outside of hledger-web), and it will show the new data -when you reload the page or navigate to a new page. If a change makes a +when you reload the page or navigate to a new page. If a change makes a file unparseable, hledger-web will display an error message until the file has been fixed. @@ -369,14 +370,16 @@ File: hledger-web.info, Node: JSON API, Next: ENVIRONMENT, Prev: RELOADING, ********** In addition to the web UI, hledger-web also serves a JSON API that can -be used to get data or add new transactions. If you want the JSON API -only, you can use the '--serve-api' flag. Eg: +be used to get data or add new transactions. If you want the JSON API +only, you can use the `--serve-api' flag. Eg: + $ hledger-web -f examples/sample.journal --serve-api ... You can get JSON data from these routes: + /version /accountnames /transactions @@ -389,6 +392,7 @@ $ hledger-web -f examples/sample.journal --serve-api command). (hledger-web's JSON does not include newlines, here we use python to prettify it): + $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool [ "assets", @@ -408,6 +412,7 @@ $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool Or all transactions: + $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool [ { @@ -429,24 +434,25 @@ $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool Most of the JSON corresponds to hledger's data types; for details of what the fields mean, see the Hledger.Data.Json haddock docs and click -on the various data types, eg Transaction. And for a higher level +on the various data types, eg Transaction. And for a higher level understanding, see the journal manual. In some cases there is outer JSON corresponding to a "Report" type. -To understand that, go to the Hledger.Web.Handler.MiscR haddock and look -at the source for the appropriate handler to see what it returns. Eg -for '/accounttransactions' it's getAccounttransactionsR, returning a -"'accountTransactionsReport ...'". Looking up the haddock for that we +To understand that, go to the Hledger.Web.Handler.MiscR haddock and +look at the source for the appropriate handler to see what it returns. +Eg for `/accounttransactions' it's getAccounttransactionsR, returning a +"`accountTransactionsReport ...'". Looking up the haddock for that we can see that /accounttransactions returns an AccountTransactionsReport, which consists of a report title and a list of AccountTransactionsReportItem (etc). You can add a new transaction to the journal with a PUT request to -'/add', if hledger-web was started with the 'add' capability (enabled by -default). The payload must be the full, exact JSON representation of a -hledger transaction (partial data won't do). You can get sample JSON -from hledger-web's '/transactions' or '/accounttransactions', or you can -export it with hledger-lib, eg like so: +`/add', if hledger-web was started with the `add' capability (enabled +by default). The payload must be the full, exact JSON representation of +a hledger transaction (partial data won't do). You can get sample JSON +from hledger-web's `/transactions' or `/accounttransactions', or you +can export it with hledger-lib, eg like so: + .../hledger$ stack ghci hledger-lib >>> writeJsonFile "txn.json" (head $ jtxns samplejournal) @@ -455,6 +461,7 @@ export it with hledger-lib, eg like so: Here's how it looks as of hledger-1.17 (remember, this JSON corresponds to hledger's Transaction and related data types): + { "tcomment": "", "tpostings": [ @@ -541,9 +548,10 @@ corresponds to hledger's Transaction and related data types): "tstatus": "Unmarked" } - And here's how to test adding it with curl. This should add a new + And here's how to test adding it with curl. This should add a new entry to your journal: + $ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json  @@ -552,25 +560,26 @@ File: hledger-web.info, Node: ENVIRONMENT, Next: FILES, Prev: JSON API, Up: 6 ENVIRONMENT ************* -*LEDGER_FILE* The journal file path when not specified with '-f'. -Default: '~/.hledger.journal' (on windows, perhaps -'C:/Users/USER/.hledger.journal'). +*LEDGER_FILE* The journal file path when not specified with `-f'. +Default: `~/.hledger.journal' (on windows, perhaps +`C:/Users/USER/.hledger.journal'). - A typical value is '~/DIR/YYYY.journal', where DIR is a -version-controlled finance directory and YYYY is the current year. Or -'~/DIR/current.journal', where current.journal is a symbolic link to + A typical value is `~/DIR/YYYY.journal', where DIR is a +version-controlled finance directory and YYYY is the current year. Or +`~/DIR/current.journal', where current.journal is a symbolic link to YYYY.journal. - On Mac computers, you can set this and other environment variables in -a more thorough way that also affects applications started from the GUI -(say, an Emacs dock icon). Eg on MacOS Catalina I have a -'~/.MacOSX/environment.plist' file containing + On Mac computers, you can set this and other environment variables +in a more thorough way that also affects applications started from the +GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a +`~/.MacOSX/environment.plist' file containing + { "LEDGER_FILE" : "~/finance/current.journal" } - To see the effect you may need to 'killall Dock', or reboot. + To see the effect you may need to `killall Dock', or reboot.  File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top @@ -579,9 +588,9 @@ File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top ******* Reads data from one or more files in hledger journal, timeclock, -timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or -'$HOME/.hledger.journal' (on windows, perhaps -'C:/Users/USER/.hledger.journal'). +timedot, or CSV format specified with `-f', or `$LEDGER_FILE', or +`$HOME/.hledger.journal' (on windows, perhaps +`C:/Users/USER/.hledger.journal').  File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top @@ -589,10 +598,10 @@ File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top 8 BUGS ****** -The need to precede options with '--' when invoked from hledger is +The need to precede options with `--' when invoked from hledger is awkward. - '-f-' doesn't work (hledger-web can't read from stdin). + `-f-' doesn't work (hledger-web can't read from stdin). Query arguments and some hledger options are ignored. @@ -600,29 +609,25 @@ awkward. Does not work well on small screens. - -Tag Table: -Node: Top223 -Node: OPTIONS1889 -Ref: #options1994 -Node: PERMISSIONS9427 -Ref: #permissions9566 -Node: EDITING UPLOADING DOWNLOADING10778 -Ref: #editing-uploading-downloading10959 -Node: RELOADING11793 -Ref: #reloading11927 -Node: JSON API12360 -Ref: #json-api12474 -Node: ENVIRONMENT17964 -Ref: #environment18080 -Node: FILES18813 -Ref: #files18913 -Node: BUGS19126 -Ref: #bugs19204 - -End Tag Table  -Local Variables: -coding: utf-8 -End: +Tag Table: +Node: Top235 +Node: OPTIONS1878 +Ref: #options1983 +Node: PERMISSIONS9396 +Ref: #permissions9535 +Node: EDITING UPLOADING DOWNLOADING10747 +Ref: #editing-uploading-downloading10928 +Node: RELOADING11759 +Ref: #reloading11893 +Node: JSON API12325 +Ref: #json-api12439 +Node: ENVIRONMENT17928 +Ref: #environment18044 +Node: FILES18776 +Ref: #files18876 +Node: BUGS19089 +Ref: #bugs19167 + +End Tag Table diff --git a/hledger-web/hledger-web.txt b/hledger-web/hledger-web.txt index aa72ee75a..3e682b517 100644 --- a/hledger-web/hledger-web.txt +++ b/hledger-web/hledger-web.txt @@ -556,4 +556,4 @@ SEE ALSO -hledger-web-1.22.99 August 2021 HLEDGER-WEB(1) +hledger-web-1.22.99 September 2021 HLEDGER-WEB(1) diff --git a/hledger/.date.m4 b/hledger/.date.m4 index fe58c8a96..4be5270d1 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_}}, {{August 2021}})m4_dnl +m4_define({{_monthyear_}}, {{September 2021}})m4_dnl diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 230760267..db467c8da 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -1,6 +1,6 @@ .\"t -.TH "HLEDGER" "1" "August 2021" "hledger-1.22.99 " "hledger User Manuals" +.TH "HLEDGER" "1" "September 2021" "hledger-1.22.99 " "hledger User Manuals" @@ -762,6 +762,12 @@ T}@T{ T} .TE .PP +Note \[dq]today\[aq]s date\[dq] can be overridden with the +\f[C]--today\f[R] option, in case it\[aq]s needed for testing or for +recreating old reports. +(Except for periodic transaction rules; those are not affected by +\f[C]--today\f[R].) +.PP .SS Report start & end date .PP By default, most hledger reports will show the full span of time @@ -779,8 +785,8 @@ All of these accept the smart date syntax. .PP Some notes: .IP \[bu] 2 -As in Ledger, end dates are exclusive, so you need to write the date -\f[I]after\f[R] the last day you want to include. +End dates are exclusive, as in Ledger, so you should write the date +\f[I]after\f[R] the last day you want to see in the report. .IP \[bu] 2 As noted in reporting options: among start/end dates specified with \f[I]options\f[R], the last (i.e. @@ -847,9 +853,16 @@ separate row or column. .PP The following \[dq]standard\[dq] report intervals can be enabled by using their corresponding flag: -.PP -\f[C]-D/--daily\f[R], \f[C]-W/--weekly\f[R], \f[C]-M/--monthly\f[R], -\f[C]-Q/--quarterly\f[R], \f[C]-Y/--yearly\f[R]. +.IP \[bu] 2 +\f[C]-D/--daily\f[R] +.IP \[bu] 2 +\f[C]-W/--weekly\f[R] +.IP \[bu] 2 +\f[C]-M/--monthly\f[R] +.IP \[bu] 2 +\f[C]-Q/--quarterly\f[R] +.IP \[bu] 2 +\f[C]-Y/--yearly\f[R] .PP These standard intervals always start on natural interval boundaries: eg \f[C]--weekly\f[R] starts on mondays, \f[C]--monthly\f[R] starts on the @@ -871,6 +884,20 @@ overridden (ie, the report starts earlier than your requested start date, or ends later than your requested end date). This is done to ensure \[dq]full\[dq] first and last subperiods, so that all subperiods\[aq] numbers are comparable. +.PP +To summarise: +.IP \[bu] 2 +In multiperiod reports, all subperiods are forced to be the same length, +to simplify reporting. +.IP \[bu] 2 +Reports with the standard +\f[C]--weekly\f[R]/\f[C]--monthly\f[R]/\f[C]--quarterly\f[R]/\f[C]--yearly\f[R] +intervals are required to start on the first day of a +week/month/quarter/year. +We\[aq]d like more flexibility here but it isn\[aq]t supported yet. +.IP \[bu] 2 +\f[C]--period\f[R] (below) can specify more complex intervals, starting +on any date. .SS Period expressions .PP The \f[C]-p/--period\f[R] option accepts period expressions, a shorthand @@ -882,7 +909,13 @@ Here\[aq]s a basic period expression specifying the first quarter of Note, hledger always treats start dates as inclusive and end dates as exclusive: .PP +.TS +tab(@); +l. +T{ \f[C]-p \[dq]from 2009/1/1 to 2009/4/1\[dq]\f[R] +T} +.TE .PP Keywords like \[dq]from\[dq] and \[dq]to\[dq] are optional, and so are the spaces, as long as you don\[aq]t run two dates together. @@ -987,17 +1020,16 @@ T}@T{ fourth quarter of the current year T} .TE +.SS Period expressions with a report interval .PP -The argument of \f[C]-p\f[R] can also begin with, or be, a report -interval expression. -The basic report intervals are \f[C]daily\f[R], \f[C]weekly\f[R], -\f[C]monthly\f[R], \f[C]quarterly\f[R], or \f[C]yearly\f[R], which have -the same effect as the -\f[C]-D\f[R],\f[C]-W\f[R],\f[C]-M\f[R],\f[C]-Q\f[R], or \f[C]-Y\f[R] -flags. -Between report interval and start/end dates (if any), the word -\f[C]in\f[R] is optional. -Examples: +\f[C]-p/--period\f[R]\[aq]s argument can also begin with, or entirely +consist of, a report interval. +This should be separated from the start/end dates (if any) by a space, +or the word \f[C]in\f[R]. +The basic intervals (which can also be written as command line flags) +are \f[C]daily\f[R], \f[C]weekly\f[R], \f[C]monthly\f[R], +\f[C]quarterly\f[R], and \f[C]yearly\f[R]. +Some examples: .PP .TS tab(@); @@ -1013,11 +1045,11 @@ T{ T} .TE .PP -Note that \f[C]weekly\f[R], \f[C]monthly\f[R], \f[C]quarterly\f[R] and -\f[C]yearly\f[R] intervals will always start on the first day on week, -month, quarter or year accordingly, and will end on the last day of same -period, even if associated period expression specifies different -explicit start and end date. +As mentioned above, the \f[C]weekly\f[R], \f[C]monthly\f[R], +\f[C]quarterly\f[R] and \f[C]yearly\f[R] intervals require a report +start date that is the first day of a week, month, quarter or year. +And, report start/end dates will be expanded if needed to span a whole +number of intervals. .PP For example: .PP @@ -1046,15 +1078,23 @@ T}@T{ starts on 2009/01/01, first day of 2009 T} .TE +.SS More complex report intervals .PP -The following more complex report intervals are also supported: -\f[C]biweekly\f[R], \f[C]fortnightly\f[R], \f[C]bimonthly\f[R], -\f[C]every day|week|month|quarter|year\f[R], -\f[C]every N days|weeks|months|quarters|years\f[R]. -.PP -All of these will start on the first day of the requested period and end -on the last one, as described above. +Some more complex kinds of interval are also supported in period +expressions: +.IP \[bu] 2 +\f[C]biweekly\f[R] +.IP \[bu] 2 +\f[C]fortnightly\f[R] +.IP \[bu] 2 +\f[C]bimonthly\f[R] +.IP \[bu] 2 +\f[C]every day|week|month|quarter|year\f[R] +.IP \[bu] 2 +\f[C]every N days|weeks|months|quarters|years\f[R] .PP +These too will cause report start/end dates to be expanded, if needed, +to span a whole number of intervals. Examples: .PP .TS @@ -1076,16 +1116,33 @@ T}@T{ periods will have boundaries on 2009/03/01, 2009/08/01, ... T} .TE +.SS Intervals with custom start date .PP -If you want intervals that start on arbitrary day of your choosing and -span a week, month or year, you need to use any of the following: +All intervals mentioned above are required to start on their natural +calendar boundaries, but the following intervals can start on any date: .PP -\f[C]every Nth day of week\f[R], \f[C]every WEEKDAYNAME\f[R] (eg -\f[C]mon|tue|wed|thu|fri|sat|sun\f[R]), -\f[C]every Nth day [of month]\f[R], -\f[C]every Nth WEEKDAYNAME [of month]\f[R], -\f[C]every MM/DD [of year]\f[R], \f[C]every Nth MMM [of year]\f[R], -\f[C]every MMM Nth [of year]\f[R]. +Weekly on custom day: +.IP \[bu] 2 +\f[C]every Nth day of week\f[R] (\f[C]th\f[R], \f[C]nd\f[R], +\f[C]rd\f[R], or \f[C]st\f[R] are all accepted after the number) +.IP \[bu] 2 +\f[C]every WEEKDAYNAME\f[R] (full or three-letter english weekday name, +case insensitive) +.PP +Monthly on custom day: +.IP \[bu] 2 +\f[C]every Nth day [of month]\f[R] +.IP \[bu] 2 +\f[C]every Nth WEEKDAYNAME [of month]\f[R] +.PP +Yearly on custom day: +.IP \[bu] 2 +\f[C]every MM/DD [of year]\f[R] (month number and day of month number) +.IP \[bu] 2 +\f[C]every MONTHNAME DDth [of year]\f[R] (full or three-letter english +month name, case insensitive, and day of month number) +.IP \[bu] 2 +\f[C]every DDth MONTHNAME [of year]\f[R] (equivalent to the above) .PP Examples: .PP @@ -1115,10 +1172,10 @@ T} T{ \f[C]-p \[dq]every 11/05\[dq]\f[R] T}@T{ -yearly periods with boundaries on 5th of Nov +yearly periods with boundaries on 5th of November T} T{ -\f[C]-p \[dq]every 5th Nov\[dq]\f[R] +\f[C]-p \[dq]every 5th November\[dq]\f[R] T}@T{ same T} @@ -1129,23 +1186,79 @@ same T} .TE .PP -Show historical balances at end of 15th each month (N is exclusive end -date): +Show historical balances at end of the 15th day of each month (N is an +end date, exclusive as always): +.IP +.nf +\f[C] +$ hledger balance -H -p \[dq]every 16th day\[dq] +\f[R] +.fi .PP -\f[C]hledger balance -H -p \[dq]every 16th day\[dq]\f[R] +Group postings from the start of wednesday to end of the following +tuesday (N is both (inclusive) start date and (exclusive) end date): +.IP +.nf +\f[C] +$ hledger register checking -p \[dq]every 3rd day of week\[dq] +\f[R] +.fi +.SS Periods or dates ? .PP -Group postings from start of wednesday to end of next tuesday (N is -start date and exclusive end date): +Report intervals like the above are most often used with +\f[C]-p|--period\f[R], to divide reports into multiple subperiods - each +generated date marks a subperiod boundary. +Here, the periods between the dates are what\[aq]s important. .PP -\f[C]hledger register checking -p \[dq]every 3rd day of week\[dq]\f[R] +But report intervals can also be used with \f[C]--forecast\f[R] to +generate future transactions, or with \f[C]balance --budget\f[R] to +generate budget goal-setting transactions. +For these, the dates themselves are what matters. +.SS Events on multiple weekdays +.PP +The \f[C]every WEEKDAYNAME\f[R] form has a special variant with multiple +day names, comma-separated. +Eg: \f[C]every mon,thu,sat\f[R]. +Also, \f[C]weekday\f[R] and \f[C]weekendday\f[R] are shorthand for +\f[C]mon,tue,wed,thu,fri\f[R] and \f[C]sat,sun\f[R] respectively. +.PP +This form is mainly intended for use with \f[C]--forecast\f[R], to +generate periodic transactions on arbitrary days of the week. +It may be less useful with \f[C]-p\f[R], since it divides each week into +subperiods of unequal length. +(Because gaps between periods are not allowed; if you\[aq]d like to +change this, see #1632.) +.PP +Examples: +.PP +.TS +tab(@); +lw(17.8n) lw(52.2n). +T{ +\f[C]-p \[dq]every mon,wed,fri\[dq]\f[R] +T}@T{ +dates will be Mon, Wed, Fri; periods will be Mon-Tue, Wed-Thu, Fri-Sun +T} +T{ +\f[C]-p \[dq]every weekday\[dq]\f[R] +T}@T{ +dates will be Mon, Tue, Wed, Thu, Fri; periods will be Mon, Tue, Wed, +Thu, Fri-Sun +T} +T{ +\f[C]-p \[dq]every weekendday\[dq]\f[R] +T}@T{ +dates will be Sat, Sun; periods will be Sat, Sun-Fri +T} +.TE .SH DEPTH .PP -With the \f[C]--depth N\f[R] option (short form: \f[C]-N\f[R]), commands -like account, balance and register will show only the uppermost accounts -in the account tree, down to level N. +With the \f[C]--depth NUM\f[R] option (short form: \f[C]-NUM\f[R]), +commands like account, balance and register will show only the uppermost +accounts in the account tree, down to level NUM. Use this when you want a summary with less detail. -This flag has the same effect as a \f[C]depth:\f[R] query argument (so -\f[C]-2\f[R], \f[C]--depth=2\f[R] or \f[C]depth:2\f[R] are equivalent). +This flag has the same effect as a \f[C]depth:\f[R] query argument: +\f[C]depth:2\f[R], \f[C]--depth=2\f[R] or \f[C]-2\f[R] are equivalent. .SH QUERIES .PP One of hledger\[aq]s strengths is being able to quickly report on a @@ -2256,6 +2369,24 @@ If you already have tables created via SQL output of hledger, you would probably want to either clear tables of existing data (via \f[C]delete\f[R] or \f[C]truncate\f[R] SQL statements) or drop tables completely as otherwise your postings will be duped. +.SS Commodity styles +.PP +The display style of a commodity/currence is inferred according to the +rules described in Commodity display style. +The inferred display style can be overriden by an optional +\f[C]-c/--commodity-style\f[R] option. +For example, the following will override the display style for dollars. +.IP +.nf +\f[C] +$ hledger print -c \[aq]$1.000,0\[aq] +\f[R] +.fi +.PP +The format specification of the style is identical to the commodity +display style specification for the commodity directive. +The command line option can be supplied repeatedly to override the +display style for multiple commodity/currency symbols. .SH COMMANDS .PP hledger provides a number of commands for producing reports and managing @@ -2628,6 +2759,8 @@ or actual and planned balance changes (\f[C]--budget\f[R]) or value of balance changes (\f[C]-V\f[R]) .IP \[bu] 2 or change of balance values (\f[C]--valuechange\f[R]) +.IP \[bu] 2 +or unrealised capital gain/loss (\f[C]--gain\f[R]) .PP \&..in.. .IP \[bu] 2 @@ -2686,11 +2819,11 @@ end of the journal period (more on this below). .PP Accounts are sorted by declaration order if any, and then alphabetically by account name. -For instance, using examples/sample.journal: +For instance (using examples/sample.journal): .IP .nf \f[C] -$ hledger bal +$ hledger -f examples/sample.journal bal $1 assets:bank:saving $-2 assets:cash $1 expenses:food @@ -2710,7 +2843,7 @@ Use \f[C]-E/--empty\f[R] to show them (revealing .IP .nf \f[C] -$ 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 @@ -2735,7 +2868,7 @@ Eg: .IP .nf \f[C] -$ hledger bal --cleared assets date:200806 +$ hledger -f examples/sample.journal bal --cleared assets date:200806 $-2 assets:cash -------------------- $-2 @@ -2751,7 +2884,7 @@ subaccounts\[aq] \[dq]leaf\[dq] names indented below their parent: .IP .nf \f[C] -$ hledger balance +$ hledger -f examples/sample.journal balance $-1 assets $1 bank:saving $-2 cash @@ -2785,31 +2918,35 @@ Each group of sibling accounts (ie, under a common parent) is sorted separately. .SS Depth limiting .PP -With a \f[C]depth:N\f[R] query, or \f[C]--depth N\f[R] option, or just -\f[C]-N\f[R], balance reports will show accounts only to the specified -depth, hiding the deeper subaccounts. +With a \f[C]depth:NUM\f[R] query, or \f[C]--depth NUM\f[R] option, or +just \f[C]-NUM\f[R] (eg: \f[C]-3\f[R]) balance reports will show +accounts only to the specified depth, hiding the deeper subaccounts. +This can be useful for getting an overview without too much detail. +.PP Account balances at the depth limit always include the balances from any -hidden subaccounts (even in list mode). -This can be useful for getting an overview. +deeper subaccounts (even in list mode). Eg, limiting to depth 1: .IP .nf \f[C] -$ hledger balance -N -1 +$ hledger -f examples/sample.journal balance -1 $-1 assets $2 expenses $-2 income $1 liabilities +-------------------- + 0 \f[R] .fi +.SS Dropping top-level accounts .PP -You can also hide top-level account name parts, using -\f[C]--drop N\f[R]. +You can also hide one or more top-level account name parts, using +\f[C]--drop NUM\f[R]. This can be useful for hiding repetitive top-level account names: .IP .nf \f[C] -$ hledger bal expenses --drop 1 +$ hledger -f examples/sample.journal bal expenses --drop 1 $1 food $1 supplies -------------------- @@ -2827,7 +2964,7 @@ periods (and a title): .IP .nf \f[C] -$ hledger balance --quarterly income expenses -E +$ hledger -f examples/sample.journal bal --quarterly income expenses -E Balance changes in 2008: || 2008q1 2008q2 2008q3 2008q4 @@ -2974,7 +3111,7 @@ value expressed as a percentage of the (column) total: .IP .nf \f[C] -$ hledger bal expenses -Q -% +$ hledger -f examples/sample.journal bal expenses -Q -% Balance changes in 2008: || 2008Q1 2008Q2 2008Q3 2008Q4 @@ -3070,7 +3207,11 @@ It is one of: \f[C]--budget\f[R] : like --sum but also show a goal amount .IP \[bu] 2 \f[C]--valuechange\f[R] : show the change in period-end historical -balance values +balance values (caused by deposits, withdrawals, and/or market price +fluctuations) +.IP \[bu] 2 +\f[C]--gain\f[R] : show the unrealised capital gain/loss, (the current +valued balance minus each amount\[aq]s original cost) .PP \f[B]Accumulation type:\f[R] .PD 0 @@ -3112,7 +3253,7 @@ cost \f[C]--value=then[,COMM]\f[R] : show value at transaction dates .IP \[bu] 2 \f[C]--value=end[,COMM]\f[R] : show value at period end date(s) -(\f[B]default with \f[CB]--valuechange\f[B]\f[R]) +(\f[B]default with \f[CB]--valuechange\f[B], \f[CB]--gain\f[B]\f[R]) .IP \[bu] 2 \f[C]--value=now[,COMM]\f[R] : show value at today\[aq]s date .IP \[bu] 2 @@ -3570,7 +3711,7 @@ Eg: .IP .nf \f[C] -$ hledger balance --format \[dq]%20(account) %12(total)\[dq] +$ hledger -f examples/sample.journal balance --format \[dq]%20(account) %12(total)\[dq] assets $-1 bank:saving $1 cash $-2 @@ -3938,19 +4079,42 @@ whichever is later. .PP Unless you are running \f[C]close\f[R] on exactly the first day of the new period, you\[aq]ll want to override the closing date. -This is done by specifying a report period, where \[dq]last day of the +This is done by specifying a report end date, where \[dq]last day of the report period\[dq] will be the closing date. The opening date is always the following day. -So to close on 2020-12-31 and open on 2021-01-01, any of these work -.IP \[bu] 2 -\f[C]-p 2020\f[R] -.IP \[bu] 2 -\f[C]date:2020\f[R] -.IP \[bu] 2 -\f[C]-e 2021-01-01\f[R] (remember \f[C]-e\f[R] specifies an exclusive -end date) -.IP \[bu] 2 +So to close on (end of) 2020-12-31 and open on (start of) 2021-01-01, +any of these will work: +.PP +.TS +tab(@); +l l. +T{ +end date argument +T}@T{ +explanation +T} +_ +T{ +\f[C]-e 2021-01-01\f[R] +T}@T{ +end dates are exclusive +T} +T{ \f[C]-e 2021\f[R] +T}@T{ +equivalent, per smart dates +T} +T{ +\f[C]-p 2020\f[R] +T}@T{ +equivalent, the period\[aq]s begin date is ignored +T} +T{ +\f[C]date:2020\f[R] +T}@T{ +equivalent query +T} +.TE .SS Example: close asset/liability accounts for file transition .PP Carrying asset/liability balances from 2020.journal into a new file for @@ -4010,7 +4174,7 @@ like this: ; 2019.journal 2019-01-01 opening balances ; earliest opening txn, no tag here \&... -2019-12-31 closing balances ; close:2019 +2019-12-31 closing balances ; clopen:2020 \&... \f[R] .fi @@ -4018,9 +4182,9 @@ like this: .nf \f[C] ; 2020.journal -2020-01-01 opening balances ; open:2020 +2020-01-01 opening balances ; clopen:2020 \&... -2020-12-31 closing balances ; close:2020 +2020-12-31 closing balances ; clopen:2021 \&... \f[R] .fi @@ -4028,7 +4192,7 @@ like this: .nf \f[C] ; 2021.journal -2021-01-01 opening balances ; open:2021 +2021-01-01 opening balances ; clopen:2021 \&... \f[R] .fi @@ -4048,14 +4212,11 @@ you could do eg: .IP .nf \f[C] -$ hledger -f all.journal reg -H checking not:tag:\[aq]open|close\[aq] +$ hledger -f all.journal reg -H checking not:tag:clopen # all years checking register, hiding non-essential opening/closing txns -$ hledger -f all.journal bs -p 2020 not:tag:close=2020 +$ hledger -f all.journal bs -p 2020 not:tag:clopen=2020 # 2020 year end balances, suppressing 2020 closing txn - -$ hledger -f 2020.journal bs not:tag:close - # 2020 year end balances, easier case \f[R] .fi .SS close and balance assertions @@ -4104,35 +4265,45 @@ single-day transactions): .fi .SS Example: close revenue/expense accounts to retained earnings .PP -Here, the opening transaction is supressed with \f[C]--close\f[R], as -it\[aq]s probably not needed. -Also you\[aq]ll want to use a different equity account name: +For this, use \f[C]--close\f[R] to suppress the opening transaction, as +it\[aq]s not needed. +Also you\[aq]ll want to change the equity account name to your +equivalent of \[dq]equity:retained earnings\[dq]. +.PP +Closing 2021\[aq]s first quarter revenues/expenses: .IP .nf \f[C] -$ hledger close -f 2021.journal -p 2021Q1 --close --close-acct=\[aq]equity:retained earnings\[aq] revenues expenses >> 2021.journal - # close 2021 first quarter revenues/expenses +$ hledger close -f 2021.journal --close revenues expenses -p 2021Q1 \[rs] + --close-acct=\[aq]equity:retained earnings\[aq] >> 2021.journal \f[R] .fi .PP -Or, operating on the default journal: +The same, using the default journal and current year: .IP .nf \f[C] -$ hledger close -p Q1 --close --close-acct=\[aq]equity:retained earnings\[aq] revenues expenses >> $LEDGER_FILE - # close current year\[aq]s first quarter revenues/expenses +$ hledger close --close revenues expenses -p Q1 \[rs] + --close-acct=\[aq]equity:retained earnings\[aq] >> $LEDGER_FILE \f[R] .fi .PP -Now, eg: +Now, the first quarter\[aq]s balance sheet should show a zero (unless +you are using \[at]/\[at]\[at] notation without equity postings): .IP .nf \f[C] $ hledger bse -p Q1 - # Q1 full balance sheet, total should be zero - -$ hledger is -p Q1 not:\[aq]retained earnings\[aq] - # Q1 income statement, must suppress the closing txn +\f[R] +.fi +.PP +And we must suppress the closing transaction to see the first +quarter\[aq]s income statement (using the description; +\f[C]not:\[aq]retained earnings\[aq]\f[R] won\[aq]t work here): +.IP +.nf +\f[C] +$ hledger is -p Q1 not:desc:\[aq]closing balances\[aq] \f[R] .fi .SS codes @@ -4275,8 +4446,13 @@ help .PD Show the hledger user manual in one of several formats, optionally positioned at a given TOPIC (if possible). -TOPIC is any heading, or heading prefix, in the manual. -Some examples: commands, print, \[aq]auto postings\[aq], periodic. +.PP +TOPIC is any heading in the manual, or the start of any heading (but not +the middle). +It is case insensitive. +.PP +Some examples: \f[C]commands\f[R], \f[C]print\f[R], \f[C]forecast\f[R], +\f[C]\[dq]auto postings\[dq]\f[R], \f[C]\[dq]commodity column\[dq]\f[R]. .PP This command shows the user manual built in to this hledger version. It can be useful if the correct version of the hledger manual, or the @@ -6036,6 +6212,9 @@ commodity 1000.00000000 BTC commodity 1 000. \f[R] .fi +.PP +The inferred commodity style can be overridden by supplying a command +line option. .SS Rounding .PP Amounts are stored internally as decimal numbers with up to 255 decimal @@ -6714,6 +6893,9 @@ commodity 1 000 000. Note hledger normally uses banker\[aq]s rounding, so 0.5 displayed with zero decimal digits is \[dq]0\[dq]. (More at Commodity display style.) +.PP +Even in the presence of commodity directives, the commodity display +style can still be overridden by supplying a command line option. .SS Commodity error checking .PP In strict mode, enabled with the \f[C]-s\f[R]/\f[C]--strict\f[R] flag, @@ -6910,17 +7092,18 @@ report. not investments or receivables.) .SS Declaring account types .PP -Generally, to make these reports work you should declare your top-level -accounts and their types, using account directives with \f[C]type:\f[R] -tags. -.PP -The tag\[aq]s value should be one of: \f[C]Asset\f[R], -\f[C]Liability\f[R], \f[C]Equity\f[R], \f[C]Revenue\f[R], -\f[C]Expense\f[R], \f[C]Cash\f[R], \f[C]A\f[R], \f[C]L\f[R], -\f[C]E\f[R], \f[C]R\f[R], \f[C]X\f[R], \f[C]C\f[R] (all case -insensitive). -The type is inherited by all subaccounts except where they override it. -Here\[aq]s a complete example: +To make the balancesheet/balancesheetequity/cashflow/incomestatement +reports work, generally you should declare your top-level accounts, and +their types. +For each top-level account, write an account directive, with a +\f[C]type:\f[R] tag. +The tag\[aq]s value can be any of \f[C]Asset\f[R], \f[C]Liability\f[R], +\f[C]Equity\f[R], \f[C]Revenue\f[R], \f[C]Expense\f[R], \f[C]Cash\f[R], +or (for short) \f[C]A\f[R], \f[C]L\f[R], \f[C]E\f[R], \f[C]R\f[R], +\f[C]X\f[R], \f[C]C\f[R] (case insensitive). +An account\[aq]s type is inherited by its subaccounts, unless they +declare a different type. +Here\[aq]s an example, declaring all six account types: .IP .nf \f[C] @@ -6933,15 +7116,30 @@ account revenues ; type: Revenue account expenses ; type: Expense \f[R] .fi -.SS Auto-detected account types .PP -If you happen to use common english top-level account names, you may not -need to declare account types, as they will be detected automatically -using the following rules: +There is also an older syntax, which is deprecated and will be dropped +soon (A, L, E, R or X separated from the account name by two or more +spaces): .IP .nf \f[C] - If account\[aq]s name matches this regular expression: | its type is: +account assets A +account liabilities L +account equity E +account revenues R +account expenses X +\f[R] +.fi +.SS Auto-detected account types +.PP +hledger tries to find at least one top level account in each of the six +account types (Asset, Liability, Equity, Revenue, Expense, Cash). +When no accounts have been declared for a particular type, hledger tries +to auto-detect some accounts by name, using regular expressions: +.IP +.nf +\f[C] + If account\[aq]s name matches this case insensitive regular expression:| its type is: ------------------------------------------------------------------- | ------------ \[ha]assets?(:|$) | and does not contain regexp (investment|receivable|:A/R|:fixed) | Cash @@ -6953,17 +7151,27 @@ using the following rules: \f[R] .fi .PP -Even so, explicit declarations may be a good idea, for clarity and -predictability. -.SS Interference from auto-detected account types +For people using standard english account names, this feature helps +hledger\[aq]s high-level reports work out of the box with minimal +configuration. .PP -If you assign any account type, it\[aq]s a good idea to assign all of -them, to prevent any confusion from mixing declared and auto-detected -types. -Although it\[aq]s unlikely to happen in real life, here\[aq]s an -example: with the following journal, \f[C]balancesheetequity\f[R] shows -\[dq]liabilities\[dq] in both Liabilities and Equity sections. -Declaring another account as \f[C]type:Liability\f[R] would fix it: +If you use non-english account names, you should declare account types +to make these reports work. +And more generally, declaring accounts and types is usually a good idea, +for increased clarity and predictability (and for the other benefits of +account directives: error checking, display order, etc). +.PP +Notes: +.IP \[bu] 2 +When any account is declared as some type, this disables auto-detection +for that particular type. +.IP \[bu] 2 +If you declare any account\[aq]s type, it\[aq]s a good idea to declare +an account for all six types, since a mix of declared and auto-detected +types can cause confusion. +For example, here liabilities is declared to be Equity, but would also +be auto-detected as Liability, since no Liability account is declared: +.RS 2 .IP .nf \f[C] @@ -6975,21 +7183,7 @@ account liabilities ; type:Equity equity -2 \f[R] .fi -.SS Old account type syntax -.PP -In some hledger journals you might instead see this old syntax (the -letters ALERX, separated from the account name by two or more spaces); -this is deprecated and may be removed soon: -.IP -.nf -\f[C] -account assets A -account liabilities L -account equity E -account revenues R -account expenses X -\f[R] -.fi +.RE .SS Account display order .PP Account directives also set the order in which accounts are displayed, @@ -7356,53 +7550,83 @@ expression. .PP The \f[C]--forecast\f[R] flag activates any periodic transaction rules in the journal. -They will generate temporary recurring transactions, which are not saved -in the journal, but will appear in all reports (eg print). -This can be useful for estimating balances into the future, or +These will generate temporary additional transactions, usually recurring +and in the future, which will appear in all reports. +\f[C]hledger print --forecast\f[R] is a good way to see them. +.PP +This can be useful for estimating balances into the future, perhaps experimenting with different scenarios. -Or, it can be used as a data entry aid: describe recurring transactions, -and every so often copy the output of \f[C]print --forecast\f[R] into -the journal. .PP -These transactions will have an extra tag indicating which periodic rule -generated them: \f[C]generated-transaction:\[ti] PERIODICEXPR\f[R]. -And a similar, hidden tag (beginning with an underscore) which, because -it\[aq]s never displayed by print, can be used to match transactions -generated \[dq]just now\[dq]: -\f[C]_generated-transaction:\[ti] PERIODICEXPR\f[R]. +It could also be useful for scripted data entry: you could describe +recurring transactions, and every so often copy the output of +\f[C]print --forecast\f[R] into the journal. .PP -Periodic transactions are generated within some forecast period. -By default, this +The generated transactions will have an extra tag, like +\f[C]generated-transaction:\[ti] PERIODICEXPR\f[R], indicating which +periodic rule generated them. +There is also a similar, hidden tag, named +\f[C]_generated-transaction:\f[R], which you can use to reliably match +transactions generated \[dq]just now\[dq] (rather than \f[C]print\f[R]ed +in the past). +.PP +The forecast transactions are generated within a \f[I]forecast +period\f[R], which is independent of the report period. +(Forecast period sets the bounds for generated transactions, report +period controls which transactions are reported.) The forecast period +begins on: .IP \[bu] 2 -begins on the later of +the start date provided within \f[C]--forecast\f[R]\[aq]s argument, if +any +.IP \[bu] 2 +otherwise, the later of .RS 2 .IP \[bu] 2 -the report start date if specified with -b/-p/date: +the report start date, if specified (with +\f[C]-b\f[R]/\f[C]-p\f[R]/\f[C]date:\f[R]) .IP \[bu] 2 -the day after the latest normal (non-periodic) transaction in the -journal, or today if there are no normal transactions. +the day after the latest ordinary transaction in the journal, if any .RE .IP \[bu] 2 -ends on the report end date if specified with -e/-p/date:, or 6 months -(180 days) from today. +otherwise today. .PP -This means that periodic transactions will begin only after the latest -recorded transaction. -And a recorded transaction dated in the future can prevent generation of -periodic transactions. -(You can avoid that by writing the future transaction as a one-time -periodic rule instead - put tilde before the date, eg -\f[C]\[ti] YYYY-MM-DD ...\f[R]). +It ends on: +.IP \[bu] 2 +the end date provided within \f[C]--forecast\f[R]\[aq]s argument, if any +.IP \[bu] 2 +otherwise, the report end date, if specified (with +\f[C]-e\f[R]/\f[C]-p\f[R]/\f[C]date:\f[R]) +.IP \[bu] 2 +otherwise 180 days (6 months) from today. +.PP +Note, this means that ordinary transactions will suppress periodic +transactions, by default; the periodic transactions will not start until +after the last ordinary transaction. +This is usually convenient, but you can get around it in two ways: +.IP \[bu] 2 +If you need to record some transactions in the future, make them +periodic transactions (with a single occurrence, eg: +\f[C]\[ti] YYYY-MM-DD\f[R]) rather than ordinary transactions. +That way they won\[aq]t suppress other periodic transactions. +.IP \[bu] 2 +Or give \f[C]--forecast\f[R] a period expression argument. +A forecast period specified this way can overlap ordinary transactions, +and need not be in the future. +Some things to note: +.RS 2 +.IP \[bu] 2 +You must use \f[C]=\f[R] between flag and argument; a space won\[aq]t +work. +.IP \[bu] 2 +The period expression can specify the forecast period\[aq]s start date, +end date, or both. +See also Report start & end date. +.IP \[bu] 2 +The period expression should not specify a report interval. +(Each periodic transaction rule specifies its own interval.) +.RE .PP -Or, you can set your own arbitrary \[dq]forecast period\[dq], which can -overlap recorded transactions, and need not be in the future, by -providing an option argument, like \f[C]--forecast=PERIODEXPR\f[R]. -Note the equals sign is required, a space won\[aq]t work. -PERIODEXPR is a period expression, which can specify the start date, end -date, or both, like in a \f[C]date:\f[R] query. -(See also hledger.1 -> Report start & end date). Some examples: \f[C]--forecast=202001-202004\f[R], -\f[C]--forecast=jan-\f[R], \f[C]--forecast=2020\f[R]. +\f[C]--forecast=jan-\f[R], \f[C]--forecast=2021\f[R]. .SS Budgeting with periodic transactions .PP With the \f[C]--budget\f[R] flag, currently supported by the balance @@ -8088,7 +8312,9 @@ Tips: Interpolation strips outer whitespace (so a CSV value like \f[C]\[dq] 1 \[dq]\f[R] becomes \f[C]1\f[R] when interpolated) (#1051). .IP \[bu] 2 -See also Tips below. +Interpolations always refer to a CSV field - you can\[aq]t interpolate a +hledger field. +(See Referencing other fields below). .SS Field names .PP Here are the standard hledger field (and pseudo-field) names, which you diff --git a/hledger/hledger.info b/hledger/hledger.info index 7873c8d3f..c3d81dda7 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -1,4 +1,5 @@ -This is hledger.info, produced by makeinfo version 6.8 from stdin. +This is hledger/hledger.info, produced by makeinfo version 4.8 from +stdin. INFO-DIR-SECTION User Applications START-INFO-DIR-ENTRY @@ -6,57 +7,58 @@ START-INFO-DIR-ENTRY END-INFO-DIR-ENTRY  -File: hledger.info, Node: Top, Next: OPTIONS, Up: (dir) +File: hledger.info, Node: Top, Up: (dir) hledger(1) ********** This is the command-line interface (CLI) for the hledger accounting -tool. Here we also describe hledger's concepts and file formats. This +tool. Here we also describe hledger's concepts and file formats. This manual is for hledger 1.22.99. - 'hledger' + `hledger' - 'hledger [-f FILE] COMMAND [OPTIONS] [ARGS]' + `hledger [-f FILE] COMMAND [OPTIONS] [ARGS]' - 'hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]' + `hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]' hledger is a reliable, cross-platform set of programs for tracking money, time, or any other commodity, using double-entry accounting and a -simple, editable file format. hledger is inspired by and largely +simple, editable file format. hledger is inspired by and largely compatible with ledger(1). The basic function of the hledger CLI is to read a plain text file describing financial transactions (in accounting terms, a general journal) and print useful reports on standard output, or export them as CSV. hledger can also read some other file formats such as CSV files, -translating them to journal format. Additionally, hledger lists other +translating them to journal format. Additionally, hledger lists other hledger-* executables found in the user's $PATH and can invoke them as subcommands. hledger reads data from one or more files in hledger journal, -timeclock, timedot, or CSV format specified with '-f', or -'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps -'C:/Users/USER/.hledger.journal'). If using '$LEDGER_FILE', note this -must be a real environment variable, not a shell variable. You can -specify standard input with '-f-'. +timeclock, timedot, or CSV format specified with `-f', or +`$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps +`C:/Users/USER/.hledger.journal'). If using `$LEDGER_FILE', note this +must be a real environment variable, not a shell variable. You can +specify standard input with `-f-'. Transactions are dated movements of money between two (or more) named accounts, and are recorded with journal entries like this: + 2015/10/16 bought food expenses:food $10 assets:cash Most users use a text editor to edit the journal, usually with an -editor mode such as ledger-mode for added convenience. hledger's +editor mode such as ledger-mode for added convenience. hledger's interactive add command is another way to record new transactions. hledger never changes existing transactions. To get started, you can either save some entries like the above in -'~/.hledger.journal', or run 'hledger add' and follow the prompts. Then -try some commands like 'hledger print' or 'hledger balance'. Run -'hledger' with no arguments for a list of commands. +`~/.hledger.journal', or run `hledger add' and follow the prompts. Then +try some commands like `hledger print' or `hledger balance'. Run +`hledger' with no arguments for a list of commands. * Menu: @@ -101,140 +103,137 @@ File: hledger.info, Node: General options, Next: Command options, Up: OPTIONS =================== To see general usage help, including general options which are supported -by most hledger commands, run 'hledger -h'. +by most hledger commands, run `hledger -h'. General help options: -'-h --help' - +`-h --help' show general or COMMAND help -'--man' +`--man' show general or COMMAND user manual with man -'--info' +`--info' show general or COMMAND user manual with info -'--version' +`--version' show general or ADDONCMD version -'--debug[=N]' +`--debug[=N]' show debug output (levels 1-9, default: 1) General input options: -'-f FILE --file=FILE' - - use a different input file. For stdin, use - (default: - '$LEDGER_FILE' or '$HOME/.hledger.journal') -'--rules-file=RULESFILE' +`-f FILE --file=FILE' + use a different input file. For stdin, use - (default: + `$LEDGER_FILE' or `$HOME/.hledger.journal') +`--rules-file=RULESFILE' Conversion rules file to use when reading CSV (default: FILE.rules) -'--separator=CHAR' +`--separator=CHAR' Field separator to expect when reading CSV (default: ',') -'--alias=OLD=NEW' +`--alias=OLD=NEW' rename accounts named OLD to NEW -'--anon' +`--anon' anonymize accounts and payees -'--pivot FIELDNAME' +`--pivot FIELDNAME' use some other field or tag for the account name -'-I --ignore-assertions' +`-I --ignore-assertions' disable balance assertion checks (note: does not disable balance assignments) -'-s --strict' +`-s --strict' do extra error checking (check that all posted accounts are declared) General reporting options: -'-b --begin=DATE' - +`-b --begin=DATE' include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) -'-e --end=DATE' +`-e --end=DATE' include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) -'-D --daily' +`-D --daily' multiperiod/multicolumn report by day -'-W --weekly' +`-W --weekly' multiperiod/multicolumn report by week -'-M --monthly' +`-M --monthly' multiperiod/multicolumn report by month -'-Q --quarterly' +`-Q --quarterly' multiperiod/multicolumn report by quarter -'-Y --yearly' +`-Y --yearly' multiperiod/multicolumn report by year -'-p --period=PERIODEXP' +`-p --period=PERIODEXP' set start date, end date, and/or reporting interval all at once using period expressions syntax -'--date2' +`--date2' match the secondary date instead (see command help for other effects) -'-U --unmarked' +`-U --unmarked' include only unmarked postings/txns (can combine with -P or -C) -'-P --pending' +`-P --pending' include only pending postings/txns -'-C --cleared' +`-C --cleared' include only cleared postings/txns -'-R --real' +`-R --real' include only non-virtual postings -'-NUM --depth=NUM' +`-NUM --depth=NUM' hide/aggregate accounts or postings more than NUM levels deep -'-E --empty' +`-E --empty' show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) -'-B --cost' +`-B --cost' convert amounts to their cost/selling amount at transaction time -'-V --market' +`-V --market' convert amounts to their market value in default valuation commodities -'-X --exchange=COMM' +`-X --exchange=COMM' convert amounts to their market value in commodity COMM -'--value' +`--value' convert amounts to cost or market value, more flexibly than -B/-V/-X -'--infer-market-prices' +`--infer-market-prices' use transaction prices (recorded with @ or @@) as additional market prices, as if they were P directives -'--auto' +`--auto' apply automated posting rules to modify transactions. -'--forecast' +`--forecast' generate future transactions from periodic transaction rules, for - the next 6 months or till report end date. In hledger-ui, also + the next 6 months or till report end date. In hledger-ui, also make ordinary future transactions visible. -'--color=WHEN (or --colour=WHEN)' +`--color=WHEN (or --colour=WHEN)' Should color-supporting commands use ANSI color codes in text output. 'auto' (default): whenever stdout seems to be a color-supporting terminal. 'always' or 'yes': always, useful eg - when piping output into 'less -R'. 'never' or 'no': never. A + when piping output into 'less -R'. 'never' or 'no': never. A NO_COLOR environment variable overrides this. When a reporting option appears more than once in the command line, @@ -249,14 +248,14 @@ File: hledger.info, Node: Command options, Next: Command arguments, Prev: Gen =================== To see options for a particular command, including command-specific -options, run: 'hledger COMMAND -h'. +options, run: `hledger COMMAND -h'. Command-specific options must be written after the command name, eg: -'hledger print -x'. +`hledger print -x'. Additionally, if the command is an add-on, you may need to put its -options after a double-hyphen, eg: 'hledger ui -- --watch'. Or, you can -run the add-on executable directly: 'hledger-ui --watch'. +options after a double-hyphen, eg: `hledger ui -- --watch'. Or, you can +run the add-on executable directly: `hledger-ui --watch'.  File: hledger.info, Node: Command arguments, Next: Special characters, Prev: Command options, Up: OPTIONS @@ -268,32 +267,36 @@ Most hledger commands accept arguments after the command name, which are often a query, filtering the data in some way. You can save a set of command line options/arguments in a file, and -then reuse them by writing '@FILENAME' as a command line argument. Eg: -'hledger bal @foo.args'. (To prevent this, eg if you have an argument -that begins with a literal '@', precede it with '--', eg: 'hledger bal +then reuse them by writing `@FILENAME' as a command line argument. Eg: +`hledger bal @foo.args'. (To prevent this, eg if you have an argument +that begins with a literal `@', precede it with `--', eg: `hledger bal -- @ARG'). Inside the argument file, each line should contain just one option or -argument. Avoid the use of spaces, except inside quotes (or you'll see -a confusing error). Between a flag and its argument, use = (or -nothing). Bad: +argument. Avoid the use of spaces, except inside quotes (or you'll see a +confusing error). Between a flag and its argument, use = (or nothing). +Bad: + assets depth:2 -X USD Good: + assets depth:2 -X=USD For special characters (see below), use one less level of quoting -than you would at the command prompt. Bad: +than you would at the command prompt. Bad: + -X"$" Good: + -X$ See also: Save frequently used options. @@ -318,19 +321,21 @@ File: hledger.info, Node: Single escaping shell metacharacters, Next: Double e -------------------------------------------- In shell command lines, characters significant to your shell - such as -spaces, '<', '>', '(', ')', '|', '$' and '\' - should be "shell-escaped" -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: +spaces, `<', `>', `(', `)', `|', `$' and `\' - should be +"shell-escaped" 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: + $ hledger register 'credit card' or: + $ hledger register credit\ card - Windows users should keep in mind that 'cmd' treats single quote as a -regular character, so you should be using double quotes exclusively. + Windows users should keep in mind that `cmd' treats single quote as +a regular character, so you should be using double quotes exclusively. PowerShell treats both single and double quotes as quotes.  @@ -340,17 +345,19 @@ File: hledger.info, Node: Double escaping regular expression metacharacters, N --------------------------------------------------------- Characters significant in regular expressions (described below) - such -as '.', '^', '$', '[', ']', '(', ')', '|', and '\' - may need to be +as `.', `^', `$', `[', `]', `(', `)', `|', and `\' - may need to be "regex-escaped" if you don't want them to be interpreted by hledger's -regular expression engine. This is done by writing backslashes before +regular expression engine. This is done by writing backslashes before them, but since backslash is typically also a shell metacharacter, both -shell-escaping and regex-escaping will be needed. Eg to match a literal -'$' sign while using the bash shell: +shell-escaping and regex-escaping will be needed. Eg to match a literal +`$' sign while using the bash shell: + $ hledger balance cur:'\$' or: + $ hledger balance cur:\\$  @@ -362,25 +369,28 @@ File: hledger.info, Node: Triple escaping for add-on commands, Next: Less esca 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 '$' sign while using the -bash shell and running an add-on command ('ui'): +level of shell-escaping. Eg to match a literal `$' sign while using the +bash shell and running an add-on command (`ui'): + $ hledger ui cur:'\\$' or: + $ hledger ui cur:\\\\$ If you wondered why _four_ backslashes, perhaps this helps: -unescaped: '$' -escaped: '\$' -double-escaped: '\\$' -triple-escaped: '\\\\$' +unescaped: `$' +escaped: `\$' +double-escaped: `\\$' +triple-escaped: `\\\\$' Or, you can avoid the extra escaping by running the add-on executable directly: + $ hledger-ui cur:\\$  @@ -391,11 +401,14 @@ File: hledger.info, Node: Less escaping, Prev: Triple escaping for add-on comm Options and arguments are sometimes used in places other than the shell command line, where shell-escaping is not needed, so there you should -use one less level of escaping. Those places include: +use one less level of escaping. Those places include: * an @argumentfile + * hledger-ui's filter field + * hledger-web's search form + * GHCI's prompt (used by developers).  @@ -413,12 +426,13 @@ hledger is expected to handle non-ascii characters correctly: * 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: + + This requires a well-configured environment. Here are some tips: * A system locale must be configured, and it must be one that can - decode the characters being used. In bash, you can set a locale - like this: 'export LANG=en_US.UTF-8'. There are some more details - in Troubleshooting. This step is essential - without it, hledger + decode the characters being used. In bash, you can set a locale + like this: `export LANG=en_US.UTF-8'. 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). @@ -432,11 +446,12 @@ hledger is expected to handle non-ascii characters correctly: double width (for report alignment) * on Windows, for best results you should run hledger in the same - kind of environment in which it was built. Eg hledger built in the + kind of environment in which it was built. Eg hledger built in the standard CMD.EXE environment (like the binaries on our download page) might show display problems when run in a cygwin or msys terminal, and vice versa. (See eg #961). +  File: hledger.info, Node: Regular expressions, Prev: Unicode characters, Up: OPTIONS @@ -446,41 +461,49 @@ File: hledger.info, Node: Regular expressions, Prev: Unicode characters, Up: hledger uses regular expressions in a number of places: * query terms, on the command line and in the hledger-web search - form: 'REGEX', 'desc:REGEX', 'cur:REGEX', 'tag:...=REGEX' - * CSV rules conditional blocks: 'if REGEX ...' - * account alias directives and options: 'alias /REGEX/ = - REPLACEMENT', '--alias /REGEX/=REPLACEMENT' + form: `REGEX', `desc:REGEX', `cur:REGEX', `tag:...=REGEX' - hledger's regular expressions come from the regex-tdfa library. If + * CSV rules conditional blocks: `if REGEX ...' + + * account alias directives and options: `alias /REGEX/ = + REPLACEMENT', `--alias /REGEX/=REPLACEMENT' + + hledger's regular expressions come from the regex-tdfa library. If they're not doing what you expect, it's important to know exactly what they support: 1. they are case insensitive + 2. they are infix matching (they do not need to match the entire thing being matched) + 3. they are POSIX ERE (extended regular expressions) - 4. they also support GNU word boundaries ('\b', '\B', '\<', '\>') - 5. they do not support backreferences; if you write '\1', it will - match the digit '1'. Except when doing text replacement, eg in + + 4. they also support GNU word boundaries (`\b', `\B', `\<', `\>') + + 5. they do not support backreferences; if you write `\1', it will + match the digit `1'. Except when doing text replacement, eg in account aliases, where backreferences can be used in the replacement string to reference capturing groups in the search regexp. - 6. they do not support mode modifiers ('(?s)'), character classes - ('\w', '\d'), or anything else not mentioned above. + + 6. they do not support mode modifiers (`(?s)'), character classes + (`\w', `\d'), or anything else not mentioned above. Some things to note: - * In the 'alias' directive and '--alias' option, regular expressions - must be enclosed in forward slashes ('/REGEX/'). Elsewhere in + * In the `alias' directive and `--alias' option, regular expressions + must be enclosed in forward slashes (`/REGEX/'). Elsewhere in hledger, these are not required. - * In queries, to match a regular expression metacharacter like '$' as - a literal character, prepend a backslash. Eg to search for amounts - with the dollar sign in hledger-web, write 'cur:\$'. + * In queries, to match a regular expression metacharacter like `$' as + a literal character, prepend a backslash. Eg to search for amounts + with the dollar sign in hledger-web, write `cur:\$'. + + * On the command line, some metacharacters like `$' have a special + meaning to the shell and so must be escaped at least once more. See + Special characters. - * On the command line, some metacharacters like '$' have a special - meaning to the shell and so must be escaped at least once more. - See Special characters.  File: hledger.info, Node: ENVIRONMENT, Next: DATA FILES, Prev: OPTIONS, Up: Top @@ -488,31 +511,32 @@ File: hledger.info, Node: ENVIRONMENT, Next: DATA FILES, Prev: OPTIONS, Up: 2 ENVIRONMENT ************* -*LEDGER_FILE* The journal file path when not specified with '-f'. -Default: '~/.hledger.journal' (on windows, perhaps -'C:/Users/USER/.hledger.journal'). +*LEDGER_FILE* The journal file path when not specified with `-f'. +Default: `~/.hledger.journal' (on windows, perhaps +`C:/Users/USER/.hledger.journal'). - A typical value is '~/DIR/YYYY.journal', where DIR is a -version-controlled finance directory and YYYY is the current year. Or -'~/DIR/current.journal', where current.journal is a symbolic link to + A typical value is `~/DIR/YYYY.journal', where DIR is a +version-controlled finance directory and YYYY is the current year. Or +`~/DIR/current.journal', where current.journal is a symbolic link to YYYY.journal. - On Mac computers, you can set this and other environment variables in -a more thorough way that also affects applications started from the GUI -(say, an Emacs dock icon). Eg on MacOS Catalina I have a -'~/.MacOSX/environment.plist' file containing + On Mac computers, you can set this and other environment variables +in a more thorough way that also affects applications started from the +GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a +`~/.MacOSX/environment.plist' file containing + { "LEDGER_FILE" : "~/finance/current.journal" } - To see the effect you may need to 'killall Dock', or reboot. + To see the effect you may need to `killall Dock', or reboot. - *COLUMNS* The screen width used by the register command. Default: + *COLUMNS* The screen width used by the register command. Default: the full terminal width. *NO_COLOR* If this variable exists with any value, hledger will not -use ANSI color codes in terminal output. This overrides the +use ANSI color codes in terminal output. This overrides the -color/-colour option.  @@ -521,20 +545,23 @@ File: hledger.info, Node: DATA FILES, Next: TIME PERIODS, Prev: ENVIRONMENT, 3 DATA FILES ************ -hledger reads transactions from one or more data files. The default -data file is '$HOME/.hledger.journal' (or on Windows, something like -'C:/Users/USER/.hledger.journal'). +hledger reads transactions from one or more data files. The default data +file is `$HOME/.hledger.journal' (or on Windows, something like +`C:/Users/USER/.hledger.journal'). + + You can override this with the `$LEDGER_FILE' environment variable: - You can override this with the '$LEDGER_FILE' environment variable: $ setenv LEDGER_FILE ~/finance/2016.journal $ hledger stats - or with one or more '-f/--file' options: + or with one or more `-f/--file' options: + $ hledger -f /some/file -f another_file stats - The file name '-' means standard input: + The file name `-' means standard input: + $ cat some.journal | hledger -f- @@ -555,31 +582,32 @@ any of the supported file formats, which currently are: Reader: Reads: Used for file extensions: --------------------------------------------------------------------------- -'journal'hledger journal files and some Ledger '.journal' '.j' - journals, for transactions '.hledger' '.ledger' -'timeclock'timeclock files, for precise time '.timeclock' - logging -'timedot'timedot files, for approximate time '.timedot' - logging -'csv' comma/semicolon/tab/other-separated '.csv' '.ssv' '.tsv' - values, for data import +-------------------------------------------------------------------------- +`journal'hledger journal files and some Ledger `.journal' `.j' + journals, for transactions `.hledger' `.ledger' +`timeclock'timeclock files, for precise time `.timeclock' + logging +`timedot'timedot files, for approximate time `.timedot' + logging +`csv' comma/semicolon/tab/other-separated `.csv' `.ssv' `.tsv' + values, for data import These formats are described in their own sections, below. hledger detects the format automatically based on the file extensions -shown above. If it can't recognise the file extension, it assumes -'journal' format. So for non-journal files, it's important to use a +shown above. If it can't recognise the file extension, it assumes +`journal' format. So for non-journal files, it's important to use a recognised file extension, so as to either read successfully or to show relevant error messages. You can also force a specific reader/format by prefixing the file -path with the format and a colon. Eg, to read a .dat file as csv -format: +path with the format and a colon. Eg, to read a .dat file as csv format: + $ hledger -f csv:/some/csv-file.dat stats - Or to read stdin ('-') as timeclock format: + Or to read stdin (`-') as timeclock format: + $ echo 'i 2009/13/1 08:00:00' | hledger print -ftimeclock:- @@ -589,17 +617,19 @@ File: hledger.info, Node: Multiple files, Next: Strict mode, Prev: Data forma 3.2 Multiple files ================== -You can specify multiple '-f' options, to read multiple files as one big -journal. There are some limitations with this: +You can specify multiple `-f' options, to read multiple files as one +big journal. There are some limitations with this: * most directives do not affect sibling files + * balance assertions will not see any account balances from previous files If you need either of those things, you can * use a single parent file which includes the others - * or concatenate the files into one before reading, eg: 'cat + + * or concatenate the files into one before reading, eg: `cat a.journal b.journal | hledger -f- CMD'.  @@ -608,20 +638,24 @@ File: hledger.info, Node: Strict mode, Prev: Multiple files, Up: DATA FILES 3.3 Strict mode =============== -hledger checks input files for valid data. By default, the most +hledger checks input files for valid data. By default, the most important errors are detected, while still accepting easy journal files without a lot of declarations: * Are the input files parseable, with valid syntax ? + * Are all transactions balanced ? + * Do all balance assertions pass ? - With the '-s'/'--strict' flag, additional checks are performed: + With the `-s'/`--strict' flag, additional checks are performed: - * Are all accounts posted to, declared with an 'account' directive ? + * Are all accounts posted to, declared with an `account' directive ? (Account error checking) - * Are all commodities declared with a 'commodity' directive ? + + * Are all commodities declared with a `commodity' directive ? (Commodity error checking) + * Are all commodity conversions declared explicitly ? You can also use the check command to run these and some additional @@ -646,37 +680,39 @@ File: hledger.info, Node: Smart dates, Next: Report start & end date, Up: TIM 4.1 Smart dates =============== -hledger's user interfaces accept a flexible "smart date" syntax. Smart +hledger's user interfaces accept a flexible "smart date" syntax. Smart dates allow some english words, can be relative to today's date, and can have less-significant date parts omitted (defaulting to 1). Examples: -'2004/10/1', exact date, several separators allowed. Year -'2004-01-01', is 4+ digits, month is 1-12, day is 1-31 -'2004.9.1' -'2004' start of year -'2004/10' start of month -'10/1' month and day in current year -'21' day in current month -'october, oct' start of month in current year -'yesterday, today, -1, 0, 1 days from today -tomorrow' -'last/this/next -1, 0, 1 periods from the current period +`2004/10/1', exact date, several separators allowed. Year +`2004-01-01', `2004.9.1' is 4+ digits, month is 1-12, day is 1-31 +`2004' start of year +`2004/10' start of month +`10/1' month and day in current year +`21' day in current month +`october, oct' start of month in current year +`yesterday, today, -1, 0, 1 days from today +tomorrow' +`last/this/next -1, 0, 1 periods from the current period day/week/month/quarter/year' -'20181201' 8 digit YYYYMMDD with valid year month and - day -'201812' 6 digit YYYYMM with valid year and month +`20181201' 8 digit YYYYMMDD with valid year month and day +`201812' 6 digit YYYYMM with valid year and month 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 +`20181232' 8 digits with an invalid day gives an error +`201801012' 9+ digits beginning with a valid YYYYMMDD gives an error + + Note "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; those are not affected by `--today'.)  File: hledger.info, Node: Report start & end date, Next: Report intervals, Prev: Smart dates, Up: TIME PERIODS @@ -685,43 +721,46 @@ File: hledger.info, Node: Report start & end date, Next: Report intervals, Pr =========================== By default, most hledger reports will show the full span of time -represented by the journal data. The report start date will be the +represented by the journal data. 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', -'-e/--end', '-p/--period' or a 'date:' query (described below). All of +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. Some notes: - * As in Ledger, end dates are exclusive, so you need to write the - date _after_ the last day you want to include. + * End dates are exclusive, as in Ledger, so you should write the date + _after_ the last day you want to see in the report. + * As noted in reporting options: among start/end dates specified with - _options_, the last (i.e. right-most) option takes precedence. + _options_, the last (i.e. right-most) option takes precedence. + * 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 + 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. + * A report interval (see below) will adjust start/end dates, when needed, so that they fall on subperiod boundaries. Examples: -'-b begin on St. Patrick's day 2016 -2016/3/17' -'-e 12/1' end at the start of december 1st of the current year +`-b begin on St. Patrick's day 2016 +2016/3/17' +`-e 12/1' end at the start of december 1st of the current year (11/30 will be the last date included) -'-b all transactions on or after the 1st of the current month -thismonth' -'-p all transactions in the current month -thismonth' -'date:2016/3/17..'the above written as queries instead ('..' can also be - replaced with '-') -'date:..12/1' -'date:thismonth..' -'date:thismonth' +`-b all transactions on or after the 1st of the current month +thismonth' +`-p all transactions in the current month +thismonth' +`date:2016/3/17..'the above written as queries instead (`..' can also be + replaced with `-') +`date:..12/1' +`date:thismonth..' +`date:thismonth'  File: hledger.info, Node: Report intervals, Next: Period expressions, Prev: Report start & end date, Up: TIME PERIODS @@ -736,152 +775,265 @@ separate row or column. The following "standard" report intervals can be enabled by using their corresponding flag: - '-D/--daily', '-W/--weekly', '-M/--monthly', '-Q/--quarterly', -'-Y/--yearly'. + * `-D/--daily' - These standard intervals always start on natural interval boundaries: -eg '--weekly' starts on mondays, '--monthly' starts on the first of the -month, '--yearly' always starts on January 1st, etc. + * `-W/--weekly' - Certain more complex intervals, and more flexible boundary dates, can -be specified by '-p/--period'. These are described in period + * `-M/--monthly' + + * `-Q/--quarterly' + + * `-Y/--yearly' + + These standard intervals always start on natural interval +boundaries: eg `--weekly' starts on mondays, `--monthly' starts on the +first of the month, `--yearly' always starts on January 1st, etc. + + Certain more complex intervals, and more flexible boundary dates, +can be specified by `-p/--period'. These are described in period expressions, below. Report intervals can only be specified by the flags above, and not by query arguments, currently. Report intervals have another effect: multi-period reports are always -expanded to fill a whole number of subperiods. So if you use a report -interval (other than '--daily'), and you have specified a start or end -date, you may notice those dates being overridden (ie, the report starts -earlier than your requested start date, or ends later than your -requested end date). This is done to ensure "full" first and last +expanded to fill a whole number of subperiods. So if you use a report +interval (other than `--daily'), and you have specified a start or end +date, you may notice those dates being overridden (ie, the report +starts earlier than your requested start date, or ends later than your +requested end date). This is done to ensure "full" first and last subperiods, so that all subperiods' numbers are comparable. + To summarise: + + * In multiperiod reports, all subperiods are forced to be the same + length, to simplify reporting. + + * Reports with the standard + `--weekly'/`--monthly'/`--quarterly'/`--yearly' intervals are + required to start on the first day of a week/month/quarter/year. + We'd like more flexibility here but it isn't supported yet. + + * `--period' (below) can specify more complex intervals, starting on + any date. +  File: hledger.info, Node: Period expressions, Prev: Report intervals, Up: TIME PERIODS 4.4 Period expressions ====================== -The '-p/--period' option accepts period expressions, a shorthand way of +The `-p/--period' option accepts period expressions, a shorthand way of expressing a start date, end date, and/or report interval all at once. Here's a basic period expression specifying the first quarter of 2009. Note, hledger always treats start dates as inclusive and end dates as exclusive: - '-p "from 2009/1/1 to 2009/4/1"' +`-p "from 2009/1/1 to 2009/4/1"' Keywords like "from" and "to" are optional, and so are the spaces, as -long as you don't run two dates together. "to" can also be written as -".." or "-". These are equivalent to the above: +long as you don't run two dates together. "to" can also be written as +".." or "-". These are equivalent to the above: -'-p "2009/1/1 2009/4/1"' -'-p2009/1/1to2009/4/1' -'-p2009/1/1..2009/4/1' +`-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, the above can also be written as: -'-p "1/1 4/1"' -'-p "january-apr"' -'-p "this year to 4/1"' +`-p "1/1 4/1"' +`-p "january-apr"' +`-p "this year to 4/1"' If you specify only one date, the missing start or end date will be the earliest or latest transaction in your journal: -'-p "from 2009/1/1"' everything after january 1, 2009 -'-p "from 2009/1"' the same -'-p "from 2009"' the same -'-p "to 2009"' everything before january 1, 2009 +`-p "from 2009/1/1"' everything after january 1, 2009 +`-p "from 2009/1"' the same +`-p "from 2009"' the same +`-p "to 2009"' everything before january 1, 2009 A single date with no "from" or "to" defines both the start and end date like so: -'-p "2009"' the year 2009; equivalent to “2009/1/1 to 2010/1/1” -'-p "2009/1"' the month of jan; equivalent to “2009/1/1 to 2009/2/1” -'-p "2009/1/1"' just that day; equivalent to “2009/1/1 to 2009/1/2” +`-p "2009"' the year 2009; equivalent to “2009/1/1 to 2010/1/1” +`-p "2009/1"' the month of jan; equivalent to “2009/1/1 to 2009/2/1” +`-p "2009/1/1"' just that day; equivalent to “2009/1/1 to 2009/1/2” Or you can specify a single quarter like so: -'-p "2009Q1"' first quarter of 2009, equivalent to “2009/1/1 to 2009/4/1” -'-p "q4"' fourth quarter of the current year +`-p "2009Q1"' first quarter of 2009, equivalent to “2009/1/1 to 2009/4/1” +`-p "q4"' fourth quarter of the current year - The argument of '-p' can also begin with, or be, a report interval -expression. The basic report intervals are 'daily', 'weekly', -'monthly', 'quarterly', or 'yearly', which have the same effect as the -'-D','-W','-M','-Q', or '-Y' flags. Between report interval and -start/end dates (if any), the word 'in' is optional. Examples: +* Menu: -'-p "weekly from 2009/1/1 to 2009/4/1"' -'-p "monthly in 2008"' -'-p "quarterly"' +* Period expressions with a report interval:: +* More complex report intervals:: +* Intervals with custom start date:: +* Periods or dates ?:: +* Events on multiple weekdays:: - Note that 'weekly', 'monthly', 'quarterly' and 'yearly' intervals -will always start on the first day on week, month, quarter or year -accordingly, and will end on the last day of same period, even if -associated period expression specifies different explicit start and end -date. + +File: hledger.info, Node: Period expressions with a report interval, Next: More complex report intervals, Up: Period expressions + +4.4.1 Period expressions with a report interval +----------------------------------------------- + +`-p/--period''s argument can also begin with, or entirely consist of, a +report interval. This should be separated from the start/end dates (if +any) by a space, or the word `in'. The basic intervals (which can also +be written as command line flags) are `daily', `weekly', `monthly', +`quarterly', and `yearly'. Some examples: + +`-p "weekly from 2009/1/1 to 2009/4/1"' +`-p "monthly in 2008"' +`-p "quarterly"' + + As mentioned above, the `weekly', `monthly', `quarterly' and +`yearly' intervals require a report start date that is the first day of +a week, month, quarter or year. And, report start/end dates will be +expanded if needed to span a whole number of intervals. For example: -'-p "weekly from starts on 2008/12/29, closest preceding -2009/1/1 to 2009/4/1"' Monday -'-p "monthly in starts on 2018/11/01 -2008/11/25"' -'-p "quarterly from starts on 2009/04/01, ends on 2009/06/30, -2009-05-05 to which are first and last days of Q2 2009 -2009-06-01"' -'-p "yearly from starts on 2009/01/01, first day of 2009 -2009-12-29"' +`-p "weekly from 2009/1/1 starts on 2008/12/29, closest preceding Monday +to 2009/4/1"' +`-p "monthly in starts on 2018/11/01 +2008/11/25"' +`-p "quarterly from starts on 2009/04/01, ends on 2009/06/30, +2009-05-05 to 2009-06-01"' which are first and last days of Q2 2009 +`-p "yearly from starts on 2009/01/01, first day of 2009 +2009-12-29"' - The following more complex report intervals are also supported: -'biweekly', 'fortnightly', 'bimonthly', 'every -day|week|month|quarter|year', 'every N -days|weeks|months|quarters|years'. + +File: hledger.info, Node: More complex report intervals, Next: Intervals with custom start date, Prev: Period expressions with a report interval, Up: Period expressions - All of these will start on the first day of the requested period and -end on the last one, as described above. +4.4.2 More complex report intervals +----------------------------------- - Examples: +Some more complex kinds of interval are also supported in period +expressions: -'-p "bimonthly from periods will have boundaries on 2008/01/01, -2008"' 2008/03/01, ... -'-p "every 2 weeks"' starts on closest preceding Monday -'-p "every 5 month from periods will have boundaries on 2009/03/01, + * `biweekly' + + * `fortnightly' + + * `bimonthly' + + * `every day|week|month|quarter|year' + + * `every N days|weeks|months|quarters|years' + + These too will cause report start/end dates to be expanded, if +needed, to span a whole number of intervals. Examples: + +`-p "bimonthly from 2008"' periods will have boundaries on 2008/01/01, + 2008/03/01, ... +`-p "every 2 weeks"' starts on closest preceding Monday +`-p "every 5 month from periods will have boundaries on 2009/03/01, 2009/03"' 2009/08/01, ... - If you want intervals that start on arbitrary day of your choosing -and span a week, month or year, you need to use any of the following: + +File: hledger.info, Node: Intervals with custom start date, Next: Periods or dates ?, Prev: More complex report intervals, Up: Period expressions - 'every Nth day of week', 'every WEEKDAYNAME' (eg -'mon|tue|wed|thu|fri|sat|sun'), 'every Nth day [of month]', 'every Nth -WEEKDAYNAME [of month]', 'every MM/DD [of year]', 'every Nth MMM [of -year]', 'every MMM Nth [of year]'. +4.4.3 Intervals with custom start date +-------------------------------------- + +All intervals mentioned above are required to start on their natural +calendar boundaries, but the following intervals can start on any date: + + Weekly on custom day: + + * `every Nth day of week' (`th', `nd', `rd', or `st' are all + accepted after the number) + + * `every WEEKDAYNAME' (full or three-letter english weekday name, + case insensitive) + + Monthly on custom day: + + * `every Nth day [of month]' + + * `every Nth WEEKDAYNAME [of month]' + + Yearly on custom day: + + * `every MM/DD [of year]' (month number and day of month number) + + * `every MONTHNAME DDth [of year]' (full or three-letter english + month name, case insensitive, and day of month number) + + * `every DDth MONTHNAME [of year]' (equivalent to the above) Examples: -'-p "every 2nd day of periods will go from Tue to Tue -week"' -'-p "every Tue"' same -'-p "every 15th day"' period boundaries will be on 15th of each - month -'-p "every 2nd period boundaries will be on second Monday of -Monday"' each month -'-p "every 11/05"' yearly periods with boundaries on 5th of Nov -'-p "every 5th Nov"' same -'-p "every Nov 5th"' same +`-p "every 2nd day of periods will go from Tue to Tue +week"' +`-p "every Tue"' same +`-p "every 15th day"' period boundaries will be on 15th of each month +`-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 + November +`-p "every 5th same +November"' +`-p "every Nov 5th"' same - Show historical balances at end of 15th each month (N is exclusive -end date): + 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 start of wednesday to end of next tuesday (N is -start date and exclusive end date): +$ hledger balance -H -p "every 16th day" - 'hledger register checking -p "every 3rd day of week"' + 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" + + +File: hledger.info, Node: Periods or dates ?, Next: Events on multiple weekdays, Prev: Intervals with custom start date, Up: Period expressions + +4.4.4 Periods or dates ? +------------------------ + +Report intervals like the above are most often used with `-p|--period', +to divide reports into multiple subperiods - each generated date marks +a subperiod boundary. Here, the periods between the dates are what's +important. + + But report intervals can also be used with `--forecast' to generate +future transactions, or with `balance --budget' to generate budget +goal-setting transactions. For these, the dates themselves are what +matters. + + +File: hledger.info, Node: Events on multiple weekdays, Prev: Periods or dates ?, Up: Period expressions + +4.4.5 Events on multiple weekdays +--------------------------------- + +The `every WEEKDAYNAME' form has a special variant with multiple day +names, comma-separated. Eg: `every mon,thu,sat'. Also, `weekday' and +`weekendday' are shorthand for `mon,tue,wed,thu,fri' and `sat,sun' +respectively. + + This form 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. (Because gaps between periods are not allowed; if you'd like to +change this, see #1632.) + + Examples: + +`-p "every dates will be Mon, Wed, Fri; periods will be Mon-Tue, +mon,wed,fri"' Wed-Thu, Fri-Sun +`-p "every dates will be Mon, Tue, Wed, Thu, Fri; periods will +weekday"' be Mon, Tue, Wed, Thu, Fri-Sun +`-p "every dates will be Sat, Sun; periods will be Sat, Sun-Fri +weekendday"'  File: hledger.info, Node: DEPTH, Next: QUERIES, Prev: TIME PERIODS, Up: Top @@ -889,11 +1041,11 @@ File: hledger.info, Node: DEPTH, Next: QUERIES, Prev: TIME PERIODS, Up: Top 5 DEPTH ******* -With the '--depth N' option (short form: '-N'), commands like account, -balance and register will show only the uppermost accounts in the -account tree, down to level N. Use this when you want a summary with -less detail. This flag has the same effect as a 'depth:' query argument -(so '-2', '--depth=2' or 'depth:2' are equivalent). +With the `--depth NUM' option (short form: `-NUM'), commands like +account, balance and register will show only the uppermost accounts in +the account tree, down to level NUM. Use this when you want a summary +with less detail. This flag has the same effect as a `depth:' query +argument: `depth:2', `--depth=2' or `-2' are equivalent.  File: hledger.info, Node: QUERIES, Next: COSTING, Prev: DEPTH, Up: Top @@ -902,30 +1054,31 @@ File: hledger.info, Node: QUERIES, Next: COSTING, 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 optional query +arguments to restrict their scope. The syntax is as follows: - * Zero or more space-separated query terms. These are most often + * Zero or more space-separated query terms. These are most often account name substrings: - 'utilities food:groceries' + `utilities food:groceries' * Terms with spaces or other special characters should be enclosed in quotes: - '"personal care"' + `"personal care"' * Regular expressions are also supported: - '"^expenses\b" "accounts (payable|receivable)"' + `"^expenses\b" "accounts (payable|receivable)"' * Add a query type prefix to match other parts of the data: - 'date:202012- desc:amazon cur:USD amt:">100" status:' + `date:202012- desc:amazon cur:USD amt:">100" status:' - * Add a 'not:' prefix to negate a term: + * Add a `not:' prefix to negate a term: + + `not:cur:USD' - 'not:cur:USD' * Menu: @@ -943,73 +1096,73 @@ File: hledger.info, Node: Query types, Next: Combining query terms, Up: QUERI 6.1 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. +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'* + *`acct:REGEX', `REGEX'* Match account names containing this (case insensitive) regular -expression. This is the default query type when there is no prefix, and +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'. +write an account name substring, like `expenses' or `food'. - *'amt:N, amt:N, amt:>=N'* + *`amt:N, amt:N, amt:>=N'* Match postings with a single-commodity amount equal to, less than, or greater than N. (Postings with multi-commodity amounts are not tested -and will always match.) The comparison has two modes: if N is preceded +and will always match.) The comparison has two modes: if N is preceded by a + or - sign (or is 0), the two signed numbers are compared. Otherwise, the absolute magnitudes are compared, ignoring sign. - *'code:REGEX'* + *`code:REGEX'* Match by transaction code (eg check number). - *'cur:REGEX'* + *`cur:REGEX'* Match postings or transactions including any amounts whose currency/commodity symbol is fully matched by REGEX. (For a partial -match, use '.*REGEX.*'). Note, to match special characters which are -regex-significant, you need to escape them with '\'. And for characters +match, use `.*REGEX.*'). Note, to match special characters which are +regex-significant, you need to escape them with `\'. And for characters which are significant to your shell you may need one more level of -escaping. So eg to match the dollar sign: -'hledger print cur:\\$'. +escaping. So eg to match the dollar sign: +`hledger print cur:\\$'. - *'desc:REGEX'* + *`desc:REGEX'* Match transaction descriptions. - *'date:PERIODEXPR'* -Match dates (or with the '--date2' flag, secondary dates) within the -specified period. PERIODEXPR is a period expression with no report -interval. Examples: -'date:2016', 'date:thismonth', 'date:2/1-2/15', -'date:2021-07-27..nextquarter'. + *`date:PERIODEXPR'* +Match dates (or with the `--date2' flag, secondary dates) within the +specified period. PERIODEXPR is a period expression with no report +interval. Examples: +`date:2016', `date:thismonth', `date:2/1-2/15', +`date:2021-07-27..nextquarter'. - *'date2:PERIODEXPR'* + *`date2:PERIODEXPR'* Match secondary dates within the specified period (independent of the -'--date2' flag). +`--date2' flag). - *'depth:N'* + *`depth:N'* Match (or display, depending on command) accounts at or above this depth. - *'note:REGEX'* -Match transaction notes (the part of the description right of '|', or -the whole description if there's no '|'). + *`note:REGEX'* +Match transaction notes (the part of the description right of `|', or +the whole description if there's no `|'). - *'payee:REGEX'* + *`payee:REGEX'* Match transaction payee/payer names (the part of the description left of -'|', or the whole description if there's no '|'). +`|', or the whole description if there's no `|'). - *'real:, real:0'* + *`real:, real:0'* Match real or virtual postings respectively. - *'status:, status:!, status:*'* + *`status:, status:!, status:*'* Match unmarked, pending, or cleared transactions respectively. - *'tag:REGEX[=REGEX]'* -Match by tag name, and optionally also by tag value. (To match only by -value, use 'tag:.=REGEX'.) Note that postings also inherit tags from + *`tag:REGEX[=REGEX]'* +Match by tag name, and optionally also by tag value. (To match only by +value, use `tag:.=REGEX'.) Note that postings also inherit tags from their transaction, and transactions also acquire tags from their postings, when querying. - (*'inacct:ACCTNAME'* + (*`inacct:ACCTNAME'* A special query term used automatically in hledger-web only: tells hledger-web to show the transaction register for an account.) @@ -1022,20 +1175,27 @@ File: hledger.info, Node: Combining query terms, Next: Queries and command opt Most commands select things which match: * any of the description terms AND + * any of the account terms AND + * any of the status terms AND + * all the other terms. while the print command shows transactions which: * match any of the description terms AND + * have any postings matching any of the positive account terms AND + * have no postings matching any of the negative account terms AND + * match all the other terms. You can do more powerful queries (such as AND-ing two like terms) by -running a first query with 'print', and piping the result into a second -hledger command. Eg: how much of food expenses was paid with cash ? +running a first query with `print', and piping the result into a second +hledger command. Eg: how much of food expenses was paid with cash ? + $ hledger print assets:cash | hledger -f- -I balance expenses:food @@ -1048,9 +1208,9 @@ File: hledger.info, Node: Queries and command options, Next: Queries and accou 6.3 Queries and command options =============================== -Some queries can also be expressed as command-line options: 'depth:2' is -equivalent to '--depth 2', 'date:2020' is equivalent to '-p 2020', etc. -When you mix command options and query arguments, generally the +Some queries can also be expressed as command-line options: `depth:2' +is equivalent to `--depth 2', `date:2020' is equivalent to `-p 2020', +etc. When you mix command options and query arguments, generally the resulting query is their intersection.  @@ -1059,8 +1219,8 @@ File: hledger.info, Node: Queries and account aliases, Next: Queries and valua 6.4 Queries and account aliases =============================== -When account names are rewritten with '--alias' or 'alias', 'acct:' will -match either the old or the new account name. +When account names are rewritten with `--alias' or `alias', `acct:' +will match either the old or the new account name.  File: hledger.info, Node: Queries and valuation, Next: Querying with account aliases, Prev: Queries and account aliases, Up: QUERIES @@ -1069,7 +1229,7 @@ File: hledger.info, Node: Queries and valuation, Next: Querying with account a ========================= When amounts are converted to other commodities in cost or value -reports, 'cur:' and 'amt:' match the old commodity symbol and the old +reports, `cur:' and `amt:' match the old commodity symbol and the old amount quantity, not the new ones (except in hledger 1.22.0 where it's reversed, see #1625). @@ -1079,8 +1239,8 @@ File: hledger.info, Node: Querying with account aliases, Next: Querying with c 6.6 Querying with account aliases ================================= -When account names are rewritten with '--alias' or 'alias', note that -'acct:' will match either the old or the new account name. +When account names are rewritten with `--alias' or `alias', note that +`acct:' will match either the old or the new account name.  File: hledger.info, Node: Querying with cost or value, Prev: Querying with account aliases, Up: QUERIES @@ -1089,8 +1249,8 @@ File: hledger.info, Node: Querying with cost or value, Prev: Querying with acc =============================== When amounts are converted to other commodities in cost or value -reports, note that 'cur:' matches the new commodity symbol, and not the -old one, and 'amt:' matches the new quantity, and not the old one. +reports, note that `cur:' matches the new commodity symbol, and not the +old one, and `amt:' matches the new quantity, and not the old one. Note: this changed in hledger 1.22, previously it was the reverse, see the discussion at #1625. @@ -1100,8 +1260,8 @@ File: hledger.info, Node: COSTING, Next: VALUATION, Prev: QUERIES, Up: Top 7 COSTING ********* -The '-B/--cost' flag converts amounts to their cost or sale amount at -transaction time, if they have a transaction price specified. If this +The `-B/--cost' flag converts amounts to their cost or sale amount at +transaction time, if they have a transaction price specified. If this flag is supplied, hledger will perform cost conversion first, and will apply any market price valuations (if requested) afterwards. @@ -1114,9 +1274,9 @@ File: hledger.info, Node: VALUATION, Next: PIVOTING, Prev: COSTING, Up: Top Instead of reporting amounts in their original commodity, hledger can convert them to cost/sale amount (using the conversion rate recorded in the transaction), and/or to market value (using some market price on a -certain date). This is controlled by the '--value=TYPE[,COMMODITY]' -option, which will be described below. We also provide the simpler '-V' -and '-X COMMODITY' options, and often one of these is all you need: +certain date). This is controlled by the `--value=TYPE[,COMMODITY]' +option, which will be described below. We also provide the simpler `-V' +and `-X COMMODITY' options, and often one of these is all you need: * Menu: @@ -1137,9 +1297,9 @@ File: hledger.info, Node: -V Value, Next: -X Value in specified commodity, Up 8.1 -V: Value ============= -The '-V/--market' flag converts amounts to market value in their default -_valuation commodity_, using the market prices in effect on the -_valuation date(s)_, if any. More on these in a minute. +The `-V/--market' flag converts amounts to market value in their +default _valuation commodity_, using the market prices in effect on the +_valuation date(s)_, if any. More on these in a minute.  File: hledger.info, Node: -X Value in specified commodity, Next: Valuation date, Prev: -V Value, Up: VALUATION @@ -1147,7 +1307,7 @@ File: hledger.info, Node: -X Value in specified commodity, Next: Valuation dat 8.2 -X: Value in specified commodity ==================================== -The '-X/--exchange=COMM' option is like '-V', except you tell it which +The `-X/--exchange=COMM' option is like `-V', except you tell it which currency you want to convert to, and it tries to convert everything to that. @@ -1165,8 +1325,8 @@ prices will be used. specified, that will be used as the valuation date; otherwise the valuation date is the journal's end date. - For multiperiod reports, each column/period is valued on the last day -of the period, by default. + For multiperiod reports, each column/period is valued on the last +day of the period, by default.  File: hledger.info, Node: Market prices, Next: --infer-market-price market prices from transactions, Prev: Valuation date, Up: VALUATION @@ -1180,7 +1340,7 @@ this order of preference : 1. A _declared market price_ or _inferred market price_: A's latest market price in B on or before the valuation date as declared by a - P directive, or (with the '--infer-market-price' flag) inferred + P directive, or (with the `--infer-market-price' flag) inferred from transaction prices. 2. A _reverse market price_: the inverse of a declared or inferred @@ -1194,10 +1354,11 @@ this order of preference : including both forward and reverse prices (1 and 2 above), leading from A to B. + There is a limit to the length of these price chains; if hledger reaches that length without finding a complete chain or exhausting all possibilities, it will give up (with a "gave up" message visible in -'--debug=2' output). That limit is currently 1000. +`--debug=2' output). That limit is currently 1000. Amounts for which no suitable market price can be found, are not converted. @@ -1209,32 +1370,33 @@ File: hledger.info, Node: --infer-market-price 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 +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 transaction prices as additional market -prices (as Ledger does) ? We could produce value reports without -needing P directives at all. +prices (as Ledger does) ? We could produce value reports without needing +P directives at all. - Adding the '--infer-market-price' flag to '-V', '-X' or '--value' -enables this. So for example, 'hledger bs -V --infer-market-price' will -get market prices both from P directives and from transactions. (And if + Adding the `--infer-market-price' flag to `-V', `-X' or `--value' +enables this. So for example, `hledger bs -V --infer-market-price' will +get market prices both from P directives and from transactions. (And if both occur on the same day, the P directive takes precedence). There is a downside: value reports can sometimes be affected in -confusing/undesired ways by your journal entries. If this happens to +confusing/undesired ways by your journal entries. If this happens to you, read all of this Valuation section carefully, and try adding -'--debug' or '--debug=2' to troubleshoot. +`--debug' or `--debug=2' to troubleshoot. - '--infer-market-price' can infer market prices from: + `--infer-market-price' can infer market prices from: - * multicommodity transactions with explicit prices ('@'/'@@') + * multicommodity transactions with explicit prices (`@'/`@@') - * multicommodity transactions with implicit prices (no '@', two - commodities, unbalanced). (With these, the order of postings - matters. 'hledger print -x' can be useful for troubleshooting.) + * multicommodity transactions with implicit prices (no `@', two + commodities, unbalanced). (With these, the order of postings + matters. `hledger print -x' can be useful for troubleshooting.) + + * but not, currently, from "more correct" multicommodity + transactions (no `@', multiple commodities, balanced). - * but not, currently, from "more correct" multicommodity transactions - (no '@', multiple commodities, balanced).  File: hledger.info, Node: Valuation commodity, Next: Simple valuation examples, Prev: --infer-market-price market prices from transactions, Up: VALUATION @@ -1242,13 +1404,13 @@ File: hledger.info, Node: Valuation commodity, Next: Simple valuation examples 8.6 Valuation commodity ======================= -*When you specify a valuation commodity ('-X COMM' or '--value +*When you specify a valuation commodity (`-X COMM' or `--value TYPE,COMM'):* hledger will convert all amounts to COMM, wherever it can find a suitable market price (including by reversing or chaining prices). - *When you leave the valuation commodity unspecified ('-V' or '--value -TYPE'):* + *When you leave the valuation commodity unspecified (`-V' or +`--value TYPE'):* For each commodity A, hledger picks a default valuation commodity as follows, in this order of preference: @@ -1256,22 +1418,24 @@ follows, in this order of preference: on or before valuation date. 2. The price commodity from the latest P-declared market price for A - on any date. (Allows conversion to proceed when there are inferred + on any date. (Allows conversion to proceed when there are inferred prices before the valuation date.) 3. If there are no P directives at all (any commodity or date) and the - '--infer-market-price' flag is used: the price commodity from the + `--infer-market-price' flag is used: the price commodity from the latest transaction-inferred price for A on or before valuation date. + This means: - * If you have P directives, they determine which commodities '-V' + * If you have P directives, they determine which commodities `-V' will convert, and to what. - * If you have no P directives, and use the '--infer-market-price' + * If you have no P directives, and use the `--infer-market-price' flag, transaction prices determine it. + Amounts for which no valuation commodity can be found are not converted. @@ -1281,7 +1445,8 @@ File: hledger.info, Node: Simple valuation examples, Next: --value Flexible va 8.7 Simple valuation examples ============================= -Here are some quick examples of '-V': +Here are some quick examples of `-V': + ; one euro is worth this many dollars from nov 1 P 2016/11/01 € $1.10 @@ -1296,16 +1461,19 @@ P 2016/12/21 € $1.03 How many euros do I have ? + $ hledger -f t.j bal -N euros €100 assets:euros What are they worth at end of nov 3 ? + $ hledger -f t.j bal -N euros -V -e 2016/11/4 $110.00 assets:euros - What are they worth after 2016/12/21 ? (no report end date -specified, defaults to today) + What are they worth after 2016/12/21 ? (no report end date specified, +defaults to today) + $ hledger -f t.j bal -N euros -V $103.00 assets:euros @@ -1316,7 +1484,8 @@ File: hledger.info, Node: --value Flexible valuation, Next: More valuation exa 8.8 -value: Flexible valuation ============================== -'-V' and '-X' are special cases of the more general '--value' option: +`-V' and `-X' are special cases of the more general `--value' option: + --value=TYPE[,COMM] TYPE is then, end, now or YYYY-MM-DD. COMM is an optional commodity symbol. @@ -1328,28 +1497,27 @@ File: hledger.info, Node: --value Flexible valuation, Next: More valuation exa The TYPE part selects cost or value and valuation date: -'--value=then' - +`--value=then' Convert amounts to their value in the default valuation commodity, using market prices on each posting's date. -'--value=end' +`--value=end' 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's end date); or in multiperiod reports, market prices on the last day of each subperiod. -'--value=now' +`--value=now' Convert amounts to their value in the default valuation commodity using current market prices (as of when report is generated). -'--value=YYYY-MM-DD' +`--value=YYYY-MM-DD' Convert amounts to their value in the default valuation commodity using market prices on this date. - To select a different valuation commodity, add the optional ',COMM' -part: a comma, then the target commodity's symbol. Eg: -*'--value=now,EUR'*. hledger will do its best to convert amounts to + To select a different valuation commodity, add the optional `,COMM' +part: a comma, then the target commodity's symbol. Eg: +*`--value=now,EUR'*. hledger will do its best to convert amounts to this commodity, deducing market prices as described above.  @@ -1358,8 +1526,9 @@ File: hledger.info, Node: More valuation examples, Next: Effect of valuation o 8.9 More valuation examples =========================== -Here are some examples showing the effect of '--value', as seen with -'print': +Here are some examples showing the effect of `--value', as seen with +`print': + P 2000-01-01 A 1 B P 2000-02-01 A 2 B @@ -1377,6 +1546,7 @@ P 2000-04-01 A 4 B Show the cost of each posting: + $ hledger -f- print --cost 2000-01-01 (a) 5 B @@ -1389,6 +1559,7 @@ $ hledger -f- print --cost Show the value as of the last day of the report period (2000-02-29): + $ hledger -f- print --value=end date:2000/01-2000/03 2000-01-01 (a) 2 B @@ -1399,6 +1570,7 @@ $ hledger -f- print --value=end date:2000/01-2000/03 With no report period specified, that shows the value as of the last day of the journal (2000-03-01): + $ hledger -f- print --value=end 2000-01-01 (a) 3 B @@ -1412,6 +1584,7 @@ $ hledger -f- print --value=end Show the current value (the 2000-04-01 price is still in effect today): + $ hledger -f- print --value=now 2000-01-01 (a) 4 B @@ -1424,6 +1597,7 @@ $ hledger -f- print --value=now Show the value on 2000/01/15: + $ hledger -f- print --value=2000-01-15 2000-01-01 (a) 1 B @@ -1435,7 +1609,8 @@ $ hledger -f- print --value=2000-01-15 (a) 1 B You may need to explicitly set a commodity's display style, when -reverse prices are used. Eg this output might be surprising: +reverse prices are used. Eg this output might be surprising: + P 2000-01-01 A 2B @@ -1443,6 +1618,7 @@ P 2000-01-01 A 2B a 1B b + $ hledger print -x -X A 2000-01-01 a 0 @@ -1450,10 +1626,11 @@ $ hledger print -x -X A Explanation: because there's no amount or commodity directive specifying a display style for A, 0.5A gets the default style, which -shows no decimal digits. Because the displayed amount looks like zero, -the commodity symbol and minus sign are not displayed either. Adding a +shows no decimal digits. Because the displayed amount looks like zero, +the commodity symbol and minus sign are not displayed either. Adding a commodity directive sets a more useful display style for A: + P 2000-01-01 A 2B commodity 0.00A @@ -1461,6 +1638,7 @@ commodity 0.00A a 1B b + $ hledger print -X A 2000-01-01 a 0.50A @@ -1473,51 +1651,49 @@ File: hledger.info, Node: Effect of valuation on reports, Prev: More valuation =================================== Here is a reference for how valuation is supposed to affect each part of -hledger's reports (and a glossary). (It's wide, you'll have to scroll -sideways.) It may be useful when troubleshooting. If you find -problems, please report them, ideally with a reproducible example. -Related: #329, #1083. +hledger's reports (and a glossary). (It's wide, you'll have to scroll +sideways.) It may be useful when troubleshooting. If you find problems, +please report them, ideally with a reproducible example. Related: #329, +#1083. -Report '-B', '-V', '-X' '--value=then' '--value=end''--value=DATE', -type '--cost' '--value=now' ------------------------------------------------------------------------------- -*print* +Report `-B', `-V', `-X' `--value=then' `--value=end'`--value=DATE', +type `--cost' `--value=now' +------------------------------------------------------------------------------ +*print* posting cost value at value at posting value at value amounts report end date report or at - or today journal DATE/today - end + or today journal end DATE/today balance unchanged unchanged unchanged unchanged unchanged -assertions/assignments -*register* +assertions/assignments + +*register* starting cost value at valued at day value at value balance day before each historical day before at (-H) report or posting was made report or DATE/today - journal journal - start start + journal journal + start start posting cost value at value at posting value at value amounts report end date report or at - or today journal DATE/today - end + or today journal end DATE/today summary summarised value at sum of postings value at value -posting cost period in interval, period at -amounts ends valued at ends DATE/today -with interval start -report -interval +posting cost period ends in interval, period ends at +amounts valued at DATE/today +with interval start +report +interval running sum/average sum/average sum/average of sum/average sum/average -total/averageof of displayed values of of +total/averageof of displayed values of of displayed displayed displayed displayed values values values values -*balance -(bs, -bse, cf, -is)* + +*balance +(bs, bse, +cf, is)* balance sums of value at value at posting value at value changes costs report end date report or at - or today journal DATE/today - of sums of end of of - postings sums of sums - postings of + or today of journal end DATE/today + sums of of sums of of sums + postings postings of postings budget like like like balance like like amounts balance balance changes balances balance @@ -1525,87 +1701,84 @@ amounts balance balance changes balances balance grand sum of sum of sum of displayed sum of sum of total displayed displayed valued displayed displayed values values values values -*balance -(bs, -bse, cf, -is) with -report -interval* -starting sums of value at sums of values value at sums -balances costs of report of postings report of -(-H) postings start of before report start of postings - before sums of start at sums of before - report all respective all report - start postings posting dates postings start - before before - report report - start start -balance sums of same as sums of values balance value -changes costs of -value=end of postings in change in at -(bal, postings period at each DATE/today -is, bs in period respective period, of --change, posting dates valued at sums -cf period of --change) ends postings -end sums of same as sums of values period end value -balances costs of -value=end of postings from balances, at + +*balance +(bs, bse, +cf, is) +with +report +interval* +starting sums of value at sums of values of value at sums of +balances costs of report postings before report postings +(-H) postings start of report start at start of before + before sums of all respective sums of all report + report start postings posting dates postings start + before before + report start report start +balance sums of same as sums of values of balance value +changes costs of -value=end postings in change in at +(bal, is, postings in period at each DATE/today +bs period respective period, of sums +-change, posting dates valued at of +cf period ends postings +-change) +end sums of same as sums of values of period end value +balances costs of -value=end postings from balances, at (bal -H, postings before period valued at DATE/today -is -H, from start to period period of -bs, cf) before end at ends sums - report respective of +is -H, from before start to period period ends of sums +bs, cf) report end at respective of start to posting dates postings - period end + period end budget like like like balance like like amounts balance balance changes/end balances balance (-budget) changes/end changes/end balances changes/end balances balances balances -row sums, sums, sums, averages sums, sums, -totals, averages averages of displayed averages averages -row of of values of of -averages displayed displayed displayed displayed -(-T, -A) values values values values -column sums of sums of sums of sums of sums -totals displayed displayed displayed values displayed of - values values values displayed - values +row sums, sums, sums, averages of sums, sums, +totals, averages of averages of displayed values averages of averages +row displayed displayed displayed of +averages values values values displayed +(-T, -A) values +column sums of sums of sums of displayed sums of sums of +totals displayed displayed values displayed displayed + values values values values grand sum, sum, sum, average of sum, sum, total, average of average of column totals average of average grand column column column of average totals totals totals column totals - '--cumulative' is omitted to save space, it works like '-H' but with + + `--cumulative' is omitted to save space, it works like `-H' but with a zero starting balance. *Glossary:* _cost_ - calculated using price(s) recorded in the transaction(s). -_value_ +_value_ market value using available market price declarations, or the unchanged amount if no conversion rate can be found. -_report start_ +_report start_ the first day of the report period specified with -b or -p or date:, otherwise today. -_report or journal start_ +_report or journal start_ the first day of the report period specified with -b or -p or date:, otherwise the earliest transaction date in the journal, otherwise today. -_report end_ +_report end_ the last day of the report period specified with -e or -p or date:, otherwise today. -_report or journal end_ +_report or journal end_ the last day of the report period specified with -e or -p or date:, otherwise the latest transaction date in the journal, otherwise today. -_report interval_ +_report interval_ a flag (-D/-W/-M/-Q/-Y) or period expression that activates the report's multi-period mode (whether showing one or many subperiods). @@ -1617,26 +1790,28 @@ File: hledger.info, Node: PIVOTING, Next: OUTPUT, Prev: VALUATION, Up: Top ********** Normally hledger sums amounts, and organizes them in a hierarchy, based -on account name. The '--pivot FIELD' option causes it to sum and -organize hierarchy based on the value of some other field instead. -FIELD can be: 'code', 'description', 'payee', 'note', or the full name -(case insensitive) of any tag. As with account names, values containing -'colon:separated:parts' will be displayed hierarchically in reports. +on account name. The `--pivot FIELD' option causes it to sum and +organize hierarchy based on the value of some other field instead. FIELD +can be: `code', `description', `payee', `note', or the full name (case +insensitive) of any tag. As with account names, values containing +`colon:separated:parts' will be displayed hierarchically in reports. - '--pivot' is a general option affecting all reports; you can think of -hledger transforming the journal before any other processing, replacing -every posting's account name with the value of the specified field on -that posting, inheriting it from the transaction or using a blank value -if it's not present. + `--pivot' is a general option affecting all reports; you can think +of hledger transforming the journal before any other processing, +replacing every posting's account name with the value of the specified +field on that posting, inheriting it from the transaction or using a +blank value if it's not present. An example: + 2016/02/16 Member Fee Payment assets:bank account 2 EUR income:member fees -2 EUR ; member: John Doe Normal balance report showing account names: + $ hledger balance 2 EUR assets:bank account -2 EUR income:member fees @@ -1645,6 +1820,7 @@ $ hledger balance Pivoted balance report, using member: tag values instead: + $ hledger balance --pivot member 2 EUR -2 EUR John Doe @@ -1654,6 +1830,7 @@ $ hledger balance --pivot member One way to show only amounts with a member: value (using a query, described below): + $ hledger balance --pivot member tag:member=. -2 EUR John Doe -------------------- @@ -1662,6 +1839,7 @@ $ hledger balance --pivot member tag:member=. Another way (the acct: query matches against the pivoted "account name"): + $ hledger balance --pivot member acct:. -2 EUR John Doe -------------------- @@ -1677,6 +1855,7 @@ File: hledger.info, Node: OUTPUT, Next: COMMANDS, Prev: PIVOTING, Up: Top * Output destination:: * Output format:: +* Commodity styles::  File: hledger.info, Node: Output destination, Next: Output format, Up: OUTPUT @@ -1684,62 +1863,68 @@ File: hledger.info, Node: Output destination, Next: Output format, Up: OUTPUT 10.1 Output destination ======================= -hledger commands send their output to the terminal by default. You can +hledger commands send their output to the terminal by default. You can of course redirect this, eg into a file, using standard shell syntax: + $ hledger print > foo.txt Some commands (print, register, stats, the balance commands) also -provide the '-o/--output-file' option, which does the same thing without -needing the shell. Eg: +provide the `-o/--output-file' option, which does the same thing +without needing the shell. Eg: + $ hledger print -o foo.txt $ hledger print -o - # write to stdout (the default) hledger can optionally produce debug output (if enabled with -'--debug=N'); this goes to stderr, and is not affected by -'-o/--output-file'. If you need to capture it, use shell redirects, eg: -'hledger bal --debug=3 >file 2>&1'. +`--debug=N'); this goes to stderr, and is not affected by +`-o/--output-file'. If you need to capture it, use shell redirects, eg: +`hledger bal --debug=3 >file 2>&1'.  -File: hledger.info, Node: Output format, Prev: Output destination, Up: OUTPUT +File: hledger.info, Node: Output format, Next: Commodity styles, Prev: Output destination, Up: OUTPUT 10.2 Output format ================== Some commands (print, register, the balance commands) offer a choice of -output format. In addition to the usual plain text format ('txt'), -there are CSV ('csv'), HTML ('html'), JSON ('json') and SQL ('sql'). -This is controlled by the '-O/--output-format' option: +output format. In addition to the usual plain text format (`txt'), +there are CSV (`csv'), HTML (`html'), JSON (`json') and SQL (`sql'). +This is controlled by the `-O/--output-format' option: + $ hledger print -O csv - or, by a file extension specified with '-o/--output-file': + or, by a file extension specified with `-o/--output-file': + $ hledger balancesheet -o foo.html # write HTML to foo.html - The '-O' option can be used to override the file extension if needed: + The `-O' option can be used to override the file extension if needed: + $ hledger balancesheet -o foo.txt -O html # write HTML to foo.txt Some notes about JSON output: * This feature is marked experimental, and not yet much used; you - should expect our JSON to evolve. Real-world feedback is welcome. + should expect our JSON to evolve. Real-world feedback is welcome. * Our JSON is rather large and verbose, as it is quite a faithful - representation of hledger's internal data types. To understand the + representation 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. + * hledger represents quantities as Decimal values storing up to 255 - significant digits, eg for repeating decimals. Such numbers can + significant digits, eg for repeating decimals. 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. We + prices), and would break most JSON consumers. So in JSON, we show + quantities as simple Numbers with at most 10 decimal places. We don't limit the number of integer digits, but that part is under - your control. We hope this approach will not cause problems in - practice; if you find otherwise, please let us know. (Cf #1195) + your control. We hope this approach will not cause problems in + practice; if you find otherwise, please let us know. (Cf #1195) Notes about SQL output: @@ -1748,13 +1933,33 @@ $ hledger balancesheet -o foo.txt -O html # write HTML to foo.txt * SQL output is expected to work with sqlite, MySQL and PostgreSQL - * SQL output is structured with the expectations that statements will - be executed in the empty database. If you already have tables + * SQL output is structured with the expectations that statements + will be executed in the empty database. If you already have tables created via SQL output of hledger, you would probably want to - either clear tables of existing data (via 'delete' or 'truncate' + either clear tables of existing data (via `delete' or `truncate' SQL statements) or drop tables completely as otherwise your postings will be duped. + + +File: hledger.info, Node: Commodity styles, Prev: Output format, Up: OUTPUT + +10.3 Commodity styles +===================== + +The display style of a commodity/currence is inferred according to the +rules described in Commodity display style. The inferred display style +can be overriden by an optional `-c/--commodity-style' option. For +example, the following will override the display style for dollars. + + +$ hledger print -c '$1.000,0' + + The format specification of the style is identical to the commodity +display style specification for the commodity directive. The command +line option can be supplied repeatedly to override the display style for +multiple commodity/currency symbols. +  File: hledger.info, Node: COMMANDS, Next: JOURNAL FORMAT, Prev: OUTPUT, Up: Top @@ -1762,10 +1967,10 @@ File: hledger.info, Node: COMMANDS, Next: JOURNAL FORMAT, Prev: OUTPUT, Up: *********** hledger provides a number of commands for producing reports and managing -your data. Run 'hledger' with no arguments to list the commands -available, and 'hledger CMD' to run a command. CMD can be the full +your data. Run `hledger' with no arguments to list the commands +available, and `hledger CMD' to run a command. CMD can be the full command name, or its standard abbreviation shown in the commands list, -or any unambiguous prefix of the name. Eg: 'hledger bal'. +or any unambiguous prefix of the name. Eg: `hledger bal'. Here are the built-in commands, with the most often-used in bold: @@ -1775,62 +1980,91 @@ or any unambiguous prefix of the name. Eg: 'hledger bal'. journal file. * *add* - add transactions using guided prompts + * *import* - add any new transactions from other files (eg csv) *Data management:* * check - check for various kinds of issue in the data + * close (equity) - generate balance-resetting transactions + * diff - compare account transactions in two journal files + * rewrite - generate extra postings, similar to print -auto *Financial statements:* * *aregister (areg)* - show transactions in a particular account + * *balancesheet (bs)* - show assets, liabilities and net worth + * balancesheetequity (bse) - show assets, liabilities and equity + * cashflow (cf) - show changes in liquid assets + * *incomestatement (is)* - show revenues and expenses + * roi - show return on investments *Miscellaneous reports:* * accounts - show account names + * activity - show postings-per-interval bar charts + * *balance (bal)* - show balance changes/end balances/budgets in any accounts + * codes - show transaction codes + * commodities - show commodity/currency symbols + * descriptions - show unique transaction descriptions + * files - show input file paths + * help - show hledger user manuals in several formats + * notes - show unique note segments of transaction descriptions + * payees - show unique payee segments of transaction descriptions + * prices - show market price records + * *print* - show transactions (journal entries) + * print-unique - show only transactions with unique descriptions + * *register (reg)* - show postings in one or more accounts & running total + * register-match - show a recent posting that best matches a description + * stats - show journal statistics + * tags - show tag names + * test - run self tests *Add-on commands:* - Programs or scripts named 'hledger-SOMETHING' in your PATH are add-on -commands; these appear in the commands list with a '+' mark. Two of -these are maintained and released with hledger: + Programs or scripts named `hledger-SOMETHING' in your PATH are +add-on commands; these appear in the commands list with a `+' mark. +Two of these are maintained and released with hledger: * *ui* - an efficient terminal interface (TUI) for hledger + * *web* - a simple web interface (WUI) for hledger And these add-ons are maintained separately: * iadd - a more interactive alternative for the add command + * interest - generates interest transactions according to various schemes + * stockquotes - downloads market prices for your commodities from AlphaVantage _(experimental)_ @@ -1880,16 +2114,17 @@ accounts Show account names. This command lists account names, either declared with account -directives (-declared), posted to (-used), or both (the default). With +directives (-declared), posted to (-used), or both (the default). With query arguments, only matched account names and account names referenced -by matched postings are shown. 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'. +by matched postings are shown. 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'. Examples: + $ hledger accounts assets:bank:checking assets:bank:saving @@ -1911,14 +2146,15 @@ Show an ascii barchart of posting counts per interval. The activity command displays an ascii histogram showing transaction counts by day, week, month or other reporting interval (by day is the -default). With query arguments, it counts only matched transactions. +default). With query arguments, it counts only matched transactions. Examples: + $ hledger activity --quarterly 2008-01-01 ** 2008-04-01 ******* -2008-07-01 +2008-07-01 2008-10-01 **  @@ -1928,19 +2164,19 @@ File: hledger.info, Node: add, Next: aregister, Prev: activity, Up: COMMANDS ======== add -Prompt for transactions and add them to the journal. Any arguments will +Prompt for transactions and add them to the journal. Any arguments will be used as default inputs for the first N prompts. Many hledger users edit their journals directly with a text editor, or generate them from CSV. For more interactive data entry, there is the -'add' command, which prompts interactively on the console for new +`add' command, which prompts interactively on the console for new transactions, and appends them to the journal file (if there are -multiple '-f FILE' options, the first file is used.) Existing -transactions are not changed. This is the only hledger command that +multiple `-f FILE' options, the first file is used.) Existing +transactions are not changed. This is the only hledger command that writes to the journal file. - To use it, just run 'hledger add' and follow the prompts. You can -add as many transactions as you like; when you are finished, enter '.' + To use it, just run `hledger add' and follow the prompts. You can +add as many transactions as you like; when you are finished, enter `.' or press control-d or control-c to exit. Features: @@ -1948,22 +2184,31 @@ or press control-d or control-c to exit. * add tries to provide useful defaults, using the most similar (by description) recent transaction (filtered by the query, if any) as a template. + * You can also set the initial defaults with command line arguments. + * Readline-style edit keys can be used during data entry. + * The tab key will auto-complete whenever possible - accounts, - descriptions, dates ('yesterday', 'today', 'tomorrow'). If the + descriptions, dates (`yesterday', `today', `tomorrow'). If the input area is empty, it will insert the default value. - * If the journal defines a default commodity, it will be added to any - bare numbers entered. + + * If the journal defines a default commodity, it will be added to + any bare numbers entered. + * A parenthesised transaction code may be entered following a date. + * Comments and tags may be entered following a description or amount. - * If you make a mistake, enter '<' at any prompt to go one step + + * If you make a mistake, enter `<' at any prompt to go one step backward. + * Input prompts are displayed in a different colour when the terminal supports it. Example (see the tutorial for a detailed explanation): + $ hledger add Adding transactions to journal file /src/hledger/examples/sample.journal Any command line arguments will be used as defaults. @@ -1973,18 +2218,18 @@ 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 [2015/05/22]: +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 -Save this transaction to the journal ? [y]: +Save this transaction to the journal ? [y]: Saved. Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ @@ -1999,35 +2244,34 @@ File: hledger.info, Node: aregister, Next: balance, Prev: add, Up: COMMANDS ============== aregister, areg - - Show the transactions and running historical balance of a single +Show the transactions and running historical balance of a single account, with each transaction displayed as one line. - 'aregister' shows the overall transactions affecting a particular -account (and any subaccounts). Each report line represents one -transaction in this account. Transactions before the report start date -are always included in the running balance ('--historical' mode is + `aregister' shows the overall transactions affecting a particular +account (and any subaccounts). Each report line represents one +transaction in this account. Transactions before the report start date +are always included in the running balance (`--historical' mode is always on). - This is a more "real world", bank-like view than the 'register' + 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 'aregister' for reviewing and reconciling real-world -asset/liability accounts - use 'register' for reviewing detailed +accounts, not necessarily in historical mode). As a quick rule of thumb: +- use `aregister' 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 + `aregister' requires one argument: the account to report on. You can write either the full account name, or a case-insensitive regular expression which will select the alphabetically first matched account. -(Eg if you have 'assets:aaa:checking' and 'assets:bbb:checking' -accounts, 'hledger areg checking' would select 'assets:aaa:checking'.) +(Eg if you have `assets:aaa:checking' and `assets:bbb:checking' +accounts, `hledger areg checking' would select `assets:aaa:checking'.) Transactions involving subaccounts of this account will also be -shown. 'aregister' ignores depth limits, so its final total will always +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 -transactions shown. Note some queries will disturb the running balance, +transactions shown. Note some queries will disturb the running balance, causing it to be different from the account's real-world running balance. @@ -2035,22 +2279,26 @@ balance. balance during july, in the first account whose name contains "checking": + $ hledger areg checking date:jul - Each 'aregister' line item shows: + Each `aregister' line item shows: * the transaction's date (or the relevant posting's date if different, see below) + * the names of all the other account(s) involved in this transaction (probably abbreviated) + * the total change to this account's balance from this transaction + * the account's historical running balance after this transaction. Transactions making a net change of zero are not shown by default; -add the '-E/--empty' flag to show them. +add the `-E/--empty' flag to show them. This command also supports the output destination and output format -options. The output formats supported are 'txt', 'csv', and 'json'. +options. The output formats supported are `txt', `csv', and `json'. * Menu: @@ -2064,13 +2312,13 @@ File: hledger.info, Node: aregister and custom posting dates, Up: aregister Transactions whose date is outside the report period can still be shown, if they have a posting to this account dated inside the report period. -(And in this case it's the posting date that is shown.) This ensures -that 'aregister' can show an accurate historical running balance, -matching the one shown by 'register -H' with the same arguments. +(And in this case it's the posting date that is shown.) This ensures +that `aregister' can show an accurate historical running balance, +matching the one shown by `register -H' with the same arguments. - To filter strictly by transaction date instead, add the '--txn-dates' -flag. If you use this flag and some of your postings have custom dates, -it's probably best to assume the running balance is wrong. + To filter strictly by transaction date instead, add the +`--txn-dates' flag. If you use this flag and some of your postings have +custom dates, it's probably best to assume the running balance is wrong.  File: hledger.info, Node: balance, Next: balancesheet, Prev: aregister, Up: COMMANDS @@ -2081,15 +2329,15 @@ File: hledger.info, Node: balance, Next: balancesheet, Prev: aregister, Up: balance, bal Show accounts and their balances. - 'balance' is one of hledger's oldest and most versatile commands, for -listing account balances, balance changes, values, value changes and -more, during one time period or many. Generally it shows a table, with + `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', -'balancesheetequity', 'cashflow' and 'incomestatement'. When you need -more control, then use 'balance'. + Note there are some higher-level variants of the `balance' command +with convenient defaults, which can be simpler to use: `balancesheet', +`balancesheetequity', `cashflow' and `incomestatement'. When you need +more control, then use `balance'. * Menu: @@ -2098,6 +2346,7 @@ more control, then use 'balance'. * Filtered balance report:: * List or tree mode:: * Depth limiting:: +* Dropping top-level accounts:: * Multi-period balance report:: * Commodity column:: * Sorting by amount:: @@ -2114,56 +2363,74 @@ File: hledger.info, Node: balance features, Next: Simple balance report, Up: 11.5.1 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.. + `balance' can show.. + + * accounts as a list (`-l') or a tree (`-t') + + * optionally depth-limited (`-[1-9]') - * accounts as a list ('-l') or a tree ('-t') - * optionally depth-limited ('-[1-9]') * sorted by declaration order and name, or by amount ..and their.. * balance changes (the default) - * or actual and planned balance changes ('--budget') - * or value of balance changes ('-V') - * or change of balance values ('--valuechange') + + * or actual and planned balance changes (`--budget') + + * or value of balance changes (`-V') + + * or change of balance values (`--valuechange') + + * or unrealised capital gain/loss (`--gain') ..in.. * one time period (the whole journal period by default) - * or multiple periods ('-D', '-W', '-M', '-Q', '-Y', '-p INTERVAL') + + * or multiple periods (`-D', `-W', `-M', `-Q', `-Y', `-p INTERVAL') ..either.. * per period (the default) - * or accumulated since report start date ('--cumulative') - * or accumulated since account creation ('--historical/-H') + + * or accumulated since report start date (`--cumulative') + + * or accumulated since account creation (`--historical/-H') ..possibly converted to.. - * cost ('--value=cost[,COMM]'/'--cost'/'-B') - * or market value, as of transaction dates ('--value=then[,COMM]') - * or at period ends ('--value=end[,COMM]') - * or now ('--value=now') - * or at some other date ('--value=YYYY-MM-DD') + * cost (`--value=cost[,COMM]'/`--cost'/`-B') + + * or market value, as of transaction dates (`--value=then[,COMM]') + + * or at period ends (`--value=end[,COMM]') + + * or now (`--value=now') + + * or at some other date (`--value=YYYY-MM-DD') ..with.. - * totals ('-T'), averages ('-A'), percentages ('-%'), inverted sign - ('--invert') - * rows and columns swapped ('--transpose') - * another field used as account name ('--pivot') + * totals (`-T'), averages (`-A'), percentages (`-%'), inverted sign + (`--invert') + + * rows and columns swapped (`--transpose') + + * another field used as account name (`--pivot') + * custom-formatted line items (single-period reports only) - ('--format') + (`--format') + * commodities shown in a separate column, one per row - ('--commodity-column') + (`--commodity-column') This command supports the output destination and output format -options, with output formats 'txt', 'csv', 'json', and (multi-period -reports only:) 'html'. In 'txt' output in a colour-supporting terminal, +options, with output formats `txt', `csv', `json', and (multi-period +reports only:) `html'. In `txt' output in a colour-supporting terminal, negative amounts are shown in red.  @@ -2172,17 +2439,18 @@ File: hledger.info, Node: Simple balance report, Next: Filtered balance report 11.5.2 Simple balance report ---------------------------- -With no arguments, 'balance' shows a list of all accounts and their +With no arguments, `balance' shows a list of all accounts and their change of balance - ie, the sum of posting amounts, both inflows and -outflows - during the entire period of the journal. For real-world +outflows - during the entire period of the journal. For real-world accounts, this should also match their end balance at the end of the journal period (more on this below). Accounts are sorted by declaration order if any, and then -alphabetically by account name. For instance, using -examples/sample.journal: +alphabetically by account name. For instance (using +examples/sample.journal): -$ hledger bal + +$ hledger -f examples/sample.journal bal $1 assets:bank:saving $-2 assets:cash $1 expenses:food @@ -2191,13 +2459,14 @@ $ hledger bal $-1 income:salary $1 liabilities:debts -------------------- - 0 + 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 -(revealing 'assets:bank:checking' here): +mode - see below) are hidden by default. Use `-E/--empty' to show them +(revealing `assets:bank:checking' here): -$ 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 @@ -2207,10 +2476,10 @@ $ hledger -f examples/sample.journal bal -E $-1 income:salary $1 liabilities:debts -------------------- - 0 + 0 The total of the amounts displayed is shown as the last line, unless -'-N'/'--no-total' is used. +`-N'/`--no-total' is used.  File: hledger.info, Node: Filtered balance report, Next: List or tree mode, Prev: Simple balance report, Up: balance @@ -2219,13 +2488,14 @@ File: hledger.info, Node: Filtered balance report, Next: List or tree mode, P ------------------------------ 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: +cleared transactions only, etc. by using query arguments or options to +limit the postings being matched. Eg: -$ hledger bal --cleared assets date:200806 + +$ hledger -f examples/sample.journal bal --cleared assets date:200806 $-2 assets:cash -------------------- - $-2 + $-2  File: hledger.info, Node: List or tree mode, Next: Depth limiting, Prev: Filtered balance report, Up: balance @@ -2233,13 +2503,14 @@ File: hledger.info, Node: List or tree mode, Next: Depth limiting, Prev: Filt 11.5.4 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 balance + +$ hledger -f examples/sample.journal balance $-1 assets $1 bank:saving $-2 cash @@ -2256,143 +2527,172 @@ $ hledger balance Notes: * "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' above). + compact output, unless `--no-elide' is used. Boring accounts have + no balance of their own and just one subaccount (eg `assets:bank' + and `liabilities' above). * All balances shown are "inclusive", ie including the balances from - all subaccounts. Note this means some repetition in the output, + all subaccounts. Note this means some repetition in the output, which requires explanation when sharing reports with - non-plaintextaccounting-users. A tree mode report's final total is + non-plaintextaccounting-users. A tree mode report's final total is the sum of the top-level balances shown, not of all the balances shown. * Each group of sibling accounts (ie, under a common parent) is sorted separately. +  -File: hledger.info, Node: Depth limiting, Next: Multi-period balance report, Prev: List or tree mode, Up: balance +File: hledger.info, Node: Depth limiting, Next: Dropping top-level accounts, Prev: List or tree mode, Up: balance 11.5.5 Depth limiting --------------------- -With a 'depth:N' query, or '--depth N' option, or just '-N', balance -reports will show accounts only to the specified depth, hiding the -deeper subaccounts. Account balances at the depth limit always include -the balances from any hidden subaccounts (even in list mode). This can -be useful for getting an overview. Eg, limiting to depth 1: +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. -$ hledger balance -N -1 + 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 $-1 assets $2 expenses $-2 income $1 liabilities +-------------------- + 0 - You can also hide top-level account name parts, using '--drop N'. -This can be useful for hiding repetitive top-level account names: + +File: hledger.info, Node: Dropping top-level accounts, Next: Multi-period balance report, Prev: Depth limiting, Up: balance -$ hledger bal expenses --drop 1 +11.5.6 Dropping top-level accounts +---------------------------------- + +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: + + +$ hledger -f examples/sample.journal bal expenses --drop 1 $1 food $1 supplies -------------------- - $2 + $2  -File: hledger.info, Node: Multi-period balance report, Next: Commodity column, Prev: Depth limiting, Up: balance +File: hledger.info, Node: Multi-period balance report, Next: Commodity column, Prev: Dropping top-level accounts, Up: balance -11.5.6 Multi-period balance report +11.5.7 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), -'balance' shows a tabular report, with columns representing successive -time periods (and a title): +With a report interval (set by the `-D/--daily', `-W/--weekly', +`-M/--monthly', `-Q/--quarterly', `-Y/--yearly', or `-p/--period' +flag), `balance' shows a tabular report, with columns representing +successive time periods (and a title): -$ hledger balance --quarterly income expenses -E + +$ hledger -f examples/sample.journal bal --quarterly income expenses -E Balance changes in 2008: - || 2008q1 2008q2 2008q3 2008q4 + || 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 + 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 + || $-1 $1 0 0 Notes: * The report's start/end dates will be expanded, if necessary, to fully encompass the displayed subperiods (so that the first and last subperiods have the same duration as the others). + * Leading and trailing periods (columns) containing all zeroes are - not shown, unless '-E/--empty' is used. + not shown, unless `-E/--empty' is used. + * Accounts (rows) containing all zeroes are not shown, unless - '-E/--empty' is used. + `-E/--empty' is used. + * Amounts with many commodities are shown in abbreviated form, unless - '--no-elide' is used. _(experimental)_ - * 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. - * The '--pivot FIELD' option causes a different transaction field to - be used as "account name". See PIVOTING. + `--no-elide' is used. _(experimental)_ + + * 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. + + * 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 in the terminal. Here are some ways to handle that: +viewing in the terminal. Here are some ways to handle that: + + * Hide the totals row with `-N/--no-total' + + * Convert to a single currency with `-V' - * Hide the totals row with '-N/--no-total' - * Convert to a single currency with '-V' * Maximize the terminal window + * Reduce the terminal's font size - * View with a pager like less, eg: 'hledger bal -D --color=yes | less - -RS' - * 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') - * Output as HTML and view with a browser: 'hledger bal -D -o a.html + + * View with a pager like less, eg: `hledger bal -D --color=yes | + less -RS' + + * 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') + + * Output as HTML and view with a browser: `hledger bal -D -o a.html && open a.html'  File: hledger.info, Node: Commodity column, Next: Sorting by amount, Prev: Multi-period balance report, Up: balance -11.5.7 Commodity column +11.5.8 Commodity column ----------------------- -With '--commodity-column', commodity symbols are displayed in a separate -column, and amounts are displayed as bare numbers. In this mode, each -report row will show amounts for a single commodity, using extra rows -when necessary. It can be useful for a cleaner display of reports with -many commodities: +With `--commodity-column', commodity symbols are displayed in a +separate column, and amounts are displayed as bare numbers. In this +mode, each report row will show amounts for a single commodity, using +extra rows when necessary. It can be useful for a cleaner display of +reports with many commodities: + $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y Balance changes in 2012-01-01..2014-12-31: - || 2012 2013 2014 Total + || 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.. + 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.. + || 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.. $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --commodity-column Balance changes in 2012-01-01..2014-12-31: - || Commodity 2012 2013 2014 Total + || 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 || VEA 12.00 10.00 14.00 36.00 - Assets:US:ETrade || VHT 106.00 18.00 170.00 294.00 + 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 || 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 - || VEA 12.00 10.00 14.00 36.00 - || 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 + || VEA 12.00 10.00 14.00 36.00 + || VHT 106.00 18.00 170.00 294.00 This flag also affects CSV output, which is useful for producing data that is easier to consume, eg when making charts: + $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv "account","balance" "Assets:US:ETrade","70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT" @@ -2414,80 +2714,83 @@ $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --commodi  File: hledger.info, Node: Sorting by amount, Next: Percentages, Prev: Commodity column, Up: balance -11.5.8 Sorting by amount +11.5.9 Sorting by amount ------------------------ -With '-S/--sort-amount', accounts with the largest (most positive) -balances 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 commodity -first, and then by subsequent commodities (if an amount is missing a -commodity, it is treated as 0). +With `-S/--sort-amount', accounts with the largest (most positive) +balances 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 +commodity first, and then by subsequent commodities (if an amount is +missing a commodity, it is treated as 0). Revenues and liability balances are typically negative, however, so -'-S' shows these in reverse order. To work around this, you can add -'--invert' to flip the signs. (Or, use one of the higher-level reports, -which flip the sign automatically. Eg: 'hledger incomestatement -MAS'). +`-S' shows these in reverse order. To work around this, you can add +`--invert' to flip the signs. (Or, use one of the higher-level reports, +which flip the sign automatically. Eg: `hledger incomestatement -MAS').  File: hledger.info, Node: Percentages, Next: Balance change end balance, Prev: Sorting by amount, Up: balance -11.5.9 Percentages ------------------- +11.5.10 Percentages +------------------- -With '-%/--percent', balance reports show each account's value expressed -as a percentage of the (column) total: +With `-%/--percent', balance reports show each account's value +expressed as a percentage of the (column) total: -$ hledger bal expenses -Q -% + +$ hledger -f examples/sample.journal bal expenses -Q -% Balance changes in 2008: - || 2008Q1 2008Q2 2008Q3 2008Q4 + || 2008Q1 2008Q2 2008Q3 2008Q4 ===================++================================= - expenses:food || 0 50.0 % 0 0 - expenses:supplies || 0 50.0 % 0 0 + expenses:food || 0 50.0 % 0 0 + expenses:supplies || 0 50.0 % 0 0 -------------------++--------------------------------- - || 0 100.0 % 0 0 + || 0 100.0 % 0 0 Note it is not useful to calculate percentages if the amounts in a -column have mixed signs. In this case, make a separate report for each +column 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 +them to one commodity with `-B', `-V', `-X' or `--value', or make a separate report for each commodity: + $ hledger bal -% cur:\\$ $ hledger bal -% cur:€  File: hledger.info, Node: Balance change end balance, Next: Balance report types, Prev: Percentages, Up: balance -11.5.10 Balance change, end balance +11.5.11 Balance change, end balance ----------------------------------- It's important to be clear on the meaning of the numbers shown in -balance reports. Here is some terminology we use: +balance reports. Here is some terminology we use: A *_balance change_* is the net amount added to, or removed from, an account during some period. - An *_end balance_* is the amount accumulated in an account as of some -date (and some time, but hledger doesn't store that; assume end of day -in your timezone). It is the sum of previous balance changes. + 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 since the account was created. For a real world account, this -means it will match the "historical record", eg the balances reported in -your bank statements or bank web UI. (If they are correct!) +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 bank statements or bank web UI. (If they are correct!) 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 + `balance' shows balance changes by default. To see accurate historical end balances: 1. Initialise account starting balances with an "opening balances" @@ -2496,157 +2799,175 @@ historical end balances: 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' flag. ('-H' causes report start date to be + `-H/--historical' flag. (`-H' causes report start date to be ignored when summing postings.) +  File: hledger.info, Node: Balance report types, Next: Useful balance reports, Prev: Balance change end balance, Up: balance -11.5.11 Balance report types +11.5.12 Balance report types ---------------------------- For more flexible reporting, there are three important option groups: - 'hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] -...' + `hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] +[VALUATIONTYPE] ...' The first two are the most important: calculation type selects the basic calculation to perform for each table cell, while accumulation type says which postings should be included in each cell's calculation. Typically one or both of these are selected by default, so you don't -need to write them explicitly. A valuation type can be added if you +need to write them explicitly. A valuation type can be added if you want to convert the basic report to value or cost. *Calculation type:* -The basic calculation to perform for each table cell. It is one of: +The basic calculation to perform for each table cell. It is one of: - * '--sum' : sum the posting amounts (*default*) - * '--budget' : like -sum but also show a goal amount - * '--valuechange' : show the change in period-end historical balance - values + * `--sum' : sum the posting amounts (*default*) + + * `--budget' : like -sum but also show a goal amount + + * `--valuechange' : show the change in period-end historical balance + values (caused by deposits, withdrawals, and/or market price + fluctuations) + + * `--gain' : show the unrealised capital gain/loss, (the current + valued balance minus each amount's original cost) *Accumulation type:* -Which postings should be included in each cell's calculation. It is one +Which postings should be included in each cell's calculation. It is one of: - * '--change' : postings from column start to column end, ie within - the cell's period. Typically used to see revenues/expenses. + * `--change' : postings from column start to column end, ie within + the cell's period. Typically used to see revenues/expenses. (*default for balance, incomestatement*) - * '--cumulative' : postings from report start to column end, eg to - show changes accumulated since the report's start date. Rarely + * `--cumulative' : postings from report start to column end, eg to + show changes accumulated since the report's start date. Rarely used. - * '--historical/-H' : postings from journal start to column end, ie + * `--historical/-H' : postings from journal start to column end, ie all postings from account creation to the end of the cell's period. Typically used to see historical end balances of - assets/liabilities/equity. (*default for balancesheet, + assets/liabilities/equity. (*default for balancesheet, balancesheetequity, cashflow*) + *Valuation type:* Which kind of valuation, valuation date(s) and optionally a target -valuation commodity to use. It is one of: +valuation commodity to use. It is one of: * no valuation, show amounts in their original commodities (*default*) - * '--value=cost[,COMM]' : no valuation, show amounts converted to - cost - * '--value=then[,COMM]' : show value at transaction dates - * '--value=end[,COMM]' : show value at period end date(s) (*default - with '--valuechange'*) - * '--value=now[,COMM]' : show value at today's date - * '--value=YYYY-MM-DD[,COMM]' : show value at another date - or one of their aliases: '--cost/-B', '--market/-V' or -'--exchange/-X'. + * `--value=cost[,COMM]' : no valuation, show amounts converted to + cost + + * `--value=then[,COMM]' : show value at transaction dates + + * `--value=end[,COMM]' : show value at period end date(s) (*default + with `--valuechange', `--gain'*) + + * `--value=now[,COMM]' : show value at today's date + + * `--value=YYYY-MM-DD[,COMM]' : show value at another date + + or one of their aliases: `--cost/-B', `--market/-V' or +`--exchange/-X'. Most combinations of these options should produce reasonable reports, -but if you find any that seem wrong or misleading, let us know. The +but if you find any that seem wrong or misleading, let us know. The following restrictions are applied: - * '--valuechange' implies '--value=end' - * '--valuechange' makes '--change' the default when used with the - 'balancesheet'/'balancesheetequity' commands - * '--cumulative' or '--historical' disables '--row-total/-T' + * `--valuechange' implies `--value=end' + + * `--valuechange' makes `--change' the default when used with the + `balancesheet'/`balancesheetequity' commands + + * `--cumulative' or `--historical' disables `--row-total/-T' For reference, here is what the combinations of accumulation and valuation show: -Valuation:no valuation '--value= then' '--value= end' '--value= ->Accumulation: YYYY-MM-DD +Valuation:no valuation `--value= then' `--value= end' `--value= +>Accumulation: YYYY-MM-DD v /now' ------------------------------------------------------------------------------- -'--change'change in sum of period-end DATE-value - period posting-date value of of change in - market values change in period - in period period -'--cumulative'change from sum of period-end DATE-value - report start to posting-date value of of change - period end market values change from from report - from report report start start to - start to period to period end period end - end -'--historicalchange from sum of period-end DATE-value -/-H' journal start posting-date value of of change - to period end market values change from from journal - (historical end from journal journal start start to - balance) start to period to period end period end - end +------------------------------------------------------------------------------ +`--change'change in period sum of period-end DATE-value of + posting-date value of change change in + market values in in period period + period +`--cumulative'change from sum of period-end DATE-value of + report start to posting-date value of change change from + period end market values from report report start + from report start to period to period end + start to period end + end +`--historicalchange from sum of period-end DATE-value of +/-H' journal start to posting-date value of change change from + period end market values from journal journal start + (historical end from journal start to period to period end + balance) start to period end + end  File: hledger.info, Node: Useful balance reports, Next: Budget report, Prev: Balance report types, Up: balance -11.5.12 Useful balance reports +11.5.13 Useful balance reports ------------------------------ -Some frequently used 'balance' options/reports are: +Some frequently used `balance' options/reports are: - * 'bal -M revenues expenses' - Show revenues/expenses in each month. Also available as the - 'incomestatement' command. + * `bal -M revenues expenses' + Show revenues/expenses in each month. Also available as the + `incomestatement' command. - * 'bal -M -H assets liabilities' - Show historical asset/liability balances at each month end. Also - available as the 'balancesheet' command. + * `bal -M -H assets liabilities' + Show historical asset/liability balances at each month end. Also + available as the `balancesheet' command. - * 'bal -M -H assets liabilities equity' + * `bal -M -H assets liabilities equity' Show historical asset/liability/equity balances at each month end. - Also available as the 'balancesheetequity' command. + Also available as the `balancesheetequity' command. + + * `bal -M assets not:receivable' + Show changes to liquid assets in each month. Also available as the + `cashflow' command. - * 'bal -M assets not:receivable' - Show changes to liquid assets in each month. Also available as the - 'cashflow' command. Also: - * 'bal -M expenses -2 -SA' + * `bal -M expenses -2 -SA' Show monthly expenses summarised to depth 2 and sorted by average amount. - * 'bal -M --budget expenses' + * `bal -M --budget expenses' Show monthly expenses and budget goals. - * 'bal -M --valuechange investments' + * `bal -M --valuechange investments' Show monthly change in market value of investment assets. - * 'bal investments --valuechange -D date:lastweek amt:'>1000' -STA + * `bal investments --valuechange -D date:lastweek amt:'>1000' -STA [--invert]' Show top gainers [or losers] last week +  File: hledger.info, Node: Budget report, Next: Customising single-period balance reports, Prev: Useful balance reports, Up: balance -11.5.13 Budget report +11.5.14 Budget report --------------------- -The '--budget' report type activates extra columns showing any budget -goals for each account and period. The budget goals are defined by -periodic transactions. This is very useful for comparing planned and +The `--budget' report type activates extra columns showing any budget +goals for each account and period. The budget goals are defined by +periodic transactions. This is very useful for comparing planned and actual income, expenses, time usage, etc. For example, you can take average monthly expenses in the common expense categories to construct a minimal monthly budget: + ;; Budget ~ monthly income $2000 @@ -2673,81 +2994,85 @@ expense categories to construct a minimal monthly budget: You can now see a monthly budget report: + $ hledger balance -M --budget Budget performance in 2017/11/01-2017/12/31: - || Nov Dec + || Nov Dec ======================++==================================================== - assets || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] - assets:bank || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] - assets:bank:checking || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] - expenses || $495 [ 103% of $480] $565 [ 118% of $480] - expenses:bus || $49 [ 98% of $50] $53 [ 106% of $50] - expenses:food || $396 [ 99% of $400] $412 [ 103% of $400] - expenses:movies || $30 [ 100% of $30] 0 [ 0% of $30] - income || $1950 [ 98% of $2000] $2100 [ 105% of $2000] + assets || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] + assets:bank || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] + assets:bank:checking || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] + expenses || $495 [ 103% of $480] $565 [ 118% of $480] + expenses:bus || $49 [ 98% of $50] $53 [ 106% of $50] + expenses:food || $396 [ 99% of $400] $412 [ 103% of $400] + expenses:movies || $30 [ 100% of $30] 0 [ 0% of $30] + income || $1950 [ 98% of $2000] $2100 [ 105% of $2000] ----------------------++---------------------------------------------------- - || 0 [ 0] 0 [ 0] + || 0 [ 0] 0 [ 0] This is different from a normal balance report in several ways: - * Only accounts with budget goals during the report period are shown, - by default. + * Only accounts with budget goals during the report period are + shown, by default. * In each column, in square brackets after the actual amount, budget - goal amounts are shown, and the actual/goal percentage. (Note: + goal amounts are shown, and the actual/goal percentage. (Note: budget goals should be in the same commodity as the actual amount.) - * All parent accounts are always shown, even in list mode. Eg - assets, assets:bank, and expenses above. + * All parent accounts are always shown, even in list mode. Eg assets, + assets:bank, and expenses above. * Amounts always include all subaccounts, budgeted or unbudgeted, even in list mode. - This means that the numbers displayed will not always add up! Eg -above, the 'expenses' actual amount includes the gifts and supplies -transactions, but the 'expenses:gifts' and 'expenses:supplies' accounts + + This means that the numbers displayed will not always add up! Eg +above, the `expenses' actual amount includes the gifts and supplies +transactions, but the `expenses:gifts' and `expenses:supplies' accounts are not shown, as they have no budget amounts declared. - This can be confusing. When you need to make things clearer, use the -'-E/--empty' flag, which will reveal all accounts including unbudgeted -ones, giving the full picture. Eg: + This can be confusing. When you need to make things clearer, use the +`-E/--empty' flag, which will reveal all accounts including unbudgeted +ones, giving the full picture. Eg: + $ hledger balance -M --budget --empty Budget performance in 2017/11/01-2017/12/31: - || Nov Dec + || Nov Dec ======================++==================================================== - assets || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] - assets:bank || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] - assets:bank:checking || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] - expenses || $495 [ 103% of $480] $565 [ 118% of $480] - expenses:bus || $49 [ 98% of $50] $53 [ 106% of $50] - expenses:food || $396 [ 99% of $400] $412 [ 103% of $400] - expenses:gifts || 0 $100 - expenses:movies || $30 [ 100% of $30] 0 [ 0% of $30] - expenses:supplies || $20 0 - income || $1950 [ 98% of $2000] $2100 [ 105% of $2000] + assets || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] + assets:bank || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] + assets:bank:checking || $-2445 [ 99% of $-2480] $-2665 [ 107% of $-2480] + expenses || $495 [ 103% of $480] $565 [ 118% of $480] + expenses:bus || $49 [ 98% of $50] $53 [ 106% of $50] + expenses:food || $396 [ 99% of $400] $412 [ 103% of $400] + expenses:gifts || 0 $100 + expenses:movies || $30 [ 100% of $30] 0 [ 0% of $30] + expenses:supplies || $20 0 + income || $1950 [ 98% of $2000] $2100 [ 105% of $2000] ----------------------++---------------------------------------------------- - || 0 [ 0] 0 [ 0] + || 0 [ 0] 0 [ 0] + + You can roll over unspent budgets to next period with `--cumulative': - You can roll over unspent budgets to next period with '--cumulative': $ hledger balance -M --budget --cumulative Budget performance in 2017/11/01-2017/12/31: - || Nov Dec + || Nov Dec ======================++==================================================== - assets || $-2445 [ 99% of $-2480] $-5110 [ 103% of $-4960] - assets:bank || $-2445 [ 99% of $-2480] $-5110 [ 103% of $-4960] - assets:bank:checking || $-2445 [ 99% of $-2480] $-5110 [ 103% of $-4960] - expenses || $495 [ 103% of $480] $1060 [ 110% of $960] - expenses:bus || $49 [ 98% of $50] $102 [ 102% of $100] - expenses:food || $396 [ 99% of $400] $808 [ 101% of $800] - expenses:movies || $30 [ 100% of $30] $30 [ 50% of $60] - income || $1950 [ 98% of $2000] $4050 [ 101% of $4000] + assets || $-2445 [ 99% of $-2480] $-5110 [ 103% of $-4960] + assets:bank || $-2445 [ 99% of $-2480] $-5110 [ 103% of $-4960] + assets:bank:checking || $-2445 [ 99% of $-2480] $-5110 [ 103% of $-4960] + expenses || $495 [ 103% of $480] $1060 [ 110% of $960] + expenses:bus || $49 [ 98% of $50] $102 [ 102% of $100] + expenses:food || $396 [ 99% of $400] $808 [ 101% of $800] + expenses:movies || $30 [ 100% of $30] $30 [ 50% of $60] + income || $1950 [ 98% of $2000] $4050 [ 101% of $4000] ----------------------++---------------------------------------------------- - || 0 [ 0] 0 [ 0] + || 0 [ 0] 0 [ 0] For more examples and notes, see Budgeting. @@ -2760,17 +3085,18 @@ Budget performance in 2017/11/01-2017/12/31:  File: hledger.info, Node: Budget report start date, Next: Budgets and subaccounts, Up: Budget report -11.5.13.1 Budget report start date +11.5.14.1 Budget report start date .................................. This might be a bug, but for now: when making budget reports, it's a good idea to explicitly set the report's start date to the first day of -a reporting period, because a periodic rule like '~ monthly' generates +a reporting period, because a periodic rule like `~ monthly' generates its transactions on the 1st of each month, and if your journal has no regular transactions on the 1st, the default report start date could -exclude that budget goal, which can be a little surprising. Eg here the +exclude that budget goal, which can be a little surprising. Eg here the default report period is just the day of 2020-01-15: + ~ monthly in 2020 (expenses:food) $500 @@ -2778,36 +3104,38 @@ default report period is just the day of 2020-01-15: expenses:food $400 assets:checking + $ hledger bal expenses --budget Budget performance in 2020-01-15: - || 2020-01-15 + || 2020-01-15 ==============++============ - || $400 + || $400 --------------++------------ - || $400 + || $400 To avoid this, specify the budget report's period, or at least the -start date, with '-b'/'-e'/'-p'/'date:', to ensure it includes the -budget goal transactions (periodic transactions) that you want. Eg, -adding '-b 2020/1/1' to the above: +start date, with `-b'/`-e'/`-p'/`date:', to ensure it includes the +budget goal transactions (periodic transactions) that you want. Eg, +adding `-b 2020/1/1' to the above: + $ hledger bal expenses --budget -b 2020/1/1 Budget performance in 2020-01-01..2020-01-15: - || 2020-01-01..2020-01-15 + || 2020-01-01..2020-01-15 ===============++======================== - expenses:food || $400 [80% of $500] + expenses:food || $400 [80% of $500] ---------------++------------------------ - || $400 [80% of $500] + || $400 [80% of $500]  File: hledger.info, Node: Budgets and subaccounts, Next: Selecting budget goals, Prev: Budget report start date, Up: Budget report -11.5.13.2 Budgets and subaccounts +11.5.14.2 Budgets and subaccounts ................................. -You can add budgets to any account in your account hierarchy. If you +You can add budgets to any account in your account hierarchy. If you have budgets on both parent account and some of its children, then budget(s) of the child account(s) would be added to the budget of their parent, much like account balances behave. @@ -2817,6 +3145,7 @@ account, all its parents would have budget as well. To illustrate this, consider the following budget: + ~ monthly from 2019/01 expenses:personal $1,000.00 expenses:personal:electronics $100.00 @@ -2824,15 +3153,16 @@ account, all its parents would have budget as well. With this, monthly budget for electronics is defined to be $100 and budget for personal expenses is an additional $1000, which implicitly -means that budget for both 'expenses:personal' and 'expenses' is $1100. +means that budget for both `expenses:personal' and `expenses' is $1100. - Transactions in 'expenses:personal:electronics' will be counted both -towards its $100 budget and $1100 of 'expenses:personal' , and -transactions in any other subaccount of 'expenses:personal' would be -counted towards only towards the budget of 'expenses:personal'. + Transactions in `expenses:personal:electronics' will be counted both +towards its $100 budget and $1100 of `expenses:personal' , and +transactions in any other subaccount of `expenses:personal' would be +counted towards only towards the budget of `expenses:personal'. For example, let's consider these transactions: + ~ monthly from 2019/01 expenses:personal $1,000.00 expenses:personal:electronics $100.00 @@ -2855,77 +3185,81 @@ counted towards only towards the budget of 'expenses:personal'. liabilities As you can see, we have transactions in -'expenses:personal:electronics:upgrades' and 'expenses:personal:train +`expenses:personal:electronics:upgrades' and `expenses:personal:train tickets', and since both of these accounts are without explicitly defined budget, these transactions would be counted towards budgets of -'expenses:personal:electronics' and 'expenses:personal' accordingly: +`expenses:personal:electronics' and `expenses:personal' accordingly: + $ hledger balance --budget -M Budget performance in 2019/01: - || Jan + || Jan ===============================++=============================== - expenses || $283.00 [ 26% of $1100.00] - expenses:personal || $283.00 [ 26% of $1100.00] - expenses:personal:electronics || $100.00 [ 100% of $100.00] - liabilities || $-283.00 [ 26% of $-1100.00] + expenses || $283.00 [ 26% of $1100.00] + expenses:personal || $283.00 [ 26% of $1100.00] + expenses:personal:electronics || $100.00 [ 100% of $100.00] + liabilities || $-283.00 [ 26% of $-1100.00] -------------------------------++------------------------------- - || 0 [ 0] + || 0 [ 0] - And with '--empty', we can get a better picture of budget allocation + And with `--empty', we can get a better picture of budget allocation and consumption: + $ hledger balance --budget -M --empty Budget performance in 2019/01: - || Jan + || Jan ========================================++=============================== - expenses || $283.00 [ 26% of $1100.00] - expenses:personal || $283.00 [ 26% of $1100.00] - expenses:personal:electronics || $100.00 [ 100% of $100.00] - expenses:personal:electronics:upgrades || $10.00 - expenses:personal:train tickets || $153.00 - liabilities || $-283.00 [ 26% of $-1100.00] + expenses || $283.00 [ 26% of $1100.00] + expenses:personal || $283.00 [ 26% of $1100.00] + expenses:personal:electronics || $100.00 [ 100% of $100.00] + expenses:personal:electronics:upgrades || $10.00 + expenses:personal:train tickets || $153.00 + liabilities || $-283.00 [ 26% of $-1100.00] ----------------------------------------++------------------------------- - || 0 [ 0] + || 0 [ 0]  File: hledger.info, Node: Selecting budget goals, Prev: Budgets and subaccounts, Up: Budget report -11.5.13.3 Selecting budget goals +11.5.14.3 Selecting budget goals ................................ The budget report evaluates periodic transaction rules to generate special "goal transactions", which generate the goal amounts for each -account in each report subperiod. When troubleshooting, you can use the +account in each report subperiod. When troubleshooting, you can use the print command to show these as forecasted transactions: + $ hledger print --forecast=BUDGETREPORTPERIOD tag:generated By default, the budget report uses all available periodic transaction -rules to generate goals. This includes rules with a different report -interval from your report. Eg if you have daily, weekly and monthly +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 +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 +regular expression or query). This means you can give your periodic rules descriptions (remember that two spaces are needed), and then select from multiple budgets defined in your journal.  File: hledger.info, Node: Customising single-period balance reports, Prev: Budget report, Up: balance -11.5.14 Customising single-period balance reports +11.5.15 Customising single-period balance reports ------------------------------------------------- For single-period balance reports displayed in the terminal (only), you -can use '--format FMT' to customise the format and content of each line. -Eg: +can use `--format FMT' to customise the format and content of each +line. Eg: -$ hledger balance --format "%20(account) %12(total)" + +$ hledger -f examples/sample.journal balance --format "%20(account) %12(total)" assets $-1 bank:saving $1 cash $-2 @@ -2940,10 +3274,10 @@ $ hledger balance --format "%20(account) %12(total)" 0 The FMT format string (plus a newline) specifies the formatting -applied to each account/balance pair. It may contain any suitable text, +applied to each account/balance pair. It may contain any suitable text, with data fields interpolated like so: - '%[MIN][.MAX](FIELDNAME)' + `%[MIN][.MAX](FIELDNAME)' * MIN pads with spaces to at least this width (optional) @@ -2951,31 +3285,39 @@ with data fields interpolated like so: * FIELDNAME must be enclosed in parentheses, and can be one of: - * 'depth_spacer' - a number of spaces equal to the account's + * `depth_spacer' - a number of spaces equal to the account's depth, or if MIN is specified, MIN * depth spaces. - * 'account' - the account's name - * 'total' - the account's balance/posted total, right justified + + * `account' - the account's name + + * `total' - the account's balance/posted total, right justified + Also, FMT can begin with an optional prefix to control how multi-commodity amounts are rendered: - * '%_' - render on multiple lines, bottom-aligned (the default) - * '%^' - render on multiple lines, top-aligned - * '%,' - render on one line, comma-separated + * `%_' - render on multiple lines, bottom-aligned (the default) - There are some quirks. Eg in one-line mode, '%(depth_spacer)' has no -effect, instead '%(account)' has indentation built in. Experimentation + * `%^' - render on multiple lines, top-aligned + + * `%,' - render on one line, comma-separated + + There are some quirks. Eg in one-line mode, `%(depth_spacer)' has no +effect, instead `%(account)' has indentation built in. Experimentation may be needed to get pleasing results. Some example formats: - * '%(total)' - the account's total - * '%-20.20(account)' - the account's name, left justified, padded to + * `%(total)' - the account's total + + * `%-20.20(account)' - the account's name, left justified, padded to 20 characters and clipped at 20 characters - * '%,%-50(account) %25(total)' - account name padded to 50 + + * `%,%-50(account) %25(total)' - account name padded to 50 characters, total padded to 20 characters, with multiple commodities rendered on one line - * '%20(total) %2(depth_spacer)%-(account)' - the default format for + + * `%20(total) %2(depth_spacer)%-(account)' - the default format for the single-column balance report  @@ -2986,17 +3328,18 @@ File: hledger.info, Node: balancesheet, Next: balancesheetequity, Prev: balan balancesheet, bs This command displays a balance sheet, showing historical ending -balances of asset and liability accounts. (To see equity as well, use -the balancesheetequity command.) Amounts are shown with normal positive +balances of asset and liability accounts. (To see equity as well, use +the balancesheetequity command.) Amounts are shown with normal positive sign, as in conventional financial statements. The asset and liability accounts shown are those accounts declared -with the 'Asset' or 'Cash' or 'Liability' type, or otherwise all -accounts under a top-level 'asset' or 'liability' account (case +with the `Asset' or `Cash' or `Liability' type, or otherwise all +accounts under a top-level `asset' or `liability' account (case insensitive, plurals allowed). Example: + $ hledger balancesheet Balance Sheet @@ -3016,15 +3359,15 @@ Total: -------------------- 0 - This command is a higher-level variant of the 'balance' command, and + This command is a higher-level variant of the `balance' command, and supports many of that command's features, such as multi-period reports. -It is similar to 'hledger balance -H assets liabilities', but with +It is similar to `hledger balance -H assets liabilities', but with smarter account detection, and liabilities displayed with their sign flipped. This command also supports the output destination and output format -options The output formats supported are 'txt', 'csv', 'html', and -(experimental) 'json'. +options The output formats supported are `txt', `csv', `html', and +(experimental) `json'.  File: hledger.info, Node: balancesheetequity, Next: cashflow, Prev: balancesheet, Up: COMMANDS @@ -3034,16 +3377,17 @@ File: hledger.info, Node: balancesheetequity, Next: cashflow, Prev: balancesh balancesheetequity, bse This command displays a balance sheet, showing historical ending -balances of asset, liability and equity accounts. Amounts are shown -with normal positive sign, as in conventional financial statements. +balances of asset, liability and equity accounts. Amounts are shown with +normal positive sign, as in conventional financial statements. The asset, liability and equity accounts shown are those accounts -declared with the 'Asset', 'Cash', 'Liability' or 'Equity' type, or -otherwise all accounts under a top-level 'asset', 'liability' or -'equity' account (case insensitive, plurals allowed). +declared with the `Asset', `Cash', `Liability' or `Equity' type, or +otherwise all accounts under a top-level `asset', `liability' or +`equity' account (case insensitive, plurals allowed). Example: + $ hledger balancesheetequity Balance Sheet With Equity @@ -3068,15 +3412,15 @@ Total: -------------------- 0 - This command is a higher-level variant of the 'balance' command, and + This command is a higher-level variant of the `balance' command, and supports many of that command's features, such as multi-period reports. -It is similar to 'hledger balance -H assets liabilities equity', but +It is similar to `hledger balance -H assets liabilities equity', but with smarter account detection, and liabilities/equity displayed with their sign flipped. This command also supports the output destination and output format -options The output formats supported are 'txt', 'csv', 'html', and -(experimental) 'json'. +options The output formats supported are `txt', `csv', `html', and +(experimental) `json'.  File: hledger.info, Node: cashflow, Next: check, Prev: balancesheetequity, Up: COMMANDS @@ -3086,16 +3430,17 @@ File: hledger.info, Node: cashflow, Next: check, Prev: balancesheetequity, U cashflow, cf This command displays a cashflow statement, showing the inflows and -outflows affecting "cash" (ie, liquid) assets. Amounts are shown with +outflows affecting "cash" (ie, liquid) assets. Amounts are shown with normal positive sign, as in conventional financial statements. - The "cash" accounts shown are those accounts declared with the 'Cash' -type, or otherwise all accounts under a top-level 'asset' account (case -insensitive, plural allowed) which do not have 'fixed', 'investment', -'receivable' or 'A/R' in their name. + The "cash" accounts shown are those accounts declared with the +`Cash' type, or otherwise all accounts under a top-level `asset' +account (case insensitive, plural allowed) which do not have `fixed', +`investment', `receivable' or `A/R' in their name. Example: + $ hledger cashflow Cashflow Statement @@ -3110,14 +3455,14 @@ Total: -------------------- $-1 - This command is a higher-level variant of the 'balance' command, and + This command is a higher-level variant of the `balance' command, and supports many of that command's features, such as multi-period reports. -It is similar to 'hledger balance assets not:fixed not:investment +It is similar to `hledger balance assets not:fixed not:investment not:receivable', but with smarter account detection. This command also supports the output destination and output format -options The output formats supported are 'txt', 'csv', 'html', and -(experimental) 'json'. +options The output formats supported are `txt', `csv', `html', and +(experimental) `json'.  File: hledger.info, Node: check, Next: close, Prev: cashflow, Up: COMMANDS @@ -3129,13 +3474,14 @@ check Check for various kinds of errors in your data. hledger provides a number of built-in error checks to help prevent -problems in your data. Some of these are run automatically; or, you can -use this 'check' command to run them on demand, with no output and a -zero exit code if all is well. Specify their names (or a prefix) as +problems in your data. Some of these are run automatically; or, you can +use this `check' command to run them on demand, with no output and a +zero exit code if all is well. Specify their names (or a prefix) as argument(s). Some examples: + hledger check # basic checks hledger check -s # basic + strict checks hledger check ordereddates payees # basic + two other checks @@ -3156,7 +3502,7 @@ File: hledger.info, Node: Basic checks, Next: Strict checks, Up: check ------------------- These checks are always run automatically, by (almost) all hledger -commands, including 'check': +commands, including `check': * *parseable* - data files are well-formed and can be successfully parsed @@ -3167,7 +3513,8 @@ commands, including 'check': transaction prices * *assertions* - all balance assertions in the journal are passing. - (This check can be disabled with '-I'/'--ignore-assertions'.) + (This check can be disabled with `-I'/`--ignore-assertions'.) +  File: hledger.info, Node: Strict checks, Next: Other checks, Prev: Basic checks, Up: check @@ -3175,9 +3522,9 @@ File: hledger.info, Node: Strict checks, Next: Other checks, Prev: Basic chec 11.9.2 Strict checks -------------------- -These additional checks are run when the '-s'/'--strict' (strict mode) -flag is used. Or, they can be run by giving their names as arguments to -'check': +These additional checks are run when the `-s'/`--strict' (strict mode) +flag is used. Or, they can be run by giving their names as arguments to +`check': * *accounts* - all account names used by transactions have been declared @@ -3187,6 +3534,7 @@ flag is used. Or, they can be run by giving their names as arguments to * *balancednoautoconversion* - transactions are balanced, possibly using explicit transaction prices but not inferred ones +  File: hledger.info, Node: Other checks, Next: Custom checks, Prev: Strict checks, Up: check @@ -3194,7 +3542,7 @@ File: hledger.info, Node: Other checks, Next: Custom checks, Prev: Strict che ------------------- These checks can be run only by giving their names as arguments to -'check'. They are more specialised and not desirable for everyone, +`check'. They are more specialised and not desirable for everyone, therefore optional: * *ordereddates* - transactions are ordered by date within each file @@ -3203,6 +3551,7 @@ therefore optional: * *uniqueleafnames* - all account leaf names are unique +  File: hledger.info, Node: Custom checks, Prev: Other checks, Up: check @@ -3218,6 +3567,7 @@ https://github.com/simonmichael/hledger/tree/master/bin: * *hledger-check-fancyassertions* - more complex balance assertions are passing + You could make similar scripts to perform your own custom checks. See: Cookbook -> Scripting. @@ -3232,38 +3582,38 @@ Prints a sample "closing" transaction bringing specified account balances to zero, and an inverse "opening" transaction restoring the same account balances. - If like most people you split your journal files by time, eg by year: -at the end of the year you can use this command to "close out" your -asset and liability (and perhaps equity) balances in the old file, and -reinitialise them in the new file. This helps ensure that report + If like most people you split your journal files by time, eg by +year: at the end of the year you can use this command to "close out" +your asset and liability (and perhaps equity) balances in the old file, +and reinitialise them in the new file. This helps ensure that report balances remain correct whether you are including old files or not. (Because all closing/opening transactions except the very first will cancel out - see example below.) Some people also use this command to close out revenue and expense -balances at the end of an accounting period. This properly records the +balances at the end of an accounting period. This properly records the period's profit/loss as "retained earnings" (part of equity), and allows the accounting equation (A-L=E) to balance, which you could then check by the bse report's zero total. - You can print just the closing transaction by using the '--close' -flag, or just the opening transaction with the '--open' flag. + You can print just the closing transaction by using the `--close' +flag, or just the opening transaction with the `--open' flag. - Their descriptions are 'closing balances' and 'opening balances' by -default; you can customise these with the '--close-desc' and -'--open-desc' options. + Their descriptions are `closing balances' and `opening balances' by +default; you can customise these with the `--close-desc' and +`--open-desc' options. Just one balancing equity posting is used by default, with the amount -left implicit. The default account name is 'equity:opening/closing -balances'. You can customise the account name(s) with '--close-acct' -and '--open-acct'. (If you specify only one of these, it will be used +left implicit. The default account name is `equity:opening/closing +balances'. You can customise the account name(s) with `--close-acct' +and `--open-acct'. (If you specify only one of these, it will be used for both.) - With '--x/--explicit', the equity posting's amount will be shown + With `--x/--explicit', the equity posting's amount will be shown explicitly, and if it involves multiple commodities, there will be a separate equity posting for each commodity (as in the print command). - With '--interleaved', each equity posting is shown next to the + With `--interleaved', each equity posting is shown next to the posting it balances (good for troubleshooting). * Menu: @@ -3282,11 +3632,11 @@ File: hledger.info, Node: close and prices, Next: close date, Up: close ------------------------ Transaction prices are ignored (and discarded) by closing/opening -transactions, by default. With '--show-costs', they are preserved; +transactions, by default. With `--show-costs', they are preserved; there will be a separate equity posting for each cost in each commodity. -This means 'balance -B' reports will look the same after the transition. -Note if you have many foreign currency or investment transactions, this -will generate very large journal entries. +This means `balance -B' reports will look the same after the +transition. Note if you have many foreign currency or investment +transactions, this will generate very large journal entries.  File: hledger.info, Node: close date, Next: Example close asset/liability accounts for file transition, Prev: close and prices, Up: close @@ -3297,16 +3647,19 @@ File: hledger.info, Node: close date, Next: Example close asset/liability acco The default closing date is yesterday, or the journal's end date, whichever is later. - Unless you are running 'close' on exactly the first day of the new -period, you'll want to override the closing date. This is done by -specifying a report period, where "last day of the report period" will -be the closing date. The opening date is always the following day. So -to close on 2020-12-31 and open on 2021-01-01, any of these work + Unless you are running `close' on exactly the first day of the new +period, you'll want to override the closing date. This is done by +specifying a report end date, where "last day of the report period" will +be the closing date. The opening date is always the following day. So to +close on (end of) 2020-12-31 and open on (start of) 2021-01-01, any of +these will work: - * '-p 2020' - * 'date:2020' - * '-e 2021-01-01' (remember '-e' specifies an exclusive end date) - * '-e 2021' +end date argument explanation +------------------------------------------------------------------- +`-e 2021-01-01' end dates are exclusive +`-e 2021' equivalent, per smart dates +`-p 2020' equivalent, the period's begin date is ignored +`date:2020' equivalent query  File: hledger.info, Node: Example close asset/liability accounts for file transition, Next: Hiding opening/closing transactions, Prev: close date, Up: close @@ -3317,17 +3670,20 @@ File: hledger.info, Node: Example close asset/liability accounts for file trans Carrying asset/liability balances from 2020.journal into a new file for 2021: + $ hledger close -f 2020.journal -p 2020 assets liabilities # copy/paste the closing transaction to the end of 2020.journal # copy/paste the opening transaction to the start of 2021.journal Or: + $ hledger close -f 2020.journal -p 2020 assets liabilities --open >> 2021.journal # add 2021's first transaction $ hledger close -f 2020.journal -p 2020 assets liabilities --close >> 2020.journal # add 2020's last transaction Now, + $ hledger bs -f 2021.journal # just new file - balances correct $ hledger bs -f 2020.journal -f 2021.journal # old and new files - balances correct $ hledger bs -f 2020.journal # just old files - balances are zero ? @@ -3340,8 +3696,9 @@ File: hledger.info, Node: Hiding opening/closing transactions, Next: close and ------------------------------------------- Although the closing/opening transactions cancel out, they will be -visible in reports like 'print' and 'register', creating some visual -clutter. You can exclude them all with a query, like: +visible in reports like `print' and `register', creating some visual +clutter. You can exclude them all with a query, like: + $ hledger print not:desc:'opening|closing' # less typing $ hledger print not:'equity:opening/closing balances' # more precise @@ -3349,28 +3706,32 @@ $ hledger print not:'equity:opening/closing balances' # more precise But when reporting on multiple files, this can get a bit tricky; you may need to keep the earliest opening balances, for a historical register report; or you may need to suppress a closing transaction, to -see year-end balances. If you find yourself needing more precise +see year-end balances. If you find yourself needing more precise queries, here's one solution: add more easily-matched tags to opening/closing transactions, like this: + ; 2019.journal 2019-01-01 opening balances ; earliest opening txn, no tag here ... -2019-12-31 closing balances ; close:2019 +2019-12-31 closing balances ; clopen:2020 ... + ; 2020.journal -2020-01-01 opening balances ; open:2020 +2020-01-01 opening balances ; clopen:2020 ... -2020-12-31 closing balances ; close:2020 +2020-12-31 closing balances ; clopen:2021 ... + ; 2021.journal -2021-01-01 opening balances ; open:2021 +2021-01-01 opening balances ; clopen:2021 ... Now with + ; all.journal include 2019.journal include 2020.journal @@ -3378,15 +3739,13 @@ include 2021.journal you could do eg: -$ hledger -f all.journal reg -H checking not:tag:'open|close' + +$ hledger -f all.journal reg -H checking not:tag:clopen # all years checking register, hiding non-essential opening/closing txns -$ hledger -f all.journal bs -p 2020 not:tag:close=2020 +$ hledger -f all.journal bs -p 2020 not:tag:clopen=2020 # 2020 year end balances, suppressing 2020 closing txn -$ hledger -f 2020.journal bs not:tag:close - # 2020 year end balances, easier case -  File: hledger.info, Node: close and balance assertions, Next: Example close revenue/expense accounts to retained earnings, Prev: Hiding opening/closing transactions, Up: close @@ -3395,19 +3754,20 @@ File: hledger.info, Node: close and balance assertions, Next: Example close re The closing and opening transactions will include balance assertions, verifying that the accounts have first been reset to zero and then -restored to their previous balance. These provide valuable error +restored to their previous balance. These provide valuable error checking, alerting you when things get out of line, but you can ignore -them temporarily with '-I' or just remove them if you prefer. +them temporarily with `-I' or just remove them if you prefer. You probably shouldn't use status or realness filters (like -C or -R -or 'status:') with 'close', or the generated balance assertions will -depend on these flags. Likewise, if you run this command with '--auto', -the balance assertions would probably always require '--auto'. +or `status:') with `close', or the generated balance assertions will +depend on these flags. Likewise, if you run this command with `--auto', +the balance assertions would probably always require `--auto'. Multi-day transactions (where some postings have a different date) break the balance assertions, because the money is temporarily "invisible" while in transit: + 2020/12/30 a purchase made in december, cleared in the next year expenses:food 5 assets:bank:checking -5 ; date: 2021/1/2 @@ -3416,6 +3776,7 @@ break the balance assertions, because the money is temporarily in-transit money (splitting the multi-day transaction into two single-day transactions): + ; in 2020.journal: 2020/12/30 a purchase made in december, cleared in the next year expenses:food 5 @@ -3432,25 +3793,34 @@ File: hledger.info, Node: Example close revenue/expense accounts to retained ea 11.10.6 Example: close revenue/expense accounts to retained earnings -------------------------------------------------------------------- -Here, the opening transaction is supressed with '--close', as it's -probably not needed. Also you'll want to use a different equity account -name: +For this, use `--close' to suppress the opening transaction, as it's +not needed. Also you'll want to change the equity account name to your +equivalent of "equity:retained earnings". -$ hledger close -f 2021.journal -p 2021Q1 --close --close-acct='equity:retained earnings' revenues expenses >> 2021.journal - # close 2021 first quarter revenues/expenses + Closing 2021's first quarter revenues/expenses: - Or, operating on the default journal: -$ hledger close -p Q1 --close --close-acct='equity:retained earnings' revenues expenses >> $LEDGER_FILE - # close current year's first quarter revenues/expenses +$ hledger close -f 2021.journal --close revenues expenses -p 2021Q1 \ + --close-acct='equity:retained earnings' >> 2021.journal + + The same, using the default journal and current year: + + +$ hledger close --close revenues expenses -p Q1 \ + --close-acct='equity:retained earnings' >> $LEDGER_FILE + + Now, the first quarter's balance sheet should show a zero (unless you +are using @/@@ notation without equity postings): - Now, eg: $ hledger bse -p Q1 - # Q1 full balance sheet, total should be zero -$ hledger is -p Q1 not:'retained earnings' - # Q1 income statement, must suppress the closing txn + And we must suppress the closing transaction to see the first +quarter's income statement (using the description; `not:'retained +earnings'' won't work here): + + +$ hledger is -p Q1 not:desc:'closing balances'  File: hledger.info, Node: codes, Next: commodities, Prev: close, Up: COMMANDS @@ -3462,18 +3832,19 @@ 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 +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 +codes 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. Examples: + 1/1 (123) (a) 1 @@ -3486,11 +3857,13 @@ will be printed as blank lines. 1/1 (126) (a) 1 + $ hledger codes 123 124 126 + $ hledger codes -E 123 124 @@ -3517,11 +3890,12 @@ descriptions 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 +transactions, in alphabetic order. You can add a query to select a subset of transactions. Example: + $ hledger descriptions Store Name Gas Station | Petrol @@ -3534,25 +3908,26 @@ File: hledger.info, Node: diff, Next: files, Prev: descriptions, Up: COMMAND ========== 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.) -Since postings not transactions are compared, this also works when -multiple bank transactions have been combined into a single journal -entry. +file, it looks for a corresponding posting in the other file which +posts the same amount to the same account (ignoring date, description, +etc.) Since postings not transactions are compared, this also works +when multiple bank transactions have been combined into a single +journal entry. 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 +from 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. Examples: -$ 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 @@ -3569,8 +3944,8 @@ File: hledger.info, Node: files, Next: help, Prev: diff, Up: COMMANDS =========== files -List all files included in the journal. With a REGEX argument, only -file names matching the regular expression (case sensitive) are shown. +List all files included in the journal. With a REGEX argument, only file +names matching the regular expression (case sensitive) are shown.  File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS @@ -3580,18 +3955,22 @@ File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS help Show the hledger user manual in one of several formats, optionally -positioned at a given TOPIC (if possible). TOPIC is any heading, or -heading prefix, in the manual. Some examples: commands, print, 'auto -postings', periodic. +positioned at a given TOPIC (if possible). + + TOPIC is any heading in the manual, or the start of any heading (but +not the middle). It is case insensitive. + + Some examples: `commands', `print', `forecast', `"auto postings"', +`"commodity column"'. This command shows the user manual built in to this hledger version. It can be useful if the correct version of the hledger manual, or the usual viewing tools, are not installed on your system. By default it uses the best viewer it can find in $PATH, in this -order: 'info', 'man', $PAGER (unless a topic is specified), 'less', or -stdout. When run non-interactively, it always uses stdout. Or you can -select a particular viewer with the '-i' (info), '-m' (man), or '-p' +order: `info', `man', $PAGER (unless a topic is specified), `less', or +stdout. When run non-interactively, it always uses stdout. Or you can +select a particular viewer with the `-i' (info), `-m' (man), or `-p' (pager) flags.  @@ -3602,15 +3981,15 @@ File: hledger.info, Node: import, Next: incomestatement, Prev: help, Up: COM import Read new transactions added to each FILE since last run, and add them to -the main journal file. Or with -dry-run, just print the transactions -that would be added. Or with -catchup, just mark all of the FILEs' +the main journal file. Or with -dry-run, just print the transactions +that would be added. Or with -catchup, just mark all of the FILEs' transactions as imported, without actually importing any. - Unlike other hledger commands, with 'import' the journal file is an + Unlike other hledger commands, with `import' the journal file is an output file, and will be modified, though only by appending (existing -data will not be changed). The input files are specified as arguments, +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 -'hledger import bank.csv' or perhaps 'hledger import *.csv'. +`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. @@ -3628,43 +4007,45 @@ File: hledger.info, Node: Deduplication, Next: Import testing, Up: import 11.17.1 Deduplication --------------------- -As a convenience 'import' does _deduplication_ while reading -transactions. 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 periodically importing foreign data -which may contain already-imported transactions. So eg, if every day -you download bank CSV files containing redundant data, you can safely -run 'hledger import bank.csv' and only new transactions will be -imported. ('import' is idempotent.) +As a convenience `import' does _deduplication_ while reading +transactions. 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 periodically importing foreign data which +may contain already-imported transactions. So eg, if every day you +download bank CSV files containing redundant data, you can safely run +`hledger import bank.csv' and only new transactions will be imported. +(`import' is idempotent.) 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 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 +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 be the ones affected). hledger remembers the latest date processed in each input file by -saving a hidden ".latest" state file in the same directory. Eg when -reading 'finance/bank.csv', it will look for and update the -'finance/.latest.bank.csv' state file. The format is simple: one or +saving a hidden ".latest" state file in the same directory. Eg when +reading `finance/bank.csv', it will look for and update the +`finance/.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 date." Normally you won't see or manipulate these state files -yourself. But if needed, you can delete them to reset the state (making +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 certain date. Note deduplication (and updating of state files) can also be done by -'print --new', but this is less often used. +`print --new', but this is less often used.  File: hledger.info, Node: Import testing, Next: Importing balance assignments, Prev: Deduplication, Up: import @@ -3672,16 +4053,18 @@ File: hledger.info, Node: Import testing, Next: Importing balance assignments, 11.17.2 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 or (live updating): + $ ls bank.csv* | entr bash -c 'echo ====; hledger import --dry bank.csv | hledger -f- -I print unknown'  @@ -3691,12 +4074,13 @@ File: hledger.info, Node: Importing balance assignments, Next: Commodity displ ------------------------------------- Entries added by import will have their posting amounts made explicit -(like 'hledger print -x'). This means that any balance assignments in +(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 +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 -amounts. To avoid this problem, use print instead of import: +amounts. To avoid this problem, use print instead of import: + $ hledger print IMPORTFILE [--new] >> $LEDGER_FILE @@ -3719,18 +4103,18 @@ File: hledger.info, Node: incomestatement, Next: notes, Prev: import, Up: CO ===================== incomestatement, is - - This command displays an income statement, showing revenues and -expenses during one or more periods. Amounts are shown with normal -positive sign, as in conventional financial statements. +This command displays an income statement, showing revenues and expenses +during one or more periods. Amounts are shown with normal positive sign, +as in conventional financial statements. The revenue and expense accounts shown are those accounts declared -with the 'Revenue' or 'Expense' type, or otherwise all accounts under a -top-level 'revenue' or 'income' or 'expense' account (case insensitive, +with the `Revenue' or `Expense' type, or otherwise all accounts under a +top-level `revenue' or `income' or `expense' account (case insensitive, plurals allowed). Example: + $ hledger incomestatement Income Statement @@ -3752,15 +4136,15 @@ Total: -------------------- 0 - This command is a higher-level variant of the 'balance' command, and + This command is a higher-level variant of the `balance' command, and supports 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 -sign flipped. +It is similar to `hledger balance '(revenues|income)' expenses', but +with smarter account detection, and revenues/income displayed with +their sign flipped. This command also supports the output destination and output format -options The output formats supported are 'txt', 'csv', 'html', and -(experimental) 'json'. +options The output formats supported are `txt', `csv', `html', and +(experimental) `json'.  File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: COMMANDS @@ -3772,12 +4156,13 @@ notes List the unique notes that appear in transactions. This command lists the unique notes that appear in transactions, in -alphabetic order. You can add a query to select a subset of -transactions. The note is the part of the transaction description after +alphabetic order. You can add a query to select a subset of +transactions. The note is the part of the transaction description after a | character (or if there is no |, the whole description). Example: + $ hledger notes Petrol Snacks @@ -3798,11 +4183,12 @@ with payee directives (-declared), used in transaction descriptions 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: + $ hledger payees Store Name Gas Station @@ -3815,11 +4201,11 @@ File: hledger.info, Node: prices, Next: print, Prev: payees, Up: COMMANDS ============ prices -Print market price directives from the journal. With -costs, also print -synthetic market prices based on transaction prices. With +Print market price directives from the journal. With -costs, also print +synthetic market prices based on transaction prices. With -inverted-costs, also print inverse prices based on transaction prices. -Prices (and postings providing prices) can be filtered by a query. -Price amounts are always displayed with their full precision. +Prices (and postings providing prices) can be filtered by a query. Price +amounts are always displayed with their full precision.  File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS @@ -3831,10 +4217,10 @@ print Show transaction journal entries, sorted by date. The print command displays full journal entries (transactions) from -the journal file, sorted by date (or with '--date2', by secondary date). +the journal file, sorted by date (or with `--date2', by secondary date). Amounts are shown mostly normalised to commodity display style, eg -the placement of commodity symbols will be consistent. All of their +the placement of commodity symbols will be consistent. All of their decimal places are shown, as in the original journal entry (with one alteration: in some cases trailing zeroes are added.) @@ -3848,6 +4234,7 @@ directives and file-level comments. Eg: + $ hledger print 2008/01/01 income assets:bank:checking $1 @@ -3871,9 +4258,10 @@ $ hledger print assets:bank:checking $-1 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 +process it again with a second hledger command. This can be useful for certain kinds of search, eg: + # 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 @@ -3883,40 +4271,42 @@ unparseable: * Valuation affects posting amounts but not balance assertion or balance assignment amounts, potentially causing those to fail. + * Auto postings can generate postings with too many missing amounts. Normally, the journal entry's explicit or implicit amount style is -preserved. For example, when an amount is omitted in the journal, it -will not appear in the output. Similarly, when a transaction price is -implied but not written, it will not appear in the output. You can use -the '-x'/'--explicit' flag to make all amounts and transaction prices +preserved. For example, when an amount is omitted in the journal, it +will not appear in the output. Similarly, when a transaction price is +implied but not written, it will not appear in the output. You can use +the `-x'/`--explicit' flag to make all amounts and transaction prices explicit, which can be useful for troubleshooting or for making your -journal more readable and robust against data entry errors. '-x' is -also implied by using any of '-B','-V','-X','--value'. +journal more readable and robust against data entry errors. `-x' is +also implied by using any of `-B',`-V',`-X',`--value'. - Note, '-x'/'--explicit' will cause postings with a multi-commodity + Note, `-x'/`--explicit' will cause postings with a multi-commodity amount (these can arise when a multi-commodity transaction has an implicit amount) to be split into multiple single-commodity postings, keeping the output parseable. - With '-B'/'--cost', amounts with transaction prices are converted to -cost using that price. This can be used for troubleshooting. + With `-B'/`--cost', amounts with transaction prices are converted to +cost using that price. This can be used for troubleshooting. - With '-m'/'--match' and a STR argument, print will show at most one + With `-m'/`--match' and a STR argument, print will show at most one transaction: the one one whose description is most similar to STR, and -is most recent. STR should contain at least two characters. If there -is no similar-enough match, no transaction will be shown. +is most recent. STR should contain at least two characters. If there is +no similar-enough match, no transaction will be shown. - With '--new', hledger prints only transactions it has not seen on a -previous run. This uses the same deduplication system as the 'import' -command. (See import's docs for details.) + With `--new', hledger prints only transactions it has not seen on a +previous run. This uses the same deduplication system as the `import' +command. (See import's docs for details.) This command also supports the output destination and output format -options The output formats supported are 'txt', 'csv', and -(experimental) 'json' and 'sql'. +options The output formats supported are `txt', `csv', and +(experimental) `json' and `sql'. Here's an example of print's CSV output: + $ hledger print -Ocsv "txnidx","date","date2","status","code","description","comment","account","amount","commodity","credit","debit","posting-status","posting-comment" "1","2008/01/01","","","","income","","assets:bank:checking","1","$","","1","","" @@ -3933,14 +4323,17 @@ $ hledger print -Ocsv * There is one CSV record per posting, with the parent transaction's fields repeated. + * The "txnidx" (transaction index) field shows which postings belong - to the same transaction. (This number might change if transactions + to the same transaction. (This number might change if transactions are reordered within the file, files are parsed/included in a different order, etc.) + * The amount is separated into "commodity" (the symbol) and "amount" (numeric quantity) fields. + * The numeric amount is repeated in either the "credit" or "debit" - column, for convenience. (Those names are not accurate in the + column, for convenience. (Those names are not accurate in the accounting sense; it just puts negative amounts under credit and zero or greater amounts under debit.) @@ -3955,6 +4348,7 @@ Print transactions which do not reuse an already-seen description. Example: + $ cat unique.journal 1/1 test (acct:one) 1 @@ -3976,7 +4370,7 @@ 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 +(See also the `aregister' command, which shows matched transactions in a specific account.) register normally shows line per posting, but note that @@ -3986,6 +4380,7 @@ commodity). It is typically used with a query selecting a particular account, to see that account's activity: + $ hledger register checking 2008/01/01 income assets:bank:checking $1 $1 2008/06/01 gift assets:bank:checking $1 $2 @@ -3994,43 +4389,47 @@ $ hledger register checking With -date2, it shows and sorts by secondary date instead. - The '--historical'/'-H' flag adds the balance from any undisplayed -prior postings to the running total. This is useful when you want to + 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 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 - The '--depth' option limits the amount of sub-account detail + The `--depth' option limits the amount of sub-account detail displayed. - The '--average'/'-A' flag shows the running average posting amount + 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 +average for the whole report period). This flag implies `--empty' (see +below). It is affected by `--historical'. It works best when showing just one account and one commodity. - The '--related'/'-r' flag shows the _other_ postings in the + 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 + The `--invert' flag negates all amounts. For example, it can be used on an income account where amounts are normally displayed as negative -numbers. It's also useful to show postings on the checking account +numbers. It's also useful to show postings on the checking account together with the related account: + $ hledger register --related --invert assets:checking With a reporting interval, register shows summary postings, one per interval, aggregating the postings to each account: + $ hledger register --monthly income 2008/01 income:salary $-1 $-1 2008/06 income:gifts $-1 $-2 Periods with no activity, and summary postings with a zero amount, -are not shown by default; use the '--empty'/'-E' flag to see them: +are not shown by default; use the `--empty'/`-E' flag to see them: + $ hledger register --monthly income -E 2008/01 income:salary $-1 $-1 @@ -4046,9 +4445,10 @@ $ hledger register --monthly income -E 2008/11 0 $-2 2008/12 0 $-2 - Often, you'll want to see just one line per interval. The '--depth' + Often, you'll want to see just one line per interval. The `--depth' option helps with this, causing subaccounts to be aggregated: + $ hledger register --monthly assets --depth 1h 2008/01 assets $1 $1 2008/06 assets $-1 0 @@ -4056,7 +4456,7 @@ $ hledger register --monthly assets --depth 1h Note when using report intervals, if you specify start/end dates these will be adjusted outward if necessary to contain a whole number of -intervals. This ensures that the first and last intervals are full +intervals. This ensures that the first and last intervals are full length and comparable to the others in the report. * Menu: @@ -4069,14 +4469,15 @@ File: hledger.info, Node: Custom register output, Up: register 11.24.1 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 -a bash shell variable) or by using the '--width'/'-w' option. +register uses the full terminal width by default, except on windows. You +can override this by setting the `COLUMNS' environment variable (not a +bash shell variable) or by using the `--width'/`-w' option. The description and account columns normally share the space equally -(about half of (width - 40) each). You can adjust this by adding a +(about half of (width - 40) each). You can adjust this by adding a description width as part of -width's argument, comma-separated: -'--width W,D' . Here's a diagram (won't display correctly in -help): +`--width W,D' . Here's a diagram (won't display correctly in -help): + <--------------------------------- width (W) ----------------------------------> date (10) description (D) account (W-41-D) amount (12) balance (12) @@ -4084,6 +4485,7 @@ DDDDDDDDDD dddddddddddddddddddd aaaaaaaaaaaaaaaaaaa AAAAAAAAAAAA AAAAAAAAAAAA and some examples: + $ 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 @@ -4092,8 +4494,8 @@ $ hledger reg -w 100,40 # set overall width 100, description width 40 $ hledger reg -w $COLUMNS,40 # use terminal width, & description width 40 This command also supports the output destination and output format -options The output formats supported are 'txt', 'csv', and -(experimental) 'json'. +options The output formats supported are `txt', `csv', and +(experimental) `json'.  File: hledger.info, Node: register-match, Next: rewrite, Prev: register, Up: COMMANDS @@ -4103,9 +4505,9 @@ File: hledger.info, Node: register-match, Next: rewrite, Prev: register, Up: register-match Print the one posting whose transaction description is closest to DESC, -in the style of the register command. If there are multiple equally -good matches, it shows the most recent. Query options (options, not -arguments) can be used to restrict the search space. Helps +in the style of the register command. If there are multiple equally good +matches, it shows the most recent. Query options (options, not +arguments) can be used to restrict the search space. Helps ledger-autosync detect already-seen transactions when importing.  @@ -4119,7 +4521,7 @@ Print all transactions, rewriting the postings of matched transactions. For now the only rewrite available is adding new postings, like print -auto. - This is a start at a generic rewriter of transaction entries. It + This is a start at a generic rewriter of transaction entries. It reads the default journal and prints the transactions, like print, but adds one or more specified postings to any transactions matching QUERY. The posting amounts can be fixed, or a multiplier of the existing @@ -4127,12 +4529,14 @@ transaction's first posting amount. Examples: + $ hledger-rewrite.hs ^income --add-posting '(liabilities:tax) *.33 ; income tax' --add-posting '(reserve:gifts) $100' $ hledger-rewrite.hs expenses:gifts --add-posting '(reserve:gifts) *-1"' $ hledger-rewrite.hs -f rewrites.hledger rewrites.hledger may consist of entries like: + = ^income amt:<0 date:2017 (liabilities:tax) *0.33 ; tax on income (reserve:grocery) *0.25 ; reserve 25% for grocery @@ -4143,17 +4547,18 @@ two spaces between account and amount. More: + $ hledger rewrite -- [QUERY] --add-posting "ACCT AMTEXPR" ... $ hledger rewrite -- ^income --add-posting '(liabilities:tax) *.33' $ hledger rewrite -- expenses:gifts --add-posting '(budget:gifts) *-1"' $ hledger rewrite -- ^income --add-posting '(budget:foreign currency) *0.25 JPY; diversify' - Argument for '--add-posting' option is a usual posting of transaction -with an exception for amount specification. More precisely, you can use -''*'' (star symbol) before the amount to indicate that that this is a -factor for an amount of original matched posting. If the amount -includes a commodity name, the new posting amount will be in the new -commodity; otherwise, it will be in the matched posting amount's + Argument for `--add-posting' option is a usual posting of +transaction with an exception for amount specification. More precisely, +you can use `'*'' (star symbol) before the amount to indicate that that +this is a factor for an amount of original matched posting. If the +amount includes a commodity name, the new posting amount will be in the +new commodity; otherwise, it will be in the matched posting amount's commodity. * Menu: @@ -4169,13 +4574,15 @@ File: hledger.info, Node: Re-write rules in a file, Next: Diff output format, -------------------------------- During the run this tool will execute so called "Automated Transactions" -found in any journal it process. I.e instead of specifying this +found in any journal it process. I.e instead of specifying this operations in command line you can put them in a journal file. + $ rewrite-rules.journal Make contents look like this: + = ^income (liabilities:tax) *.33 @@ -4183,21 +4590,23 @@ $ rewrite-rules.journal budget:gifts *-1 assets:budget *1 - Note that ''='' (equality symbol) that is used instead of date in -transactions you usually write. It indicates the query by which you -want to match the posting to add new ones. + Note that `'='' (equality symbol) that is used instead of date in +transactions you usually write. It indicates the query by which you want +to match the posting to add new ones. + $ hledger rewrite -- -f input.journal -f rewrite-rules.journal > rewritten-tidy-output.journal This is something similar to the commands pipeline: + $ hledger rewrite -- -f input.journal '^income' --add-posting '(liabilities:tax) *.33' \ | hledger rewrite -- -f - expenses:gifts --add-posting 'budget:gifts *-1' \ --add-posting 'assets:budget *1' \ > rewritten-tidy-output.journal It is important to understand that relative order of such entries in -journal is important. You can re-use result of previously added +journal is important. You can re-use result of previously added postings.  @@ -4209,10 +4618,12 @@ File: hledger.info, Node: Diff output format, Next: rewrite vs print --auto, To use this tool for batch modification of your journal files you may find useful output in form of unified diff. + $ hledger rewrite -- --diff -f examples/sample.journal '^income' --add-posting '(liabilities:tax) *.33' Output might look like: + --- /tmp/examples/sample.journal +++ /tmp/examples/sample.journal @@ -18,3 +18,4 @@ @@ -4228,14 +4639,14 @@ $ hledger rewrite -- --diff -f examples/sample.journal '^income' --add-posting ' income:gifts + (liabilities:tax) 0 - If you'll pass this through 'patch' tool you'll get transactions -containing the posting that matches your query be updated. Note that + If you'll pass this through `patch' tool you'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 '--file' options and 'include' directives inside of these +specified via `--file' options and `include' directives inside of these files. - Be careful. Whole transaction being re-formatted in a style of -output from 'hledger print'. + Be careful. Whole transaction being re-formatted in a style of output +from `hledger print'. See also: @@ -4251,16 +4662,16 @@ This command predates print -auto, and currently does much the same thing, but with these differences: * with multiple files, rewrite lets rules in any file affect all - other files. print -auto uses standard directive scoping; rules + other files. print -auto uses standard directive scoping; rules affect only child files. * rewrite's query limits which transactions can be rewritten; all are - printed. print -auto's query limits which transactions are - printed. + printed. print -auto's query limits which transactions are printed. * rewrite applies rules specified on command line or in the journal. print -auto applies rules specified in the journal. +  File: hledger.info, Node: roi, Next: stats, Prev: rewrite, Up: COMMANDS @@ -4272,27 +4683,28 @@ Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on your investments. At a minimum, you need to supply a query (which could be just an -account name) to select your investment(s) with '--inv', and another -query to identify your profit and loss transactions with '--pnl'. +account name) to select your investment(s) with `--inv', and another +query to identify your profit and loss transactions with `--pnl'. If you do not record changes in the value of your investment manually, or do not require computation of time-weighted return (TWR), -'--pnl' could be an empty query ('--pnl ""' or '--pnl STR' where 'STR' +`--pnl' could be an empty query (`--pnl ""' or `--pnl STR' where `STR' does not match any of your accounts). This command will compute and display the internalized rate of return (IRR) and time-weighted rate of return (TWR) for your investments for -the time period requested. Both rates of return are annualized before +the time period requested. Both rates of return are annualized before display, regardless of the length of reporting interval. Price directives will be taken into account if you supply appropriate -'--cost' or '--value' flags (see VALUATION). +`--cost' or `--value' flags (see VALUATION). Note, in some cases this report can fail, for these reasons: * Error (NotBracketed): No solution for Internal Rate of Return - (IRR). Possible causes: IRR is huge (>1000000%), balance of + (IRR). Possible causes: IRR is huge (>1000000%), balance of investment becomes negative at some point in time. + * Error (SearchFailed): Failed to find solution for Internal Rate of Return (IRR). Either search does not converge to a solution, or converges too slowly. @@ -4304,6 +4716,7 @@ display, regardless of the length of reporting interval. * Cookbook -> Return on Investment + * Menu: * Spaces and special characters in --inv and --pnl:: @@ -4313,63 +4726,72 @@ display, regardless of the length of reporting interval.  File: hledger.info, Node: Spaces and special characters in --inv and --pnl, Next: Semantics of --inv and --pnl, Up: roi -11.27.1 Spaces and special characters in '--inv' and +11.27.1 Spaces and special characters in `--inv' and ---------------------------------------------------- -'--pnl' Note that '--inv' and '--pnl''s argument is a query, and queries +`--pnl' + + Note that `--inv' and `--pnl''s argument is a query, and queries could have several space-separated terms (see QUERIES). To indicate that all search terms form single command-line argument, you will need to put them in quotes (see Special characters): + $ hledger roi --inv 'term1 term2 term3 ...' If any query terms contain spaces themselves, you will need an extra level of nested quoting, eg: + $ hledger roi --inv="'Assets:Test 1'" --pnl="'Equity:Unrealized Profit and Loss'"  File: hledger.info, Node: Semantics of --inv and --pnl, Next: IRR and TWR explained, Prev: Spaces and special characters in --inv and --pnl, Up: roi -11.27.2 Semantics of '--inv' and '--pnl' +11.27.2 Semantics of `--inv' and `--pnl' ---------------------------------------- -Query supplied to '--inv' has to match all transactions that are related -to your investment. Transactions not matching '--inv' will be ignored. +Query supplied to `--inv' has to match all transactions that are +related to your investment. Transactions not matching `--inv' will be +ignored. - In these transactions, ROI will conside postings that match '--inv' -to be "investment postings" and other postings (not matching '--inv') + In these transactions, ROI will conside postings that match `--inv' +to be "investment postings" and other postings (not matching `--inv') will be sorted into two categories: "cash flow" and "profit and loss", as ROI needs to know which part of the investment value is your contributions and which is due to the return on investment. * "Cash flow" is depositing or withdrawing money, buying or selling assets, or otherwise converting between your investment commodity - and any other commodity. Example: + and any other commodity. Example: + 2019-01-01 Investing in Snake Oil assets:cash -$100 investment:snake oil - + 2020-01-01 Selling my Snake Oil assets:cash $10 investment:snake oil = 0 * "Profit and loss" is change in the value of your investment: + 2019-06-01 Snake Oil falls in value investment:snake oil = $57 equity:unrealized profit or loss + All non-investment postings are assumed to be "cash flow", unless -they match '--pnl' query. Changes in value of your investment due to +they match `--pnl' query. Changes in value of your investment due to "profit and loss" postings will be considered as part of your investment return. - Example: if you use '--inv snake --pnl equity:unrealized', then + Example: if you use `--inv snake --pnl equity:unrealized', then postings in the example below would be classifed as: + 2019-01-01 Snake Oil #1 assets:cash -$100 ; cash flow posting investment:snake oil ; investment posting @@ -4389,31 +4811,31 @@ File: hledger.info, Node: IRR and TWR explained, Prev: Semantics of --inv and 11.27.3 IRR and TWR explained ----------------------------- -"ROI" stands for "return on investment". Traditionally this was -computed as a difference between current value of investment and its -initial value, expressed in percentage of the initial value. +"ROI" stands for "return on investment". Traditionally this was computed +as a difference between current value of investment and its initial +value, expressed in percentage of the initial value. However, this approach is only practical in simple cases, where 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 +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. Internal rate of return, or "IRR" (also called "money-weighted rate of return") takes into account effects of in-flows and out-flows. Naively, if you are withdrawing from your investment, your future gains -would be smaller (in absolute numbers), and will be a smaller percentage -of your initial investment, and if you are adding to your investment, -you will receive bigger absolute gains (but probably at the same rate of -return). IRR is a way to compute rate of return for each period between -in-flow or out-flow of money, and then combine them in a way that gives -you a compound annual rate of return that investment is expected to -generate. +would be smaller (in absolute numbers), and will be a smaller +percentage of your initial investment, and if you are adding to your +investment, you will receive bigger absolute gains (but probably at the +same rate of return). IRR is a way to compute rate of return for each +period between in-flow or out-flow of money, and then combine them in a +way that gives you a compound annual rate of return that investment is +expected to generate. As mentioned before, in-flows and out-flows would be any cash that you personally put in or withdraw, and for the "roi" command, these are -the postings that match the query in the'--inv' argument and NOT match -the query in the'--pnl' argument. +the postings that match the query in the`--inv' argument and NOT match +the query in the`--pnl' argument. If you manually record changes in the value of your investment as transactions that balance them against "profit and loss" (or "unrealized @@ -4424,21 +4846,21 @@ close to the days when in- or out-flows occur. In technical terms, IRR uses the same approach as computation of net present value, and tries to find a discount rate that makes net present -value of all the cash flows of your investment to add up to zero. This +value of all the cash flows of your investment to add up to zero. This could be hard to wrap your head around, especially if you haven't done -discounted cash flow analysis before. Implementation of IRR in hledger -should produce results that match the 'XIRR' formula in Excel. +discounted cash flow analysis before. Implementation of IRR in hledger +should produce results that match the `XIRR' formula in Excel. - Second way to compute rate of return that 'roi' command implements is -called "time-weighted rate of return" or "TWR". Like IRR, it will also -break the history of your investment into periods between in-flows, + Second way to compute rate of return that `roi' command implements +is called "time-weighted rate of return" or "TWR". Like IRR, it will +also break the history of your investment into periods between in-flows, out-flows and value changes, to compute rate of return per each period -and then a compound rate of return. However, internal workings of TWR +and then a compound rate of return. However, internal workings of TWR are quite different. TWR represents your investment as an imaginary "unit fund" where in-flows/ out-flows lead to buying or selling "units" of your investment -and changes in its value change the value of "investment unit". Change +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. @@ -4455,15 +4877,16 @@ File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS stats Show some journal statistics. - The stats command displays summary information for the whole journal, -or a matched part of it. With a reporting interval, it shows a report -for each report period. + The stats command displays summary information for the whole +journal, or a matched part of it. With a reporting interval, it shows a +report for each report period. Example: + $ hledger stats Main journal file : /src/hledger/examples/sample.journal -Included journal files : +Included journal files : Transactions span : 2008-01-01 to 2009-01-01 (366 days) Last transaction : 2008-12-31 (2333 days ago) Transactions : 5 (0.0 per day) @@ -4484,10 +4907,10 @@ File: hledger.info, Node: tags, Next: test, Prev: stats, Up: COMMANDS ========== tags -List the unique tag names used in the journal. With a TAGREGEX -argument, only tag names matching the regular expression (case -insensitive) are shown. With QUERY arguments, only transactions -matching the query are considered. +List the unique tag names used in the journal. With a TAGREGEX argument, +only tag names matching the regular expression (case insensitive) are +shown. With QUERY arguments, only transactions matching the query are +considered. With the -values flag, the tags' unique values are listed instead. @@ -4507,22 +4930,23 @@ 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 -be non-zero. +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 +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 -- (double hyphen). Eg to run only the tests in Hledger.Data.Amount, -with ANSI colour codes disabled: +- (double hyphen). Eg to run only the tests in Hledger.Data.Amount, with +ANSI colour codes disabled: + $ hledger test -- -pData.Amount --color=never For help on these, see https://github.com/feuerbach/tasty#options -('-- --help' currently doesn't show them). +(`-- --help' currently doesn't show them).  File: hledger.info, Node: About add-on commands, Prev: test, Up: COMMANDS @@ -4532,35 +4956,40 @@ File: hledger.info, Node: About add-on commands, Prev: test, Up: COMMANDS Add-on commands are programs or scripts in your PATH - * whose name starts with 'hledger-' + * whose name starts with `hledger-' + * whose name ends with a recognised file extension: - '.bat','.com','.exe', '.hs','.lhs','.pl','.py','.rb','.rkt','.sh' + `.bat',`.com',`.exe', `.hs',`.lhs',`.pl',`.py',`.rb',`.rkt',`.sh' or none + * and (on unix, mac) which are executable by the current user. Add-ons are a relatively easy way to add local features or experiment -with new ideas. They can be written in any language, but haskell -scripts have a big advantage: they can use the same hledger library -functions that built-in commands use for command-line options, parsing -and reporting. Some experimental/example add-on scripts can be found in -the hledger repo's bin/ directory. +with new ideas. They can be written in any language, but haskell scripts +have a big advantage: they can use the same hledger library functions +that built-in commands use for command-line options, parsing and +reporting. Some experimental/example add-on scripts can be found in the +hledger repo's bin/ directory. Note in a hledger command line, add-on command flags must have a -double dash ('--') preceding them. Eg you must write: +double dash (`--') preceding them. Eg you must write: + $ hledger web -- --serve and not: + $ hledger web --serve - (because the '--serve' flag belongs to 'hledger-web', not 'hledger'). + (because the `--serve' flag belongs to `hledger-web', not `hledger'). - The '-h/--help' and '--version' flags don't require '--'. + The `-h/--help' and `--version' flags don't require `--'. If you have any trouble with this, remember you can always run the add-on program directly, eg: + $ hledger-web --serve  @@ -4572,30 +5001,30 @@ File: hledger.info, Node: JOURNAL FORMAT, Next: CSV FORMAT, Prev: COMMANDS, hledger's default file format, representing a General Journal. hledger's usual data source is a plain text file containing journal -entries in hledger journal format. This file represents a standard -accounting general journal. I use file names ending in '.journal', but -that's not required. The journal file contains a number of transaction +entries in hledger journal format. This file represents a standard +accounting general journal. I use file names ending in `.journal', but +that's not required. The journal file contains a number of transaction entries, each describing a transfer of money (or any commodity) between two or more named accounts, in a simple format readable by both hledger and humans. hledger's journal format is a compatible subset, mostly, of ledger's journal format, so hledger can work with compatible ledger journal files -as well. It's safe, and encouraged, to run both hledger and ledger on +as well. It's safe, and encouraged, to run both hledger and ledger on the same journal file, eg to validate the results you're getting. You can use hledger without learning any more about this file; just use the add or web or import commands to create and update it. Many users, though, edit the journal file with a text editor, and -track changes with a version control system such as git. Editor addons +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. See Editor +formatting, tab completion, and useful commands. See Editor configuration at hledger.org for the full list. Here's a description of each part of the file format (and hledger's -data model). These are mostly in the order you'll use them, but in some +data model). These are mostly in the order you'll use them, but in some cases related concepts have been grouped together for easy reference, or linked before they are introduced, so feel free to skip over anything that looks unnecessary right now. @@ -4637,25 +5066,30 @@ File: hledger.info, Node: Transactions, Next: Dates, Up: JOURNAL FORMAT 12.1 Transactions ================= -Transactions are the main unit of information in a journal file. They +Transactions are the main unit of information in a journal file. They represent events, typically a movement of some quantity of commodities between two or more named accounts. Each transaction is recorded as a journal entry, beginning with a -simple date in column 0. This can be followed by any of the following +simple date in column 0. This can be followed by any of the following optional fields, separated by spaces: - * a status character (empty, '!', or '*') + * a status character (empty, `!', or `*') + * a code (any short number or text, enclosed in parentheses) + * a description (any remaining text until end of line or a semicolon) + * a comment (any remaining text following a semicolon until end of line, and any following indented lines beginning with a semicolon) + * 0 or more indented _posting_ lines, describing what was transferred - and the accounts involved (indented comment lines are also allowed, - but not blank lines or non-indented lines). + and the accounts involved (indented comment lines are also + allowed, but not blank lines or non-indented lines). Here's a simple journal file containing one transaction: + 2008/01/01 income assets:bank:checking $1 income:salary $-1 @@ -4678,12 +5112,12 @@ File: hledger.info, Node: Simple dates, Next: Secondary dates, Up: Dates 12.2.1 Simple dates ------------------- -Dates in the journal file use _simple dates_ format: 'YYYY-MM-DD' or -'YYYY/MM/DD' or 'YYYY.MM.DD', with leading zeros optional. The year may +Dates in the journal file use _simple dates_ format: `YYYY-MM-DD' or +`YYYY/MM/DD' or `YYYY.MM.DD', with leading zeros optional. The year may be omitted, in which case it will be inferred from the context: the -current transaction, the default year set with a default year directive, -or the current date when the command is run. Some examples: -'2010-01-31', '2010/01/31', '2010.1.31', '1/31'. +current transaction, the default year set with a default year +directive, or the current date when the command is run. Some examples: +`2010-01-31', `2010/01/31', `2010.1.31', `1/31'. (The UI also accepts simple dates, as well as the more flexible smart dates documented in the hledger manual.) @@ -4695,32 +5129,35 @@ File: hledger.info, Node: Secondary dates, Next: Posting dates, Prev: Simple ---------------------- Real-life transactions sometimes involve more than one date - eg the -date you write a cheque, and the date it clears in your bank. When you +date you write a cheque, and the date it clears in your bank. When you want to model this, for more accurate daily balances, you can specify individual posting dates. Or, you can use the older _secondary date_ feature (Ledger calls it -auxiliary date or effective date). Note: we support this for +auxiliary date or effective date). Note: we support this for compatibility, but I usually recommend avoiding this feature; posting dates are almost always clearer and simpler. A secondary date is written after the primary date, following an -equals sign. If the year is omitted, the primary date's year is -assumed. When running reports, the primary (left) date is used by -default, but with the '--date2' flag (or '--aux-date' or '--effective'), +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 (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 = +a consistent rule. Eg "primary = the bank's clearing date, secondary = date the transaction was initiated, if different", as shown here: + 2010/2/23=2/19 movie ticket expenses:cinema $10 assets:checking + $ hledger register checking 2010-02-23 movie ticket assets:checking $-10 $-10 + $ hledger register checking --date2 2010-02-19 movie ticket assets:checking $-10 $-10 @@ -4732,31 +5169,34 @@ File: hledger.info, Node: Posting dates, Prev: Secondary dates, Up: Dates You can give individual postings a different date from their parent transaction, by adding a posting comment containing a tag (see below) -like 'date:DATE'. This is probably the best way to control posting -dates precisely. Eg in this example the expense should appear in May +like `date:DATE'. This is probably the best way to control posting +dates precisely. Eg in this example the expense should appear in May reports, and the deduction from checking should be reported on 6/1 for easy bank reconciliation: + 2015/5/30 expenses:food $10 ; food purchased on saturday 5/30 assets:checking ; bank cleared it on monday, date:6/1 + $ hledger -f t.j register food 2015-05-30 expenses:food $10 $10 + $ hledger -f t.j register checking 2015-06-01 assets:checking $-10 $-10 DATE should be a simple date; if the year is not specified it will -use the year of the transaction's date. You can set the secondary date -similarly, with 'date2:DATE2'. The 'date:' or 'date2:' tags must have a -valid simple date value if they are present, eg a 'date:' tag with no +use the year of the transaction's date. You can set the secondary date +similarly, with `date2:DATE2'. The `date:' or `date2:' tags must have a +valid simple date value if they are present, eg a `date:' tag with no value is not allowed. Ledger's earlier, more compact bracketed date syntax is also -supported: '[DATE]', '[DATE=DATE2]' or '[=DATE2]'. hledger will attempt -to parse any square-bracketed sequence of the '0123456789/-.=' -characters in this way. With this syntax, DATE infers its year from the +supported: `[DATE]', `[DATE=DATE2]' or `[=DATE2]'. hledger will attempt +to parse any square-bracketed sequence of the `0123456789/-.=' +characters in this way. With this syntax, DATE infers its year from the transaction and DATE2 infers its year from DATE.  @@ -4771,43 +5211,42 @@ description or posting account name, separated from it by a space, indicating one of three statuses: mark status - ------------------ +----------------- unmarked -'!' pending -'*' cleared +`!' pending +`*' cleared - When reporting, you can filter by status with the '-U/--unmarked', -'-P/--pending', and '-C/--cleared' flags; or the 'status:', 'status:!', -and 'status:*' queries; or the U, P, C keys in hledger-ui. + When reporting, you can filter by status with the `-U/--unmarked', +`-P/--pending', and `-C/--cleared' flags; or the `status:', `status:!', +and `status:*' queries; or the U, P, C keys in hledger-ui. Note, in Ledger and in older versions of hledger, the "unmarked" -state is called "uncleared". As of hledger 1.3 we have renamed it to +state is called "uncleared". As of hledger 1.3 we have renamed it to unmarked for clarity. To replicate Ledger and old hledger's behaviour of also matching pending, combine -U and -P. Status marks are optional, but can be helpful eg for reconciling with -real-world accounts. Some editor modes provide highlighting and -shortcuts for working with status. Eg in Emacs ledger-mode, you can +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. What "uncleared", "pending", and "cleared" actually mean is up to you. Here's one suggestion: status meaning --------------------------------------------------------------------------- +-------------------------------------------------------------------------- uncleared recorded but not yet reconciled; needs review pending tentatively reconciled (if needed, eg during a big reconciliation) cleared complete, reconciled as far as possible, and considered correct - With this scheme, you would use '-PC' to see the current balance at -your bank, '-U' to see things which will probably hit your bank soon -(like uncashed checks), and no flags to see the most up-to-date state of -your finances. + With this scheme, you would use `-PC' to see the current balance at +your bank, `-U' to see things which will probably hit your bank soon +(like uncashed checks), and no flags to see the most up-to-date state +of your finances.  File: hledger.info, Node: Code, Next: Description, Prev: Status, Up: JOURNAL FORMAT @@ -4816,7 +5255,7 @@ File: hledger.info, Node: Code, Next: Description, Prev: Status, Up: JOURNAL ========= After the status mark, but before the description, you can optionally -write a transaction "code", enclosed in parentheses. This is a good +write a transaction "code", enclosed in parentheses. This is a good place to record a check number, or some other important transaction id or reference number. @@ -4827,9 +5266,9 @@ File: hledger.info, Node: Description, Next: Comments, Prev: Code, Up: JOURN ================ A transaction's description is the rest of the line following the date -and status mark (or until a comment begins). Sometimes called the +and status mark (or until a comment begins). Sometimes called the "narration" in traditional bookkeeping, it can be used for whatever you -wish, or left blank. Transaction descriptions can be queried, unlike +wish, or left blank. Transaction descriptions can be queried, unlike comments. * Menu: @@ -4842,11 +5281,11 @@ File: hledger.info, Node: Payee and note, Up: Description 12.5.1 Payee and note --------------------- -You can optionally include a '|' (pipe) character in descriptions to +You can optionally include a `|' (pipe) character in descriptions to subdivide the description into separate fields for payee/payer name on -the left (up to the first '|') and an additional note field on the right -(after the first '|'). This may be worthwhile if you need to do more -precise querying and pivoting by payee or by note. +the left (up to the first `|') and an additional note field on the +right (after the first `|'). This may be worthwhile if you need to do +more precise querying and pivoting by payee or by note.  File: hledger.info, Node: Comments, Next: Tags, Prev: Description, Up: JOURNAL FORMAT @@ -4854,19 +5293,20 @@ File: hledger.info, Node: Comments, Next: Tags, Prev: Description, Up: JOURN 12.6 Comments ============= -Lines in the journal beginning with a semicolon (';') or hash ('#') or -star ('*') are comments, and will be ignored. (Star comments cause +Lines in the journal beginning with a semicolon (`;') or hash (`#') or +star (`*') are comments, and will be ignored. (Star comments cause org-mode nodes to be ignored, allowing emacs users to fold and navigate their journals with org-mode or orgstruct-mode.) You can attach comments to a transaction by writing them after the description and/or indented on the following lines (before the -postings). Similarly, you can attach comments to an individual posting +postings). Similarly, you can attach comments to an individual posting by writing them after the amount and/or indented on the following lines. -Transaction and posting comments must begin with a semicolon (';'). +Transaction and posting comments must begin with a semicolon (`;'). Some examples: + # a file comment ; another file comment * also a file comment, useful in org/orgstruct mode @@ -4885,8 +5325,8 @@ end comment ; another comment line for posting 2 ; a file comment (because not indented) - You can also comment larger regions of a file using 'comment' and -'end comment' directives. + You can also comment larger regions of a file using `comment' and +`end comment' directives.  File: hledger.info, Node: Tags, Next: Postings, Prev: Comments, Up: JOURNAL FORMAT @@ -4900,29 +5340,35 @@ transactions, which you can then search or pivot on. A simple tag is a word (which may contain hyphens) followed by a full colon, written inside a transaction or posting comment line: + 2017/1/16 bought groceries ; sometag: Tags can have a value, which is the text after the colon, up to the next comma or end of line, with leading/trailing whitespace removed: + expenses:food $10 ; a-posting-tag: the tag value Note this means hledger's tag values can not contain commas or newlines. Ending at commas means you can write multiple short tags on one line, comma separated: + assets:checking ; a comment containing tag1:, tag2: some value ... Here, - * "'a comment containing'" is just comment text, not a tag - * "'tag1'" is a tag with no value - * "'tag2'" is another tag, whose value is "'some value ...'" + * "`a comment containing'" is just comment text, not a tag + + * "`tag1'" is a tag with no value + + * "`tag2'" is another tag, whose value is "`some value ...'" Tags in a transaction comment affect the transaction and all of its -postings, while tags in a posting comment affect only that posting. For -example, the following transaction has three tags ('A', 'TAG2', -'third-tag') and the posting has four (those plus 'posting-tag'): +postings, while tags in a posting comment affect only that posting. For +example, the following transaction has three tags (`A', `TAG2', +`third-tag') and the posting has four (those plus `posting-tag'): + 1/1 a transaction ; A:, TAG2: ; third-tag: a third transaction tag, <- with a value @@ -4938,25 +5384,27 @@ File: hledger.info, Node: Postings, Next: Account names, Prev: Tags, Up: JOU ============= A posting is an addition of some amount to, or removal of some amount -from, an account. Each posting line begins with at least one space or +from, an account. Each posting line begins with at least one space or tab (2 or 4 spaces is common), followed by: - * (optional) a status character (empty, '!', or '*'), followed by a + * (optional) a status character (empty, `!', or `*'), followed by a space - * (required) an account name (any text, optionally containing *single - spaces*, until end of line or a double space) + + * (required) an account name (any text, optionally containing + *single spaces*, until end of line or a double space) + * (optional) *two or more spaces* or tabs followed by an amount. Positive amounts are being added to the account, negative amounts are being removed. - The amounts within a transaction must always sum up to zero. As a + 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. 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 +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. * Menu: @@ -4974,17 +5422,19 @@ posting_ or _unbalanced posting_, which means it is exempt from the usual rule that a transaction's postings must balance add up to zero. This is not part of double entry accounting, so you might choose to -avoid this feature. Or you can use it sparingly for certain special -cases where it can be convenient. Eg, you could set opening balances +avoid this feature. Or you can use it sparingly for certain special +cases where it can be convenient. Eg, you could set opening balances without using a balancing equity account: + 1/1 opening balances (assets:checking) $1000 (assets:savings) $2000 - A posting with a bracketed account name is called a _balanced virtual -posting_. The balanced virtual postings in a transaction must add up to -zero (separately from other postings). Eg: + A posting with a bracketed account name is called a _balanced +virtual posting_. The balanced virtual postings in a transaction must +add up to zero (separately from other postings). Eg: + 1/1 buy food with cash, update budget envelope subaccounts, & something else assets:cash $-10 ; <- these balance @@ -4995,8 +5445,8 @@ zero (separately from other postings). Eg: (something:else) $5 ; <- not required to balance Ordinary non-parenthesised, non-bracketed postings are called _real -postings_. You can exclude virtual postings from reports with the -'-R/--real' flag or 'real:1' query. +postings_. You can exclude virtual postings from reports with the +`-R/--real' flag or `real:1' query.  File: hledger.info, Node: Account names, Next: Amounts, Prev: Postings, Up: JOURNAL FORMAT @@ -5005,13 +5455,12 @@ File: hledger.info, Node: Account names, Next: Amounts, Prev: Postings, Up: ================== Account names typically have several parts separated by a full colon, -from which hledger derives a hierarchical chart of accounts. They can -be anything you like, but in finance there are traditionally five -top-level accounts: 'assets', 'liabilities', 'revenue', 'expenses', and -'equity'. +from which hledger derives a hierarchical chart of accounts. They can be +anything you like, but in finance there are traditionally five top-level +accounts: `assets', `liabilities', `revenue', `expenses', and `equity'. - Account names may contain single spaces, eg: 'assets:accounts -receivable'. Because of this, they must always be followed by *two or + Account names may contain single spaces, eg: `assets:accounts +receivable'. Because of this, they must always be followed by *two or more spaces* (or newline). Account names can be aliased. @@ -5022,12 +5471,12 @@ File: hledger.info, Node: Amounts, Next: Transaction prices, Prev: Account na 12.10 Amounts ============= -After the account name, there is usually an amount. (Important: between +After the account name, there is usually an amount. (Important: between account name and amount, there must be *two or more spaces*.) hledger's amount format is flexible, supporting several international -formats. Here are some examples. Amounts have a number (the -"quantity"): +formats. Here are some examples. Amounts have a number (the "quantity"): + 1 @@ -5035,6 +5484,7 @@ formats. Here are some examples. Amounts have a number (the below), to the left or right of the quantity, with or without a separating space: + $1 4000 AAPL 3 "green apples" @@ -5043,17 +5493,20 @@ $1 is the default), The sign can be written before or after a left-side commodity symbol: + -$1 $-1 One or more spaces between the sign and the number are acceptable when parsing (but they won't be displayed in output): + + $1 $- 1 Scientific E notation is allowed: + 1E-6 EUR 1E3 @@ -5073,12 +5526,14 @@ File: hledger.info, Node: Decimal marks digit group marks, Next: Commodity, U A decimal mark can be written as a period or a comma: + 1.23 1,23456780000009 In the integer part of the quantity (left of the decimal mark), -groups of digits can optionally be separated by a "digit group mark" - a -space, comma, or period (different from the decimal mark): +groups of digits can optionally be separated by a "digit group mark" - +a space, comma, or period (different from the decimal mark): + $1,000,000.00 EUR 2.000.000,00 @@ -5086,16 +5541,17 @@ INR 9,99,99,999.00 1 000 000.9455 Note, a number containing a single digit group mark and no decimal -mark is ambiguous. Are these digit group marks or decimal marks ? +mark is ambiguous. Are these digit group marks or decimal marks ? + 1,000 1.000 If you don't tell it otherwise, hledger will assume both of the above -are decimal marks, parsing both numbers as 1. To prevent confusion and -undetected typos, we recommend adding 'commodity' directives at the top +are decimal marks, parsing both numbers as 1. To prevent confusion and +undetected typos, we recommend adding `commodity' directives at the top of your journal file to explicitly declare the decimal mark (and -optionally a digit group mark) for each commodity. Read on for more +optionally a digit group mark) for each commodity. Read on for more about this.  @@ -5109,20 +5565,20 @@ number, and a "commodity", which is a currency symbol, stock ticker, or any word or phrase describing something you are tracking. If the commodity name contains non-letters (spaces, numbers, or -punctuation), you must always write it inside double quotes ('"green -apples"', '"ABC123"'). +punctuation), you must always write it inside double quotes (`"green +apples"', `"ABC123"'). If you write just a bare number, that too will have a commodity, with -name '""'; we call that the "no-symbol commodity". +name `""'; we call that the "no-symbol commodity". Actually, hledger combines these single-commodity amounts into more powerful multi-commodity amounts, which are what it works with most of -the time. A multi-commodity amount could be, eg: '1 USD, 2 EUR, 3.456 -TSLA'. In practice, you will only see multi-commodity amounts in +the time. A multi-commodity amount could be, eg: `1 USD, 2 EUR, 3.456 +TSLA'. In practice, you will only see multi-commodity amounts in hledger's output; you can't write them directly in the journal file. (If you are writing scripts or working with hledger's internals, -these are the 'Amount' and 'MixedAmount' types.) +these are the `Amount' and `MixedAmount' types.)  File: hledger.info, Node: Commodity directives, Next: Commodity display style, Prev: Commodity, Up: Amounts @@ -5130,11 +5586,12 @@ File: hledger.info, Node: Commodity directives, Next: Commodity display style, 12.10.3 Commodity directives ---------------------------- -You can add 'commodity' directives to the journal, preferably at the +You can add `commodity' directives to the journal, preferably at the top, to declare your commodities and help with number parsing (see -above) and display (see below). These are optional, but recommended. +above) and display (see below). These are optional, but recommended. They are described in more detail in JOURNAL FORMAT -> Declaring -commodities. Here's a quick example: +commodities. Here's a quick example: + # number format and display style for $, EUR, INR and the no-symbol commodity: commodity $1,000.00 @@ -5149,13 +5606,13 @@ File: hledger.info, Node: Commodity display style, Next: Rounding, Prev: Comm ------------------------------- For the amounts in each commodity, hledger chooses a consistent display -style to use in most reports. (Exceptions: price amounts, and all -amounts displayed by the 'print' command, are displayed with all of +style to use in most reports. (Exceptions: price amounts, and all +amounts displayed by the `print' command, are displayed with all of their decimal digits visible.) A commodity's display style is inferred as follows. - First, if a default commodity is declared with 'D', this commodity + First, if a default commodity is declared with `D', this commodity and its style is applied to any no-symbol amounts in the journal. Then each commodity's style is inferred from one of the following, in @@ -5163,40 +5620,48 @@ order of preference: * The commodity directive for that commodity (including the no-symbol commodity), if any. + * The amounts in that commodity seen in the journal's transactions. (Posting amounts only; prices and periodic or auto rules are ignored, currently.) - * The built-in fallback style, which looks like this: '$1000.00'. + + * The built-in fallback style, which looks like this: `$1000.00'. (Symbol on the left, period decimal mark, two decimal places.) A style is inferred from journal amounts as follows: * Use the general style (decimal mark, symbol placement) of the first amount + * Use the first-seen digit group style (digit group mark, digit group sizes), if any + * Use the maximum number of decimal places of all. Transaction price amounts don't affect the commodity display style directly, but occasionally they can do so indirectly (eg when a -posting's amount is inferred using a transaction price). If you find +posting's amount is inferred using a transaction price). If you find this causing problems, use a commodity directive to fix the display style. To summarise: each commodity's amounts will be normalised to (a) the -style declared by a 'commodity' directive, or (b) the style of the first -posting amount in the journal, with the first-seen digit group style and -the maximum-seen number of decimal places. So if your reports are -showing amounts in a way you don't like, eg with too many decimal -places, use a commodity directive. Some examples: +style declared by a `commodity' directive, or (b) the style of the +first posting amount in the journal, with the first-seen digit group +style and the maximum-seen number of decimal places. So if your reports +are showing amounts in a way you don't like, eg with too many decimal +places, use a commodity directive. Some examples: -# declare euro, dollar, bitcoin and no-symbol commodities and set their + +# declare euro, dollar, bitcoin and no-symbol commodities and set their # input number formats and output display styles: commodity EUR 1.000, commodity $1000.00 commodity 1000.00000000 BTC commodity 1 000. + The inferred commodity style can be overridden by supplying a command +line option. +  File: hledger.info, Node: Rounding, Prev: Commodity display style, Up: Amounts @@ -5205,10 +5670,10 @@ File: hledger.info, Node: Rounding, Prev: Commodity display style, Up: Amount Amounts are stored internally as decimal numbers with up to 255 decimal places, and displayed with the number of decimal places specified by the -commodity display style. Note, hledger uses banker's rounding: it -rounds to the nearest even number, eg 0.5 displayed with zero decimal -places is "0"). (Guaranteed since hledger 1.17.1; in older versions -this could vary if hledger was built with Decimal < 0.5.1.) +commodity display style. Note, hledger uses banker's rounding: it rounds +to the nearest even number, eg 0.5 displayed with zero decimal places is +"0"). (Guaranteed since hledger 1.17.1; in older versions this could +vary if hledger was built with Decimal < 0.5.1.)  File: hledger.info, Node: Transaction prices, Next: Lot prices lot dates, Prev: Amounts, Up: JOURNAL FORMAT @@ -5217,22 +5682,24 @@ File: hledger.info, Node: Transaction prices, Next: Lot prices lot dates, Pre ======================== Within a transaction, you can note an amount's price in another -commodity. This can be used to document the cost (in a purchase) or -selling price (in a sale). For example, transaction prices are useful -to record purchases of a foreign currency. Note transaction prices are -fixed at the time of the transaction, and do not change over time. See +commodity. This can be used to document the cost (in a purchase) or +selling price (in a sale). For example, transaction prices are useful to +record purchases of a foreign currency. Note transaction prices are +fixed at the time of the transaction, and do not change over time. See also market prices, which represent prevailing exchange rates on a certain date. There are several ways to record a transaction price: - 1. Write the price per unit, as '@ UNITPRICE' after the amount: + 1. Write the price per unit, as `@ UNITPRICE' after the amount: + 2009/1/1 assets:euros €100 @ $1.35 ; one hundred euros purchased at $1.35 each assets:dollars ; balancing amount is -$135.00 - 2. Write the total price, as '@@ TOTALPRICE' after the amount: + 2. Write the total price, as `@@ TOTALPRICE' after the amount: + 2009/1/1 assets:euros €100 @@ $135 ; one hundred euros purchased at $135 for the lot @@ -5241,22 +5708,25 @@ certain date. 3. Specify amounts for all postings, using exactly two commodities, and let hledger infer the price that balances the transaction: + 2009/1/1 assets:euros €100 ; one hundred euros purchased assets:dollars $-135 ; for $135 - 4. Like 1, but the '@' is parenthesised, i.e. '(@)'; this is for + 4. Like 1, but the `@' is parenthesised, i.e. `(@)'; this is for compatibility with Ledger journals (Virtual posting costs), and is equivalent to 1 in hledger. - 5. Like 2, but as in 4 the '@@' is parenthesised, i.e. '(@@)'; in + 5. Like 2, but as in 4 the `@@' is parenthesised, i.e. `(@@)'; in hledger, this is equivalent to 2. - Use the '-B/--cost' flag to convert amounts to their transaction -price's commodity, if any. (mnemonic: "B" is from "cost Basis", as in -Ledger). Eg here is how -B affects the balance report for the example + + Use the `-B/--cost' flag to convert amounts to their transaction +price's commodity, if any. (mnemonic: "B" is from "cost Basis", as in +Ledger). Eg here is how -B affects the balance report for the example above: + $ hledger bal -N --flat $-135 assets:dollars €100 assets:euros @@ -5266,13 +5736,15 @@ $ hledger bal -N --flat -B Note -B is sensitive to the order of postings when a transaction price is inferred: the inferred price will be in the commodity of the -last amount. So if example 3's postings are reversed, while the +last amount. So if example 3's postings are reversed, while the transaction is equivalent, -B shows something different: + 2009/1/1 assets:dollars $-135 ; 135 dollars sold assets:euros €100 ; for 100 euros + $ hledger bal -N --flat -B €-100 assets:dollars # <- the dollars' selling price €100 assets:euros @@ -5284,13 +5756,13 @@ File: hledger.info, Node: Lot prices lot dates, Next: Balance assertions, Pre =========================== Ledger allows another kind of price, lot price (four variants: -'{UNITPRICE}', '{{TOTALPRICE}}', '{=FIXEDUNITPRICE}', -'{{=FIXEDTOTALPRICE}}'), and/or a lot date ('[DATE]') to be specified. +`{UNITPRICE}', `{{TOTALPRICE}}', `{=FIXEDUNITPRICE}', +`{{=FIXEDTOTALPRICE}}'), and/or a lot date (`[DATE]') to be specified. These are normally used to select a lot when selling investments. hledger will parse these, for compatibility with Ledger journals, but -currently ignores them. A transaction price, lot price and/or lot date -may appear in any order, after the posting amount and before the balance -assertion if any. +currently ignores them. A transaction price, lot price and/or lot date +may appear in any order, after the posting amount and before the +balance assertion if any.  File: hledger.info, Node: Balance assertions, Next: Balance assignments, Prev: Lot prices lot dates, Up: JOURNAL FORMAT @@ -5298,11 +5770,12 @@ File: hledger.info, Node: Balance assertions, Next: Balance assignments, Prev 12.13 Balance assertions ======================== -hledger supports Ledger-style balance assertions in journal files. -These look like, for example, '= EXPECTEDBALANCE' following a posting's -amount. Eg here we assert the expected dollar balance in accounts a and +hledger supports Ledger-style balance assertions in journal files. These +look like, for example, `= EXPECTEDBALANCE' following a posting's +amount. Eg here we assert the expected dollar balance in accounts a and b after each posting: + 2013/1/1 a $1 =$1 b =$-1 @@ -5312,12 +5785,12 @@ b after each posting: b $-1 =$-2 After reading a journal file, hledger will check all balance -assertions and report an error if any of them fail. Balance assertions +assertions and report an error if any of them fail. Balance assertions can protect you from, eg, inadvertently disrupting reconciled balances -while cleaning up old entries. You can disable them temporarily with -the '-I/--ignore-assertions' flag, which can be useful for -troubleshooting or for reading Ledger files. (Note: this flag currently -does not disable balance assignments, below). +while cleaning up old entries. You can disable them temporarily with the +`-I/--ignore-assertions' flag, which can be useful for troubleshooting +or for reading Ledger files. (Note: this flag currently does not +disable balance assignments, below). * Menu: @@ -5337,17 +5810,17 @@ File: hledger.info, Node: Assertions and ordering, Next: Assertions and includ ------------------------------- hledger sorts an account's postings and assertions first by date and -then (for postings on the same day) by parse order. Note this is +then (for postings on the same day) by parse order. Note this is different from Ledger, which sorts assertions only by parse order. (Also, Ledger assertions do not see the accumulated effect of repeated postings 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 +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. +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.  File: hledger.info, Node: Assertions and included files, Next: Assertions and multiple -f options, Prev: Assertions and ordering, Up: Balance assertions @@ -5355,8 +5828,8 @@ File: hledger.info, Node: Assertions and included files, Next: Assertions and 12.13.2 Assertions and included files ------------------------------------- -With included files, things are a little more complicated. Including -preserves the ordering of postings and assertions. If you have multiple +With included files, things are a little more complicated. Including +preserves the ordering of postings and assertions. If you have multiple postings to an account on the same day, split across different files, and you also want to assert the account's balance on the same day, you'll have to put the assertion in the right file. @@ -5368,7 +5841,7 @@ File: hledger.info, Node: Assertions and multiple -f options, Next: Assertions ------------------------------------------ Balance assertions don't work well across files specified with multiple --f options. Use include or concatenate the files instead. +-f options. Use include or concatenate the files instead.  File: hledger.info, Node: Assertions and commodities, Next: Assertions and prices, Prev: Assertions and multiple -f options, Up: Balance assertions @@ -5378,17 +5851,18 @@ File: hledger.info, Node: Assertions and commodities, Next: Assertions and pri 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. +(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 -equals sign ('== EXPECTEDBALANCE'). This asserts that there are no +equals sign (`== EXPECTEDBALANCE'). This asserts that there are no other unasserted commodities in the account (or, that their balance is 0). + 2013/1/1 a $1 a 1€ @@ -5405,9 +5879,10 @@ other unasserted commodities in the account (or, that their balance is 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 +that has multiple commodities. One workaround is to isolate each commodity into its own subaccount: + 2013/1/1 a:usd $1 a:euro 1€ @@ -5427,13 +5902,14 @@ File: hledger.info, Node: Assertions and prices, Next: Assertions and subaccou Balance assertions ignore transaction prices, and should normally be written without one: + 2019/1/1 (a) $1 @ €1 = $1 We do allow prices to be written there, however, and print shows them, even though they don't affect whether the assertion passes or -fails. This is for backward compatibility (hledger's close command used -to generate balance assertions with prices), and because balance +fails. This is for backward compatibility (hledger's close command +used to generate balance assertions with prices), and because balance _assignments_ do use them (see below).  @@ -5442,11 +5918,12 @@ File: hledger.info, Node: Assertions and subaccounts, Next: Assertions and vir 12.13.6 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 assert the balance including subaccounts by writing '=*' or '==*', +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 equity:opening balances checking:a 5 @@ -5460,8 +5937,7 @@ File: hledger.info, Node: Assertions and virtual postings, Next: Assertions an --------------------------------------- Balance assertions are checked against all postings, both real and -virtual. They are not affected by the '--real/-R' flag or 'real:' -query. +virtual. They are not affected by the `--real/-R' flag or `real:' query.  File: hledger.info, Node: Assertions and precision, Prev: Assertions and virtual postings, Up: Balance assertions @@ -5470,8 +5946,8 @@ File: hledger.info, Node: Assertions and precision, Prev: Assertions and virtu -------------------------------- Balance assertions compare the exactly calculated amounts, which are not -always what is shown by reports. Eg a commodity directive may limit the -display precision, but this will not affect balance assertions. Balance +always what is shown by reports. Eg a commodity directive may limit the +display precision, but this will not affect balance assertions. Balance assertion failure messages show exact amounts.  @@ -5480,12 +5956,13 @@ File: hledger.info, Node: Balance assignments, Next: Directives, Prev: Balanc 12.14 Balance assignments ========================= -Ledger-style balance assignments are also supported. These are like +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 +assertion. This can be a convenience during data entry, eg when setting opening balances: + ; starting a new journal, set asset account balances 2016/1/1 opening balances assets:checking = $409.32 @@ -5495,6 +5972,7 @@ opening balances: or when adjusting a balance to reality: + ; no cash left; update balance, record any untracked spending as a generic expense 2016/1/15 assets:cash = $0 @@ -5503,7 +5981,7 @@ opening balances: 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 -assignment). Note that using balance assignments makes your journal a +assignment). Note that using balance assignments makes your journal a little less explicit; to know the exact amount posted, you have to run hledger or do the calculations yourself, instead of just reading it. @@ -5520,9 +5998,11 @@ File: hledger.info, Node: Balance assignments and prices, Up: Balance assignme A transaction price in a balance assignment will cause the calculated amount to have that price attached: + 2019/1/1 (a) = $1 @ €2 + $ hledger print --explicit 2019-01-01 (a) $1 @ €2 = $1 @ €2 @@ -5534,7 +6014,7 @@ File: hledger.info, Node: Directives, Next: Directives and multiple files, Pr ================ A directive is a line in the journal beginning with a special keyword, -that influences how the journal is processed. hledger's directives are +that influences how the journal is processed. hledger's directives are based on a subset of Ledger's, but there are many differences (and also some differences between hledger versions). @@ -5542,25 +6022,25 @@ some differences between hledger versions). so here is a table summarising the directives and their effects, with links to more detailed docs. -directiveend subdirectivespurpose can affect (as of +directiveend subdirectivespurpose can affect (as of directive 2018/06) ------------------------------------------------------------------------------ -'account' any document account names, all entries in - text declare account types & all files, before - display order or after -'alias' 'end rewrite account names following entries +----------------------------------------------------------------------------- +`account' any document account names, all entries in all + text declare account types & files, before or + display order after +`alias' `end rewrite account names following entries aliases' until end of current file or end directive -'apply 'end prepend a common parent to following entries +`apply `end prepend a common parent to following entries account' apply account names until end of account' current file or end directive -'comment''end ignore part of journal following entries +`comment'`end ignore part of journal following entries comment' until end of current file or end directive -'commodity' 'format'declare a commodity and its number notation: +`commodity' `format'declare a commodity and its number notation: number notation & display following entries style until end of current file; @@ -5568,11 +6048,10 @@ account' apply account names until end of amounts of that commodity in reports -'D' declare a commodity to be default - used for commodityless commodity: - amounts, and its number following - notation & display style commodityless - entries until end +`D' declare a commodity to be default commodity: + used for commodityless following + amounts, and its number commodityless + notation & display style entries until end of current file; number notation: following entries @@ -5583,39 +6062,39 @@ account' apply account names until end of amounts of that commodity in reports -'include' include entries/directives what the included +`include' include entries/directives what the included from another file directives affect -'payee' declare a payee name following entries +`payee' declare a payee name following entries until end of current file -'P' declare a market price for amounts of that - a commodity commodity in +`P' declare a market price for a amounts of that + commodity commodity in reports, when -V is used -'Y' declare a year for yearless following entries +`Y' declare a year for yearless following entries dates until end of current file -'=' declare an auto posting all entries in +`=' declare an auto posting all entries in rule, adding postings to parent/current/child other transactions files (but not - sibling files, - see #1212) + sibling files, see + #1212) And some definitions: subdirectiveoptional indented directive line immediately following a parent directive number how to interpret numbers when parsing journal entries (the -notationidentity of the decimal separator character). (Currently each +notationidentity of the decimal separator character). (Currently each commodity can have its own notation, even in the same file.) -displayhow to display amounts of a commodity in reports (symbol side -style and spacing, digit groups, decimal separator, decimal places) -directivewhich entries and (when there are multiple files) which files -scope are affected by a directive +displayhow to display amounts of a commodity in reports (symbol side and +style spacing, digit groups, decimal separator, decimal places) +directivewhich entries and (when there are multiple files) which files are +scope affected by a directive As you can see, directives vary in which journal entries and files they affect, and whether they are focussed on input (parsing) or output -(reports). Some directives have multiple effects. +(reports). Some directives have multiple effects.  File: hledger.info, Node: Directives and multiple files, Next: Comment blocks, Prev: Directives, Up: JOURNAL FORMAT @@ -5623,18 +6102,18 @@ File: hledger.info, Node: Directives and multiple files, Next: Comment blocks, 12.16 Directives and multiple files =================================== -If you use multiple '-f'/'--file' options, or the 'include' directive, -hledger will process multiple input files. But note that directives +If you use multiple `-f'/`--file' options, or the `include' directive, +hledger will process multiple input files. But note that directives which affect input (see above) typically last only until the end of the file in which they occur. This may seem inconvenient, but it's intentional; it makes reports -stable and deterministic, independent of the order of input. Otherwise +stable and deterministic, independent of the order of input. Otherwise you could see different numbers if you happened to write -f options in a different order, or if you moved includes around while cleaning up your files. - It can be surprising though; for example, it means that 'alias' + It can be surprising though; for example, it means that `alias' directives do not affect parent or sibling files (see below).  @@ -5643,9 +6122,9 @@ File: hledger.info, Node: Comment blocks, Next: Including other files, Prev: 12.17 Comment blocks ==================== -A line containing just 'comment' starts a commented region of the file, -and a line containing just 'end comment' (or the end of the current -file) ends it. See also comments. +A line containing just `comment' starts a commented region of the file, +and a line containing just `end comment' (or the end of the current +file) ends it. See also comments.  File: hledger.info, Node: Including other files, Next: Default year, Prev: Comment blocks, Up: JOURNAL FORMAT @@ -5656,6 +6135,7 @@ File: hledger.info, Node: Including other files, Next: Default year, Prev: Co You can pull in the content of additional files by writing an include directive, like this: + include FILEPATH Only journal files can include, and only journal, timeclock or @@ -5664,19 +6144,19 @@ timedot files can be included (not CSV files, currently). If the file path does not begin with a slash, it is relative to the current file's folder. - A tilde means home directory, eg: 'include ~/main.journal'. + A tilde means home directory, eg: `include ~/main.journal'. The path may contain glob patterns to match multiple files, eg: -'include *.journal'. +`include *.journal'. - There is limited support for recursive wildcards: '**/' (the slash is -required) matches 0 or more subdirectories. It's not super convenient + There is limited support for recursive wildcards: `**/' (the slash +is required) matches 0 or more subdirectories. It's not super convenient since you have to avoid include cycles and including directories, but -this can be done, eg: 'include */**/*.journal'. +this can be done, eg: `include */**/*.journal'. The path may also be prefixed to force a specific file format, overriding the file extension (as described in hledger.1 -> Input -files): 'include timedot:~/notes/2020*.md'. +files): `include timedot:~/notes/2020*.md'.  File: hledger.info, Node: Default year, Next: Declaring payees, Prev: Including other files, Up: JOURNAL FORMAT @@ -5685,9 +6165,10 @@ File: hledger.info, Node: Default year, Next: Declaring payees, Prev: Includi ================== You can set a default year to be used for subsequent dates which don't -specify a year. This is a line beginning with 'Y' followed by the year. +specify a year. This is a line beginning with `Y' followed by the year. Eg: + Y2009 ; set default year to 2009 12/15 ; equivalent to 2009/12/15 @@ -5710,10 +6191,11 @@ File: hledger.info, Node: Declaring payees, Next: Declaring commodities, Prev 12.20 Declaring payees ====================== -The 'payee' directive can be used to declare a limited set of payees -which may appear in transaction descriptions. The "payees" check will +The `payee' directive can be used to declare a limited set of payees +which may appear in transaction descriptions. The "payees" check will report an error if any transaction refers to a payee that has not been -declared. Eg: +declared. Eg: + payee Whole Foods @@ -5723,23 +6205,24 @@ File: hledger.info, Node: Declaring commodities, Next: Default commodity, Pre 12.21 Declaring commodities =========================== -You can use 'commodity' directives to declare your commodities. In fact -the 'commodity' directive performs several functions at once: +You can use `commodity' directives to declare your commodities. In fact +the `commodity' directive performs several functions at once: - 1. It declares commodities which may be used in the journal. This can - optionally be enforced, providing useful error checking. (Cf + 1. It declares commodities which may be used in the journal. This can + optionally be enforced, providing useful error checking. (Cf Commodity error checking) 2. It declares which decimal mark character (period or comma), to expect when parsing input - useful to disambiguate international - number formats in your data. Without this, hledger will parse both - '1,000' and '1.000' as 1. (Cf Amounts) + number formats in your data. Without this, hledger will parse both + `1,000' and `1.000' as 1. (Cf Amounts) 3. It declares how to render the commodity's amounts when displaying output - the decimal mark, any digit group marks, the number of - decimal places, symbol placement and so on. (Cf Commodity display + decimal places, symbol placement and so on. (Cf Commodity display style) + You will run into one of the problems solved by commodity directives sooner or later, so we recommend using them, for robust and predictable parsing and display. @@ -5747,18 +6230,20 @@ parsing and display. Generally you should put them at the top of your journal file (since for function 2, they affect only following amounts, cf #793). - A commodity directive is just the word 'commodity' followed by a + A commodity directive is just the word `commodity' followed by a sample amount, like this: + ;commodity SAMPLEAMOUNT commodity $1000.00 commodity 1,000.0000 AAAA ; optional same-line comment - It may also be written on multiple lines, and use the 'format' -subdirective, as in Ledger. Note in this case the commodity symbol + It may also be written on multiple lines, and use the `format' +subdirective, as in Ledger. Note in this case the commodity symbol appears twice; it must be the same in both places: + ;commodity SYMBOL ; format SAMPLEAMOUNT @@ -5777,6 +6262,7 @@ comma - followed by 0 or more decimal digits. A few more examples: + # number formats for $, EUR, INR and the no-symbol commodity: commodity $1,000.00 commodity EUR 1.000,00 @@ -5784,7 +6270,10 @@ commodity INR 9,99,99,999.0 commodity 1 000 000. Note hledger normally uses banker's rounding, so 0.5 displayed with -zero decimal digits is "0". (More at Commodity display style.) +zero decimal digits is "0". (More at Commodity display style.) + + Even in the presence of commodity directives, the commodity display +style can still be overridden by supplying a command line option. * Menu: @@ -5796,10 +6285,10 @@ File: hledger.info, Node: Commodity error checking, Up: Declaring commodities 12.21.1 Commodity error checking -------------------------------- -In strict mode, enabled with the '-s'/'--strict' flag, hledger will -report an error if a commodity symbol is used that has not been declared -by a 'commodity' directive. This works similarly to account error -checking, see the notes there for more details. +In strict mode, enabled with the `-s'/`--strict' flag, hledger will +report an error if a commodity symbol is used that has not been +declared by a `commodity' directive. This works similarly to account +error checking, see the notes there for more details.  File: hledger.info, Node: Default commodity, Next: Declaring market prices, Prev: Declaring commodities, Up: JOURNAL FORMAT @@ -5807,20 +6296,21 @@ File: hledger.info, Node: Default commodity, Next: Declaring market prices, P 12.22 Default commodity ======================= -The 'D' directive sets a default commodity, to be used for any +The `D' directive sets a default commodity, to be used for any subsequent commodityless amounts (ie, plain numbers) seen while parsing -the journal. This effect lasts until the next 'D' directive, or the end +the journal. This effect lasts until the next `D' directive, or the end of the journal. - For compatibility/historical reasons, 'D' also acts like a -'commodity' directive (setting the commodity's decimal mark for parsing + For compatibility/historical reasons, `D' also acts like a +`commodity' directive (setting the commodity's decimal mark for parsing and display style for output). - As with 'commodity', the amount must include a decimal mark (either -period or comma). If both 'commodity' and 'D' directives are used for -the same commodity, the 'commodity' style takes precedence. + As with `commodity', the amount must include a decimal mark (either +period or comma). If both `commodity' and `D' directives are used for +the same commodity, the `commodity' style takes precedence. + + The syntax is `D AMOUNT'. Eg: - The syntax is 'D AMOUNT'. Eg: ; commodity-less amounts should be treated as dollars ; (and displayed with the dollar sign on the left, thousands separators and two decimal places) @@ -5836,13 +6326,14 @@ File: hledger.info, Node: Declaring market prices, Next: Declaring accounts, 12.23 Declaring market prices ============================= -The 'P' directive declares a market price, which is an exchange rate -between two commodities on a certain date. (In Ledger, they are called -"historical prices".) These are often obtained from a stock exchange, +The `P' directive declares a market price, which is an exchange rate +between two commodities on a certain date. (In Ledger, they are called +"historical prices".) These are often obtained from a stock exchange, cryptocurrency exchange, or the foreign exchange market. The format is: + P DATE COMMODITY1SYMBOL COMMODITY2AMOUNT DATE is a simple date, COMMODITY1SYMBOL is the symbol of the @@ -5850,14 +6341,15 @@ commodity being priced, and COMMODITY2AMOUNT is the amount (symbol and quantity) of commodity 2 that one unit of commodity 1 is worth on this date. Examples: + # one euro was worth $1.35 from 2009-01-01 onward: P 2009-01-01 € $1.35 # and $1.40 from 2010-01-01 onward: P 2010-01-01 € $1.40 - The '-V', '-X' and '--value' flags use these market prices to show -amount values in another commodity. See Valuation. + The `-V', `-X' and `--value' flags use these market prices to show +amount values in another commodity. See Valuation.  File: hledger.info, Node: Declaring accounts, Next: Rewriting accounts, Prev: Declaring market prices, Up: JOURNAL FORMAT @@ -5865,27 +6357,33 @@ File: hledger.info, Node: Declaring accounts, Next: Rewriting accounts, Prev: 12.24 Declaring accounts ======================== -'account' directives can be used to declare accounts (ie, the places -that amounts are transferred from and to). Though not required, these +`account' directives can be used to declare accounts (ie, the places +that amounts are transferred from and to). Though not required, these declarations can provide several benefits: * They can document your intended chart of accounts, providing a reference. + * They can help hledger know your accounts' types (asset, liability, equity, revenue, expense), useful for reports like balancesheet and incomestatement. + * They control account display order in reports, allowing non-alphabetic sorting (eg Revenues to appear above Expenses). + * They can store extra information about accounts (account numbers, notes, etc.) + * They help with account name completion in the add command, hledger-iadd, hledger-web, ledger-mode etc. + * In strict mode, they restrict which accounts may be posted to by transactions, which helps detect typos. - The simplest form is just the word 'account' followed by a + The simplest form is just the word `account' followed by a hledger-style account name, eg this account directive declares the -'assets:bank:checking' account: +`assets:bank:checking' account: + account assets:bank:checking @@ -5904,24 +6402,27 @@ File: hledger.info, Node: Account error checking, Next: Account comments, Up: ------------------------------ By default, accounts come into existence when a transaction references -them by name. This is convenient, but it means hledger can't warn you -when you mis-spell an account name in the journal. Usually you'll find +them by name. This is convenient, but it means hledger can't warn you +when you mis-spell an account name in the journal. Usually you'll find the error later, as an extra account in balance reports, or an incorrect balance when reconciling. - In strict mode, enabled with the '-s'/'--strict' flag, hledger will + In strict mode, enabled with the `-s'/`--strict' flag, hledger will report an error if any transaction uses an account name that has not -been declared by an account directive. Some notes: +been declared by an account directive. Some notes: * The declaration is case-sensitive; transactions must use the correct account name capitalisation. + * The account directive's scope is "whole file and below" (see - directives). This means it affects all of the current file, and - any files it includes, but not parent or sibling files. The - position of account directives within the file does not matter, - though it's usual to put them at the top. - * Accounts can only be declared in 'journal' files (but will affect + directives). This means it affects all of the current file, and any + files it includes, but not parent or sibling files. The position of + account directives within the file does not matter, though it's + usual to put them at the top. + + * Accounts can only be declared in `journal' files (but will affect included files in other formats). + * It's currently not possible to declare "all possible subaccounts" with a wildcard; every account posted to must be declared. @@ -5935,10 +6436,12 @@ Comments, beginning with a semicolon, can be added: * on the same line, *after two or more spaces* (because ; is allowed in account names) + * on the next lines, indented An example of both: + account assets:bank:checking ; same-line comment, note 2+ spaces before ; ; next-line comment ; another with tag, acctno:12345 (not used yet) @@ -5954,11 +6457,13 @@ File: hledger.info, Node: Account subdirectives, Next: Account types, Prev: A We also allow (and ignore) Ledger-style indented subdirectives, just for compatibility.: + account assets:bank:checking format blah blah ; <- subdirective, ignored Here is the full syntax of account directives: + account ACCTNAME [ACCTTYPE] [;COMMENT] [;COMMENTS] [LEDGER-STYLE SUBDIRECTIVES, IGNORED] @@ -5972,23 +6477,21 @@ File: hledger.info, Node: Account types, Next: Account display order, Prev: A hledger recognises five main types of account, corresponding to the account classes in the accounting equation: - 'Asset', 'Liability', 'Equity', 'Revenue', 'Expense'. + `Asset', `Liability', `Equity', `Revenue', `Expense'. These account types are important for controlling which accounts appear in the balancesheet, balancesheetequity, incomestatement reports (and probably for other things in future). - Additionally, we recognise the 'Cash' type, which is also an 'Asset', -and which causes accounts to appear in the cashflow report. ("Cash" -here means liquid assets, eg bank balances but typically not investments -or receivables.) + Additionally, we recognise the `Cash' type, which is also an +`Asset', and which causes accounts to appear in the cashflow report. +("Cash" here means liquid assets, eg bank balances but typically not +investments or receivables.) * Menu: * Declaring account types:: * Auto-detected account types:: -* Interference from auto-detected account types:: -* Old account type syntax::  File: hledger.info, Node: Declaring account types, Next: Auto-detected account types, Up: Account types @@ -5996,13 +6499,15 @@ File: hledger.info, Node: Declaring account types, Next: Auto-detected account 12.24.4.1 Declaring account types ................................. -Generally, to make these reports work you should declare your top-level -accounts and their types, using account directives with 'type:' tags. +To make the balancesheet/balancesheetequity/cashflow/incomestatement +reports work, generally you should declare your top-level accounts, and +their types. For each top-level account, write an account directive, +with a `type:' tag. The tag's value can be any of `Asset', `Liability', +`Equity', `Revenue', `Expense', `Cash', or (for short) `A', `L', `E', +`R', `X', `C' (case insensitive). An account's type is inherited by its +subaccounts, unless they declare a different type. Here's an example, +declaring all six account types: - The tag's value should be one of: 'Asset', 'Liability', 'Equity', -'Revenue', 'Expense', 'Cash', 'A', 'L', 'E', 'R', 'X', 'C' (all case -insensitive). The type is inherited by all subaccounts except where -they override it. Here's a complete example: account assets ; type: Asset account assets:bank ; type: Cash @@ -6012,19 +6517,32 @@ account equity ; type: Equity account revenues ; type: Revenue account expenses ; type: Expense + There is also an older syntax, which is deprecated and will be +dropped soon (A, L, E, R or X separated from the account name by two or +more spaces): + + +account assets A +account liabilities L +account equity E +account revenues R +account expenses X +  -File: hledger.info, Node: Auto-detected account types, Next: Interference from auto-detected account types, Prev: Declaring account types, Up: Account types +File: hledger.info, Node: Auto-detected account types, Prev: Declaring account types, Up: Account types 12.24.4.2 Auto-detected account types ..................................... -If you happen to use common english top-level account names, you may not -need to declare account types, as they will be detected automatically -using the following rules: +hledger tries to find at least one top level account in each of the six +account types (Asset, Liability, Equity, Revenue, Expense, Cash). When +no accounts have been declared for a particular type, hledger tries to +auto-detect some accounts by name, using regular expressions: - If account's name matches this regular expression: | its type is: + + If account's name matches this case insensitive regular expression:| its type is: ------------------------------------------------------------------- | ------------ - ^assets?(:|$) | + ^assets?(:|$) | and does not contain regexp (investment|receivable|:A/R|:fixed) | Cash otherwise | Asset ^(debts?|liabilit(y|ies))(:|$) | Liability @@ -6032,44 +6550,35 @@ using the following rules: ^(income|revenue)s?(:|$) | Revenue ^expenses?(:|$) | Expense - Even so, explicit declarations may be a good idea, for clarity and -predictability. + For people using standard english account names, this feature helps +hledger's high-level reports work out of the box with minimal +configuration. - -File: hledger.info, Node: Interference from auto-detected account types, Next: Old account type syntax, Prev: Auto-detected account types, Up: Account types + If you use non-english account names, you should declare account +types to make these reports work. And more generally, declaring +accounts and types is usually a good idea, for increased clarity and +predictability (and for the other benefits of account directives: error +checking, display order, etc). -12.24.4.3 Interference from auto-detected account types -....................................................... + Notes: -If you assign any account type, it's a good idea to assign all of them, -to prevent any confusion from mixing declared and auto-detected types. -Although it's unlikely to happen in real life, here's an example: with -the following journal, 'balancesheetequity' shows "liabilities" in both -Liabilities and Equity sections. Declaring another account as -'type:Liability' would fix it: + * When any account is declared as some type, this disables + auto-detection for that particular type. -account liabilities ; type:Equity + * If you declare any account's type, it's a good idea to declare an + account for all six types, since a mix of declared and + auto-detected types can cause confusion. For example, here + liabilities is declared to be Equity, but would also be + auto-detected as Liability, since no Liability account is declared: -2020-01-01 - assets 1 - liabilities 1 - equity -2 - -File: hledger.info, Node: Old account type syntax, Prev: Interference from auto-detected account types, Up: Account types + account liabilities ; type:Equity -12.24.4.4 Old account type syntax -................................. + 2020-01-01 + assets 1 + liabilities 1 + equity -2 -In some hledger journals you might instead see this old syntax (the -letters ALERX, separated from the account name by two or more spaces); -this is deprecated and may be removed soon: - -account assets A -account liabilities L -account equity E -account revenues R -account expenses X  File: hledger.info, Node: Account display order, Prev: Account types, Up: Declaring accounts @@ -6079,9 +6588,10 @@ File: hledger.info, Node: Account display order, Prev: Account types, Up: Dec Account directives also set the order in which accounts are displayed, eg in reports, the hledger-ui accounts screen, and the hledger-web -sidebar. By default accounts are listed in alphabetical order. But if +sidebar. By default accounts are listed in alphabetical order. But if you have these account directives in the journal: + account assets account liabilities account equity @@ -6091,6 +6601,7 @@ account expenses you'll see those accounts displayed in declaration order, not alphabetically: + $ hledger accounts -1 assets liabilities @@ -6102,20 +6613,22 @@ expenses order. Note that sorting is done at each level of the account tree (within -each group of sibling accounts under the same parent). And currently, +each group of sibling accounts under the same parent). And currently, this directive: + account other:zoo - would influence the position of 'zoo' among 'other''s subaccounts, -but not the position of 'other' among the top-level accounts. This + would influence the position of `zoo' among `other''s subaccounts, +but not the position of `other' among the top-level accounts. This means: - * you will sometimes declare parent accounts (eg 'account other' + * you will sometimes declare parent accounts (eg `account other' above) that you don't intend to post to, just to customize their display order - * sibling accounts stay together (you couldn't display 'x:y' in - between 'a:b' and 'a:c'). + + * sibling accounts stay together (you couldn't display `x:y' in + between `a:b' and `a:c').  File: hledger.info, Node: Rewriting accounts, Next: Default parent account, Prev: Declaring accounts, Up: JOURNAL FORMAT @@ -6124,13 +6637,16 @@ File: hledger.info, Node: Rewriting accounts, Next: Default parent account, P ======================== You can define account alias rules which rewrite your account names, or -parts of them, before generating reports. This can be useful for: +parts of them, before generating reports. This can be useful for: * expanding shorthand account names to their full form, allowing easier data entry and a less verbose journal + * adapting old journals to your current chart of accounts + * experimenting with new account organisations, like a new hierarchy or combining two accounts into one + * customising reports Account aliases also rewrite account names in account directives. @@ -6153,20 +6669,22 @@ File: hledger.info, Node: Basic aliases, Next: Regex aliases, Up: Rewriting a 12.25.1 Basic aliases --------------------- -To set an account alias, use the 'alias' directive in your journal file. -This affects all subsequent journal entries in the current file or its -included files (but note: not sibling or parent files). The spaces +To set an account alias, use the `alias' directive in your journal +file. This affects all subsequent journal entries in the current file or +its included files (but note: not sibling or parent files). The spaces around the = are optional: + alias OLD = NEW - Or, you can use the '--alias 'OLD=NEW'' option on the command line. -This affects all entries. It's useful for trying out aliases + Or, you can use the `--alias 'OLD=NEW'' option on the command line. +This affects all entries. It's useful for trying out aliases interactively. - OLD and NEW are case sensitive full account names. hledger will + OLD and NEW are case sensitive full account names. hledger will replace any occurrence of the old account name with the new one. -Subaccounts are also affected. Eg: +Subaccounts are also affected. Eg: + alias checking = assets:bank:wells fargo:checking ; rewrites "checking" to "assets:bank:wells fargo:checking", or "checking:a" to "assets:bank:wells fargo:checking:a" @@ -6180,15 +6698,17 @@ File: hledger.info, Node: Regex aliases, Next: Combining aliases, Prev: Basic There is also a more powerful variant that uses a regular expression, indicated by the forward slashes: + alias /REGEX/ = REPLACEMENT - or '--alias '/REGEX/=REPLACEMENT''. + or `--alias '/REGEX/=REPLACEMENT''. - REGEX is a case-insensitive regular expression. Anywhere it matches + REGEX is a case-insensitive regular expression. Anywhere it matches inside an account name, the matched part will be replaced by REPLACEMENT. If REGEX contains parenthesised match groups, these can be referenced by the usual numeric backreferences in REPLACEMENT. Eg: + alias /^(.+):bank:([^:]+):(.*)/ = \1:\2 \3 ; rewrites "assets:bank:wells fargo:checking" to "assets:wells fargo checking" @@ -6206,31 +6726,34 @@ You can define as many aliases as you like, using journal directives and/or command line options. Recursive aliases - where an account name is rewritten by one alias, -then by another alias, and so on - are allowed. Each alias sees the +then by another alias, and so on - are allowed. Each alias sees the effect of previously applied aliases. In such cases it can be important to understand which aliases will be -applied and in which order. For (each account name in) each journal +applied and in which order. For (each account name in) each journal entry, we apply: - 1. 'alias' directives preceding the journal entry, most recently + 1. `alias' directives preceding the journal entry, most recently parsed first (ie, reading upward from the journal entry, bottom to top) - 2. '--alias' options, in the order they appeared on the command line + + 2. `--alias' options, in the order they appeared on the command line (left to right). In other words, for (an account name in) a given journal entry: * the nearest alias declaration before/above the entry is applied first + * the next alias before/above that will be be applied next, and so on + * aliases defined after/below the entry do not affect it. This gives nearby aliases precedence over distant ones, and helps provide semantic stability - aliases will keep working the same way independent of which files are being read and in which order. - In case of trouble, adding '--debug=6' to the command line will show + In case of trouble, adding `--debug=6' to the command line will show which aliases are being applied when.  @@ -6239,14 +6762,16 @@ File: hledger.info, Node: Aliases and multiple files, Next: end aliases, Prev 12.25.4 Aliases and multiple files ---------------------------------- -As explained at Directives and multiple files, 'alias' directives do not -affect parent or sibling files. Eg in this command, +As explained at Directives and multiple files, `alias' directives do +not affect parent or sibling files. Eg in this command, + hledger -f a.aliases -f b.journal account aliases defined in a.aliases will not affect b.journal. Including the aliases doesn't work either: + include a.aliases 2020-01-01 ; not affected by a.aliases @@ -6256,6 +6781,7 @@ include a.aliases This means that account aliases should usually be declared at the start of your top-most file, like this: + alias foo=Foo alias bar=Bar @@ -6268,12 +6794,13 @@ include c.journal ; also affected  File: hledger.info, Node: end aliases, Prev: Aliases and multiple files, Up: Rewriting accounts -12.25.5 'end aliases' +12.25.5 `end aliases' --------------------- -You can clear (forget) all currently defined aliases with the 'end +You can clear (forget) all currently defined aliases with the `end aliases' directive: + end aliases  @@ -6283,9 +6810,10 @@ File: hledger.info, Node: Default parent account, Next: Periodic transactions, ============================ You can specify a parent account which will be prepended to all accounts -within a section of the journal. Use the 'apply account' and 'end apply +within a section of the journal. Use the `apply account' and `end apply account' directives like so: + apply account home 2010/1/1 @@ -6296,12 +6824,14 @@ end apply account which is equivalent to: + 2010/01/01 home:food $10 home:cash $-10 - If 'end apply account' is omitted, the effect lasts to the end of the -file. Included files are also affected, eg: + If `end apply account' is omitted, the effect lasts to the end of +the file. Included files are also affected, eg: + apply account business include biz.journal @@ -6309,13 +6839,13 @@ end apply account apply account personal include personal.journal - Prior to hledger 1.0, legacy 'account' and 'end' spellings were also + Prior to hledger 1.0, legacy `account' and `end' spellings were also supported. - A default parent account also affects account directives. It does -not affect account names being entered via hledger add or hledger-web. -If account aliases are present, they are applied after the default -parent account. + A default parent account also affects account directives. It does not +affect account names being entered via hledger add or hledger-web. If +account aliases are present, they are applied after the default parent +account.  File: hledger.info, Node: Periodic transactions, Next: Auto postings, Prev: Default parent account, Up: JOURNAL FORMAT @@ -6323,7 +6853,7 @@ File: hledger.info, Node: Periodic transactions, Next: Auto postings, Prev: D 12.27 Periodic transactions =========================== -Periodic transaction rules describe transactions that recur. They allow +Periodic transaction rules describe transactions that recur. They allow hledger to generate temporary future transactions to help with forecasting, so you don't have to write out each one in the journal, and it's easy to try out different forecasts. @@ -6333,24 +6863,30 @@ read this whole section - or at least these tips: 1. Two spaces accidentally added or omitted will cause you trouble - read about this below. - 2. For troubleshooting, show the generated transactions with 'hledger - print --forecast tag:generated' or 'hledger register --forecast + + 2. For troubleshooting, show the generated transactions with `hledger + print --forecast tag:generated' or `hledger register --forecast tag:generated'. + 3. Forecasted transactions will begin only after the last non-forecasted transaction's date. + 4. Forecasted transactions will end 6 months from today, by default. See below for the exact start/end rules. - 5. period expressions can be tricky. Their documentation needs + + 5. period expressions can be tricky. Their documentation needs improvement, but is worth studying. + 6. Some period expressions with a repeating interval must begin on a - natural boundary of that interval. Eg in 'weekly from DATE', DATE - must be a monday. '~ weekly from 2019/10/1' (a tuesday) will give + natural boundary of that interval. Eg in `weekly from DATE', DATE + must be a monday. `~ weekly from 2019/10/1' (a tuesday) will give an error. + 7. Other period expressions with an interval are automatically - expanded to cover a whole number of that interval. (This is done + expanded to cover a whole number of that interval. (This is done to improve reports, but it also affects periodic transactions. - Yes, it's a bit inconsistent with the above.) Eg: '~ every 10th - day of month from 2020/01', which is equivalent to '~ every 10th + Yes, it's a bit inconsistent with the above.) Eg: `~ every 10th + day of month from 2020/01', which is equivalent to `~ every 10th day of month from 2020/01/01', will be adjusted to start on 2019/12/10. @@ -6371,19 +6907,20 @@ File: hledger.info, Node: Periodic rule syntax, Next: Two spaces between perio ---------------------------- A periodic transaction rule looks like a normal journal entry, with the -date replaced by a tilde ('~') followed by a period expression -(mnemonic: '~' looks like a recurring sine wave.): +date replaced by a tilde (`~') followed by a period expression +(mnemonic: `~' looks like a recurring sine wave.): + ~ monthly expenses:rent $2000 assets:bank:checking There is an additional constraint on the period expression: the start -date must fall on a natural boundary of the interval. Eg 'monthly from -2018/1/1' is valid, but 'monthly from 2018/1/15' is not. +date must fall on a natural boundary of the interval. Eg `monthly from +2018/1/1' is valid, but `monthly from 2018/1/15' is not. Partial or relative dates (M/D, D, tomorrow, last week) in the period -expression can work (useful or not). They will be relative to today's +expression can work (useful or not). They will be relative to today's date, unless a Y default year directive is in effect, in which case they will be relative to Y/1/1. @@ -6394,10 +6931,11 @@ File: hledger.info, Node: Two spaces between period expression and description! ------------------------------------------------------------- If the period expression is followed by a transaction description, these -must be separated by *two or more spaces*. This helps hledger know +must be separated by *two or more spaces*. This helps hledger know where the period expression ends, so that descriptions can not accidentally alter their meaning, as in this example: + ; 2 or more spaces needed here, so the period is not understood as "every 2 months in 2020" ; || ; vv @@ -6409,6 +6947,7 @@ accidentally alter their meaning, as in this example: * Do write two spaces between your period expression and your transaction description, if any. + * Don't accidentally write two spaces in the middle of your period expression. @@ -6418,45 +6957,74 @@ File: hledger.info, Node: Forecasting with periodic transactions, Next: Budget 12.27.3 Forecasting with periodic transactions ---------------------------------------------- -The '--forecast' flag activates any periodic transaction rules in the -journal. They will generate temporary recurring transactions, which are -not saved in the journal, but will appear in all reports (eg print). -This can be useful for estimating balances into the future, or -experimenting with different scenarios. Or, it can be used as a data -entry aid: describe recurring transactions, and every so often copy the -output of 'print --forecast' into the journal. +The `--forecast' flag activates any periodic transaction rules in the +journal. These will generate temporary additional transactions, usually +recurring and in the future, which will appear in all reports. +`hledger print --forecast' is a good way to see them. - These transactions will have an extra tag indicating which periodic -rule generated them: 'generated-transaction:~ PERIODICEXPR'. And a -similar, hidden tag (beginning with an underscore) which, because it's -never displayed by print, can be used to match transactions generated -"just now": '_generated-transaction:~ PERIODICEXPR'. + This can be useful for estimating balances into the future, perhaps +experimenting with different scenarios. - Periodic transactions are generated within some forecast period. By -default, this + It could also be useful for scripted data entry: you could describe +recurring transactions, and every so often copy the output of `print +--forecast' into the journal. - * begins on the later of - * the report start date if specified with -b/-p/date: - * the day after the latest normal (non-periodic) transaction in - the journal, or today if there are no normal transactions. + The generated transactions will have an extra tag, like +`generated-transaction:~ PERIODICEXPR', indicating which periodic rule +generated them. There is also a similar, hidden tag, named +`_generated-transaction:', which you can use to reliably match +transactions generated "just now" (rather than `print'ed in the past). - * ends on the report end date if specified with -e/-p/date:, or 6 - months (180 days) from today. + The forecast transactions are generated within a _forecast period_, +which is independent of the report period. (Forecast period sets the +bounds for generated transactions, report period controls which +transactions are reported.) The forecast period begins on: - This means that periodic transactions will begin only after the -latest recorded transaction. And a recorded transaction dated in the -future can prevent generation of periodic transactions. (You can avoid -that by writing the future transaction as a one-time periodic rule -instead - put tilde before the date, eg '~ YYYY-MM-DD ...'). + * the start date provided within `--forecast''s argument, if any - Or, you can set your own arbitrary "forecast period", which can -overlap recorded transactions, and need not be in the future, by -providing an option argument, like '--forecast=PERIODEXPR'. Note the -equals sign is required, a space won't work. PERIODEXPR is a period -expression, which can specify the start date, end date, or both, like in -a 'date:' query. (See also hledger.1 -> Report start & end date). Some -examples: '--forecast=202001-202004', '--forecast=jan-', -'--forecast=2020'. + * otherwise, the later of + * the report start date, if specified (with `-b'/`-p'/`date:') + + * the day after the latest ordinary transaction in the journal, + if any + + * otherwise today. + + It ends on: + + * the end date provided within `--forecast''s argument, if any + + * otherwise, the report end date, if specified (with + `-e'/`-p'/`date:') + + * otherwise 180 days (6 months) from today. + + Note, this means that ordinary transactions will suppress periodic +transactions, by default; the periodic transactions will not start until +after the last ordinary transaction. This is usually convenient, but you +can get around it in two ways: + + * If you need to record some transactions in the future, make them + periodic transactions (with a single occurrence, eg: `~ + YYYY-MM-DD') rather than ordinary transactions. That way they + won't suppress other periodic transactions. + + * Or give `--forecast' a period expression argument. A forecast + period specified this way can overlap ordinary transactions, and + need not be in the future. Some things to note: + + * You must use `=' between flag and argument; a space won't + work. + + * The period expression can specify the forecast period's start + date, end date, or both. See also Report start & end date. + + * The period expression should not specify a report interval. + (Each periodic transaction rule specifies its own interval.) + + + Some examples: `--forecast=202001-202004', `--forecast=jan-', +`--forecast=2021'.  File: hledger.info, Node: Budgeting with periodic transactions, Prev: Forecasting with periodic transactions, Up: Periodic transactions @@ -6464,12 +7032,12 @@ File: hledger.info, Node: Budgeting with periodic transactions, Prev: Forecast 12.27.4 Budgeting with periodic transactions -------------------------------------------- -With the '--budget' flag, currently supported by the balance command, +With the `--budget' flag, currently supported by the balance command, each periodic transaction rule declares recurring budget goals for the -specified accounts. Eg the first example above declares a goal of +specified accounts. Eg the first example above declares a goal of spending $2000 on rent (and also, a goal of depositing $2000 into -checking) every month. Goals and actual performance can then be -compared in budget reports. +checking) every month. Goals and actual performance can then be compared +in budget reports. See also: Budgeting and Forecasting. @@ -6481,40 +7049,46 @@ File: hledger.info, Node: Auto postings, Prev: Periodic transactions, Up: JOU "Automated postings" or "auto postings" are extra postings which get added automatically to transactions which match certain queries, defined -by "auto posting rules", when you use the '--auto' flag. +by "auto posting rules", when you use the `--auto' flag. An auto posting rule looks a bit like a transaction: + = QUERY ACCOUNT AMOUNT ... ACCOUNT [AMOUNT] - except the first line is an equals sign (mnemonic: '=' suggests + 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: - * a normal amount with a commodity symbol, eg '$2'. This will be - used as-is. - * a number, eg '2'. The commodity symbol (if any) from the matched + * a normal amount with a commodity symbol, eg `$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 + + * 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, + + * 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 +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 Some examples: + ; every time I buy food, schedule a dollar donation = expenses:food (liabilities:charity) $-1 @@ -6532,6 +7106,7 @@ query term below: expenses:gifts $20 assets:checking + $ hledger print --auto 2017-12-01 expenses:food $10 @@ -6558,8 +7133,8 @@ File: hledger.info, Node: Auto postings and multiple files, Next: Auto posting ---------------------------------------- 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'/'--file' are used - see #1212). +in any parent file or child file. Note, currently it will not affect +sibling files (when multiple `-f'/`--file' are used - see #1212).  File: hledger.info, Node: Auto postings and dates, Next: Auto postings and transaction balancing / inferred amounts / balance assertions, Prev: Auto postings and multiple files, Up: Auto postings @@ -6577,14 +7152,17 @@ File: hledger.info, Node: Auto postings and transaction balancing / inferred am 12.28.3 Auto postings and transaction balancing / inferred amounts / -------------------------------------------------------------------- -balance assertions Currently, auto postings are added: +balance assertions + + Currently, auto postings are added: * after missing amounts are inferred, and transactions are checked for balancedness, + * but before balance assertions are checked. 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 +after auto postings are added. This changed in hledger 1.12+; see #893 for background.  @@ -6595,18 +7173,20 @@ File: hledger.info, Node: Auto posting tags, Prev: Auto postings and transacti Automated postings will have some extra tags: - * 'generated-posting:= QUERY' - shows this was generated by an auto + * `generated-posting:= QUERY' - shows this was generated by an auto posting rule, and the query - * '_generated-posting:= QUERY' - a hidden tag, which does not appear - in hledger's output. This can be used to match postings generated + + * `_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 have these tags added: - * 'modified:' - this transaction was modified - * '_modified:' - a hidden tag not appearing in the comment; this + * `modified:' - this transaction was modified + + * `_modified:' - a hidden tag not appearing in the comment; this transaction was modified "just now".  @@ -6624,46 +7204,46 @@ transaction. (To learn about _writing_ CSV, see CSV output.) - We describe each CSV file's format with a corresponding _rules file_. -By default this is named like the CSV file with a '.rules' extension -added. Eg when reading 'FILE.csv', hledger also looks for -'FILE.csv.rules' in the same directory as 'FILE.csv'. You can specify a -different rules file with the '--rules-file' option. If a rules file is -not found, hledger will create a sample rules file, which you'll need to -adjust. + We describe each CSV file's format with a corresponding _rules +file_. By default this is named like the CSV file with a `.rules' +extension added. Eg when reading `FILE.csv', hledger also looks for +`FILE.csv.rules' in the same directory as `FILE.csv'. You can specify a +different rules file with the `--rules-file' option. If a rules file is +not found, hledger will create a sample rules file, which you'll need +to adjust. This file contains rules describing the CSV data (header line, fields layout, date format etc.), and how to construct hledger journal entries -(transactions) from it. Often there will also be a list of conditional -rules for categorising transactions based on their descriptions. Here's +(transactions) from it. Often there will also be a list of conditional +rules for categorising transactions based on their descriptions. Here's an overview of the CSV rules; these are described more fully below, after the examples: -*'skip'* skip one or more header lines or matched - CSV records -*'fields' list* name CSV fields, assign them to hledger +*`skip'* skip one or more header lines or matched CSV + records +*`fields' list* name CSV fields, assign them to hledger fields *field assignment* assign a value to one hledger field, with interpolation -*Field names* hledger field names, used in the fields - list and field assignments -*'separator'* a custom field separator -*'if' block* apply some rules to CSV records matched by +*Field names* hledger field names, used in the fields list + and field assignments +*`separator'* a custom field separator +*`if' block* apply some rules to CSV records matched by patterns -*'if' table* apply some rules to CSV records matched by +*`if' table* apply some rules to CSV records matched by patterns, alternate syntax -*'end'* skip the remaining CSV records -*'date-format'* how to parse dates in CSV records -*'decimal-mark'* the decimal mark used in CSV amounts, if +*`end'* skip the remaining CSV records +*`date-format'* how to parse dates in CSV records +*`decimal-mark'* the decimal mark used in CSV amounts, if ambiguous -*'newest-first'* disambiguate record order when there's only +*`newest-first'* disambiguate record order when there's only one date -*'include'* inline another CSV rules file -*'balance-type'* choose which type of balance assignments to +*`include'* inline another CSV rules file +*`balance-type'* choose which type of balance assignments to use - Note, for best error messages when reading CSV files, use a '.csv', -'.tsv' or '.ssv' file extension or file prefix - see File Extension + Note, for best error messages when reading CSV files, use a `.csv', +`.tsv' or `.ssv' file extension or file prefix - see File Extension below. There's an introductory Convert CSV files tutorial on hledger.org. @@ -6680,7 +7260,7 @@ File: hledger.info, Node: Examples, Next: CSV rules, Up: CSV FORMAT 13.1 Examples ============= -Here are some sample hledger CSV rules files. See also the full +Here are some sample hledger CSV rules files. See also the full collection at: https://github.com/simonmichael/hledger/tree/master/examples/csv @@ -6699,16 +7279,19 @@ File: hledger.info, Node: Basic, Next: Bank of Ireland, Up: Examples 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: +are. Here's a simple CSV file and a rules file for it: + Date, Description, Id, Amount 12/11/2019, Foo, 123, 10.23 + # basic.csv.rules skip 1 fields date, description, _, amount date-format %d/%m/%Y + $ hledger print -f basic.csv 2019-11-12 Foo expenses:unknown 10.23 @@ -6726,10 +7309,12 @@ 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 necessary but provides extra error checking: + Date,Details,Debit,Credit,Balance 07/12/2012,LODGMENT 529898,,10.0,131.21 07/12/2012,PAYMENT,5,,126 + # bankofireland-checking.csv.rules # skip the header line @@ -6756,6 +7341,7 @@ currency EUR # set the base account for all txns account1 assets:bank:boi:checking + $ hledger -f bankofireland-checking.csv print 2012-12-07 LODGMENT 529898 assets:bank:boi:checking EUR10.0 = EUR131.2 @@ -6776,13 +7362,15 @@ File: hledger.info, Node: Amazon, Next: Paypal, Prev: Bank of Ireland, Up: E ------------- Here we convert amazon.com order history, and use an if block to -generate a third posting if there's a fee. (In practice you'd probably +generate 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" "Jul 29, 2012","Payment","To","Foo.","Completed","$20.00","$0.00","16000000000000DGLNJPI1P9B8DKPVHL" "Jul 30, 2012","Payment","To","Adapteva, Inc.","Completed","$25.00","$1.00","17LA58JSKRD4HDGLNJPI1P9B8DKPVHL" + # amazon-orders.csv.rules # skip one header line @@ -6817,6 +7405,7 @@ if %fees [1-9] account3 expenses:fees amount3 %fees + $ hledger -f amazon-orders.csv print 2012-07-29 (16000000000000DGLNJPI1P9B8DKPVHL) To Foo. ; status:Completed assets:amazon @@ -6836,6 +7425,7 @@ File: hledger.info, Node: Paypal, Prev: Amazon, Up: Examples 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" "10/01/2019","03:46:20","PDT","Calm Radio","Subscription Payment","Completed","USD","-6.99","0.00","-6.99","simon@joyful.com","memberships@calmradio.com","60P57143A8206782E","MONTHLY - $1 for the first 2 Months: Me - Order 99309. Item total: $1.00 USD first 2 months, then $6.99 / Month","","I-R8YLY094FJYR","","-6.99","" "10/01/2019","03:46:20","PDT","","Bank Deposit to PP Account ","Pending","USD","6.99","0.00","6.99","","simon@joyful.com","0TU1544T080463733","","","60P57143A8206782E","","0.00","" @@ -6845,6 +7435,7 @@ Paypal-specific rules, and a second rules file included: "10/19/2019","03:02:12","PDT","","Bank Deposit to PP Account ","Pending","USD","2.00","0.00","2.00","","simon@joyful.com","3XJ107139A851061F","","","K9U43044RY432050M","","0.00","" "10/22/2019","05:07:06","PDT","Noble Benefactor","Subscription Payment","Completed","USD","10.00","-0.59","9.41","noble@bene.fac.tor","simon@joyful.com","6L8L1662YP1334033","Joyful Systems","","I-KC9VBGY2GWDB","","9.41","" + # paypal-custom.csv.rules # Tips: @@ -6927,6 +7518,7 @@ Bank Deposit to PP Account if Currency Conversion account2 equity:currency conversion + # common.rules if @@ -6950,6 +7542,7 @@ if Google account2 expenses:online:apps description google | music + $ 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@joyful.com, toemail:memberships@calmradio.com, time:03:46:20, type:Subscription Payment, status:Completed assets:online:paypal $-6.99 = $-6.99 @@ -6988,7 +7581,7 @@ File: hledger.info, Node: CSV rules, Next: Tips, Prev: Examples, Up: CSV FOR ============== The following kinds of rule can appear in the rules file, in any order. -Blank lines and lines beginning with '#' or ';' are ignored. +Blank lines and lines beginning with `#' or `;' are ignored. * Menu: @@ -7009,15 +7602,16 @@ Blank lines and lines beginning with '#' or ';' are ignored.  File: hledger.info, Node: skip, Next: fields list, Up: CSV rules -13.2.1 'skip' +13.2.1 `skip' ------------- + skip N - The word "skip" followed by a number (or no number, meaning 1) tells +The word "skip" followed by a number (or no number, meaning 1) tells hledger to ignore this many non-empty lines preceding the CSV data. -(Empty/blank lines are skipped automatically.) You'll need this -whenever your CSV data contains header lines. +(Empty/blank lines are skipped automatically.) You'll need this whenever +your CSV data contains header lines. It also has a second purpose: it can be used inside if blocks to ignore certain CSV records (described below). @@ -7025,43 +7619,51 @@ ignore certain CSV records (described below).  File: hledger.info, Node: fields list, Next: field assignment, Prev: skip, Up: CSV rules -13.2.2 'fields' list +13.2.2 `fields' list -------------------- + fields FIELDNAME1, FIELDNAME2, ... - A fields list (the word "fields" followed by comma-separated field +A fields list (the word "fields" followed by comma-separated field names) is the quick way to assign CSV field values to hledger fields. -(The other way is field assignments, see below.) A fields list does -does two things: +(The other way is field assignments, see below.) A fields list does does +two things: - 1. It names the CSV fields. This is optional, but can be convenient + 1. It names the CSV fields. This is optional, but can be convenient later for interpolating them. - 2. Whenever you use a standard hledger field name (defined below), the - CSV value is assigned to that part of the hledger transaction. + 2. Whenever you use a standard hledger field name (defined below), + the CSV value is assigned to that part of the hledger transaction. + Here's an example that says "use the 1st, 2nd and 4th fields as the transaction's date, description and amount; name the last two fields for later reference; and ignore the others": + fields date, description, , amount, , , somefield, anotherfield Tips: * The fields list always use commas, even if your CSV data uses another separator character. + * Currently there must be least two items in the list (at least one comma). - * Field names may not contain spaces. Spaces before/after field + + * Field names may not contain spaces. Spaces before/after field names are optional. + * If the CSV contains column headings, it's a good idea to use these, suitably modified, as the basis for your field names (eg lower-cased, with underscores instead of spaces). + * If some heading names match standard hledger fields, but you don't want to set the hledger fields directly, alter those names, eg by appending an underscore. - * Fields you don't care about can be given a dummy name (eg: '_' ), + + * Fields you don't care about can be given a dummy name (eg: `_' ), or no name.  @@ -7070,21 +7672,23 @@ File: hledger.info, Node: field assignment, Next: Field names, Prev: fields l 13.2.3 field assignment ----------------------- + HLEDGERFIELDNAME FIELDVALUE - Field assignments are the more flexible way to assign CSV values to -hledger fields. They can be used instead of or in addition to a fields +Field assignments are the more flexible way to assign CSV values to +hledger fields. They can be used instead of or in addition to a fields list (see above). To assign a value to a hledger field, write the field name (any of the standard hledger field/pseudo-field names, defined below), a space, -followed by a text value on the same line. This text value may +followed by a text value on the same line. This text value may interpolate CSV fields, referenced by their 1-based position in the CSV -record ('%N'), or by the name they were given in the fields list -('%CSVFIELDNAME'). +record (`%N'), or by the name they were given in the fields list +(`%CSVFIELDNAME'). Some examples: + # set the amount to the 4th CSV field, with " USD" appended amount %4 USD @@ -7093,9 +7697,11 @@ comment note: %somefield - %anotherfield, date: %1 Tips: - * Interpolation strips outer whitespace (so a CSV value like '" 1 "' - becomes '1' when interpolated) (#1051). - * See also Tips below. + * Interpolation strips outer whitespace (so a CSV value like `" 1 "' + becomes `1' when interpolated) (#1051). + + * Interpolations always refer to a CSV field - you can't interpolate + a hledger field. (See Referencing other fields below).  File: hledger.info, Node: Field names, Next: separator, Prev: field assignment, Up: CSV rules @@ -7104,7 +7710,7 @@ File: hledger.info, Node: Field names, Next: separator, Prev: field assignmen ------------------ Here are the standard hledger field (and pseudo-field) names, which you -can use in a fields list and in field assignments. For more about the +can use in a fields list and in field assignments. For more about the transaction parts they refer to, see Transactions. * Menu: @@ -7126,7 +7732,7 @@ File: hledger.info, Node: date field, Next: date2 field, Up: Field names 13.2.4.1 date field ................... -Assigning to 'date' sets the transaction date. +Assigning to `date' sets the transaction date.  File: hledger.info, Node: date2 field, Next: status field, Prev: date field, Up: Field names @@ -7134,7 +7740,7 @@ File: hledger.info, Node: date2 field, Next: status field, Prev: date field, 13.2.4.2 date2 field .................... -'date2' sets the transaction's secondary date, if any. +`date2' sets the transaction's secondary date, if any.  File: hledger.info, Node: status field, Next: code field, Prev: date2 field, Up: Field names @@ -7142,7 +7748,7 @@ File: hledger.info, Node: status field, Next: code field, Prev: date2 field, 13.2.4.3 status field ..................... -'status' sets the transaction's status, if any. +`status' sets the transaction's status, if any.  File: hledger.info, Node: code field, Next: description field, Prev: status field, Up: Field names @@ -7150,7 +7756,7 @@ File: hledger.info, Node: code field, Next: description field, Prev: status f 13.2.4.4 code field ................... -'code' sets the transaction's code, if any. +`code' sets the transaction's code, if any.  File: hledger.info, Node: description field, Next: comment field, Prev: code field, Up: Field names @@ -7158,7 +7764,7 @@ File: hledger.info, Node: description field, Next: comment field, Prev: code 13.2.4.5 description field .......................... -'description' sets the transaction's description, if any. +`description' sets the transaction's description, if any.  File: hledger.info, Node: comment field, Next: account field, Prev: description field, Up: Field names @@ -7166,11 +7772,11 @@ File: hledger.info, Node: comment field, Next: account field, Prev: descripti 13.2.4.6 comment field ...................... -'comment' sets the transaction's comment, if any. +`comment' sets the transaction's comment, if any. - 'commentN', where N is a number, sets the Nth posting's comment. + `commentN', where N is a number, sets the Nth posting's comment. - Tips: - Only single-line comments can be assigned. - Comments can + Tips: - Only single-line comments can be assigned. - Comments can contain tags, as usual.  @@ -7179,12 +7785,12 @@ File: hledger.info, Node: account field, Next: amount field, Prev: comment fi 13.2.4.7 account field ...................... -Assigning to 'accountN', where N is 1 to 99, sets the account name of +Assigning to `accountN', where N is 1 to 99, sets the account name of the Nth posting, and causes that posting to be generated. - Most often there are two postings, so you'll want to set 'account1' -and 'account2'. Typically 'account1' is associated with the CSV file, -and is set once with a top-level assignment, while 'account2' is set + Most often there are two postings, so you'll want to set `account1' +and `account2'. Typically `account1' is associated with the CSV file, +and is set once with a top-level assignment, while `account2' is set based on each transaction's description, and in conditional blocks. If a posting's account name is left unset but its amount is set (see @@ -7197,29 +7803,29 @@ File: hledger.info, Node: amount field, Next: currency field, Prev: account f 13.2.4.8 amount field ..................... -'amountN' sets the amount of the Nth posting, and causes that posting to -be generated. By assigning to 'amount1', 'amount2', ... etc. you can +`amountN' sets the amount of the Nth posting, and causes that posting +to be generated. By assigning to `amount1', `amount2', ... etc. you can generate up to 99 postings. - 'amountN-in' and 'amountN-out' can be used instead, if the CSV uses + `amountN-in' and `amountN-out' can be used instead, if the CSV uses separate fields for debits and credits (inflows and outflows). hledger assumes both of these CSV fields are unsigned, and will automatically -negate the "-out" value. If they are signed, see "Setting amounts" +negate the "-out" value. If they are signed, see "Setting amounts" below. - 'amount', or 'amount-in' and 'amount-out' are a legacy mode, to keep + `amount', or `amount-in' and `amount-out' are a legacy mode, to keep pre-hledger-1.17 CSV rules files working (and for occasional -convenience). They are suitable only for two-posting transactions; they -set both posting 1's and posting 2's amount. Posting 2's amount will be +convenience). They are suitable only for two-posting transactions; they +set both posting 1's and posting 2's amount. Posting 2's amount will be negated, and also converted to cost if there's a transaction price. If you have an existing rules file using the unnumbered form, you might want to use the numbered form in certain conditional blocks, -without having to update and retest all the old rules. To facilitate -this, posting 1 ignores 'amount'/'amount-in'/'amount-out' if any of -'amount1'/'amount1-in'/'amount1-out' are assigned, and posting 2 ignores -them if any of 'amount2'/'amount2-in'/'amount2-out' are assigned, -avoiding conflicts. +without having to update and retest all the old rules. To facilitate +this, posting 1 ignores `amount'/`amount-in'/`amount-out' if any of +`amount1'/`amount1-in'/`amount1-out' are assigned, and posting 2 +ignores them if any of `amount2'/`amount2-in'/`amount2-out' are +assigned, avoiding conflicts.  File: hledger.info, Node: currency field, Next: balance field, Prev: amount field, Up: Field names @@ -7227,11 +7833,11 @@ File: hledger.info, Node: currency field, Next: balance field, Prev: amount f 13.2.4.9 currency field ....................... -'currency' sets a currency symbol, to be prepended to all postings' -amounts. You can use this if the CSV amounts do not have a currency +`currency' sets a currency symbol, to be prepended to all postings' +amounts. You can use this if the CSV amounts do not have a currency symbol, eg if it is in a separate column. - 'currencyN' prepends a currency symbol to just the Nth posting's + `currencyN' prepends a currency symbol to just the Nth posting's amount.  @@ -7240,48 +7846,52 @@ File: hledger.info, Node: balance field, Prev: currency field, Up: Field name 13.2.4.10 balance field ....................... -'balanceN' sets a balance assertion amount (or if the posting amount is +`balanceN' sets a balance assertion amount (or if the posting amount is left empty, a balance assignment) on posting N. - 'balance' is a compatibility spelling for hledger <1.17; it is -equivalent to 'balance1'. + `balance' is a compatibility spelling for hledger <1.17; it is +equivalent to `balance1'. You can adjust the type of assertion/assignment with the -'balance-type' rule (see below). +`balance-type' rule (see below). See Tips below for more about setting amounts and currency.  File: hledger.info, Node: separator, Next: if block, Prev: Field names, Up: CSV rules -13.2.5 'separator' +13.2.5 `separator' ------------------ -You can use the 'separator' rule to read other kinds of -character-separated data. The argument is any single separator -character, or the words 'tab' or 'space' (case insensitive). Eg, for +You can use the `separator' rule to read other kinds of +character-separated data. The argument is any single separator +character, or the words `tab' or `space' (case insensitive). Eg, for comma-separated values (CSV): + separator , or for semicolon-separated values (SSV): + separator ; or for tab-separated values (TSV): + separator TAB - If the input file has a '.csv', '.ssv' or '.tsv' file extension (or a -'csv:', 'ssv:', 'tsv:' prefix), the appropriate separator will be + If the input file has a `.csv', `.ssv' or `.tsv' file extension (or +a `csv:', `ssv:', `tsv:' prefix), the appropriate separator will be inferred automatically, and you won't need this rule.  File: hledger.info, Node: if block, Next: if table, Prev: separator, Up: CSV rules -13.2.6 'if' block +13.2.6 `if' block ----------------- + if MATCHER RULE @@ -7292,10 +7902,9 @@ MATCHER RULE RULE - Conditional blocks ("if blocks") are a block of rules that are -applied only to CSV records which match certain patterns. They are -often used for customising account names based on transaction -descriptions. +Conditional blocks ("if blocks") are a block of rules that are applied +only to CSV records which match certain patterns. They are often used +for customising account names based on transaction descriptions. * Menu: @@ -7312,20 +7921,21 @@ File: hledger.info, Node: Matching the whole record, Next: Matching individual Each MATCHER can be a record matcher, which looks like this: + REGEX REGEX is a case-insensitive regular expression that tries to match -anywhere within the CSV record. It is a POSIX ERE (extended regular -expression) that also supports GNU word boundaries ('\b', '\B', '\<', -'\>'), and nothing else. If you have trouble, be sure to check our doc: +anywhere within the CSV record. It is a POSIX ERE (extended regular +expression) that also supports GNU word boundaries (`\b', `\B', `\<', +`\>'), and nothing else. If you have trouble, be sure to check our doc: https://hledger.org/hledger.html#regular-expressions Important note: the record that is matched is not the original record, but a synthetic one, with any enclosing double quotes (but not enclosing whitespace) removed, and always comma-separated (which means -that a field containing a comma will appear like two fields). Eg, if -the original record is '2020-01-01; "Acme, Inc."; 1,000', the REGEX will -actually see '2020-01-01,Acme, Inc., 1,000'). +that a field containing a comma will appear like two fields). Eg, if the +original record is `2020-01-01; "Acme, Inc."; 1,000', the REGEX will +actually see `2020-01-01,Acme, Inc., 1,000').  File: hledger.info, Node: Matching individual fields, Next: Combining matchers, Prev: Matching the whole record, Up: if block @@ -7335,11 +7945,12 @@ File: hledger.info, Node: Matching individual fields, Next: Combining matchers Or, MATCHER can be a field matcher, like this: + %CSVFIELD REGEX - which matches just the content of a particular CSV field. CSVFIELD + which matches just the content of a particular CSV field. CSVFIELD is a percent sign followed by the field's name or column number, like -'%date' or '%1'. +`%date' or `%1'.  File: hledger.info, Node: Combining matchers, Next: Rules applied on successful match, Prev: Matching individual fields, Up: if block @@ -7350,9 +7961,10 @@ File: hledger.info, Node: Combining matchers, Next: Rules applied on successfu A single matcher can be written on the same line as the "if"; or multiple matchers can be written on the following lines, non-indented. Multiple matchers are OR'd (any one of them can match), unless one -begins with an '&' symbol, in which case it is AND'ed with the previous +begins with an `&' symbol, in which case it is AND'ed with the previous matcher. + if MATCHER & MATCHER @@ -7365,19 +7977,23 @@ File: hledger.info, Node: Rules applied on successful match, Prev: Combining m .......................................... After the patterns there should be one or more rules to apply, all -indented by at least one space. Three kinds of rule are allowed in +indented by at least one space. Three kinds of rule are allowed in conditional blocks: * field assignments (to set a hledger field) + * skip (to skip the matched CSV record) + * end (to skip all remaining CSV records). Examples: + # if the CSV record contains "groceries", set account2 to "expenses:groceries" if groceries account2 expenses:groceries + # if the CSV record contains any of these patterns, set account2 and comment as shown if monthly service fee @@ -7389,26 +8005,28 @@ banking thru software  File: hledger.info, Node: if table, Next: end, Prev: if block, Up: CSV rules -13.2.7 'if' table +13.2.7 `if' table ----------------- + if,CSVFIELDNAME1,CSVFIELDNAME2,...,CSVFIELDNAMEn MATCHER1,VALUE11,VALUE12,...,VALUE1n MATCHER2,VALUE21,VALUE22,...,VALUE2n MATCHER3,VALUE31,VALUE32,...,VALUE3n - Conditional tables ("if tables") are a different syntax to specify -field assignments that will be applied only to CSV records which match -certain patterns. +Conditional tables ("if tables") are a different syntax to specify field +assignments that will be applied only to CSV records which match certain +patterns. MATCHER could be either field or record matcher, as described above. When MATCHER matches, values from that row would be assigned to the CSV -fields named on the 'if' line, in the same order. +fields named on the `if' line, in the same order. - Therefore 'if' table is exactly equivalent to a sequence of of 'if' + Therefore `if' table is exactly equivalent to a sequence of of `if' blocks: + if MATCHER1 CSVFIELDNAME1 VALUE11 CSVFIELDNAME2 VALUE12 @@ -7431,17 +8049,18 @@ if MATCHER3 empty) values for all the listed fields. Rules would be checked and applied in the order they are listed in -the table and, like with 'if' blocks, later rules (in the same or -another table) or 'if' blocks could override the effect of any rule. +the table and, like with `if' blocks, later rules (in the same or +another table) or `if' blocks could override the effect of any rule. Instead of ',' you can use a variety of other non-alphanumeric -characters as a separator. First character after 'if' is taken to be -the separator for the rest of the table. It is the responsibility of +characters as a separator. First character after `if' is taken to be +the separator for the rest of the table. It is the responsibility of the user to ensure that separator does not occur inside MATCHERs and values - there is no way to escape separator. Example: + if,account2,comment atm transaction fee,expenses:business:banking,deductible? check it %description groceries,expenses:groceries, @@ -7450,12 +8069,13 @@ atm transaction fee,expenses:business:banking,deductible? check it  File: hledger.info, Node: end, Next: date-format, Prev: if table, Up: CSV rules -13.2.8 'end' +13.2.8 `end' ------------ This rule can be used inside if blocks (only), to make hledger stop reading this CSV file and move on to the next input file, or to command -execution. Eg: +execution. Eg: + # ignore everything following the first empty record if ,,,, @@ -7464,27 +8084,32 @@ if ,,,,  File: hledger.info, Node: date-format, Next: decimal-mark, Prev: end, Up: CSV rules -13.2.9 'date-format' +13.2.9 `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', +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 date parsing pattern, which must parse the CSV date value completely. Some examples: + # MM/DD/YY date-format %m/%d/%y + # D/M/YYYY # The - makes leading zeros optional. date-format %-d/%-m/%Y + # YYYY-Mmm-DD date-format %Y-%h-%d + # 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 @@ -7500,17 +8125,19 @@ time zone, dates can be "off by one".  File: hledger.info, Node: decimal-mark, Next: newest-first, Prev: date-format, Up: CSV rules -13.2.10 'decimal-mark' +13.2.10 `decimal-mark' ---------------------- + decimal-mark . - or: +or: + decimal-mark , hledger automatically accepts either period or comma as a decimal -mark when parsing numbers (cf Amounts). However if any numbers in the +mark when parsing numbers (cf Amounts). However if any numbers in the CSV contain digit group marks, such as thousand-separating commas, you should declare the decimal mark explicitly with this rule, to avoid misparsed numbers. @@ -7518,21 +8145,24 @@ misparsed numbers.  File: hledger.info, Node: newest-first, Next: include, Prev: decimal-mark, Up: CSV rules -13.2.11 'newest-first' +13.2.11 `newest-first' ---------------------- -hledger always sorts the generated transactions by date. Transactions -on the same date should appear in the same order as their CSV records, -as hledger can usually auto-detect whether the CSV's normal order is -oldest first or newest first. But if all of the following are true: +hledger always sorts the generated transactions by date. Transactions on +the same date should appear in the same order as their CSV records, as +hledger can usually auto-detect whether the CSV's normal order is oldest +first or newest first. But if all of the following are true: * the CSV might sometimes contain just one day of data (all records having the same date) - * the CSV records are normally in reverse chronological order (newest - at the top) + + * the CSV records are normally in reverse chronological order + (newest at the top) + * and you care about preserving the order of same-day transactions - then, you should add the 'newest-first' rule as a hint. Eg: + then, you should add the `newest-first' rule as a hint. Eg: + # tell hledger explicitly that the CSV is normally newest first newest-first @@ -7540,16 +8170,18 @@ newest-first  File: hledger.info, Node: include, Next: balance-type, Prev: newest-first, Up: CSV rules -13.2.12 'include' +13.2.12 `include' ----------------- + include RULESFILE - This includes the contents of another CSV rules file at this point. -'RULESFILE' is an absolute file path or a path relative to the current -file's directory. This can be useful for sharing common rules between +This includes the contents of another CSV rules file at this point. +`RULESFILE' is an absolute file path or a path relative to the current +file's directory. This can be useful for sharing common rules between several rules files, eg: + # someaccount.csv.rules ## someaccount-specific rules @@ -7563,21 +8195,23 @@ include categorisation.rules  File: hledger.info, Node: balance-type, Prev: include, Up: CSV rules -13.2.13 'balance-type' +13.2.13 `balance-type' ---------------------- Balance assertions generated by assigning to balanceN are of the simple -'=' 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 -'balance-type' rule: +`=' 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 +`balance-type' rule: + # balance assertions will consider all commodities and all subaccounts balance-type ==* Here are the balance assertion types for quick reference: + = single commodity, exclude subaccounts =* single commodity, include subaccounts == multi commodity, exclude subaccounts @@ -7611,15 +8245,16 @@ File: hledger.info, Node: Rapid feedback, Next: Valid CSV, Up: Tips --------------------- It's a good idea to get rapid feedback while creating/troubleshooting -CSV rules. Here's a good way, using entr from +CSV rules. Here's a good way, using entr from http://eradman.com/entrproject : + $ ls foo.csv* | entr bash -c 'echo ----; hledger -f foo.csv print desc:SOMEDESC' - A desc: query (eg) is used to select just one, or a few, transactions -of interest. "bash -c" is used to run multiple commands, so we can echo -a separator each time the command re-runs, making it easier to read the -output. + A desc: query (eg) is used to select just one, or a few, +transactions of interest. "bash -c" is used to run multiple commands, +so we can echo a separator each time the command re-runs, making it +easier to read the output.  File: hledger.info, Node: Valid CSV, Next: File Extension, Prev: Rapid feedback, Up: Tips @@ -7627,10 +8262,11 @@ File: hledger.info, Node: Valid CSV, Next: File Extension, Prev: Rapid feedba 13.3.2 Valid CSV ---------------- -hledger accepts CSV conforming to RFC 4180. When CSV values are -enclosed in quotes, note: +hledger accepts CSV conforming to RFC 4180. When CSV values are enclosed +in quotes, note: * they must be double quotes (not single quotes) + * spaces outside the quotes are not allowed  @@ -7640,14 +8276,16 @@ File: hledger.info, Node: File Extension, Next: Reading multiple CSV files, P --------------------- To help hledger identify the format and show the right error messages, -CSV/SSV/TSV files should normally be named with a '.csv', '.ssv' or -'.tsv' filename extension. Or, the file path should be prefixed with -'csv:', 'ssv:' or 'tsv:'. Eg: +CSV/SSV/TSV files should normally be named with a `.csv', `.ssv' or +`.tsv' filename extension. Or, the file path should be prefixed with +`csv:', `ssv:' or `tsv:'. Eg: + $ hledger -f foo.ssv print or: + $ cat foo | hledger -f ssv:- foo You can override the file extension with a separator rule if needed. @@ -7659,9 +8297,9 @@ File: hledger.info, Node: Reading multiple CSV files, Next: Valid transactions 13.3.4 Reading multiple CSV files --------------------------------- -If you use multiple '-f' options to read multiple CSV files at once, +If you use multiple `-f' options to read multiple CSV files at once, hledger will look for a correspondingly-named rules file for each CSV -file. But if you use the '--rules-file' option, that rules file will be +file. But if you use the `--rules-file' option, that rules file will be used for all the CSV files.  @@ -7678,9 +8316,10 @@ the problem entry. There is one exception: balance assertions, if you have generated them, will not be checked, since normally these will work only when the -CSV data is part of the main journal. If you do need to check balance +CSV data is part of the main journal. If you do need to check balance assertions generated from CSV right away, pipe into another hledger: + $ hledger -f file.csv print | hledger -f- print  @@ -7694,23 +8333,25 @@ transactions, the new file may overlap with the old one, containing some of the same records. The import command will (a) detect the new transactions, and (b) -append just those transactions to your main journal. It is idempotent, +append just those transactions to your main journal. It is idempotent, so you don't have to remember how many times you ran it or with which -version of the CSV. (It keeps state in a hidden '.latest.FILE.csv' -file.) This is the easiest way to import CSV data. Eg: +version of the CSV. (It keeps state in a hidden `.latest.FILE.csv' +file.) This is the easiest way to import CSV data. Eg: + # download the latest CSV files, then run this command. # Note, no -f flags needed here. $ hledger import *.csv [--dry] - This method works for most CSV files. (Where records have a stable + This method works for most CSV files. (Where records have a stable chronological order, and new records appear only at the new end.) A number of other tools and workflows, hledger-specific and -otherwise, exist for converting, deduplicating, classifying and managing -CSV data. See: +otherwise, exist for converting, deduplicating, classifying and +managing CSV data. See: * https://hledger.org -> sidebar -> real world setups + * https://plaintextaccounting.org -> data import/conversion  @@ -7724,23 +8365,24 @@ Some tips on using the amount-setting rules discussed above. Here are the ways to set a posting's amount: 1. *If the CSV has a single amount field:* - Assign (via a fields list or a field assignment) to 'amountN'. - This sets the Nth posting's amount. N is usually 1 or 2 but can go - up to 99. + Assign (via a fields list or a field assignment) to `amountN'. This + sets the Nth posting's amount. N is usually 1 or 2 but can go up + to 99. 2. *If the CSV has separate amount fields for debit & credit (in & out):* - a. *If both fields are unsigned:* - Assign to 'amountN-in' and 'amountN-out'. This sets posting + Assign to `amountN-in' and `amountN-out'. This sets posting N's amount to whichever of these has a non-zero value, and negates the "-out" value. b. *If either field is signed (can contain a minus sign):* - Use a conditional rule to flip the sign (of non-empty values). - Since hledger always negates amountN-out, if it was already - negative, we must undo that by negating once more (but only if - the field is non-empty): + Use a conditional rule to flip the sign (of non-empty + values). Since hledger always negates amountN-out, if it was + already negative, we must undo that by negating once more + (but only if the field is non-empty): + + fields date, description, amount1-in, amount1-out if %amount1-out [1-9] @@ -7749,17 +8391,19 @@ Some tips on using the amount-setting rules discussed above. c. *If both fields, or neither field, can contain a non-zero value:* hledger normally expects exactly one of the fields to have a - non-zero value. Eg, the 'amountN-in'/'amountN-out' rules + non-zero value. Eg, the `amountN-in'/`amountN-out' rules would reject value pairs like these: + "", "" "0", "0" "1", "none" So, use smarter conditional rules to set the amount from the - appropriate field. Eg, these rules would make it use only the + appropriate field. Eg, these rules would make it use only the value containing non-zero digits, handling the above: + fields date, description, in, out if %in [1-9] amount1 %in @@ -7768,22 +8412,25 @@ Some tips on using the amount-setting rules discussed above. 3. *If you are stuck with hledger <1.17, or you want posting 2's amount converted to cost:* - Assign to 'amount' (or to 'amount-in' and 'amount-out'). (The old + Assign to `amount' (or to `amount-in' and `amount-out'). (The old numberless syntax, which sets amount1 and amount2.) 4. *If the CSV has the balance instead of the transaction amount:* - Assign to 'balanceN', which sets posting N's amount indirectly via - a balance assignment. (Old syntax: 'balance', equivalent to - 'balance1'.) + Assign to `balanceN', which sets posting N's amount indirectly via + a balance assignment. (Old syntax: `balance', equivalent to + `balance1'.) * *If hledger guesses the wrong default account name:* When setting the amount via balance assertion, hledger may - guess the wrong default account name. So, set the account + guess the wrong default account name. So, set the account name explicitly, eg: + fields date, description, balance1 account1 assets:checking + +  File: hledger.info, Node: Amount signs, Next: Setting currency/commodity, Prev: Setting amounts, Up: Tips @@ -7794,21 +8441,22 @@ There is some special handling for amount signs, to simplify parsing and sign-flipping: * *If an amount value begins with a plus sign:* - that will be removed: '+AMT' becomes 'AMT' + that will be removed: `+AMT' becomes `AMT' * *If an amount value is parenthesised:* - it will be de-parenthesised and sign-flipped: '(AMT)' becomes - '-AMT' + it will be de-parenthesised and sign-flipped: `(AMT)' becomes + `-AMT' * *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' + they cancel out and will be removed: `--AMT' or `-(AMT)' becomes + `AMT' * *If an amount value contains just a sign (or just a set of parentheses):* - that is removed, making it an empty value. '"+"' or '"-"' or - '"()"' becomes '""'. + that is removed, making it an empty value. `"+"' or `"-"' or + `"()"' becomes `""'. +  File: hledger.info, Node: Setting currency/commodity, Next: Amount decimal places, Prev: Amount signs, Up: Tips @@ -7819,43 +8467,51 @@ File: hledger.info, Node: Setting currency/commodity, Next: Amount decimal pla If the currency/commodity symbol is included in the CSV's amount field(s): + 2020-01-01,foo,$123.00 you don't have to do anything special for the commodity symbol, it -will be assigned as part of the amount. Eg: +will be assigned as part of the amount. Eg: + fields date,description,amount + 2020-01-01 foo expenses:unknown $123.00 income:unknown $-123.00 If the currency is provided as a separate CSV field: + 2020-01-01,foo,USD,123.00 - You can assign that to the 'currency' pseudo-field, which has the + 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 left, with no separating space): + fields date,description,currency,amount + 2020-01-01 foo expenses:unknown USD123.00 income:unknown USD-123.00 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: +with more control. Eg to put the symbol on the right, and separated by a +space: + fields date,description,cur,amt amount %amt %cur + 2020-01-01 foo expenses:unknown 123.00 USD income:unknown -123.00 USD - Note we used a temporary field name ('cur') that is not 'currency' - + Note we used a temporary field name (`cur') that is not `currency' - that would trigger the prepending effect, which we don't want here.  @@ -7865,7 +8521,7 @@ File: hledger.info, Node: Amount decimal places, Next: Referencing other field ----------------------------- Like amounts in a journal file, the amounts generated by CSV rules like -'amount1' influence commodity display styles, such as the number of +`amount1' influence commodity display styles, such as the number of decimal places displayed in reports. The original amounts as written in the CSV file do not affect display @@ -7878,10 +8534,11 @@ File: hledger.info, Node: Referencing other fields, Next: How CSV rules are ev -------------------------------- 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 +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" fields date,description,amount1 @@ -7894,14 +8551,16 @@ comment %amount1 Here, since there's no CSV amount1 field, %amount1 will produce a literal "amount1": + fields date,description,csvamount amount1 %csvamount USD # Can't interpolate amount1 here comment %amount1 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: +only the last one takes effect. Here, comment's value will be be B, or C +if "something" is matched, but never A: + comment A comment B @@ -7915,37 +8574,43 @@ File: hledger.info, Node: How CSV rules are evaluated, Prev: Referencing other ----------------------------------- Here's how to think of CSV rules being evaluated (if you really need -to). First, +to). First, - * 'include' - all includes are inlined, from top to bottom, depth - first. (At each include point the file is inlined and scanned for + * `include' - all includes are inlined, from top to bottom, depth + first. (At each include point the file is inlined and scanned for further includes, recursively, before proceeding.) - Then "global" rules are evaluated, top to bottom. If a rule is + Then "global" rules are evaluated, top to bottom. If a rule is repeated, the last one wins: - * 'skip' (at top level) - * 'date-format' - * 'newest-first' - * 'fields' - names the CSV fields, optionally sets up initial + * `skip' (at top level) + + * `date-format' + + * `newest-first' + + * `fields' - names the CSV fields, optionally sets up initial assignments to hledger fields Then for each CSV record in turn: - * test all 'if' blocks. If any of them contain a 'end' rule, skip - all remaining CSV records. Otherwise if any of them contain a - 'skip' rule, skip that many CSV records. If there are multiple - matched 'skip' rules, the first one wins. - * collect all field assignments at top level and in matched 'if' - blocks. When there are multiple assignments for a field, keep only + * test all `if' blocks. If any of them contain a `end' rule, skip + all remaining CSV records. Otherwise if any of them contain a + `skip' rule, skip that many CSV records. If there are multiple + matched `skip' rules, the first one wins. + + * 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. + * compute a value for each hledger field - either the one that was assigned to it (and interpolate the %CSVFIELDNAME references), or a default + * generate a synthetic hledger transaction from these values. This is all part of the CSV reader, one of several readers hledger -can use to parse input files. When all files have been read +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. @@ -7957,22 +8622,24 @@ File: hledger.info, Node: TIMECLOCK FORMAT, Next: TIMEDOT FORMAT, Prev: CSV F 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. + 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 +optional. The timezone, if present, must be four digits and is ignored (currently the time is always interpreted as a local time). + i 2015/03/30 09:00:00 some:account name optional description after two spaces 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 -the above time log, 'hledger print' generates these journal entries: +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 2015-03-30 * optional description after two spaces @@ -7986,6 +8653,7 @@ $ hledger -f t.timeclock print Here is a sample.timeclock to download and some queries to try: + $ 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 @@ -7995,37 +8663,41 @@ $ hledger -f sample.timeclock register -p weekly --depth 1 --empty # time summa * use emacs and the built-in timeclock.el, or the extended timeclock-x.el and perhaps the extras in ledgerutils.el - * 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 - `date '+%Y-%m-%d %H:%M:%S'` >>$TIMELOG"' + * 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 `date '+%Y-%m-%d %H:%M:%S'` >>$TIMELOG"' - * or use the old 'ti' and 'to' scripts in the ledger 2.x repository. + * 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 executable renamed. +  File: hledger.info, Node: TIMEDOT FORMAT, Next: COMMON TASKS, Prev: TIMECLOCK FORMAT, Up: Top 15 TIMEDOT FORMAT ***************** -'timedot' format is hledger's human-friendly time logging format. -Compared to 'timeclock' format, it is +`timedot' format is hledger's human-friendly time logging format. +Compared to `timeclock' format, it is * convenient for quick, approximate, and retroactive time logging + * readable: you can see at a glance where time was spent. A timedot file contains a series of day entries, which might look like this: + 2021-08-04 hom:errands .... .... fos:hledger:timedot .. ; docs -per:admin:finance +per:admin:finance hledger reads this as three time transactions on this day, with each dot representing a quarter-hour spent: + $ hledger -f a.timedot print # .timedot file extension activates the timedot reader 2021-08-04 * (hom:errands) 2.00 @@ -8043,53 +8715,60 @@ $ hledger -f a.timedot print # .timedot file extension activates the timedot r Optionally this can be followed on the same line by * a common *transaction description* for this day + * a common *transaction comment* for this day, after a semicolon - (';'). + (`;'). After the date line are zero or more optionally-indented time transaction lines, consisting of: * an *account name* - any word or phrase, usually a hledger-style account name. + * *two or more spaces* - a field separator, required if there is an amount (as in journal format). + * a *timedot amount* - dots representing quarter hours, or a number representing hours. - * an optional *comment* beginning with semicolon. This is ignored. + + * an optional *comment* beginning with semicolon. This is ignored. In more detail, timedot amounts can be: * *dots*: zero or more period characters, each representing one - quarter-hour. Spaces are ignored and can be used for grouping. - Eg: '.... ..' + quarter-hour. Spaces are ignored and can be used for grouping. Eg: + `.... ..' - * a *number*, representing hours. Eg: '1.5' + * a *number*, representing hours. Eg: `1.5' - * a *number immediately followed by a unit symbol* 's', 'm', 'h', - 'd', 'w', 'mo', or 'y', representing seconds, minutes, hours, days - weeks, months or years. Eg '1.5h' or '90m'. The following + * a *number immediately followed by a unit symbol* `s', `m', `h', + `d', `w', `mo', or `y', representing seconds, minutes, hours, days + weeks, months or years. Eg `1.5h' or `90m'. The following equivalencies are assumed: - '60s' = '1m', '60m' = '1h', '24h' = '1d', '7d' = '1w', '30d' = - '1mo', '365d' = '1y'. (This unit will not be visible in the + `60s' = `1m', `60m' = `1h', `24h' = `1d', `7d' = `1w', `30d' = + `1mo', `365d' = `1y'. (This unit will not be visible in the generated transaction amount, which is always in hours.) + There is some added flexibility to help with keeping time log data in the same file as your notes, todo lists, etc.: - * Lines beginning with '#' or ';', and blank lines, are ignored. + * Lines beginning with `#' or `;', and blank lines, are ignored. * Lines not ending with a double-space and amount are parsed as - transactions with zero amount. (Most hledger reports hide these by + transactions with zero amount. (Most hledger reports hide these by default; add -E to see them.) - * One or more stars ('*') followed by a space, at the start of a - line, is ignored. So date lines or time transaction lines can also + * One or more stars (`*') followed by a space, at the start of a + line, is ignored. So date lines or time transaction lines can also be Org-mode headlines. * All Org-mode headlines before the first date line are ignored. + More examples: + # on this day, 6h was spent on client work, 1.5h on haskell FOSS work, etc. 2016/2/1 inc:client1 .... .... .... .... .... .... @@ -8100,16 +8779,19 @@ biz:research . inc:client1 .... .... biz:research . + 2016/2/3 inc:client1 4 fos:hledger 3 biz:research 1 + * Time log ** 2020-01-01 *** adm:time . *** adm:finance . + * 2020 Work Diary ** Q1 *** 2020-02-29 @@ -8128,6 +8810,7 @@ adm:planning: trip Reporting: + $ hledger -f a.timedot print date:2016/2/2 2016-02-02 * (inc:client1) 2.00 @@ -8135,27 +8818,30 @@ $ hledger -f a.timedot print date:2016/2/2 2016-02-02 * (biz:research) 0.25 + $ 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 - fos || 1.50 0 3.00 - haskell || 1.50 0 0 - hledger || 0 0 3.00 - inc || 6.00 2.00 4.00 - client1 || 6.00 2.00 4.00 + biz || 0.25 0.25 1.00 + research || 0.25 0.25 1.00 + fos || 1.50 0 3.00 + haskell || 1.50 0 0 + hledger || 0 0 3.00 + inc || 6.00 2.00 4.00 + client1 || 6.00 2.00 4.00 ------------++---------------------------------------- - || 7.75 2.25 8.00 + || 7.75 2.25 8.00 Using period instead of colon as account name separator: + 2016/2/4 fos.hledger.timedot 4 fos.ledger .. + $ hledger -f a.timedot --alias /\\./=: bal --tree 4.50 fos 4.00 hledger:timedot @@ -8193,6 +8879,7 @@ File: hledger.info, Node: Getting help, Next: Constructing command lines, Up: 16.1 Getting help ================= + $ hledger # show available commands $ hledger --help # show common options $ hledger CMD --help # show common and command options, and command help @@ -8201,7 +8888,7 @@ $ hledger help hledger # show hledger manual as info/man/text (auto-chosen) $ hledger help journal --man # show the journal manual as a man page $ hledger help --help # show more detailed help for the help command - Find more docs, chat, mail list, reddit, issue tracker: +Find more docs, chat, mail list, reddit, issue tracker: https://hledger.org#help-feedback  @@ -8210,19 +8897,23 @@ File: hledger.info, Node: Constructing command lines, Next: Starting a journal 16.2 Constructing command lines =============================== -hledger has an extensive and powerful command line interface. We strive +hledger has an extensive and powerful command line interface. We strive to keep it simple and ergonomic, but you may run into one of the -confusing real world details described in OPTIONS, below. If that +confusing real world details described in OPTIONS, below. If that happens, here are some tips that may help: * command-specific options must go after the command (it's fine to - put all options there) ('hledger CMD OPTS ARGS') + put all options there) (`hledger CMD OPTS ARGS') + * running add-on executables directly simplifies command line parsing - ('hledger-ui OPTS ARGS') + (`hledger-ui OPTS ARGS') + * enclose "problematic" args in single quotes + * if needed, also add a backslash to hide regular expression metacharacters from the shell - * to see how a misbehaving command is being parsed, add '--debug=2'. + + * to see how a misbehaving command is being parsed, add `--debug=2'.  File: hledger.info, Node: Starting a journal file, Next: Setting opening balances, Prev: Constructing command lines, Up: COMMON TASKS @@ -8231,17 +8922,19 @@ File: hledger.info, Node: Starting a journal file, Next: Setting opening balan ============================ hledger looks for your accounting data in a journal file, -'$HOME/.hledger.journal' by default: +`$HOME/.hledger.journal' by default: + $ hledger stats The hledger journal file "/Users/simon/.hledger.journal" was not found. 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. 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: + You can override this by setting the `LEDGER_FILE' environment +variable. It's a good practice to keep this important file under version +control, and to start a new file each year. So you could do something +like this: + $ mkdir ~/finance $ cd ~/finance @@ -8252,7 +8945,7 @@ $ echo "export LEDGER_FILE=$HOME/finance/2020.journal" >> ~/.bashrc $ source ~/.bashrc $ hledger stats Main file : /Users/simon/finance/2020.journal -Included files : +Included files : Transactions span : to (0 days) Last transaction : none Transactions : 0 (0.0 per day) @@ -8270,21 +8963,22 @@ File: hledger.info, Node: Setting opening balances, Next: Recording transactio ============================= Pick a starting date for which you can look up the balances of some -real-world assets (bank accounts, wallet..) and liabilities (credit +real-world assets (bank accounts, wallet..) and liabilities (credit cards..). To avoid a lot of data entry, you may want to start with just one or two accounts, like your checking account or cash wallet; and pick a -recent starting date, like today or the start of the week. You can +recent starting date, like today or the start of the week. You can always come back later and add more accounts and older transactions, eg going back to january 1st. Add an opening balances transaction to the journal, declaring the -balances on this date. Here are two ways to do it: +balances on this date. Here are two ways to do it: * The first way: open the journal in any text editor and save an entry like this: + 2020-01-01 * opening balances assets:bank:checking $1000 = $1000 assets:bank:savings $2000 = $2000 @@ -8295,7 +8989,7 @@ balances on this date. Here are two ways to do it: 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 @@ -8304,9 +8998,10 @@ balances on this date. Here are two ways to do it: The = amounts are optional balance assertions, providing extra error checking. - * The second way: run 'hledger add' and follow the prompts to record + * The second way: run `hledger add' and follow the prompts to record a similar transaction: + $ hledger add Adding transactions to journal file /Users/simon/finance/2020.journal Any command line arguments will be used as defaults. @@ -8327,7 +9022,7 @@ balances on this date. Here are two ways to do it: Account 4: liabilities:creditcard 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): . 2020-01-01 * opening balances assets:bank:checking $1000 @@ -8335,14 +9030,16 @@ balances on this date. Here are two ways to do it: assets:cash $100 liabilities:creditcard $-50 equity:opening/closing balances $-3050 - - Save this transaction to the journal ? [y]: + + Save this transaction to the journal ? [y]: Saved. Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2020-01-01]: . + If you're using version control, this could be a good time to commit -the journal. Eg: +the journal. Eg: + $ git commit -m 'initial balances' 2020.journal @@ -8360,6 +9057,7 @@ convert CSV data downloaded from your bank. Here are some simple transactions, see the hledger_journal(5) manual and hledger.org for more ideas: + 2020/1/10 * gift received assets:cash $20 income:gifts @@ -8382,49 +9080,52 @@ Periodically you should reconcile - compare your hledger-reported balances 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 +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 discrepancies. A typical workflow: - 1. Reconcile cash. Count what's in your wallet. Compare with what - hledger reports ('hledger bal cash'). If they are different, try - to remember the missing transaction, or look for the error in the - already-recorded transactions. A register report can be helpful - ('hledger reg cash'). If you can't find the error, add an - adjustment transaction. Eg if you have $105 after the above, and + 1. Reconcile cash. Count what's in your wallet. Compare with what + hledger reports (`hledger bal cash'). If they are different, try to + remember the missing transaction, or look for the error in the + already-recorded transactions. A register report can be helpful + (`hledger reg cash'). If you can't find the error, add an + adjustment transaction. Eg if you have $105 after the above, and can't explain the missing $2, it could be: + 2020-01-16 * adjust cash assets:cash $-2 = $105 expenses:misc - 2. Reconcile checking. Log in to your bank's website. Compare - today's (cleared) balance with hledger's cleared balance ('hledger - bal checking -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 transaction history and running balance from your bank - with the one reported by 'hledger reg checking -C'. This will be - easier if you generally record transaction dates quite similar to - your bank's clearing dates. + 2. Reconcile checking. Log in to your bank's website. Compare today's + (cleared) balance with hledger's cleared balance (`hledger bal + checking -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 transaction history and running balance from + your bank with the one reported by `hledger reg checking -C'. This + will be easier if you generally record transaction dates quite + similar to your bank's clearing dates. 3. Repeat for other asset/liability accounts. + Tip: instead of the register command, use hledger-ui to see a -live-updating register while you edit the journal: 'hledger-ui --watch +live-updating register while you edit the journal: `hledger-ui --watch --register 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, -insert '*' between '2020-01-15' and 'paycheck' +that, by adding the `*' marker. Eg in the paycheck transaction above, +insert `*' between `2020-01-15' and `paycheck' If you're using version control, this can be another good time to commit: + $ git commit -m 'txns' 2020.journal  @@ -8437,6 +9138,7 @@ Here are some basic reports. Show all transactions: + $ hledger print 2020-01-01 * opening balances assets:bank:checking $1000 @@ -8463,6 +9165,7 @@ $ hledger print Show account names, and their hierarchy: + $ hledger accounts --tree assets bank @@ -8482,6 +9185,7 @@ liabilities Show all account totals: + $ hledger balance $4105 assets $4000 bank @@ -8502,6 +9206,7 @@ $ hledger balance Show only asset and liability balances, as a flat list, limited to depth 2: + $ hledger bal assets liabilities --flat -2 $4000 assets:bank $105 assets:cash @@ -8512,56 +9217,59 @@ $ hledger bal assets liabilities --flat -2 Show the same thing without negative numbers, formatted as a simple balance sheet: + $ hledger bs --flat -2 Balance Sheet 2020-01-16 - || 2020-01-16 + || 2020-01-16 ========================++============ - Assets || + Assets || ------------------------++------------ - assets:bank || $4000 - assets:cash || $105 + assets:bank || $4000 + assets:cash || $105 ------------------------++------------ - || $4105 + || $4105 ========================++============ - Liabilities || + Liabilities || ------------------------++------------ - liabilities:creditcard || $50 + liabilities:creditcard || $50 ------------------------++------------ - || $50 + || $50 ========================++============ - Net: || $4055 + Net: || $4055 - The final total is your "net worth" on the end date. (Or use 'bse' + The final total is your "net worth" on the end date. (Or use `bse' for a full balance sheet with equity.) Show income and expense totals, formatted as an income statement: -hledger is + +hledger is Income Statement 2020-01-01-2020-01-16 - || 2020-01-01-2020-01-16 + || 2020-01-01-2020-01-16 ===============++======================= - Revenues || + Revenues || ---------------++----------------------- - income:gifts || $20 - income:salary || $1000 + income:gifts || $20 + income:salary || $1000 ---------------++----------------------- - || $1020 + || $1020 ===============++======================= - Expenses || + Expenses || ---------------++----------------------- - expenses:food || $13 - expenses:misc || $2 + expenses:food || $13 + expenses:misc || $2 ---------------++----------------------- - || $15 + || $15 ===============++======================= - Net: || $1005 + Net: || $1005 The final total is your net income during this period. Show transactions affecting your wallet, with running total: + $ hledger register cash 2020-01-01 opening balances assets:cash $100 $100 2020-01-10 gift received assets:cash $20 $120 @@ -8570,6 +9278,7 @@ $ hledger register cash Show weekly posting counts as a bar chart: + $ hledger activity -W 2019-12-30 ***** 2020-01-06 **** @@ -8583,10 +9292,10 @@ File: hledger.info, Node: Migrating to a new file, Prev: Reporting, Up: COMMO 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. + If using version control, don't forget to `git add' the new file.  File: hledger.info, Node: LIMITATIONS, Next: TROUBLESHOOTING, Prev: COMMON TASKS, Up: Top @@ -8594,11 +9303,11 @@ File: hledger.info, Node: LIMITATIONS, Next: TROUBLESHOOTING, Prev: COMMON TA 17 LIMITATIONS ************** -The need to precede add-on command options with '--' when invoked from +The need to precede add-on command options with `--' when invoked from hledger is awkward. When input data contains non-ascii characters, a suitable system -locale must be configured (or there will be an unhelpful error). Eg on +locale must be configured (or there will be an unhelpful error). Eg on POSIX, set LANG to something other than C. In a Microsoft Windows CMD window, non-ascii characters and colours @@ -8610,8 +9319,8 @@ running a hledger built in CMD in MSYS/CYGWIN, or vice-versa. In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger add. - Not all of Ledger's journal file syntax is supported. See file -format differences. + Not all of Ledger's journal file syntax is supported. See file format +differences. On large data files, hledger is slower and uses more memory than Ledger. @@ -8628,28 +9337,29 @@ tracker): *Successfully installed, but "No command 'hledger' found"* stack and cabal install binaries into a special directory, which should -be added to your PATH environment variable. Eg on unix-like systems, +be added to your PATH environment variable. Eg on unix-like systems, that is ~/.local/bin and ~/.cabal/bin respectively. *I set a custom LEDGER_FILE, but hledger is still using the default file* -'LEDGER_FILE' should be a real environment variable, not just a shell -variable. The command 'env | grep LEDGER_FILE' should show it. You may -need to use 'export'. Here's an explanation. +`LEDGER_FILE' should be a real environment variable, not just a shell +variable. The command `env | grep LEDGER_FILE' should show it. You may +need to use `export'. Here's an explanation. *Getting errors like "Illegal byte sequence" or "Invalid or incomplete multibyte or wide character" or "commitAndReleaseBuffer: invalid argument (invalid character)"* -Programs compiled with GHC (hledger, haskell build tools, etc.) need to +Programs compiled with GHC (hledger, haskell build tools, etc.) need to have a UTF-8-aware locale configured in the environment, otherwise they will fail with these kinds of errors when they encounter non-ascii characters. To fix it, set the LANG environment variable to some locale which -supports UTF-8. The locale you choose must be installed on your system. +supports UTF-8. The locale you choose must be installed on your system. Here's an example of setting LANG temporarily, on Ubuntu GNU/Linux: + $ file my.journal my.journal: UTF-8 Unicode text # the file is UTF8-encoded $ echo $LANG @@ -8660,10 +9370,11 @@ en_US.utf8 # here's a UTF8-aware one we can use POSIX $ LANG=en_US.utf8 hledger -f my.journal print # ensure it is used for this command - If available, 'C.UTF-8' will also work. If your preferred locale -isn't listed by 'locale -a', you might need to install it. Eg on + If available, `C.UTF-8' will also work. If your preferred locale +isn't listed by `locale -a', you might need to install it. Eg on Ubuntu/Debian: + $ apt-get install language-pack-fr $ locale -a C @@ -8678,520 +9389,528 @@ $ LANG=fr_FR.utf8 hledger -f my.journal print Here's how you could set it permanently, if you use a bash shell: + $ echo "export LANG=en_US.utf8" >>~/.bash_profile $ bash --login - Exact spelling and capitalisation may be important. Note the -difference on MacOS ('UTF-8', not 'utf8'). Some platforms (eg ubuntu) + Exact spelling and capitalisation may be important. Note the +difference on MacOS (`UTF-8', not `utf8'). Some platforms (eg ubuntu) allow variant spellings, but others (eg macos) require it to be exact: + $ locale -a | grep -iE en_us.*utf en_US.UTF-8 $ LANG=en_US.UTF-8 hledger -f my.journal print - -Tag Table: -Node: Top208 -Node: OPTIONS2605 -Ref: #options2706 -Node: General options2848 -Ref: #general-options2973 -Node: Command options6708 -Ref: #command-options6859 -Node: Command arguments7259 -Ref: #command-arguments7417 -Node: Special characters8297 -Ref: #special-characters8460 -Node: Single escaping shell metacharacters8623 -Ref: #single-escaping-shell-metacharacters8864 -Node: Double escaping regular expression metacharacters9467 -Ref: #double-escaping-regular-expression-metacharacters9778 -Node: Triple escaping for add-on commands10304 -Ref: #triple-escaping-for-add-on-commands10564 -Node: Less escaping11208 -Ref: #less-escaping11362 -Node: Unicode characters11686 -Ref: #unicode-characters11851 -Node: Regular expressions13263 -Ref: #regular-expressions13403 -Node: ENVIRONMENT15139 -Ref: #environment15255 -Node: DATA FILES16240 -Ref: #data-files16359 -Node: Data formats16898 -Ref: #data-formats17016 -Node: Multiple files18410 -Ref: #multiple-files18552 -Node: Strict mode19021 -Ref: #strict-mode19136 -Node: TIME PERIODS19842 -Ref: #time-periods19959 -Node: Smart dates20057 -Ref: #smart-dates20183 -Node: Report start & end date21509 -Ref: #report-start-end-date21684 -Node: Report intervals23342 -Ref: #report-intervals23510 -Node: Period expressions24787 -Ref: #period-expressions24927 -Node: DEPTH29300 -Ref: #depth29400 -Node: QUERIES29732 -Ref: #queries29831 -Node: Query types30772 -Ref: #query-types30891 -Node: Combining query terms33563 -Ref: #combining-query-terms33738 -Node: Queries and command options34540 -Ref: #queries-and-command-options34743 -Node: Queries and account aliases34992 -Ref: #queries-and-account-aliases35195 -Node: Queries and valuation35315 -Ref: #queries-and-valuation35508 -Node: Querying with account aliases35737 -Ref: #querying-with-account-aliases35946 -Node: Querying with cost or value36076 -Ref: #querying-with-cost-or-value36251 -Node: COSTING36552 -Ref: #costing36655 -Node: VALUATION36929 -Ref: #valuation37037 -Node: -V Value37762 -Ref: #v-value37886 -Node: -X Value in specified commodity38081 -Ref: #x-value-in-specified-commodity38274 -Node: Valuation date38423 -Ref: #valuation-date38585 -Node: Market prices39022 -Ref: #market-prices39203 -Node: --infer-market-price market prices from transactions40385 -Ref: #infer-market-price-market-prices-from-transactions40649 -Node: Valuation commodity42003 -Ref: #valuation-commodity42213 -Node: Simple valuation examples43437 -Ref: #simple-valuation-examples43633 -Node: --value Flexible valuation44292 -Ref: #value-flexible-valuation44494 -Node: More valuation examples46138 -Ref: #more-valuation-examples46339 -Node: Effect of valuation on reports48338 -Ref: #effect-of-valuation-on-reports48520 -Node: PIVOTING55921 -Ref: #pivoting56026 -Node: OUTPUT57702 -Ref: #output57804 -Node: Output destination57855 -Ref: #output-destination57988 -Node: Output format58645 -Ref: #output-format58768 -Node: COMMANDS60935 -Ref: #commands61047 -Node: accounts64412 -Ref: #accounts64512 -Node: activity65208 -Ref: #activity65320 -Node: add65703 -Ref: #add65806 -Node: aregister68599 -Ref: #aregister68713 -Node: aregister and custom posting dates71078 -Ref: #aregister-and-custom-posting-dates71244 -Node: balance71796 -Ref: #balance71915 -Node: balance features72851 -Ref: #balance-features72991 -Node: Simple balance report74733 -Ref: #simple-balance-report74915 -Node: Filtered balance report76368 -Ref: #filtered-balance-report76555 -Node: List or tree mode76855 -Ref: #list-or-tree-mode77023 -Node: Depth limiting78341 -Ref: #depth-limiting78507 -Node: Multi-period balance report79268 -Ref: #multi-period-balance-report79459 -Node: Commodity column81711 -Ref: #commodity-column81883 -Node: Sorting by amount84784 -Ref: #sorting-by-amount84942 -Node: Percentages85612 -Ref: #percentages85768 -Node: Balance change end balance86702 -Ref: #balance-change-end-balance86895 -Node: Balance report types88323 -Ref: #balance-report-types88513 -Node: Useful balance reports92586 -Ref: #useful-balance-reports92767 -Node: Budget report93852 -Ref: #budget-report94036 -Node: Budget report start date99311 -Ref: #budget-report-start-date99489 -Node: Budgets and subaccounts100821 -Ref: #budgets-and-subaccounts101028 -Node: Selecting budget goals104468 -Ref: #selecting-budget-goals104640 -Node: Customising single-period balance reports105674 -Ref: #customising-single-period-balance-reports105883 -Node: balancesheet108031 -Ref: #balancesheet108169 -Node: balancesheetequity109468 -Ref: #balancesheetequity109619 -Node: cashflow110999 -Ref: #cashflow111123 -Node: check112269 -Ref: #check112374 -Node: Basic checks113008 -Ref: #basic-checks113126 -Node: Strict checks113677 -Ref: #strict-checks113818 -Node: Other checks114254 -Ref: #other-checks114394 -Node: Custom checks114751 -Ref: #custom-checks114871 -Node: close115288 -Ref: #close115392 -Node: close and prices117483 -Ref: #close-and-prices117612 -Node: close date118007 -Ref: #close-date118191 -Node: Example close asset/liability accounts for file transition118741 -Ref: #example-close-assetliability-accounts-for-file-transition119042 -Node: Hiding opening/closing transactions119901 -Ref: #hiding-openingclosing-transactions120172 -Node: close and balance assertions121634 -Ref: #close-and-balance-assertions121892 -Node: Example close revenue/expense accounts to retained earnings123246 -Ref: #example-close-revenueexpense-accounts-to-retained-earnings123524 -Node: codes124236 -Ref: #codes124346 -Node: commodities125058 -Ref: #commodities125187 -Node: descriptions125269 -Ref: #descriptions125399 -Node: diff125703 -Ref: #diff125811 -Node: files126858 -Ref: #files126960 -Node: help127107 -Ref: #help127209 -Node: import127936 -Ref: #import128052 -Node: Deduplication128917 -Ref: #deduplication129042 -Node: Import testing130936 -Ref: #import-testing131101 -Node: Importing balance assignments131589 -Ref: #importing-balance-assignments131795 -Node: Commodity display styles132444 -Ref: #commodity-display-styles132617 -Node: incomestatement132746 -Ref: #incomestatement132881 -Node: notes134186 -Ref: #notes134301 -Node: payees134669 -Ref: #payees134777 -Node: prices135303 -Ref: #prices135411 -Node: print135752 -Ref: #print135864 -Node: print-unique141179 -Ref: #print-unique141307 -Node: register141592 -Ref: #register141721 -Node: Custom register output146167 -Ref: #custom-register-output146298 -Node: register-match147635 -Ref: #register-match147771 -Node: rewrite148122 -Ref: #rewrite148239 -Node: Re-write rules in a file150145 -Ref: #re-write-rules-in-a-file150308 -Node: Diff output format151457 -Ref: #diff-output-format151640 -Node: rewrite vs print --auto152732 -Ref: #rewrite-vs.-print---auto152892 -Node: roi153448 -Ref: #roi153548 -Node: Spaces and special characters in --inv and --pnl155234 -Ref: #spaces-and-special-characters-in---inv-and---pnl155474 -Node: Semantics of --inv and --pnl155962 -Ref: #semantics-of---inv-and---pnl156201 -Node: IRR and TWR explained158051 -Ref: #irr-and-twr-explained158211 -Node: stats161279 -Ref: #stats161380 -Node: tags162168 -Ref: #tags162268 -Node: test162787 -Ref: #test162903 -Node: About add-on commands163650 -Ref: #about-add-on-commands163787 -Node: JOURNAL FORMAT164918 -Ref: #journal-format165046 -Node: Transactions167242 -Ref: #transactions167357 -Node: Dates168371 -Ref: #dates168487 -Node: Simple dates168552 -Ref: #simple-dates168672 -Node: Secondary dates169181 -Ref: #secondary-dates169329 -Node: Posting dates170665 -Ref: #posting-dates170788 -Node: Status172160 -Ref: #status172270 -Node: Code173978 -Ref: #code174090 -Node: Description174322 -Ref: #description174450 -Node: Payee and note174770 -Ref: #payee-and-note174878 -Node: Comments175213 -Ref: #comments175335 -Node: Tags176529 -Ref: #tags-1176640 -Node: Postings178033 -Ref: #postings178157 -Node: Virtual postings179183 -Ref: #virtual-postings179294 -Node: Account names180599 -Ref: #account-names180736 -Node: Amounts181224 -Ref: #amounts181361 -Node: Decimal marks digit group marks182317 -Ref: #decimal-marks-digit-group-marks182494 -Node: Commodity183366 -Ref: #commodity183526 -Node: Commodity directives184478 -Ref: #commodity-directives184652 -Node: Commodity display style185139 -Ref: #commodity-display-style185318 -Node: Rounding187426 -Ref: #rounding187546 -Node: Transaction prices187958 -Ref: #transaction-prices188124 -Node: Lot prices lot dates190555 -Ref: #lot-prices-lot-dates190738 -Node: Balance assertions191226 -Ref: #balance-assertions191404 -Node: Assertions and ordering192437 -Ref: #assertions-and-ordering192619 -Node: Assertions and included files193319 -Ref: #assertions-and-included-files193556 -Node: Assertions and multiple -f options193889 -Ref: #assertions-and-multiple--f-options194139 -Node: Assertions and commodities194271 -Ref: #assertions-and-commodities194497 -Node: Assertions and prices195654 -Ref: #assertions-and-prices195862 -Node: Assertions and subaccounts196302 -Ref: #assertions-and-subaccounts196525 -Node: Assertions and virtual postings196849 -Ref: #assertions-and-virtual-postings197085 -Node: Assertions and precision197227 -Ref: #assertions-and-precision197414 -Node: Balance assignments197681 -Ref: #balance-assignments197851 -Node: Balance assignments and prices199015 -Ref: #balance-assignments-and-prices199181 -Node: Directives199405 -Ref: #directives199568 -Node: Directives and multiple files204922 -Ref: #directives-and-multiple-files205118 -Node: Comment blocks205782 -Ref: #comment-blocks205959 -Node: Including other files206135 -Ref: #including-other-files206309 -Node: Default year207233 -Ref: #default-year207391 -Node: Declaring payees207798 -Ref: #declaring-payees207964 -Node: Declaring commodities208210 -Ref: #declaring-commodities208391 -Node: Commodity error checking210771 -Ref: #commodity-error-checking210921 -Node: Default commodity211178 -Ref: #default-commodity211358 -Node: Declaring market prices212234 -Ref: #declaring-market-prices212423 -Node: Declaring accounts213236 -Ref: #declaring-accounts213416 -Node: Account error checking214618 -Ref: #account-error-checking214784 -Node: Account comments215963 -Ref: #account-comments216147 -Node: Account subdirectives216571 -Ref: #account-subdirectives216756 -Node: Account types217069 -Ref: #account-types217243 -Node: Declaring account types217979 -Ref: #declaring-account-types218158 -Node: Auto-detected account types218808 -Ref: #auto-detected-account-types219049 -Node: Interference from auto-detected account types220009 -Ref: #interference-from-auto-detected-account-types220286 -Node: Old account type syntax220769 -Ref: #old-account-type-syntax220966 -Node: Account display order221266 -Ref: #account-display-order221426 -Node: Rewriting accounts222577 -Ref: #rewriting-accounts222756 -Node: Basic aliases223513 -Ref: #basic-aliases223649 -Node: Regex aliases224393 -Ref: #regex-aliases224555 -Node: Combining aliases225274 -Ref: #combining-aliases225457 -Node: Aliases and multiple files226733 -Ref: #aliases-and-multiple-files226932 -Node: end aliases227511 -Ref: #end-aliases227658 -Node: Default parent account227759 -Ref: #default-parent-account227949 -Node: Periodic transactions228833 -Ref: #periodic-transactions229016 -Node: Periodic rule syntax230933 -Ref: #periodic-rule-syntax231133 -Node: Two spaces between period expression and description!231837 -Ref: #two-spaces-between-period-expression-and-description232150 -Node: Forecasting with periodic transactions232834 -Ref: #forecasting-with-periodic-transactions233133 -Node: Budgeting with periodic transactions235188 -Ref: #budgeting-with-periodic-transactions235421 -Node: Auto postings235830 -Ref: #auto-postings235966 -Node: Auto postings and multiple files238145 -Ref: #auto-postings-and-multiple-files238343 -Node: Auto postings and dates238552 -Ref: #auto-postings-and-dates238820 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions238995 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions239340 -Node: Auto posting tags239682 -Ref: #auto-posting-tags239891 -Node: CSV FORMAT240527 -Ref: #csv-format240655 -Node: Examples243284 -Ref: #examples243387 -Node: Basic243595 -Ref: #basic243697 -Node: Bank of Ireland244239 -Ref: #bank-of-ireland244376 -Node: Amazon245838 -Ref: #amazon245958 -Node: Paypal247677 -Ref: #paypal247773 -Node: CSV rules255417 -Ref: #csv-rules255535 -Node: skip255868 -Ref: #skip255968 -Node: fields list256343 -Ref: #fields-list256482 -Node: field assignment257985 -Ref: #field-assignment258137 -Node: Field names259065 -Ref: #field-names259205 -Node: date field259585 -Ref: #date-field259705 -Node: date2 field259753 -Ref: #date2-field259896 -Node: status field259952 -Ref: #status-field260097 -Node: code field260146 -Ref: #code-field260293 -Node: description field260338 -Ref: #description-field260500 -Node: comment field260559 -Ref: #comment-field260716 -Node: account field260931 -Ref: #account-field261083 -Node: amount field261658 -Ref: #amount-field261809 -Node: currency field263054 -Ref: #currency-field263209 -Node: balance field263466 -Ref: #balance-field263600 -Node: separator263972 -Ref: #separator264104 -Node: if block264644 -Ref: #if-block264771 -Node: Matching the whole record265172 -Ref: #matching-the-whole-record265349 -Node: Matching individual fields266152 -Ref: #matching-individual-fields266358 -Node: Combining matchers266582 -Ref: #combining-matchers266780 -Node: Rules applied on successful match267093 -Ref: #rules-applied-on-successful-match267286 -Node: if table267940 -Ref: #if-table268061 -Node: end269799 -Ref: #end269913 -Node: date-format270137 -Ref: #date-format270271 -Node: decimal-mark271267 -Ref: #decimal-mark271414 -Node: newest-first271753 -Ref: #newest-first271896 -Node: include272579 -Ref: #include272712 -Node: balance-type273156 -Ref: #balance-type273278 -Node: Tips273978 -Ref: #tips274069 -Node: Rapid feedback274368 -Ref: #rapid-feedback274487 -Node: Valid CSV274947 -Ref: #valid-csv275079 -Node: File Extension275271 -Ref: #file-extension275425 -Node: Reading multiple CSV files275854 -Ref: #reading-multiple-csv-files276041 -Node: Valid transactions276282 -Ref: #valid-transactions276462 -Node: Deduplicating importing277090 -Ref: #deduplicating-importing277271 -Node: Setting amounts278304 -Ref: #setting-amounts278461 -Node: Amount signs280902 -Ref: #amount-signs281056 -Node: Setting currency/commodity281743 -Ref: #setting-currencycommodity281931 -Node: Amount decimal places283105 -Ref: #amount-decimal-places283297 -Node: Referencing other fields283609 -Ref: #referencing-other-fields283808 -Node: How CSV rules are evaluated284705 -Ref: #how-csv-rules-are-evaluated284880 -Node: TIMECLOCK FORMAT286331 -Ref: #timeclock-format286471 -Node: TIMEDOT FORMAT288532 -Ref: #timedot-format288670 -Node: COMMON TASKS293232 -Ref: #common-tasks293361 -Node: Getting help293768 -Ref: #getting-help293902 -Node: Constructing command lines294455 -Ref: #constructing-command-lines294649 -Node: Starting a journal file295346 -Ref: #starting-a-journal-file295546 -Node: Setting opening balances296734 -Ref: #setting-opening-balances296932 -Node: Recording transactions300073 -Ref: #recording-transactions300255 -Node: Reconciling300811 -Ref: #reconciling300956 -Node: Reporting303213 -Ref: #reporting303355 -Node: Migrating to a new file307354 -Ref: #migrating-to-a-new-file307504 -Node: LIMITATIONS307803 -Ref: #limitations307931 -Node: TROUBLESHOOTING308674 -Ref: #troubleshooting308789 - -End Tag Table  -Local Variables: -coding: utf-8 -End: +Tag Table: +Node: Top216 +Node: OPTIONS2589 +Ref: #options2690 +Node: General options2832 +Ref: #general-options2957 +Node: Command options6688 +Ref: #command-options6839 +Node: Command arguments7238 +Ref: #command-arguments7396 +Node: Special characters8274 +Ref: #special-characters8437 +Node: Single escaping shell metacharacters8600 +Ref: #single-escaping-shell-metacharacters8841 +Node: Double escaping regular expression metacharacters9445 +Ref: #double-escaping-regular-expression-metacharacters9756 +Node: Triple escaping for add-on commands10282 +Ref: #triple-escaping-for-add-on-commands10542 +Node: Less escaping11188 +Ref: #less-escaping11342 +Node: Unicode characters11668 +Ref: #unicode-characters11833 +Node: Regular expressions13242 +Ref: #regular-expressions13382 +Node: ENVIRONMENT15123 +Ref: #environment15239 +Node: DATA FILES16221 +Ref: #data-files16340 +Node: Data formats16881 +Ref: #data-formats16999 +Node: Multiple files18481 +Ref: #multiple-files18623 +Node: Strict mode19093 +Ref: #strict-mode19208 +Node: TIME PERIODS19917 +Ref: #time-periods20034 +Node: Smart dates20132 +Ref: #smart-dates20258 +Node: Report start & end date21772 +Ref: #report-start-end-date21947 +Node: Report intervals23626 +Ref: #report-intervals23794 +Node: Period expressions25536 +Ref: #period-expressions25676 +Node: Period expressions with a report interval27404 +Ref: #period-expressions-with-a-report-interval27636 +Node: More complex report intervals28731 +Ref: #more-complex-report-intervals28980 +Node: Intervals with custom start date29618 +Ref: #intervals-with-custom-start-date29850 +Node: Periods or dates ?31439 +Ref: #periods-or-dates31641 +Node: Events on multiple weekdays32081 +Ref: #events-on-multiple-weekdays32260 +Node: DEPTH33126 +Ref: #depth33226 +Node: QUERIES33559 +Ref: #queries33658 +Node: Query types34597 +Ref: #query-types34716 +Node: Combining query terms37378 +Ref: #combining-query-terms37553 +Node: Queries and command options38362 +Ref: #queries-and-command-options38565 +Node: Queries and account aliases38814 +Ref: #queries-and-account-aliases39017 +Node: Queries and valuation39137 +Ref: #queries-and-valuation39330 +Node: Querying with account aliases39559 +Ref: #querying-with-account-aliases39768 +Node: Querying with cost or value39898 +Ref: #querying-with-cost-or-value40073 +Node: COSTING40374 +Ref: #costing40477 +Node: VALUATION40750 +Ref: #valuation40858 +Node: -V Value41581 +Ref: #v-value41705 +Node: -X Value in specified commodity41899 +Ref: #x-value-in-specified-commodity42092 +Node: Valuation date42241 +Ref: #valuation-date42403 +Node: Market prices42840 +Ref: #market-prices43021 +Node: --infer-market-price market prices from transactions44203 +Ref: #infer-market-price-market-prices-from-transactions44467 +Node: Valuation commodity45816 +Ref: #valuation-commodity46026 +Node: Simple valuation examples47251 +Ref: #simple-valuation-examples47447 +Node: --value Flexible valuation48109 +Ref: #value-flexible-valuation48311 +Node: More valuation examples49953 +Ref: #more-valuation-examples50154 +Node: Effect of valuation on reports52160 +Ref: #effect-of-valuation-on-reports52342 +Node: PIVOTING60239 +Ref: #pivoting60344 +Node: OUTPUT62023 +Ref: #output62125 +Node: Output destination62197 +Ref: #output-destination62330 +Node: Output format62986 +Ref: #output-format63134 +Node: Commodity styles65297 +Ref: #commodity-styles65424 +Node: COMMANDS65985 +Ref: #commands66097 +Node: accounts69487 +Ref: #accounts69587 +Node: activity70279 +Ref: #activity70391 +Node: add70773 +Ref: #add70876 +Node: aregister73671 +Ref: #aregister73785 +Node: aregister and custom posting dates76144 +Ref: #aregister-and-custom-posting-dates76310 +Node: balance76860 +Ref: #balance76979 +Node: balance features77945 +Ref: #balance-features78085 +Node: Simple balance report79890 +Ref: #simple-balance-report80072 +Node: Filtered balance report81547 +Ref: #filtered-balance-report81734 +Node: List or tree mode82058 +Ref: #list-or-tree-mode82226 +Node: Depth limiting83570 +Ref: #depth-limiting83736 +Node: Dropping top-level accounts84334 +Ref: #dropping-top-level-accounts84536 +Node: Multi-period balance report84844 +Ref: #multi-period-balance-report85048 +Node: Commodity column87327 +Ref: #commodity-column87499 +Node: Sorting by amount90386 +Ref: #sorting-by-amount90544 +Node: Percentages91209 +Ref: #percentages91367 +Node: Balance change end balance92326 +Ref: #balance-change-end-balance92519 +Node: Balance report types93943 +Ref: #balance-report-types94133 +Node: Useful balance reports98504 +Ref: #useful-balance-reports98685 +Node: Budget report99769 +Ref: #budget-report99953 +Node: Budget report start date105158 +Ref: #budget-report-start-date105336 +Node: Budgets and subaccounts106663 +Ref: #budgets-and-subaccounts106870 +Node: Selecting budget goals110257 +Ref: #selecting-budget-goals110429 +Node: Customising single-period balance reports111459 +Ref: #customising-single-period-balance-reports111668 +Node: balancesheet113852 +Ref: #balancesheet113990 +Node: balancesheetequity115288 +Ref: #balancesheetequity115439 +Node: cashflow116819 +Ref: #cashflow116943 +Node: check118089 +Ref: #check118194 +Node: Basic checks118827 +Ref: #basic-checks118945 +Node: Strict checks119497 +Ref: #strict-checks119638 +Node: Other checks120074 +Ref: #other-checks120214 +Node: Custom checks120571 +Ref: #custom-checks120691 +Node: close121109 +Ref: #close121213 +Node: close and prices123299 +Ref: #close-and-prices123428 +Node: close date123822 +Ref: #close-date124006 +Node: Example close asset/liability accounts for file transition124752 +Ref: #example-close-assetliability-accounts-for-file-transition125053 +Node: Hiding opening/closing transactions125915 +Ref: #hiding-openingclosing-transactions126186 +Node: close and balance assertions127567 +Ref: #close-and-balance-assertions127825 +Node: Example close revenue/expense accounts to retained earnings129179 +Ref: #example-close-revenueexpense-accounts-to-retained-earnings129457 +Node: codes130350 +Ref: #codes130460 +Node: commodities131173 +Ref: #commodities131302 +Node: descriptions131384 +Ref: #descriptions131514 +Node: diff131818 +Ref: #diff131926 +Node: files132971 +Ref: #files133073 +Node: help133219 +Ref: #help133321 +Node: import134136 +Ref: #import134252 +Node: Deduplication135114 +Ref: #deduplication135239 +Node: Import testing137127 +Ref: #import-testing137292 +Node: Importing balance assignments137782 +Ref: #importing-balance-assignments137988 +Node: Commodity display styles138635 +Ref: #commodity-display-styles138808 +Node: incomestatement138937 +Ref: #incomestatement139072 +Node: notes140373 +Ref: #notes140488 +Node: payees140855 +Ref: #payees140963 +Node: prices141489 +Ref: #prices141597 +Node: print141936 +Ref: #print142048 +Node: print-unique147358 +Ref: #print-unique147486 +Node: register147772 +Ref: #register147901 +Node: Custom register output152345 +Ref: #custom-register-output152476 +Node: register-match153813 +Ref: #register-match153949 +Node: rewrite154297 +Ref: #rewrite154414 +Node: Re-write rules in a file156320 +Ref: #re-write-rules-in-a-file156483 +Node: Diff output format157633 +Ref: #diff-output-format157816 +Node: rewrite vs print --auto158908 +Ref: #rewrite-vs.-print---auto159068 +Node: roi159618 +Ref: #roi159718 +Node: Spaces and special characters in --inv and --pnl161406 +Ref: #spaces-and-special-characters-in---inv-and---pnl161647 +Node: Semantics of --inv and --pnl162140 +Ref: #semantics-of---inv-and---pnl162379 +Node: IRR and TWR explained164225 +Ref: #irr-and-twr-explained164385 +Node: stats167447 +Ref: #stats167548 +Node: tags168335 +Ref: #tags168435 +Node: test168952 +Ref: #test169068 +Node: About add-on commands169813 +Ref: #about-add-on-commands169950 +Node: JOURNAL FORMAT171083 +Ref: #journal-format171211 +Node: Transactions173400 +Ref: #transactions173515 +Node: Dates174532 +Ref: #dates174648 +Node: Simple dates174713 +Ref: #simple-dates174833 +Node: Secondary dates175340 +Ref: #secondary-dates175488 +Node: Posting dates176822 +Ref: #posting-dates176945 +Node: Status178314 +Ref: #status178424 +Node: Code180129 +Ref: #code180241 +Node: Description180472 +Ref: #description180600 +Node: Payee and note180918 +Ref: #payee-and-note181026 +Node: Comments181360 +Ref: #comments181482 +Node: Tags182675 +Ref: #tags-1182786 +Node: Postings184184 +Ref: #postings184308 +Node: Virtual postings185332 +Ref: #virtual-postings185443 +Node: Account names186745 +Ref: #account-names186882 +Node: Amounts187368 +Ref: #amounts187505 +Node: Decimal marks digit group marks188463 +Ref: #decimal-marks-digit-group-marks188640 +Node: Commodity189512 +Ref: #commodity189672 +Node: Commodity directives190622 +Ref: #commodity-directives190796 +Node: Commodity display style191282 +Ref: #commodity-display-style191461 +Node: Rounding193656 +Ref: #rounding193776 +Node: Transaction prices194186 +Ref: #transaction-prices194352 +Node: Lot prices lot dates196782 +Ref: #lot-prices-lot-dates196965 +Node: Balance assertions197452 +Ref: #balance-assertions197630 +Node: Assertions and ordering198660 +Ref: #assertions-and-ordering198842 +Node: Assertions and included files199539 +Ref: #assertions-and-included-files199776 +Node: Assertions and multiple -f options200107 +Ref: #assertions-and-multiple--f-options200357 +Node: Assertions and commodities200488 +Ref: #assertions-and-commodities200714 +Node: Assertions and prices201869 +Ref: #assertions-and-prices202077 +Node: Assertions and subaccounts202518 +Ref: #assertions-and-subaccounts202741 +Node: Assertions and virtual postings203065 +Ref: #assertions-and-virtual-postings203301 +Node: Assertions and precision203442 +Ref: #assertions-and-precision203629 +Node: Balance assignments203894 +Ref: #balance-assignments204064 +Node: Balance assignments and prices205227 +Ref: #balance-assignments-and-prices205393 +Node: Directives205619 +Ref: #directives205782 +Node: Directives and multiple files211084 +Ref: #directives-and-multiple-files211280 +Node: Comment blocks211942 +Ref: #comment-blocks212119 +Node: Including other files212294 +Ref: #including-other-files212468 +Node: Default year213392 +Ref: #default-year213550 +Node: Declaring payees213957 +Ref: #declaring-payees214123 +Node: Declaring commodities214368 +Ref: #declaring-commodities214549 +Node: Commodity error checking217063 +Ref: #commodity-error-checking217213 +Node: Default commodity217469 +Ref: #default-commodity217649 +Node: Declaring market prices218523 +Ref: #declaring-market-prices218712 +Node: Declaring accounts219524 +Ref: #declaring-accounts219704 +Node: Account error checking220911 +Ref: #account-error-checking221077 +Node: Account comments222254 +Ref: #account-comments222438 +Node: Account subdirectives222864 +Ref: #account-subdirectives223049 +Node: Account types223364 +Ref: #account-types223538 +Node: Declaring account types224195 +Ref: #declaring-account-types224374 +Node: Auto-detected account types225426 +Ref: #auto-detected-account-types225613 +Node: Account display order227625 +Ref: #account-display-order227785 +Node: Rewriting accounts228936 +Ref: #rewriting-accounts229115 +Node: Basic aliases229874 +Ref: #basic-aliases230010 +Node: Regex aliases230752 +Ref: #regex-aliases230914 +Node: Combining aliases231634 +Ref: #combining-aliases231817 +Node: Aliases and multiple files233094 +Ref: #aliases-and-multiple-files233293 +Node: end aliases233874 +Ref: #end-aliases234021 +Node: Default parent account234123 +Ref: #default-parent-account234313 +Node: Periodic transactions235197 +Ref: #periodic-transactions235380 +Node: Periodic rule syntax237297 +Ref: #periodic-rule-syntax237497 +Node: Two spaces between period expression and description!238200 +Ref: #two-spaces-between-period-expression-and-description238513 +Node: Forecasting with periodic transactions239198 +Ref: #forecasting-with-periodic-transactions239497 +Node: Budgeting with periodic transactions242265 +Ref: #budgeting-with-periodic-transactions242498 +Node: Auto postings242905 +Ref: #auto-postings243041 +Node: Auto postings and multiple files245224 +Ref: #auto-postings-and-multiple-files245422 +Node: Auto postings and dates245630 +Ref: #auto-postings-and-dates245898 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions246073 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions246419 +Node: Auto posting tags246764 +Ref: #auto-posting-tags246973 +Node: CSV FORMAT247610 +Ref: #csv-format247738 +Node: Examples250362 +Ref: #examples250465 +Node: Basic250672 +Ref: #basic250774 +Node: Bank of Ireland251318 +Ref: #bank-of-ireland251455 +Node: Amazon252920 +Ref: #amazon253040 +Node: Paypal254761 +Ref: #paypal254857 +Node: CSV rules262505 +Ref: #csv-rules262623 +Node: skip262956 +Ref: #skip263056 +Node: fields list263428 +Ref: #fields-list263567 +Node: field assignment265072 +Ref: #field-assignment265224 +Node: Field names266256 +Ref: #field-names266396 +Node: date field266775 +Ref: #date-field266895 +Node: date2 field266943 +Ref: #date2-field267086 +Node: status field267142 +Ref: #status-field267287 +Node: code field267336 +Ref: #code-field267483 +Node: description field267528 +Ref: #description-field267690 +Node: comment field267749 +Ref: #comment-field267906 +Node: account field268120 +Ref: #account-field268272 +Node: amount field268846 +Ref: #amount-field268997 +Node: currency field270235 +Ref: #currency-field270390 +Node: balance field270646 +Ref: #balance-field270780 +Node: separator271152 +Ref: #separator271284 +Node: if block271826 +Ref: #if-block271953 +Node: Matching the whole record272351 +Ref: #matching-the-whole-record272528 +Node: Matching individual fields273331 +Ref: #matching-individual-fields273537 +Node: Combining matchers273761 +Ref: #combining-matchers273959 +Node: Rules applied on successful match274273 +Ref: #rules-applied-on-successful-match274466 +Node: if table275123 +Ref: #if-table275244 +Node: end276980 +Ref: #end277094 +Node: date-format277318 +Ref: #date-format277452 +Node: decimal-mark278449 +Ref: #decimal-mark278596 +Node: newest-first278933 +Ref: #newest-first279076 +Node: include279759 +Ref: #include279892 +Node: balance-type280334 +Ref: #balance-type280456 +Node: Tips281156 +Ref: #tips281247 +Node: Rapid feedback281546 +Ref: #rapid-feedback281665 +Node: Valid CSV282124 +Ref: #valid-csv282256 +Node: File Extension282448 +Ref: #file-extension282602 +Node: Reading multiple CSV files283031 +Ref: #reading-multiple-csv-files283218 +Node: Valid transactions283458 +Ref: #valid-transactions283638 +Node: Deduplicating importing284266 +Ref: #deduplicating-importing284447 +Node: Setting amounts285479 +Ref: #setting-amounts285636 +Node: Amount signs288077 +Ref: #amount-signs288231 +Node: Setting currency/commodity288918 +Ref: #setting-currencycommodity289106 +Node: Amount decimal places290286 +Ref: #amount-decimal-places290478 +Node: Referencing other fields290790 +Ref: #referencing-other-fields290989 +Node: How CSV rules are evaluated291887 +Ref: #how-csv-rules-are-evaluated292062 +Node: TIMECLOCK FORMAT293511 +Ref: #timeclock-format293651 +Node: TIMEDOT FORMAT295719 +Ref: #timedot-format295857 +Node: COMMON TASKS300416 +Ref: #common-tasks300545 +Node: Getting help300952 +Ref: #getting-help301086 +Node: Constructing command lines301637 +Ref: #constructing-command-lines301831 +Node: Starting a journal file302530 +Ref: #starting-a-journal-file302730 +Node: Setting opening balances303917 +Ref: #setting-opening-balances304115 +Node: Recording transactions307248 +Ref: #recording-transactions307430 +Node: Reconciling307987 +Ref: #reconciling308132 +Node: Reporting310377 +Ref: #reporting310519 +Node: Migrating to a new file314439 +Ref: #migrating-to-a-new-file314589 +Node: LIMITATIONS314887 +Ref: #limitations315015 +Node: TROUBLESHOOTING315756 +Ref: #troubleshooting315871 + +End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 47583bff1..66dc9d241 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -543,6 +543,10 @@ TIME PERIODS 20181232 8 digits with an invalid day gives an error 201801012 9+ digits beginning with a valid YYYYMMDD gives an error + Note "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; those are not affected by --today.) + Report start & end date By default, most hledger reports will show the full span of time repre- @@ -557,8 +561,8 @@ TIME PERIODS Some notes: - o As in Ledger, end dates are exclusive, so you need to write the date - after the last day you want to include. + 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 options, the last (i.e. right-most) option takes precedence. @@ -593,7 +597,15 @@ TIME PERIODS The following "standard" report intervals can be enabled by using their corresponding flag: - -D/--daily, -W/--weekly, -M/--monthly, -Q/--quarterly, -Y/--yearly. + o -D/--daily + + o -W/--weekly + + o -M/--monthly + + o -Q/--quarterly + + o -Y/--yearly These standard intervals always start on natural interval boundaries: eg --weekly starts on mondays, --monthly starts on the first of the @@ -614,18 +626,32 @@ TIME PERIODS requested end date). This is done to ensure "full" first and last sub- periods, so that all subperiods' numbers are comparable. - Period expressions - The -p/--period option accepts period expressions, a shorthand way of - expressing a start date, end date, and/or report interval all at once. + To summarise: - Here's a basic period expression specifying the first quarter of 2009. - Note, hledger always treats start dates as inclusive and end dates as + o In multiperiod reports, all subperiods are forced to be the same + length, to simplify reporting. + + o Reports with the standard --weekly/--monthly/--quarterly/--yearly + intervals are required to start on the first day of a + week/month/quarter/year. We'd like more flexibility here but it + isn't supported yet. + + o --period (below) can specify more complex intervals, starting on any + date. + + Period expressions + The -p/--period option accepts period expressions, a shorthand way of + expressing a start date, end date, and/or report interval all at once. + + Here's a basic period expression specifying the first quarter of 2009. + Note, hledger always treats start dates as inclusive and end dates as exclusive: + -p "from 2009/1/1 to 2009/4/1" - Keywords like "from" and "to" are optional, and so are the spaces, as - long as you don't run two dates together. "to" can also be written as + Keywords like "from" and "to" are optional, and so are the spaces, as + long as you don't run two dates together. "to" can also be written as ".." or "-". These are equivalent to the above: @@ -633,12 +659,11 @@ TIME PERIODS -p2009/1/1to2009/4/1 -p2009/1/1..2009/4/1 - Dates are smart dates, so if the current year is 2009, the above can + Dates are smart dates, so if the current year is 2009, the above can also be written as: -p "1/1 4/1" - -p "january-apr" -p "this year to 4/1" @@ -650,66 +675,75 @@ TIME PERIODS 1, 2009 -p "from 2009/1" the same -p "from 2009" the same - -p "to 2009" everything before january + -p "to 2009" everything before january 1, 2009 - A single date with no "from" or "to" defines both the start and end + A single date with no "from" or "to" defines both the start and end date like so: - -p "2009" the year 2009; equivalent + -p "2009" the year 2009; equivalent to "2009/1/1 to 2010/1/1" - -p "2009/1" the month of jan; equiva- + -p "2009/1" the month of jan; equiva- lent to "2009/1/1 to 2009/2/1" - -p "2009/1/1" just that day; equivalent + -p "2009/1/1" just that day; equivalent to "2009/1/1 to 2009/1/2" Or you can specify a single quarter like so: - -p "2009Q1" first quarter of 2009, + -p "2009Q1" first quarter of 2009, equivalent to "2009/1/1 to 2009/4/1" -p "q4" fourth quarter of the cur- rent year - The argument of -p can also begin with, or be, a report interval - expression. The basic report intervals are daily, weekly, monthly, - quarterly, or yearly, which have the same effect as the -D,-W,-M,-Q, or - -Y flags. Between report interval and start/end dates (if any), the - word in is optional. Examples: + Period expressions with a report interval + -p/--period's argument can also begin with, or entirely consist of, a + report interval. This should be separated from the start/end dates (if + any) by a space, or the word in. The basic intervals (which can also + be written as command line flags) are daily, weekly, monthly, quar- + terly, and yearly. Some examples: -p "weekly from 2009/1/1 to 2009/4/1" -p "monthly in 2008" -p "quarterly" - Note that weekly, monthly, quarterly and yearly intervals will always - start on the first day on week, month, quarter or year accordingly, and - will end on the last day of same period, even if associated period - expression specifies different explicit start and end date. + As mentioned above, the weekly, monthly, quarterly and yearly intervals + require a report start date that is the first day of a week, month, + quarter or year. And, report start/end dates will be expanded if + needed to span a whole number of intervals. For example: - -p "weekly from 2009/1/1 starts on 2008/12/29, closest preceding Mon- + -p "weekly from 2009/1/1 starts on 2008/12/29, closest preceding Mon- to 2009/4/1" day - -p "monthly in starts on 2018/11/01 + -p "monthly in starts on 2018/11/01 2008/11/25" - -p "quarterly from starts on 2009/04/01, ends on 2009/06/30, + -p "quarterly from starts on 2009/04/01, ends on 2009/06/30, 2009-05-05 to 2009-06-01" which are first and last days of Q2 2009 -p "yearly from starts on 2009/01/01, first day of 2009 2009-12-29" - The following more complex report intervals are also supported: - biweekly, fortnightly, bimonthly, every day|week|month|quarter|year, - every N days|weeks|months|quarters|years. + More complex report intervals + Some more complex kinds of interval are also supported in period + expressions: - All of these will start on the first day of the requested period and - end on the last one, as described above. + o biweekly - Examples: + o fortnightly + + o bimonthly + + o every day|week|month|quarter|year + + o every N days|weeks|months|quarters|years + + These too will cause report start/end dates to be expanded, if needed, + to span a whole number of intervals. Examples: -p "bimonthly from 2008" periods will have boundaries on 2008/01/01, @@ -718,56 +752,110 @@ TIME PERIODS -p "every 5 month from periods will have boundaries on 2009/03/01, 2009/03" 2009/08/01, ... - If you want intervals that start on arbitrary day of your choosing and - span a week, month or year, you need to use any of the following: + Intervals with custom start date + All intervals mentioned above are required to start on their natural + calendar boundaries, but the following intervals can start on any date: - every Nth day of week, every WEEKDAYNAME (eg - mon|tue|wed|thu|fri|sat|sun), every Nth day [of month], every Nth WEEK- - DAYNAME [of month], every MM/DD [of year], every Nth MMM [of year], - every MMM Nth [of year]. + Weekly on custom day: + + 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 + insensitive) + + Monthly on custom day: + + o every Nth day [of month] + + o every Nth WEEKDAYNAME [of month] + + Yearly on custom day: + + 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 + name, case insensitive, and day of month number) + + o every DDth MONTHNAME [of year] (equivalent to the above) Examples: -p "every 2nd day of periods will go from Tue to Tue week" + -p "every Tue" same - -p "every 15th day" period boundaries will be on 15th of each + -p "every 15th day" period boundaries will be on 15th of each month - -p "every 2nd Monday" period boundaries will be on second Monday of + -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 Nov - -p "every 5th Nov" same + -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 15th each month (N is exclusive end - date): + 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" + $ hledger balance -H -p "every 16th day" - Group postings from start of wednesday to end of next tuesday (N is - start date and exclusive end date): + 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" + $ hledger register checking -p "every 3rd day of week" + + Periods or dates ? + Report intervals like the above are most often used with -p|--period, + to divide reports into multiple subperiods - each generated date marks + a subperiod boundary. Here, the periods between the dates are what's + important. + + But report intervals can also be used with --forecast to generate + future transactions, or with balance --budget to generate budget goal- + setting transactions. For these, the dates themselves are what mat- + ters. + + Events on multiple weekdays + The every WEEKDAYNAME form has a special variant with multiple day + names, comma-separated. Eg: every mon,thu,sat. Also, weekday and + weekendday are shorthand for mon,tue,wed,thu,fri and sat,sun respec- + tively. + + This form is mainly intended for use with --forecast, to generate peri- + odic transactions on arbitrary days of the week. It may be less useful + with -p, since it divides each week into subperiods of unequal length. + (Because gaps between periods are not allowed; if you'd like to change + this, see #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 + 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 N option (short form: -N), commands like account, bal- - ance and register will show only the uppermost accounts in the account - tree, down to level N. Use this when you want a summary with less - detail. This flag has the same effect as a depth: query argument (so - -2, --depth=2 or depth:2 are equivalent). + With the --depth NUM option (short form: -NUM), commands like account, + balance and register will show only the uppermost accounts in the + account tree, down to level NUM. Use this when you want a summary with + less detail. This flag has the same effect as a depth: query argument: + depth:2, --depth=2 or -2 are equivalent. 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: - o Zero or more space-separated query terms. These are most often + o Zero or more space-separated query terms. These are most often account name substrings: utilities food:groceries - o Terms with spaces or other special characters should be enclosed in + o Terms with spaces or other special characters should be enclosed in quotes: "personal care" @@ -789,16 +877,16 @@ QUERIES prefixed with not: to convert them into a negative match. acct:REGEX, REGEX - Match account names containing this (case insensitive) regular expres- + 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 + ular expression syntax is typically not needed, so usually we just write an account name substring, like expenses or food. amt:N, amt:N, amt:>=N - Match postings with a single-commodity amount equal to, less than, or - greater than N. (Postings with multi-commodity amounts are not tested - and will always match.) The comparison has two modes: if N is preceded - by a + or - sign (or is 0), the two signed numbers are compared. Oth- + Match postings with a single-commodity amount equal to, less than, or + greater than N. (Postings with multi-commodity amounts are not tested + and will always match.) The comparison has two modes: if N is preceded + by a + or - sign (or is 0), the two signed numbers are compared. Oth- erwise, the absolute magnitudes are compared, ignoring sign. code:REGEX @@ -806,10 +894,10 @@ QUERIES cur:REGEX Match postings or transactions including any amounts whose cur- - rency/commodity symbol is fully matched by REGEX. (For a partial - match, use .*REGEX.*). Note, to match special characters which are - regex-significant, you need to escape them with \. And for characters - which are significant to your shell you may need one more level of + rency/commodity symbol is fully matched by REGEX. (For a partial + match, use .*REGEX.*). Note, to match special characters which are + regex-significant, you need to escape them with \. And for characters + which are significant to your shell you may need one more level of escaping. So eg to match the dollar sign: hledger print cur:\\$. @@ -817,17 +905,17 @@ QUERIES Match transaction descriptions. date:PERIODEXPR - Match dates (or with the --date2 flag, secondary dates) within the - specified period. PERIODEXPR is a period expression with no report + Match dates (or with the --date2 flag, secondary dates) within the + specified period. PERIODEXPR is a period expression with no report interval. Examples: date:2016, date:thismonth, date:2/1-2/15, date:2021-07-27..nextquarter. date2:PERIODEXPR - Match secondary dates within the specified period (independent of the + Match secondary dates within the specified period (independent of the --date2 flag). depth:N - Match (or display, depending on command) accounts at or above this + Match (or display, depending on command) accounts at or above this depth. note:REGEX @@ -835,7 +923,7 @@ QUERIES whole description if there's no |). payee:REGEX - Match transaction payee/payer names (the part of the description left + Match transaction payee/payer names (the part of the description left of |, or the whole description if there's no |). real:, real:0 @@ -846,12 +934,12 @@ QUERIES tag:REGEX[=REGEX] Match by tag name, and optionally also by tag value. (To match only by - value, use tag:.=REGEX.) Note that postings also inherit tags from - their transaction, and transactions also acquire tags from their post- + value, use tag:.=REGEX.) Note that postings also inherit tags from + their transaction, and transactions also acquire tags from their post- ings, when querying. (inacct:ACCTNAME - A special query term used automatically in hledger-web only: tells + A special query term used automatically in hledger-web only: tells hledger-web to show the transaction register for an account.) Combining query terms @@ -875,29 +963,29 @@ QUERIES o match all the other terms. - You can do more powerful queries (such as AND-ing two like terms) by - running a first query with print, and piping the result into a second + You can do more powerful queries (such as AND-ing two like terms) by + running a first query with print, and piping the result into a second hledger command. Eg: how much of food expenses was paid with cash ? $ hledger print assets:cash | hledger -f- -I balance expenses:food - If you are interested in full boolean expressions for queries, see + If you are interested in full boolean expressions for queries, see #203. Queries and command options - Some queries can also be expressed as command-line options: depth:2 is + Some queries can also be expressed as command-line options: depth:2 is equivalent to --depth 2, date:2020 is equivalent to -p 2020, etc. When - you mix command options and query arguments, generally the resulting + you mix command options and query arguments, generally the resulting query is their intersection. Queries and account aliases - When account names are rewritten with --alias or alias, acct: will + When account names are rewritten with --alias or alias, acct: will match either the old or the new account name. Queries and valuation - When amounts are converted to other commodities in cost or value - reports, cur: and amt: match the old commodity symbol and the old - amount quantity, not the new ones (except in hledger 1.22.0 where it's + When amounts are converted to other commodities in cost or value + reports, cur: and amt: match the old commodity symbol and the old + amount quantity, not the new ones (except in hledger 1.22.0 where it's reversed, see #1625). Querying with account aliases @@ -905,54 +993,54 @@ QUERIES will match either the old or the new account name. Querying with cost or value - When amounts are converted to other commodities in cost or value - reports, note that cur: matches the new commodity symbol, and not the + When amounts are converted to other commodities in cost or value + reports, note that cur: matches the new commodity symbol, and not the old one, and amt: matches the new quantity, and not the old one. Note: - this changed in hledger 1.22, previously it was the reverse, see the + this changed in hledger 1.22, previously it was the reverse, see the discussion at #1625. COSTING - The -B/--cost flag converts amounts to their cost or sale amount at - transaction time, if they have a transaction price specified. If this - flag is supplied, hledger will perform cost conversion first, and will + The -B/--cost flag converts amounts to their cost or sale amount at + transaction time, if they have a transaction price specified. If this + flag is supplied, hledger will perform cost conversion first, and will apply any market price valuations (if requested) afterwards. VALUATION - Instead of reporting amounts in their original commodity, hledger can + Instead of reporting amounts in their original commodity, hledger can convert them to cost/sale amount (using the conversion rate recorded in - the transaction), and/or to market value (using some market price on a - certain date). This is controlled by the --value=TYPE[,COMMODITY] - option, which will be described below. We also provide the simpler -V + the transaction), and/or to market value (using some market price on a + certain date). This is controlled by the --value=TYPE[,COMMODITY] + option, which will be described below. We also provide the simpler -V and -X COMMODITY options, and often one of these is all you need: -V: Value - The -V/--market flag converts amounts to market value in their default + The -V/--market flag converts amounts to market value in their default valuation commodity, using the market prices in effect on the valuation date(s), if any. More on these in a minute. -X: Value in specified commodity The -X/--exchange=COMM option is like -V, except you tell it which cur- - rency you want to convert to, and it tries to convert everything to + rency you want to convert to, and it tries to convert everything to that. Valuation date - Since market prices can change from day to day, market value reports + Since market prices can change from day to day, market value reports have a valuation date (or more than one), which determines which market prices will be used. For single period reports, if an explicit report end date is specified, - that will be used as the valuation date; otherwise the valuation date + that will be used as the valuation date; otherwise the valuation date is the journal's end date. - For multiperiod reports, each column/period is valued on the last day + For multiperiod reports, each column/period is valued on the last day of the period, by default. Market prices - To convert a commodity A to its market value in another commodity B, - hledger looks for a suitable market price (exchange rate) as follows, + To convert a commodity A to its market value in another commodity B, + hledger looks for a suitable market price (exchange rate) as follows, in this order of preference : - 1. A declared market price or inferred market price: A's latest market + 1. A declared market price or inferred market price: A's latest market price in B on or before the valuation date as declared by a P direc- tive, or (with the --infer-market-price flag) inferred from transac- tion prices. @@ -960,37 +1048,37 @@ VALUATION 2. A reverse market price: the inverse of a declared or inferred market price from B to A. - 3. A forward chain of market prices: a synthetic price formed by com- + 3. A forward chain of market prices: a synthetic price formed by com- bining the shortest chain of "forward" (only 1 above) market prices, leading from A to B. - 4. Any chain of market prices: a chain of any market prices, including - both forward and reverse prices (1 and 2 above), leading from A to + 4. Any chain of market prices: a chain of any market prices, including + both forward and reverse prices (1 and 2 above), leading from A to B. - There is a limit to the length of these price chains; if hledger - reaches that length without finding a complete chain or exhausting all - possibilities, it will give up (with a "gave up" message visible in + There is a limit to the length of these price chains; if hledger + reaches that length without finding a complete chain or exhausting all + possibilities, it will give up (with a "gave up" message visible in --debug=2 output). That limit is currently 1000. - Amounts for which no suitable market price can be found, are not con- + Amounts for which no suitable market price can be found, are not con- verted. --infer-market-price: market prices from transactions Normally, market value in hledger is fully controlled by, and requires, P directives in your journal. Since adding and updating those can be a - chore, and since transactions usually take place at close to market + chore, and since transactions usually take place at close to market value, why not use the recorded transaction prices as additional market prices (as Ledger does) ? We could produce value reports without need- ing P directives at all. Adding the --infer-market-price flag to -V, -X or --value enables this. - So for example, hledger bs -V --infer-market-price will get market - prices both from P directives and from transactions. (And if both + So for example, hledger bs -V --infer-market-price will get market + prices both from P directives and from transactions. (And if both occur on the same day, the P directive takes precedence). There is a downside: value reports can sometimes be affected in confus- - ing/undesired ways by your journal entries. If this happens to you, + ing/undesired ways by your journal entries. If this happens to you, read all of this Valuation section carefully, and try adding --debug or --debug=2 to troubleshoot. @@ -998,43 +1086,43 @@ VALUATION o multicommodity transactions with explicit prices (@/@@) - o multicommodity transactions with implicit prices (no @, two commodi- - ties, unbalanced). (With these, the order of postings matters. + o multicommodity transactions with implicit prices (no @, two commodi- + ties, unbalanced). (With these, the order of postings matters. hledger print -x can be useful for troubleshooting.) - o but not, currently, from "more correct" multicommodity transactions + o but not, currently, from "more correct" multicommodity transactions (no @, multiple commodities, balanced). Valuation commodity When you specify a valuation commodity (-X COMM or --value TYPE,COMM): - hledger will convert all amounts to COMM, wherever it can find a suit- + hledger will convert all amounts to COMM, wherever it can find a suit- able market price (including by reversing or chaining prices). - When you leave the valuation commodity unspecified (-V or --value + When you leave the valuation commodity unspecified (-V or --value TYPE): - For each commodity A, hledger picks a default valuation commodity as + For each commodity A, hledger picks a default valuation commodity as follows, in this order of preference: 1. The price commodity from the latest P-declared market price for A on or before valuation date. 2. The price commodity from the latest P-declared market price for A on - any date. (Allows conversion to proceed when there are inferred + any date. (Allows conversion to proceed when there are inferred prices before the valuation date.) - 3. If there are no P directives at all (any commodity or date) and the + 3. If there are no P directives at all (any commodity or date) and the --infer-market-price flag is used: the price commodity from the lat- est transaction-inferred price for A on or before valuation date. This means: - o If you have P directives, they determine which commodities -V will + o If you have P directives, they determine which commodities -V will convert, and to what. - o If you have no P directives, and use the --infer-market-price flag, + o If you have no P directives, and use the --infer-market-price flag, transaction prices determine it. - Amounts for which no valuation commodity can be found are not con- + Amounts for which no valuation commodity can be found are not con- verted. Simple valuation examples @@ -1061,7 +1149,7 @@ VALUATION $ hledger -f t.j bal -N euros -V -e 2016/11/4 $110.00 assets:euros - What are they worth after 2016/12/21 ? (no report end date specified, + What are they worth after 2016/12/21 ? (no report end date specified, defaults to today) $ hledger -f t.j bal -N euros -V @@ -1081,31 +1169,31 @@ VALUATION The TYPE part selects cost or value and valuation date: --value=then - Convert amounts to their value in the default valuation commod- + Convert amounts to their value in the default valuation commod- ity, using market prices on each posting's date. --value=end - Convert amounts to their value in the default valuation commod- - ity, using market prices on the last day of the report period - (or if unspecified, the journal's end date); or in multiperiod + Convert amounts to their value in the default valuation commod- + ity, using market prices on the last day of the report period + (or if unspecified, the journal's end date); or in multiperiod reports, market prices on the last day of each subperiod. --value=now - Convert amounts to their value in the default valuation commod- - ity using current market prices (as of when report is gener- + Convert amounts to their value in the default valuation commod- + ity using current market prices (as of when report is gener- ated). --value=YYYY-MM-DD - Convert amounts to their value in the default valuation commod- + Convert amounts to their value in the default valuation commod- ity using market prices on this date. To select a different valuation commodity, add the optional ,COMM part: - a comma, then the target commodity's symbol. Eg: --value=now,EUR. + a comma, then the target commodity's symbol. Eg: --value=now,EUR. hledger will do its best to convert amounts to this commodity, deducing market prices as described above. More valuation examples - Here are some examples showing the effect of --value, as seen with + Here are some examples showing the effect of --value, as seen with print: P 2000-01-01 A 1 B @@ -1143,7 +1231,7 @@ VALUATION 2000-02-01 (a) 2 B - With no report period specified, that shows the value as of the last + With no report period specified, that shows the value as of the last day of the journal (2000-03-01): $ hledger -f- print --value=end @@ -1180,7 +1268,7 @@ VALUATION 2000-03-01 (a) 1 B - You may need to explicitly set a commodity's display style, when + You may need to explicitly set a commodity's display style, when reverse prices are used. Eg this output might be surprising: P 2000-01-01 A 2B @@ -1194,10 +1282,10 @@ VALUATION a 0 b 0 - Explanation: because there's no amount or commodity directive specify- - ing a display style for A, 0.5A gets the default style, which shows no + Explanation: because there's no amount or commodity directive specify- + ing a display style for A, 0.5A gets the default style, which shows no decimal digits. Because the displayed amount looks like zero, the com- - modity symbol and minus sign are not displayed either. Adding a com- + modity symbol and minus sign are not displayed either. Adding a com- modity directive sets a more useful display style for A: P 2000-01-01 A 2B @@ -1213,10 +1301,10 @@ VALUATION b -0.50A Effect of valuation on reports - Here is a reference for how valuation is supposed to affect each part - of hledger's reports (and a glossary). (It's wide, you'll have to - scroll sideways.) It may be useful when troubleshooting. If you find - problems, please report them, ideally with a reproducible example. + Here is a reference for how valuation is supposed to affect each part + of hledger's reports (and a glossary). (It's wide, you'll have to + scroll sideways.) It may be useful when troubleshooting. If you find + problems, please report them, ideally with a reproducible example. Related: #329, #1083. @@ -1224,7 +1312,7 @@ VALUATION type --value=now ----------------------------------------------------------------------------------------------- print - posting cost value at value at posting value at value at + posting cost value at value at posting value at value at amounts report end date report or DATE/today or today journal end balance unchanged unchanged unchanged unchanged unchanged @@ -1238,7 +1326,7 @@ VALUATION report or posting was made report or journal journal start start - posting cost value at value at posting value at value at + posting cost value at value at posting value at value at amounts report end date report or DATE/today or today journal end summary post- summarised value at sum of postings value at value at @@ -1249,24 +1337,22 @@ VALUATION total/average of displayed of displayed displayed values of displayed of displayed values values values values - - balance (bs, bse, cf, is) - balance sums of value at value at posting value at value at + balance sums of value at value at posting value at value at changes costs report end date report or DATE/today of - or today of journal end sums of post- + or today of journal end sums of post- sums of of sums of ings postings postings budget like balance like balance like balance like bal- like balance amounts changes changes changes ances changes (--budget) - grand total sum of dis- sum of dis- sum of displayed sum of dis- sum of dis- + grand total sum of dis- sum of dis- sum of displayed sum of dis- sum of dis- played val- played val- valued played val- played values ues ues ues balance (bs, - bse, cf, is) + bse, cf, is) with report interval starting bal- sums of value at sums of values of value at sums of post- @@ -1280,6 +1366,11 @@ VALUATION is, bs postings in period at respec- each period, sums of post- --change, cf period tive posting valued at ings --change) dates period ends + + + + + end balances sums of same as sums of values of period end value at (bal -H, is costs of --value=end postings from balances, DATE/today of --H, bs, cf) postings before period valued at sums of post- @@ -1291,10 +1382,10 @@ VALUATION amounts changes/end changes/end changes/end bal- ances changes/end (--budget) balances balances ances balances row totals, sums, aver- sums, aver- sums, averages of sums, aver- sums, aver- - row averages ages of dis- ages of dis- displayed values ages of dis- ages of dis- + row averages ages of dis- ages of dis- displayed values ages of dis- ages of dis- (-T, -A) played val- played val- played val- played values ues ues ues - column totals sums of dis- sums of dis- sums of displayed sums of dis- sums of dis- + column totals sums of dis- sums of dis- sums of displayed sums of dis- sums of dis- played val- played val- values played val- played values ues ues ues grand total, sum, average sum, average sum, average of sum, average sum, average @@ -1309,43 +1400,43 @@ VALUATION cost calculated using price(s) recorded in the transaction(s). - value market value using available market price declarations, or the + value market value using available market price declarations, or the unchanged amount if no conversion rate can be found. report start - the first day of the report period specified with -b or -p or + the first day of the report period specified with -b or -p or date:, otherwise today. report or journal start - the first day of the report period specified with -b or -p or - date:, otherwise the earliest transaction date in the journal, + the first day of the report period specified with -b or -p or + date:, otherwise the earliest transaction date in the journal, otherwise today. report end - the last day of the report period specified with -e or -p or + the last day of the report period specified with -e or -p or date:, otherwise today. report or journal end - the last day of the report period specified with -e or -p or - date:, otherwise the latest transaction date in the journal, + the last day of the report period specified with -e or -p or + date:, otherwise the latest transaction date in the journal, otherwise today. report interval - a flag (-D/-W/-M/-Q/-Y) or period expression that activates the + a flag (-D/-W/-M/-Q/-Y) or period expression that activates the report's multi-period mode (whether showing one or many subperi- ods). PIVOTING Normally hledger sums amounts, and organizes them in a hierarchy, based - on account name. The --pivot FIELD option causes it to sum and orga- - nize hierarchy based on the value of some other field instead. FIELD + on account name. The --pivot FIELD option causes it to sum and orga- + nize hierarchy based on the value of some other field instead. FIELD can be: code, description, payee, note, or the full name (case insensi- tive) of any tag. As with account names, values containing colon:sepa- rated:parts will be displayed hierarchically in reports. - --pivot is a general option affecting all reports; you can think of + --pivot is a general option affecting all reports; you can think of hledger transforming the journal before any other processing, replacing - every posting's account name with the value of the specified field on + every posting's account name with the value of the specified field on that posting, inheriting it from the transaction or using a blank value if it's not present. @@ -1371,7 +1462,7 @@ PIVOTING -------------------- 0 - One way to show only amounts with a member: value (using a query, + One way to show only amounts with a member: value (using a query, described below): $ hledger balance --pivot member tag:member=. @@ -1379,7 +1470,7 @@ PIVOTING -------------------- -2 EUR - Another way (the acct: query matches against the pivoted "account + Another way (the acct: query matches against the pivoted "account name"): $ hledger balance --pivot member acct:. @@ -1394,22 +1485,22 @@ OUTPUT $ hledger print > foo.txt - Some commands (print, register, stats, the balance commands) also pro- - vide the -o/--output-file option, which does the same thing without + Some commands (print, register, stats, the balance commands) also pro- + vide the -o/--output-file option, which does the same thing without needing the shell. Eg: $ hledger print -o foo.txt $ hledger print -o - # write to stdout (the default) - hledger can optionally produce debug output (if enabled with - --debug=N); this goes to stderr, and is not affected by -o/--output- - file. If you need to capture it, use shell redirects, eg: hledger bal + hledger can optionally produce debug output (if enabled with + --debug=N); this goes to stderr, and is not affected by -o/--output- + file. If you need to capture it, use shell redirects, eg: hledger bal --debug=3 >file 2>&1. Output format Some commands (print, register, the balance commands) offer a choice of output format. In addition to the usual plain text format (txt), there - are CSV (csv), HTML (html), JSON (json) and SQL (sql). This is con- + are CSV (csv), HTML (html), JSON (json) and SQL (sql). This is con- trolled by the -O/--output-format option: $ hledger print -O csv @@ -1424,42 +1515,55 @@ OUTPUT Some notes about JSON output: - o This feature is marked experimental, and not yet much used; you + o This feature is marked experimental, and not yet much used; you should expect our JSON to evolve. Real-world feedback is welcome. - o Our JSON is rather large and verbose, as it is quite a faithful rep- - resentation of hledger's internal data types. To understand the + o Our JSON is rather large and verbose, as it is quite a faithful rep- + resentation 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. - o hledger represents quantities as Decimal values storing up to 255 - significant digits, eg for repeating decimals. Such numbers can + o 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 transaction prices), - and would break most JSON consumers. So in JSON, we show quantities + and would break most JSON consumers. So in JSON, we show quantities as simple Numbers with at most 10 decimal places. We don't limit the - number of integer digits, but that part is under your control. We - hope this approach will not cause problems in practice; if you find + number of integer digits, but that part is under your control. We + hope this approach will not cause problems in practice; if you find otherwise, please let us know. (Cf #1195) Notes about SQL output: - o SQL output is also marked experimental, and much like JSON could use + o SQL output is also marked experimental, and much like JSON could use real-world feedback. o SQL output is expected to work with sqlite, MySQL and PostgreSQL - o SQL output is structured with the expectations that statements will - be executed in the empty database. If you already have tables cre- - ated via SQL output of hledger, you would probably want to either + o SQL output is structured with the expectations that statements will + be executed in the empty database. If you already have tables cre- + ated via SQL output of hledger, you would probably want to either clear tables of existing data (via delete or truncate SQL statements) or drop tables completely as otherwise your postings will be duped. + Commodity styles + The display style of a commodity/currence is inferred according to the + rules described in Commodity display style. The inferred display style + can be overriden by an optional -c/--commodity-style option. For exam- + ple, the following will override the display style for dollars. + + $ hledger print -c '$1.000,0' + + The format specification of the style is identical to the commodity + display style specification for the commodity directive. The command + line option can be supplied repeatedly to override the display style + for multiple commodity/currency symbols. + COMMANDS - hledger provides a number of commands for producing reports and manag- - ing your data. Run hledger with no arguments to list the commands - available, and hledger CMD to run a command. CMD can be the full com- - mand name, or its standard abbreviation shown in the commands list, or + hledger provides a number of commands for producing reports and manag- + ing your data. Run hledger with no arguments to list the commands + available, and hledger CMD to run a command. CMD can be the full com- + mand name, or its standard abbreviation shown in the commands list, or any unambiguous prefix of the name. Eg: hledger bal. Here are the built-in commands, with the most often-used in bold: @@ -1503,7 +1607,7 @@ COMMANDS o activity - show postings-per-interval bar charts - o balance (bal) - show balance changes/end balances/budgets in any + o balance (bal) - show balance changes/end balances/budgets in any accounts o codes - show transaction codes @@ -1526,10 +1630,10 @@ COMMANDS o print-unique - show only transactions with unique descriptions - o register (reg) - show postings in one or more accounts & running + o register (reg) - show postings in one or more accounts & running total - o register-match - show a recent posting that best matches a descrip- + o register-match - show a recent posting that best matches a descrip- tion o stats - show journal statistics @@ -1540,8 +1644,8 @@ COMMANDS Add-on commands: - Programs or scripts named hledger-SOMETHING in your PATH are add-on - commands; these appear in the commands list with a + mark. Two of + Programs or scripts named hledger-SOMETHING in your PATH are add-on + commands; these appear in the commands list with a + mark. Two of these are maintained and released with hledger: o ui - an efficient terminal interface (TUI) for hledger @@ -1552,10 +1656,10 @@ COMMANDS o iadd - a more interactive alternative for the add command - o interest - generates interest transactions according to various + o interest - generates interest transactions according to various schemes - o stockquotes - downloads market prices for your commodities from + o stockquotes - downloads market prices for your commodities from AlphaVantage (experimental) Next, the detailed command docs, in alphabetical order. @@ -1564,13 +1668,13 @@ COMMANDS accounts Show account names. - This command lists account names, either declared with account direc- - tives (--declared), posted to (--used), or both (the default). With - query arguments, only matched account names and account names refer- - enced by matched postings are shown. 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 com- - ponents. Account names can be depth-clipped with depth:N or --depth N + This command lists account names, either declared with account direc- + tives (--declared), posted to (--used), or both (the default). With + query arguments, only matched account names and account names refer- + enced by matched postings are shown. 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 com- + ponents. Account names can be depth-clipped with depth:N or --depth N or -N. Examples: @@ -1589,8 +1693,8 @@ COMMANDS activity Show an ascii barchart of posting counts per interval. - The activity command displays an ascii histogram showing transaction - counts by day, week, month or other reporting interval (by day is the + The activity command displays an ascii histogram showing transaction + counts by day, week, month or other reporting interval (by day is the default). With query arguments, it counts only matched transactions. Examples: @@ -1603,25 +1707,25 @@ COMMANDS add add - Prompt for transactions and add them to the journal. Any arguments + Prompt for transactions and add them to the journal. Any arguments will be used as default inputs for the first N prompts. - Many hledger users edit their journals directly with a text editor, or - generate them from CSV. For more interactive data entry, there is the - add command, which prompts interactively on the console for new trans- + Many hledger users edit their journals directly with a text editor, or + generate them from CSV. For more interactive data entry, there is the + add command, which prompts interactively on the console for new trans- actions, and appends them to the journal file (if there are multiple -f - FILE options, the first file is used.) Existing transactions are not - changed. This is the only hledger command that writes to the journal + FILE options, the first file is used.) Existing transactions are not + changed. This is the only hledger command that writes to the journal file. To use it, just run hledger add and follow the prompts. You can add as - many transactions as you like; when you are finished, enter . or press + many transactions as you like; when you are finished, enter . or press control-d or control-c to exit. Features: - o add tries to provide useful defaults, using the most similar (by - description) recent transaction (filtered by the query, if any) as a + o add tries to provide useful defaults, using the most similar (by + description) recent transaction (filtered by the query, if any) as a template. o You can also set the initial defaults with command line arguments. @@ -1629,10 +1733,10 @@ COMMANDS o Readline-style edit keys can be used during data entry. o The tab key will auto-complete whenever possible - accounts, descrip- - tions, dates (yesterday, today, tomorrow). If the input area is + tions, dates (yesterday, today, tomorrow). If the input area is empty, it will insert the default value. - o If the journal defines a default commodity, it will be added to any + o If the journal defines a default commodity, it will be added to any bare numbers entered. o A parenthesised transaction code may be entered following a date. @@ -1641,7 +1745,7 @@ COMMANDS o If you make a mistake, enter < at any prompt to go one step backward. - o Input prompts are displayed in a different colour when the terminal + o Input prompts are displayed in a different colour when the terminal supports it. Example (see the tutorial for a detailed explanation): @@ -1671,91 +1775,91 @@ COMMANDS Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ - On Microsoft Windows, the add command makes sure that no part of the + On Microsoft Windows, the add command makes sure that no part of the file path ends with a period, as that would cause problems (#1056). aregister aregister, areg - Show the transactions and running historical balance of a single + Show the transactions and running historical balance of a single account, with each transaction displayed as one line. aregister shows the overall transactions affecting a particular account - (and any subaccounts). Each report line represents one transaction in - this account. Transactions before the report start date are always + (and any subaccounts). Each report line represents one transaction in + this account. Transactions before the report start date are always included in the running balance (--historical mode is always on). - This is a more "real world", bank-like view than the register command - (which shows individual postings, possibly from multiple accounts, not + This is a more "real world", bank-like view than the register command + (which shows individual postings, possibly from multiple accounts, not necessarily in historical mode). As a quick rule of thumb: - use areg- ister for reviewing and reconciling real-world asset/liability accounts - use register for reviewing detailed revenues/expenses. - aregister requires one argument: the account to report on. You can - write either the full account name, or a case-insensitive regular - expression which will select the alphabetically first matched account. - (Eg if you have assets:aaa:checking and assets:bbb:checking accounts, + aregister requires one argument: the account to report on. You can + write either the full account name, or a case-insensitive regular + expression which will select the alphabetically first matched account. + (Eg if you have assets:aaa:checking and assets:bbb:checking accounts, hledger areg checking would select assets:aaa:checking.) - Transactions involving subaccounts of this account will also be shown. - aregister ignores depth limits, so its final total will always match a + Transactions involving subaccounts of this account will also be shown. + aregister ignores depth limits, so its final total will always match a balance report with similar arguments. - Any additional arguments form a query which will filter the transac- + Any additional arguments form a query which will filter the transac- tions shown. Note some queries will disturb the running balance, caus- ing it to be different from the account's real-world running balance. - An example: this shows the transactions and historical running balance + An example: this shows the transactions and historical running balance during july, in the first account whose name contains "checking": $ hledger areg checking date:jul Each aregister line item shows: - o the transaction's date (or the relevant posting's date if different, + o the transaction's date (or the relevant posting's date if different, see below) - o the names of all the other account(s) involved in this transaction + o the names of all the other account(s) involved in this transaction (probably abbreviated) o the total change to this account's balance from this transaction o the account's historical running balance after this transaction. - Transactions making a net change of zero are not shown by default; add + Transactions making a net change of zero are not shown by default; add the -E/--empty flag to show them. - This command also supports the output destination and output format + This command also supports the output destination and output format options. The output formats supported are txt, csv, and json. aregister and custom posting dates - Transactions whose date is outside the report period can still be - shown, if they have a posting to this account dated inside the report - period. (And in this case it's the posting date that is shown.) This + Transactions whose date is outside the report period can still be + shown, if they have a posting to this account dated inside the report + period. (And in this case it's the posting date that is shown.) This ensures that aregister can show an accurate historical running balance, matching the one shown by register -H with the same arguments. - To filter strictly by transaction date instead, add the --txn-dates - flag. If you use this flag and some of your postings have custom + To filter strictly by transaction date instead, add the --txn-dates + flag. If you use this flag and some of your postings have custom dates, it's probably best to assume the running balance is wrong. balance balance, bal Show accounts and their balances. - balance is one of hledger's oldest and most versatile commands, for - listing account balances, balance changes, values, value changes and + balance is one of hledger's oldest and most versatile commands, for + listing account balances, balance changes, values, value changes and more, during one time period or many. Generally it shows a table, with rows representing accounts, and columns representing periods. - Note there are some higher-level variants of the balance command with - convenient defaults, which can be simpler to use: balancesheet, bal- + Note there are some higher-level variants of the balance command with + convenient defaults, which can be simpler to use: balancesheet, bal- ancesheetequity, cashflow and incomestatement. When you need more con- trol, then use balance. balance features - Here's a quick overview of the balance command's features, followed by - more detailed descriptions and examples. Many of these work with the + Here's a quick overview of the balance command's features, followed by + more detailed descriptions and examples. Many of these work with the higher-level commands as well. balance can show.. @@ -1776,6 +1880,8 @@ COMMANDS o or change of balance values (--valuechange) + o or unrealised capital gain/loss (--gain) + ..in.. o one time period (the whole journal period by default) @@ -1804,7 +1910,7 @@ COMMANDS ..with.. - o totals (-T), averages (-A), percentages (-%), inverted sign + o totals (-T), averages (-A), percentages (-%), inverted sign (--invert) o rows and columns swapped (--transpose) @@ -1817,21 +1923,21 @@ COMMANDS umn) This command supports the output destination and output format options, - with output formats txt, csv, json, and (multi-period reports only:) - html. In txt output in a colour-supporting terminal, negative amounts + with output formats txt, csv, json, and (multi-period reports only:) + html. In txt output in a colour-supporting terminal, negative amounts are shown in red. Simple balance report - With no arguments, balance shows a list of all accounts and their - change of balance - ie, the sum of posting amounts, both inflows and - outflows - during the entire period of the journal. For real-world - accounts, this should also match their end balance at the end of the + With no arguments, balance shows a list of all accounts and their + change of balance - ie, the sum of posting amounts, both inflows and + outflows - during the entire period of the journal. For real-world + accounts, this should also match their end balance at the end of the journal period (more on this below). - Accounts are sorted by declaration order if any, and then alphabeti- - cally by account name. For instance, using examples/sample.journal: + Accounts are sorted by declaration order if any, and then alphabeti- + cally by account name. For instance (using examples/sample.journal): - $ hledger bal + $ hledger -f examples/sample.journal bal $1 assets:bank:saving $-2 assets:cash $1 expenses:food @@ -1843,10 +1949,10 @@ COMMANDS 0 Accounts with a zero balance (and no non-zero subaccounts, in tree mode - - see below) are hidden by default. Use -E/--empty to show them + - see below) are hidden by default. Use -E/--empty to show them (revealing assets:bank:checking here): - $ hledger -f examples/sample.journal bal -E + $ hledger -f examples/sample.journal bal -E 0 assets:bank:checking $1 assets:bank:saving $-2 assets:cash @@ -1858,27 +1964,27 @@ COMMANDS -------------------- 0 - The total of the amounts displayed is shown as the last line, unless + The total of the amounts displayed is shown as the last line, unless -N/--no-total is used. Filtered balance report - You can show fewer accounts, a different time period, totals from + You can show fewer accounts, a different time period, totals from cleared transactions only, etc. by using query arguments or options to limit the postings being matched. Eg: - $ hledger bal --cleared assets date:200806 + $ hledger -f examples/sample.journal bal --cleared assets date:200806 $-2 assets:cash -------------------- $-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 balance + $ hledger -f examples/sample.journal balance $-1 assets $1 bank:saving $-2 cash @@ -1895,36 +2001,42 @@ 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:N query, or --depth N option, or just -N, balance reports - will show accounts only to the specified depth, hiding the deeper sub- - accounts. Account balances at the depth limit always include the bal- - ances from any hidden subaccounts (even in list mode). This can be - useful for getting an overview. Eg, limiting to depth 1: + 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. - $ hledger balance -N -1 + 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 $-1 assets $2 expenses $-2 income $1 liabilities + -------------------- + 0 - You can also hide top-level account name parts, using --drop N. This - can be useful for hiding repetitive top-level account names: + Dropping top-level accounts + 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: - $ hledger bal expenses --drop 1 + $ hledger -f examples/sample.journal bal expenses --drop 1 $1 food $1 supplies -------------------- @@ -1937,7 +2049,7 @@ COMMANDS ance shows a tabular report, with columns representing successive time periods (and a title): - $ hledger balance --quarterly income expenses -E + $ hledger -f examples/sample.journal bal --quarterly income expenses -E Balance changes in 2008: || 2008q1 2008q2 2008q3 2008q4 @@ -2065,7 +2177,7 @@ COMMANDS With -%/--percent, balance reports show each account's value expressed as a percentage of the (column) total: - $ hledger bal expenses -Q -% + $ hledger -f examples/sample.journal bal expenses -Q -% Balance changes in 2008: || 2008Q1 2008Q2 2008Q3 2008Q4 @@ -2142,7 +2254,11 @@ COMMANDS o --budget : like --sum but also show a goal amount o --valuechange : show the change in period-end historical balance val- - ues + ues (caused by deposits, withdrawals, and/or market price fluctua- + tions) + + o --gain : show the unrealised capital gain/loss, (the current valued + balance minus each amount's original cost) Accumulation type: Which postings should be included in each cell's calculation. It is @@ -2172,7 +2288,7 @@ COMMANDS o --value=then[,COMM] : show value at transaction dates o --value=end[,COMM] : show value at period end date(s) (default with - --valuechange) + --valuechange, --gain) o --value=now[,COMM] : show value at today's date @@ -2511,7 +2627,7 @@ COMMANDS can use --format FMT to customise the format and content of each line. Eg: - $ hledger balance --format "%20(account) %12(total)" + $ hledger -f examples/sample.journal balance --format "%20(account) %12(total)" assets $-1 bank:saving $1 cash $-2 @@ -2818,17 +2934,20 @@ COMMANDS Unless you are running close on exactly the first day of the new period, you'll want to override the closing date. This is done by - specifying a report period, where "last day of the report period" will - be the closing date. The opening date is always the following day. So - to close on 2020-12-31 and open on 2021-01-01, any of these work + specifying a report end date, where "last day of the report period" + will be the closing date. The opening date is always the following + day. So to close on (end of) 2020-12-31 and open on (start of) + 2021-01-01, any of these will work: - o -p 2020 - o date:2020 - - o -e 2021-01-01 (remember -e specifies an exclusive end date) - - o -e 2021 + end date argument explanation + ----------------------------------------------- + -e 2021-01-01 end dates are exclusive + -e 2021 equivalent, per smart + dates + -p 2020 equivalent, the period's + begin date is ignored + date:2020 equivalent query Example: close asset/liability accounts for file transition Carrying asset/liability balances from 2020.journal into a new file for @@ -2852,33 +2971,33 @@ COMMANDS Hiding opening/closing transactions Although the closing/opening transactions cancel out, they will be vis- - ible in reports like print and register, creating some visual clutter. + ible in reports like print and register, creating some visual clutter. You can exclude them all with a query, like: $ hledger print not:desc:'opening|closing' # less typing $ hledger print not:'equity:opening/closing balances' # more precise - But when reporting on multiple files, this can get a bit tricky; you + But when reporting on multiple files, this can get a bit tricky; you may need to keep the earliest opening balances, for a historical regis- - ter report; or you may need to suppress a closing transaction, to see - year-end balances. If you find yourself needing more precise queries, - here's one solution: add more easily-matched tags to opening/closing + ter report; or you may need to suppress a closing transaction, to see + year-end balances. If you find yourself needing more precise queries, + here's one solution: add more easily-matched tags to opening/closing transactions, like this: ; 2019.journal 2019-01-01 opening balances ; earliest opening txn, no tag here ... - 2019-12-31 closing balances ; close:2019 + 2019-12-31 closing balances ; clopen:2020 ... ; 2020.journal - 2020-01-01 opening balances ; open:2020 + 2020-01-01 opening balances ; clopen:2020 ... - 2020-12-31 closing balances ; close:2020 + 2020-12-31 closing balances ; clopen:2021 ... ; 2021.journal - 2021-01-01 opening balances ; open:2021 + 2021-01-01 opening balances ; clopen:2021 ... Now with @@ -2890,28 +3009,25 @@ COMMANDS you could do eg: - $ hledger -f all.journal reg -H checking not:tag:'open|close' + $ hledger -f all.journal reg -H checking not:tag:clopen # all years checking register, hiding non-essential opening/closing txns - $ hledger -f all.journal bs -p 2020 not:tag:close=2020 + $ hledger -f all.journal bs -p 2020 not:tag:clopen=2020 # 2020 year end balances, suppressing 2020 closing txn - $ hledger -f 2020.journal bs not:tag:close - # 2020 year end balances, easier case - close and balance assertions - The closing and opening transactions will include balance assertions, - verifying that the accounts have first been reset to zero and then - restored to their previous balance. These provide valuable error - checking, alerting you when things get out of line, but you can ignore + The closing and opening transactions will include balance assertions, + verifying that the accounts have first been reset to zero and then + restored to their previous balance. These provide valuable error + checking, alerting you when things get out of line, but you can ignore them temporarily with -I or just remove them if you prefer. You probably shouldn't use status or realness filters (like -C or -R or status:) with close, or the generated balance assertions will depend on - these flags. Likewise, if you run this command with --auto, the bal- + these flags. Likewise, if you run this command with --auto, the bal- ance assertions would probably always require --auto. - Multi-day transactions (where some postings have a different date) + Multi-day transactions (where some postings have a different date) break the balance assertions, because the money is temporarily "invisi- ble" while in transit: @@ -2919,8 +3035,8 @@ COMMANDS expenses:food 5 assets:bank:checking -5 ; date: 2021/1/2 - To fix the assertions, you can add a temporary account to track such - in-transit money (splitting the multi-day transaction into two single- + To fix the assertions, you can add a temporary account to track such + in-transit money (splitting the multi-day transaction into two single- day transactions): ; in 2020.journal: @@ -2934,25 +3050,30 @@ COMMANDS assets:bank:checking Example: close revenue/expense accounts to retained earnings - Here, the opening transaction is supressed with --close, as it's proba- - bly not needed. Also you'll want to use a different equity account - name: + For this, use --close to suppress the opening transaction, as it's not + needed. Also you'll want to change the equity account name to your + equivalent of "equity:retained earnings". - $ hledger close -f 2021.journal -p 2021Q1 --close --close-acct='equity:retained earnings' revenues expenses >> 2021.journal - # close 2021 first quarter revenues/expenses + Closing 2021's first quarter revenues/expenses: - Or, operating on the default journal: + $ hledger close -f 2021.journal --close revenues expenses -p 2021Q1 \ + --close-acct='equity:retained earnings' >> 2021.journal - $ hledger close -p Q1 --close --close-acct='equity:retained earnings' revenues expenses >> $LEDGER_FILE - # close current year's first quarter revenues/expenses + The same, using the default journal and current year: - Now, eg: + $ hledger close --close revenues expenses -p Q1 \ + --close-acct='equity:retained earnings' >> $LEDGER_FILE + + Now, the first quarter's balance sheet should show a zero (unless you + are using @/@@ notation without equity postings): $ hledger bse -p Q1 - # Q1 full balance sheet, total should be zero - $ hledger is -p Q1 not:'retained earnings' - # Q1 income statement, must suppress the closing txn + And we must suppress the closing transaction to see the first quarter's + income statement (using the description; not:'retained earnings' won't + work here): + + $ hledger is -p Q1 not:desc:'closing balances' codes codes @@ -3051,9 +3172,13 @@ COMMANDS help help Show the hledger user manual in one of several formats, optionally - positioned at a given TOPIC (if possible). TOPIC is any heading, or - heading prefix, in the manual. Some examples: commands, print, 'auto - postings', periodic. + positioned at a given TOPIC (if possible). + + TOPIC is any heading in the manual, or the start of any heading (but + not the middle). It is case insensitive. + + Some examples: commands, print, forecast, "auto postings", "commodity + column". This command shows the user manual built in to this hledger version. It can be useful if the correct version of the hledger manual, or the @@ -4377,19 +4502,22 @@ JOURNAL FORMAT commodity 1000.00000000 BTC commodity 1 000. + The inferred commodity style can be overridden by supplying a command + line option. + Rounding Amounts are stored internally as decimal numbers with up to 255 decimal - places, and displayed with the number of decimal places specified by - the commodity display style. Note, hledger uses banker's rounding: it - rounds to the nearest even number, eg 0.5 displayed with zero decimal - places is "0"). (Guaranteed since hledger 1.17.1; in older versions + places, and displayed with the number of decimal places specified by + the commodity display style. Note, hledger uses banker's rounding: it + rounds to the nearest even number, eg 0.5 displayed with zero decimal + places is "0"). (Guaranteed since hledger 1.17.1; in older versions this could vary if hledger was built with Decimal < 0.5.1.) Transaction prices Within a transaction, you can note an amount's price in another commod- - ity. This can be used to document the cost (in a purchase) or selling - price (in a sale). For example, transaction prices are useful to - record purchases of a foreign currency. Note transaction prices are + ity. This can be used to document the cost (in a purchase) or selling + price (in a sale). For example, transaction prices are useful to + record purchases of a foreign currency. Note transaction prices are fixed at the time of the transaction, and do not change over time. See also market prices, which represent prevailing exchange rates on a cer- tain date. @@ -4415,14 +4543,14 @@ JOURNAL FORMAT assets:euros EUR100 ; one hundred euros purchased assets:dollars $-135 ; for $135 - 4. Like 1, but the @ is parenthesised, i.e. (@); this is for compati- - bility with Ledger journals (Virtual posting costs), and is equiva- + 4. Like 1, but the @ is parenthesised, i.e. (@); this is for compati- + bility with Ledger journals (Virtual posting costs), and is equiva- lent to 1 in hledger. 5. Like 2, but as in 4 the @@ is parenthesised, i.e. (@@); in hledger, this is equivalent to 2. - Use the -B/--cost flag to convert amounts to their transaction price's + Use the -B/--cost flag to convert amounts to their transaction price's commodity, if any. (mnemonic: "B" is from "cost Basis", as in Ledger). Eg here is how -B affects the balance report for the example above: @@ -4433,8 +4561,8 @@ JOURNAL FORMAT $-135 assets:dollars $135 assets:euros # <- the euros' cost - Note -B is sensitive to the order of postings when a transaction price - is inferred: the inferred price will be in the commodity of the last + Note -B is sensitive to the order of postings when a transaction price + is inferred: the inferred price will be in the commodity of the last amount. So if example 3's postings are reversed, while the transaction is equivalent, -B shows something different: @@ -4447,18 +4575,18 @@ JOURNAL FORMAT EUR100 assets:euros Lot prices, lot dates - Ledger allows another kind of price, lot price (four variants: {UNIT- + Ledger allows another kind of price, lot price (four variants: {UNIT- PRICE}, {{TOTALPRICE}}, {=FIXEDUNITPRICE}, {{=FIXEDTOTALPRICE}}), and/or a lot date ([DATE]) to be specified. These are normally used to - select a lot when selling investments. hledger will parse these, for - compatibility with Ledger journals, but currently ignores them. A - transaction price, lot price and/or lot date may appear in any order, + select a lot when selling investments. hledger will parse these, for + compatibility with Ledger journals, but currently ignores them. A + transaction price, lot price and/or lot date may appear in any order, after the posting amount and before the balance assertion if any. Balance assertions - hledger supports Ledger-style balance assertions in journal files. - These look like, for example, = EXPECTEDBALANCE following a posting's - amount. Eg here we assert the expected dollar balance in accounts a + hledger supports Ledger-style balance assertions in journal files. + These look like, for example, = EXPECTEDBALANCE following a posting's + amount. Eg here we assert the expected dollar balance in accounts a and b after each posting: 2013/1/1 @@ -4470,32 +4598,32 @@ JOURNAL FORMAT b $-1 =$-2 After reading a journal file, hledger will check all balance assertions - and report an error if any of them fail. Balance assertions can pro- - tect you from, eg, inadvertently disrupting reconciled balances while - cleaning up old entries. You can disable them temporarily with the + and report an error if any of them fail. Balance assertions can pro- + tect you from, eg, inadvertently disrupting reconciled balances while + cleaning up old entries. You can disable them temporarily with the -I/--ignore-assertions flag, which can be useful for troubleshooting or - for reading Ledger files. (Note: this flag currently does not disable + for reading Ledger files. (Note: this flag currently does not disable balance assignments, below). Assertions and ordering - hledger sorts an account's postings and assertions first by date and - then (for postings on the same day) by parse order. Note this is dif- + hledger sorts an account's postings and assertions first by date and + then (for postings on the same day) by parse order. Note this is dif- ferent from Ledger, which sorts assertions only by parse order. (Also, - Ledger assertions do not see the accumulated effect of repeated post- + Ledger assertions do not see the accumulated effect of repeated post- ings to the same account within a transaction.) So, hledger balance assertions keep working if you reorder differently- - dated transactions within the journal. But if you reorder same-dated - transactions or postings, assertions might break and require updating. + dated transactions within the journal. But if you reorder same-dated + transactions or postings, assertions might break and require updating. This order dependence does bring an advantage: precise control over the order of postings and assertions within a day, so you can assert intra- day balances. Assertions and included files - With included files, things are a little more complicated. Including - preserves the ordering of postings and assertions. If you have multi- - ple postings to an account on the same day, split across different - files, and you also want to assert the account's balance on the same + With included files, things are a little more complicated. Including + preserves the ordering of postings and assertions. If you have multi- + ple postings to an account on the same day, split across different + files, and you also want to assert the account's balance on the same day, you'll have to put the assertion in the right file. Assertions and multiple -f options @@ -4503,15 +4631,15 @@ JOURNAL FORMAT -f options. Use include or concatenate the files instead. 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 unasserted commodities in the account (or, that their balance is 0). @@ -4531,7 +4659,7 @@ JOURNAL FORMAT a 0 == $1 It's not yet possible to make a complete assertion about a balance that - has multiple commodities. One workaround is to isolate each commodity + has multiple commodities. One workaround is to isolate each commodity into its own subaccount: 2013/1/1 @@ -4545,21 +4673,21 @@ JOURNAL FORMAT a:euro 0 == 1EUR Assertions and prices - Balance assertions ignore transaction prices, and should normally be + Balance assertions ignore transaction prices, and should normally be written without one: 2019/1/1 (a) $1 @ EUR1 = $1 - We do allow prices to be written there, however, and print shows them, - even though they don't affect whether the assertion passes or fails. - This is for backward compatibility (hledger's close command used to - generate balance assertions with prices), and because balance assign- + We do allow prices to be written there, however, and print shows them, + even though they don't affect whether the assertion passes or fails. + This is for backward compatibility (hledger's close command used to + generate balance assertions with prices), and because balance assign- ments do use them (see below). Assertions and subaccounts - The balance assertions above (= and ==) do not count the balance from - subaccounts; they check the account's exclusive balance only. You can + The balance assertions above (= and ==) do not count the balance from + subaccounts; they check the account's exclusive balance only. You can assert the balance including subaccounts by writing =* or ==*, eg: 2019/1/1 @@ -4573,16 +4701,16 @@ JOURNAL FORMAT tual. They are not affected by the --real/-R flag or real: query. Assertions and precision - Balance assertions compare the exactly calculated amounts, which are - not always what is shown by reports. Eg a commodity directive may - limit the display precision, but this will not affect balance asser- + Balance assertions compare the exactly calculated amounts, which are + not always what is shown by reports. Eg a commodity directive may + limit the display precision, but this will not affect balance asser- tions. Balance assertion failure messages show exact amounts. Balance assignments - Ledger-style balance assignments are also supported. These are like - balance assertions, but with no posting amount on the left side of the - equals sign; instead it is calculated automatically so as to satisfy - the assertion. This can be a convenience during data entry, eg when + Ledger-style balance assignments are also supported. These are like + balance assertions, but with no posting amount on the left side of the + equals sign; instead it is calculated automatically so as to satisfy + the assertion. This can be a convenience during data entry, eg when setting opening balances: ; starting a new journal, set asset account balances @@ -4600,14 +4728,14 @@ JOURNAL FORMAT expenses:misc The calculated amount depends on the account's balance in the commodity - at that point (which depends on the previously-dated postings of the - commodity to that account since the last balance assertion or assign- + at that point (which depends on the previously-dated postings of the + commodity to that account since the last balance assertion or assign- ment). Note that using balance assignments makes your journal a little less explicit; to know the exact amount posted, you have to run hledger or do the calculations yourself, instead of just reading it. Balance assignments and prices - A transaction price in a balance assignment will cause the calculated + A transaction price in a balance assignment will cause the calculated amount to have that price attached: 2019/1/1 @@ -4618,51 +4746,53 @@ JOURNAL FORMAT (a) $1 @ EUR2 = $1 @ EUR2 Directives - A directive is a line in the journal beginning with a special keyword, + A directive is a line in the journal beginning with a special keyword, that influences how the journal is processed. hledger's directives are based on a subset of Ledger's, but there are many differences (and also some differences between hledger versions). Directives' behaviour and interactions can get a little bit complex, so - here is a table summarising the directives and their effects, with + here is a table summarising the directives and their effects, with links to more detailed docs. - direc- end subdi- purpose can affect (as of + + + direc- end subdi- purpose can affect (as of tive directive rec- 2018/06) tives ------------------------------------------------------------------------------------ - account any document account names, all entries in all - text declare account types & dis- files, before or + account any document account names, all entries in all + text declare account types & dis- files, before or play order after alias end rewrite account names following entries - aliases until end of cur- + aliases until end of cur- rent file or end directive - apply end apply prepend a common parent to following entries - account account account names until end of cur- + apply end apply prepend a common parent to following entries + account account account names until end of cur- rent file or end directive comment end com- ignore part of journal following entries - ment until end of cur- + ment until end of cur- rent file or end directive - commod- format declare a commodity and its number notation: + commod- format declare a commodity and its number notation: ity number notation & display following entries - style until end of cur- - rent file; display + style until end of cur- + rent file; display style: amounts of that commodity in reports - D declare a commodity to be default commodity: + D declare a commodity to be default commodity: used for commodityless following commod- - amounts, and its number ityless entries - notation & display style until end of cur- + amounts, and its number ityless entries + notation & display style until end of cur- rent file; number notation: following entries in that commodity until end - of current file; + of current file; display style: amounts of that commodity in @@ -4670,17 +4800,17 @@ JOURNAL FORMAT include include entries/directives what the included from another file directives affect payee declare a payee name following entries - until end of cur- + until end of cur- rent file P declare a market price for a amounts of that commodity commodity in reports, when -V is used - Y declare a year for yearless following entries - dates until end of cur- + Y declare a year for yearless following entries + dates until end of cur- rent file - = declare an auto posting all entries in par- - rule, adding postings to ent/current/child + = declare an auto posting all entries in par- + rule, adding postings to ent/current/child other transactions files (but not sib- ling files, see #1212) @@ -4688,53 +4818,53 @@ JOURNAL FORMAT And some definitions: - subdi- optional indented directive line immediately following a parent + subdi- optional indented directive line immediately following a parent rec- directive tive number how to interpret numbers when parsing journal entries (the iden- - nota- tity of the decimal separator character). (Currently each com- + nota- tity of the decimal separator character). (Currently each com- tion modity can have its own notation, even in the same file.) - dis- how to display amounts of a commodity in reports (symbol side + dis- how to display amounts of a commodity in reports (symbol side play and spacing, digit groups, decimal separator, decimal places) style - direc- which entries and (when there are multiple files) which files + direc- which entries and (when there are multiple files) which files tive are affected by a directive scope As you can see, directives vary in which journal entries and files they - affect, and whether they are focussed on input (parsing) or output + affect, and whether they are focussed on input (parsing) or output (reports). Some directives have multiple effects. Directives and multiple files - If you use multiple -f/--file options, or the include directive, - hledger will process multiple input files. But note that directives + If you use multiple -f/--file options, or the include directive, + hledger will process multiple input files. But note that directives which affect input (see above) typically last only until the end of the file in which they occur. This may seem inconvenient, but it's intentional; it makes reports sta- - ble and deterministic, independent of the order of input. Otherwise - you could see different numbers if you happened to write -f options in - a different order, or if you moved includes around while cleaning up + ble and deterministic, independent of the order of input. Otherwise + you could see different numbers if you happened to write -f options in + a different order, or if you moved includes around while cleaning up your files. - It can be surprising though; for example, it means that alias direc- + It can be surprising though; for example, it means that alias direc- tives do not affect parent or sibling files (see below). Comment blocks - A line containing just comment starts a commented region of the file, + A line containing just comment starts a commented region of the file, and a line containing just end comment (or the end of the current file) ends it. See also comments. Including other files - You can pull in the content of additional files by writing an include + You can pull in the content of additional files by writing an include directive, like this: include FILEPATH - Only journal files can include, and only journal, timeclock or timedot + Only journal files can include, and only journal, timeclock or timedot files can be included (not CSV files, currently). - If the file path does not begin with a slash, it is relative to the + If the file path does not begin with a slash, it is relative to the current file's folder. A tilde means home directory, eg: include ~/main.journal. @@ -4742,18 +4872,18 @@ JOURNAL FORMAT The path may contain glob patterns to match multiple files, eg: include *.journal. - There is limited support for recursive wildcards: **/ (the slash is - required) matches 0 or more subdirectories. It's not super convenient - since you have to avoid include cycles and including directories, but + There is limited support for recursive wildcards: **/ (the slash is + required) matches 0 or more subdirectories. It's not super convenient + since you have to avoid include cycles and including directories, but this can be done, eg: include */**/*.journal. The path may also be prefixed to force a specific file format, overrid- - ing the file extension (as described in hledger.1 -> Input files): + ing the file extension (as described in hledger.1 -> Input files): include timedot:~/notes/2020*.md. Default year - You can set a default year to be used for subsequent dates which don't - specify a year. This is a line beginning with Y followed by the year. + You can set a default year to be used for subsequent dates which don't + specify a year. This is a line beginning with Y followed by the year. Eg: Y2009 ; set default year to 2009 @@ -4773,39 +4903,39 @@ JOURNAL FORMAT assets Declaring payees - The payee directive can be used to declare a limited set of payees - which may appear in transaction descriptions. The "payees" check will - report an error if any transaction refers to a payee that has not been + The payee directive can be used to declare a limited set of payees + which may appear in transaction descriptions. The "payees" check will + report an error if any transaction refers to a payee that has not been declared. Eg: payee Whole Foods Declaring commodities - You can use commodity directives to declare your commodities. In fact + You can use commodity directives to declare your commodities. In fact the commodity directive performs several functions at once: - 1. It declares commodities which may be used in the journal. This can - optionally be enforced, providing useful error checking. (Cf Com- + 1. It declares commodities which may be used in the journal. This can + optionally be enforced, providing useful error checking. (Cf Com- modity error checking) - 2. It declares which decimal mark character (period or comma), to - expect when parsing input - useful to disambiguate international - number formats in your data. Without this, hledger will parse both + 2. It declares which decimal mark character (period or comma), to + expect when parsing input - useful to disambiguate international + number formats in your data. Without this, hledger will parse both 1,000 and 1.000 as 1. (Cf Amounts) - 3. It declares how to render the commodity's amounts when displaying + 3. It declares how to render the commodity's amounts when displaying output - the decimal mark, any digit group marks, the number of dec- - imal places, symbol placement and so on. (Cf Commodity display + imal places, symbol placement and so on. (Cf Commodity display style) - You will run into one of the problems solved by commodity directives + You will run into one of the problems solved by commodity directives sooner or later, so we recommend using them, for robust and predictable parsing and display. - Generally you should put them at the top of your journal file (since + Generally you should put them at the top of your journal file (since for function 2, they affect only following amounts, cf #793). - A commodity directive is just the word commodity followed by a sample + A commodity directive is just the word commodity followed by a sample amount, like this: ;commodity SAMPLEAMOUNT @@ -4813,8 +4943,8 @@ JOURNAL FORMAT commodity $1000.00 commodity 1,000.0000 AAAA ; optional same-line comment - It may also be written on multiple lines, and use the format subdirec- - tive, as in Ledger. Note in this case the commodity symbol appears + It may also be written on multiple lines, and use the format subdirec- + tive, as in Ledger. Note in this case the commodity symbol appears twice; it must be the same in both places: ;commodity SYMBOL @@ -4826,11 +4956,11 @@ JOURNAL FORMAT commodity INR format INR 1,00,00,000.00 - Remember that if the commodity symbol contains spaces, numbers, or + Remember that if the commodity symbol contains spaces, numbers, or punctuation, it must be enclosed in double quotes (cf Commodity). - The amount's quantity does not matter; only the format is significant. - It must include a decimal mark - either a period or a comma - followed + The amount's quantity does not matter; only the format is significant. + It must include a decimal mark - either a period or a comma - followed by 0 or more decimal digits. A few more examples: @@ -4841,9 +4971,12 @@ JOURNAL FORMAT commodity INR 9,99,99,999.0 commodity 1 000 000. - Note hledger normally uses banker's rounding, so 0.5 displayed with + Note hledger normally uses banker's rounding, so 0.5 displayed with zero decimal digits is "0". (More at Commodity display style.) + Even in the presence of commodity directives, the commodity display + style can still be overridden by supplying a command line option. + Commodity error checking In strict mode, enabled with the -s/--strict flag, hledger will report an error if a commodity symbol is used that has not been declared by a @@ -4999,13 +5132,14 @@ JOURNAL FORMAT receivables.) Declaring account types - Generally, to make these reports work you should declare your top-level - accounts and their types, using account directives with type: tags. - - The tag's value should be one of: Asset, Liability, Equity, Revenue, - Expense, Cash, A, L, E, R, X, C (all case insensitive). The type is - inherited by all subaccounts except where they override it. Here's a - complete example: + To make the balancesheet/balancesheetequity/cashflow/incomestatement + reports work, generally you should declare your top-level accounts, and + their types. For each top-level account, write an account directive, + with a type: tag. The tag's value can be any of Asset, Liability, + Equity, Revenue, Expense, Cash, or (for short) A, L, E, R, X, C (case + insensitive). An account's type is inherited by its subaccounts, + unless they declare a different type. Here's an example, declaring all + six account types: account assets ; type: Asset account assets:bank ; type: Cash @@ -5015,12 +5149,23 @@ JOURNAL FORMAT account revenues ; type: Revenue account expenses ; type: Expense - Auto-detected account types - If you happen to use common english top-level account names, you may - not need to declare account types, as they will be detected automati- - cally using the following rules: + There is also an older syntax, which is deprecated and will be dropped + soon (A, L, E, R or X separated from the account name by two or more + spaces): - If account's name matches this regular expression: | its type is: + account assets A + account liabilities L + account equity E + account revenues R + account expenses X + + Auto-detected account types + hledger tries to find at least one top level account in each of the six + account types (Asset, Liability, Equity, Revenue, Expense, Cash). When + no accounts have been declared for a particular type, hledger tries to + auto-detect some accounts by name, using regular expressions: + + If account's name matches this case insensitive regular expression:| its type is: ------------------------------------------------------------------- | ------------ ^assets?(:|$) | and does not contain regexp (investment|receivable|:A/R|:fixed) | Cash @@ -5030,38 +5175,37 @@ JOURNAL FORMAT ^(income|revenue)s?(:|$) | Revenue ^expenses?(:|$) | Expense - Even so, explicit declarations may be a good idea, for clarity and pre- - dictability. + For people using standard english account names, this feature helps + hledger's high-level reports work out of the box with minimal configu- + ration. - Interference from auto-detected account types - If you assign any account type, it's a good idea to assign all of them, - to prevent any confusion from mixing declared and auto-detected types. - Although it's unlikely to happen in real life, here's an example: with - the following journal, balancesheetequity shows "liabilities" in both - Liabilities and Equity sections. Declaring another account as - type:Liability would fix it: + If you use non-english account names, you should declare account types + to make these reports work. And more generally, declaring accounts and + types is usually a good idea, for increased clarity and predictability + (and for the other benefits of account directives: error checking, dis- + play order, etc). - account liabilities ; type:Equity + Notes: - 2020-01-01 - assets 1 - liabilities 1 - equity -2 + o When any account is declared as some type, this disables auto-detec- + tion for that particular type. - Old account type syntax - In some hledger journals you might instead see this old syntax (the - letters ALERX, separated from the account name by two or more spaces); - this is deprecated and may be removed soon: + o If you declare any account's type, it's a good idea to declare an + account for all six types, since a mix of declared and auto-detected + types can cause confusion. For example, here liabilities is declared + to be Equity, but would also be auto-detected as Liability, since no + Liability account is declared: - account assets A - account liabilities L - account equity E - account revenues R - account expenses X + account liabilities ; type:Equity + + 2020-01-01 + assets 1 + liabilities 1 + equity -2 Account display order - Account directives also set the order in which accounts are displayed, - eg in reports, the hledger-ui accounts screen, and the hledger-web + Account directives also set the order in which accounts are displayed, + eg in reports, the hledger-ui accounts screen, and the hledger-web sidebar. By default accounts are listed in alphabetical order. But if you have these account directives in the journal: @@ -5083,20 +5227,20 @@ JOURNAL FORMAT Undeclared accounts, if any, are displayed last, in alphabetical order. - Note that sorting is done at each level of the account tree (within - each group of sibling accounts under the same parent). And currently, + Note that sorting is done at each level of the account tree (within + each group of sibling accounts under the same parent). And currently, this directive: account other:zoo - would influence the position of zoo among other's subaccounts, but not + would influence the position of zoo among other's subaccounts, but not the position of other among the top-level accounts. This means: - o you will sometimes declare parent accounts (eg account other above) - that you don't intend to post to, just to customize their display + o you will sometimes declare parent accounts (eg account other above) + that you don't intend to post to, just to customize their display order - o sibling accounts stay together (you couldn't display x:y in between + o sibling accounts stay together (you couldn't display x:y in between a:b and a:c). Rewriting accounts @@ -5114,15 +5258,15 @@ JOURNAL FORMAT o customising reports Account aliases also rewrite account names in account directives. They - do not affect account names being entered via hledger add or hledger- + do not affect account names being entered via hledger add or hledger- web. See also Rewrite account names. Basic aliases - To set an account alias, use the alias directive in your journal file. - This affects all subsequent journal entries in the current file or its - included files (but note: not sibling or parent files). The spaces + To set an account alias, use the alias directive in your journal file. + This affects all subsequent journal entries in the current file or its + included files (but note: not sibling or parent files). The spaces around the = are optional: alias OLD = NEW @@ -5130,49 +5274,49 @@ JOURNAL FORMAT Or, you can use the --alias 'OLD=NEW' option on the command line. This affects all entries. It's useful for trying out aliases interactively. - OLD and NEW are case sensitive full account names. hledger will - replace any occurrence of the old account name with the new one. Sub- + OLD and NEW are case sensitive full account names. hledger will + replace any occurrence of the old account name with the new one. Sub- accounts are also affected. Eg: alias checking = assets:bank:wells fargo:checking ; rewrites "checking" to "assets:bank:wells fargo:checking", or "checking:a" to "assets:bank:wells fargo:checking:a" Regex aliases - There is also a more powerful variant that uses a regular expression, + There is also a more powerful variant that uses a regular expression, indicated by the forward slashes: alias /REGEX/ = REPLACEMENT or --alias '/REGEX/=REPLACEMENT'. - REGEX is a case-insensitive regular expression. Anywhere it matches - inside an account name, the matched part will be replaced by REPLACE- - MENT. If REGEX contains parenthesised match groups, these can be ref- + REGEX is a case-insensitive regular expression. Anywhere it matches + inside an account name, the matched part will be replaced by REPLACE- + MENT. If REGEX contains parenthesised match groups, these can be ref- erenced by the usual numeric backreferences in REPLACEMENT. Eg: alias /^(.+):bank:([^:]+):(.*)/ = \1:\2 \3 ; rewrites "assets:bank:wells fargo:checking" to "assets:wells fargo checking" - Also note that REPLACEMENT continues to the end of line (or on command - line, to end of option argument), so it can contain trailing white- + Also note that REPLACEMENT continues to the end of line (or on command + line, to end of option argument), so it can contain trailing white- space. Combining aliases - You can define as many aliases as you like, using journal directives + You can define as many aliases as you like, using journal directives and/or command line options. - Recursive aliases - where an account name is rewritten by one alias, - then by another alias, and so on - are allowed. Each alias sees the + Recursive aliases - where an account name is rewritten by one alias, + then by another alias, and so on - are allowed. Each alias sees the effect of previously applied aliases. - In such cases it can be important to understand which aliases will be - applied and in which order. For (each account name in) each journal + In such cases it can be important to understand which aliases will be + applied and in which order. For (each account name in) each journal entry, we apply: - 1. alias directives preceding the journal entry, most recently parsed + 1. alias directives preceding the journal entry, most recently parsed first (ie, reading upward from the journal entry, bottom to top) - 2. --alias options, in the order they appeared on the command line + 2. --alias options, in the order they appeared on the command line (left to right). In other words, for (an account name in) a given journal entry: @@ -5183,15 +5327,15 @@ JOURNAL FORMAT o aliases defined after/below the entry do not affect it. - This gives nearby aliases precedence over distant ones, and helps pro- - vide semantic stability - aliases will keep working the same way inde- + This gives nearby aliases precedence over distant ones, and helps pro- + vide semantic stability - aliases will keep working the same way inde- pendent of which files are being read and in which order. - In case of trouble, adding --debug=6 to the command line will show + In case of trouble, adding --debug=6 to the command line will show which aliases are being applied when. Aliases and multiple files - As explained at Directives and multiple files, alias directives do not + As explained at Directives and multiple files, alias directives do not affect parent or sibling files. Eg in this command, hledger -f a.aliases -f b.journal @@ -5218,14 +5362,14 @@ JOURNAL FORMAT include c.journal ; also affected end aliases - You can clear (forget) all currently defined aliases with the end + You can clear (forget) all currently defined aliases with the end aliases directive: end aliases Default parent account - You can specify a parent account which will be prepended to all - accounts within a section of the journal. Use the apply account and + You can specify a parent account which will be prepended to all + accounts within a section of the journal. Use the apply account and end apply account directives like so: apply account home @@ -5242,7 +5386,7 @@ JOURNAL FORMAT home:food $10 home:cash $-10 - If end apply account is omitted, the effect lasts to the end of the + If end apply account is omitted, the effect lasts to the end of the file. Included files are also affected, eg: apply account business @@ -5251,49 +5395,49 @@ JOURNAL FORMAT apply account personal include personal.journal - Prior to hledger 1.0, legacy account and end spellings were also sup- + Prior to hledger 1.0, legacy account and end spellings were also sup- ported. - A default parent account also affects account directives. It does not - affect account names being entered via hledger add or hledger-web. If - account aliases are present, they are applied after the default parent + A default parent account also affects account directives. It does not + affect account names being entered via hledger add or hledger-web. If + account aliases are present, they are applied after the default parent account. Periodic transactions - Periodic transaction rules describe transactions that recur. They - allow hledger to generate temporary future transactions to help with - forecasting, so you don't have to write out each one in the journal, + Periodic transaction rules describe transactions that recur. They + allow hledger to generate temporary future transactions to help with + forecasting, so you don't have to write out each one in the journal, and it's easy to try out different forecasts. - Periodic transactions can be a little tricky, so before you use them, + Periodic transactions can be a little tricky, so before you use them, read this whole section - or at least these tips: - 1. Two spaces accidentally added or omitted will cause you trouble - + 1. Two spaces accidentally added or omitted will cause you trouble - read about this below. - 2. For troubleshooting, show the generated transactions with hledger - print --forecast tag:generated or hledger register --forecast + 2. For troubleshooting, show the generated transactions with hledger + print --forecast tag:generated or hledger register --forecast tag:generated. - 3. Forecasted transactions will begin only after the last non-fore- + 3. Forecasted transactions will begin only after the last non-fore- casted transaction's date. - 4. Forecasted transactions will end 6 months from today, by default. + 4. Forecasted transactions will end 6 months from today, by default. See below for the exact start/end rules. - 5. period expressions can be tricky. Their documentation needs + 5. period expressions can be tricky. Their documentation needs improvement, but is worth studying. - 6. Some period expressions with a repeating interval must begin on a - natural boundary of that interval. Eg in weekly from DATE, DATE - must be a monday. ~ weekly from 2019/10/1 (a tuesday) will give an + 6. Some period expressions with a repeating interval must begin on a + natural boundary of that interval. Eg in weekly from DATE, DATE + must be a monday. ~ weekly from 2019/10/1 (a tuesday) will give an error. 7. Other period expressions with an interval are automatically expanded - to cover a whole number of that interval. (This is done to improve + to cover a whole number of that interval. (This is done to improve reports, but it also affects periodic transactions. Yes, it's a bit - inconsistent with the above.) Eg: ~ every 10th day of month from - 2020/01, which is equivalent to ~ every 10th day of month from + inconsistent with the above.) Eg: ~ every 10th day of month from + 2020/01, which is equivalent to ~ every 10th day of month from 2020/01/01, will be adjusted to start on 2019/12/10. Periodic transaction rules also have a second meaning: they are used to @@ -5308,17 +5452,17 @@ JOURNAL FORMAT expenses:rent $2000 assets:bank:checking - There is an additional constraint on the period expression: the start - date must fall on a natural boundary of the interval. Eg monthly from + There is an additional constraint on the period expression: the start + date must fall on a natural boundary of the interval. Eg monthly from 2018/1/1 is valid, but monthly from 2018/1/15 is not. - Partial or relative dates (M/D, D, tomorrow, last week) in the period - expression can work (useful or not). They will be relative to today's - date, unless a Y default year directive is in effect, in which case + Partial or relative dates (M/D, D, tomorrow, last week) in the period + expression can work (useful or not). They will be relative to today's + date, unless a Y default year directive is in effect, in which case they will be relative to Y/1/1. Two spaces between period expression and description! - If the period expression is followed by a transaction description, + If the period expression is followed by a transaction description, these must be separated by two or more spaces. This helps hledger know where the period expression ends, so that descriptions can not acciden- tally alter their meaning, as in this example: @@ -5332,67 +5476,93 @@ JOURNAL FORMAT So, - o Do write two spaces between your period expression and your transac- + o Do write two spaces between your period expression and your transac- tion description, if any. - o Don't accidentally write two spaces in the middle of your period + o Don't accidentally write two spaces in the middle of your period expression. Forecasting with periodic transactions - The --forecast flag activates any periodic transaction rules in the - journal. They will generate temporary recurring transactions, which - are not saved in the journal, but will appear in all reports (eg - print). This can be useful for estimating balances into the future, or - experimenting with different scenarios. Or, it can be used as a data - entry aid: describe recurring transactions, and every so often copy the - output of print --forecast into the journal. + The --forecast flag activates any periodic transaction rules in the + journal. These will generate temporary additional transactions, usu- + ally recurring and in the future, which will appear in all reports. + hledger print --forecast is a good way to see them. - These transactions will have an extra tag indicating which periodic - rule generated them: generated-transaction:~ PERIODICEXPR. And a simi- - lar, hidden tag (beginning with an underscore) which, because it's - never displayed by print, can be used to match transactions generated - "just now": _generated-transaction:~ PERIODICEXPR. + This can be useful for estimating balances into the future, perhaps + experimenting with different scenarios. - Periodic transactions are generated within some forecast period. By - default, this + It could also be useful for scripted data entry: you could describe + recurring transactions, and every so often copy the output of print + --forecast into the journal. - o begins on the later of + The generated transactions will have an extra tag, like generated- + transaction:~ PERIODICEXPR, indicating which periodic rule generated + them. There is also a similar, hidden tag, named _generated-transac- + tion:, which you can use to reliably match transactions generated "just + now" (rather than printed in the past). - o the report start date if specified with -b/-p/date: + The forecast transactions are generated within a forecast period, which + is independent of the report period. (Forecast period sets the bounds + for generated transactions, report period controls which transactions + are reported.) The forecast period begins on: - o the day after the latest normal (non-periodic) transaction in the - journal, or today if there are no normal transactions. + o the start date provided within --forecast's argument, if any - o ends on the report end date if specified with -e/-p/date:, or 6 - months (180 days) from today. + o otherwise, the later of - This means that periodic transactions will begin only after the latest - recorded transaction. And a recorded transaction dated in the future - can prevent generation of periodic transactions. (You can avoid that - by writing the future transaction as a one-time periodic rule instead - - put tilde before the date, eg ~ YYYY-MM-DD ...). + o the report start date, if specified (with -b/-p/date:) - Or, you can set your own arbitrary "forecast period", which can overlap - recorded transactions, and need not be in the future, by providing an - option argument, like --forecast=PERIODEXPR. Note the equals sign is - required, a space won't work. PERIODEXPR is a period expression, which - can specify the start date, end date, or both, like in a date: query. - (See also hledger.1 -> Report start & end date). Some examples: - --forecast=202001-202004, --forecast=jan-, --forecast=2020. + o the day after the latest ordinary transaction in the journal, if + any + + o otherwise today. + + It ends on: + + o the end date provided within --forecast's argument, if any + + o otherwise, the report end date, if specified (with -e/-p/date:) + + o otherwise 180 days (6 months) from today. + + Note, this means that ordinary transactions will suppress periodic + transactions, by default; the periodic transactions will not start + until after the last ordinary transaction. This is usually convenient, + but you can get around it in two ways: + + o If you need to record some transactions in the future, make them + periodic transactions (with a single occurrence, eg: ~ YYYY-MM-DD) + rather than ordinary transactions. That way they won't suppress + other periodic transactions. + + o Or give --forecast a period expression argument. A forecast period + specified this way can overlap ordinary transactions, and need not be + in the future. Some things to note: + + o You must use = between flag and argument; a space won't work. + + o The period expression can specify the forecast period's start date, + end date, or both. See also Report start & end date. + + o The period expression should not specify a report interval. (Each + periodic transaction rule specifies its own interval.) + + Some examples: --forecast=202001-202004, --forecast=jan-, --fore- + cast=2021. Budgeting with periodic transactions - With the --budget flag, currently supported by the balance command, - each periodic transaction rule declares recurring budget goals for the - specified accounts. Eg the first example above declares a goal of - spending $2000 on rent (and also, a goal of depositing $2000 into - checking) every month. Goals and actual performance can then be com- + With the --budget flag, currently supported by the balance command, + each periodic transaction rule declares recurring budget goals for the + specified accounts. Eg the first example above declares a goal of + spending $2000 on rent (and also, a goal of depositing $2000 into + checking) every month. Goals and actual performance can then be com- pared in budget reports. See also: Budgeting and Forecasting. Auto postings - "Automated postings" or "auto postings" are extra postings which get + "Automated postings" or "auto postings" are extra postings which get added automatically to transactions which match certain queries, defined by "auto posting rules", when you use the --auto flag. @@ -5403,27 +5573,27 @@ JOURNAL FORMAT ... ACCOUNT [AMOUNT] - except the first line is an equals sign (mnemonic: = suggests match- - ing), followed by a query (which matches existing postings), and each - "posting" line describes a posting to be generated, and the posting + except the first line is an equals sign (mnemonic: = suggests match- + ing), followed by a query (which matches existing postings), and each + "posting" line describes a posting to be generated, and the posting amounts can be: - o a normal amount with a commodity symbol, eg $2. This will be used + o a normal amount with a commodity symbol, eg $2. This will be used as-is. o a number, eg 2. The commodity symbol (if any) from the matched post- ing will be added to this. - o a numeric multiplier, eg *2 (a star followed by a number N). The + o a numeric multiplier, eg *2 (a star followed by a number N). The matched posting's amount (and total price, if any) will be multiplied by N. - o a multiplier with a commodity symbol, eg *$2 (a star, number N, and + o a multiplier with a commodity symbol, eg *$2 (a star, number N, and symbol S). The matched posting's amount will be multiplied by N, and its commodity symbol will be replaced with S. - Any query term containing spaces must be enclosed in single or double - quotes, as on the command line. Eg, note the quotes around the second + Any query term containing spaces must be enclosed in single or double + quotes, as on the command line. Eg, note the quotes around the second query term below: = expenses:groceries 'expenses:dining out' @@ -5462,24 +5632,24 @@ JOURNAL FORMAT Auto postings and multiple files An auto posting rule can affect any transaction in the current file, or - in any parent file or child file. Note, currently it will not affect + in any parent file or child file. Note, currently it will not affect sibling files (when multiple -f/--file are used - see #1212). Auto postings and dates - A posting date (or secondary date) in the matched posting, or (taking - precedence) a posting date in the auto posting rule itself, will also + A posting date (or secondary date) in the matched posting, or (taking + precedence) a posting date in the auto posting rule itself, will also be used in the generated posting. Auto postings and transaction balancing / inferred amounts / balance asser- tions Currently, auto postings are added: - o after missing amounts are inferred, and transactions are checked for + o after missing amounts are inferred, and transactions are checked for balancedness, o but before balance assertions are checked. - Note this means that journal entries must be balanced both before and + Note this means that journal entries must be balanced both before and after auto postings are added. This changed in hledger 1.12+; see #893 for background. @@ -5489,11 +5659,11 @@ JOURNAL FORMAT o generated-posting:= QUERY - shows this was generated by an auto post- ing rule, and the query - o _generated-posting:= QUERY - a hidden tag, which does not appear in + o _generated-posting:= QUERY - a hidden tag, which does not appear in hledger's output. This can be used to match postings generated "just now", rather than generated in the past and saved to the journal. - Also, any transaction that has been changed by auto posting rules will + Also, any transaction that has been changed by auto posting rules will have these tags added: o modified: - this transaction was modified @@ -5504,65 +5674,65 @@ JOURNAL FORMAT CSV FORMAT How hledger reads CSV data, and the CSV rules file format. - hledger can read CSV files (Character Separated Value - usually comma, - semicolon, or tab) containing dated records as if they were journal + hledger can read CSV files (Character Separated Value - usually comma, + semicolon, or tab) containing dated records as if they were journal files, automatically converting each CSV record into a transaction. (To learn about writing CSV, see CSV output.) We describe each CSV file's format with a corresponding rules file. By - default this is named like the CSV file with a .rules extension added. - Eg when reading FILE.csv, hledger also looks for FILE.csv.rules in the - same directory as FILE.csv. You can specify a different rules file - with the --rules-file option. If a rules file is not found, hledger + default this is named like the CSV file with a .rules extension added. + Eg when reading FILE.csv, hledger also looks for FILE.csv.rules in the + same directory as FILE.csv. You can specify a different rules file + with the --rules-file option. If a rules file is not found, hledger will create a sample rules file, which you'll need to adjust. - This file contains rules describing the CSV data (header line, fields + This file contains rules describing the CSV data (header line, fields layout, date format etc.), and how to construct hledger journal entries (transactions) from it. Often there will also be a list of conditional rules for categorising transactions based on their descriptions. - Here's an overview of the CSV rules; these are described more fully + Here's an overview of the CSV rules; these are described more fully below, after the examples: skip skip one or more header lines or matched CSV records - fields list name CSV fields, assign them to hledger + + + fields list name CSV fields, assign them to hledger fields - field assignment assign a value to one hledger field, with + field assignment assign a value to one hledger field, with interpolation Field names hledger field names, used in the fields list and field assignments separator a custom field separator - if block apply some rules to CSV records matched by + if block apply some rules to CSV records matched by patterns - if table apply some rules to CSV records matched by + if table apply some rules to CSV records matched by patterns, alternate syntax end skip the remaining CSV records date-format how to parse dates in CSV records - decimal-mark the decimal mark used in CSV amounts, if + decimal-mark the decimal mark used in CSV amounts, if ambiguous - - - newest-first disambiguate record order when there's only + newest-first disambiguate record order when there's only one date include inline another CSV rules file - balance-type choose which type of balance assignments to + balance-type choose which type of balance assignments to use - Note, for best error messages when reading CSV files, use a .csv, .tsv + Note, for best error messages when reading CSV files, use a .csv, .tsv or .ssv file extension or file prefix - see File Extension below. There's an introductory Convert CSV files tutorial on hledger.org. Examples - Here are some sample hledger CSV rules files. See also the full col- + Here are some sample hledger CSV rules files. See also the full col- lection at: https://github.com/simonmichael/hledger/tree/master/examples/csv Basic - At minimum, the rules file must identify the date and amount fields, - and often it also specifies the date format and how many header lines + At minimum, the rules file must identify the date and amount fields, + and often it also specifies the date format and how many header lines there are. Here's a simple CSV file and a rules file for it: Date, Description, Id, Amount @@ -5581,8 +5751,8 @@ CSV FORMAT Default account names are chosen, since we didn't set them. Bank of Ireland - Here's a CSV with two amount fields (Debit and Credit), and a balance - field, which we can use to add balance assertions, which is not neces- + Here's a CSV with two amount fields (Debit and Credit), and a balance + field, which we can use to add balance assertions, which is not neces- sary but provides extra error checking: Date,Details,Debit,Credit,Balance @@ -5624,13 +5794,13 @@ CSV FORMAT assets:bank:boi:checking EUR-5.0 = EUR126.0 expenses:unknown EUR5.0 - The balance assertions don't raise an error above, because we're read- - ing directly from CSV, but they will be checked if these entries are + The balance assertions don't raise an error above, because we're read- + ing directly from CSV, but they will be checked if these entries are imported into a journal file. Amazon Here we convert amazon.com order history, and use an if block to gener- - ate a third posting if there's a fee. (In practice you'd probably get + ate a third posting if there's a fee. (In practice you'd probably get this data from your bank instead, but it's an example.) "Date","Type","To/From","Name","Status","Amount","Fees","Transaction ID" @@ -5682,7 +5852,7 @@ CSV FORMAT expenses:fees $1.00 Paypal - Here's a real-world rules file for (customised) Paypal CSV, with some + Here's a real-world rules file for (customised) Paypal CSV, with some Paypal-specific rules, and a second rules file included: "Date","Time","TimeZone","Name","Type","Status","Currency","Gross","Fee","Net","From Email Address","To Email Address","Transaction ID","Item Title","Item ID","Reference Txn ID","Receipt ID","Balance","Note" @@ -5837,9 +6007,9 @@ CSV FORMAT skip skip N - The word "skip" followed by a number (or no number, meaning 1) tells - hledger to ignore this many non-empty lines preceding the CSV data. - (Empty/blank lines are skipped automatically.) You'll need this when- + The word "skip" followed by a number (or no number, meaning 1) tells + hledger to ignore this many non-empty lines preceding the CSV data. + (Empty/blank lines are skipped automatically.) You'll need this when- ever your CSV data contains header lines. It also has a second purpose: it can be used inside if blocks to ignore @@ -5848,19 +6018,19 @@ CSV FORMAT fields list fields FIELDNAME1, FIELDNAME2, ... - A fields list (the word "fields" followed by comma-separated field - names) is the quick way to assign CSV field values to hledger fields. - (The other way is field assignments, see below.) A fields list does + A fields list (the word "fields" followed by comma-separated field + names) is the quick way to assign CSV field values to hledger fields. + (The other way is field assignments, see below.) A fields list does does two things: - 1. It names the CSV fields. This is optional, but can be convenient + 1. It names the CSV fields. This is optional, but can be convenient later for interpolating them. - 2. Whenever you use a standard hledger field name (defined below), the + 2. Whenever you use a standard hledger field name (defined below), the CSV value is assigned to that part of the hledger transaction. - Here's an example that says "use the 1st, 2nd and 4th fields as the - transaction's date, description and amount; name the last two fields + Here's an example that says "use the 1st, 2nd and 4th fields as the + transaction's date, description and amount; name the last two fields for later reference; and ignore the others": fields date, description, , amount, , , somefield, anotherfield @@ -5870,18 +6040,18 @@ CSV FORMAT o The fields list always use commas, even if your CSV data uses another separator character. - o Currently there must be least two items in the list (at least one + o Currently there must be least two items in the list (at least one comma). - o Field names may not contain spaces. Spaces before/after field names + o Field names may not contain spaces. Spaces before/after field names are optional. - o If the CSV contains column headings, it's a good idea to use these, + o If the CSV contains column headings, it's a good idea to use these, suitably modified, as the basis for your field names (eg lower-cased, with underscores instead of spaces). - o If some heading names match standard hledger fields, but you don't - want to set the hledger fields directly, alter those names, eg by + o If some heading names match standard hledger fields, but you don't + want to set the hledger fields directly, alter those names, eg by appending an underscore. o Fields you don't care about can be given a dummy name (eg: _ ), or no @@ -5890,15 +6060,15 @@ CSV FORMAT field assignment HLEDGERFIELDNAME FIELDVALUE - Field assignments are the more flexible way to assign CSV values to + Field assignments are the more flexible way to assign CSV values to hledger fields. They can be used instead of or in addition to a fields list (see above). - To assign a value to a hledger field, write the field name (any of the - standard hledger field/pseudo-field names, defined below), a space, - followed by a text value on the same line. This text value may inter- - polate CSV fields, referenced by their 1-based position in the CSV - record (%N), or by the name they were given in the fields list (%CSV- + To assign a value to a hledger field, write the field name (any of the + standard hledger field/pseudo-field names, defined below), a space, + followed by a text value on the same line. This text value may inter- + polate CSV fields, referenced by their 1-based position in the CSV + record (%N), or by the name they were given in the fields list (%CSV- FIELDNAME). Some examples: @@ -5911,10 +6081,11 @@ CSV FORMAT Tips: - o Interpolation strips outer whitespace (so a CSV value like " 1 " + o Interpolation strips outer whitespace (so a CSV value like " 1 " becomes 1 when interpolated) (#1051). - o See also Tips below. + o Interpolations always refer to a CSV field - you can't interpolate a + hledger field. (See Referencing other fields below). Field names Here are the standard hledger field (and pseudo-field) names, which you @@ -7241,4 +7412,4 @@ SEE ALSO -hledger-1.22.99 August 2021 HLEDGER(1) +hledger-1.22.99 September 2021 HLEDGER(1)