diff --git a/hledger-lib/hledger_journal.5 b/hledger-lib/hledger_journal.5 index 25c930781..0bbb7807b 100644 --- a/hledger-lib/hledger_journal.5 +++ b/hledger-lib/hledger_journal.5 @@ -1264,6 +1264,13 @@ followed by 0 or more decimal digits. Note hledger normally uses banker\[aq]s rounding, so 0.5 displayed with zero decimal digits is \[dq]0\[dq]. (More at Commodity display style.) +.SS Commodity error checking +.PP +In strict mode, enabled with the \f[C]-s\f[R]/\f[C]--strict\f[R] flag, +hledger will report an error if a commodity symbol is used that has not +been declared by a \f[C]commodity\f[R] directive. +This works similarly to account error checking, see the notes there for +more details. .SS Default commodity .PP The \f[C]D\f[R] directive sets a default commodity, to be used for @@ -1364,20 +1371,19 @@ hledger-style account name, eg this account directive declares the account assets:bank:checking \f[R] .fi -.SS Account existence +.SS Account error checking .PP By default, accounts come into existence when a transaction references -them. -This is convenient, but when you mis-spell an account name in a -transaction, hledger won\[aq]t be able to detect it. -Usually this isn\[aq]t a big problem, as you\[aq]ll notice the error in -balance reports, or when reconciling account balances. +them by name. +This is convenient, but it means hledger can\[aq]t warn you when you +mis-spell an account name in the journal. +Usually you\[aq]ll find the error later, as an extra account in balance +reports, or an incorrect balance when reconciling. .PP -When you want more error checking, you can enable strict mode with the -\f[C]-s\f[R]/\f[C]--strict\f[R] flag. -Then hledger will will report an error if any transaction references an -account that has not been declared by an account directive. -Some things to note: +In strict mode, enabled with the \f[C]-s\f[R]/\f[C]--strict\f[R] flag, +hledger will report an error if any transaction uses an account name +that has not been declared by an account directive. +Some notes: .IP \[bu] 2 The declaration is case-sensitive; transactions must use the correct account name capitalisation. diff --git a/hledger-lib/hledger_journal.info b/hledger-lib/hledger_journal.info index 3cfafa4a7..c730655ce 100644 --- a/hledger-lib/hledger_journal.info +++ b/hledger-lib/hledger_journal.info @@ -1139,6 +1139,21 @@ a comma, followed by 0 or more decimal digits. Note hledger normally uses banker's rounding, so 0.5 displayed with zero decimal digits is "0". (More at Commodity display style.) +* Menu: + +* Commodity error checking:: + + +File: hledger_journal.info, Node: Commodity error checking, Up: Declaring commodities + +1.13.5.1 Commodity error checking +................................. + +In strict mode, enabled with the '-s'/'--strict' flag, hledger will +report an error if a commodity symbol is used that has not been declared +by a 'commodity' directive. This works similarly to account error +checking, see the notes there for more details. +  File: hledger_journal.info, Node: Default commodity, Next: Declaring market prices, Prev: Declaring commodities, Up: Directives @@ -1228,28 +1243,27 @@ account assets:bank:checking * Menu: -* Account existence:: +* Account error checking:: * Account comments:: * Account subdirectives:: * Account types:: * Account display order::  -File: hledger_journal.info, Node: Account existence, Next: Account comments, Up: Declaring accounts +File: hledger_journal.info, Node: Account error checking, Next: Account comments, Up: Declaring accounts -1.13.8.1 Account existence -.......................... +1.13.8.1 Account error checking +............................... By default, accounts come into existence when a transaction references -them. This is convenient, but when you mis-spell an account name in a -transaction, hledger won't be able to detect it. Usually this isn't a -big problem, as you'll notice the error in balance reports, or when -reconciling account balances. +them by name. This is convenient, but it means hledger can't warn you +when you mis-spell an account name in the journal. Usually you'll find +the error later, as an extra account in balance reports, or an incorrect +balance when reconciling. - When you want more error checking, you can enable strict mode with -the '-s'/'--strict' flag. Then hledger will will report an error if any -transaction references an account that has not been declared by an -account directive. Some things to note: + In strict mode, enabled with the '-s'/'--strict' flag, hledger will +report an error if any transaction uses an account name that has not +been declared by an account directive. Some notes: * The declaration is case-sensitive; transactions must use the correct account name capitalisation. @@ -1264,7 +1278,7 @@ account directive. Some things to note: with a wildcard; every account posted to must be declared.  -File: hledger_journal.info, Node: Account comments, Next: Account subdirectives, Prev: Account existence, Up: Declaring accounts +File: hledger_journal.info, Node: Account comments, Next: Account subdirectives, Prev: Account error checking, Up: Declaring accounts 1.13.8.2 Account comments ......................... @@ -1990,56 +2004,58 @@ Node: Default year39916 Ref: #default-year40085 Node: Declaring commodities40492 Ref: #declaring-commodities40675 -Node: Default commodity42480 -Ref: #default-commodity42666 -Node: Declaring market prices43555 -Ref: #declaring-market-prices43750 -Node: Declaring accounts44607 -Ref: #declaring-accounts44793 -Node: Account existence45990 -Ref: #account-existence46151 -Node: Account comments47387 -Ref: #account-comments47576 -Node: Account subdirectives48000 -Ref: #account-subdirectives48195 -Node: Account types48508 -Ref: #account-types48692 -Node: Account display order51738 -Ref: #account-display-order51908 -Node: Rewriting accounts53059 -Ref: #rewriting-accounts53244 -Node: Basic aliases54001 -Ref: #basic-aliases54147 -Node: Regex aliases54851 -Ref: #regex-aliases55023 -Node: Combining aliases55742 -Ref: #combining-aliases55935 -Node: Aliases and multiple files57211 -Ref: #aliases-and-multiple-files57420 -Node: end aliases57999 -Ref: #end-aliases58156 -Node: Default parent account58257 -Ref: #default-parent-account58425 -Node: Periodic transactions59309 -Ref: #periodic-transactions59484 -Node: Periodic rule syntax61356 -Ref: #periodic-rule-syntax61562 -Node: Two spaces between period expression and description!62266 -Ref: #two-spaces-between-period-expression-and-description62585 -Node: Forecasting with periodic transactions63269 -Ref: #forecasting-with-periodic-transactions63574 -Node: Budgeting with periodic transactions65629 -Ref: #budgeting-with-periodic-transactions65868 -Node: Auto postings66277 -Ref: #auto-postings66417 -Node: Auto postings and multiple files68596 -Ref: #auto-postings-and-multiple-files68800 -Node: Auto postings and dates69009 -Ref: #auto-postings-and-dates69283 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions69458 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions69809 -Node: Auto posting tags70151 -Ref: #auto-posting-tags70366 +Node: Commodity error checking42519 +Ref: #commodity-error-checking42679 +Node: Default commodity42936 +Ref: #default-commodity43122 +Node: Declaring market prices44011 +Ref: #declaring-market-prices44206 +Node: Declaring accounts45063 +Ref: #declaring-accounts45249 +Node: Account error checking46451 +Ref: #account-error-checking46627 +Node: Account comments47806 +Ref: #account-comments48000 +Node: Account subdirectives48424 +Ref: #account-subdirectives48619 +Node: Account types48932 +Ref: #account-types49116 +Node: Account display order52162 +Ref: #account-display-order52332 +Node: Rewriting accounts53483 +Ref: #rewriting-accounts53668 +Node: Basic aliases54425 +Ref: #basic-aliases54571 +Node: Regex aliases55275 +Ref: #regex-aliases55447 +Node: Combining aliases56166 +Ref: #combining-aliases56359 +Node: Aliases and multiple files57635 +Ref: #aliases-and-multiple-files57844 +Node: end aliases58423 +Ref: #end-aliases58580 +Node: Default parent account58681 +Ref: #default-parent-account58849 +Node: Periodic transactions59733 +Ref: #periodic-transactions59908 +Node: Periodic rule syntax61780 +Ref: #periodic-rule-syntax61986 +Node: Two spaces between period expression and description!62690 +Ref: #two-spaces-between-period-expression-and-description63009 +Node: Forecasting with periodic transactions63693 +Ref: #forecasting-with-periodic-transactions63998 +Node: Budgeting with periodic transactions66053 +Ref: #budgeting-with-periodic-transactions66292 +Node: Auto postings66701 +Ref: #auto-postings66841 +Node: Auto postings and multiple files69020 +Ref: #auto-postings-and-multiple-files69224 +Node: Auto postings and dates69433 +Ref: #auto-postings-and-dates69707 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions69882 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions70233 +Node: Auto posting tags70575 +Ref: #auto-posting-tags70790  End Tag Table diff --git a/hledger-lib/hledger_journal.txt b/hledger-lib/hledger_journal.txt index bdd958a1e..c7ecae64b 100644 --- a/hledger-lib/hledger_journal.txt +++ b/hledger-lib/hledger_journal.txt @@ -892,16 +892,22 @@ FILE FORMAT Note hledger normally uses banker's rounding, so 0.5 displayed with zero decimal digits is "0". (More at Commodity display style.) + Commodity error checking + In strict mode, enabled with the -s/--strict flag, hledger will report + an error if a commodity symbol is used that has not been declared by a + commodity directive. This works similarly to account error checking, + see the notes there for more details. + Default commodity - The D directive sets a default commodity, to be used for amounts with- + The D directive sets a default commodity, to be used for amounts with- out a commodity symbol (ie, plain numbers). This commodity will be ap- plied to all subsequent commodity-less amounts, or until the next D di- rective. (Note, this is different from Ledger's D.) - For compatibility/historical reasons, D also acts like a commodity di- + For compatibility/historical reasons, D also acts like a commodity di- rective, setting the commodity's display style (for output) and decimal mark (for parsing input). As with commodity, the amount must always be - written with a decimal mark (period or comma). If both directives are + written with a decimal mark (period or comma). If both directives are used, commodity's style takes precedence. The syntax is D AMOUNT. Eg: @@ -915,9 +921,9 @@ FILE FORMAT b Declaring 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 - "historical prices".) These are often obtained from a stock exchange, + 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 + "historical prices".) These are often obtained from a stock exchange, cryptocurrency exchange, or the foreign exchange market. Here is the format: @@ -928,59 +934,58 @@ FILE FORMAT o COMMODITYA is the symbol of the commodity being priced - o COMMODITYBAMOUNT is an amount (symbol and quantity) in a second com- + o COMMODITYBAMOUNT is an amount (symbol and quantity) in a second com- modity, giving the price in commodity B of one unit of commodity A. - These two market price directives say that one euro was worth 1.35 US + These two market price directives say that one euro was worth 1.35 US dollars during 2009, and $1.40 from 2010 onward: P 2009/1/1 EUR $1.35 P 2010/1/1 EUR $1.40 - The -V, -X and --value flags use these market prices to show amount + The -V, -X and --value flags use these market prices to show amount values in another commodity. See Valuation. Declaring accounts account directives can be used to declare accounts (ie, the places that - amounts are transferred from and to). Though not required, these dec- + amounts are transferred from and to). Though not required, these dec- larations can provide several benefits: o They can document your intended chart of accounts, providing a refer- ence. - o They can help hledger know your accounts' types (asset, liability, - equity, revenue, expense), useful for reports like balancesheet and + o They can help hledger know your accounts' types (asset, liability, + equity, revenue, expense), useful for reports like balancesheet and incomestatement. - o They control account display order in reports, allowing non-alpha- + o They control account display order in reports, allowing non-alpha- betic sorting (eg Revenues to appear above Expenses). - o They can store extra information about accounts (account numbers, + o They can store extra information about accounts (account numbers, notes, etc.) - o They help with account name completion in the add command, hledger- + o They help with account name completion in the add command, hledger- iadd, hledger-web, ledger-mode etc. - o In strict mode, they restrict which accounts may be posted to by + o In strict mode, they restrict which accounts may be posted to by transactions, which helps detect typos. - The simplest form is just the word account followed by a hledger-style + The simplest form is just the word account followed by a hledger-style account name, eg this account directive declares the assets:bank:check- ing account: account assets:bank:checking - Account existence - By default, accounts come into existence when a transaction references - them. This is convenient, but when you mis-spell an account name in a - transaction, hledger won't be able to detect it. Usually this isn't a - big problem, as you'll notice the error in balance reports, or when - reconciling account balances. + Account error checking + By default, accounts come into existence when a transaction references + them by name. This is convenient, but it means hledger can't warn you + when you mis-spell an account name in the journal. Usually you'll find + the error later, as an extra account in balance reports, or an incor- + rect balance when reconciling. - When you want more error checking, you can enable strict mode with the - -s/--strict flag. Then hledger will will report an error if any trans- - action references an account that has not been declared by an account - directive. Some things to note: + In strict mode, enabled with the -s/--strict flag, hledger will report + an error if any transaction uses an account name that has not been de- + clared by an account directive. Some notes: o The declaration is case-sensitive; transactions must use the correct account name capitalisation. @@ -1070,6 +1075,7 @@ FILE FORMAT ^(debts?|lia- Liability bilit(y|ies))(:|$) ^equity(:|$) Equity + ^(income|revenue)s?(:|$) Revenue ^expenses?(:|$) Expense diff --git a/hledger/hledger.1 b/hledger/hledger.1 index a7dc21851..a5bcbd406 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -1078,8 +1078,14 @@ Do all balance assertions pass ? With the \f[C]-s\f[R]/\f[C]--strict\f[R] flag, additional checks are performed: .IP \[bu] 2 -Are all accounts referenced by transactions declared with an account -directive ? +Are all accounts posted to, declared with an \f[C]account\f[R] directive +? +(Account error checking) +.IP \[bu] 2 +Are all commodities declared with a \f[C]commodity\f[R] directive ? +(Commodity error checking) +.PP +See also: https://hledger.org/checking-for-errors.html .PP \f[I]experimental.\f[R] .SS Output destination @@ -3530,28 +3536,67 @@ Instead of absolute values percentages can be displayed with This command also supports the output destination and output format options The output formats supported are \f[C]txt\f[R], \f[C]csv\f[R], \f[C]html\f[R], and (experimental) \f[C]json\f[R]. -.SS check-dates +.SS check .PP -check-dates +check .PD 0 .P .PD -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\[aq] dates are checked. -Reads the default journal file, or another specified with -f. -.SS check-dupes +Check for various kinds of errors in your data. .PP -check-dupes -.PD 0 -.P -.PD -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. +hledger provides a number of built-in error checks to help prevent +problems in your data. +Some, but not all, of these are run automatically before all commands. +You can also use this \f[C]check\f[R] command to run any of the +available tests. +They are named, and run, as follows: .PP -An example: http://stefanorodighiero.net/software/hledger-dupes.html +\f[C]hledger check\f[R] runs the basic checks, like all other commands, +but with no output unless there is a problem. +These are: +.IP \[bu] 2 +\f[B]parseable\f[R] - data files are well-formed and can be successfully +parsed +.IP \[bu] 2 +\f[B]autobalanced\f[R] - all transactions are balanced, inferring +missing amounts where necessary, and possibly converting commodities +using transaction prices or automatically-inferred transaction prices +.IP \[bu] 2 +\f[B]assertions\f[R] - all balance assertions are passing (except with +\f[C]-I\f[R]/\f[C]--ignore-assertions\f[R]) +.PP +\f[C]hledger check --strict\f[R] also runs the additional \[dq]strict +mode\[dq] checks, which are: +.IP \[bu] 2 +\f[B]accounts\f[R] - all account names used by transactions have been +declared +.IP \[bu] 2 +\f[B]commodities\f[R] - all commodity symbols used have been declared +.PP +\f[C]hledger check CHECK1 CHECK2 ...\f[R] runs all of the named checks, +in turn. +This may be useful when neither the default nor strict checks are +exactly what you want, or when you want to focus on a single check of +interest. +The arguments are standard lowercase names for the checks. +Currently only these checks can be run in this way: +.IP \[bu] 2 +\f[B]dates\f[R] - transactions are ordered by date (similar to the old +\f[C]check-dates\f[R] command) +.IP \[bu] 2 +\f[B]leafnames\f[R] - all account leaf names are unique ((similar to the +old \f[C]check-dupes\f[R] command) +.PP +See also: +.PP +Some checks are shipped as addon scripts for now (cf +https://github.com/simonmichael/hledger/tree/master/bin, and Cookbook -> +Scripting): +.IP \[bu] 2 +\f[B]tagfiles\f[R] - all tag values containing / (a forward slash) exist +as file paths +.IP \[bu] 2 +\f[B]fancyassertions\f[R] - more complex balance assertions are passing .SS close .PP close, equity diff --git a/hledger/hledger.info b/hledger/hledger.info index 31220727b..e87a7088b 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -1017,8 +1017,12 @@ without a lot of declarations: With the '-s'/'--strict' flag, additional checks are performed: - * Are all accounts referenced by transactions declared with an - account directive ? + * Are all accounts posted to, declared with an 'account' directive ? + (Account error checking) + * Are all commodities declared with a 'commodity' directive ? + (Commodity error checking) + + See also: https://hledger.org/checking-for-errors.html _experimental._ @@ -1972,8 +1976,7 @@ detailed command help. * balancesheet:: * balancesheetequity:: * cashflow:: -* check-dates:: -* check-dupes:: +* check:: * close:: * codes:: * commodities:: @@ -2921,7 +2924,7 @@ options The output formats supported are 'txt', 'csv', 'html', and (experimental) 'json'.  -File: hledger.info, Node: cashflow, Next: check-dates, Prev: balancesheetequity, Up: COMMANDS +File: hledger.info, Node: cashflow, Next: check, Prev: balancesheetequity, Up: COMMANDS 3.8 cashflow ============ @@ -2963,34 +2966,63 @@ options The output formats supported are 'txt', 'csv', 'html', and (experimental) 'json'.  -File: hledger.info, Node: check-dates, Next: check-dupes, Prev: cashflow, Up: COMMANDS +File: hledger.info, Node: check, Next: close, Prev: cashflow, Up: COMMANDS -3.9 check-dates -=============== +3.9 check +========= -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. -Reads the default journal file, or another specified with -f. +check +Check for various kinds of errors in your data. + + hledger provides a number of built-in error checks to help prevent +problems in your data. Some, but not all, of these are run +automatically before all commands. You can also use this 'check' +command to run any of the available tests. They are named, and run, as +follows: + + 'hledger check' runs the basic checks, like all other commands, but +with no output unless there is a problem. These are: + + * *parseable* - data files are well-formed and can be successfully + parsed + * *autobalanced* - all transactions are balanced, inferring missing + amounts where necessary, and possibly converting commodities using + transaction prices or automatically-inferred transaction prices + * *assertions* - all balance assertions are passing (except with + '-I'/'--ignore-assertions') + + 'hledger check --strict' also runs the additional "strict mode" +checks, which are: + + * *accounts* - all account names used by transactions have been + declared + * *commodities* - all commodity symbols used have been declared + + 'hledger check CHECK1 CHECK2 ...' runs all of the named checks, in +turn. This may be useful when neither the default nor strict checks are +exactly what you want, or when you want to focus on a single check of +interest. The arguments are standard lowercase names for the checks. +Currently only these checks can be run in this way: + + * *dates* - transactions are ordered by date (similar to the old + 'check-dates' command) + * *leafnames* - all account leaf names are unique ((similar to the + old 'check-dupes' command) + + See also: + + Some checks are shipped as addon scripts for now (cf +https://github.com/simonmichael/hledger/tree/master/bin, and Cookbook -> +Scripting): + + * *tagfiles* - all tag values containing / (a forward slash) exist as + file paths + * *fancyassertions* - more complex balance assertions are passing  -File: hledger.info, Node: check-dupes, Next: close, Prev: check-dates, Up: COMMANDS +File: hledger.info, Node: close, Next: codes, Prev: check, Up: COMMANDS -3.10 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. Reads -the default journal file, or another specified as an argument. - - An example: http://stefanorodighiero.net/software/hledger-dupes.html - - -File: hledger.info, Node: close, Next: codes, Prev: check-dupes, Up: COMMANDS - -3.11 close +3.10 close ========== close, equity @@ -3030,7 +3062,7 @@ you have many foreign currency or investment transactions.  File: hledger.info, Node: close usage, Up: close -3.11.1 close usage +3.10.1 close usage ------------------ If you split your journal files by time (eg yearly), you will typically @@ -3101,7 +3133,7 @@ breaking balance assertions:  File: hledger.info, Node: codes, Next: commodities, Prev: close, Up: COMMANDS -3.12 codes +3.11 codes ========== codes @@ -3147,7 +3179,7 @@ $ hledger codes -E  File: hledger.info, Node: commodities, Next: descriptions, Prev: codes, Up: COMMANDS -3.13 commodities +3.12 commodities ================ commodities @@ -3156,7 +3188,7 @@ List all commodity/currency symbols used or declared in the journal.  File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: COMMANDS -3.14 descriptions +3.13 descriptions ================= descriptions @@ -3176,7 +3208,7 @@ Person A  File: hledger.info, Node: diff, Next: files, Prev: descriptions, Up: COMMANDS -3.15 diff +3.14 diff ========= diff @@ -3211,7 +3243,7 @@ These transactions are in the second file only:  File: hledger.info, Node: files, Next: help, Prev: diff, Up: COMMANDS -3.16 files +3.15 files ========== files @@ -3221,7 +3253,7 @@ file names matching the regular expression (case sensitive) are shown.  File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS -3.17 help +3.16 help ========= help @@ -3261,7 +3293,7 @@ DESCRIPTION  File: hledger.info, Node: import, Next: incomestatement, Prev: help, Up: COMMANDS -3.18 import +3.17 import =========== import @@ -3291,7 +3323,7 @@ $ hledger import --dry ... | hledger -f- print unknown --ignore-assertions  File: hledger.info, Node: Importing balance assignments, Next: Commodity display styles, Up: import -3.18.1 Importing balance assignments +3.17.1 Importing balance assignments ------------------------------------ Entries added by import will have their posting amounts made explicit @@ -3310,7 +3342,7 @@ please test it and send a pull request.)  File: hledger.info, Node: Commodity display styles, Prev: Importing balance assignments, Up: import -3.18.2 Commodity display styles +3.17.2 Commodity display styles ------------------------------- Imported amounts will be formatted according to the canonical commodity @@ -3319,7 +3351,7 @@ styles (declared or inferred) in the main journal file.  File: hledger.info, Node: incomestatement, Next: notes, Prev: import, Up: COMMANDS -3.19 incomestatement +3.18 incomestatement ==================== incomestatement, is @@ -3369,7 +3401,7 @@ options The output formats supported are 'txt', 'csv', 'html', and  File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: COMMANDS -3.20 notes +3.19 notes ========== notes @@ -3389,7 +3421,7 @@ Snacks  File: hledger.info, Node: payees, Next: prices, Prev: notes, Up: COMMANDS -3.21 payees +3.20 payees =========== payees @@ -3411,7 +3443,7 @@ Person A  File: hledger.info, Node: prices, Next: print, Prev: payees, Up: COMMANDS -3.22 prices +3.21 prices =========== prices @@ -3424,7 +3456,7 @@ Price amounts are always displayed with their full precision.  File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS -3.23 print +3.22 print ========== print, txns, p @@ -3533,7 +3565,7 @@ $ hledger print -Ocsv  File: hledger.info, Node: print-unique, Next: register, Prev: print, Up: COMMANDS -3.24 print-unique +3.23 print-unique ================= print-unique @@ -3554,7 +3586,7 @@ $ LEDGER_FILE=unique.journal hledger print-unique  File: hledger.info, Node: register, Next: register-match, Prev: print-unique, Up: COMMANDS -3.25 register +3.24 register ============= register, reg, r @@ -3652,7 +3684,7 @@ length and comparable to the others in the report.  File: hledger.info, Node: Custom register output, Up: register -3.25.1 Custom register output +3.24.1 Custom register output ----------------------------- register uses the full terminal width by default, except on windows. @@ -3684,7 +3716,7 @@ options The output formats supported are 'txt', 'csv', and  File: hledger.info, Node: register-match, Next: rewrite, Prev: register, Up: COMMANDS -3.26 register-match +3.25 register-match =================== register-match @@ -3697,7 +3729,7 @@ ledger-autosync detect already-seen transactions when importing.  File: hledger.info, Node: rewrite, Next: roi, Prev: register-match, Up: COMMANDS -3.27 rewrite +3.26 rewrite ============ rewrite @@ -3749,7 +3781,7 @@ commodity.  File: hledger.info, Node: Re-write rules in a file, Up: rewrite -3.27.1 Re-write rules in a file +3.26.1 Re-write rules in a file ------------------------------- During the run this tool will execute so called "Automated Transactions" @@ -3792,7 +3824,7 @@ postings.  File: hledger.info, Node: Diff output format, Next: rewrite vs print --auto, Up: Re-write rules in a file -3.27.1.1 Diff output format +3.26.1.1 Diff output format ........................... To use this tool for batch modification of your journal files you may @@ -3833,7 +3865,7 @@ output from 'hledger print'.  File: hledger.info, Node: rewrite vs print --auto, Prev: Diff output format, Up: Re-write rules in a file -3.27.1.2 rewrite vs. print -auto +3.26.1.2 rewrite vs. print -auto ................................ This command predates print -auto, and currently does much the same @@ -3853,7 +3885,7 @@ thing, but with these differences:  File: hledger.info, Node: roi, Next: stats, Prev: rewrite, Up: COMMANDS -3.28 roi +3.27 roi ======== roi @@ -4109,7 +4141,7 @@ $ hledger roi -Y --inv investment --pnl "unrealized"  File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS -3.29 stats +3.28 stats ========== stats @@ -4140,7 +4172,7 @@ selection.  File: hledger.info, Node: tags, Next: test, Prev: stats, Up: COMMANDS -3.30 tags +3.29 tags ========= tags @@ -4160,7 +4192,7 @@ they are omitted.  File: hledger.info, Node: test, Next: Add-on commands, Prev: tags, Up: COMMANDS -3.31 test +3.30 test ========= test @@ -4187,7 +4219,7 @@ $ hledger test -- -pData.Amount --color=never  File: hledger.info, Node: Add-on commands, Prev: test, Up: COMMANDS -3.32 Add-on commands +3.31 Add-on commands ==================== hledger also searches for external add-on commands, and will include @@ -4228,7 +4260,7 @@ interfaces. These are maintained and released along with hledger:  File: hledger.info, Node: ui, Next: web, Up: Add-on commands -3.32.1 ui +3.31.1 ui --------- hledger-ui provides an efficient terminal interface. @@ -4236,7 +4268,7 @@ hledger-ui provides an efficient terminal interface.  File: hledger.info, Node: web, Next: iadd, Prev: ui, Up: Add-on commands -3.32.2 web +3.31.2 web ---------- hledger-web provides a simple web interface. @@ -4246,7 +4278,7 @@ hledger-web provides a simple web interface.  File: hledger.info, Node: iadd, Next: interest, Prev: web, Up: Add-on commands -3.32.3 iadd +3.31.3 iadd ----------- hledger-iadd is a more interactive, terminal UI replacement for the add @@ -4255,7 +4287,7 @@ command.  File: hledger.info, Node: interest, Prev: iadd, Up: Add-on commands -3.32.4 interest +3.31.4 interest --------------- hledger-interest generates interest transactions for an account @@ -4454,170 +4486,168 @@ Node: Input files30574 Ref: #input-files30710 Node: Strict mode33009 Ref: #strict-mode33145 -Node: Output destination33626 -Ref: #output-destination33778 -Node: Output format34203 -Ref: #output-format34355 -Node: Regular expressions36522 -Ref: #regular-expressions36679 -Node: Smart dates38415 -Ref: #smart-dates38566 -Node: Report start & end date39927 -Ref: #report-start-end-date40099 -Node: Report intervals41596 -Ref: #report-intervals41761 -Node: Period expressions42151 -Ref: #period-expressions42311 -Node: Depth limiting46684 -Ref: #depth-limiting46828 -Node: Pivoting47160 -Ref: #pivoting47283 -Node: Valuation48959 -Ref: #valuation49061 -Node: -B Cost49750 -Ref: #b-cost49854 -Node: -V Value49987 -Ref: #v-value50133 -Node: -X Value in specified commodity50328 -Ref: #x-value-in-specified-commodity50527 -Node: Valuation date50676 -Ref: #valuation-date50844 -Node: Market prices51266 -Ref: #market-prices51446 -Node: --infer-value market prices from transactions52388 -Ref: #infer-value-market-prices-from-transactions52637 -Node: Valuation commodity53919 -Ref: #valuation-commodity54128 -Node: Simple valuation examples55354 -Ref: #simple-valuation-examples55556 -Node: --value Flexible valuation56215 -Ref: #value-flexible-valuation56423 -Node: More valuation examples58370 -Ref: #more-valuation-examples58579 -Node: Effect of valuation on reports60584 -Ref: #effect-of-valuation-on-reports60772 -Node: COMMANDS67791 -Ref: #commands67899 -Node: accounts69007 -Ref: #accounts69105 -Node: activity69804 -Ref: #activity69914 -Node: add70297 -Ref: #add70398 -Node: aregister73191 -Ref: #aregister73303 -Node: aregister and custom posting dates74676 -Ref: #aregister-and-custom-posting-dates74849 -Ref: #output-format-175442 -Node: balance75847 -Ref: #balance75964 -Node: Classic balance report77444 -Ref: #classic-balance-report77617 -Node: Customising the classic balance report78941 -Ref: #customising-the-classic-balance-report79169 -Node: Colour support81245 -Ref: #colour-support81412 -Node: Flat mode81508 -Ref: #flat-mode81656 -Node: Depth limited balance reports82069 -Ref: #depth-limited-balance-reports82254 -Node: Percentages82710 -Ref: #percentages82867 -Node: Sorting by amount84004 -Ref: #sorting-by-amount84170 -Node: Multicolumn balance report84664 -Ref: #multicolumn-balance-report84850 -Node: Budget report90447 -Ref: #budget-report90590 -Node: Budget report start date95879 -Ref: #budget-report-start-date96044 -Node: Nested budgets97376 -Ref: #nested-budgets97521 -Ref: #output-format-2101004 -Node: balancesheet101165 -Ref: #balancesheet101301 -Node: balancesheetequity102813 -Ref: #balancesheetequity102962 -Node: cashflow104038 -Ref: #cashflow104166 -Node: check-dates105382 -Ref: #check-dates105509 -Node: check-dupes105788 -Ref: #check-dupes105914 -Node: close106207 -Ref: #close106315 -Node: close usage107837 -Ref: #close-usage107930 -Node: codes110743 -Ref: #codes110851 -Node: commodities111563 -Ref: #commodities111690 -Node: descriptions111772 -Ref: #descriptions111900 -Node: diff112204 -Ref: #diff112310 -Node: files113357 -Ref: #files113457 -Node: help113604 -Ref: #help113704 -Node: import114785 -Ref: #import114899 -Node: Importing balance assignments115821 -Ref: #importing-balance-assignments116002 -Node: Commodity display styles116651 -Ref: #commodity-display-styles116822 -Node: incomestatement116951 -Ref: #incomestatement117084 -Node: notes118429 -Ref: #notes118542 -Node: payees118910 -Ref: #payees119016 -Node: prices119436 -Ref: #prices119542 -Node: print119883 -Ref: #print119993 -Node: print-unique124789 -Ref: #print-unique124915 -Node: register125200 -Ref: #register125327 -Node: Custom register output129776 -Ref: #custom-register-output129905 -Node: register-match131242 -Ref: #register-match131376 -Node: rewrite131727 -Ref: #rewrite131842 -Node: Re-write rules in a file133697 -Ref: #re-write-rules-in-a-file133831 -Node: Diff output format135041 -Ref: #diff-output-format135210 -Node: rewrite vs print --auto136302 -Ref: #rewrite-vs.-print---auto136481 -Node: roi137037 -Ref: #roi137135 -Node: stats149345 -Ref: #stats149444 -Node: tags150232 -Ref: #tags150330 -Node: test150849 -Ref: #test150957 -Node: Add-on commands151704 -Ref: #add-on-commands151821 -Node: ui153164 -Ref: #ui153252 -Node: web153306 -Ref: #web153409 -Node: iadd153525 -Ref: #iadd153636 -Node: interest153718 -Ref: #interest153825 -Node: ENVIRONMENT154065 -Ref: #environment154177 -Node: FILES155162 -Ref: #files-1155265 -Node: LIMITATIONS155478 -Ref: #limitations155597 -Node: TROUBLESHOOTING156339 -Ref: #troubleshooting156452 +Node: Output destination33793 +Ref: #output-destination33945 +Node: Output format34370 +Ref: #output-format34522 +Node: Regular expressions36689 +Ref: #regular-expressions36846 +Node: Smart dates38582 +Ref: #smart-dates38733 +Node: Report start & end date40094 +Ref: #report-start-end-date40266 +Node: Report intervals41763 +Ref: #report-intervals41928 +Node: Period expressions42318 +Ref: #period-expressions42478 +Node: Depth limiting46851 +Ref: #depth-limiting46995 +Node: Pivoting47327 +Ref: #pivoting47450 +Node: Valuation49126 +Ref: #valuation49228 +Node: -B Cost49917 +Ref: #b-cost50021 +Node: -V Value50154 +Ref: #v-value50300 +Node: -X Value in specified commodity50495 +Ref: #x-value-in-specified-commodity50694 +Node: Valuation date50843 +Ref: #valuation-date51011 +Node: Market prices51433 +Ref: #market-prices51613 +Node: --infer-value market prices from transactions52555 +Ref: #infer-value-market-prices-from-transactions52804 +Node: Valuation commodity54086 +Ref: #valuation-commodity54295 +Node: Simple valuation examples55521 +Ref: #simple-valuation-examples55723 +Node: --value Flexible valuation56382 +Ref: #value-flexible-valuation56590 +Node: More valuation examples58537 +Ref: #more-valuation-examples58746 +Node: Effect of valuation on reports60751 +Ref: #effect-of-valuation-on-reports60939 +Node: COMMANDS67958 +Ref: #commands68066 +Node: accounts69152 +Ref: #accounts69250 +Node: activity69949 +Ref: #activity70059 +Node: add70442 +Ref: #add70543 +Node: aregister73336 +Ref: #aregister73448 +Node: aregister and custom posting dates74821 +Ref: #aregister-and-custom-posting-dates74994 +Ref: #output-format-175587 +Node: balance75992 +Ref: #balance76109 +Node: Classic balance report77589 +Ref: #classic-balance-report77762 +Node: Customising the classic balance report79086 +Ref: #customising-the-classic-balance-report79314 +Node: Colour support81390 +Ref: #colour-support81557 +Node: Flat mode81653 +Ref: #flat-mode81801 +Node: Depth limited balance reports82214 +Ref: #depth-limited-balance-reports82399 +Node: Percentages82855 +Ref: #percentages83012 +Node: Sorting by amount84149 +Ref: #sorting-by-amount84315 +Node: Multicolumn balance report84809 +Ref: #multicolumn-balance-report84995 +Node: Budget report90592 +Ref: #budget-report90735 +Node: Budget report start date96024 +Ref: #budget-report-start-date96189 +Node: Nested budgets97521 +Ref: #nested-budgets97666 +Ref: #output-format-2101149 +Node: balancesheet101310 +Ref: #balancesheet101446 +Node: balancesheetequity102958 +Ref: #balancesheetequity103107 +Node: cashflow104183 +Ref: #cashflow104305 +Node: check105521 +Ref: #check105624 +Node: close107565 +Ref: #close107667 +Node: close usage109189 +Ref: #close-usage109282 +Node: codes112095 +Ref: #codes112203 +Node: commodities112915 +Ref: #commodities113042 +Node: descriptions113124 +Ref: #descriptions113252 +Node: diff113556 +Ref: #diff113662 +Node: files114709 +Ref: #files114809 +Node: help114956 +Ref: #help115056 +Node: import116137 +Ref: #import116251 +Node: Importing balance assignments117173 +Ref: #importing-balance-assignments117354 +Node: Commodity display styles118003 +Ref: #commodity-display-styles118174 +Node: incomestatement118303 +Ref: #incomestatement118436 +Node: notes119781 +Ref: #notes119894 +Node: payees120262 +Ref: #payees120368 +Node: prices120788 +Ref: #prices120894 +Node: print121235 +Ref: #print121345 +Node: print-unique126141 +Ref: #print-unique126267 +Node: register126552 +Ref: #register126679 +Node: Custom register output131128 +Ref: #custom-register-output131257 +Node: register-match132594 +Ref: #register-match132728 +Node: rewrite133079 +Ref: #rewrite133194 +Node: Re-write rules in a file135049 +Ref: #re-write-rules-in-a-file135183 +Node: Diff output format136393 +Ref: #diff-output-format136562 +Node: rewrite vs print --auto137654 +Ref: #rewrite-vs.-print---auto137833 +Node: roi138389 +Ref: #roi138487 +Node: stats150697 +Ref: #stats150796 +Node: tags151584 +Ref: #tags151682 +Node: test152201 +Ref: #test152309 +Node: Add-on commands153056 +Ref: #add-on-commands153173 +Node: ui154516 +Ref: #ui154604 +Node: web154658 +Ref: #web154761 +Node: iadd154877 +Ref: #iadd154988 +Node: interest155070 +Ref: #interest155177 +Node: ENVIRONMENT155417 +Ref: #environment155529 +Node: FILES156514 +Ref: #files-1156617 +Node: LIMITATIONS156830 +Ref: #limitations156949 +Node: TROUBLESHOOTING157691 +Ref: #troubleshooting157804  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 4a3261a9a..8fddbec75 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -870,8 +870,13 @@ OPTIONS With the -s/--strict flag, additional checks are performed: - o Are all accounts referenced by transactions declared with an account - directive ? + o Are all accounts posted to, declared with an account directive ? + (Account error checking) + + o Are all commodities declared with a commodity directive ? (Commodity + error checking) + + See also: https://hledger.org/checking-for-errors.html experimental. @@ -881,8 +886,8 @@ OPTIONS $ hledger print > foo.txt - Some commands (print, register, stats, the balance commands) also pro- - vide the -o/--output-file option, which does the same thing without + Some commands (print, register, stats, the balance commands) also pro- + vide the -o/--output-file option, which does the same thing without needing the shell. Eg: $ hledger print -o foo.txt @@ -891,7 +896,7 @@ OPTIONS Output format Some commands (print, register, the balance commands) offer a choice of output format. In addition to the usual plain text format (txt), there - are CSV (csv), HTML (html), JSON (json) and SQL (sql). This is con- + are CSV (csv), HTML (html), JSON (json) and SQL (sql). This is con- trolled by the -O/--output-format option: $ hledger print -O csv @@ -906,149 +911,149 @@ OPTIONS Some notes about JSON output: - o This feature is marked experimental, and not yet much used; you + o This feature is marked experimental, and not yet much used; you should expect our JSON to evolve. Real-world feedback is welcome. - o Our JSON is rather large and verbose, as it is quite a faithful rep- - resentation of hledger's internal data types. To understand the + o Our JSON is rather large and verbose, as it is quite a faithful rep- + resentation of hledger's internal data types. To understand the JSON, read the Haskell type definitions, which are mostly in https://github.com/simonmichael/hledger/blob/master/hledger- lib/Hledger/Data/Types.hs. - o hledger represents quantities as Decimal values storing up to 255 - significant digits, eg for repeating decimals. Such numbers can + o hledger represents quantities as Decimal values storing up to 255 + significant digits, eg for repeating decimals. Such numbers can arise in practice (from automatically-calculated transaction prices), - and would break most JSON consumers. So in JSON, we show quantities + and would break most JSON consumers. So in JSON, we show quantities as simple Numbers with at most 10 decimal places. We don't limit the - number of integer digits, but that part is under your control. We - hope this approach will not cause problems in practice; if you find + number of integer digits, but that part is under your control. We + hope this approach will not cause problems in practice; if you find otherwise, please let us know. (Cf #1195) Notes about SQL output: - o SQL output is also marked experimental, and much like JSON could use + o SQL output is also marked experimental, and much like JSON could use real-world feedback. o SQL output is expected to work with sqlite, MySQL and PostgreSQL - o SQL output is structured with the expectations that statements will - be executed in the empty database. If you already have tables cre- - ated via SQL output of hledger, you would probably want to either + o SQL output is structured with the expectations that statements will + be executed in the empty database. If you already have tables cre- + ated via SQL output of hledger, you would probably want to either clear tables of existing data (via delete or truncate SQL statements) or drop tables completely as otherwise your postings will be duped. 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. If - they're not doing what you expect, it's important to know exactly what + hledger's regular expressions come from the regex-tdfa library. If + they're not doing what you expect, it's important to know exactly what they support: 1. they are case insensitive - 2. they are infix matching (they do not need to match the entire thing + 2. they are infix matching (they do not need to match the entire thing being matched) 3. they are POSIX ERE (extended regular expressions) 4. they also support GNU word boundaries (\b, \B, \<, \>) - 5. they do not support backreferences; if you write \1, it will match - the digit 1. Except when doing text replacement, eg in account - aliases, where backreferences can be used in the replacement string + 5. they do not support backreferences; if you write \1, it will match + the digit 1. Except when doing text replacement, eg in account + aliases, where backreferences can be used in the replacement string to reference capturing groups in the search regexp. - 6. they do not support mode modifiers ((?s)), character classes (\w, + 6. they do not support mode modifiers ((?s)), character classes (\w, \d), or anything else not mentioned above. 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. Smart dates hledger's user interfaces accept a flexible "smart date" syntax (unlike - dates in the journal file). Smart dates allow some english words, can - be relative to today's date, and can have less-significant date parts + dates in the journal file). Smart dates allow some english words, can + be relative to today's date, and can have less-significant date parts omitted (defaulting to 1). Examples: - 2004/10/1, 2004-01-01, exact date, several separators allowed. Year + 2004/10/1, 2004-01-01, exact date, several separators allowed. Year 2004.9.1 is 4+ digits, month is 1-12, day is 1-31 2004 start of year 2004/10 start of month 10/1 month and day in current year 21 day in current month october, oct start of month in current year + yesterday, today, tomor- -1, 0, 1 days from today row last/this/next -1, 0, 1 periods from the current period day/week/month/quar- ter/year - 20181201 8 digit YYYYMMDD with valid year month and day 201812 6 digit YYYYMM with valid year and month - Counterexamples - malformed digit sequences might give surprising re- + Counterexamples - malformed digit sequences might give surprising re- sults: - 201813 6 digits with an invalid month is parsed as start of + 201813 6 digits with an invalid month is parsed as start of 6-digit year - 20181301 8 digits with an invalid month is parsed as start of + 20181301 8 digits with an invalid month is parsed as start of 8-digit year 20181232 8 digits with an invalid day gives an error 201801012 9+ digits beginning with a valid YYYYMMDD gives an error Report start & end date - Most hledger reports show the full span of time represented by the + Most hledger reports show the full span of time represented by the journal data, by default. So, the effective report start and end dates - will be the earliest and latest transaction or posting dates found in + will be the earliest and latest transaction or posting dates found in the journal. - Often you will want to see a shorter time span, such as the current - month. You can specify a start and/or end date using -b/--begin, + Often you will want to see a shorter time span, such as the current + month. You can specify a start and/or end date using -b/--begin, -e/--end, -p/--period or a date: query (described below). All of these accept the smart date syntax. Some notes: - o As in Ledger, end dates are exclusive, so you need to write the date + o As in Ledger, end dates are exclusive, so you need to write the date after the last day you want to include. - o As noted in reporting options: among start/end dates specified with + o As noted in reporting options: among start/end dates specified with options, the last (i.e. right-most) option takes precedence. - o The effective report start and end dates are the intersection of the - start/end dates from options and that from date: queries. That is, - date:2019-01 date:2019 -p'2000 to 2030' yields January 2019, the + o The effective report start and end dates are the intersection of the + start/end dates from options and that from date: queries. That is, + date:2019-01 date:2019 -p'2000 to 2030' yields January 2019, the smallest common time span. Examples: -b 2016/3/17 begin on St. Patrick's day 2016 - -e 12/1 end at the start of december 1st of the current year + -e 12/1 end at the start of december 1st of the current year (11/30 will be the last date included) -b thismonth all transactions on or after the 1st of the current month -p thismonth all transactions in the current month - date:2016/3/17.. the above written as queries instead (.. can also be re- + date:2016/3/17.. the above written as queries instead (.. can also be re- placed with -) date:..12/1 date:thismonth.. @@ -1056,31 +1061,31 @@ OPTIONS Report intervals A report interval can be specified so that commands like register, bal- - 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- + 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. Period expressions - The -p/--period option accepts period expressions, a shorthand way of + The -p/--period option accepts period expressions, a shorthand way of expressing a start date, end date, and/or report interval all at once. - Here's a basic period expression specifying the first quarter of 2009. - Note, hledger always treats start dates as inclusive and end dates as + Here's a basic period expression specifying the first quarter of 2009. + Note, hledger always treats start dates as inclusive and end dates as exclusive: -p "from 2009/1/1 to 2009/4/1" - Keywords like "from" and "to" are optional, and so are the spaces, as - long as you don't run two dates together. "to" can also be written as + Keywords like "from" and "to" are optional, and so are the spaces, as + long as you don't run two dates together. "to" can also be written as ".." or "-". These are equivalent to the above: -p "2009/1/1 2009/4/1" -p2009/1/1to2009/4/1 -p2009/1/1..2009/4/1 - Dates are smart dates, so if the current year is 2009, the above can + Dates are smart dates, so if the current year is 2009, the above can also be written as: -p "1/1 4/1" @@ -1094,74 +1099,73 @@ OPTIONS 1, 2009 -p "from 2009/1" the same -p "from 2009" the same - -p "to 2009" everything before january + -p "to 2009" everything before january 1, 2009 - A single date with no "from" or "to" defines both the start and end + A single date with no "from" or "to" defines both the start and end date like so: - -p "2009" the year 2009; equivalent + -p "2009" the year 2009; equivalent to "2009/1/1 to 2010/1/1" - -p "2009/1" the month of jan; equiva- + -p "2009/1" the month of jan; equiva- lent to "2009/1/1 to 2009/2/1" - -p "2009/1/1" just that day; equivalent + -p "2009/1/1" just that day; equivalent to "2009/1/1 to 2009/1/2" Or you can specify a single quarter like so: - -p "2009Q1" first quarter of 2009, + -p "2009Q1" first quarter of 2009, equivalent to "2009/1/1 to 2009/4/1" -p "q4" fourth quarter of the cur- rent year - The argument of -p can also begin with, or be, a report interval ex- + 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 + 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: -p "weekly from 2009/1/1 to 2009/4/1" -p "monthly in 2008" -p "quarterly" - Note that weekly, monthly, quarterly and yearly intervals will always + 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- + will end on the last day of same period, even if associated period ex- pression specifies different explicit start and end date. For example: - -p "weekly from 2009/1/1 starts on 2008/12/29, closest preceding Mon- + -p "weekly from 2009/1/1 starts on 2008/12/29, closest preceding Mon- to 2009/4/1" day - -p "monthly in starts on 2018/11/01 + -p "monthly in starts on 2018/11/01 2008/11/25" - -p "quarterly from starts on 2009/04/01, ends on 2009/06/30, + -p "quarterly from starts on 2009/04/01, ends on 2009/06/30, 2009-05-05 to 2009-06-01" which are first and last days of Q2 2009 - -p "yearly from starts on 2009/01/01, first day of 2009 2009-12-29" - The following more complex report intervals are also supported: bi- - weekly, fortnightly, bimonthly, every day|week|month|quarter|year, ev- + The following more complex report intervals are also supported: bi- + weekly, fortnightly, bimonthly, every day|week|month|quarter|year, ev- ery N days|weeks|months|quarters|years. - All of these will start on the first day of the requested period and + All of these will start on the first day of the requested period and end on the last one, as described above. Examples: - -p "bimonthly from 2008" periods will have boundaries on 2008/01/01, + -p "bimonthly from 2008" periods will have boundaries on 2008/01/01, 2008/03/01, ... -p "every 2 weeks" starts on closest preceding Monday - -p "every 5 month from periods will have boundaries on 2009/03/01, + -p "every 5 month from periods will have boundaries on 2009/03/01, 2009/03" 2009/08/01, ... - If you want intervals that start on arbitrary day of your choosing and + If you want intervals that start on arbitrary day of your choosing and span a week, month or year, you need to use any of the following: - every Nth day of week, every WEEKDAYNAME (eg + every Nth day of week, every WEEKDAYNAME (eg mon|tue|wed|thu|fri|sat|sun), every Nth day [of month], every Nth WEEK- DAYNAME [of month], every MM/DD [of year], every Nth MMM [of year], ev- ery MMM Nth [of year]. @@ -1171,42 +1175,42 @@ OPTIONS -p "every 2nd day of periods will go from Tue to Tue week" -p "every Tue" same - -p "every 15th day" period boundaries will be on 15th of each + -p "every 15th day" period boundaries will be on 15th of each month - -p "every 2nd Monday" period boundaries will be on second Monday of + -p "every 2nd Monday" period boundaries will be on second Monday of each month -p "every 11/05" yearly periods with boundaries on 5th of Nov -p "every 5th Nov" same -p "every Nov 5th" same - Show historical balances at end of 15th each month (N is exclusive end + Show historical balances at end of 15th each month (N is exclusive end date): hledger balance -H -p "every 16th day" - Group postings from start of wednesday to end of next tuesday (N is + Group postings from start of wednesday to end of next tuesday (N is start date and exclusive end date): hledger register checking -p "every 3rd day of week" 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- + 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 equivalent). Pivoting Normally hledger sums amounts, and organizes them in a hierarchy, based - on account name. The --pivot FIELD option causes it to sum and orga- - nize hierarchy based on the value of some other field instead. FIELD + on account name. The --pivot FIELD option causes it to sum and orga- + nize hierarchy based on the value of some other field instead. FIELD can be: code, description, payee, note, or the full name (case insensi- tive) of any tag. As with account names, values containing colon:sepa- rated:parts will be displayed hierarchically in reports. - --pivot is a general option affecting all reports; you can think of + --pivot is a general option affecting all reports; you can think of hledger transforming the journal before any other processing, replacing - every posting's account name with the value of the specified field on + every posting's account name with the value of the specified field on that posting, inheriting it from the transaction or using a blank value if it's not present. @@ -1232,7 +1236,7 @@ OPTIONS -------------------- 0 - One way to show only amounts with a member: value (using a query, de- + One way to show only amounts with a member: value (using a query, de- scribed below): $ hledger balance --pivot member tag:member=. @@ -1240,7 +1244,7 @@ OPTIONS -------------------- -2 EUR - Another way (the acct: query matches against the pivoted "account + Another way (the acct: query matches against the pivoted "account name"): $ hledger balance --pivot member acct:. @@ -1249,49 +1253,49 @@ OPTIONS -2 EUR Valuation - Instead of reporting amounts in their original commodity, hledger can + Instead of reporting amounts in their original commodity, hledger can convert them to cost/sale amount (using the conversion rate recorded in the transaction), or to market value (using some market price on a cer- tain date). This is controlled by the --value=TYPE[,COMMODITY] option, - but we also provide the simpler -B/-V/-X flags, and usually one of + but we also provide the simpler -B/-V/-X flags, and usually one of those is all you need. -B: Cost - The -B/--cost flag converts amounts to their cost or sale amount at + The -B/--cost flag converts amounts to their cost or sale amount at transaction time, if they have a transaction price specified. -V: Value - The -V/--market flag converts amounts to market value in their default + The -V/--market flag converts amounts to market value in their default valuation commodity, using the market prices in effect on the valuation date(s), if any. More on these in a minute. -X: Value in specified commodity The -X/--exchange=COMM option is like -V, except you tell it which cur- - rency you want to convert to, and it tries to convert everything to + rency you want to convert to, and it tries to convert everything to that. Valuation date - Since market prices can change from day to day, market value reports + Since market prices can change from day to day, market value reports have a valuation date (or more than one), which determines which market prices will be used. For single period reports, if an explicit report end date is specified, - that will be used as the valuation date; otherwise the valuation date + that will be used as the valuation date; otherwise the valuation date is "today". - For multiperiod reports, each column/period is valued on the last day + For multiperiod reports, each column/period is valued on the last day of the period, by default. Market prices (experimental) - To convert a commodity A to its market value in another commodity B, - hledger looks for a suitable market price (exchange rate) as follows, + To convert a commodity A to its market value in another commodity B, + hledger looks for a suitable market price (exchange rate) as follows, in this order of preference : - 1. A declared market price or inferred market price: A's latest market + 1. A declared market price or inferred market price: A's latest market price in B on or before the valuation date as declared by a P direc- - tive, or (with the --infer-value flag) inferred from transaction + tive, or (with the --infer-value flag) inferred from transaction prices. 2. A reverse market price: the inverse of a declared or inferred market @@ -1301,8 +1305,8 @@ OPTIONS bining the shortest chain of "forward" (only 1 above) market prices, leading from A to B. - 4. A any chain of market prices: a chain of any market prices, includ- - ing both forward and reverse prices (1 and 2 above), leading from A + 4. A any chain of market prices: a chain of any market prices, includ- + ing both forward and reverse prices (1 and 2 above), leading from A to B. Amounts for which no applicable market price can be found, are not con- @@ -1313,17 +1317,17 @@ OPTIONS Normally, market value in hledger is fully controlled by, and requires, P directives in your journal. Since adding and updating those can be a - chore, and since transactions usually take place at close to market + chore, and since transactions usually take place at close to market value, why not use the recorded transaction prices as additional market prices (as Ledger does) ? We could produce value reports without need- ing P directives at all. - Adding the --infer-value flag to -V, -X or --value enables this. So - for example, hledger bs -V --infer-value will get market prices both + Adding the --infer-value flag to -V, -X or --value enables this. So + for example, hledger bs -V --infer-value will get market prices both from P directives and from transactions. There is a downside: value reports can sometimes be affected in confus- - ing/undesired ways by your journal entries. If this happens to you, + ing/undesired ways by your journal entries. If this happens to you, read all of this Valuation section carefully, and try adding --debug or --debug=2 to troubleshoot. @@ -1331,45 +1335,45 @@ OPTIONS o multicommodity transactions with explicit prices (@/@@) - o multicommodity transactions with implicit prices (no @, two commodi- - ties, unbalanced). (With these, the order of postings matters. + o multicommodity transactions with implicit prices (no @, two commodi- + ties, unbalanced). (With these, the order of postings matters. hledger print -x can be useful for troubleshooting.) - o but not, currently, from "more correct" multicommodity transactions + o but not, currently, from "more correct" multicommodity transactions (no @, multiple commodities, balanced). Valuation commodity (experimental) When you specify a valuation commodity (-X COMM or --value TYPE,COMM): - hledger will convert all amounts to COMM, wherever it can find a suit- + hledger will convert all amounts to COMM, wherever it can find a suit- able market price (including by reversing or chaining prices). - When you leave the valuation commodity unspecified (-V or --value + When you leave the valuation commodity unspecified (-V or --value TYPE): - For each commodity A, hledger picks a default valuation commodity as + For each commodity A, hledger picks a default valuation commodity as follows, in this order of preference: 1. The price commodity from the latest P-declared market price for A on or before valuation date. 2. The price commodity from the latest P-declared market price for A on - any date. (Allows conversion to proceed when there are inferred + any date. (Allows conversion to proceed when there are inferred prices before the valuation date.) - 3. If there are no P directives at all (any commodity or date) and the - --infer-value flag is used: the price commodity from the latest + 3. If there are no P directives at all (any commodity or date) and the + --infer-value flag is used: the price commodity from the latest transaction-inferred price for A on or before valuation date. This means: - o If you have P directives, they determine which commodities -V will + o If you have P directives, they determine which commodities -V will convert, and to what. o If you have no P directives, and use the --infer-value flag, transac- tion prices determine it. - Amounts for which no valuation commodity can be found are not con- + Amounts for which no valuation commodity can be found are not con- verted. Simple valuation examples @@ -1396,7 +1400,7 @@ OPTIONS $ hledger -f t.j bal -N euros -V -e 2016/11/4 $110.00 assets:euros - What are they worth after 2016/12/21 ? (no report end date specified, + What are they worth after 2016/12/21 ? (no report end date specified, defaults to today) $ hledger -f t.j bal -N euros -V @@ -1417,36 +1421,36 @@ OPTIONS The TYPE part selects cost or value and valuation date: --value=cost - Convert amounts to cost, using the prices recorded in transac- + Convert amounts to cost, using the prices recorded in transac- tions. --value=then - Convert amounts to their value in the default valuation commod- - ity, using market prices on each posting's date. This is cur- + Convert amounts to their value in the default valuation commod- + ity, using market prices on each posting's date. This is cur- rently supported only by the print and register commands. --value=end - Convert amounts to their value in the default valuation commod- - ity, using market prices on the last day of the report period - (or if unspecified, the journal's end date); or in multiperiod + Convert amounts to their value in the default valuation commod- + ity, using market prices on the last day of the report period + (or if unspecified, the journal's end date); or in multiperiod reports, market prices on the last day of each subperiod. --value=now - Convert amounts to their value in the default valuation commod- - ity using current market prices (as of when report is gener- + Convert amounts to their value in the default valuation commod- + ity using current market prices (as of when report is gener- ated). --value=YYYY-MM-DD - Convert amounts to their value in the default valuation commod- + Convert amounts to their value in the default valuation commod- ity using market prices on this date. To select a different valuation commodity, add the optional ,COMM part: - a comma, then the target commodity's symbol. Eg: --value=now,EUR. + a comma, then the target commodity's symbol. Eg: --value=now,EUR. hledger will do its best to convert amounts to this commodity, deducing market prices as described above. More valuation examples - Here are some examples showing the effect of --value, as seen with + Here are some examples showing the effect of --value, as seen with print: P 2000-01-01 A 1 B @@ -1484,7 +1488,7 @@ OPTIONS 2000-02-01 (a) 2 B - With no report period specified, that shows the value as of the last + With no report period specified, that shows the value as of the last day of the journal (2000-03-01): $ hledger -f- print --value=end @@ -1521,7 +1525,7 @@ OPTIONS 2000-03-01 (a) 1 B - You may need to explicitly set a commodity's display style, when re- + You may need to explicitly set a commodity's display style, when re- verse prices are used. Eg this output might be surprising: P 2000-01-01 A 2B @@ -1535,10 +1539,10 @@ OPTIONS a 0 b 0 - Explanation: because there's no amount or commodity directive specify- - ing a display style for A, 0.5A gets the default style, which shows no + Explanation: because there's no amount or commodity directive specify- + ing a display style for A, 0.5A gets the default style, which shows no decimal digits. Because the displayed amount looks like zero, the com- - modity symbol and minus sign are not displayed either. Adding a com- + modity symbol and minus sign are not displayed either. Adding a com- modity directive sets a more useful display style for A: P 2000-01-01 A 2B @@ -1554,9 +1558,9 @@ OPTIONS b -0.50A Effect of valuation on reports - Here is a reference for how valuation is supposed to affect each part - of hledger's reports (and a glossary). (It's wide, you'll have to - scroll sideways.) It may be useful when troubleshooting. If you find + Here is a reference for how valuation is supposed to affect each part + of hledger's reports (and a glossary). (It's wide, you'll have to + scroll sideways.) It may be useful when troubleshooting. If you find problems, please report them, ideally with a reproducible example. Re- lated: #329, #1083. @@ -1564,7 +1568,7 @@ OPTIONS --value=cost --value=now -------------------------------------------------------------------------------------------- print - posting cost value at re- value at value at re- value at + posting cost value at re- value at value at re- value at amounts port end or posting date port or jour- DATE/today today nal end balance as- unchanged unchanged unchanged unchanged unchanged @@ -1573,15 +1577,15 @@ OPTIONS signments register - starting cost value at day not sup- value at day value at + starting cost value at day not sup- value at day value at balance before report ported before report DATE/today (-H) or journal or journal start start - posting cost value at re- value at value at re- value at + posting cost value at re- value at value at re- value at amounts port end or posting date port or jour- DATE/today today nal end - summary summarised value at pe- sum of post- value at pe- value at - posting cost riod ends ings in in- riod ends DATE/today + summary summarised value at pe- sum of post- value at pe- value at + posting cost riod ends ings in in- riod ends DATE/today amounts terval, val- with report ued at in- interval terval start @@ -1592,9 +1596,9 @@ OPTIONS balance (bs, bse, cf, is) - balance sums of costs value at re- not sup- value at re- value at + balance sums of costs value at re- not sup- value at re- value at changes port end or ported port or jour- DATE/today of - today of sums nal end of sums of post- + today of sums nal end of sums of post- of postings sums of post- ings ings budget like balance like balance not sup- like balances like balance @@ -1608,7 +1612,7 @@ OPTIONS cf, is) with report interval - starting sums of costs value at re- not sup- value at re- sums of post- + starting sums of costs value at re- not sup- value at re- sums of post- balances of postings port start of ported port start of ings before (-H) before report sums of all sums of all report start start postings be- postings be- @@ -1616,6 +1620,10 @@ OPTIONS start start + + + + balance sums of costs same as not sup- balance value at changes of postings --value=end ported change in DATE/today of (bal, is, in period each period, sums of post- @@ -1632,10 +1640,10 @@ OPTIONS amounts changes/end changes/end ported changes/end (--budget) balances balances balances row totals, sums, aver- sums, aver- not sup- sums, aver- sums, aver- - row aver- ages of dis- ages of dis- ported ages of dis- ages of dis- + row aver- ages of dis- ages of dis- ported ages of dis- ages of dis- ages (-T, played values played values played values played values -A) - column to- sums of dis- sums of dis- not sup- sums of dis- sums of dis- + column to- sums of dis- sums of dis- not sup- sums of dis- sums of dis- tals played values played values ported played values played values grand to- sum, average sum, average not sup- sum, average sum, average tal, grand of column to- of column to- ported of column to- of column to- @@ -1649,60 +1657,60 @@ OPTIONS 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). 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 in- + comestatement). 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- + 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. 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: @@ -1721,8 +1729,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: @@ -1735,25 +1743,25 @@ COMMANDS add add - Prompt for transactions and add them to the journal. Any arguments + Prompt for transactions and add them to the journal. Any arguments will be used as default inputs for the first N prompts. - Many hledger users edit their journals directly with a text editor, or - generate them from CSV. For more interactive data entry, there is the - add command, which prompts interactively on the console for new trans- + Many hledger users edit their journals directly with a text editor, or + generate them from CSV. For more interactive data entry, there is the + add command, which prompts interactively on the console for new trans- actions, and appends them to the journal file (if there are multiple -f - FILE options, the first file is used.) Existing transactions are not - changed. This is the only hledger command that writes to the journal + FILE options, the first file is used.) Existing transactions are not + changed. This is the only hledger command that writes to the journal file. To use it, just run hledger add and follow the prompts. You can add as - many transactions as you like; when you are finished, enter . or press + many transactions as you like; when you are finished, enter . or press control-d or control-c to exit. Features: - o add tries to provide useful defaults, using the most similar (by de- - scription) recent transaction (filtered by the query, if any) as a + o add tries to provide useful defaults, using the most similar (by de- + scription) recent transaction (filtered by the query, if any) as a template. o You can also set the initial defaults with command line arguments. @@ -1761,10 +1769,10 @@ COMMANDS o Readline-style edit keys can be used during data entry. o The tab key will auto-complete whenever possible - accounts, descrip- - tions, dates (yesterday, today, tomorrow). If the input area is + tions, dates (yesterday, today, tomorrow). If the input area is empty, it will insert the default value. - o If the journal defines a default commodity, it will be added to any + o If the journal defines a default commodity, it will be added to any bare numbers entered. o A parenthesised transaction code may be entered following a date. @@ -1773,7 +1781,7 @@ COMMANDS o If you make a mistake, enter < at any prompt to go one step backward. - o Input prompts are displayed in a different colour when the terminal + o Input prompts are displayed in a different colour when the terminal supports it. Example (see the tutorial for a detailed explanation): @@ -1803,16 +1811,16 @@ COMMANDS Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ - On Microsoft Windows, the add command makes sure that no part of the + On Microsoft Windows, the add command makes sure that no part of the file path ends with a period, as that would cause problems (#1056). aregister aregister, areg - Show transactions affecting a particular account, and the account's + Show transactions affecting a particular account, and the account's running balance. - aregister shows the transactions affecting a particular account (and - its subaccounts), from the point of view of that account. Each line + aregister shows the transactions affecting a particular account (and + its subaccounts), from the point of view of that account. Each line shows: o the transaction's (or posting's, see below) date @@ -1821,35 +1829,35 @@ COMMANDS o the net change to this account's balance - o the account's historical running balance (including balance from + o the account's historical running balance (including balance from transactions before the report start date). - With aregister, each line represents a whole transaction - as in - hledger-ui, hledger-web, and your bank statement. By contrast, the - register command shows individual postings, across all accounts. You - might prefer aregister for reconciling with real-world asset/liability + With aregister, each line represents a whole transaction - as in + hledger-ui, hledger-web, and your bank statement. By contrast, the + register command shows individual postings, across all accounts. You + might prefer aregister for reconciling with real-world asset/liability accounts, and register for reviewing detailed revenues/expenses. An account must be specified as the first argument, which should be the - full account name or an account pattern (regular expression). aregis- - ter will show transactions in this account (the first one matched) and + full account name or an account pattern (regular expression). aregis- + ter will show transactions in this account (the first one matched) and any of its subaccounts. - Any additional arguments form a query which will filter the transac- + Any additional arguments form a query which will filter the transac- tions shown. - Transactions making a net change of zero are not shown by default; add + Transactions making a net change of zero are not shown by default; add the -E/--empty flag to show them. aregister and custom posting dates - Transactions whose date is outside the report period can still be - shown, if they have a posting to this account dated inside the report - period. (And in this case it's the posting date that is shown.) This + Transactions whose date is outside the report period can still be + shown, if they have a posting to this account dated inside the report + period. (And in this case it's the posting date that is shown.) This ensures that aregister can show an accurate historical running balance, matching the one shown by register -H with the same arguments. - To filter strictly by transaction date instead, add the --txn-dates - flag. If you use this flag and some of your postings have custom + To filter strictly by transaction date instead, add the --txn-dates + flag. If you use this flag and some of your postings have custom dates, it's probably best to assume the running balance is wrong. Output format @@ -1858,12 +1866,12 @@ COMMANDS Examples: - Show all transactions and historical running balance in the first ac- + Show all transactions and historical running balance in the first ac- count whose name contains "checking": $ hledger areg checking - Show transactions and historical running balance in all asset accounts + Show transactions and historical running balance in all asset accounts during july: $ hledger areg assets date:jul @@ -1873,29 +1881,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 @@ -1913,21 +1921,21 @@ COMMANDS 0 By default, accounts are displayed hierarchically, with subaccounts in- - dented below their parent, with accounts at each level of the tree + dented below their parent, with accounts at each level of the tree sorted by declaration order if declared, then by account name. "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 @@ -1936,7 +1944,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)" @@ -1954,7 +1962,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) @@ -1965,14 +1973,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) @@ -1989,24 +1997,24 @@ COMMANDS 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 - In terminal output, when colour is enabled, the balance command shows + In terminal output, when colour is enabled, the balance command shows negative amounts in red. 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. @@ -2015,8 +2023,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 @@ -2029,9 +2037,9 @@ COMMANDS inclusive balances at the depth limit. Percentages - With -% or --percent, balance reports show each account's value ex- - pressed as a percentage of the column's total. This is useful to get - an overview of the relative sizes of account balances. For example to + With -% or --percent, balance reports show each account's value ex- + pressed as a percentage of the column's total. This is useful to get + an overview of the relative sizes of account balances. For example to obtain an overview of expenses: $ hledger balance expenses -% @@ -2041,43 +2049,43 @@ COMMANDS -------------------- 100.0 % - Note that --tree does not have an effect on -%. The percentages are - always relative to the total sum of each column, they are never rela- + Note that --tree does not have an effect on -%. The percentages are + always relative to the total sum of each column, they are never rela- tive to the parent account. - Since the percentages are relative to the columns sum, it is usually - not useful to calculate percentages if the signs of the amounts are - mixed. Although the results are technically correct, they are most - likely useless. Especially in a balance report that sums up to zero + Since the percentages are relative to the columns sum, it is usually + not useful to calculate percentages if the signs of the amounts are + mixed. Although the results are technically correct, they are most + likely useless. Especially in a balance report that sums up to zero (eg hledger balance -B) all percentage values will be zero. - This flag does not work if the report contains any mixed commodity ac- + This flag does not work if the report contains any mixed commodity ac- counts. If there are mixed commodity accounts in the report be sure to use -V or -B to coerce the report into using a single commodity. Sorting by amount - With -S/--sort-amount, accounts with the largest (most positive) bal- - ances are shown first. For example, hledger bal expenses -MAS shows + With -S/--sort-amount, accounts with the largest (most positive) bal- + ances are shown first. For example, hledger bal expenses -MAS shows your biggest averaged monthly expenses first. - Revenues and liability balances are typically negative, however, so -S - shows these in reverse order. To work around this, you can add --in- - vert to flip the signs. Or, use one of the sign-flipping reports like + Revenues and liability balances are typically negative, however, so -S + shows these in reverse order. To work around this, you can add --in- + vert to flip the signs. Or, use one of the sign-flipping reports like balancesheet or incomestatement, which also support -S. Eg: hledger is -MAS. 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- + 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. - 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 @@ -2093,7 +2101,7 @@ 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 + riod, accumulating the changes across periods, starting from 0 at the report start date: $ hledger balance --quarterly income expenses -E --cumulative @@ -2109,8 +2117,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: @@ -2129,26 +2137,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: + 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 + 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 -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: @@ -2169,27 +2177,27 @@ COMMANDS (Average is rounded to the dollar here since all journal amounts are) - The --transpose flag can be used to exchange the rows and columns of a + The --transpose flag can be used to exchange the rows and columns of a multicolumn report. - When showing multicommodity amounts, multicolumn balance reports will + When showing multicommodity amounts, multicolumn balance reports will elide any amounts which have more than two commodities, since otherwise - columns could get very wide. The --no-elide flag disables this. Hid- - ing totals with the -N/--no-total flag can also help reduce the width + columns could get very wide. The --no-elide flag disables this. Hid- + ing totals with the -N/--no-total flag can also help reduce the width of multicommodity reports. When the report is still too wide, a good workaround is to pipe it into - less -RS (-R for colour, -S to chop long lines). Eg: hledger bal -D + less -RS (-R for colour, -S to chop long lines). Eg: hledger bal -D --color=yes | less -RS. Budget report - With --budget, extra columns are displayed showing budget goals for - each account and period, if any. Budget goals are defined by periodic + 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 + come, 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- + For example, you can take average monthly expenses in the common ex- pense categories to construct a minimal monthly budget: ;; Budget @@ -2236,26 +2244,26 @@ COMMANDS This is different from a normal balance report in several ways: - o Only accounts with budget goals during the report period are shown, + o Only accounts with budget goals during the report period are shown, by default. - o In each column, in square brackets after the actual amount, budget - goal amounts are shown, and the actual/goal percentage. (Note: bud- + o In each column, in square brackets after the actual amount, budget + goal amounts are shown, and the actual/goal percentage. (Note: bud- get goals should be in the same commodity as the actual amount.) - o All parent accounts are always shown, even in 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 @@ -2297,12 +2305,12 @@ COMMANDS For more examples and notes, see Budgeting. Budget report start date - This might be a bug, but for now: when making budget reports, it's a + This might be a bug, but for now: when making budget reports, it's a good idea to explicitly set the report's start date to the first day of - a reporting period, because a periodic rule like ~ monthly generates - its transactions on the 1st of each month, and if your journal has no - regular transactions on the 1st, the default report start date could - exclude that budget goal, which can be a little surprising. Eg here + a reporting period, because a periodic rule like ~ monthly generates + its transactions on the 1st of each month, and if your journal has no + regular transactions on the 1st, the default report start date could + exclude that budget goal, which can be a little surprising. Eg here the default report period is just the day of 2020-01-15: ~ monthly in 2020 @@ -2321,9 +2329,9 @@ COMMANDS --------------++------------ || $400 - To avoid this, specify the budget report's period, or at least the - start date, with -b/-e/-p/date:, to ensure it includes the budget goal - transactions (periodic transactions) that you want. Eg, adding -b + To avoid this, specify the budget report's period, or at least the + start date, with -b/-e/-p/date:, to ensure it includes the budget goal + transactions (periodic transactions) that you want. Eg, adding -b 2020/1/1 to the above: $ hledger bal expenses --budget -b 2020/1/1 @@ -2336,12 +2344,12 @@ COMMANDS || $400 [80% of $500] 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: @@ -2351,13 +2359,13 @@ COMMANDS expenses:personal:electronics $100.00 liabilities - With this, monthly budget for electronics is defined to be $100 and - budget for personal expenses is an additional $1000, which implicitly + With this, monthly budget for electronics is defined to be $100 and + budget for personal expenses is an additional $1000, which implicitly means that budget for both expenses:personal and expenses is $1100. - Transactions in expenses:personal:electronics will be counted both to- + Transactions in expenses:personal:electronics will be counted both to- wards its $100 budget and $1100 of expenses:personal , and transactions - in any other subaccount of expenses:personal would be counted towards + in any other subaccount of expenses:personal would be counted towards only towards the budget of expenses:personal. For example, let's consider these transactions: @@ -2383,9 +2391,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: @@ -2401,7 +2409,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 @@ -2425,14 +2433,14 @@ COMMANDS balancesheet balancesheet, bs - This command displays a balance sheet, showing historical ending bal- + This command displays a balance sheet, showing historical ending bal- ances of asset and liability accounts. (To see equity as well, use the - balancesheetequity command.) Amounts are shown with normal positive + balancesheetequity command.) Amounts are shown with normal positive sign, as in conventional financial statements. The asset and liability accounts shown are those accounts declared with - the Asset or Cash or Liability type, or otherwise all accounts under a - top-level asset or liability account (case insensitive, plurals al- + the Asset or Cash or Liability type, or otherwise all accounts under a + top-level asset or liability account (case insensitive, plurals al- lowed). Example: @@ -2457,25 +2465,25 @@ 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 - sense). Instead of absolute values percentages can be displayed with + 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). Instead of absolute values percentages can be displayed with -%. This command also supports the output destination and output format op- - tions The output formats supported are txt, csv, html, and (experimen- + tions The output formats supported are txt, csv, html, and (experimen- tal) json. balancesheetequity balancesheetequity, bse - This command displays a balance sheet, showing historical ending bal- - ances of asset, liability and equity accounts. Amounts are shown with + This command displays a balance sheet, showing historical ending bal- + ances of asset, liability and equity accounts. Amounts are shown with normal positive sign, as in conventional financial statements. - The asset, liability and equity accounts shown are those accounts de- + The asset, liability and equity accounts shown are those accounts de- clared with the Asset, Cash, Liability or Equity type, or otherwise all accounts under a top-level asset, liability or equity account (case in- sensitive, plurals allowed). @@ -2507,18 +2515,18 @@ COMMANDS 0 This command also supports the output destination and output format op- - tions The output formats supported are txt, csv, html, and (experimen- + tions The output formats supported are txt, csv, html, and (experimen- tal) json. cashflow cashflow, cf - This command displays a cashflow statement, showing the inflows and - outflows affecting "cash" (ie, liquid) assets. Amounts are shown with + This command displays a cashflow statement, showing the inflows and + outflows affecting "cash" (ie, liquid) assets. Amounts are shown with normal positive sign, as in conventional financial statements. - The "cash" accounts shown are those accounts declared with the Cash - type, or otherwise all accounts under a top-level asset account (case - insensitive, plural allowed) which do not have fixed, investment, re- + The "cash" accounts shown are those accounts declared with the Cash + type, or otherwise all accounts under a top-level asset account (case + insensitive, plural allowed) which do not have fixed, investment, re- ceivable or A/R in their name. Example: @@ -2538,90 +2546,126 @@ 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. Instead of absolute val- ues percentages can be displayed with -%. This command also supports the output destination and output format op- - tions The output formats supported are txt, csv, html, and (experimen- + tions The output formats supported are txt, csv, html, and (experimen- tal) json. - 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. - Reads the default journal file, or another specified with -f. + check + check + Check for various kinds of errors in your data. - 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. - Reads the default journal file, or another specified as an argument. + hledger provides a number of built-in error checks to help prevent + problems in your data. Some, but not all, of these are run automati- + cally before all commands. You can also use this check command to run + any of the available tests. They are named, and run, as follows: - An example: http://stefanorodighiero.net/software/hledger-dupes.html + hledger check runs the basic checks, like all other commands, but with + no output unless there is a problem. These are: + + o parseable - data files are well-formed and can be successfully parsed + + o autobalanced - all transactions are balanced, inferring missing + amounts where necessary, and possibly converting commodities using + transaction prices or automatically-inferred transaction prices + + o assertions - all balance assertions are passing (except with -I/--ig- + nore-assertions) + + hledger check --strict also runs the additional "strict mode" checks, + which are: + + o accounts - all account names used by transactions have been declared + + o commodities - all commodity symbols used have been declared + + hledger check CHECK1 CHECK2 ... runs all of the named checks, in turn. + This may be useful when neither the default nor strict checks are ex- + actly what you want, or when you want to focus on a single check of in- + terest. The arguments are standard lowercase names for the checks. + Currently only these checks can be run in this way: + + o dates - transactions are ordered by date (similar to the old check- + dates command) + + o leafnames - all account leaf names are unique ((similar to the old + check-dupes command) + + See also: + + Some checks are shipped as addon scripts for now (cf + https://github.com/simonmichael/hledger/tree/master/bin, and Cookbook + -> Scripting): + + o tagfiles - all tag values containing / (a forward slash) exist as + file paths + + o fancyassertions - more complex balance assertions are passing 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. These can be added to your journal file(s), eg to bring asset/liability - balances forward into a new journal file, or to close out revenues/ex- + balances forward into a new journal file, or to close out revenues/ex- penses to retained earnings at the end of a period. - You can print just one of these transactions by using the --close or - --open flag. You can customise their descriptions with the --close- + You can print just one of these transactions by using the --close or + --open flag. You can customise their descriptions with the --close- desc and --open-desc options. One amountless posting to "equity:opening/closing balances" is added to - balance the transactions, by default. You can customise this account - name with --close-acct and --open-acct; if you specify only one of + balance the transactions, by default. You can customise this account + name with --close-acct and --open-acct; if you specify only one of these, it will be used for both. With --x/--explicit, the equity posting's amount will be shown. And if - it involves multiple commodities, a posting for each commodity will be + it involves multiple commodities, a posting for each commodity will be shown, as with the print command. - With --interleaved, the equity postings are shown next to the postings + With --interleaved, the equity postings are shown next to the postings they balance, which makes troubleshooting easier. By default, transaction prices in the journal are ignored when generat- ing the closing/opening transactions. With --show-costs, this cost in- - formation is preserved (balance -B reports will be unchanged after the - transition). Separate postings are generated for each cost in each - commodity. Note this can generate very large journal entries, if you + formation is preserved (balance -B reports will be unchanged after the + transition). Separate postings are generated for each cost in each + commodity. Note this can generate very large journal entries, if you have many foreign currency or investment transactions. close usage 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- + 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 + (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. Examples: @@ -2662,13 +2706,13 @@ COMMANDS codes List the codes seen in transactions, in the order parsed. - This command prints the value of each transaction's code field, in the - order transactions were parsed. The transaction code is an optional - value written in parentheses between the date and description, often + This command prints the value of each transaction's code field, in the + order transactions were parsed. The transaction code is an optional + value written in parentheses between the date and description, often used to store a cheque number, order number or similar. Transactions aren't required to have a code, and missing or empty codes - will not be shown by default. With the -E/--empty flag, they will be + will not be shown by default. With the -E/--empty flag, they will be printed as blank lines. You can add a query to select a subset of transactions. @@ -2708,7 +2752,7 @@ COMMANDS List the unique descriptions that appear in transactions. This command lists the unique descriptions that appear in transactions, - in alphabetic order. You can add a query to select a subset of trans- + in alphabetic order. You can add a query to select a subset of trans- actions. Example: @@ -2720,18 +2764,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. @@ -2749,20 +2793,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: @@ -2789,9 +2833,9 @@ 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- - tions that would be added. Or with --catchup, just mark all of the + 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. Or with --catchup, just mark all of the FILEs' transactions as imported, without actually importing any. The input files are specified as arguments - no need to write -f before @@ -2802,23 +2846,23 @@ 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.) Commodity display styles @@ -2827,13 +2871,13 @@ COMMANDS incomestatement incomestatement, is - This command displays an income statement, showing revenues and ex- + This command displays an income statement, showing revenues and ex- penses during one or more periods. Amounts are shown with normal posi- tive sign, as in conventional financial statements. The revenue and expense accounts shown are those accounts declared with - the Revenue or Expense type, or otherwise all accounts under a top- - level revenue or income or expense account (case insensitive, plurals + the Revenue or Expense type, or otherwise all accounts under a top- + level revenue or income or expense account (case insensitive, plurals allowed). Example: @@ -2860,13 +2904,13 @@ 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 mode with --change/--cumulative/--historical. Instead of abso- + 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. Instead of abso- lute values percentages can be displayed with -%. This command also supports the output destination and output format op- - tions The output formats supported are txt, csv, html, and (experimen- + tions The output formats supported are txt, csv, html, and (experimen- tal) json. notes @@ -2874,8 +2918,8 @@ COMMANDS List the unique notes that appear in transactions. This command lists the unique notes that appear in transactions, in al- - phabetic order. You can add a query to select a subset of transac- - tions. The note is the part of the transaction description after a | + phabetic order. You can add a query to select a subset of transac- + tions. The note is the part of the transaction description after a | character (or if there is no |, the whole description). Example: @@ -2889,8 +2933,8 @@ COMMANDS List the unique payee/payer names that appear in transactions. This command lists the unique payee/payer names that appear in transac- - tions, in alphabetic order. You can add a query to select a subset of - transactions. The payee/payer is the part of the transaction descrip- + tions, in alphabetic order. You can add a query to select a subset of + transactions. The payee/payer is the part of the transaction descrip- tion before a | character (or if there is no |, the whole description). Example: @@ -2902,10 +2946,10 @@ 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 --in- + verted-costs, also print inverse prices based on transaction prices. + Prices (and postings providing prices) can be filtered by a query. Price amounts are always displayed with their full precision. print @@ -2913,11 +2957,11 @@ COMMANDS Show transaction journal entries, sorted by date. The print command displays full journal entries (transactions) from the - journal file in date order, tidily formatted. With --date2, transac- + journal file in date order, tidily formatted. With --date2, transac- 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- + It preserves all transaction information, but it does not preserve di- rectives or inter-transaction comments $ hledger print @@ -2944,43 +2988,43 @@ COMMANDS Normally, the journal entry's explicit or implicit amount style is pre- served. For example, when an amount is omitted in the journal, it will - not appear in the output. Similarly, when a transaction price is im- - plied but not written, it will not appear in the output. You can use - the -x/--explicit flag to make all amounts and transaction prices ex- - plicit, which can be useful for troubleshooting or for making your + not appear in the output. Similarly, when a transaction price is im- + plied but not written, it will not appear in the output. You can use + the -x/--explicit flag to make all amounts and transaction prices ex- + plicit, which can be useful for troubleshooting or for making your journal more readable and robust against data entry errors. -x is also implied by using any of -B,-V,-X,--value. - Note, -x/--explicit will cause postings with a multi-commodity amount - (these can arise when a multi-commodity transaction has an implicit - amount) to be split into multiple single-commodity postings, keeping + Note, -x/--explicit will cause postings with a multi-commodity amount + (these can arise when a multi-commodity transaction has an implicit + amount) to be split into multiple single-commodity postings, keeping the output parseable. - With -B/--cost, amounts with transaction prices are converted to cost + With -B/--cost, amounts with transaction prices are converted to cost using that price. This can be used for troubleshooting. - With -m/--match and a STR argument, print will show at most one trans- - action: the one one whose description is most similar to STR, and is - most recent. STR should contain at least two characters. If there is + With -m/--match and a STR argument, print will show at most one trans- + action: the one one whose description is most similar to STR, and is + most recent. STR should contain at least two characters. If there is no similar-enough match, no transaction will be shown. With --new, for each FILE being read, hledger reads (and writes) a spe- - 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 + 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 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- + 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 command also supports the output destination and output format op- - tions The output formats supported are txt, csv, and (experimental) + tions The output formats supported are txt, csv, and (experimental) json and sql. Here's an example of print's CSV output: @@ -2999,20 +3043,20 @@ COMMANDS "5","2008/12/31","","*","","pay off","","liabilities:debts","1","$","","1","","" "5","2008/12/31","","*","","pay off","","assets:bank:checking","-1","$","1","","","" - o There is one CSV record per posting, with the parent transaction's + o There is one CSV record per posting, with the parent transaction's fields repeated. o The "txnidx" (transaction index) field shows which postings belong to - the same transaction. (This number might change if transactions are - reordered within the file, files are parsed/included in a different + the same transaction. (This number might change if transactions are + reordered within the file, files are parsed/included in a different order, etc.) - o The amount is separated into "commodity" (the symbol) and "amount" + o The amount is separated into "commodity" (the symbol) and "amount" (numeric quantity) fields. o The numeric amount is repeated in either the "credit" or "debit" col- - umn, for convenience. (Those names are not accurate in the account- - ing sense; it just puts negative amounts under credit and zero or + umn, for convenience. (Those names are not accurate in the account- + ing sense; it just puts negative amounts under credit and zero or greater amounts under debit.) print-unique @@ -3036,14 +3080,14 @@ COMMANDS Show postings and their running total. The register command displays matched postings, across all accounts, in - date order, with their running total or running historical balance. - (See also the aregister command, which shows matched transactions in a + date order, with their running total or running historical balance. + (See also the aregister command, which shows matched transactions in a specific account.) register normally shows line per posting, but note that multi-commodity amounts will occupy multiple lines (one line per commodity). - It is typically used with a query selecting a particular account, to + It is typically used with a query selecting a particular account, to see that account's activity: $ hledger register checking @@ -3054,8 +3098,8 @@ COMMANDS With --date2, it shows and sorts by secondary date instead. - The --historical/-H flag adds the balance from any undisplayed prior - postings to the running total. This is useful when you want to see + The --historical/-H flag adds the balance from any undisplayed prior + postings to the running total. This is useful when you want to see only recent activity, with a historically accurate running balance: $ hledger register checking -b 2008/6 --historical @@ -3065,18 +3109,18 @@ COMMANDS The --depth option limits the amount of sub-account detail displayed. - The --average/-A flag shows the running average posting amount instead + The --average/-A flag shows the running average posting amount instead of the running total (so, the final number displayed is the average for - the whole report period). This flag implies --empty (see below). It - is affected by --historical. It works best when showing just one ac- + the whole report period). This flag implies --empty (see below). It + is affected by --historical. It works best when showing just one ac- count and one commodity. - The --related/-r flag shows the other postings in the transactions of + The --related/-r flag shows the other postings in the transactions of the postings which would normally be shown. - The --invert flag negates all amounts. For example, it can be used on + The --invert flag negates all amounts. For example, it can be used on an income account where amounts are normally displayed as negative num- - bers. It's also useful to show postings on the checking account to- + bers. It's also useful to show postings on the checking account to- gether with the related account: $ hledger register --related --invert assets:checking @@ -3088,7 +3132,7 @@ COMMANDS 2008/01 income:salary $-1 $-1 2008/06 income:gifts $-1 $-2 - Periods with no activity, and summary postings with a zero amount, are + Periods with no activity, and summary postings with a zero amount, are not shown by default; use the --empty/-E flag to see them: $ hledger register --monthly income -E @@ -3105,7 +3149,7 @@ COMMANDS 2008/11 0 $-2 2008/12 0 $-2 - Often, you'll want to see just one line per interval. The --depth op- + Often, you'll want to see just one line per interval. The --depth op- tion helps with this, causing subaccounts to be aggregated: $ hledger register --monthly assets --depth 1h @@ -3113,17 +3157,17 @@ COMMANDS 2008/06 assets $-1 0 2008/12 assets $-1 $-1 - Note when using report intervals, if you specify start/end dates these - will be adjusted outward if necessary to contain a whole number of in- - tervals. This ensures that the first and last intervals are full + Note when using report intervals, if you specify start/end dates these + will be adjusted outward if necessary to contain a whole number of in- + tervals. This ensures that the first and last intervals are full length and comparable to the others in the report. Custom register output - register uses the full terminal width by default, except on windows. - You can override this by setting the COLUMNS environment variable (not + register uses the full terminal width by default, except on windows. + You can override this by setting the COLUMNS environment variable (not a bash shell variable) or by using the --width/-w option. - The description and account columns normally share the space equally + The description and account columns normally share the space equally (about half of (width - 40) each). You can adjust this by adding a de- scription width as part of --width's argument, comma-separated: --width W,D . Here's a diagram (won't display correctly in --help): @@ -3142,27 +3186,27 @@ COMMANDS $ hledger reg -w $COLUMNS,40 # use terminal width, & description width 40 This command also supports the output destination and output format op- - tions The output formats supported are txt, csv, and (experimental) + tions The output formats supported are txt, csv, and (experimental) json. register-match register-match Print the one posting whose transaction description is closest to DESC, - in the style of the register command. If there are multiple equally - good matches, it shows the most recent. Query options (options, not - arguments) can be used to restrict the search space. Helps ledger-au- + 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. rewrite rewrite Print all transactions, rewriting the postings of matched transactions. - For now the only rewrite available is adding new postings, like print + For now the only rewrite available is adding new postings, like print --auto. This is a start at a generic rewriter of transaction entries. It reads - the default journal and prints the transactions, like print, but adds + the default journal and prints the transactions, like print, but adds one or more specified postings to any transactions matching QUERY. The - posting amounts can be fixed, or a multiplier of the existing transac- + posting amounts can be fixed, or a multiplier of the existing transac- tion's first posting amount. Examples: @@ -3178,7 +3222,7 @@ COMMANDS (reserve:grocery) *0.25 ; reserve 25% for grocery (reserve:) *0.25 ; reserve 25% for grocery - Note the single quotes to protect the dollar sign from bash, and the + Note the single quotes to protect the dollar sign from bash, and the two spaces between account and amount. More: @@ -3188,16 +3232,16 @@ COMMANDS $ hledger rewrite -- expenses:gifts --add-posting '(budget:gifts) *-1"' $ hledger rewrite -- ^income --add-posting '(budget:foreign currency) *0.25 JPY; diversify' - Argument for --add-posting option is a usual posting of transaction - with an exception for amount specification. More precisely, you can + Argument for --add-posting option is a usual posting of transaction + with an exception for amount specification. More precisely, you can use '*' (star symbol) before the amount to indicate that that this is a - factor for an amount of original matched posting. If the amount in- + factor for an amount of original matched posting. If the amount in- cludes a commodity name, the new posting amount will be in the new com- - modity; otherwise, it will be in the matched posting amount's commod- + modity; otherwise, it will be in the matched posting amount's commod- ity. Re-write rules in a file - During the run this tool will execute so called "Automated Transac- + During the run this tool will execute so called "Automated Transac- tions" found in any journal it process. I.e instead of specifying this operations in command line you can put them in a journal file. @@ -3212,7 +3256,7 @@ COMMANDS budget:gifts *-1 assets:budget *1 - Note that '=' (equality symbol) that is used instead of date in trans- + Note that '=' (equality symbol) that is used instead of date in trans- actions you usually write. It indicates the query by which you want to match the posting to add new ones. @@ -3225,12 +3269,12 @@ COMMANDS --add-posting 'assets:budget *1' \ > rewritten-tidy-output.journal - It is important to understand that relative order of such entries in - journal is important. You can re-use result of previously added post- + It is important to understand that relative order of such entries in + journal is important. You can re-use result of previously added post- ings. Diff output format - To use this tool for batch modification of your journal files you may + To use this tool for batch modification of your journal files you may find useful output in form of unified diff. $ hledger rewrite -- --diff -f examples/sample.journal '^income' --add-posting '(liabilities:tax) *.33' @@ -3254,10 +3298,10 @@ COMMANDS If you'll pass this through patch tool you'll get transactions contain- ing the posting that matches your query be updated. Note that multiple - files might be update according to list of input files specified via + files might be update according to list of input files specified via --file options and include directives inside of these files. - Be careful. Whole transaction being re-formatted in a style of output + Be careful. Whole transaction being re-formatted in a style of output from hledger print. See also: @@ -3265,49 +3309,49 @@ COMMANDS https://github.com/simonmichael/hledger/issues/99 rewrite vs. print --auto - This command predates print --auto, and currently does much the same + This command predates print --auto, and currently does much the same thing, but with these differences: - o with multiple files, rewrite lets rules in any file affect all other - files. print --auto uses standard directive scoping; rules affect + o with multiple files, rewrite lets rules in any file affect all other + files. print --auto uses standard directive scoping; rules affect only child files. - o rewrite's query limits which transactions can be rewritten; all are + o rewrite's query limits which transactions can be rewritten; all are printed. print --auto's query limits which transactions are printed. - o rewrite applies rules specified on command line or in the journal. + o rewrite applies rules specified on command line or in the journal. print --auto applies rules specified in the journal. roi roi - Shows the time-weighted (TWR) and money-weighted (IRR) rate of return + Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on your investments. - This command assumes that you have account(s) that hold nothing but + This command assumes that you have account(s) that hold nothing but your investments and whenever you record current appraisal/valuation of these investments you offset unrealized profit and loss into account(s) that, again, hold nothing but unrealized profit and loss. - Any transactions affecting balance of investment account(s) and not - originating from unrealized profit and loss account(s) are assumed to + Any transactions affecting balance of investment account(s) and not + 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- + 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. - This command will compute and display the internalized rate of return - (IRR) and time-weighted rate of return (TWR) for your investments for - the time period requested. Both rates of return are annualized before + This command will compute and display the internalized rate of return + (IRR) and time-weighted rate of return (TWR) for your investments for + the time period requested. Both rates of return are annualized before display, regardless of the length of reporting interval. Note, in some cases this report can fail, for these reasons: - o Error (NotBracketed): No solution for Internal Rate of Return (IRR). - Possible causes: IRR is huge (>1000000%), balance of investment be- + o Error (NotBracketed): No solution for Internal Rate of Return (IRR). + Possible causes: IRR is huge (>1000000%), balance of investment be- comes negative at some point in time. - o Error (SearchFailed): Failed to find solution for Internal Rate of + o Error (SearchFailed): Failed to find solution for Internal Rate of Return (IRR). Either search does not converge to a solution, or con- verges too slowly. @@ -3318,67 +3362,67 @@ COMMANDS More background: - "ROI" stands for "return on investment". Traditionally this was com- - puted as a difference between current value of investment and its ini- + "ROI" stands for "return on investment". Traditionally this was com- + puted as a difference between current value of investment and its ini- tial value, expressed in percentage of the initial value. However, this approach is only practical in simple cases, where invest- - ments receives no in-flows or out-flows of money, and where rate of + ments receives no in-flows or out-flows of money, and where rate of growth is fixed over time. For more complex scenarios you need differ- - ent ways to compute rate of return, and this command implements two of + ent ways to compute rate of return, and this command implements two of them: IRR and TWR. - Internal rate of return, or "IRR" (also called "money-weighted rate of - return") takes into account effects of in-flows and out-flows. + Internal rate of return, or "IRR" (also called "money-weighted rate of + return") takes into account effects of in-flows and out-flows. Naively, if you are withdrawing from your investment, your future gains - would be smaller (in absolute numbers), and will be a smaller percent- - age of your initial investment, and if you are adding to your invest- - ment, you will receive bigger absolute gains (but probably at the same - rate of return). IRR is a way to compute rate of return for each pe- - riod between in-flow or out-flow of money, and then combine them in a + would be smaller (in absolute numbers), and will be a smaller percent- + age of your initial investment, and if you are adding to your invest- + ment, you will receive bigger absolute gains (but probably at the same + rate of return). IRR is a way to compute rate of return for each pe- + riod between in-flow or out-flow of money, and then combine them in a way that gives you an annual rate of return that investment is expected to generate. - As mentioned before, in-flows and out-flows would be any cash that you - personally put in or withdraw, and for the "roi" command, these are - transactions that involve account(s) matching --inv argument and NOT + As mentioned before, in-flows and out-flows would be any cash that you + personally put in or withdraw, and for the "roi" command, these are + transactions that involve account(s) matching --inv argument and NOT involve account(s) matching --pnl argument. - Presumably, you will also record changes in the value of your invest- - ment, and balance them against "profit and loss" (or "unrealized + Presumably, you will also record changes in the value of your invest- + ment, and balance them against "profit and loss" (or "unrealized gains") account. Note that in order for IRR to compute the precise ef- - fect of your in-flows and out-flows on the rate of return, you will - need to record the value of your investement on or close to the days + fect of your in-flows and out-flows on the rate of return, you will + need to record the value of your investement on or close to the days when in- or out-flows occur. - Implementation of IRR in hledger should match the XIRR formula in Ex- + Implementation of IRR in hledger should match the XIRR formula in Ex- cel. - Second way to compute rate of return that roi command implements is + Second way to compute rate of return that roi command implements is called "time-weighted rate of return" or "TWR". Like IRR, it will also - break the history of your investment into periods between in-flows and + break the history of your investment into periods between in-flows and out-flows to compute rate of return per each period and then a compound rate of return. However, internal workings of TWR are quite different. - In technical terms, IRR uses the same approach as computation of net + In technical terms, IRR uses the same approach as computation of net present value, and tries to find a discount rate that makes net present value of all the cash flows of your investment to add up to zero. This - could be hard to wrap your head around, especially if you haven't done + could be hard to wrap your head around, especially if you haven't done discounted cash flow analysis before. - TWR represents your investment as an imaginary "unit fund" where in- - flows/ out-flows lead to buying or selling "units" of your investment + TWR represents your investment as an imaginary "unit fund" where in- + flows/ out-flows lead to buying or selling "units" of your investment and changes in its value change the value of "investment unit". Change - in "unit price" over the reporting period gives you rate of return of + in "unit price" over the reporting period gives you rate of return of your investment. - References: * Explanation of rate of return * Explanation of IRR * Ex- - planation of TWR * Examples of computing IRR and TWR and discussion of + References: * Explanation of rate of return * Explanation of IRR * Ex- + planation of TWR * Examples of computing IRR and TWR and discussion of the limitations of both metrics More examples: - Lets say that we found an investment in Snake Oil that is proising to + Lets say that we found an investment in Snake Oil that is proising to give us 10% annually: 2019-01-01 Investing in Snake Oil @@ -3389,7 +3433,7 @@ COMMANDS investment:snake oil = $110 equity:unrealized gains - For now, basic computation of the rate of return, as well as IRR and + For now, basic computation of the rate of return, as well as IRR and TWR, gives us the expected 10%: $ hledger roi -Y --inv investment --pnl "unrealized" @@ -3399,10 +3443,10 @@ COMMANDS | 1 || 2019-01-01 | 2019-12-31 || 0 | 100 | 110 | 10 || 10.00% | 10.00% | +---++------------+------------++---------------+----------+-------------+-----++--------+--------+ - However, lets say that shorty after investing in the Snake Oil we - started to have second thoughs, so we prompty withdrew $90, leaving - only $10 in. Before Christmas, though, we started to get the "fear of - mission out", so we put the $90 back in. So for most of the year, our + However, lets say that shorty after investing in the Snake Oil we + started to have second thoughs, so we prompty withdrew $90, leaving + only $10 in. Before Christmas, though, we started to get the "fear of + mission out", so we put the $90 back in. So for most of the year, our investment was just $10 dollars, and it gave us just $1 in growth: 2019-01-01 Investing in Snake Oil @@ -3433,10 +3477,10 @@ COMMANDS Here, IRR tells us that we made close to 10% on the $10 dollars that we had in the account most of the time. And TWR is ... just 1%? Why? - Based on the transactions in our journal, TWR "think" that we are buy- - ing back $90 worst of Snake Oil at the same price that it had at the + Based on the transactions in our journal, TWR "think" that we are buy- + ing back $90 worst of Snake Oil at the same price that it had at the beginning of they year, and then after that our $100 investment gets $1 - increase in value, or 1% of $100. Let's take a closer look at what is + increase in value, or 1% of $100. Let's take a closer look at what is happening here by asking for quarterly reports instead of annual: $ hledger roi -Q --inv investment --pnl "unrealized" @@ -3449,10 +3493,10 @@ COMMANDS | 4 || 2019-10-01 | 2019-12-31 || 10 | 90 | 101 | 1 || 37.80% | 4.03% | +---++------------+------------++---------------+----------+-------------+-----++--------+-------+ - Now both IRR and TWR are thrown off by the fact that all of the growth - for our investment happens in Q4 2019. This happes because IRR compu- + Now both IRR and TWR are thrown off by the fact that all of the growth + for our investment happens in Q4 2019. This happes because IRR compu- tation is still yielding 9.32% and TWR is still 1%, but this time these - are rates for three month period instead of twelve, so in order to get + are rates for three month period instead of twelve, so in order to get an annual rate they should be multiplied by four! Let's try to keep a better record of how Snake Oil grew in value: @@ -3497,10 +3541,10 @@ COMMANDS | 4 || 2019-10-01 | 2019-12-31 || 10.75 | 90 | 101.00 | 0.25 || 8.05% | 1.00% | +---++------------+------------++---------------+----------+-------------+------++--------+--------+ - Something is still wrong with TWR computation for Q4, and if you have - been paying attention you know what it is already: big $90 buy-back is - recorded prior to the only transaction that captures the change of - value of Snake Oil that happened in this time period. Lets combine + Something is still wrong with TWR computation for Q4, and if you have + been paying attention you know what it is already: big $90 buy-back is + recorded prior to the only transaction that captures the change of + value of Snake Oil that happened in this time period. Lets combine transactions from 30th and 31st of Dec into one: 2019-12-30 Fear of missing out and growth of Snake Oil @@ -3521,7 +3565,7 @@ COMMANDS | 4 || 2019-10-01 | 2019-12-31 || 10.75 | 90 | 101.00 | 0.25 || 8.05% | 9.57% | +---++------------+------------++---------------+----------+-------------+------++--------+--------+ - And for annual report, TWR now reports the exact profitability of our + And for annual report, TWR now reports the exact profitability of our investment: $ hledger roi -Y --inv investment --pnl "unrealized" @@ -3535,8 +3579,8 @@ COMMANDS stats Show some journal statistics. - The stats command displays summary information for the whole journal, - or a matched part of it. With a reporting interval, it shows a report + The stats command displays summary information for the whole journal, + or a matched part of it. With a reporting interval, it shows a report for each report period. Example: @@ -3554,35 +3598,35 @@ COMMANDS Commodities : 1 ($) Market prices : 12 ($) - This command also supports output destination and output format selec- + This command also supports output destination and output format selec- tion. tags tags - List the unique tag names used in the journal. With a TAGREGEX argu- + List the unique tag names used in the journal. With a TAGREGEX argu- ment, only tag names matching the regular expression (case insensitive) - are shown. With QUERY arguments, only transactions matching the query + are shown. With QUERY arguments, only transactions matching the query are considered. With the --values flag, the tags' unique values are listed instead. - With --parsed flag, all tags or values are shown in the order they are + With --parsed flag, all tags or values are shown in the order they are parsed from the input data, including duplicates. - With -E/--empty, any blank/empty values will also be shown, otherwise + With -E/--empty, any blank/empty values will also be shown, otherwise they are omitted. test test Run built-in unit tests. - This command runs the unit tests built in to hledger and hledger-lib, - printing the results on stdout. If any test fails, the exit code will + This command runs the unit tests built in to hledger and hledger-lib, + printing the results on stdout. If any test fails, the exit code will be non-zero. - This is mainly used by hledger developers, but you can also use it to - sanity-check the installed hledger executable on your platform. All - tests are expected to pass - if you ever see a failure, please report + This is mainly used by hledger developers, but you can also use it to + sanity-check the installed hledger executable on your platform. All + tests are expected to pass - if you ever see a failure, please report as a bug! This command also accepts tasty test runner options, written after a -- @@ -3591,35 +3635,35 @@ COMMANDS $ hledger test -- -pData.Amount --color=never - For help on these, see https://github.com/feuerbach/tasty#options (-- + For help on these, see https://github.com/feuerbach/tasty#options (-- --help currently doesn't show them). Add-on commands - hledger also searches for external add-on commands, and will include + hledger also searches for external add-on commands, and will include these in the commands list. These are programs or scripts in your PATH - whose name starts with hledger- and ends with a recognised file exten- + whose name starts with hledger- and ends with a recognised file exten- sion (currently: no extension, bat,com,exe, hs,lhs,pl,py,rb,rkt,sh). - Add-ons can be invoked like any hledger command, but there are a few + Add-ons can be invoked like any hledger command, but there are a few things to be aware of. Eg if the hledger-web add-on is installed, - o hledger -h web shows hledger's help, while hledger web -h shows + o hledger -h web shows hledger's help, while hledger web -h shows hledger-web's help. - o Flags specific to the add-on must have a preceding -- to hide them - from hledger. So hledger web --serve --port 9000 will be rejected; + o Flags specific to the add-on must have a preceding -- to hide them + from hledger. So hledger web --serve --port 9000 will be rejected; you must use hledger web -- --serve --port 9000. o You can always run add-ons directly if preferred: hledger-web --serve --port 9000. - Add-ons are a relatively easy way to add local features or experiment - with new ideas. They can be written in any language, but haskell - scripts have a big advantage: they can use the same hledger (and - haskell) library functions that built-in commands do, for command-line + Add-ons are a relatively easy way to add local features or experiment + with new ideas. They can be written in any language, but haskell + scripts have a big advantage: they can use the same hledger (and + haskell) library functions that built-in commands do, for command-line options, journal parsing, reporting, etc. - Two important add-ons are the hledger-ui and hledger-web user inter- + Two important add-ons are the hledger-ui and hledger-web user inter- faces. These are maintained and released along with hledger: ui @@ -3638,20 +3682,20 @@ COMMANDS hledger-interest generates interest transactions for an account accord- ing to various schemes. - A few more experimental or old add-ons can be found in hledger's bin/ + A few more experimental or old add-ons can be found in hledger's bin/ directory. These are typically prototypes and not guaranteed to work. ENVIRONMENT 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). - A typical value is ~/DIR/YYYY.journal, where DIR is a version-con- - trolled finance directory and YYYY is the current year. Or ~/DIR/cur- + A typical value is ~/DIR/YYYY.journal, where DIR is a version-con- + trolled finance directory and YYYY is the current year. Or ~/DIR/cur- rent.journal, where current.journal is a symbolic link to YYYY.journal. On Mac computers, you can set this and other environment variables in a - more thorough way that also affects applications started from the GUI + more thorough way that also affects applications started from the GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a ~/.MacOSX/en- vironment.plist file containing @@ -3661,21 +3705,21 @@ ENVIRONMENT To see the effect you may need to killall Dock, or reboot. - 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. - NO_COLOR If this variable exists with any value, hledger will not use - ANSI color codes in terminal output. This overrides the + NO_COLOR If this variable exists with any value, hledger will not use + ANSI color codes in terminal output. This overrides the --color/--colour option. 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 @@ -3691,36 +3735,36 @@ LIMITATIONS In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger add. - Not all of Ledger's journal file syntax is supported. See 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 re- + member you can also seek help from the IRC channel, mail list or bug tracker): Successfully installed, but "No command 'hledger' found" stack and cabal install binaries into a special directory, which should - be added to your PATH environment variable. Eg on unix-like systems, + be added to your PATH environment variable. Eg on unix-like systems, that is ~/.local/bin and ~/.cabal/bin respectively. I set a custom LEDGER_FILE, but hledger is still using the default file - LEDGER_FILE should be a real environment variable, not just a shell - variable. The command env | grep LEDGER_FILE should show it. You may + LEDGER_FILE should be a real environment variable, not just a shell + variable. The command env | grep LEDGER_FILE should show it. You may need to use export. Here's an explanation. - Getting errors like "Illegal byte sequence" or "Invalid or incomplete - multibyte or wide character" or "commitAndReleaseBuffer: invalid argu- + Getting errors like "Illegal byte sequence" or "Invalid or incomplete + multibyte or wide character" or "commitAndReleaseBuffer: invalid argu- ment (invalid character)" Programs compiled with GHC (hledger, haskell build tools, etc.) need to have a UTF-8-aware locale configured in the environment, otherwise they - will fail with these kinds of errors when they encounter non-ascii + will fail with these kinds of errors when they encounter non-ascii characters. - To fix it, set the LANG environment variable to some locale which sup- + To fix it, set the LANG environment variable to some locale which sup- ports UTF-8. The locale you choose must be installed on your system. Here's an example of setting LANG temporarily, on Ubuntu GNU/Linux: @@ -3735,8 +3779,8 @@ TROUBLESHOOTING POSIX $ LANG=en_US.utf8 hledger -f my.journal print # ensure it is used for this command - If available, C.UTF-8 will also work. If your preferred locale isn't - listed by locale -a, you might need to install it. Eg on Ubuntu/De- + If available, C.UTF-8 will also work. If your preferred locale isn't + listed by locale -a, you might need to install it. Eg on Ubuntu/De- bian: $ apt-get install language-pack-fr @@ -3756,8 +3800,8 @@ TROUBLESHOOTING $ echo "export LANG=en_US.utf8" >>~/.bash_profile $ bash --login - Exact spelling and capitalisation may be important. Note the differ- - ence on MacOS (UTF-8, not utf8). Some platforms (eg ubuntu) allow + Exact spelling and capitalisation may be important. Note the differ- + ence on MacOS (UTF-8, not utf8). Some platforms (eg ubuntu) allow variant spellings, but others (eg macos) require it to be exact: $ locale -a | grep -iE en_us.*utf @@ -3767,7 +3811,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) @@ -3781,7 +3825,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)