diff --git a/hledger-lib/hledger_csv.txt b/hledger-lib/hledger_csv.txt index 60f4cf835..33ec57fb5 100644 --- a/hledger-lib/hledger_csv.txt +++ b/hledger-lib/hledger_csv.txt @@ -24,9 +24,9 @@ DESCRIPTION When reading a CSV file named FILE.csv, hledger looks for a conversion rules file named FILE.csv.rules in the same directory. You can over- - ride this with the --rules-file option. If the rules file does not ex- - ist, hledger will auto-create one with some example rules, which you'll - need to adjust. + ride this with the --rules-file option. If the rules file does not + exist, hledger will auto-create one with some example rules, which + you'll need to adjust. At minimum, the rules file must identify the date and amount fields. It's often necessary to specify the date format, and the number of @@ -192,8 +192,8 @@ CSV TIPS you might need newest-first, see above). CSV accounts - Each journal entry will have two postings, to account1 and account2 re- - spectively. It's not yet possible to generate entries with more than + Each journal entry will have two postings, to account1 and account2 + respectively. It's not yet possible to generate entries with more than two postings. It's conventional and recommended to use account1 for the account whose CSV we are reading. @@ -229,9 +229,9 @@ CSV TIPS CSV balance assertions/assignments If the CSV includes a running balance, you can assign that to one of the pseudo fields balance (or balance1) or balance2. This will gener- - ate a balance assertion (or if the amount is left empty, a balance as- - signment), on the first or second posting, whenever the running balance - field is non-empty. (TODO: #1000) + ate a balance assertion (or if the amount is left empty, a balance + assignment), on the first or second posting, whenever the running bal- + ance field is non-empty. (TODO: #1000) Reading multiple CSV files You can read multiple CSV files at once using multiple -f arguments on diff --git a/hledger-lib/hledger_journal.5 b/hledger-lib/hledger_journal.5 index a4feb2b05..b3bb29320 100644 --- a/hledger-lib/hledger_journal.5 +++ b/hledger-lib/hledger_journal.5 @@ -1579,11 +1579,45 @@ parent account. .SS Periodic transactions .PP Periodic transaction rules describe transactions that recur. -They allow you to generate future transactions for forecasting, without -having to write them out explicitly in the journal (with -\f[C]--forecast\f[R]). -Secondly, they also can be used to define budget goals (with -\f[C]--budget\f[R]). +They allow hledger to generate temporary future transactions to help +with forecasting, so you don\[aq]t have to write out each one in the +journal, and it\[aq]s easy to try out different forecasts. +Secondly, they are also used to define the budgets shown in budget +reports. +.PP +Periodic transactions can be a little tricky, so before you use them, +read this whole section - or at least these tips: +.IP "1." 3 +Two spaces accidentally added or omitted will cause you trouble - read +about this below. +.IP "2." 3 +For troubleshooting, show the generated transactions with +\f[C]hledger print --forecast tag:generated\f[R] or +\f[C]hledger register --forecast tag:generated\f[R]. +.IP "3." 3 +Forecasted transactions will begin only after the last non-forecasted +transaction\[aq]s date. +.IP "4." 3 +Forecasted transactions will end 6 months from today, by default. +See below for the exact start/end rules. +.IP "5." 3 +period expressions can be tricky. +Their documentation needs improvement, but is worth studying. +.IP "6." 3 +Some period expressions with a repeating interval must begin on a +natural boundary of that interval. +Eg in \f[C]weekly from DATE\f[R], DATE must be a monday. +\f[C]\[ti] weekly from 2019/10/1\f[R] (a tuesday) will give an error. +.IP "7." 3 +Other period expressions with an interval are automatically expanded to +cover a whole number of that interval. +(This is done to improve reports, but it also affects periodic +transactions. +Yes, it\[aq]s a bit inconsistent with the above.) Eg: +\f[C]\[ti] every 10th day of month from 2020/01\f[R], which is +equivalent to \f[C]\[ti] every 10th day of month from 2020/01/01\f[R], +will be adjusted to start on 2019/12/10. +.SS Periodic rule syntax .PP A periodic transaction rule looks like a normal journal entry, with the date replaced by a tilde (\f[C]\[ti]\f[R]) followed by a period @@ -1607,7 +1641,7 @@ 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\[aq]s date, unless a Y default year directive is in effect, in which case they will be relative to Y/1/1. -.SS Two spaces after the period expression +.SS Two spaces between period expression and description! .PP If the period expression is followed by a transaction description, these must be separated by \f[B]two or more spaces\f[R]. @@ -1625,6 +1659,14 @@ example: income:acme inc \f[R] .fi +.PP +So, +.IP \[bu] 2 +Do write two spaces between your period expression and your transaction +description, if any. +.IP \[bu] 2 +Don\[aq]t accidentally write two spaces in the middle of your period +expression. .SS Forecasting with periodic transactions .PP With the \f[C]--forecast\f[R] flag, each periodic transaction rule @@ -1686,8 +1728,8 @@ 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. .PP -For more details, see: balance: Budget report and Cookbook: Budgeting -and Forecasting. +For more details, see: balance: Budget report and Budgeting and +Forecasting. .PP .SS Auto postings / transaction modifiers .PP diff --git a/hledger-lib/hledger_journal.info b/hledger-lib/hledger_journal.info index 27388b59b..72841c649 100644 --- a/hledger-lib/hledger_journal.info +++ b/hledger-lib/hledger_journal.info @@ -1412,12 +1412,52 @@ File: hledger_journal.info, Node: Periodic transactions, Next: Auto postings / ========================== Periodic transaction rules describe transactions that recur. They allow -you to generate future transactions for forecasting, without having to -write them out explicitly in the journal (with '--forecast'). Secondly, -they also can be used to define budget goals (with '--budget'). +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. Secondly, they are also used +to define the budgets shown in budget reports. - A periodic transaction rule looks like a normal journal entry, with -the date replaced by a tilde ('~') followed by a period expression + 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 - + read about this below. + 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 + 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 error. + 7. Other period expressions with an interval are automatically + expanded to cover a whole number of that interval. (This is done + to improve reports, but it also affects periodic transactions. + Yes, it's a bit inconsistent with the above.) Eg: '~ every 10th + day of month from 2020/01', which is equivalent to '~ every 10th + day of month from 2020/01/01', will be adjusted to start on + 2019/12/10. + +* Menu: + +* Periodic rule syntax:: +* Two spaces between period expression and description!:: +* Forecasting with periodic transactions:: +* Budgeting with periodic transactions:: + + +File: hledger_journal.info, Node: Periodic rule syntax, Next: Two spaces between period expression and description!, Up: Periodic transactions + +1.15.1 Periodic rule syntax +--------------------------- + +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.): ~ monthly @@ -1433,17 +1473,11 @@ 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. -* Menu: - -* Two spaces after the period expression:: -* Forecasting with periodic transactions:: -* Budgeting with periodic transactions:: -  -File: hledger_journal.info, Node: Two spaces after the period expression, Next: Forecasting with periodic transactions, Up: Periodic transactions +File: hledger_journal.info, Node: Two spaces between period expression and description!, Next: Forecasting with periodic transactions, Prev: Periodic rule syntax, Up: Periodic transactions -1.15.1 Two spaces after the period expression ---------------------------------------------- +1.15.2 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 @@ -1457,10 +1491,17 @@ accidentally alter their meaning, as in this example: assets:bank:checking $1500 income:acme inc - -File: hledger_journal.info, Node: Forecasting with periodic transactions, Next: Budgeting with periodic transactions, Prev: Two spaces after the period expression, Up: Periodic transactions + So, -1.15.2 Forecasting with periodic transactions + * 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. + + +File: hledger_journal.info, Node: Forecasting with periodic transactions, Next: Budgeting with periodic transactions, Prev: Two spaces between period expression and description!, Up: Periodic transactions + +1.15.3 Forecasting with periodic transactions --------------------------------------------- With the '--forecast' flag, each periodic transaction rule generates @@ -1513,7 +1554,7 @@ disables forecast transactions on previous dates.)  File: hledger_journal.info, Node: Budgeting with periodic transactions, Prev: Forecasting with periodic transactions, Up: Periodic transactions -1.15.3 Budgeting with periodic transactions +1.15.4 Budgeting with periodic transactions ------------------------------------------- With the '--budget' flag, currently supported by the balance command, @@ -1523,8 +1564,8 @@ 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. - For more details, see: balance: Budget report and Cookbook: Budgeting -and Forecasting. + For more details, see: balance: Budget report and Budgeting and +Forecasting.  File: hledger_journal.info, Node: Auto postings / transaction modifiers, Prev: Periodic transactions, Up: FILE FORMAT @@ -1760,21 +1801,23 @@ Node: Default parent account50218 Ref: #default-parent-account50384 Node: Periodic transactions51268 Ref: #periodic-transactions51466 -Node: Two spaces after the period expression52592 -Ref: #two-spaces-after-the-period-expression52837 -Node: Forecasting with periodic transactions53322 -Ref: #forecasting-with-periodic-transactions53612 -Node: Budgeting with periodic transactions55638 -Ref: #budgeting-with-periodic-transactions55877 -Node: Auto postings / transaction modifiers56336 -Ref: #auto-postings-transaction-modifiers56547 -Node: Auto postings and dates58776 -Ref: #auto-postings-and-dates59033 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions59208 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions59583 -Node: Auto posting tags59961 -Ref: #auto-posting-tags60200 -Node: EDITOR SUPPORT60865 -Ref: #editor-support60983 +Node: Periodic rule syntax53338 +Ref: #periodic-rule-syntax53544 +Node: Two spaces between period expression and description!54248 +Ref: #two-spaces-between-period-expression-and-description54567 +Node: Forecasting with periodic transactions55251 +Ref: #forecasting-with-periodic-transactions55556 +Node: Budgeting with periodic transactions57582 +Ref: #budgeting-with-periodic-transactions57821 +Node: Auto postings / transaction modifiers58270 +Ref: #auto-postings-transaction-modifiers58481 +Node: Auto postings and dates60710 +Ref: #auto-postings-and-dates60967 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions61142 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions61517 +Node: Auto posting tags61895 +Ref: #auto-posting-tags62134 +Node: EDITOR SUPPORT62799 +Ref: #editor-support62917  End Tag Table diff --git a/hledger-lib/hledger_journal.txt b/hledger-lib/hledger_journal.txt index 9bc211812..be7334b2b 100644 --- a/hledger-lib/hledger_journal.txt +++ b/hledger-lib/hledger_journal.txt @@ -7,9 +7,9 @@ NAME Journal - hledger's default file format, representing a General Journal DESCRIPTION - hledger's usual data source is a plain text file containing journal en- - tries in hledger journal format. This file represents a standard ac- - counting general journal. I use file names ending in .journal, but + hledger's usual data source is a plain text file containing journal + entries in hledger journal format. This file represents a standard + accounting general journal. I use file names ending in .journal, but that's not required. The journal file contains a number of transaction entries, each describing a transfer of money (or any commodity) between two or more named accounts, in a simple format readable by both hledger @@ -23,8 +23,8 @@ DESCRIPTION You can use hledger without learning any more about this file; just use the add or web commands to create and update it. Many users, though, - also edit the journal file directly with a text editor, perhaps as- - sisted by the helper modes for emacs or vim. + also edit the journal file directly with a text editor, perhaps + assisted by the helper modes for emacs or vim. Here's an example: @@ -58,9 +58,9 @@ DESCRIPTION FILE FORMAT Transactions Transactions are movements of some quantity of commodities between - named accounts. Each transaction is represented by a journal entry be- - ginning with a simple date in column 0. This can be followed by any of - the following, separated by spaces: + named accounts. Each transaction is represented by a journal entry + beginning with a simple date in column 0. This can be followed by any + of the following, separated by spaces: o (optional) a status character (empty, !, or *) @@ -104,16 +104,16 @@ FILE FORMAT Simple dates Within a journal file, transaction dates use Y/M/D (or Y-M-D or Y.M.D) Leading zeros are optional. The year may be omitted, in which case it - will be inferred from the context - the current transaction, the de- - fault year set with a default year directive, or the current date when - the command is run. Some examples: 2010/01/31, 1/31, 2010-01-31, + 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, 1/31, 2010-01-31, 2010.1.31. Secondary dates Real-life transactions sometimes involve more than one date - eg the date you write a cheque, and the date it clears in your bank. When you - want to model this, eg for more accurate balances, you can specify in- - dividual posting dates, which I recommend. Or, you can use the sec- + want to model this, eg for more accurate balances, you can specify + individual posting dates, which I recommend. Or, you can use the sec- ondary dates (aka auxiliary/effective dates) feature, supported for compatibility with Ledger. @@ -142,15 +142,15 @@ FILE FORMAT Secondary dates require some effort; you must use them consistently in your journal entries and remember whether to use or not use the --date2 flag for your reports. They are included in hledger for Ledger compat- - ibility, but posting dates are a more powerful and less confusing al- - ternative. + ibility, but posting dates are a more powerful and less confusing + alternative. Posting 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 re- - ports, and the deduction from checking should be reported on 6/1 for + precisely. Eg in this example the expense should appear in May + reports, and the deduction from checking should be reported on 6/1 for easy bank reconciliation: 2015/5/30 @@ -177,9 +177,9 @@ FILE FORMAT Status Transactions, or individual postings within a transaction, can have a - status mark, which is a single character before the transaction de- - scription or posting account name, separated from it by a space, indi- - cating one of three statuses: + status mark, which is a single character before the transaction + description or posting account name, separated from it by a space, + indicating one of three statuses: mark status ------------------ @@ -192,8 +192,8 @@ FILE FORMAT 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 un- - marked for clarity. + is called "uncleared". As of hledger 1.3 we have renamed it to + unmarked for clarity. To replicate Ledger and old hledger's behaviour of also matching pend- ing, combine -U and -P. @@ -215,8 +215,8 @@ FILE FORMAT rect With this scheme, you would use -PC to see the current balance at your - bank, -U to see things which will probably hit your bank soon (like un- - cashed checks), and no flags to see the most up-to-date state of 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. Description @@ -229,9 +229,9 @@ FILE FORMAT Payee and note You can optionally include a | (pipe) character in descriptions to sub- divide the description into separate fields for payee/payer name on the - left (up to the first |) and an additional note field on the right (af- - ter the first |). This may be worthwhile if you need to do more pre- - cise querying and pivoting by payee or by note. + 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. Account names Account names typically have several parts separated by a full colon, @@ -580,11 +580,11 @@ FILE FORMAT 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 de- - scription and/or indented on the following lines (before the postings). - Similarly, you can attach comments to an individual posting by writing - them after the amount and/or indented on the following lines. Transac- - tion and posting comments must begin with a semicolon (;). + You can attach comments to a transaction by writing them after the + description and/or indented on the following lines (before the post- + ings). Similarly, you can attach comments to an individual posting by + writing them after the amount and/or indented on the following lines. + Transaction and posting comments must begin with a semicolon (;). Some examples: @@ -660,33 +660,33 @@ FILE FORMAT here is a table summarising the directives and their effects, with links to more detailed docs. - direc- end di- subdi- purpose can affect (as of - tive rective rec- 2018/06) + direc- end subdi- purpose can affect (as of + tive directive rec- 2018/06) tives ------------------------------------------------------------------------------------ - account any document account names, de- all entries in all - text clare 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 in- - aliases line/included en- - tries until end of - current file or end - directive - apply end apply prepend a common parent to following in- - account account account names line/included en- - tries until end of - current file or end - directive - comment end com- ignore part of journal following in- - ment line/included en- - tries until end of - current file or end - directive + alias end rewrite account names following + aliases inline/included + entries until end + of current file or + end directive + apply end apply prepend a common parent to following + account account account names inline/included + entries until end + of current file or + end directive + comment end com- ignore part of journal following + ment inline/included + entries until end + of current file or + end directive commod- format declare a commodity and its number notation: ity number notation & display following entries style in that commodity @@ -709,13 +709,13 @@ FILE FORMAT include include entries/directives what the included from another file directives affect P declare a market price for a amounts of that - commodity commodity in re- - ports, when -V is + commodity commodity in + reports, when -V is used - Y declare a year for yearless following in- - dates line/included en- - tries until end of - current file + Y declare a year for yearless following + dates inline/included + entries until end + of current file And some definitions: @@ -731,8 +731,8 @@ FILE FORMAT scope are 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 (re- - ports). Some directives have multiple effects. + affect, and whether they are focussed on input (parsing) or output + (reports). Some directives have multiple effects. If you have a journal made up of multiple files, or pass multiple -f options on the command line, note that directives which affect input @@ -756,8 +756,8 @@ FILE FORMAT file. The include file path may contain common glob patterns (e.g. *). - The include directive can only be used in journal files. It can in- - clude journal, timeclock or timedot files, but not CSV files. + The include directive can only be used in journal files. It can + include journal, timeclock or timedot files, but not CSV files. Default year You can set a default year to be used for subsequent dates which don't @@ -813,8 +813,8 @@ FILE FORMAT Normally the display format is inferred from journal entries, but this can be unpredictable; declaring it with a commodity directive overrides - this and removes ambiguity. Towards this end, amounts in commodity di- - rectives must always be written with a decimal point (a period or + this and removes ambiguity. Towards this end, amounts in commodity + directives must always be written with a decimal point (a period or comma, followed by 0 or more decimal digits). Commodity directives do not affect how amounts are parsed; the parser @@ -839,8 +839,8 @@ FILE FORMAT a decimal point. Market prices - The P directive declares a market price, which is an exchange rate be- - tween two commodities on a certain date. (In Ledger, they are called + 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. @@ -865,8 +865,8 @@ FILE FORMAT commodity using these prices. Declaring accounts - account directives can be used to pre-declare accounts. Though not re- - quired, they can provide several benefits: + account directives can be used to pre-declare accounts. Though not + required, they can provide several benefits: o They can document your intended chart of accounts, providing a refer- ence. @@ -925,8 +925,8 @@ FILE FORMAT detected automatically. Account types declared with tags - More generally, you can declare an account's type with an account di- - rective, by writing a type: tag in a comment, followed by one of the + More generally, you can declare an account's type with an account + directive, by writing a type: tag in a comment, followed by one of the words Asset, Liability, Equity, Revenue, Expense, or one of the letters ALERX (case insensitive): @@ -1025,9 +1025,9 @@ FILE 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 re- - place any occurrence of the old account name with the new one. Subac- - counts are also affected. Eg: + 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" @@ -1092,9 +1092,9 @@ FILE FORMAT end aliases Default parent account - You can specify a parent account which will be prepended to all ac- - counts within a section of the journal. Use the apply account and end - apply account directives like so: + 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 @@ -1128,11 +1128,44 @@ FILE FORMAT account. Periodic transactions - Periodic transaction rules describe transactions that recur. They al- - low you to generate future transactions for forecasting, without having - to write them out explicitly in the journal (with --forecast). Sec- - ondly, they also can be used to define budget goals (with --budget). + 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. Secondly, they are also + used to define the budgets shown in budget reports. + 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 - + read about this below. + + 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- + casted 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 + 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 + error. + + 7. Other period expressions with an interval are automatically expanded + to cover a whole number of that interval. (This is done to improve + reports, but it also affects periodic transactions. Yes, it's a bit + inconsistent with the above.) Eg: ~ every 10th day of month from + 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 rule syntax 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.): @@ -1150,7 +1183,7 @@ FILE FORMAT date, unless a Y default year directive is in effect, in which case they will be relative to Y/1/1. - Two spaces after the period expression + 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 where the period expression ends, so that descriptions can not acciden- @@ -1163,9 +1196,17 @@ FILE FORMAT assets:bank:checking $1500 income:acme inc + So, + + 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 + expression. + Forecasting with periodic transactions - With the --forecast flag, each periodic transaction rule generates fu- - ture transactions recurring at the specified interval. These are not + With the --forecast flag, each periodic transaction rule generates + future transactions recurring at the specified interval. These are not saved in the journal, but appear in all reports. They will look like normal transactions, but with an extra tag: @@ -1220,8 +1261,8 @@ FILE FORMAT checking) every month. Goals and actual performance can then be com- pared in budget reports. - For more details, see: balance: Budget report and Cookbook: Budgeting - and Forecasting. + For more details, see: balance: Budget report and Budgeting and Fore- + casting. Auto postings / transaction modifiers Transaction modifier rules, AKA auto posting rules, describe changes to diff --git a/hledger-lib/hledger_timedot.txt b/hledger-lib/hledger_timedot.txt index 6fd2a5b6b..1f4cc5ccd 100644 --- a/hledger-lib/hledger_timedot.txt +++ b/hledger-lib/hledger_timedot.txt @@ -28,8 +28,8 @@ FILE FORMAT Quantities can be written as: - o a sequence of dots (.) representing quarter hours. Spaces may op- - tionally be used for grouping and readability. Eg: .... .. + o a sequence of dots (.) representing quarter hours. Spaces may + optionally be used for grouping and readability. Eg: .... .. o an integral or decimal number, representing hours. Eg: 1.5 diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt index e7f9f2c88..fb12e24c0 100644 --- a/hledger-ui/hledger-ui.txt +++ b/hledger-ui/hledger-ui.txt @@ -117,8 +117,8 @@ OPTIONS using period expressions syntax --date2 - match the secondary date instead (see command help for other ef- - fects) + match the secondary date instead (see command help for other + effects) -U --unmarked include only unmarked postings/txns (can combine with -P or -C) @@ -204,8 +204,8 @@ KEYS BACKSPACE or DELETE removes all filters, showing all transactions. As mentioned above, hledger-ui shows auto-generated periodic transac- - tions, and hides future transactions (auto-generated or not) by de- - fault. F toggles showing and hiding these future transactions. This + tions, and hides future transactions (auto-generated or not) by + default. F toggles showing and hiding these future transactions. This is similar to using a query like date:-tomorrow, but more convenient. (experimental) @@ -227,8 +227,8 @@ KEYS file. This allows some basic data entry. A is like a, but runs the hledger-iadd tool, which provides a curses- - style interface. This key will be available if hledger-iadd is in- - stalled in $PATH. + style 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 cursor @@ -250,35 +250,36 @@ SCREENS Account names are shown as a flat list by default. Press T to toggle tree mode. In flat mode, account balances are exclusive of subac- - counts, except where subaccounts are hidden by a depth limit (see be- - low). In tree mode, all account balances are inclusive of subaccounts. + counts, except where subaccounts are hidden by a depth limit (see + below). In tree mode, all account balances are inclusive of subac- + counts. - To see less detail, press a number key, 1 to 9, to set a depth limit. + To see less detail, press a number key, 1 to 9, to set a depth limit. Or use - to decrease and +/= to increase the depth limit. 0 shows even - less detail, collapsing all accounts to a single total. To remove the - depth limit, set it higher than the maximum account depth, or press ES- - CAPE. + 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. His- - torical 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 be- - fore the report start date, so they show the change in balance during + torical 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. 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 in- - cluded; and if you activate all three, the filter is removed.) + 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. - Z toggles nonzero mode, in which only accounts with nonzero balances - are shown (hledger-ui shows zero items by default, unlike command-line + 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. @@ -287,63 +288,63 @@ SCREENS This screen shows the transactions affecting a particular account, like a check register. Each line represents one transaction and shows: - o the other account(s) involved, in abbreviated form. (If there are - both real and virtual postings, it shows only the accounts affected + o 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.) - o the overall change to the current account's balance; positive for an + o the overall change to the current account's balance; positive for an inflow to this account, negative for an outflow. o 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 + 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 + 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 + 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 flat - mode but this account has subaccounts which are not shown due to a - depth limit. In other words, the register always shows the transac- + mode but this account has subaccounts which are not shown due to a + depth limit. In other words, the register always shows the transac- tions contributing to the balance shown on the accounts screen. Tree mode/flat mode can be toggled with T here also. - U toggles filtering by unmarked status, showing or hiding unmarked + U toggles filtering by unmarked status, showing or hiding unmarked transactions. Similarly, P toggles pending transactions, and C toggles - cleared transactions. (By default, transactions with all statuses are - shown; if you activate one or two status filters, only those transac- + cleared transactions. (By default, transactions with all statuses are + shown; if you activate one or two status filters, only those transac- tions are shown; and if you activate all three, the filter is removed.) R toggles real mode, in which virtual postings are ignored. - Z toggles nonzero mode, in which only transactions posting a nonzero - change are shown (hledger-ui shows zero items by default, unlike com- + Z toggles nonzero mode, in which only transactions posting a nonzero + change are shown (hledger-ui shows zero items by default, unlike com- mand-line hledger). Press right (or enter) to view the selected transaction in detail. Transaction screen - This screen shows a single transaction, as a general journal entry, - similar to hledger's print command and journal format (hledger_jour- + This screen shows a single transaction, as a general journal entry, + similar to hledger's print command and journal format (hledger_jour- nal(5)). - The transaction's date(s) and any cleared flag, transaction code, de- - scription, 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). + The transaction's date(s) and any cleared flag, transaction code, + 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 vary de- - pending on which account register you came from (remember most transac- - tions appear in multiple account registers). The #N number preceding + 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 trans- + actions appear in multiple account registers). The #N number preceding them is the transaction's position within the complete unfiltered jour- nal, which is a more stable id (at least until the next reload). Error screen - 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 + 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 to cancel the reload attempt.) @@ -351,17 +352,17 @@ ENVIRONMENT 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.jour- + ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- nal). FILES - Reads data from one or more files in hledger journal, timeclock, time- - dot, or CSV format specified with -f, or $LEDGER_FILE, or - $HOME/.hledger.journal (on windows, perhaps + Reads data from one or more files in hledger journal, timeclock, time- + dot, or CSV format specified with -f, or $LEDGER_FILE, or + $HOME/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.journal). BUGS - The need to precede options with -- when invoked from hledger is awk- + The need to precede options with -- when invoked from hledger is awk- ward. -f- doesn't work (hledger-ui can't read from stdin). @@ -369,24 +370,24 @@ BUGS -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 there is no + 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, 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. Symp- - toms include: unresponsive UI, periodic resetting of the cursor posi- + --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. Symp- + toms include: unresponsive UI, periodic resetting of the cursor posi- tion, momentary display of parse errors, high CPU usage eventually sub- siding, 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 + Also, if you are viewing files mounted from another machine, --watch requires that both machine clocks are roughly in step. REPORTING BUGS - Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel + Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel or hledger mail list) @@ -400,7 +401,7 @@ COPYRIGHT SEE ALSO - hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), + hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- dot(5), ledger(1) diff --git a/hledger-web/hledger-web.txt b/hledger-web/hledger-web.txt index 50b5bb29c..26cd98e52 100644 --- a/hledger-web/hledger-web.txt +++ b/hledger-web/hledger-web.txt @@ -19,9 +19,9 @@ DESCRIPTION hledger-web is hledger's web interface. It starts a simple web appli- cation 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 (ac- - counts, the current account register, balance charts) and allowing his- - tory-aware data entry, interactive searching, and bookmarking. + 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 @@ -127,8 +127,8 @@ OPTIONS using period expressions syntax --date2 - match the secondary date instead (see command help for other ef- - fects) + match the secondary date instead (see command help for other + effects) -U --unmarked include only unmarked postings/txns (can combine with -P or -C) @@ -214,8 +214,8 @@ PERMISSIONS You can restrict who can reach it by o setting the IP address it listens on (see --host above). By default - it listens on 127.0.0.1, accessible to all users on the local ma- - chine. + it listens on 127.0.0.1, accessible to all users on the local + machine. o putting it behind an authenticating proxy, using eg apache or nginx @@ -231,8 +231,8 @@ PERMISSIONS o add - allows adding new transactions to the main journal file - o manage - allows editing, uploading or downloading the main or in- - cluded files + o manage - allows editing, uploading or downloading the main or + included files o using the --capabilities-header=HTTPHEADER flag to specify a HTTP header from which it will read capabilities to enable. hledger-web @@ -242,8 +242,8 @@ PERMISSIONS EDITING, UPLOADING, DOWNLOADING If you enable the manage capability mentioned above, you'll see a new "spanner" button to the right of the search form. Clicking this will - let you edit, upload, or download the journal file or any files it in- - cludes. + let you edit, upload, or download the journal file or any files it + includes. Note, unlike any other hledger command, in this mode you (or any visi- tor) can alter or wipe the data files. @@ -262,8 +262,8 @@ RELOADING hledger-web detects changes made to the files by other means (eg if you edit it directly, outside of hledger-web), and it will show the new data when you reload the page or navigate to a new page. If a change - makes a file unparseable, hledger-web will display an error message un- - til the file has been fixed. + makes a file unparseable, hledger-web will display an error message + until the file has been fixed. (Note: if you are viewing files mounted from another machine, make sure that both machine clocks are roughly in step.) diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 7c4a0ada8..bf9def30b 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -3634,7 +3634,7 @@ account, but it\[aq]s superseded now by the built-in roi command. .SS Experimental add-ons .PP These are available in source form in the hledger repo\[aq]s bin/ -directory; installing them is pretty easy. +directory. They may be less mature and documented than built-in commands. Reading and tweaking these is a good way to start making your own! .SS autosync diff --git a/hledger/hledger.info b/hledger/hledger.info index bf6fbb014..07abf5e6d 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -3119,10 +3119,9 @@ File: hledger.info, Node: Experimental add-ons, Prev: Third party add-ons, Up 5.3 Experimental add-ons ======================== -These are available in source form in the hledger repo's bin/ directory; -installing them is pretty easy. They may be less mature and documented -than built-in commands. Reading and tweaking these is a good way to -start making your own! +These are available in source form in the hledger repo's bin/ directory. +They may be less mature and documented than built-in commands. Reading +and tweaking these is a good way to start making your own! * Menu: @@ -3328,11 +3327,11 @@ Node: irr108282 Ref: #irr108380 Node: Experimental add-ons108511 Ref: #experimental-add-ons108663 -Node: autosync108944 -Ref: #autosync109055 -Node: chart109294 -Ref: #chart109413 -Node: check109484 -Ref: #check109586 +Node: autosync108911 +Ref: #autosync109022 +Node: chart109261 +Ref: #chart109380 +Node: check109451 +Ref: #check109553  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index bf412c3ac..97c2a6b3b 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -176,8 +176,8 @@ OPTIONS using period expressions syntax --date2 - match the secondary date instead (see command help for other ef- - fects) + match the secondary date instead (see command help for other + effects) -U --unmarked include only unmarked postings/txns (can combine with -P or -C) @@ -218,14 +218,14 @@ OPTIONS Some reporting options can also be written as query arguments. Command options - To see options for a particular command, including command-specific op- - tions, run: hledger COMMAND -h. + To see options for a particular command, including command-specific + options, run: hledger COMMAND -h. Command-specific options must be written after the command name, eg: hledger print -x. - Additionally, if the command is an addon, you may need to put its op- - tions after a double-hyphen, eg: hledger ui -- --watch. Or, you can + Additionally, if the command is an addon, you may need to put its + options after a double-hyphen, eg: hledger ui -- --watch. Or, you can run the addon executable directly: hledger-ui --watch. Command arguments @@ -320,8 +320,8 @@ OPTIONS This requires a well-configured environment. Here are some tips: - o A system locale must be configured, and it must be one that can de- - code the characters being used. In bash, you can set a locale like + o 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 Trou- bleshooting. This step is essential - without it, hledger will quit on encountering a non-ascii character (as with all GHC-compiled pro- @@ -421,8 +421,8 @@ OPTIONS 201812 6 digit YYYYMM with valid year and month - Counterexamples - malformed digit sequences might give surprising re- - sults: + Counterexamples - malformed digit sequences might give surprising + results: 201813 6 digits with an invalid month is parsed as start @@ -472,9 +472,9 @@ OPTIONS ber 1st of the current year (11/30 will be the last date included) - -b thismonth all transactions on or af- - ter the 1st of the current - month + -b thismonth all transactions on or + after the 1st of the cur- + rent month -p thismonth all transactions in the current month date:2016/3/17- the above written as @@ -488,8 +488,8 @@ OPTIONS ance and activity will divide their reports into multiple subperiods. The basic intervals can be selected with one of -D/--daily, -W/--weekly, -M/--monthly, -Q/--quarterly, or -Y/--yearly. More com- - plex intervals may be specified with a period expression. Report in- - tervals can not be specified with a query. + plex intervals may be specified with a period expression. Report + intervals can not be specified with a query. Period expressions The -p/--period option accepts period expressions, a shorthand way of @@ -539,11 +539,11 @@ OPTIONS -p "2009/1/1" just that day; equivalent to "2009/1/1 to 2009/1/2" - The argument of -p can also begin with, or be, a report interval ex- - pression. The basic report intervals are daily, weekly, monthly, quar- - terly, 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: + 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: -p "weekly from 2009/1/1 to 2009/4/1" -p "monthly in 2008" @@ -551,8 +551,8 @@ OPTIONS 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 ex- - pression specifies different explicit start and end date. + will end on the last day of same period, even if associated period + expression specifies different explicit start and end date. For example: @@ -568,8 +568,8 @@ OPTIONS -p "yearly from 2009-12-29" - starts on 2009/01/01, first day of 2009 - The following more complex report intervals are also supported: bi- - weekly, bimonthly, every day|week|month|quarter|year, every N + The following more complex report intervals are also supported: + biweekly, bimonthly, every day|week|month|quarter|year, every N days|weeks|months|quarters|years. All of these will start on the first day of the requested period and @@ -582,8 +582,8 @@ OPTIONS 2008/03/01, ... -p "every 2 weeks" -- starts on closest preceeding Monday - -p "every 5 month from 2009/03" -- pe- - riods will have boundaries on + -p "every 5 month from 2009/03" -- + periods will have boundaries on 2009/03/01, 2009/08/01, ... If you want intervals that start on arbitrary day of your choosing and @@ -622,9 +622,9 @@ OPTIONS Depth limiting 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 de- - tail. This flag has the same effect as a depth: query argument (so -2, - --depth=2 or depth:2 are basically equivalent). + 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 basically equivalent). Pivoting Normally hledger sums amounts, and organizes them in a hierarchy, based @@ -662,8 +662,8 @@ OPTIONS -------------------- 0 - One way to show only amounts with a member: value (using a query, de- - scribed below): + 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 @@ -691,8 +691,8 @@ OPTIONS is today (equivalent to --value=now); for multiperiod reports, it is the last day of each subperiod (equivalent to --value=end). - The default valuation commodity is the one referenced in the latest ap- - plicable market price dated on or before the valuation date. If most + The default valuation commodity is the one referenced in the latest + applicable market price dated on or before the valuation date. If most of your P declarations lead to a single home currency, this will usu- ally be what you want. (To specify the commodity, see -X below.) @@ -782,8 +782,8 @@ OPTIONS o reverse prices (declared prices from valuation to source commodity, inverted) - o indirect prices (prices calculated from the shortest chain of de- - clared or reverse prices from source to valuation commodity) + o indirect prices (prices calculated from the shortest chain of + declared or reverse prices from source to valuation commodity) in that order. @@ -862,8 +862,8 @@ OPTIONS 2000/03/01 (a) 1 B - You may need to explicitly set a commodity's display style, when re- - verse prices are used. Eg this output might be surprising: + 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 @@ -897,8 +897,8 @@ OPTIONS Effect of --value on reports Here is a reference for how --value currently affects each part of hledger's reports. It's work in progress, but may be useful for trou- - bleshooting or reporting bugs. See also the definitions and notes be- - low. If you find problems, please report them, ideally with a repro- + bleshooting or reporting bugs. See also the definitions and notes + below. If you find problems, please report them, ideally with a repro- ducible example. Related: #329, #1083. Report type -B, -V, -X --value=end --value=DATE, @@ -908,8 +908,8 @@ OPTIONS posting cost value at report value at report value at amounts end or today or journal end DATE/today balance asser- unchanged unchanged unchanged unchanged - tions / as- - signments + tions / + assignments register starting bal- cost value at day value at day value at @@ -924,8 +924,8 @@ OPTIONS ing amounts cost ends ends DATE/today (with report interval) - running to- sum/average of sum/average of sum/average of sum/average - tal/average displayed val- displayed val- displayed val- of displayed + running sum/average of sum/average of sum/average of sum/average + total/average displayed val- displayed val- displayed val- of displayed ues ues ues values balance (bs, @@ -939,53 +939,54 @@ OPTIONS val) postings postings sums of post- ings starting bal- sums of costs sums of post- sums of post- sums of post- - ances (with of postings ings before re- ings before re- ings before - report inter- before report port start port start report start + ances (with of postings ings before ings before ings before + report inter- before report report start report start report start val and -H) start budget amounts like balances like balances like balances like balances with --budget grand total sum of dis- sum of dis- sum of dis- sum of dis- - (no report in- played values played values played values played values - terval) + (no report played values played values played values played values + interval) - row totals/av- sums/averages sums/averages sums/averages sums/averages - erages (with of displayed of displayed of displayed of displayed - report inter- values values values values + row sums/averages sums/averages sums/averages sums/averages + totals/aver- of displayed of displayed of displayed of displayed + ages (with values values values values + report inter- val) - column totals sums of dis- sums of dis- sums of dis- sums of dis- + column totals sums of dis- sums of dis- sums of dis- sums of dis- played values played values played values played values - grand to- sum/average of sum/average of sum/average of sum/average - tal/average column totals column totals column totals of column to- - tals + grand sum/average of sum/average of sum/average of sum/average + total/average column totals column totals column totals of column + totals Additional notes 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). @@ -993,16 +994,16 @@ OPTIONS The rightmost of these flags wins. Output destination - Some commands (print, register, stats, the balance commands) can write - their output to a destination other than the console. This is con- + Some commands (print, register, stats, the balance commands) can write + their output to a destination other than the console. This is con- trolled by the -o/--output-file option. $ hledger balance -o - # write to stdout (the default) $ hledger balance -o FILE # write to FILE Output format - Some commands can write their output in other formats. Eg print and - register can output CSV, and the balance commands can output CSV or + Some commands can write their output in other formats. Eg print and + register can output CSV, and the balance commands can output CSV or HTML. This is controlled by the -O/--output-format option, or by spec- ifying a .csv or .html file extension with -o/--output-file. @@ -1012,56 +1013,56 @@ OPTIONS Regular expressions hledger uses regular expressions in a number of places: - o query terms, on the command line and in the hledger-web search form: + o query terms, on the command line and in the hledger-web search form: REGEX, desc:REGEX, cur:REGEX, tag:...=REGEX o CSV rules conditional blocks: if REGEX ... - o account alias directives and options: alias /REGEX/ = REPLACEMENT, + o account alias directives and options: alias /REGEX/ = REPLACEMENT, --alias /REGEX/=REPLACEMENT - hledger's regular expressions come from the regex-tdfa library. In + hledger's regular expressions come from the regex-tdfa library. In general they: o are case insensitive - o are infix matching (do not need to match the entire thing being + o are infix matching (do not need to match the entire thing being matched) o are POSIX extended regular expressions o also support GNU word boundaries (\<, \>, \b, \B) - o and parenthesised capturing groups and numeric backreferences in re- - placement strings + o and parenthesised capturing groups and numeric backreferences in + replacement strings o do not support mode modifiers like (?s) Some things to note: - o In the alias directive and --alias option, regular expressions must - be enclosed in forward slashes (/REGEX/). Elsewhere in hledger, + o In the alias directive and --alias option, regular expressions must + be enclosed in forward slashes (/REGEX/). Elsewhere in hledger, these are not required. - o In queries, to match a regular expression metacharacter like $ as a - literal character, prepend a backslash. Eg to search for amounts + o 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:\$. - o On the command line, some metacharacters like $ have a special mean- + o On the command line, some metacharacters like $ have a special mean- ing to the shell and so must be escaped at least once more. See Spe- cial characters. QUERIES - One of hledger's strengths is being able to quickly report on precise - subsets of your data. Most commands accept an optional query expres- - sion, written as arguments after the command name, to filter the data - by date, account name or other criteria. The syntax is similar to a + One of hledger's strengths is being able to quickly report on precise + subsets of your data. Most commands accept an optional query expres- + sion, written as arguments after the command name, to filter the data + by date, account name or other criteria. The syntax is similar to a web search: one or more space-separated search terms, quotes to enclose - whitespace, prefixes to match specific fields, a not: prefix to negate + whitespace, prefixes to match specific fields, a not: prefix to negate the match. - We do not yet support arbitrary boolean combinations of search terms; - instead most commands show transactions/postings/accounts which match + We do not yet support arbitrary boolean combinations of search terms; + instead most commands show transactions/postings/accounts which match (or negatively match): o any of the description terms AND @@ -1082,31 +1083,31 @@ QUERIES o match all the other terms. - The following kinds of search terms can be used. Remember these can + The following kinds of search terms can be used. Remember these can also be prefixed with not:, eg to exclude a particular subaccount. REGEX, acct:REGEX - match account names by this regular expression. (With no pre- + match account names by this regular expression. (With no pre- fix, acct: is assumed.) same as above amt:N, amt:N, amt:>=N - match postings with a single-commodity amount that is equal to, - less than, or greater than N. (Multi-commodity amounts are not + match postings with a single-commodity amount that is equal to, + less than, or greater than N. (Multi-commodity amounts are not tested, and will always match.) The comparison has two modes: if N is preceded by a + or - sign (or is 0), the two signed numbers - are compared. Otherwise, the absolute magnitudes are compared, + are compared. Otherwise, the absolute magnitudes are compared, ignoring sign. code:REGEX match by transaction code (eg check number) cur:REGEX - match postings or transactions including any amounts whose cur- - rency/commodity symbol is fully matched by REGEX. (For a par- + match postings or transactions including any amounts whose cur- + rency/commodity symbol is fully matched by REGEX. (For a par- tial match, use .*REGEX.*). Note, to match characters which are regex-significant, like the dollar sign ($), you need to prepend - \. And when using the command line you need to add one more - level of quoting to hide it from the shell, so eg do: hledger + \. And when using the command line you need to add one more + level of quoting to hide it from the shell, so eg do: hledger print cur:'\$' or hledger print cur:\\$. desc:REGEX @@ -1114,20 +1115,20 @@ QUERIES date:PERIODEXPR match dates within the specified period. PERIODEXPR is a period - expression (with no report interval). Examples: date:2016, - date:thismonth, date:2000/2/1-2/15, date:lastweek-. If the - --date2 command line flag is present, this matches secondary + expression (with no report interval). Examples: date:2016, + date:thismonth, date:2000/2/1-2/15, date:lastweek-. If the + --date2 command line flag is present, this matches secondary dates instead. date2:PERIODEXPR match secondary dates within the specified period. depth:N - match (or display, depending on command) accounts at or above + match (or display, depending on command) accounts at or above this depth note:REGEX - match transaction notes (part of description right of |, or + match transaction notes (part of description right of |, or whole description when there's no |) payee:REGEX @@ -1141,51 +1142,51 @@ QUERIES match unmarked, pending, or cleared transactions respectively tag:REGEX[=REGEX] - match by tag name, and optionally also by tag value. Note a - tag: query is considered to match a transaction if it matches - any of the postings. Also remember that postings inherit the + match by tag name, and optionally also by tag value. Note a + tag: query is considered to match a transaction if it matches + any of the postings. Also remember that postings inherit the tags of their parent transaction. The following special search term is used automatically in hledger-web, only: inacct:ACCTNAME - tells hledger-web to show the transaction register for this ac- - count. Can be filtered further with acct etc. + tells hledger-web to show the transaction register for this + account. Can be filtered further with acct etc. Some of these can also be expressed as command-line options (eg depth:2 - is equivalent to --depth 2). Generally you can mix options and query - arguments, and the resulting query will be their intersection (perhaps + is equivalent to --depth 2). Generally you can mix options and query + arguments, and the resulting query will be their intersection (perhaps excluding the -p/--period option). COMMANDS - hledger provides a number of subcommands; hledger with no arguments + hledger provides a number of subcommands; hledger with no arguments shows a list. If you install additional hledger-* packages, or if you put programs or - scripts named hledger-NAME in your PATH, these will also be listed as + scripts named hledger-NAME in your PATH, these will also be listed as subcommands. - Run a subcommand by writing its name as first argument (eg hledger in- - comestatement). You can also write one of the standard short aliases - displayed in parentheses in the command list (hledger b), or any any + Run a subcommand by writing its name as first argument (eg hledger + incomestatement). You can also write one of the standard short aliases + displayed in parentheses in the command list (hledger b), or any any unambiguous prefix of a command name (hledger inc). - Here are all the builtin commands in alphabetical order. See also - hledger for a more organised command list, and hledger CMD -h for de- - tailed command help. + Here are all the builtin commands in alphabetical order. See also + hledger for a more organised command list, and hledger CMD -h for + detailed command help. accounts accounts, a 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: @@ -1204,8 +1205,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: @@ -1220,22 +1221,22 @@ COMMANDS add Prompt for transactions and add them to the journal. - 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 de- - scription) 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. @@ -1243,20 +1244,20 @@ 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. o Comments and tags may be entered following a description or amount. - o If you make a mistake, enter < at any prompt to restart the transac- + o If you make a mistake, enter < at any prompt to restart the transac- tion. - 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): @@ -1286,8 +1287,8 @@ COMMANDS Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ - On Microsoft Windows, the add command makes sure that no part of the - file path ends with a period, as it can cause data loss on that plat- + On Microsoft Windows, the add command makes sure that no part of the + file path ends with a period, as it can cause data loss on that plat- form (cf #1056). balance @@ -1295,29 +1296,29 @@ COMMANDS Show accounts and their balances. The balance command is hledger's most versatile command. Note, despite - the name, it is not always used for showing real-world account bal- - ances; the more accounting-aware balancesheet and incomestatement may + the name, it is not always used for showing real-world account bal- + ances; the more accounting-aware balancesheet and incomestatement may be more convenient for that. By default, it displays all accounts, and each account's change in bal- ance during the entire period of the journal. Balance changes are cal- - culated by adding up the postings in each account. You can limit the - postings matched, by a query, to see fewer accounts, changes over a + culated by adding up the postings in each account. You can limit the + postings matched, by a query, to see fewer accounts, changes over a different time period, changes from only cleared transactions, etc. If you include an account's complete history of postings in the report, - the balance change is equivalent to the account's current ending bal- - ance. For a real-world account, typically you won't have all transac- + the balance change is equivalent to the account's current ending bal- + ance. For a real-world account, typically you won't have all transac- tions in the journal; instead you'll have all transactions after a cer- - tain date, and an "opening balances" transaction setting the correct - starting balance on that date. Then the balance command will show + tain date, and an "opening balances" transaction setting the correct + starting balance on that date. Then the balance command will show real-world account balances. In some cases the -H/--historical flag is used to ensure this (more below). The balance command can produce several styles of report: Classic balance report - This is the original balance report, as found in Ledger. It usually + This is the original balance report, as found in Ledger. It usually looks like this: $ hledger balance @@ -1334,23 +1335,23 @@ COMMANDS -------------------- 0 - By default, accounts are displayed hierarchically, with subaccounts in- - dented below their parent. At each level of the tree, accounts are - sorted by account code if any, then by account name. Or with + By default, accounts are displayed hierarchically, with subaccounts + indented below their parent. At each level of the tree, accounts are + sorted by account code if any, then by account name. Or with -S/--sort-amount, by their balance amount. "Boring" accounts, which contain a single interesting subaccount and no - balance of their own, are elided into the following line for more com- - pact output. (Eg above, the "liabilities" account.) Use --no-elide to + balance of their own, are elided into the following line for more com- + pact output. (Eg above, the "liabilities" account.) Use --no-elide to prevent this. - Account balances are "inclusive" - they include the balances of any + Account balances are "inclusive" - they include the balances of any subaccounts. - Accounts which have zero balance (and no non-zero subaccounts) are + Accounts which have zero balance (and no non-zero subaccounts) are omitted. Use -E/--empty to show them. - A final total is displayed by default; use -N/--no-total to suppress + A final total is displayed by default; use -N/--no-total to suppress it, eg: $ hledger balance -p 2008/6 expenses --no-total @@ -1359,7 +1360,7 @@ COMMANDS $1 supplies Customising the classic balance report - You can customise the layout of classic balance reports with --format + You can customise the layout of classic balance reports with --format FMT: $ hledger balance --format "%20(account) %12(total)" @@ -1377,7 +1378,7 @@ COMMANDS 0 The FMT format string (plus a newline) specifies the formatting applied - to each account/balance pair. It may contain any suitable text, with + to each account/balance pair. It may contain any suitable text, with data fields interpolated like so: %[MIN][.MAX](FIELDNAME) @@ -1388,14 +1389,14 @@ COMMANDS o FIELDNAME must be enclosed in parentheses, and can be one of: - o depth_spacer - a number of spaces equal to the account's depth, or + o depth_spacer - a number of spaces equal to the account's depth, or if MIN is specified, MIN * depth spaces. o account - the account's name o total - the account's balance/posted total, right justified - Also, FMT can begin with an optional prefix to control how multi-com- + Also, FMT can begin with an optional prefix to control how multi-com- modity amounts are rendered: o %_ - render on multiple lines, bottom-aligned (the default) @@ -1404,22 +1405,22 @@ COMMANDS o %, - render on one line, comma-separated - There are some quirks. Eg in one-line mode, %(depth_spacer) has no ef- - fect, instead %(account) has indentation built in. Experimentation may - be needed to get pleasing results. + There are some quirks. Eg in one-line mode, %(depth_spacer) has no + effect, instead %(account) has indentation built in. Experimentation + may be needed to get pleasing results. Some example formats: o %(total) - the account's total - o %-20.20(account) - the account's name, left justified, padded to 20 + o %-20.20(account) - the account's name, left justified, padded to 20 characters and clipped at 20 characters - o %,%-50(account) %25(total) - account name padded to 50 characters, - total padded to 20 characters, with multiple commodities rendered on + o %,%-50(account) %25(total) - account name padded to 50 characters, + total padded to 20 characters, with multiple commodities rendered on one line - o %20(total) %2(depth_spacer)%-(account) - the default format for the + o %20(total) %2(depth_spacer)%-(account) - the default format for the single-column balance report Colour support @@ -1430,9 +1431,9 @@ COMMANDS o the output is not being redirected or piped anywhere Flat mode - To see a flat list instead of the default hierarchical display, use - --flat. In this mode, accounts (unless depth-clipped) show their full - names and "exclusive" balance, excluding any subaccount balances. In + To see a flat list instead of the default hierarchical display, use + --flat. In this mode, accounts (unless depth-clipped) show their full + names and "exclusive" balance, excluding any subaccount balances. In this mode, you can also use --drop N to omit the first few account name components. @@ -1441,8 +1442,8 @@ COMMANDS $1 supplies Depth limited balance reports - With --depth N or depth:N or just -N, balance reports show accounts - only to the specified numeric depth. This is very useful to summarise + With --depth N or depth:N or just -N, balance reports show accounts + only to the specified numeric depth. This is very useful to summarise a complex set of accounts and get an overview. $ hledger balance -N -1 @@ -1455,17 +1456,17 @@ COMMANDS inclusive balances at the depth limit. Multicolumn balance report - Multicolumn or tabular balance reports are a very useful hledger fea- - ture, and usually the preferred style. They share many of the above - features, but they show the report as a table, with columns represent- - ing time periods. This mode is activated by providing a reporting in- - terval. + Multicolumn or tabular balance reports are a very useful hledger fea- + ture, and usually the preferred style. They share many of the above + features, but they show the report as a table, with columns represent- + ing time periods. This mode is activated by providing a reporting + interval. - There are three types of multicolumn balance report, showing different + There are three types of multicolumn balance report, showing different information: 1. By default: each column shows the sum of postings in that period, ie - the account's change of balance in that period. This is useful eg + the account's change of balance in that period. This is useful eg for a monthly income statement: $ hledger balance --quarterly income expenses -E @@ -1480,8 +1481,8 @@ COMMANDS -------------------++--------------------------------- || $-1 $1 0 0 - 2. With --cumulative: each column shows the ending balance for that pe- - riod, accumulating the changes across periods, starting from 0 at + 2. With --cumulative: each column shows the ending balance for that + period, accumulating the changes across periods, starting from 0 at the report start date: $ hledger balance --quarterly income expenses -E --cumulative @@ -1497,8 +1498,8 @@ COMMANDS || $-1 0 0 0 3. With --historical/-H: each column shows the actual historical ending - balance for that period, accumulating the changes across periods, - starting from the actual balance at the report start date. This is + balance for that period, accumulating the changes across periods, + starting from the actual balance at the report start date. This is useful eg for a multi-period balance sheet, and when you are showing only the data after a certain start date: @@ -1517,26 +1518,26 @@ COMMANDS Note that --cumulative or --historical/-H disable --row-total/-T, since summing end balances generally does not make sense. - Multicolumn balance reports display accounts in flat mode by default; + Multicolumn balance reports display accounts in flat mode by default; to see the hierarchy, use --tree. - With a reporting interval (like --quarterly above), the report - start/end dates will be adjusted if necessary so that they encompass + With a reporting interval (like --quarterly above), the report + start/end dates will be adjusted if necessary so that they encompass the displayed report periods. This is so that the first and last peri- ods will be "full" and comparable to the others. - The -E/--empty flag does two things in multicolumn balance reports: - first, the report will show all columns within the specified report pe- - riod (without -E, leading and trailing columns with all zeroes are not - shown). Second, all accounts which existed at the report start date - will be considered, not just the ones with activity during the report - period (use -E to include low-activity accounts which would otherwise - would be omitted). + The -E/--empty flag does two things in multicolumn balance reports: + first, the report will show all columns within the specified report + period (without -E, leading and trailing columns with all zeroes are + not shown). Second, all accounts which existed at the report start + date will be considered, not just the ones with activity during the + report period (use -E to include low-activity accounts which would oth- + erwise would be omitted). The -T/--row-total flag adds an additional column showing the total for each row. - The -A/--average flag adds a column showing the average value in each + The -A/--average flag adds a column showing the average value in each row. Here's an example of all three: @@ -1560,21 +1561,21 @@ COMMANDS Limitations: In multicolumn reports the -V/--value flag uses the market price on the - report end date, for all columns (not the price on each column's end + report end date, for all columns (not the price on each column's end date). - Eliding of boring parent accounts in tree mode, as in the classic bal- + Eliding of boring parent accounts in tree mode, as in the classic bal- ance report, is not yet supported in multicolumn reports. Budget report - With --budget, extra columns are displayed showing budget goals for - each account and period, if any. Budget goals are defined by periodic - transactions. This is very useful for comparing planned and actual in- - come, expenses, time usage, etc. --budget is most often combined with - a report interval. + With --budget, extra columns are displayed showing budget goals for + each account and period, if any. Budget goals are defined by periodic + transactions. This is very useful for comparing planned and actual + income, expenses, time usage, etc. --budget is most often combined + with a report interval. - For example, you can take average monthly expenses in the common ex- - pense categories to construct a minimal monthly budget: + For example, you can take average monthly expenses in the common + expense categories to construct a minimal monthly budget: ;; Budget ~ monthly @@ -1620,25 +1621,25 @@ COMMANDS Note this is different from a normal balance report in several ways: - o Only accounts with budget goals during the report period are shown, + o Only accounts with budget goals during the report period are shown, by default. - o In each column, in square brackets after the actual amount, budgeted + o In each column, in square brackets after the actual amount, budgeted amounts are shown, along with the percentage of budget used. - o All parent accounts are always shown, even in flat mode. Eg assets, + o All parent accounts are always shown, even in flat mode. Eg assets, assets:bank, and expenses above. - o Amounts always include all subaccounts, budgeted or unbudgeted, even + o Amounts always include all subaccounts, budgeted or unbudgeted, even in flat mode. This means that the numbers displayed will not always add up! Eg above, - the expenses actual amount includes the gifts and supplies transac- - tions, but the expenses:gifts and expenses:supplies accounts are not + the expenses actual amount includes the gifts and supplies transac- + tions, but the expenses:gifts and expenses:supplies accounts are not shown, as they have no budget amounts declared. - This can be confusing. When you need to make things clearer, use the - -E/--empty flag, which will reveal all accounts including unbudgeted + This can be confusing. When you need to make things clearer, use the + -E/--empty flag, which will reveal all accounts including unbudgeted ones, giving the full picture. Eg: $ hledger balance -M --budget --empty @@ -1680,12 +1681,12 @@ COMMANDS For more examples, see Budgeting and Forecasting. Nested budgets - You can add budgets to any account in your account hierarchy. If you + You can add budgets to any account in your account hierarchy. If you have budgets on both parent account and some of its children, then bud- - get(s) of the child account(s) would be added to the budget of their + get(s) of the child account(s) would be added to the budget of their parent, much like account balances behave. - In the most simple case this means that once you add a budget to any + In the most simple case this means that once you add a budget to any account, all its parents would have budget as well. To illustrate this, consider the following budget: @@ -1695,14 +1696,14 @@ COMMANDS expenses:personal:electronics $100.00 liabilities - With this, monthly budget for electronics is defined to be $100 and - budget for personal expenses is an additional $1000, which implicity + With this, monthly budget for electronics is defined to be $100 and + budget for personal expenses is an additional $1000, which implicity means that budget for both expenses:personal and expenses is $1100. - Transactions in expenses:personal:electronics will be counted both to- - wards its $100 budget and $1100 of expenses:personal , and transactions - in any other subaccount of expenses:personal would be counted towards - 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 transac- + tions in any other subaccount of expenses:personal would be counted + towards only towards the budget of expenses:personal. For example, let's consider these transactions: @@ -1727,9 +1728,9 @@ COMMANDS expenses:personal $30.00 liabilities - As you can see, we have transactions in expenses:personal:electron- - ics:upgrades and expenses:personal:train tickets, and since both of - these accounts are without explicitly defined budget, these transac- + As you can see, we have transactions in expenses:personal:electron- + ics:upgrades and expenses:personal:train tickets, and since both of + these accounts are without explicitly defined budget, these transac- tions would be counted towards budgets of expenses:personal:electronics and expenses:personal accordingly: @@ -1745,7 +1746,7 @@ COMMANDS -------------------------------++------------------------------- || 0 [ 0] - And with --empty, we can get a better picture of budget allocation and + And with --empty, we can get a better picture of budget allocation and consumption: $ hledger balance --budget -M --empty @@ -1763,17 +1764,17 @@ COMMANDS || 0 [ 0] Output format - The balance command supports output destination and output format se- - lection. + The balance command supports output destination and output format + selection. balancesheet balancesheet, bs This command displays a simple balance sheet, showing historical ending - balances of asset and liability accounts (ignoring any report begin - date). It assumes that these accounts are under a top-level asset or + balances of asset and liability accounts (ignoring any report begin + date). It assumes that these accounts are under a top-level asset or liability account (case insensitive, plural forms also allowed). - Note this report shows all account balances with normal positive sign + Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). @@ -1799,19 +1800,19 @@ COMMANDS 0 With a reporting interval, multiple columns will be shown, one for each - report period. As with multicolumn balance reports, you can alter the - report mode with --change/--cumulative/--historical. Normally bal- - ancesheet shows historical ending balances, which is what you need for - a balance sheet; note this means it ignores report begin dates (and - -T/--row-total, since summing end balances generally does not make + report period. As with multicolumn balance reports, you can alter the + report mode with --change/--cumulative/--historical. Normally bal- + ancesheet shows historical ending balances, which is what you need for + a balance sheet; note this means it ignores report begin dates (and + -T/--row-total, since summing end balances generally does not make sense). - This command also supports output destination and output format selec- + This command also supports output destination and output format selec- tion. balancesheetequity balancesheetequity, bse - Just like balancesheet, but also reports Equity (which it assumes is + Just like balancesheet, but also reports Equity (which it assumes is under a top-level equity account). Example: @@ -1842,10 +1843,10 @@ COMMANDS cashflow cashflow, cf - This command displays a simple cashflow statement, showing changes in - "cash" accounts. It assumes that these accounts are under a top-level - asset account (case insensitive, plural forms also allowed) and do not - contain receivable or A/R in their name. Note this report shows all + This command displays a simple cashflow statement, showing changes in + "cash" accounts. It assumes that these accounts are under a top-level + asset account (case insensitive, plural forms also allowed) and do not + contain receivable or A/R in their name. Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). @@ -1866,81 +1867,81 @@ COMMANDS $-1 With a reporting interval, multiple columns will be shown, one for each - report period. Normally cashflow shows changes in assets per period, - though as with multicolumn balance reports you can alter the report + report period. Normally cashflow shows changes in assets per period, + though as with multicolumn balance reports you can alter the report mode with --change/--cumulative/--historical. - This command also supports output destination and output format selec- + This command also supports output destination and output format selec- tion. check-dates check-dates - Check that transactions are sorted by increasing date. With --date2, - checks secondary dates instead. With --strict, dates must also be - unique. With a query, only matched transactions' dates are checked. + Check that transactions are sorted by increasing date. With --date2, + checks secondary dates instead. With --strict, dates must also be + unique. With a query, only matched transactions' dates are checked. Reads the default journal file, or another specified with -f. check-dupes check-dupes - Reports account names having the same leaf but different prefixes. In - other words, two or more leaves that are categorized differently. + Reports account names having the same leaf but different prefixes. In + other words, two or more leaves that are categorized differently. Reads the default journal file, or another specified as an argument. An example: http://stefanorodighiero.net/software/hledger-dupes.html close close, equity - Prints a "closing balances" transaction and an "opening balances" + Prints a "closing balances" transaction and an "opening balances" transaction that bring account balances to and from zero, respectively. Useful for bringing asset/liability balances forward into a new journal - file, or for closing out revenues/expenses to retained earnings at the + file, or for closing out revenues/expenses to retained earnings at the end of a period. - The closing transaction transfers balances to "equity:closing bal- - ances". The opening transaction transfers balances from "equity:open- + The closing transaction transfers balances to "equity:closing bal- + ances". The opening transaction transfers balances from "equity:open- ing balances". You can choose to print just one of the transactions by using the --opening or --closing flag. If you split your journal files by time (eg yearly), you will typically - run this command at the end of the year, and save the closing transac- - tion as last entry of the old file, and the opening transaction as the - first entry of the new file. This makes the files self contained, so - that correct balances are reported no matter which of them are loaded. - Ie, if you load just one file, the balances are initialised correctly; - or if you load several files, the redundant closing/opening transac- - tions cancel each other out. (They will show up in print or register - reports; you can exclude them with a query like not:desc:'(open- + run this command at the end of the year, and save the closing transac- + tion as last entry of the old file, and the opening transaction as the + first entry of the new file. This makes the files self contained, so + that correct balances are reported no matter which of them are loaded. + Ie, if you load just one file, the balances are initialised correctly; + or if you load several files, the redundant closing/opening transac- + tions cancel each other out. (They will show up in print or register + reports; you can exclude them with a query like not:desc:'(open- ing|closing) balances'.) If you're running a business, you might also use this command to "close - the books" at the end of an accounting period, transferring income - statement account balances to retained earnings. (You may want to + the books" at the end of an accounting period, transferring income + statement account balances to retained earnings. (You may want to change the equity account name to something like "equity:retained earn- ings".) - By default, the closing transaction is dated yesterday, the balances - are calculated as of end of yesterday, and the opening transaction is - dated today. To close on some other date, use: hledger close -e OPEN- - INGDATE. Eg, to close/open on the 2018/2019 boundary, use -e 2019. + By default, the closing transaction is dated yesterday, the balances + are calculated as of end of yesterday, and the opening transaction is + dated today. To close on some other date, use: hledger close -e OPEN- + INGDATE. Eg, to close/open on the 2018/2019 boundary, use -e 2019. You can also use -p or date:PERIOD (any starting date is ignored). - Both transactions will include balance assertions for the closed/re- - opened accounts. You probably shouldn't use status or realness filters - (like -C or -R or status:) with this command, or the generated balance - assertions will depend on these flags. Likewise, if you run this com- - mand with --auto, the balance assertions will probably always require - --auto. + Both transactions will include balance assertions for the + closed/reopened accounts. You probably shouldn't use status or real- + ness filters (like -C or -R or status:) with this command, or the gen- + erated balance assertions will depend on these flags. Likewise, if you + run this command with --auto, the balance assertions will probably + always require --auto. - When account balances have cost information (transaction prices), the - closing/opening transactions will preserve it, so that eg balance -B + When account balances have cost information (transaction prices), the + closing/opening transactions will preserve it, so that eg balance -B reports will not be affected. Examples: - Carrying asset/liability balances into a new file for 2019, all from + Carrying asset/liability balances into a new file for 2019, all from command line: - Warning: we use >> here to append; be careful not to type a single > + Warning: we use >> here to append; be careful not to type a single > which would wipe your journal! $ hledger close -f 2018.journal -e 2019 assets liabilities --opening >>2019.journal @@ -1989,18 +1990,18 @@ COMMANDS diff diff - Compares a particular account's transactions in two input files. It + Compares a particular account's transactions in two input files. It shows any transactions to this account which are in one file but not in the other. More precisely, for each posting affecting this account in either file, - it looks for a corresponding posting in the other file which posts the - same amount to the same account (ignoring date, description, etc.) + it looks for a corresponding posting in the other file which posts the + same amount to the same account (ignoring date, description, etc.) Since postings not transactions are compared, this also works when mul- tiple bank transactions have been combined into a single journal entry. This is useful eg if you have downloaded an account's transactions from - your bank (eg as CSV data). When hledger and your bank disagree about + your bank (eg as CSV data). When hledger and your bank disagree about the account balance, you can compare the bank data with your journal to find out the cause. @@ -2018,20 +2019,20 @@ COMMANDS files files - List all files included in the journal. With a REGEX argument, only + List all files included in the journal. With a REGEX argument, only file names matching the regular expression (case sensitive) are shown. help help Show any of the hledger manuals. - The help command displays any of the main hledger manuals, in one of - several ways. Run it with no argument to list the manuals, or provide + The help command displays any of the main hledger manuals, in one of + several ways. Run it with no argument to list the manuals, or provide a full or partial manual name to select one. - hledger manuals are available in several formats. hledger help will - use the first of these display methods that it finds: info, man, - $PAGER, less, stdout (or when non-interactive, just stdout). You can + hledger manuals are available in several formats. hledger help will + use the first of these display methods that it finds: info, man, + $PAGER, less, stdout (or when non-interactive, just stdout). You can force a particular viewer with the --info, --man, --pager, --cat flags. Examples: @@ -2058,8 +2059,8 @@ COMMANDS import 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 transac- + 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 transac- tions that would be added. The input files are specified as arguments - no need to write -f before @@ -2070,36 +2071,36 @@ COMMANDS ing transactions are always added to the input files in increasing date order, and by saving .latest.FILE state files. - The --dry-run output is in journal format, so you can filter it, eg to + The --dry-run output is in journal format, so you can filter it, eg to see only uncategorised transactions: $ hledger import --dry ... | hledger -f- print unknown --ignore-assertions Importing balance assignments - Entries added by import will have their posting amounts made explicit - (like hledger print -x). This means that any balance assignments in - imported files must be evaluated; but, imported files don't get to see - the main file's account balances. As a result, importing entries with + Entries added by import will have their posting amounts made explicit + (like hledger print -x). This means that any balance assignments in + imported files must be evaluated; but, imported files don't get to see + the main file's account balances. As a result, importing entries with balance assignments (eg from an institution that provides only balances - and not posting amounts) will probably generate incorrect posting + and not posting amounts) will probably generate incorrect posting amounts. To avoid this problem, use print instead of import: $ hledger print IMPORTFILE [--new] >> $LEDGER_FILE - (If you think import should leave amounts implicit like print does, + (If you think import should leave amounts implicit like print does, please test it and send a pull request.) incomestatement incomestatement, is - This command displays a simple income statement, showing revenues and - expenses during a period. It assumes that these accounts are under a - top-level revenue or income or expense account (case insensitive, plu- - ral forms also allowed). Note this report shows all account balances - with normal positive sign (like conventional financial statements, un- - like balance/print/register) (experimental). + This command displays a simple income statement, showing revenues and + expenses during a period. It assumes that these accounts are under a + top-level revenue or income or expense account (case insensitive, plu- + ral forms also allowed). Note this report shows all account balances + with normal positive sign (like conventional financial statements, + unlike balance/print/register) (experimental). - This command displays a simple income statement. It currently assumes - that you have top-level accounts named income (or revenue) and expense + This command displays a simple income statement. It currently assumes + that you have top-level accounts named income (or revenue) and expense (plural forms also allowed.) $ hledger incomestatement @@ -2124,11 +2125,11 @@ COMMANDS 0 With a reporting interval, multiple columns will be shown, one for each - report period. Normally incomestatement shows revenues/expenses per - period, though as with multicolumn balance reports you can alter the + report period. Normally incomestatement shows revenues/expenses per + period, though as with multicolumn balance reports you can alter the report mode with --change/--cumulative/--historical. - This command also supports output destination and output format selec- + This command also supports output destination and output format selec- tion. notes @@ -2156,10 +2157,11 @@ COMMANDS prices prices - Print market price directives from the journal. With --costs, also - print synthetic market prices based on transaction prices. With --in- - verted-costs, also print inverse prices based on transaction prices. - Prices (and postings providing prices) can be filtered by a query. + 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. print print, txns, p @@ -2170,8 +2172,8 @@ COMMANDS tions are sorted by secondary date instead. print's output is always a valid hledger journal. - It preserves all transaction information, but it does not preserve di- - rectives or inter-transaction comments + It preserves all transaction information, but it does not preserve + directives or inter-transaction comments $ hledger print 2008/01/01 income @@ -2217,16 +2219,16 @@ COMMANDS cial state file (.latest.FILE in the same directory), containing the latest transaction date(s) that were seen last time FILE was read. When this file is found, only transactions with newer dates (and new - transactions on the latest date) are printed. This is useful for ig- - noring already-seen entries in import data, such as downloaded CSV + transactions on the latest date) are printed. This is useful for + ignoring already-seen entries in import data, such as downloaded CSV files. Eg: $ hledger -f bank1.csv print --new # shows transactions added since last print --new on this file - This assumes that transactions added to FILE always have same or in- - creasing dates, and that transactions on the same day do not get re- - ordered. See also the import command. + This assumes that transactions added to FILE always have same or + increasing dates, and that transactions on the same day do not get + reordered. See also the import command. This command also supports output destination and output format selec- tion. Here's an example of print's CSV output: @@ -2307,21 +2309,21 @@ COMMANDS The --average/-A flag shows the running average posting amount instead of the running total (so, the final number displayed is the average for the whole report period). This flag implies --empty (see below). It - is affected by --historical. It works best when showing just one ac- - count and one commodity. + is affected by --historical. It works best when showing just one + account and one commodity. The --related/-r flag shows the other postings in the transactions of the postings which would normally be shown. The --invert flag negates all amounts. For example, it can be used on an income account where amounts are normally displayed as negative num- - bers. It's also useful to show postings on the checking account to- - gether with the related account: + bers. It's also useful to show postings on the checking account + together with the related account: $ hledger register --related --invert assets:checking - With a reporting interval, register shows summary postings, one per in- - terval, aggregating the postings to each account: + 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 @@ -2344,8 +2346,8 @@ COMMANDS 2008/11 0 $-2 2008/12 0 $-2 - Often, you'll want to see just one line per interval. The --depth op- - tion helps with this, causing subaccounts to be aggregated: + 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 @@ -2353,8 +2355,8 @@ COMMANDS 2008/12 assets $-1 $-1 Note when using report intervals, if you specify start/end dates these - will be adjusted outward if necessary to contain a whole number of in- - tervals. This ensures that the first and last intervals are full + will be adjusted outward if necessary to contain a whole number of + intervals. This ensures that the first and last intervals are full length and comparable to the others in the report. Custom register output @@ -2363,9 +2365,9 @@ COMMANDS 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 de- - scription width as part of --width's argument, comma-separated: --width - W,D . Here's a diagram (won't display correctly in --help): + (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) ----------------------------------> date (10) description (D) account (W-41-D) amount (12) balance (12) @@ -2388,8 +2390,8 @@ COMMANDS Print the one posting whose transaction description is closest to DESC, in the style of the register command. If there are multiple equally good matches, it shows the most recent. Query options (options, not - arguments) can be used to restrict the search space. Helps ledger-au- - tosync detect already-seen transactions when importing. + arguments) can be used to restrict the search space. Helps ledger- + autosync detect already-seen transactions when importing. rewrite rewrite @@ -2429,10 +2431,10 @@ COMMANDS Argument for --add-posting option is a usual posting of transaction with an exception for amount specification. More precisely, you can use '*' (star symbol) before the amount to indicate that that this is a - factor for an amount of original matched posting. If the amount in- - cludes a commodity name, the new posting amount will be in the new com- - modity; otherwise, it will be in the matched posting amount's commod- - ity. + factor for an amount of original matched posting. If the amount + includes a commodity name, the new posting amount will be in the new + commodity; otherwise, it will be in the matched posting amount's com- + modity. Re-write rules in a file During the run this tool will execute so called "Automated Transac- @@ -2530,9 +2532,9 @@ COMMANDS originating from unrealized profit and loss account(s) are assumed to be your investments or withdrawals. - At a minimum, you need to supply a query (which could be just an ac- - count name) to select your investments with --inv, and another query to - identify your profit and loss transactions with --pnl. + At a minimum, you need to supply a query (which could be just an + account name) to select your investments with --inv, and another query + to identify your profit and loss transactions with --pnl. It will compute and display the internalized rate of return (IRR) and time-weighted rate of return (TWR) for your investments for the time @@ -2570,8 +2572,8 @@ COMMANDS List all the 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 --values flag, the tags' unique values are listed in- - stead. + considered. With --values flag, the tags' unique values are listed + instead. test test @@ -2590,8 +2592,8 @@ COMMANDS none of them). This is mainly used by developers, but it's nice to be able to sanity- - check your installed hledger executable at any time. All tests are ex- - pected to pass - if you ever see otherwise, something has gone wrong, + check your installed hledger executable at any time. All tests are + expected to pass - if you ever see otherwise, something has gone wrong, please report a bug! ADD-ON COMMANDS @@ -2650,19 +2652,18 @@ ADD-ON COMMANDS ing to various schemes. irr - hledger-irr calculates the internal rate of return of an investment ac- - count, but it's superseded now by the built-in roi command. + hledger-irr calculates the internal rate of return of an investment + account, but it's superseded now by the built-in roi command. Experimental add-ons These are available in source form in the hledger repo's bin/ direc- - tory; installing them is pretty easy. They may be less mature and doc- - umented than built-in commands. Reading and tweaking these is a good - way to start making your own! + tory. They may be less mature and documented than built-in commands. + Reading and tweaking these is a good way to start making your own! autosync hledger-autosync is a symbolic link for easily running ledger-autosync, - if installed. ledger-autosync does deduplicating conversion of OFX - data and some CSV formats, and can also download the data if your bank + if installed. ledger-autosync does deduplicating conversion of OFX + data and some CSV formats, and can also download the data if your bank offers OFX Direct Connect. chart @@ -2672,21 +2673,21 @@ ADD-ON COMMANDS hledger-check.hs checks more powerful account balance assertions. ENVIRONMENT - COLUMNS The screen width used by the register command. Default: the + COLUMNS The screen width used by the register command. 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.jour- + ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- nal). FILES - Reads data from one or more files in hledger journal, timeclock, time- - dot, or CSV format specified with -f, or $LEDGER_FILE, or - $HOME/.hledger.journal (on windows, perhaps + Reads data from one or more files in hledger journal, timeclock, time- + dot, or CSV format specified with -f, or $LEDGER_FILE, or + $HOME/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.journal). LIMITATIONS - The need to precede addon command options with -- when invoked from + The need to precede addon command options with -- when invoked from hledger is awkward. When input data contains non-ascii characters, a suitable system locale @@ -2702,33 +2703,33 @@ LIMITATIONS In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger add. - Not all of Ledger's journal file syntax is supported. See file format + 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 + On large data files, hledger is slower and uses more memory than Ledger. TROUBLESHOOTING - Here are some issues you might encounter when you run hledger (and re- - member you can also seek help from the IRC channel, mail list or bug + Here are some issues you might encounter when you run hledger (and + remember you can also seek help from the IRC channel, mail list or bug tracker): Successfully installed, but "No command 'hledger' found" stack and cabal install binaries into a special directory, which should - be added to your PATH environment variable. Eg on unix-like systems, + be added to your PATH environment variable. Eg on unix-like systems, that is ~/.local/bin and ~/.cabal/bin respectively. I set a custom LEDGER_FILE, but hledger is still using the default file - LEDGER_FILE should be a real environment variable, not just a shell - variable. The command env | grep LEDGER_FILE should show it. You may + LEDGER_FILE should be a real environment variable, not just a shell + variable. The command env | grep LEDGER_FILE should show it. You may need to use export. Here's an explanation. - "Illegal byte sequence" or "Invalid or incomplete multibyte or wide + "Illegal byte sequence" or "Invalid or incomplete multibyte or wide character" errors In order to handle non-ascii letters and symbols (like ), hledger needs an appropriate locale. This is usually configured system-wide; you can also configure it temporarily. The locale may need to be one that sup- - ports UTF-8, if you built hledger with GHC < 7.2 (or possibly always, + ports UTF-8, if you built hledger with GHC < 7.2 (or possibly always, I'm not sure yet). Here's an example of setting the locale temporarily, on ubuntu @@ -2747,7 +2748,7 @@ TROUBLESHOOTING $ echo "export LANG=en_US.UTF-8" >>~/.bash_profile $ bash --login - If we preferred to use eg fr_FR.utf8, we might have to install that + If we preferred to use eg fr_FR.utf8, we might have to install that first: $ apt-get install language-pack-fr @@ -2768,7 +2769,7 @@ TROUBLESHOOTING REPORTING BUGS - Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel + Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel or hledger mail list) @@ -2782,7 +2783,7 @@ COPYRIGHT SEE ALSO - hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), + hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- dot(5), ledger(1)