From 202d2e945be3cd3f10e5daf1afab86f79eacc15e Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 7 Feb 2020 12:14:08 -0800 Subject: [PATCH] ;doc: regen manuals [ci skip] --- hledger/hledger.1 | 178 +++---- hledger/hledger.info | 600 +++++++++++------------ hledger/hledger.txt | 1078 +++++++++++++++++++++--------------------- 3 files changed, 937 insertions(+), 919 deletions(-) diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 7be594adb..6dbe382f6 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -74,7 +74,7 @@ Here are some quick examples of how to do some basic tasks with hledger. For more details, see the reference section below, the hledger_journal(5) manual, or the more extensive docs at https://hledger.org. -.SS Get help +.SS Getting help .IP .nf \f[C] @@ -90,6 +90,26 @@ $ hledger help --help # show more detailed help for the help command .PP Find more docs, chat, mail list, reddit, issue tracker: https://hledger.org#help-feedback +.SS Constructing a command line +.PP +hledger has an extensive and powerful command line interface. +We strive to keep it simple and ergonomic, but you may run into one of +the confusing real world details described in OPTIONS, below. +If that happens, here are some tips that may help: +.IP \[bu] 2 +command-specific options must go after the command (it\[aq]s fine to put +all options there) (\f[C]hledger CMD OPTS ARGS\f[R]) +.IP \[bu] 2 +running add-on executables directly simplifies command line parsing +(\f[C]hledger-ui OPTS ARGS\f[R]) +.IP \[bu] 2 +enclose \[dq]problematic\[dq] args in single quotes +.IP \[bu] 2 +if needed, also add a backslash to hide regular expression +metacharacters from the shell +.IP \[bu] 2 +to see how a misbehaving command is being parsed, add +\f[C]--debug=2\f[R]. .SS Starting a Journal .PP hledger looks for your accounting data in a journal file, @@ -873,20 +893,6 @@ And backslashes may work better than quotes. Eg: .PP \f[C]ghci> :main balance cur:\[rs]$\f[R] -.SS Command line tips -.PP -If in doubt, keep things simple: -.IP \[bu] 2 -write options after the command (\f[C]hledger CMD -OPTIONS ARGS\f[R]) -.IP \[bu] 2 -run add-on executables directly (\f[C]hledger-ui -OPTIONS ARGS\f[R]) -.IP \[bu] 2 -enclose problematic args in single quotes -.IP \[bu] 2 -if needed, also add a backslash to escape regexp metacharacters -.PP -To find out exactly how a command line is being parsed, add -\f[C]--debug=2\f[R] to troubleshoot. .SS Unicode characters .PP hledger is expected to handle non-ascii characters correctly: @@ -1025,6 +1031,77 @@ balance assertions will not see any account balances from previous files .PP If you need those, either use the include directive, or concatenate the files, eg: \f[C]cat a.journal b.journal | hledger -f- CMD\f[R]. +.SS Output destination +.PP +Some commands (print, register, stats, the balance commands) can write +their output to a destination other than the console. +This is controlled by the \f[C]-o/--output-file\f[R] option. +.IP +.nf +\f[C] +$ hledger balance -o - # write to stdout (the default) +$ hledger balance -o FILE # write to FILE +\f[R] +.fi +.SS Output format +.PP +Some commands can write their output in other formats. +Eg print and register can output CSV, and the balance commands can +output CSV or HTML. +This is controlled by the \f[C]-O/--output-format\f[R] option, or by +specifying a \f[C].csv\f[R] or \f[C].html\f[R] file extension with +\f[C]-o/--output-file\f[R]. +.IP +.nf +\f[C] +$ hledger balance -O csv # write CSV to stdout +$ hledger balance -o FILE.csv # write CSV to FILE.csv +\f[R] +.fi +.SS Regular expressions +.PP +hledger uses regular expressions in a number of places: +.IP \[bu] 2 +query terms, on the command line and in the hledger-web search form: +\f[C]REGEX\f[R], \f[C]desc:REGEX\f[R], \f[C]cur:REGEX\f[R], +\f[C]tag:...=REGEX\f[R] +.IP \[bu] 2 +CSV rules conditional blocks: \f[C]if REGEX ...\f[R] +.IP \[bu] 2 +account alias directives and options: +\f[C]alias /REGEX/ = REPLACEMENT\f[R], +\f[C]--alias /REGEX/=REPLACEMENT\f[R] +.PP +hledger\[aq]s regular expressions come from the regex-tdfa library. +In general they: +.IP \[bu] 2 +are case insensitive +.IP \[bu] 2 +are infix matching (do not need to match the entire thing being matched) +.IP \[bu] 2 +are POSIX extended regular expressions +.IP \[bu] 2 +also support GNU word boundaries (\[rs]<, \[rs]>, \[rs]b, \[rs]B) +.IP \[bu] 2 +and parenthesised capturing groups and numeric backreferences in +replacement strings +.IP \[bu] 2 +do not support mode modifiers like (?s) +.PP +Some things to note: +.IP \[bu] 2 +In the \f[C]alias\f[R] directive and \f[C]--alias\f[R] option, regular +expressions must be enclosed in forward slashes (\f[C]/REGEX/\f[R]). +Elsewhere in hledger, these are not required. +.IP \[bu] 2 +In queries, to match a regular expression metacharacter like \f[C]$\f[R] +as a literal character, prepend a backslash. +Eg to search for amounts with the dollar sign in hledger-web, write +\f[C]cur:\[rs]$\f[R]. +.IP \[bu] 2 +On the command line, some metacharacters like \f[C]$\f[R] have a special +meaning to the shell and so must be escaped at least once more. +See Special characters. .SS Smart dates .PP hledger\[aq]s user interfaces accept a flexible \[dq]smart date\[dq] @@ -2047,77 +2124,6 @@ report\[aq]s multi-period mode (whether showing one or many subperiods). .SS Combining -B, -V, -X, --value .PP The rightmost of these flags wins. -.SS Output destination -.PP -Some commands (print, register, stats, the balance commands) can write -their output to a destination other than the console. -This is controlled by the \f[C]-o/--output-file\f[R] option. -.IP -.nf -\f[C] -$ hledger balance -o - # write to stdout (the default) -$ hledger balance -o FILE # write to FILE -\f[R] -.fi -.SS Output format -.PP -Some commands can write their output in other formats. -Eg print and register can output CSV, and the balance commands can -output CSV or HTML. -This is controlled by the \f[C]-O/--output-format\f[R] option, or by -specifying a \f[C].csv\f[R] or \f[C].html\f[R] file extension with -\f[C]-o/--output-file\f[R]. -.IP -.nf -\f[C] -$ hledger balance -O csv # write CSV to stdout -$ hledger balance -o FILE.csv # write CSV to FILE.csv -\f[R] -.fi -.SS Regular expressions -.PP -hledger uses regular expressions in a number of places: -.IP \[bu] 2 -query terms, on the command line and in the hledger-web search form: -\f[C]REGEX\f[R], \f[C]desc:REGEX\f[R], \f[C]cur:REGEX\f[R], -\f[C]tag:...=REGEX\f[R] -.IP \[bu] 2 -CSV rules conditional blocks: \f[C]if REGEX ...\f[R] -.IP \[bu] 2 -account alias directives and options: -\f[C]alias /REGEX/ = REPLACEMENT\f[R], -\f[C]--alias /REGEX/=REPLACEMENT\f[R] -.PP -hledger\[aq]s regular expressions come from the regex-tdfa library. -In general they: -.IP \[bu] 2 -are case insensitive -.IP \[bu] 2 -are infix matching (do not need to match the entire thing being matched) -.IP \[bu] 2 -are POSIX extended regular expressions -.IP \[bu] 2 -also support GNU word boundaries (\[rs]<, \[rs]>, \[rs]b, \[rs]B) -.IP \[bu] 2 -and parenthesised capturing groups and numeric backreferences in -replacement strings -.IP \[bu] 2 -do not support mode modifiers like (?s) -.PP -Some things to note: -.IP \[bu] 2 -In the \f[C]alias\f[R] directive and \f[C]--alias\f[R] option, regular -expressions must be enclosed in forward slashes (\f[C]/REGEX/\f[R]). -Elsewhere in hledger, these are not required. -.IP \[bu] 2 -In queries, to match a regular expression metacharacter like \f[C]$\f[R] -as a literal character, prepend a backslash. -Eg to search for amounts with the dollar sign in hledger-web, write -\f[C]cur:\[rs]$\f[R]. -.IP \[bu] 2 -On the command line, some metacharacters like \f[C]$\f[R] have a special -meaning to the shell and so must be escaped at least once more. -See Special characters. .SH COMMANDS .PP hledger provides a number of subcommands; \f[C]hledger\f[R] with no diff --git a/hledger/hledger.info b/hledger/hledger.info index 0ccbce082..6dfa66640 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -75,7 +75,8 @@ https://hledger.org. * Menu: -* Get help:: +* Getting help:: +* Constructing a command line:: * Starting a Journal:: * Setting Opening Balances:: * Recording Transactions:: @@ -84,10 +85,10 @@ https://hledger.org. * Starting a New File::  -File: hledger.info, Node: Get help, Next: Starting a Journal, Up: COMMON TASKS +File: hledger.info, Node: Getting help, Next: Constructing a command line, Up: COMMON TASKS -1.1 Get help -============ +1.1 Getting help +================ $ hledger # show available commands $ hledger --help # show common options @@ -101,9 +102,29 @@ $ hledger help --help # show more detailed help for the help command https://hledger.org#help-feedback  -File: hledger.info, Node: Starting a Journal, Next: Setting Opening Balances, Prev: Get help, Up: COMMON TASKS +File: hledger.info, Node: Constructing a command line, Next: Starting a Journal, Prev: Getting help, Up: COMMON TASKS -1.2 Starting a Journal +1.2 Constructing a command line +=============================== + +hledger has an extensive and powerful command line interface. We strive +to keep it simple and ergonomic, but you may run into one of the +confusing real world details described in OPTIONS, below. If that +happens, here are some tips that may help: + + * command-specific options must go after the command (it's fine to + put all options there) ('hledger CMD OPTS ARGS') + * running add-on executables directly simplifies command line parsing + ('hledger-ui OPTS ARGS') + * enclose "problematic" args in single quotes + * if needed, also add a backslash to hide regular expression + metacharacters from the shell + * to see how a misbehaving command is being parsed, add '--debug=2'. + + +File: hledger.info, Node: Starting a Journal, Next: Setting Opening Balances, Prev: Constructing a command line, Up: COMMON TASKS + +1.3 Starting a Journal ====================== hledger looks for your accounting data in a journal file, @@ -142,7 +163,7 @@ Market prices : 0 ()  File: hledger.info, Node: Setting Opening Balances, Next: Recording Transactions, Prev: Starting a Journal, Up: COMMON TASKS -1.3 Setting Opening Balances +1.4 Setting Opening Balances ============================ Pick a starting date for which you can look up the balances of some @@ -225,7 +246,7 @@ $ git commit -am 'initial balances' 2020.journal  File: hledger.info, Node: Recording Transactions, Next: Reconciling, Prev: Setting Opening Balances, Up: COMMON TASKS -1.4 Recording Transactions +1.5 Recording Transactions ========================== As you spend or receive money, you can record these transactions using @@ -251,7 +272,7 @@ and hledger.org for more ideas:  File: hledger.info, Node: Reconciling, Next: Reporting, Prev: Recording Transactions, Up: COMMON TASKS -1.5 Reconciling +1.6 Reconciling =============== Periodically you should reconcile - compare your hledger-reported @@ -306,7 +327,7 @@ $ git commit -am 'txns' 2020.journal  File: hledger.info, Node: Reporting, Next: Starting a New File, Prev: Reconciling, Up: COMMON TASKS -1.6 Reporting +1.7 Reporting ============= Here are some basic reports. @@ -454,7 +475,7 @@ $ hledger activity -W  File: hledger.info, Node: Starting a New File, Prev: Reporting, Up: COMMON TASKS -1.7 Starting a New File +1.8 Starting a New File ======================= At the end of the year, you may want to continue your journal in a new @@ -475,9 +496,11 @@ File: hledger.info, Node: OPTIONS, Next: COMMANDS, Prev: COMMON TASKS, Up: T * Command arguments:: * Queries:: * Special characters in arguments and queries:: -* Command line tips:: * Unicode characters:: * Input files:: +* Output destination:: +* Output format:: +* Regular expressions:: * Smart dates:: * Report start & end date:: * Report intervals:: @@ -485,9 +508,6 @@ File: hledger.info, Node: OPTIONS, Next: COMMANDS, Prev: COMMON TASKS, Up: T * Depth limiting:: * Pivoting:: * Valuation:: -* Output destination:: -* Output format:: -* Regular expressions::  File: hledger.info, Node: General options, Next: Command options, Up: OPTIONS @@ -773,7 +793,7 @@ and query arguments, and the resulting query will be their intersection (perhaps excluding the '-p/--period' option).  -File: hledger.info, Node: Special characters in arguments and queries, Next: Command line tips, Prev: Queries, Up: OPTIONS +File: hledger.info, Node: Special characters in arguments and queries, Next: Unicode characters, Prev: Queries, Up: OPTIONS 2.5 Special characters in arguments and queries =============================================== @@ -856,25 +876,9 @@ Eg: 'ghci> :main balance cur:\$'  -File: hledger.info, Node: Command line tips, Next: Unicode characters, Prev: Special characters in arguments and queries, Up: OPTIONS +File: hledger.info, Node: Unicode characters, Next: Input files, Prev: Special characters in arguments and queries, Up: OPTIONS -2.6 Command line tips -===================== - -If in doubt, keep things simple: - - * write options after the command ('hledger CMD -OPTIONS ARGS') - * run add-on executables directly ('hledger-ui -OPTIONS ARGS') - * enclose problematic args in single quotes - * if needed, also add a backslash to escape regexp metacharacters - - To find out exactly how a command line is being parsed, add -'--debug=2' to troubleshoot. - - -File: hledger.info, Node: Unicode characters, Next: Input files, Prev: Command line tips, Up: OPTIONS - -2.7 Unicode characters +2.6 Unicode characters ====================== hledger is expected to handle non-ascii characters correctly: @@ -911,9 +915,9 @@ hledger is expected to handle non-ascii characters correctly: terminal, and vice versa. (See eg #961).  -File: hledger.info, Node: Input files, Next: Smart dates, Prev: Unicode characters, Up: OPTIONS +File: hledger.info, Node: Input files, Next: Output destination, Prev: Unicode characters, Up: OPTIONS -2.8 Input files +2.7 Input files =============== hledger reads transactions from a data file (and the add command writes @@ -966,10 +970,77 @@ one big journal. There are some limitations with this: the files, eg: 'cat a.journal b.journal | hledger -f- CMD'.  -File: hledger.info, Node: Smart dates, Next: Report start & end date, Prev: Input files, Up: OPTIONS +File: hledger.info, Node: Output destination, Next: Output format, Prev: Input files, Up: OPTIONS -2.9 Smart dates -=============== +2.8 Output destination +====================== + +Some commands (print, register, stats, the balance commands) can write +their output to a destination other than the console. This is +controlled by the '-o/--output-file' option. + +$ hledger balance -o - # write to stdout (the default) +$ hledger balance -o FILE # write to FILE + + +File: hledger.info, Node: Output format, Next: Regular expressions, Prev: Output destination, Up: OPTIONS + +2.9 Output format +================= + +Some commands can write their output in other formats. Eg print and +register can output CSV, and the balance commands can output CSV or +HTML. This is controlled by the '-O/--output-format' option, or by +specifying a '.csv' or '.html' file extension with '-o/--output-file'. + +$ hledger balance -O csv # write CSV to stdout +$ hledger balance -o FILE.csv # write CSV to FILE.csv + + +File: hledger.info, Node: Regular expressions, Next: Smart dates, Prev: Output format, Up: OPTIONS + +2.10 Regular expressions +======================== + +hledger uses regular expressions in a number of places: + + * query terms, on the command line and in the hledger-web search + form: 'REGEX', 'desc:REGEX', 'cur:REGEX', 'tag:...=REGEX' + * CSV rules conditional blocks: 'if REGEX ...' + * account alias directives and options: 'alias /REGEX/ = + REPLACEMENT', '--alias /REGEX/=REPLACEMENT' + + hledger's regular expressions come from the regex-tdfa library. In +general they: + + * are case insensitive + * are infix matching (do not need to match the entire thing being + matched) + * are POSIX extended regular expressions + * also support GNU word boundaries (\<, \>, \b, \B) + * and parenthesised capturing groups and numeric backreferences in + replacement strings + * do not support mode modifiers like (?s) + + Some things to note: + + * In the 'alias' directive and '--alias' option, regular expressions + must be enclosed in forward slashes ('/REGEX/'). Elsewhere in + hledger, these are not required. + + * In queries, to match a regular expression metacharacter like '$' as + a literal character, prepend a backslash. Eg to search for amounts + with the dollar sign in hledger-web, write 'cur:\$'. + + * On the command line, some metacharacters like '$' have a special + meaning to the shell and so must be escaped at least once more. + See Special characters. + + +File: hledger.info, Node: Smart dates, Next: Report start & end date, Prev: Regular expressions, Up: OPTIONS + +2.11 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 @@ -1001,7 +1072,7 @@ results:  File: hledger.info, Node: Report start & end date, Next: Report intervals, Prev: Smart dates, Up: OPTIONS -2.10 Report start & end date +2.12 Report start & end date ============================ Most hledger reports show the full span of time represented by the @@ -1039,7 +1110,7 @@ these accept the smart date syntax.  File: hledger.info, Node: Report intervals, Next: Period expressions, Prev: Report start & end date, Up: OPTIONS -2.11 Report intervals +2.13 Report intervals ===================== A report interval can be specified so that commands like register, @@ -1052,7 +1123,7 @@ intervals can not be specified with a query.  File: hledger.info, Node: Period expressions, Next: Depth limiting, Prev: Report intervals, Up: OPTIONS -2.12 Period expressions +2.14 Period expressions ======================= The '-p/--period' option accepts period expressions, a shorthand way of @@ -1160,7 +1231,7 @@ start date and exclusive end date):  File: hledger.info, Node: Depth limiting, Next: Pivoting, Prev: Period expressions, Up: OPTIONS -2.13 Depth limiting +2.15 Depth limiting =================== With the '--depth N' option (short form: '-N'), commands like account, @@ -1172,7 +1243,7 @@ less detail. This flag has the same effect as a 'depth:' query argument  File: hledger.info, Node: Pivoting, Next: Valuation, Prev: Depth limiting, Up: OPTIONS -2.14 Pivoting +2.16 Pivoting ============= Normally hledger sums amounts, and organizes them in a hierarchy, based @@ -1227,9 +1298,9 @@ $ hledger balance --pivot member acct:. -2 EUR  -File: hledger.info, Node: Valuation, Next: Output destination, Prev: Pivoting, Up: OPTIONS +File: hledger.info, Node: Valuation, Prev: Pivoting, Up: OPTIONS -2.15 Valuation +2.17 Valuation ============== * Menu: @@ -1244,7 +1315,7 @@ File: hledger.info, Node: Valuation, Next: Output destination, Prev: Pivoting  File: hledger.info, Node: -B Cost, Next: -V Market value, Up: Valuation -2.15.1 -B: Cost +2.17.1 -B: Cost --------------- The '-B/--cost' flag converts amounts to their cost (or selling price) @@ -1254,7 +1325,7 @@ flag is equivalent to '--value=cost', described below.  File: hledger.info, Node: -V Market value, Next: -X Market value in specified commodity, Prev: -B Cost, Up: Valuation -2.15.2 -V: Market value +2.17.2 -V: Market value ----------------------- The '-V/--market' flag converts reported amounts to their market value @@ -1304,7 +1375,7 @@ $ hledger -f t.j bal -N euros -V  File: hledger.info, Node: -X Market value in specified commodity, Next: --value Flexible valuation, Prev: -V Market value, Up: Valuation -2.15.3 -X: Market value in specified commodity +2.17.3 -X: Market value in specified commodity ---------------------------------------------- The '-X/--exchange' option is like '-V', except it specifies the target @@ -1314,7 +1385,7 @@ commodity you would like to convert to. It is equivalent to  File: hledger.info, Node: --value Flexible valuation, Next: Effect of --value on reports, Prev: -X Market value in specified commodity, Up: Valuation -2.15.4 -value: Flexible valuation +2.17.4 -value: Flexible valuation --------------------------------- _(experimental, added 201905)_ @@ -1480,7 +1551,7 @@ $ hledger print -X A  File: hledger.info, Node: Effect of --value on reports, Next: Combining -B -V -X --value, Prev: --value Flexible valuation, Up: Valuation -2.15.5 Effect of -value on reports +2.17.5 Effect of -value on reports ---------------------------------- Here is a reference for how '--value' currently affects each part of @@ -1587,78 +1658,11 @@ _report interval_  File: hledger.info, Node: Combining -B -V -X --value, Prev: Effect of --value on reports, Up: Valuation -2.15.6 Combining -B, -V, -X, -value +2.17.6 Combining -B, -V, -X, -value ----------------------------------- The rightmost of these flags wins. - -File: hledger.info, Node: Output destination, Next: Output format, Prev: Valuation, Up: OPTIONS - -2.16 Output destination -======================= - -Some commands (print, register, stats, the balance commands) can write -their output to a destination other than the console. This is -controlled by the '-o/--output-file' option. - -$ hledger balance -o - # write to stdout (the default) -$ hledger balance -o FILE # write to FILE - - -File: hledger.info, Node: Output format, Next: Regular expressions, Prev: Output destination, Up: OPTIONS - -2.17 Output format -================== - -Some commands can write their output in other formats. Eg print and -register can output CSV, and the balance commands can output CSV or -HTML. This is controlled by the '-O/--output-format' option, or by -specifying a '.csv' or '.html' file extension with '-o/--output-file'. - -$ hledger balance -O csv # write CSV to stdout -$ hledger balance -o FILE.csv # write CSV to FILE.csv - - -File: hledger.info, Node: Regular expressions, Prev: Output format, Up: OPTIONS - -2.18 Regular expressions -======================== - -hledger uses regular expressions in a number of places: - - * query terms, on the command line and in the hledger-web search - form: 'REGEX', 'desc:REGEX', 'cur:REGEX', 'tag:...=REGEX' - * CSV rules conditional blocks: 'if REGEX ...' - * account alias directives and options: 'alias /REGEX/ = - REPLACEMENT', '--alias /REGEX/=REPLACEMENT' - - hledger's regular expressions come from the regex-tdfa library. In -general they: - - * are case insensitive - * are infix matching (do not need to match the entire thing being - matched) - * are POSIX extended regular expressions - * also support GNU word boundaries (\<, \>, \b, \B) - * and parenthesised capturing groups and numeric backreferences in - replacement strings - * do not support mode modifiers like (?s) - - Some things to note: - - * In the 'alias' directive and '--alias' option, regular expressions - must be enclosed in forward slashes ('/REGEX/'). Elsewhere in - hledger, these are not required. - - * In queries, to match a regular expression metacharacter like '$' as - a literal character, prepend a backslash. Eg to search for amounts - with the dollar sign in hledger-web, write 'cur:\$'. - - * On the command line, some metacharacters like '$' have a special - meaning to the shell and so must be escaped at least once more. - See Special characters. -  File: hledger.info, Node: COMMANDS, Next: ENVIRONMENT, Prev: OPTIONS, Up: Top @@ -3644,185 +3648,185 @@ Tag Table: Node: Top68 Node: COMMON TASKS2321 Ref: #common-tasks2433 -Node: Get help2796 -Ref: #get-help2908 -Node: Starting a Journal3461 -Ref: #starting-a-journal3626 -Node: Setting Opening Balances4814 -Ref: #setting-opening-balances5005 -Node: Recording Transactions8148 -Ref: #recording-transactions8328 -Node: Reconciling8884 -Ref: #reconciling9027 -Node: Reporting11285 -Ref: #reporting11421 -Node: Starting a New File15420 -Ref: #starting-a-new-file15556 -Node: OPTIONS15785 -Ref: #options15892 -Node: General options16284 -Ref: #general-options16409 -Node: Command options19108 -Ref: #command-options19259 -Node: Command arguments19657 -Ref: #command-arguments19804 -Node: Queries20684 -Ref: #queries20839 -Node: Special characters in arguments and queries24801 -Ref: #special-characters-in-arguments-and-queries25028 -Node: More escaping25479 -Ref: #more-escaping25641 -Node: Even more escaping25937 -Ref: #even-more-escaping26131 -Node: Less escaping26802 -Ref: #less-escaping26964 -Node: Command line tips27209 -Ref: #command-line-tips27395 -Node: Unicode characters27772 -Ref: #unicode-characters27928 -Node: Input files29340 -Ref: #input-files29476 -Node: Smart dates31405 -Ref: #smart-dates31546 -Node: Report start & end date32952 -Ref: #report-start-end-date33124 -Node: Report intervals34548 -Ref: #report-intervals34713 -Node: Period expressions35103 -Ref: #period-expressions35263 -Node: Depth limiting39218 -Ref: #depth-limiting39362 -Node: Pivoting39704 -Ref: #pivoting39827 -Node: Valuation41503 -Ref: #valuation41632 -Node: -B Cost41812 -Ref: #b-cost41923 -Node: -V Market value42121 -Ref: #v-market-value42295 -Node: -X Market value in specified commodity43727 -Ref: #x-market-value-in-specified-commodity43966 -Node: --value Flexible valuation44142 -Ref: #value-flexible-valuation44368 -Node: Effect of --value on reports48558 -Ref: #effect-of---value-on-reports48774 -Node: Combining -B -V -X --value53705 -Ref: #combining--b--v--x---value53888 -Node: Output destination53924 -Ref: #output-destination54076 -Node: Output format54359 -Ref: #output-format54511 -Node: Regular expressions54896 -Ref: #regular-expressions55033 -Node: COMMANDS56394 -Ref: #commands56502 -Node: accounts57586 -Ref: #accounts57684 -Node: activity58383 -Ref: #activity58493 -Node: add58876 -Ref: #add58975 -Node: balance61714 -Ref: #balance61825 -Node: Classic balance report63283 -Ref: #classic-balance-report63456 -Node: Customising the classic balance report64825 -Ref: #customising-the-classic-balance-report65053 -Node: Colour support67129 -Ref: #colour-support67296 -Node: Flat mode67469 -Ref: #flat-mode67617 -Node: Depth limited balance reports68030 -Ref: #depth-limited-balance-reports68215 -Node: Percentages68671 -Ref: #percentages68837 -Node: Multicolumn balance report69974 -Ref: #multicolumn-balance-report70154 -Node: Budget report75468 -Ref: #budget-report75611 -Node: Nested budgets80813 -Ref: #nested-budgets80925 -Ref: #output-format-184406 -Node: balancesheet84484 -Ref: #balancesheet84620 -Node: balancesheetequity86003 -Ref: #balancesheetequity86152 -Node: cashflow86713 -Ref: #cashflow86841 -Node: check-dates87937 -Ref: #check-dates88064 -Node: check-dupes88343 -Ref: #check-dupes88467 -Node: close88760 -Ref: #close88874 -Node: close usage90396 -Ref: #close-usage90489 -Node: commodities93302 -Ref: #commodities93429 -Node: descriptions93511 -Ref: #descriptions93639 -Node: diff93820 -Ref: #diff93926 -Node: files94973 -Ref: #files95073 -Node: help95220 -Ref: #help95320 -Node: import96401 -Ref: #import96515 -Node: Importing balance assignments97408 -Ref: #importing-balance-assignments97556 -Node: incomestatement98205 -Ref: #incomestatement98338 -Node: notes99742 -Ref: #notes99855 -Node: payees99981 -Ref: #payees100087 -Node: prices100245 -Ref: #prices100351 -Node: print100692 -Ref: #print100802 -Node: print-unique105446 -Ref: #print-unique105572 -Node: register105857 -Ref: #register105984 -Node: Custom register output110156 -Ref: #custom-register-output110285 -Node: register-match111547 -Ref: #register-match111681 -Node: rewrite112032 -Ref: #rewrite112147 -Node: Re-write rules in a file114002 -Ref: #re-write-rules-in-a-file114136 -Node: Diff output format115346 -Ref: #diff-output-format115515 -Node: rewrite vs print --auto116607 -Ref: #rewrite-vs.-print---auto116786 -Node: roi117342 -Ref: #roi117440 -Node: stats118452 -Ref: #stats118551 -Node: tags119339 -Ref: #tags119437 -Node: test119731 -Ref: #test119839 -Node: Add-on Commands120586 -Ref: #add-on-commands120703 -Node: ui122046 -Ref: #ui122134 -Node: web122188 -Ref: #web122291 -Node: iadd122407 -Ref: #iadd122518 -Node: interest122600 -Ref: #interest122707 -Node: ENVIRONMENT122947 -Ref: #environment123059 -Node: FILES123888 -Ref: #files-1123991 -Node: LIMITATIONS124204 -Ref: #limitations124323 -Node: TROUBLESHOOTING125065 -Ref: #troubleshooting125178 +Node: Getting help2832 +Ref: #getting-help2965 +Node: Constructing a command line3518 +Ref: #constructing-a-command-line3708 +Node: Starting a Journal4405 +Ref: #starting-a-journal4589 +Node: Setting Opening Balances5777 +Ref: #setting-opening-balances5968 +Node: Recording Transactions9111 +Ref: #recording-transactions9291 +Node: Reconciling9847 +Ref: #reconciling9990 +Node: Reporting12248 +Ref: #reporting12384 +Node: Starting a New File16383 +Ref: #starting-a-new-file16519 +Node: OPTIONS16748 +Ref: #options16855 +Node: General options17225 +Ref: #general-options17350 +Node: Command options20049 +Ref: #command-options20200 +Node: Command arguments20598 +Ref: #command-arguments20745 +Node: Queries21625 +Ref: #queries21780 +Node: Special characters in arguments and queries25742 +Ref: #special-characters-in-arguments-and-queries25970 +Node: More escaping26421 +Ref: #more-escaping26583 +Node: Even more escaping26879 +Ref: #even-more-escaping27073 +Node: Less escaping27744 +Ref: #less-escaping27906 +Node: Unicode characters28151 +Ref: #unicode-characters28333 +Node: Input files29745 +Ref: #input-files29888 +Node: Output destination31817 +Ref: #output-destination31969 +Node: Output format32252 +Ref: #output-format32402 +Node: Regular expressions32787 +Ref: #regular-expressions32944 +Node: Smart dates34305 +Ref: #smart-dates34456 +Node: Report start & end date35862 +Ref: #report-start-end-date36034 +Node: Report intervals37458 +Ref: #report-intervals37623 +Node: Period expressions38013 +Ref: #period-expressions38173 +Node: Depth limiting42128 +Ref: #depth-limiting42272 +Node: Pivoting42614 +Ref: #pivoting42737 +Node: Valuation44413 +Ref: #valuation44515 +Node: -B Cost44695 +Ref: #b-cost44806 +Node: -V Market value45004 +Ref: #v-market-value45178 +Node: -X Market value in specified commodity46610 +Ref: #x-market-value-in-specified-commodity46849 +Node: --value Flexible valuation47025 +Ref: #value-flexible-valuation47251 +Node: Effect of --value on reports51441 +Ref: #effect-of---value-on-reports51657 +Node: Combining -B -V -X --value56588 +Ref: #combining--b--v--x---value56771 +Node: COMMANDS56807 +Ref: #commands56915 +Node: accounts57999 +Ref: #accounts58097 +Node: activity58796 +Ref: #activity58906 +Node: add59289 +Ref: #add59388 +Node: balance62127 +Ref: #balance62238 +Node: Classic balance report63696 +Ref: #classic-balance-report63869 +Node: Customising the classic balance report65238 +Ref: #customising-the-classic-balance-report65466 +Node: Colour support67542 +Ref: #colour-support67709 +Node: Flat mode67882 +Ref: #flat-mode68030 +Node: Depth limited balance reports68443 +Ref: #depth-limited-balance-reports68628 +Node: Percentages69084 +Ref: #percentages69250 +Node: Multicolumn balance report70387 +Ref: #multicolumn-balance-report70567 +Node: Budget report75881 +Ref: #budget-report76024 +Node: Nested budgets81226 +Ref: #nested-budgets81338 +Ref: #output-format-184819 +Node: balancesheet84897 +Ref: #balancesheet85033 +Node: balancesheetequity86416 +Ref: #balancesheetequity86565 +Node: cashflow87126 +Ref: #cashflow87254 +Node: check-dates88350 +Ref: #check-dates88477 +Node: check-dupes88756 +Ref: #check-dupes88880 +Node: close89173 +Ref: #close89287 +Node: close usage90809 +Ref: #close-usage90902 +Node: commodities93715 +Ref: #commodities93842 +Node: descriptions93924 +Ref: #descriptions94052 +Node: diff94233 +Ref: #diff94339 +Node: files95386 +Ref: #files95486 +Node: help95633 +Ref: #help95733 +Node: import96814 +Ref: #import96928 +Node: Importing balance assignments97821 +Ref: #importing-balance-assignments97969 +Node: incomestatement98618 +Ref: #incomestatement98751 +Node: notes100155 +Ref: #notes100268 +Node: payees100394 +Ref: #payees100500 +Node: prices100658 +Ref: #prices100764 +Node: print101105 +Ref: #print101215 +Node: print-unique105859 +Ref: #print-unique105985 +Node: register106270 +Ref: #register106397 +Node: Custom register output110569 +Ref: #custom-register-output110698 +Node: register-match111960 +Ref: #register-match112094 +Node: rewrite112445 +Ref: #rewrite112560 +Node: Re-write rules in a file114415 +Ref: #re-write-rules-in-a-file114549 +Node: Diff output format115759 +Ref: #diff-output-format115928 +Node: rewrite vs print --auto117020 +Ref: #rewrite-vs.-print---auto117199 +Node: roi117755 +Ref: #roi117853 +Node: stats118865 +Ref: #stats118964 +Node: tags119752 +Ref: #tags119850 +Node: test120144 +Ref: #test120252 +Node: Add-on Commands120999 +Ref: #add-on-commands121116 +Node: ui122459 +Ref: #ui122547 +Node: web122601 +Ref: #web122704 +Node: iadd122820 +Ref: #iadd122931 +Node: interest123013 +Ref: #interest123120 +Node: ENVIRONMENT123360 +Ref: #environment123472 +Node: FILES124301 +Ref: #files-1124404 +Node: LIMITATIONS124617 +Ref: #limitations124736 +Node: TROUBLESHOOTING125478 +Ref: #troubleshooting125591  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 6946d9a6b..64e6d404e 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -58,7 +58,7 @@ COMMON TASKS hledger_journal(5) manual, or the more extensive docs at https://hledger.org. - Get help + Getting help $ hledger # show available commands $ hledger --help # show common options $ hledger CMD --help # show common and command options, and command help @@ -70,6 +70,25 @@ COMMON TASKS Find more docs, chat, mail list, reddit, issue tracker: https://hledger.org#help-feedback + Constructing a command line + hledger has an extensive and powerful command line interface. We + strive to keep it simple and ergonomic, but you may run into one of the + confusing real world details described in OPTIONS, below. If that hap- + pens, here are some tips that may help: + + o command-specific options must go after the command (it's fine to put + all options there) (hledger CMD OPTS ARGS) + + o running add-on executables directly simplifies command line parsing + (hledger-ui OPTS ARGS) + + o enclose "problematic" args in single quotes + + o if needed, also add a backslash to hide regular expression metachar- + acters from the shell + + o to see how a misbehaving command is being parsed, add --debug=2. + Starting a Journal hledger looks for your accounting data in a journal file, $HOME/.hledger.journal by default: @@ -721,58 +740,44 @@ OPTIONS ghci> :main balance cur:\$ - Command line tips - If in doubt, keep things simple: - - o write options after the command (hledger CMD -OPTIONS ARGS) - - o run add-on executables directly (hledger-ui -OPTIONS ARGS) - - o enclose problematic args in single quotes - - o if needed, also add a backslash to escape regexp metacharacters - - To find out exactly how a command line is being parsed, add --debug=2 - to troubleshoot. - Unicode characters hledger is expected to handle non-ascii characters correctly: - o they should be parsed correctly in input files and on the command - line, by all hledger tools (add, iadd, hledger-web's search/add/edit + o they should be parsed correctly in input files and on the command + line, by all hledger tools (add, iadd, hledger-web's search/add/edit forms, etc.) - o they should be displayed correctly by all hledger tools, and on- + o they should be displayed correctly by all hledger tools, and on- screen alignment should be preserved. This requires a well-configured environment. Here are some tips: - o A system locale must be configured, and it must be one that can de- - code the characters being used. In bash, you can set a locale like - this: export LANG=en_US.UTF-8. There are some more details in Trou- - bleshooting. This step is essential - without it, hledger will quit - on encountering a non-ascii character (as with all GHC-compiled pro- + o A system locale must be configured, and it must be one that can de- + code the characters being used. In bash, you can set a locale like + this: export LANG=en_US.UTF-8. There are some more details in Trou- + bleshooting. This step is essential - without it, hledger will quit + on encountering a non-ascii character (as with all GHC-compiled pro- grams). - o your terminal software (eg Terminal.app, iTerm, CMD.exe, xterm..) + o your terminal software (eg Terminal.app, iTerm, CMD.exe, xterm..) must support unicode o the terminal must be using a font which includes the required unicode glyphs - o the terminal should be configured to display wide characters as dou- + o the terminal should be configured to display wide characters as dou- ble width (for report alignment) - o on Windows, for best results you should run hledger in the same kind - of environment in which it was built. Eg hledger built in the stan- - dard CMD.EXE environment (like the binaries on our download page) - might show display problems when run in a cygwin or msys terminal, + o on Windows, for best results you should run hledger in the same kind + of environment in which it was built. Eg hledger built in the stan- + dard CMD.EXE environment (like the binaries on our download page) + might show display problems when run in a cygwin or msys terminal, and vice versa. (See eg #961). Input files hledger reads transactions from a data file (and the add command writes to it). By default this file is $HOME/.hledger.journal (or on Windows, - something like C:/Users/USER/.hledger.journal). You can override this + something like C:/Users/USER/.hledger.journal). You can override this with the $LEDGER_FILE environment variable: $ setenv LEDGER_FILE ~/finance/2016.journal @@ -786,24 +791,26 @@ OPTIONS $ cat some.journal | hledger -f- - Usually the data file is in hledger's journal format, but it can also - be one of several other formats, listed below. hledger detects the - format automatically based on the file extension, or if that is not + Usually the data file is in hledger's journal format, but it can also + be one of several other formats, listed below. hledger detects the + format automatically based on the file extension, or if that is not recognised, by trying each built-in "reader" in turn: Reader: Reads: Used for file extensions: ----------------------------------------------------------------------------- - journal hledger's journal format, also .journal .j .hledger .ledger + journal hledger's journal format, also .journal .j .hledger .ledger some Ledger journals - time- timeclock files (precise time .timeclock + time- timeclock files (precise time .timeclock clock logging) timedot timedot files (approximate time .timedot logging) - csv comma-separated values (data .csv + + + csv comma-separated values (data .csv interchange) - If needed (eg to ensure correct error messages when a file has the - "wrong" extension), you can force a specific reader/format by prepend- + If needed (eg to ensure correct error messages when a file has the + "wrong" extension), you can force a specific reader/format by prepend- ing it to the file path with a colon. Examples: $ hledger -f csv:/some/csv-file.dat stats @@ -814,78 +821,136 @@ OPTIONS o directives in one file will not affect the other files - o balance assertions will not see any account balances from previous + o balance assertions will not see any account balances from previous files If you need those, either use the include directive, or concatenate the files, eg: cat a.journal b.journal | hledger -f- CMD. + Output destination + Some commands (print, register, stats, the balance commands) can write + their output to a destination other than the console. This is con- + trolled by the -o/--output-file option. + + $ hledger balance -o - # write to stdout (the default) + $ hledger balance -o FILE # write to FILE + + Output format + Some commands can write their output in other formats. Eg print and + register can output CSV, and the balance commands can output CSV or + HTML. This is controlled by the -O/--output-format option, or by spec- + ifying a .csv or .html file extension with -o/--output-file. + + $ hledger balance -O csv # write CSV to stdout + $ hledger balance -o FILE.csv # write CSV to FILE.csv + + 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: + REGEX, desc:REGEX, cur:REGEX, tag:...=REGEX + + o CSV rules conditional blocks: if REGEX ... + + o account alias directives and options: alias /REGEX/ = REPLACEMENT, + --alias /REGEX/=REPLACEMENT + + hledger's regular expressions come from the regex-tdfa library. In + general they: + + o are case insensitive + + o are infix matching (do not need to match the entire thing being + matched) + + o are POSIX extended regular expressions + + o also support GNU word boundaries (\<, \>, \b, \B) + + o and parenthesised capturing groups and numeric backreferences in re- + placement strings + + o do not support mode modifiers like (?s) + + Some things to note: + + o In the alias directive and --alias option, regular expressions must + be enclosed in forward slashes (/REGEX/). Elsewhere in hledger, + 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 + with the dollar sign in hledger-web, write cur:\$. + + 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 sepa- - 2004.9.1 rators allowed. Year is - 4+ digits, month is 1-12, + 2004/10/1, 2004-01-01, exact date, several sepa- + 2004.9.1 rators allowed. Year 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 + 10/1 month and day in current year 21 day in current month - october, oct start of month in current + october, oct start of month in current year yesterday, today, tomorrow -1, 0, 1 days from today - last/this/next -1, 0, 1 periods from the + last/this/next -1, 0, 1 periods from the day/week/month/quar- current period ter/year - 20181201 8 digit YYYYMMDD with + 20181201 8 digit YYYYMMDD with valid year month and day - 201812 6 digit YYYYMM with valid + 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 + 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 + 20181301 8 digits with an invalid + month is parsed as start of 8-digit year - 20181232 8 digits with an invalid + 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: @@ -894,7 +959,7 @@ OPTIONS day 2016 -e 12/1 end at the start of decem- ber 1st of the current - year (11/30 will be the + year (11/30 will be the last date included) -b thismonth all transactions on or af- ter the 1st of the current @@ -909,31 +974,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 "-". 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" @@ -947,68 +1012,68 @@ 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" - 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 to 2009/4/1" - -- starts on 2008/12/29, closest pre- + -p "weekly from 2009/1/1 to 2009/4/1" + -- starts on 2008/12/29, closest pre- ceding Monday -p "monthly in 2008/11/25" -- starts on 2018/11/01 - -p "quarterly from 2009-05-05 to + -p "quarterly from 2009-05-05 to 2009-06-01" - starts on 2009/04/01, ends on 2009/06/30, which are first and last days of Q2 2009 -p "yearly from 2009-12-29" - starts on 2009/01/01, first day of 2009 - The following more complex report intervals are also supported: bi- + The following more complex report intervals are also supported: bi- weekly, bimonthly, every day|week|month|quarter|year, every N days|weeks|months|quarters|years. - All of these will start on the first day of the requested period and + 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 + -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 2009/03" -- pe- - riods will have boundaries on + -p "every 5 month from 2009/03" -- pe- + riods will have boundaries on 2009/03/01, 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 , every Nth day [of month], every @@ -1017,47 +1082,49 @@ OPTIONS Examples: - -p "every 2nd day of week" -- periods + -p "every 2nd day of week" -- periods will go from Tue to Tue -p "every Tue" -- same - -p "every 15th day" -- period bound- + -p "every 15th day" -- period bound- aries will be on 15th of each month - -p "every 2nd Monday" -- period bound- - aries will be on second Monday of each + + + -p "every 2nd Monday" -- period bound- + aries 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 basically 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. @@ -1083,7 +1150,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=. @@ -1091,7 +1158,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:. @@ -1102,23 +1169,23 @@ OPTIONS Valuation -B: Cost The -B/--cost flag converts amounts to their cost (or selling price) at - transaction time, if they have a transaction price specified. This + transaction time, if they have a transaction price specified. This flag is equivalent to --value=cost, described below. -V: Market value The -V/--market flag converts reported amounts to their market value in - a default valuation commodity, using the market prices in effect on a - default valuation date. For single period reports, the valuation date - is today (equivalent to --value=now); for multiperiod reports, it is + a default valuation commodity, using the market prices in effect on a + default valuation date. For single period reports, the valuation date + is today (equivalent to --value=now); for multiperiod reports, it is the last day of each subperiod (equivalent to --value=end). The default valuation commodity is the one referenced in the latest ap- - plicable market price dated on or before the valuation date. If most - of your P declarations lead to a single home currency, this will usu- + plicable market price dated on or before the valuation date. If most + of your P declarations lead to a single home currency, this will usu- ally be what you want. (To specify the commodity, see -X below.) Note that in hledger, market prices are always declared explicitly with - P directives; we do not infer them from transaction prices as Ledger + P directives; we do not infer them from transaction prices as Ledger does. Here's a quick example of -V: @@ -1144,15 +1211,15 @@ 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 $103.00 assets:euros -X: Market value in specified commodity - The -X/--exchange option is like -V, except it specifies the target - commodity you would like to convert to. It is equivalent to + The -X/--exchange option is like -V, except it specifies the target + commodity you would like to convert to. It is equivalent to --value=now,COMM or --value=end,COMM. --value: Flexible valuation @@ -1172,43 +1239,43 @@ OPTIONS 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=end Convert amounts to their value in a default valuation commodity, - using market prices on the last day of the report period (or if + 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 default valuation commodity + Convert amounts to their value in default valuation commodity using current market prices (as of when report is generated). --value=YYYY-MM-DD - Convert amounts to their value in default valuation commodity + Convert amounts to their value in default valuation commodity using market prices on this date. - The default valuation commodity is the commodity mentioned in the most + The default valuation commodity is the commodity mentioned in the most recent applicable market price declaration. When all your price decla- - rations lead to a single home currency, this will usually do what you + rations lead to a single home currency, this will usually do what you want. 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, using: o declared prices (from source commodity to valuation commodity) - o reverse prices (declared prices from valuation to source commodity, + o reverse prices (declared prices from valuation to source commodity, inverted) - o indirect prices (prices calculated from the shortest chain of de- + o indirect prices (prices calculated from the shortest chain of de- clared or reverse prices from source to valuation commodity) in that order. - 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 @@ -1246,7 +1313,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 @@ -1283,7 +1350,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 @@ -1297,10 +1364,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 @@ -1316,10 +1383,10 @@ OPTIONS b -0.50A Effect of --value on reports - Here is a reference for how --value currently affects each part of - hledger's reports. It's work in progress, but may be useful for trou- - bleshooting or reporting bugs. See also the definitions and notes be- - low. If you find problems, please report them, ideally with a repro- + Here is a reference for how --value currently affects each part of + hledger's reports. It's work in progress, but may be useful for trou- + bleshooting or reporting bugs. See also the definitions and notes be- + low. If you find problems, please report them, ideally with a repro- ducible example. Related: #329, #1083. Report type -B, -V, -X --value=end --value=DATE, @@ -1328,15 +1395,12 @@ OPTIONS print posting cost value at report value at report value at amounts end or today or journal end DATE/today - - - balance asser- unchanged unchanged unchanged unchanged - tions / as- + tions / as- signments register - starting bal- cost value at day value at day value at + starting bal- cost value at day value at day value at ance (with -H) before report before report DATE/today or journal or journal start start @@ -1355,28 +1419,31 @@ OPTIONS balance (bs, bse, cf, is..) balances (no sums of costs value at report value at report value at - report inter- end or today of or journal end DATE/today of - val) sums of post- of sums of sums of post- + report inter- end or today of or journal end DATE/today of + val) sums of post- of sums of sums of post- ings postings ings balances (with sums of costs value at period value at period value at report inter- ends of sums of ends of sums of DATE/today of val) postings postings sums of post- ings - starting bal- sums of costs sums of post- sums of post- sums of post- + starting bal- sums of costs sums of post- sums of post- sums of post- ances (with of postings ings before re- ings before re- ings before report inter- before report port start port start report start val and -H) start budget amounts like balances like balances like balances like balances with --budget - grand total sum of dis- sum of dis- sum of dis- sum of dis- + grand total sum of dis- sum of dis- sum of dis- sum of dis- (no report in- played values played values played values played values terval) row totals/av- sums/averages sums/averages sums/averages sums/averages erages (with of displayed of displayed of displayed of displayed report inter- values values values values val) - column totals sums of dis- sums of dis- sums of dis- sums of dis- + column totals sums of dis- sums of dis- sums of dis- sums of dis- played values played values played values played values + + + grand to- sum/average of sum/average of sum/average of sum/average tal/average column totals column totals column totals of column to- tals @@ -1386,122 +1453,63 @@ 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). Combining -B, -V, -X, --value The rightmost of these flags wins. - Output destination - Some commands (print, register, stats, the balance commands) can write - their output to a destination other than the console. This is con- - trolled by the -o/--output-file option. - - $ hledger balance -o - # write to stdout (the default) - $ hledger balance -o FILE # write to FILE - - Output format - Some commands can write their output in other formats. Eg print and - register can output CSV, and the balance commands can output CSV or - HTML. This is controlled by the -O/--output-format option, or by spec- - ifying a .csv or .html file extension with -o/--output-file. - - $ hledger balance -O csv # write CSV to stdout - $ hledger balance -o FILE.csv # write CSV to FILE.csv - - 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: - REGEX, desc:REGEX, cur:REGEX, tag:...=REGEX - - o CSV rules conditional blocks: if REGEX ... - - o account alias directives and options: alias /REGEX/ = REPLACEMENT, - --alias /REGEX/=REPLACEMENT - - hledger's regular expressions come from the regex-tdfa library. In - general they: - - o are case insensitive - - o are infix matching (do not need to match the entire thing being - matched) - - o are POSIX extended regular expressions - - o also support GNU word boundaries (\<, \>, \b, \B) - - o and parenthesised capturing groups and numeric backreferences in re- - placement strings - - o do not support mode modifiers like (?s) - - Some things to note: - - o In the alias directive and --alias option, regular expressions must - be enclosed in forward slashes (/REGEX/). Elsewhere in hledger, - 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 - with the dollar sign in hledger-web, write cur:\$. - - 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. - 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: @@ -1520,8 +1528,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: @@ -1536,22 +1544,22 @@ COMMANDS add Prompt for transactions and add them to the journal. - Many hledger users edit their journals directly with a text editor, or - generate them from CSV. For more interactive data entry, there is the - add command, which prompts interactively on the console for new trans- + Many hledger users edit their journals directly with a text editor, or + generate them from CSV. For more interactive data entry, there is the + add command, which prompts interactively on the console for new trans- actions, and appends them to the journal file (if there are multiple -f - FILE options, the first file is used.) Existing transactions are not - changed. This is the only hledger command that writes to the journal + FILE options, the first file is used.) Existing transactions are not + changed. This is the only hledger command that writes to the journal file. To use it, just run hledger add and follow the prompts. You can add as - many transactions as you like; when you are finished, enter . or press + many transactions as you like; when you are finished, enter . or press control-d or control-c to exit. Features: - o add tries to provide useful defaults, using the most similar (by de- - scription) recent transaction (filtered by the query, if any) as a + o add tries to provide useful defaults, using the most similar (by 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. @@ -1559,10 +1567,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. @@ -1571,7 +1579,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): @@ -1601,8 +1609,8 @@ COMMANDS Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ - On Microsoft Windows, the add command makes sure that no part of the - file path ends with a period, as it can cause data loss on that plat- + On Microsoft Windows, the add command makes sure that no part of the + file path ends with a period, as it can cause data loss on that plat- form (cf #1056). balance @@ -1610,29 +1618,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 @@ -1650,22 +1658,22 @@ COMMANDS 0 By default, accounts are displayed hierarchically, with subaccounts in- - dented below their parent. At each level of the tree, accounts are - sorted by account code if any, then by account name. Or with + dented below their parent. At each level of the tree, accounts are + sorted by account code if any, then by account name. Or with -S/--sort-amount, by their balance amount. "Boring" accounts, which contain a single interesting subaccount and no - balance of their own, are elided into the following line for more com- - pact output. (Eg above, the "liabilities" account.) Use --no-elide to + balance of their own, are elided into the following line for more com- + pact output. (Eg above, the "liabilities" account.) Use --no-elide to prevent this. - Account balances are "inclusive" - they include the balances of any + Account balances are "inclusive" - they include the balances of any subaccounts. - Accounts which have zero balance (and no non-zero subaccounts) are + Accounts which have zero balance (and no non-zero subaccounts) are omitted. Use -E/--empty to show them. - A final total is displayed by default; use -N/--no-total to suppress + A final total is displayed by default; use -N/--no-total to suppress it, eg: $ hledger balance -p 2008/6 expenses --no-total @@ -1674,7 +1682,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)" @@ -1692,7 +1700,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) @@ -1703,14 +1711,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) @@ -1727,14 +1735,14 @@ 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 @@ -1745,9 +1753,9 @@ COMMANDS o the output is not being redirected or piped anywhere Flat mode - To see a flat list instead of the default hierarchical display, use - --flat. In this mode, accounts (unless depth-clipped) show their full - names and "exclusive" balance, excluding any subaccount balances. In + To see a flat list instead of the default hierarchical display, use + --flat. In this mode, accounts (unless depth-clipped) show their full + names and "exclusive" balance, excluding any subaccount balances. In this mode, you can also use --drop N to omit the first few account name components. @@ -1756,8 +1764,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 @@ -1770,9 +1778,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 -% @@ -1782,32 +1790,32 @@ 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. 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 @@ -1823,7 +1831,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 @@ -1839,8 +1847,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: @@ -1859,26 +1867,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: @@ -1902,20 +1910,20 @@ COMMANDS Limitations: In multicolumn reports the -V/--value flag uses the market price on the - report end date, for all columns (not the price on each column's end + report end date, for all columns (not the price on each column's end date). - Eliding of boring parent accounts in tree mode, as in the classic bal- + Eliding of boring parent accounts in tree mode, as in the classic bal- ance report, is not yet supported in multicolumn reports. Budget report - With --budget, extra columns are displayed showing budget goals for - each account and period, if any. Budget goals are defined by periodic + 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 @@ -1962,25 +1970,25 @@ COMMANDS Note this is different from a normal balance report in several ways: - o Only accounts with budget goals during the report period are shown, + o Only accounts with budget goals during the report period are shown, by default. - o In each column, in square brackets after the actual amount, budgeted + o In each column, in square brackets after the actual amount, budgeted amounts are shown, along with the percentage of budget used. - o All parent accounts are always shown, even in flat mode. Eg assets, + o All parent accounts are always shown, even in flat mode. Eg assets, assets:bank, and expenses above. - o Amounts always include all subaccounts, budgeted or unbudgeted, even + o Amounts always include all subaccounts, budgeted or unbudgeted, even in flat mode. This means that the numbers displayed will not always add up! Eg above, - the expenses actual amount includes the gifts and supplies transac- - tions, but the expenses:gifts and expenses:supplies accounts are not + the expenses actual amount includes the gifts and supplies transac- + tions, but the expenses:gifts and expenses:supplies accounts are not shown, as they have no budget amounts declared. - This can be confusing. When you need to make things clearer, use the - -E/--empty flag, which will reveal all accounts including unbudgeted + This can be confusing. When you need to make things clearer, use the + -E/--empty flag, which will reveal all accounts including unbudgeted ones, giving the full picture. Eg: $ hledger balance -M --budget --empty @@ -2022,12 +2030,12 @@ COMMANDS For more examples, see Budgeting and Forecasting. Nested budgets - You can add budgets to any account in your account hierarchy. If you + You can add budgets to any account in your account hierarchy. If you have budgets on both parent account and some of its children, then bud- - get(s) of the child account(s) would be added to the budget of their + get(s) of the child account(s) would be added to the budget of their parent, much like account balances behave. - In the most simple case this means that once you add a budget to any + In the most simple case this means that once you add a budget to any account, all its parents would have budget as well. To illustrate this, consider the following budget: @@ -2037,13 +2045,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: @@ -2069,9 +2077,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: @@ -2087,7 +2095,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 @@ -2105,17 +2113,17 @@ COMMANDS || 0 [ 0] Output format - The balance command supports output destination and output format se- + The balance command supports output destination and output format se- lection. balancesheet balancesheet, bs This command displays a simple balance sheet, showing historical ending - balances of asset and liability accounts (ignoring any report begin - date). It assumes that these accounts are under a top-level asset or + balances of asset and liability accounts (ignoring any report begin + date). It assumes that these accounts are under a top-level asset or liability account (case insensitive, plural forms also allowed). - Note this report shows all account balances with normal positive sign + Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). @@ -2141,20 +2149,20 @@ 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 output destination and output format selec- + This command also supports output destination and output format selec- tion. balancesheetequity balancesheetequity, bse - Just like balancesheet, but also reports Equity (which it assumes is + Just like balancesheet, but also reports Equity (which it assumes is under a top-level equity account). Example: @@ -2185,10 +2193,10 @@ COMMANDS cashflow cashflow, cf - This command displays a simple cashflow statement, showing changes in - "cash" accounts. It assumes that these accounts are under a top-level - asset account (case insensitive, plural forms also allowed) and do not - contain receivable or A/R in their name. Note this report shows all + This command displays a simple cashflow statement, showing changes in + "cash" accounts. It assumes that these accounts are under a top-level + asset account (case insensitive, plural forms also allowed) and do not + contain receivable or A/R in their name. Note this report shows all account balances with normal positive sign (like conventional financial statements, unlike balance/print/register) (experimental). @@ -2209,89 +2217,89 @@ 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 output destination and output format selec- + This command also supports output destination and output format selec- tion. check-dates check-dates - Check that transactions are sorted by increasing date. With --date2, - checks secondary dates instead. With --strict, dates must also be - unique. With a query, only matched transactions' dates are checked. + Check that transactions are sorted by increasing date. With --date2, + checks secondary dates instead. With --strict, dates must also be + unique. With a query, only matched transactions' dates are checked. Reads the default journal file, or another specified with -f. check-dupes check-dupes - Reports account names having the same leaf but different prefixes. In - other words, two or more leaves that are categorized differently. + Reports account names having the same leaf but different prefixes. In + other words, two or more leaves that are categorized differently. Reads the default journal file, or another specified as an argument. An example: http://stefanorodighiero.net/software/hledger-dupes.html close close, equity - Prints a "closing balances" transaction and an "opening balances" + Prints a "closing balances" transaction and an "opening balances" transaction that bring account balances to and from zero, respectively. 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: @@ -2346,18 +2354,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. @@ -2375,20 +2383,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: @@ -2415,9 +2423,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 @@ -2428,36 +2436,36 @@ COMMANDS ing transactions are always added to the input files in increasing date order, and by saving .latest.FILE state files. - The --dry-run output is in journal format, so you can filter it, eg to + The --dry-run output is in journal format, so you can filter it, eg to see only uncategorised transactions: $ hledger import --dry ... | hledger -f- print unknown --ignore-assertions Importing balance assignments - Entries added by import will have their posting amounts made explicit - (like hledger print -x). This means that any balance assignments in - imported files must be evaluated; but, imported files don't get to see - the main file's account balances. As a result, importing entries with + Entries added by import will have their posting amounts made explicit + (like hledger print -x). This means that any balance assignments in + imported files must be evaluated; but, imported files don't get to see + the main file's account balances. As a result, importing entries with balance assignments (eg from an institution that provides only balances - and not posting amounts) will probably generate incorrect posting + and not posting amounts) will probably generate incorrect posting amounts. To avoid this problem, use print instead of import: $ hledger print IMPORTFILE [--new] >> $LEDGER_FILE - (If you think import should leave amounts implicit like print does, + (If you think import should leave amounts implicit like print does, please test it and send a pull request.) incomestatement incomestatement, is - This command displays a simple income statement, showing revenues and - expenses during a period. It assumes that these accounts are under a - top-level revenue or income or expense account (case insensitive, plu- - ral forms also allowed). Note this report shows all account balances - with normal positive sign (like conventional financial statements, un- + This command displays a simple income statement, showing revenues and + expenses during a period. It assumes that these accounts are under a + top-level revenue or income or expense account (case insensitive, plu- + ral forms also allowed). Note this report shows all account balances + with normal positive sign (like conventional financial statements, un- like balance/print/register) (experimental). - This command displays a simple income statement. It currently assumes - that you have top-level accounts named income (or revenue) and expense + This command displays a simple income statement. It currently assumes + that you have top-level accounts named income (or revenue) and expense (plural forms also allowed.) $ hledger incomestatement @@ -2482,12 +2490,12 @@ 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 output destination and output format selec- + This command also supports output destination and output format selec- tion. notes @@ -2515,10 +2523,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 @@ -2526,11 +2534,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 @@ -2557,41 +2565,41 @@ 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. - 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 output destination and output format selec- + This command also supports output destination and output format selec- tion. Here's an example of print's CSV output: $ hledger print -Ocsv @@ -2608,20 +2616,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 @@ -2645,7 +2653,7 @@ COMMANDS Show postings and their running total. The register command displays postings in date order, one per line, and - their running total. This is typically used with a query selecting a + their running total. This is typically used with a query selecting a particular account, to see that account's activity: $ hledger register checking @@ -2656,8 +2664,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 @@ -2667,18 +2675,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 @@ -2690,7 +2698,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 @@ -2707,7 +2715,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 @@ -2715,17 +2723,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): @@ -2743,27 +2751,27 @@ COMMANDS $ hledger reg -w 100,40 # set overall width 100, description width 40 $ hledger reg -w $COLUMNS,40 # use terminal width, & description width 40 - This command also supports output destination and output format selec- + This command also supports output destination and output format selec- tion. 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: @@ -2779,7 +2787,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: @@ -2789,16 +2797,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. @@ -2813,7 +2821,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. @@ -2826,12 +2834,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' @@ -2855,10 +2863,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: @@ -2866,48 +2874,48 @@ 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. - It 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, + It 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. stats 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: @@ -2925,14 +2933,14 @@ 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 all the tag names used in the journal. With a TAGREGEX argument, - only tag names matching the regular expression (case insensitive) are - shown. With QUERY arguments, only transactions matching the query are + List all the tag names used in the journal. With a TAGREGEX argument, + only tag names matching the regular expression (case insensitive) are + shown. With QUERY arguments, only transactions matching the query are considered. With --values flag, the tags' unique values are listed in- stead. @@ -2940,13 +2948,13 @@ COMMANDS 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 -- @@ -2955,35 +2963,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 @@ -3002,23 +3010,23 @@ 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 - COLUMNS The screen width used by the register command. Default: the + COLUMNS The screen width used by the register command. Default: the full terminal width. LEDGER_FILE The journal file path when not specified with -f. Default: - ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- + ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- nal). - 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 @@ -3029,13 +3037,13 @@ ENVIRONMENT To see the effect you may need to killall Dock, or reboot. 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 @@ -3051,33 +3059,33 @@ LIMITATIONS In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger add. - Not all of Ledger's journal file syntax is supported. See file format + Not all of Ledger's journal file syntax is supported. See file format differences. - On large data files, hledger is slower and uses more memory than + On large data files, hledger is slower and uses more memory than Ledger. TROUBLESHOOTING - Here are some issues you might encounter when you run hledger (and re- - member you can also seek help from the IRC channel, mail list or bug + Here are some issues you might encounter when you run hledger (and 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. - "Illegal byte sequence" or "Invalid or incomplete multibyte or wide + "Illegal byte sequence" or "Invalid or incomplete multibyte or wide character" errors In order to handle non-ascii letters and symbols (like ), hledger needs an appropriate locale. This is usually configured system-wide; you can also configure it temporarily. The locale may need to be one that sup- - ports UTF-8, if you built hledger with GHC < 7.2 (or possibly always, + ports UTF-8, if you built hledger with GHC < 7.2 (or possibly always, I'm not sure yet). Here's an example of setting the locale temporarily, on ubuntu @@ -3096,7 +3104,7 @@ TROUBLESHOOTING $ echo "export LANG=en_US.UTF-8" >>~/.bash_profile $ bash --login - If we preferred to use eg fr_FR.utf8, we might have to install that + If we preferred to use eg fr_FR.utf8, we might have to install that first: $ apt-get install language-pack-fr @@ -3117,7 +3125,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) @@ -3131,7 +3139,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)