From 65c30bceb6e1d3cab1e378089d831055bc91fcbd Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 27 Jun 2024 00:24:23 +0100 Subject: [PATCH] ;doc: update manuals --- hledger-ui/hledger-ui.1 | 2 +- hledger-ui/hledger-ui.info | 58 +- hledger-ui/hledger-ui.txt | 2 +- hledger-web/hledger-web.1 | 2 +- hledger-web/hledger-web.info | 34 +- hledger-web/hledger-web.txt | 2 +- hledger/hledger.1 | 45 +- hledger/hledger.info | 1394 +++++++++++++++++----------------- hledger/hledger.txt | 38 +- 9 files changed, 787 insertions(+), 790 deletions(-) diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1 index a918bd5bc..67303deff 100644 --- a/hledger-ui/hledger-ui.1 +++ b/hledger-ui/hledger-ui.1 @@ -146,7 +146,7 @@ General help flags: \-\-info show the manual with info \-\-man show the manual with man \-\-version show version information - \-\-debug=[1\-9] show this level of debug output (default: 1) + \-\-debug=[1\-9] show this much debug output (default: 1) .EE .PP With hledger\-ui, the \f[CR]\-\-debug\f[R] option sends debug output to diff --git a/hledger-ui/hledger-ui.info b/hledger-ui/hledger-ui.info index 79a173c30..3e6c15f3f 100644 --- a/hledger-ui/hledger-ui.info +++ b/hledger-ui/hledger-ui.info @@ -157,7 +157,7 @@ General help flags: --info show the manual with info --man show the manual with man --version show version information - --debug=[1-9] show this level of debug output (default: 1) + --debug=[1-9] show this much debug output (default: 1) With hledger-ui, the '--debug' option sends debug output to a 'hledger-ui.log' file in the current directory. @@ -533,34 +533,34 @@ Tag Table: Node: Top221 Node: OPTIONS1872 Ref: #options1970 -Node: MOUSE8240 -Ref: #mouse8335 -Node: KEYS8572 -Ref: #keys8665 -Node: SCREENS13320 -Ref: #screens13424 -Node: Menu screen14060 -Ref: #menu-screen14181 -Node: Cash accounts screen14376 -Ref: #cash-accounts-screen14553 -Node: Balance sheet accounts screen14737 -Ref: #balance-sheet-accounts-screen14953 -Node: Income statement accounts screen15073 -Ref: #income-statement-accounts-screen15294 -Node: All accounts screen15458 -Ref: #all-accounts-screen15639 -Node: Register screen15821 -Ref: #register-screen15980 -Node: Transaction screen18264 -Ref: #transaction-screen18422 -Node: Error screen19839 -Ref: #error-screen19961 -Node: WATCH MODE20205 -Ref: #watch-mode20322 -Node: ENVIRONMENT21781 -Ref: #environment21897 -Node: BUGS22088 -Ref: #bugs22171 +Node: MOUSE8236 +Ref: #mouse8331 +Node: KEYS8568 +Ref: #keys8661 +Node: SCREENS13316 +Ref: #screens13420 +Node: Menu screen14056 +Ref: #menu-screen14177 +Node: Cash accounts screen14372 +Ref: #cash-accounts-screen14549 +Node: Balance sheet accounts screen14733 +Ref: #balance-sheet-accounts-screen14949 +Node: Income statement accounts screen15069 +Ref: #income-statement-accounts-screen15290 +Node: All accounts screen15454 +Ref: #all-accounts-screen15635 +Node: Register screen15817 +Ref: #register-screen15976 +Node: Transaction screen18260 +Ref: #transaction-screen18418 +Node: Error screen19835 +Ref: #error-screen19957 +Node: WATCH MODE20201 +Ref: #watch-mode20318 +Node: ENVIRONMENT21777 +Ref: #environment21893 +Node: BUGS22084 +Ref: #bugs22167  End Tag Table diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt index 525b633c6..3ce514477 100644 --- a/hledger-ui/hledger-ui.txt +++ b/hledger-ui/hledger-ui.txt @@ -135,7 +135,7 @@ OPTIONS --info show the manual with info --man show the manual with man --version show version information - --debug=[1-9] show this level of debug output (default: 1) + --debug=[1-9] show this much debug output (default: 1) With hledger-ui, the --debug option sends debug output to a hledger-ui.log file in the current directory. diff --git a/hledger-web/hledger-web.1 b/hledger-web/hledger-web.1 index e597fd9a3..99bc2592f 100644 --- a/hledger-web/hledger-web.1 +++ b/hledger-web/hledger-web.1 @@ -197,7 +197,7 @@ General help flags: \-\-info show the manual with info \-\-man show the manual with man \-\-version show version information - \-\-debug=[1\-9] show this level of debug output (default: 1) + \-\-debug=[1\-9] show this much debug output (default: 1) .EE .PP hledger\-web shows accounts with zero balances by default (like diff --git a/hledger-web/hledger-web.info b/hledger-web/hledger-web.info index c91ecdfd3..35d1bef97 100644 --- a/hledger-web/hledger-web.info +++ b/hledger-web/hledger-web.info @@ -202,7 +202,7 @@ General help flags: --info show the manual with info --man show the manual with man --version show version information - --debug=[1-9] show this level of debug output (default: 1) + --debug=[1-9] show this much debug output (default: 1) hledger-web shows accounts with zero balances by default (like 'hledger-ui', and unlike 'hledger'). Using the '-E/--empty' flag will @@ -525,22 +525,22 @@ Tag Table: Node: Top223 Node: OPTIONS2569 Ref: #options2674 -Node: PERMISSIONS10952 -Ref: #permissions11091 -Node: EDITING UPLOADING DOWNLOADING12303 -Ref: #editing-uploading-downloading12484 -Node: RELOADING13318 -Ref: #reloading13452 -Node: JSON API13885 -Ref: #json-api14000 -Node: DEBUG OUTPUT19534 -Ref: #debug-output19659 -Node: Debug output19686 -Ref: #debug-output-119787 -Node: ENVIRONMENT20204 -Ref: #environment20323 -Node: BUGS20440 -Ref: #bugs20524 +Node: PERMISSIONS10948 +Ref: #permissions11087 +Node: EDITING UPLOADING DOWNLOADING12299 +Ref: #editing-uploading-downloading12480 +Node: RELOADING13314 +Ref: #reloading13448 +Node: JSON API13881 +Ref: #json-api13996 +Node: DEBUG OUTPUT19530 +Ref: #debug-output19655 +Node: Debug output19682 +Ref: #debug-output-119783 +Node: ENVIRONMENT20200 +Ref: #environment20319 +Node: BUGS20436 +Ref: #bugs20520  End Tag Table diff --git a/hledger-web/hledger-web.txt b/hledger-web/hledger-web.txt index 5dcc30901..5354c322c 100644 --- a/hledger-web/hledger-web.txt +++ b/hledger-web/hledger-web.txt @@ -179,7 +179,7 @@ OPTIONS --info show the manual with info --man show the manual with man --version show version information - --debug=[1-9] show this level of debug output (default: 1) + --debug=[1-9] show this much debug output (default: 1) hledger-web shows accounts with zero balances by default (like hledger-ui, and unlike hledger). Using the -E/--empty flag will re- diff --git a/hledger/hledger.1 b/hledger/hledger.1 index b0ee117ee..67b929faa 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -431,7 +431,7 @@ General help flags: \-\-info show the manual with info \-\-man show the manual with man \-\-version show version information - \-\-debug=[1\-9] show this level of debug output (default: 1) + \-\-debug=[1\-9] show this much debug output (default: 1) .EE .PP Usually hledger accepts any unambiguous flag prefix, eg you can write @@ -731,29 +731,30 @@ quoting than you would at the command prompt.) .PP Argument files are now superseded by.. .SS Config files -hledger looks for a \f[CR]hledger.conf\f[R] file (or -\f[CR].hledger.conf\f[R] in your home directory) in the current -directory, then parent directories, then your XDG config directory -(\f[CR]\[ti]/.config/hledger/\f[R]). -Any command line options (or arguments) in this file will be added to -your \f[CR]hledger\f[R] commands, near the start of the command line (so -you can override them when needed). +hledger will read extra command line options from a +\f[CR]hledger.conf\f[R] config file. +These will be inserted early in the command line, so your later options +can override them if needed. +The config file can contain general options (which will be used with all +commands that support them), and command\-specific options (or +arguments). +hledger.conf.sample is an example, which you can install as +\f[CR]./hledger.conf\f[R] or \f[CR]$HOME/.hledger.conf\f[R]. .PP -Or you can specify a config file with the \f[CR]\-\-conf\f[R] option. -Or you can add a \f[CR]hledger \-\-conf\f[R] shebang line to a config -file and make it executable. +To be precise, hledger looks for \f[CR]hledger.conf\f[R] in the current +directory or above, or in your home directory (with a dotted name, +\f[CR]\[ti]/.hledger.conf\f[R]), or finally in your XDG config directory +(\f[CR]\[ti]/.config/hledger/hledger.conf\f[R]). +Or you can select a particular config file by using the +\f[CR]\-\-conf\f[R] option, or by adding a \f[CR]hledger \-\-conf\f[R] +shebang line to a config file and executing it like a script (see the +example file). +You can inspect the finding and processing of config files with +\f[CR]\-\-debug\f[R] or \f[CR]\-\-debug=8\f[R]. .PP -A hledger config file contains command line options, to be used with all -commands that support them, and optionally command\-specific options in -named sections. -hledger.conf.sample is a sample demonstrating the syntax; you can -install it as \f[CR]./hledger.conf\f[R] or -\f[CR]$HOME/.hledger.conf\f[R] and customise it. -.PP -You can disable config files entirely by running with the -\f[CR]\-n/\-\-no\-conf\f[R] flag. -This will ensure hledger runs with standard defaults, useful when -troubleshooting or when sharing examples with others. +If you want to run hledger without a config file, to ensure standard +defaults and behaviour, use the \f[CR]\-n/\-\-no\-conf\f[R] flag. +This is useful when troubleshooting problems or sharing examples. .PP \f[I](Added in 1.40; experimental)\f[R] .SH Output diff --git a/hledger/hledger.info b/hledger/hledger.info index 8d66b130c..0223610a8 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -447,7 +447,7 @@ General help flags: --info show the manual with info --man show the manual with man --version show version information - --debug=[1-9] show this level of debug output (default: 1) + --debug=[1-9] show this much debug output (default: 1) Usually hledger accepts any unambiguous flag prefix, eg you can write '--tl' instead of '--tldr' or '--dry' instead of '--dry-run'. @@ -745,27 +745,26 @@ File: hledger.info, Node: Config files, Prev: Argument files, Up: Options 4.5 Config files ================ -hledger looks for a 'hledger.conf' file (or '.hledger.conf' in your home -directory) in the current directory, then parent directories, then your -XDG config directory ('~/.config/hledger/'). Any command line options -(or arguments) in this file will be added to your 'hledger' commands, -near the start of the command line (so you can override them when -needed). +hledger will read extra command line options from a 'hledger.conf' +config file. These will be inserted early in the command line, so your +later options can override them if needed. The config file can contain +general options (which will be used with all commands that support +them), and command-specific options (or arguments). hledger.conf.sample +is an example, which you can install as './hledger.conf' or +'$HOME/.hledger.conf'. - Or you can specify a config file with the '--conf' option. Or you -can add a 'hledger --conf' shebang line to a config file and make it -executable. + To be precise, hledger looks for 'hledger.conf' in the current +directory or above, or in your home directory (with a dotted name, +'~/.hledger.conf'), or finally in your XDG config directory +('~/.config/hledger/hledger.conf'). Or you can select a particular +config file by using the '--conf' option, or by adding a 'hledger +--conf' shebang line to a config file and executing it like a script +(see the example file). You can inspect the finding and processing of +config files with '--debug' or '--debug=8'. - A hledger config file contains command line options, to be used with -all commands that support them, and optionally command-specific options -in named sections. hledger.conf.sample is a sample demonstrating the -syntax; you can install it as './hledger.conf' or '$HOME/.hledger.conf' -and customise it. - - You can disable config files entirely by running with the -'-n/--no-conf' flag. This will ensure hledger runs with standard -defaults, useful when troubleshooting or when sharing examples with -others. + If you want to run hledger without a config file, to ensure standard +defaults and behaviour, use the '-n/--no-conf' flag. This is useful +when troubleshooting problems or sharing examples. _(Added in 1.40; experimental)_ @@ -3160,9 +3159,13 @@ output into the journal file to make it permanent. * Menu: * Auto postings and multiple files:: +* Auto postings and dates:: +* Auto postings and transaction balancing / inferred amounts / balance assertions:: +* Auto posting tags:: +* Auto postings on forecast transactions only::  -File: hledger.info, Node: Auto postings and multiple files, Up: Auto postings +File: hledger.info, Node: Auto postings and multiple files, Next: Auto postings and dates, Up: Auto postings 8.26.1 Auto postings and multiple files --------------------------------------- @@ -3171,30 +3174,23 @@ An auto posting rule can affect any transaction in the current file, or in any parent file or child file. Note, currently it will not affect sibling files (when multiple '-f'/'--file' are used - see #1212). -* Menu: - -* Auto postings and dates:: -* Auto postings and transaction balancing / inferred amounts / balance assertions:: -* Auto posting tags:: -* Auto postings on forecast transactions only:: -  -File: hledger.info, Node: Auto postings and dates, Next: Auto postings and transaction balancing / inferred amounts / balance assertions, Up: Auto postings and multiple files +File: hledger.info, Node: Auto postings and dates, Next: Auto postings and transaction balancing / inferred amounts / balance assertions, Prev: Auto postings and multiple files, Up: Auto postings -8.26.1.1 Auto postings and dates -................................ +8.26.2 Auto postings and dates +------------------------------ A posting date (or secondary date) in the matched posting, or (taking precedence) a posting date in the auto posting rule itself, will also be used in the generated posting.  -File: hledger.info, Node: Auto postings and transaction balancing / inferred amounts / balance assertions, Next: Auto posting tags, Prev: Auto postings and dates, Up: Auto postings and multiple files +File: hledger.info, Node: Auto postings and transaction balancing / inferred amounts / balance assertions, Next: Auto posting tags, Prev: Auto postings and dates, Up: Auto postings -8.26.1.2 Auto postings and transaction balancing / inferred -........................................................... +8.26.3 Auto postings and transaction balancing / inferred amounts / +------------------------------------------------------------------- -amounts / balance assertions Currently, auto postings are added: +balance assertions Currently, auto postings are added: * after missing amounts are inferred, and transactions are checked for balancedness, @@ -3209,10 +3205,10 @@ a missing amount applied to a given transaction, as it will be unable to infer amounts.  -File: hledger.info, Node: Auto posting tags, Next: Auto postings on forecast transactions only, Prev: Auto postings and transaction balancing / inferred amounts / balance assertions, Up: Auto postings and multiple files +File: hledger.info, Node: Auto posting tags, Next: Auto postings on forecast transactions only, Prev: Auto postings and transaction balancing / inferred amounts / balance assertions, Up: Auto postings -8.26.1.3 Auto posting tags -.......................... +8.26.4 Auto posting tags +------------------------ Automated postings will have some extra tags: @@ -3231,10 +3227,10 @@ will have these tags added: transaction was modified "just now".  -File: hledger.info, Node: Auto postings on forecast transactions only, Prev: Auto posting tags, Up: Auto postings and multiple files +File: hledger.info, Node: Auto postings on forecast transactions only, Prev: Auto posting tags, Up: Auto postings -8.26.1.4 Auto postings on forecast transactions only -.................................................... +8.26.5 Auto postings on forecast transactions only +-------------------------------------------------- Tip: you can can make auto postings that will apply to forecast transactions but not recorded transactions, by adding @@ -11639,664 +11635,664 @@ Node: Add-on commands11112 Ref: #add-on-commands11214 Node: Options12330 Ref: #options12431 -Node: Special characters18729 -Ref: #special-characters18866 -Node: Single escaping shell metacharacters19029 -Ref: #single-escaping-shell-metacharacters19270 -Node: Double escaping regular expression metacharacters19873 -Ref: #double-escaping-regular-expression-metacharacters20184 -Node: Triple escaping for add-on commands20710 -Ref: #triple-escaping-for-add-on-commands20970 -Node: Less escaping21614 -Ref: #less-escaping21768 -Node: Unicode characters22092 -Ref: #unicode-characters22257 -Node: Regular expressions23756 -Ref: #regular-expressions23919 -Node: hledger's regular expressions27015 -Ref: #hledgers-regular-expressions27174 -Node: Argument files28560 -Ref: #argument-files28707 -Node: Config files29213 -Ref: #config-files29328 -Node: Output30387 -Ref: #output30489 -Node: Output destination30616 -Ref: #output-destination30747 -Node: Output format31172 -Ref: #output-format31318 -Node: CSV output32915 -Ref: #csv-output33031 -Node: HTML output33134 -Ref: #html-output33272 -Node: JSON output33366 -Ref: #json-output33504 -Node: SQL output34489 -Ref: #sql-output34605 -Node: Commodity styles35340 -Ref: #commodity-styles35480 -Node: Colour36218 -Ref: #colour36336 -Node: Box-drawing36740 -Ref: #box-drawing36858 -Node: Paging37142 -Ref: #paging37256 -Node: Debug output38209 -Ref: #debug-output38315 -Node: Environment38978 -Ref: #environment39102 -Node: PART 2 DATA FORMATS39669 -Ref: #part-2-data-formats39812 -Node: Journal39812 -Ref: #journal39921 -Node: Journal cheatsheet42289 -Ref: #journal-cheatsheet42416 -Node: Comments48503 -Ref: #comments48631 -Node: Transactions49447 -Ref: #transactions49570 -Node: Dates50584 -Ref: #dates50691 -Node: Simple dates50736 -Ref: #simple-dates50852 -Node: Posting dates51352 -Ref: #posting-dates51470 -Node: Status52439 -Ref: #status52540 -Node: Code54205 -Ref: #code54308 -Node: Description54540 -Ref: #description54671 -Node: Payee and note55227 -Ref: #payee-and-note55333 -Node: Transaction comments56318 -Ref: #transaction-comments56471 -Node: Postings56834 -Ref: #postings56965 -Node: Debits and credits57997 -Ref: #debits-and-credits58144 -Node: The two space delimiter58607 -Ref: #the-two-space-delimiter58764 -Node: Account names59172 -Ref: #account-names59302 -Node: Amounts60976 -Ref: #amounts61104 -Node: Decimal marks62005 -Ref: #decimal-marks62132 -Node: Digit group marks63109 -Ref: #digit-group-marks63262 -Node: Commodity63744 -Ref: #commodity63873 -Node: Costs64861 -Ref: #costs64956 -Node: Balance assertions67113 -Ref: #balance-assertions67266 -Node: Assertions and ordering68350 -Ref: #assertions-and-ordering68539 -Node: Assertions and multiple included files69078 -Ref: #assertions-and-multiple-included-files69338 -Node: Assertions and multiple -f files69838 -Ref: #assertions-and-multiple--f-files70083 -Node: Assertions and costs70480 -Ref: #assertions-and-costs70689 -Node: Assertions and commodities71130 -Ref: #assertions-and-commodities71345 -Node: Assertions and subaccounts72789 -Ref: #assertions-and-subaccounts73015 -Node: Assertions and virtual postings73459 -Ref: #assertions-and-virtual-postings73697 -Node: Assertions and auto postings73829 -Ref: #assertions-and-auto-postings74059 -Node: Assertions and precision74704 -Ref: #assertions-and-precision74886 -Node: Posting comments75153 -Ref: #posting-comments75316 -Node: Transaction balancing75693 -Ref: #transaction-balancing75852 -Node: Tags77695 -Ref: #tags77814 -Node: Tag names79157 -Ref: #tag-names79264 -Node: Special tags79652 -Ref: #special-tags79784 -Node: Tag values81297 -Ref: #tag-values81407 -Node: Directives82279 -Ref: #directives82406 -Node: Directives and multiple files83736 -Ref: #directives-and-multiple-files83914 -Node: Directive effects84681 -Ref: #directive-effects84835 -Node: account directive87837 -Ref: #account-directive87993 -Node: Account comments89287 -Ref: #account-comments89438 -Node: Account error checking89946 -Ref: #account-error-checking90139 -Node: Account display order91328 -Ref: #account-display-order91516 -Node: Account types92526 -Ref: #account-types92667 -Node: alias directive96300 -Ref: #alias-directive96461 -Node: Basic aliases97511 -Ref: #basic-aliases97642 -Node: Regex aliases98386 -Ref: #regex-aliases98543 -Node: Combining aliases99433 -Ref: #combining-aliases99611 -Node: Aliases and multiple files100887 -Ref: #aliases-and-multiple-files101091 -Node: end aliases directive101670 -Ref: #end-aliases-directive101889 -Node: Aliases can generate bad account names102038 -Ref: #aliases-can-generate-bad-account-names102286 -Node: Aliases and account types102871 -Ref: #aliases-and-account-types103063 -Node: commodity directive103759 -Ref: #commodity-directive103933 -Node: Commodity directive syntax105346 -Ref: #commodity-directive-syntax105531 -Node: Commodity error checking106982 -Ref: #commodity-error-checking107163 -Node: decimal-mark directive107457 -Ref: #decimal-mark-directive107639 -Node: include directive108036 -Ref: #include-directive108200 -Node: P directive109112 -Ref: #p-directive109257 -Node: payee directive110146 -Ref: #payee-directive110295 -Node: tag directive110768 -Ref: #tag-directive110923 -Node: Periodic transactions111380 -Ref: #periodic-transactions111545 -Node: Periodic rule syntax113534 -Ref: #periodic-rule-syntax113712 -Node: Periodic rules and relative dates114357 -Ref: #periodic-rules-and-relative-dates114623 -Node: Two spaces between period expression and description!115134 -Ref: #two-spaces-between-period-expression-and-description115411 -Node: Auto postings116095 -Ref: #auto-postings116243 -Node: Auto postings and multiple files119073 -Ref: #auto-postings-and-multiple-files119237 -Node: Auto postings and dates119638 -Ref: #auto-postings-and-dates119886 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions120061 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions120417 -Node: Auto posting tags120920 -Ref: #auto-posting-tags121202 -Node: Auto postings on forecast transactions only121838 -Ref: #auto-postings-on-forecast-transactions-only122084 -Node: Other syntax122331 -Ref: #other-syntax122447 -Node: Balance assignments123103 -Ref: #balance-assignments123259 -Node: Balance assignments and costs124631 -Ref: #balance-assignments-and-costs124843 -Node: Balance assignments and multiple files125053 -Ref: #balance-assignments-and-multiple-files125283 -Node: Bracketed posting dates125476 -Ref: #bracketed-posting-dates125660 -Node: D directive126174 -Ref: #d-directive126342 -Node: apply account directive127947 -Ref: #apply-account-directive128127 -Node: Y directive128814 -Ref: #y-directive128974 -Node: Secondary dates129802 -Ref: #secondary-dates129956 -Node: Star comments131287 -Ref: #star-comments131447 -Node: Valuation expressions131979 -Ref: #valuation-expressions132156 -Node: Virtual postings132278 -Ref: #virtual-postings132455 -Node: Other Ledger directives133902 -Ref: #other-ledger-directives134098 -Node: Other cost/lot notations134664 -Ref: #other-costlot-notations134837 -Node: CSV137426 -Ref: #csv137517 -Node: CSV rules cheatsheet139509 -Ref: #csv-rules-cheatsheet139636 -Node: source141434 -Ref: #source141555 -Node: separator142435 -Ref: #separator142546 -Node: skip143086 -Ref: #skip143192 -Node: date-format143736 -Ref: #date-format143855 -Node: timezone144579 -Ref: #timezone144700 -Node: newest-first145705 -Ref: #newest-first145841 -Node: intra-day-reversed146418 -Ref: #intra-day-reversed146570 -Node: decimal-mark147018 -Ref: #decimal-mark147157 -Node: fields list147496 -Ref: #fields-list147633 -Node: Field assignment149304 -Ref: #field-assignment149446 -Node: Field names150523 -Ref: #field-names150652 -Node: date field151855 -Ref: #date-field151971 -Node: date2 field152019 -Ref: #date2-field152158 -Node: status field152214 -Ref: #status-field152355 -Node: code field152404 -Ref: #code-field152547 -Node: description field152592 -Ref: #description-field152750 -Node: comment field152809 -Ref: #comment-field152962 -Node: account field153255 -Ref: #account-field153403 -Node: amount field153973 -Ref: #amount-field154120 -Node: currency field156812 -Ref: #currency-field156963 -Node: balance field157220 -Ref: #balance-field157350 -Node: if block157743 -Ref: #if-block157862 -Node: Matchers159270 -Ref: #matchers159382 -Node: What matchers match160179 -Ref: #what-matchers-match160326 -Node: Combining matchers160766 -Ref: #combining-matchers160932 -Node: Match groups161469 -Ref: #match-groups161595 -Node: if table162363 -Ref: #if-table162483 -Node: balance-type164364 -Ref: #balance-type164491 -Node: include165191 -Ref: #include165316 -Node: Working with CSV165760 -Ref: #working-with-csv165905 -Node: Rapid feedback166312 -Ref: #rapid-feedback166443 -Node: Valid CSV166895 -Ref: #valid-csv167039 -Node: File Extension167771 -Ref: #file-extension167942 -Node: Reading CSV from standard input168506 -Ref: #reading-csv-from-standard-input168728 -Node: Reading multiple CSV files168892 -Ref: #reading-multiple-csv-files169121 -Node: Reading files specified by rule169368 -Ref: #reading-files-specified-by-rule169594 -Node: Valid transactions170765 -Ref: #valid-transactions170962 -Node: Deduplicating importing171590 -Ref: #deduplicating-importing171783 -Node: Setting amounts172819 -Ref: #setting-amounts172988 -Node: Amount signs175346 -Ref: #amount-signs175514 -Node: Setting currency/commodity176411 -Ref: #setting-currencycommodity176613 -Node: Amount decimal places177787 -Ref: #amount-decimal-places177991 -Node: Referencing other fields179044 -Ref: #referencing-other-fields179255 -Node: How CSV rules are evaluated180152 -Ref: #how-csv-rules-are-evaluated180367 -Node: Well factored rules181820 -Ref: #well-factored-rules181986 -Node: CSV rules examples182310 -Ref: #csv-rules-examples182443 -Node: Bank of Ireland182508 -Ref: #bank-of-ireland182643 -Node: Coinbase184105 -Ref: #coinbase184241 -Node: Amazon185288 -Ref: #amazon185411 -Node: Paypal187130 -Ref: #paypal187236 -Node: Timeclock194880 -Ref: #timeclock194985 -Node: Timedot197161 -Ref: #timedot197284 -Node: Timedot examples200405 -Ref: #timedot-examples200511 -Node: PART 3 REPORTING CONCEPTS202682 -Ref: #part-3-reporting-concepts202846 -Node: Time periods202846 -Ref: #time-periods202980 -Node: Report start & end date203098 -Ref: #report-start-end-date203250 -Node: Smart dates204574 -Ref: #smart-dates204727 -Node: Report intervals206517 -Ref: #report-intervals206672 -Node: Date adjustment207090 -Ref: #date-adjustment207250 -Node: Period expressions208101 -Ref: #period-expressions208242 -Node: Period expressions with a report interval210006 -Ref: #period-expressions-with-a-report-interval210240 -Node: More complex report intervals210454 -Ref: #more-complex-report-intervals210699 -Node: Multiple weekday intervals212560 -Ref: #multiple-weekday-intervals212749 -Node: Depth213571 -Ref: #depth213673 -Node: Queries213969 -Ref: #queries214071 -Node: Query types215667 -Ref: #query-types215788 -Node: Combining query terms219022 -Ref: #combining-query-terms219199 -Node: Queries and command options220762 -Ref: #queries-and-command-options220967 -Node: Queries and account aliases221216 -Ref: #queries-and-account-aliases221421 -Node: Queries and valuation221541 -Ref: #queries-and-valuation221698 -Node: Pivoting221903 -Ref: #pivoting222017 -Node: Generating data223794 -Ref: #generating-data223926 -Node: Forecasting225594 -Ref: #forecasting225719 -Node: --forecast226250 -Ref: #forecast226381 -Node: Inspecting forecast transactions227351 -Ref: #inspecting-forecast-transactions227553 -Node: Forecast reports228683 -Ref: #forecast-reports228856 -Node: Forecast tags229792 -Ref: #forecast-tags229952 -Node: Forecast period in detail230412 -Ref: #forecast-period-in-detail230606 -Node: Forecast troubleshooting231500 -Ref: #forecast-troubleshooting231668 -Node: Budgeting232571 -Ref: #budgeting232694 -Node: Amount formatting233131 -Ref: #amount-formatting233273 -Node: Commodity display style233375 -Ref: #commodity-display-style233529 -Node: Rounding235216 -Ref: #rounding235371 -Node: Trailing decimal marks235821 -Ref: #trailing-decimal-marks236000 -Node: Amount parseability236754 -Ref: #amount-parseability236910 -Node: Cost reporting238335 -Ref: #cost-reporting238477 -Node: Recording costs239138 -Ref: #recording-costs239274 -Node: Reporting at cost240865 -Ref: #reporting-at-cost241040 -Node: Equity conversion postings241630 -Ref: #equity-conversion-postings241844 -Node: Inferring equity conversion postings244275 -Ref: #inferring-equity-conversion-postings244538 -Node: Combining costs and equity conversion postings245290 -Ref: #combining-costs-and-equity-conversion-postings245600 -Node: Requirements for detecting equity conversion postings246515 -Ref: #requirements-for-detecting-equity-conversion-postings246837 -Node: Infer cost and equity by default ?248037 -Ref: #infer-cost-and-equity-by-default248266 -Node: Value reporting248474 -Ref: #value-reporting248616 -Node: -V Value249355 -Ref: #v-value249487 -Node: -X Value in specified commodity249682 -Ref: #x-value-in-specified-commodity249883 -Node: Valuation date250032 -Ref: #valuation-date250209 -Node: Finding market price250992 -Ref: #finding-market-price251203 -Node: --infer-market-prices market prices from transactions252372 -Ref: #infer-market-prices-market-prices-from-transactions252654 -Node: Valuation commodity255416 -Ref: #valuation-commodity255636 -Node: --value Flexible valuation256849 -Ref: #value-flexible-valuation257048 -Node: Valuation examples258692 -Ref: #valuation-examples258892 -Node: Interaction of valuation and queries260824 -Ref: #interaction-of-valuation-and-queries261064 -Node: Effect of valuation on reports261541 -Ref: #effect-of-valuation-on-reports261744 -Node: PART 4 COMMANDS269439 -Ref: #part-4-commands269582 -Node: Help commands271655 -Ref: #help-commands271800 -Node: help271828 -Ref: #help271917 -Node: demo273505 -Ref: #demo273594 -Node: User interface commands274638 -Ref: #user-interface-commands274807 -Node: ui274832 -Ref: #ui274924 -Node: web274957 -Ref: #web275051 -Node: Data entry commands275085 -Ref: #data-entry-commands275254 -Node: add275283 -Ref: #add275377 -Node: import277838 -Ref: #import277938 -Node: Date skipping279099 -Ref: #date-skipping279222 -Node: Import testing282000 -Ref: #import-testing282163 -Node: Importing balance assignments283006 -Ref: #importing-balance-assignments283213 -Node: Import and commodity styles283862 -Ref: #import-and-commodity-styles284042 -Node: Basic report commands284271 -Ref: #basic-report-commands284445 -Node: accounts284572 -Ref: #accounts284682 -Node: codes287445 -Ref: #codes287569 -Node: commodities288467 -Ref: #commodities288607 -Node: descriptions288711 -Ref: #descriptions288853 -Node: files289178 -Ref: #files289300 -Node: notes289475 -Ref: #notes289591 -Node: payees289987 -Ref: #payees290106 -Node: prices290771 -Ref: #prices290890 -Node: stats291663 -Ref: #stats291778 -Node: tags293404 -Ref: #tags-1293504 -Node: Standard report commands294711 -Ref: #standard-report-commands294896 -Node: print295016 -Ref: #print295124 -Node: print explicitness297462 -Ref: #print-explicitness297603 -Node: print amount style298382 -Ref: #print-amount-style298550 -Node: print parseability299620 -Ref: #print-parseability299790 -Node: print other features300539 -Ref: #print-other-features300716 -Node: print output format301237 -Ref: #print-output-format301383 -Node: aregister304522 -Ref: #aregister304655 -Node: aregister and posting dates308302 -Ref: #aregister-and-posting-dates308447 -Node: register309203 -Ref: #register309341 -Node: Custom register output315506 -Ref: #custom-register-output315635 -Node: balancesheet316982 -Ref: #balancesheet317137 -Node: balancesheetequity321618 -Ref: #balancesheetequity321785 -Node: cashflow326624 -Ref: #cashflow326774 -Node: incomestatement331052 -Ref: #incomestatement331189 -Node: Advanced report commands335516 -Ref: #advanced-report-commands335694 -Node: balance335724 -Ref: #balance335832 -Node: balance features340607 -Ref: #balance-features340747 -Node: Simple balance report342657 -Ref: #simple-balance-report342842 -Node: Balance report line format344467 -Ref: #balance-report-line-format344669 -Node: Filtered balance report346827 -Ref: #filtered-balance-report347019 -Node: List or tree mode347346 -Ref: #list-or-tree-mode347514 -Node: Depth limiting348859 -Ref: #depth-limiting349025 -Node: Dropping top-level accounts349626 -Ref: #dropping-top-level-accounts349826 -Node: Showing declared accounts350136 -Ref: #showing-declared-accounts350335 -Node: Sorting by amount350866 -Ref: #sorting-by-amount351033 -Node: Percentages351703 -Ref: #percentages351862 -Node: Multi-period balance report352410 -Ref: #multi-period-balance-report352610 -Node: Balance change end balance355162 -Ref: #balance-change-end-balance355371 -Node: Balance report types356799 -Ref: #balance-report-types356980 -Node: Calculation type357478 -Ref: #calculation-type357633 -Node: Accumulation type358182 -Ref: #accumulation-type358362 -Node: Valuation type359283 -Ref: #valuation-type359471 -Node: Combining balance report types360472 -Ref: #combining-balance-report-types360666 -Node: Budget report362504 -Ref: #budget-report362666 -Node: Using the budget report364809 -Ref: #using-the-budget-report364982 -Node: Budget date surprises367085 -Ref: #budget-date-surprises367285 -Node: Selecting budget goals368449 -Ref: #selecting-budget-goals368652 -Node: Budgeting vs forecasting369397 -Ref: #budgeting-vs-forecasting369574 -Node: Balance report layout371074 -Ref: #balance-report-layout371259 -Node: Wide layout372212 -Ref: #wide-layout372347 -Node: Tall layout374617 -Ref: #tall-layout374772 -Node: Bare layout375923 -Ref: #bare-layout376078 -Node: Tidy layout377987 -Ref: #tidy-layout378122 -Node: Some useful balance reports379531 -Ref: #some-useful-balance-reports379706 -Node: roi380791 -Ref: #roi380891 -Node: Spaces and special characters in --inv and --pnl383038 -Ref: #spaces-and-special-characters-in---inv-and---pnl383276 -Node: Semantics of --inv and --pnl383764 -Ref: #semantics-of---inv-and---pnl384001 -Node: IRR and TWR explained385851 -Ref: #irr-and-twr-explained386009 -Node: Chart commands389262 -Ref: #chart-commands389420 -Node: activity389443 -Ref: #activity389532 -Node: Data generation commands389940 -Ref: #data-generation-commands390114 -Node: close390146 -Ref: #close390252 -Node: close --migrate392738 -Ref: #close---migrate392863 -Node: close --close394502 -Ref: #close---close394644 -Node: close --open394880 -Ref: #close---open395019 -Node: close --assert395129 -Ref: #close---assert395273 -Node: close --assign395494 -Ref: #close---assign395640 -Node: close --retain396166 -Ref: #close---retain396317 -Node: close customisation397062 -Ref: #close-customisation397239 -Node: close and balance assertions398706 -Ref: #close-and-balance-assertions398901 -Node: close examples400228 -Ref: #close-examples400367 -Node: Retain earnings400465 -Ref: #retain-earnings400622 -Node: Migrate balances to a new file400968 -Ref: #migrate-balances-to-a-new-file401192 -Node: More detailed close examples402320 -Ref: #more-detailed-close-examples402516 -Node: rewrite402542 -Ref: #rewrite402652 -Node: Re-write rules in a file405114 -Ref: #re-write-rules-in-a-file405275 -Node: Diff output format406424 -Ref: #diff-output-format406605 -Node: rewrite vs print --auto407697 -Ref: #rewrite-vs.-print---auto407855 -Node: Maintenance commands408411 -Ref: #maintenance-commands408582 -Node: check408620 -Ref: #check408719 -Node: Basic checks409702 -Ref: #basic-checks409820 -Node: Strict checks410655 -Ref: #strict-checks410796 -Node: Other checks411530 -Ref: #other-checks411670 -Node: Custom checks413385 -Ref: #custom-checks413505 -Node: diff413840 -Ref: #diff413950 -Node: test415047 -Ref: #test415143 -Node: PART 5 COMMON TASKS415919 -Ref: #part-5-common-tasks416078 -Node: Getting help416152 -Ref: #getting-help416301 -Node: Constructing command lines417061 -Ref: #constructing-command-lines417242 -Node: Starting a journal file417899 -Ref: #starting-a-journal-file418081 -Node: Setting LEDGER_FILE419283 -Ref: #setting-ledger_file419455 -Node: Setting opening balances420412 -Ref: #setting-opening-balances420593 -Node: Recording transactions423734 -Ref: #recording-transactions423903 -Node: Reconciling424459 -Ref: #reconciling424591 -Node: Reporting426848 -Ref: #reporting426977 -Node: Migrating to a new file430962 -Ref: #migrating-to-a-new-file431112 -Node: BUGS431411 -Ref: #bugs431505 -Node: Troubleshooting432384 -Ref: #troubleshooting432484 +Node: Special characters18725 +Ref: #special-characters18862 +Node: Single escaping shell metacharacters19025 +Ref: #single-escaping-shell-metacharacters19266 +Node: Double escaping regular expression metacharacters19869 +Ref: #double-escaping-regular-expression-metacharacters20180 +Node: Triple escaping for add-on commands20706 +Ref: #triple-escaping-for-add-on-commands20966 +Node: Less escaping21610 +Ref: #less-escaping21764 +Node: Unicode characters22088 +Ref: #unicode-characters22253 +Node: Regular expressions23752 +Ref: #regular-expressions23915 +Node: hledger's regular expressions27011 +Ref: #hledgers-regular-expressions27170 +Node: Argument files28556 +Ref: #argument-files28703 +Node: Config files29209 +Ref: #config-files29324 +Node: Output30500 +Ref: #output30602 +Node: Output destination30729 +Ref: #output-destination30860 +Node: Output format31285 +Ref: #output-format31431 +Node: CSV output33028 +Ref: #csv-output33144 +Node: HTML output33247 +Ref: #html-output33385 +Node: JSON output33479 +Ref: #json-output33617 +Node: SQL output34602 +Ref: #sql-output34718 +Node: Commodity styles35453 +Ref: #commodity-styles35593 +Node: Colour36331 +Ref: #colour36449 +Node: Box-drawing36853 +Ref: #box-drawing36971 +Node: Paging37255 +Ref: #paging37369 +Node: Debug output38322 +Ref: #debug-output38428 +Node: Environment39091 +Ref: #environment39215 +Node: PART 2 DATA FORMATS39782 +Ref: #part-2-data-formats39925 +Node: Journal39925 +Ref: #journal40034 +Node: Journal cheatsheet42402 +Ref: #journal-cheatsheet42529 +Node: Comments48616 +Ref: #comments48744 +Node: Transactions49560 +Ref: #transactions49683 +Node: Dates50697 +Ref: #dates50804 +Node: Simple dates50849 +Ref: #simple-dates50965 +Node: Posting dates51465 +Ref: #posting-dates51583 +Node: Status52552 +Ref: #status52653 +Node: Code54318 +Ref: #code54421 +Node: Description54653 +Ref: #description54784 +Node: Payee and note55340 +Ref: #payee-and-note55446 +Node: Transaction comments56431 +Ref: #transaction-comments56584 +Node: Postings56947 +Ref: #postings57078 +Node: Debits and credits58110 +Ref: #debits-and-credits58257 +Node: The two space delimiter58720 +Ref: #the-two-space-delimiter58877 +Node: Account names59285 +Ref: #account-names59415 +Node: Amounts61089 +Ref: #amounts61217 +Node: Decimal marks62118 +Ref: #decimal-marks62245 +Node: Digit group marks63222 +Ref: #digit-group-marks63375 +Node: Commodity63857 +Ref: #commodity63986 +Node: Costs64974 +Ref: #costs65069 +Node: Balance assertions67226 +Ref: #balance-assertions67379 +Node: Assertions and ordering68463 +Ref: #assertions-and-ordering68652 +Node: Assertions and multiple included files69191 +Ref: #assertions-and-multiple-included-files69451 +Node: Assertions and multiple -f files69951 +Ref: #assertions-and-multiple--f-files70196 +Node: Assertions and costs70593 +Ref: #assertions-and-costs70802 +Node: Assertions and commodities71243 +Ref: #assertions-and-commodities71458 +Node: Assertions and subaccounts72902 +Ref: #assertions-and-subaccounts73128 +Node: Assertions and virtual postings73572 +Ref: #assertions-and-virtual-postings73810 +Node: Assertions and auto postings73942 +Ref: #assertions-and-auto-postings74172 +Node: Assertions and precision74817 +Ref: #assertions-and-precision74999 +Node: Posting comments75266 +Ref: #posting-comments75429 +Node: Transaction balancing75806 +Ref: #transaction-balancing75965 +Node: Tags77808 +Ref: #tags77927 +Node: Tag names79270 +Ref: #tag-names79377 +Node: Special tags79765 +Ref: #special-tags79897 +Node: Tag values81410 +Ref: #tag-values81520 +Node: Directives82392 +Ref: #directives82519 +Node: Directives and multiple files83849 +Ref: #directives-and-multiple-files84027 +Node: Directive effects84794 +Ref: #directive-effects84948 +Node: account directive87950 +Ref: #account-directive88106 +Node: Account comments89400 +Ref: #account-comments89551 +Node: Account error checking90059 +Ref: #account-error-checking90252 +Node: Account display order91441 +Ref: #account-display-order91629 +Node: Account types92639 +Ref: #account-types92780 +Node: alias directive96413 +Ref: #alias-directive96574 +Node: Basic aliases97624 +Ref: #basic-aliases97755 +Node: Regex aliases98499 +Ref: #regex-aliases98656 +Node: Combining aliases99546 +Ref: #combining-aliases99724 +Node: Aliases and multiple files101000 +Ref: #aliases-and-multiple-files101204 +Node: end aliases directive101783 +Ref: #end-aliases-directive102002 +Node: Aliases can generate bad account names102151 +Ref: #aliases-can-generate-bad-account-names102399 +Node: Aliases and account types102984 +Ref: #aliases-and-account-types103176 +Node: commodity directive103872 +Ref: #commodity-directive104046 +Node: Commodity directive syntax105459 +Ref: #commodity-directive-syntax105644 +Node: Commodity error checking107095 +Ref: #commodity-error-checking107276 +Node: decimal-mark directive107570 +Ref: #decimal-mark-directive107752 +Node: include directive108149 +Ref: #include-directive108313 +Node: P directive109225 +Ref: #p-directive109370 +Node: payee directive110259 +Ref: #payee-directive110408 +Node: tag directive110881 +Ref: #tag-directive111036 +Node: Periodic transactions111493 +Ref: #periodic-transactions111658 +Node: Periodic rule syntax113647 +Ref: #periodic-rule-syntax113825 +Node: Periodic rules and relative dates114470 +Ref: #periodic-rules-and-relative-dates114736 +Node: Two spaces between period expression and description!115247 +Ref: #two-spaces-between-period-expression-and-description115524 +Node: Auto postings116208 +Ref: #auto-postings116356 +Node: Auto postings and multiple files119368 +Ref: #auto-postings-and-multiple-files119564 +Node: Auto postings and dates119773 +Ref: #auto-postings-and-dates120039 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions120214 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions120557 +Node: Auto posting tags121060 +Ref: #auto-posting-tags121319 +Node: Auto postings on forecast transactions only121955 +Ref: #auto-postings-on-forecast-transactions-only122178 +Node: Other syntax122425 +Ref: #other-syntax122541 +Node: Balance assignments123197 +Ref: #balance-assignments123353 +Node: Balance assignments and costs124725 +Ref: #balance-assignments-and-costs124937 +Node: Balance assignments and multiple files125147 +Ref: #balance-assignments-and-multiple-files125377 +Node: Bracketed posting dates125570 +Ref: #bracketed-posting-dates125754 +Node: D directive126268 +Ref: #d-directive126436 +Node: apply account directive128041 +Ref: #apply-account-directive128221 +Node: Y directive128908 +Ref: #y-directive129068 +Node: Secondary dates129896 +Ref: #secondary-dates130050 +Node: Star comments131381 +Ref: #star-comments131541 +Node: Valuation expressions132073 +Ref: #valuation-expressions132250 +Node: Virtual postings132372 +Ref: #virtual-postings132549 +Node: Other Ledger directives133996 +Ref: #other-ledger-directives134192 +Node: Other cost/lot notations134758 +Ref: #other-costlot-notations134931 +Node: CSV137520 +Ref: #csv137611 +Node: CSV rules cheatsheet139603 +Ref: #csv-rules-cheatsheet139730 +Node: source141528 +Ref: #source141649 +Node: separator142529 +Ref: #separator142640 +Node: skip143180 +Ref: #skip143286 +Node: date-format143830 +Ref: #date-format143949 +Node: timezone144673 +Ref: #timezone144794 +Node: newest-first145799 +Ref: #newest-first145935 +Node: intra-day-reversed146512 +Ref: #intra-day-reversed146664 +Node: decimal-mark147112 +Ref: #decimal-mark147251 +Node: fields list147590 +Ref: #fields-list147727 +Node: Field assignment149398 +Ref: #field-assignment149540 +Node: Field names150617 +Ref: #field-names150746 +Node: date field151949 +Ref: #date-field152065 +Node: date2 field152113 +Ref: #date2-field152252 +Node: status field152308 +Ref: #status-field152449 +Node: code field152498 +Ref: #code-field152641 +Node: description field152686 +Ref: #description-field152844 +Node: comment field152903 +Ref: #comment-field153056 +Node: account field153349 +Ref: #account-field153497 +Node: amount field154067 +Ref: #amount-field154214 +Node: currency field156906 +Ref: #currency-field157057 +Node: balance field157314 +Ref: #balance-field157444 +Node: if block157837 +Ref: #if-block157956 +Node: Matchers159364 +Ref: #matchers159476 +Node: What matchers match160273 +Ref: #what-matchers-match160420 +Node: Combining matchers160860 +Ref: #combining-matchers161026 +Node: Match groups161563 +Ref: #match-groups161689 +Node: if table162457 +Ref: #if-table162577 +Node: balance-type164458 +Ref: #balance-type164585 +Node: include165285 +Ref: #include165410 +Node: Working with CSV165854 +Ref: #working-with-csv165999 +Node: Rapid feedback166406 +Ref: #rapid-feedback166537 +Node: Valid CSV166989 +Ref: #valid-csv167133 +Node: File Extension167865 +Ref: #file-extension168036 +Node: Reading CSV from standard input168600 +Ref: #reading-csv-from-standard-input168822 +Node: Reading multiple CSV files168986 +Ref: #reading-multiple-csv-files169215 +Node: Reading files specified by rule169462 +Ref: #reading-files-specified-by-rule169688 +Node: Valid transactions170859 +Ref: #valid-transactions171056 +Node: Deduplicating importing171684 +Ref: #deduplicating-importing171877 +Node: Setting amounts172913 +Ref: #setting-amounts173082 +Node: Amount signs175440 +Ref: #amount-signs175608 +Node: Setting currency/commodity176505 +Ref: #setting-currencycommodity176707 +Node: Amount decimal places177881 +Ref: #amount-decimal-places178085 +Node: Referencing other fields179138 +Ref: #referencing-other-fields179349 +Node: How CSV rules are evaluated180246 +Ref: #how-csv-rules-are-evaluated180461 +Node: Well factored rules181914 +Ref: #well-factored-rules182080 +Node: CSV rules examples182404 +Ref: #csv-rules-examples182537 +Node: Bank of Ireland182602 +Ref: #bank-of-ireland182737 +Node: Coinbase184199 +Ref: #coinbase184335 +Node: Amazon185382 +Ref: #amazon185505 +Node: Paypal187224 +Ref: #paypal187330 +Node: Timeclock194974 +Ref: #timeclock195079 +Node: Timedot197255 +Ref: #timedot197378 +Node: Timedot examples200499 +Ref: #timedot-examples200605 +Node: PART 3 REPORTING CONCEPTS202776 +Ref: #part-3-reporting-concepts202940 +Node: Time periods202940 +Ref: #time-periods203074 +Node: Report start & end date203192 +Ref: #report-start-end-date203344 +Node: Smart dates204668 +Ref: #smart-dates204821 +Node: Report intervals206611 +Ref: #report-intervals206766 +Node: Date adjustment207184 +Ref: #date-adjustment207344 +Node: Period expressions208195 +Ref: #period-expressions208336 +Node: Period expressions with a report interval210100 +Ref: #period-expressions-with-a-report-interval210334 +Node: More complex report intervals210548 +Ref: #more-complex-report-intervals210793 +Node: Multiple weekday intervals212654 +Ref: #multiple-weekday-intervals212843 +Node: Depth213665 +Ref: #depth213767 +Node: Queries214063 +Ref: #queries214165 +Node: Query types215761 +Ref: #query-types215882 +Node: Combining query terms219116 +Ref: #combining-query-terms219293 +Node: Queries and command options220856 +Ref: #queries-and-command-options221061 +Node: Queries and account aliases221310 +Ref: #queries-and-account-aliases221515 +Node: Queries and valuation221635 +Ref: #queries-and-valuation221792 +Node: Pivoting221997 +Ref: #pivoting222111 +Node: Generating data223888 +Ref: #generating-data224020 +Node: Forecasting225688 +Ref: #forecasting225813 +Node: --forecast226344 +Ref: #forecast226475 +Node: Inspecting forecast transactions227445 +Ref: #inspecting-forecast-transactions227647 +Node: Forecast reports228777 +Ref: #forecast-reports228950 +Node: Forecast tags229886 +Ref: #forecast-tags230046 +Node: Forecast period in detail230506 +Ref: #forecast-period-in-detail230700 +Node: Forecast troubleshooting231594 +Ref: #forecast-troubleshooting231762 +Node: Budgeting232665 +Ref: #budgeting232788 +Node: Amount formatting233225 +Ref: #amount-formatting233367 +Node: Commodity display style233469 +Ref: #commodity-display-style233623 +Node: Rounding235310 +Ref: #rounding235465 +Node: Trailing decimal marks235915 +Ref: #trailing-decimal-marks236094 +Node: Amount parseability236848 +Ref: #amount-parseability237004 +Node: Cost reporting238429 +Ref: #cost-reporting238571 +Node: Recording costs239232 +Ref: #recording-costs239368 +Node: Reporting at cost240959 +Ref: #reporting-at-cost241134 +Node: Equity conversion postings241724 +Ref: #equity-conversion-postings241938 +Node: Inferring equity conversion postings244369 +Ref: #inferring-equity-conversion-postings244632 +Node: Combining costs and equity conversion postings245384 +Ref: #combining-costs-and-equity-conversion-postings245694 +Node: Requirements for detecting equity conversion postings246609 +Ref: #requirements-for-detecting-equity-conversion-postings246931 +Node: Infer cost and equity by default ?248131 +Ref: #infer-cost-and-equity-by-default248360 +Node: Value reporting248568 +Ref: #value-reporting248710 +Node: -V Value249449 +Ref: #v-value249581 +Node: -X Value in specified commodity249776 +Ref: #x-value-in-specified-commodity249977 +Node: Valuation date250126 +Ref: #valuation-date250303 +Node: Finding market price251086 +Ref: #finding-market-price251297 +Node: --infer-market-prices market prices from transactions252466 +Ref: #infer-market-prices-market-prices-from-transactions252748 +Node: Valuation commodity255510 +Ref: #valuation-commodity255730 +Node: --value Flexible valuation256943 +Ref: #value-flexible-valuation257142 +Node: Valuation examples258786 +Ref: #valuation-examples258986 +Node: Interaction of valuation and queries260918 +Ref: #interaction-of-valuation-and-queries261158 +Node: Effect of valuation on reports261635 +Ref: #effect-of-valuation-on-reports261838 +Node: PART 4 COMMANDS269533 +Ref: #part-4-commands269676 +Node: Help commands271749 +Ref: #help-commands271894 +Node: help271922 +Ref: #help272011 +Node: demo273599 +Ref: #demo273688 +Node: User interface commands274732 +Ref: #user-interface-commands274901 +Node: ui274926 +Ref: #ui275018 +Node: web275051 +Ref: #web275145 +Node: Data entry commands275179 +Ref: #data-entry-commands275348 +Node: add275377 +Ref: #add275471 +Node: import277932 +Ref: #import278032 +Node: Date skipping279193 +Ref: #date-skipping279316 +Node: Import testing282094 +Ref: #import-testing282257 +Node: Importing balance assignments283100 +Ref: #importing-balance-assignments283307 +Node: Import and commodity styles283956 +Ref: #import-and-commodity-styles284136 +Node: Basic report commands284365 +Ref: #basic-report-commands284539 +Node: accounts284666 +Ref: #accounts284776 +Node: codes287539 +Ref: #codes287663 +Node: commodities288561 +Ref: #commodities288701 +Node: descriptions288805 +Ref: #descriptions288947 +Node: files289272 +Ref: #files289394 +Node: notes289569 +Ref: #notes289685 +Node: payees290081 +Ref: #payees290200 +Node: prices290865 +Ref: #prices290984 +Node: stats291757 +Ref: #stats291872 +Node: tags293498 +Ref: #tags-1293598 +Node: Standard report commands294805 +Ref: #standard-report-commands294990 +Node: print295110 +Ref: #print295218 +Node: print explicitness297556 +Ref: #print-explicitness297697 +Node: print amount style298476 +Ref: #print-amount-style298644 +Node: print parseability299714 +Ref: #print-parseability299884 +Node: print other features300633 +Ref: #print-other-features300810 +Node: print output format301331 +Ref: #print-output-format301477 +Node: aregister304616 +Ref: #aregister304749 +Node: aregister and posting dates308396 +Ref: #aregister-and-posting-dates308541 +Node: register309297 +Ref: #register309435 +Node: Custom register output315600 +Ref: #custom-register-output315729 +Node: balancesheet317076 +Ref: #balancesheet317231 +Node: balancesheetequity321712 +Ref: #balancesheetequity321879 +Node: cashflow326718 +Ref: #cashflow326868 +Node: incomestatement331146 +Ref: #incomestatement331283 +Node: Advanced report commands335610 +Ref: #advanced-report-commands335788 +Node: balance335818 +Ref: #balance335926 +Node: balance features340701 +Ref: #balance-features340841 +Node: Simple balance report342751 +Ref: #simple-balance-report342936 +Node: Balance report line format344561 +Ref: #balance-report-line-format344763 +Node: Filtered balance report346921 +Ref: #filtered-balance-report347113 +Node: List or tree mode347440 +Ref: #list-or-tree-mode347608 +Node: Depth limiting348953 +Ref: #depth-limiting349119 +Node: Dropping top-level accounts349720 +Ref: #dropping-top-level-accounts349920 +Node: Showing declared accounts350230 +Ref: #showing-declared-accounts350429 +Node: Sorting by amount350960 +Ref: #sorting-by-amount351127 +Node: Percentages351797 +Ref: #percentages351956 +Node: Multi-period balance report352504 +Ref: #multi-period-balance-report352704 +Node: Balance change end balance355256 +Ref: #balance-change-end-balance355465 +Node: Balance report types356893 +Ref: #balance-report-types357074 +Node: Calculation type357572 +Ref: #calculation-type357727 +Node: Accumulation type358276 +Ref: #accumulation-type358456 +Node: Valuation type359377 +Ref: #valuation-type359565 +Node: Combining balance report types360566 +Ref: #combining-balance-report-types360760 +Node: Budget report362598 +Ref: #budget-report362760 +Node: Using the budget report364903 +Ref: #using-the-budget-report365076 +Node: Budget date surprises367179 +Ref: #budget-date-surprises367379 +Node: Selecting budget goals368543 +Ref: #selecting-budget-goals368746 +Node: Budgeting vs forecasting369491 +Ref: #budgeting-vs-forecasting369668 +Node: Balance report layout371168 +Ref: #balance-report-layout371353 +Node: Wide layout372306 +Ref: #wide-layout372441 +Node: Tall layout374711 +Ref: #tall-layout374866 +Node: Bare layout376017 +Ref: #bare-layout376172 +Node: Tidy layout378081 +Ref: #tidy-layout378216 +Node: Some useful balance reports379625 +Ref: #some-useful-balance-reports379800 +Node: roi380885 +Ref: #roi380985 +Node: Spaces and special characters in --inv and --pnl383132 +Ref: #spaces-and-special-characters-in---inv-and---pnl383370 +Node: Semantics of --inv and --pnl383858 +Ref: #semantics-of---inv-and---pnl384095 +Node: IRR and TWR explained385945 +Ref: #irr-and-twr-explained386103 +Node: Chart commands389356 +Ref: #chart-commands389514 +Node: activity389537 +Ref: #activity389626 +Node: Data generation commands390034 +Ref: #data-generation-commands390208 +Node: close390240 +Ref: #close390346 +Node: close --migrate392832 +Ref: #close---migrate392957 +Node: close --close394596 +Ref: #close---close394738 +Node: close --open394974 +Ref: #close---open395113 +Node: close --assert395223 +Ref: #close---assert395367 +Node: close --assign395588 +Ref: #close---assign395734 +Node: close --retain396260 +Ref: #close---retain396411 +Node: close customisation397156 +Ref: #close-customisation397333 +Node: close and balance assertions398800 +Ref: #close-and-balance-assertions398995 +Node: close examples400322 +Ref: #close-examples400461 +Node: Retain earnings400559 +Ref: #retain-earnings400716 +Node: Migrate balances to a new file401062 +Ref: #migrate-balances-to-a-new-file401286 +Node: More detailed close examples402414 +Ref: #more-detailed-close-examples402610 +Node: rewrite402636 +Ref: #rewrite402746 +Node: Re-write rules in a file405208 +Ref: #re-write-rules-in-a-file405369 +Node: Diff output format406518 +Ref: #diff-output-format406699 +Node: rewrite vs print --auto407791 +Ref: #rewrite-vs.-print---auto407949 +Node: Maintenance commands408505 +Ref: #maintenance-commands408676 +Node: check408714 +Ref: #check408813 +Node: Basic checks409796 +Ref: #basic-checks409914 +Node: Strict checks410749 +Ref: #strict-checks410890 +Node: Other checks411624 +Ref: #other-checks411764 +Node: Custom checks413479 +Ref: #custom-checks413599 +Node: diff413934 +Ref: #diff414044 +Node: test415141 +Ref: #test415237 +Node: PART 5 COMMON TASKS416013 +Ref: #part-5-common-tasks416172 +Node: Getting help416246 +Ref: #getting-help416395 +Node: Constructing command lines417155 +Ref: #constructing-command-lines417336 +Node: Starting a journal file417993 +Ref: #starting-a-journal-file418175 +Node: Setting LEDGER_FILE419377 +Ref: #setting-ledger_file419549 +Node: Setting opening balances420506 +Ref: #setting-opening-balances420687 +Node: Recording transactions423828 +Ref: #recording-transactions423997 +Node: Reconciling424553 +Ref: #reconciling424685 +Node: Reporting426942 +Ref: #reporting427071 +Node: Migrating to a new file431056 +Ref: #migrating-to-a-new-file431206 +Node: BUGS431505 +Ref: #bugs431599 +Node: Troubleshooting432478 +Ref: #troubleshooting432578  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 7cd2ccfac..81532c061 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -332,7 +332,7 @@ Options --info show the manual with info --man show the manual with man --version show version information - --debug=[1-9] show this level of debug output (default: 1) + --debug=[1-9] show this much debug output (default: 1) Usually hledger accepts any unambiguous flag prefix, eg you can write --tl instead of --tldr or --dry instead of --dry-run. @@ -568,26 +568,26 @@ Options Argument files are now superseded by.. Config files - hledger looks for a hledger.conf file (or .hledger.conf in your home - directory) in the current directory, then parent directories, then your - XDG config directory (~/.config/hledger/). Any command line options - (or arguments) in this file will be added to your hledger commands, - near the start of the command line (so you can override them when - needed). + hledger will read extra command line options from a hledger.conf config + file. These will be inserted early in the command line, so your later + options can override them if needed. The config file can contain gen- + eral options (which will be used with all commands that support them), + and command-specific options (or arguments). hledger.conf.sample is an + example, which you can install as ./hledger.conf or + $HOME/.hledger.conf. - Or you can specify a config file with the --conf option. Or you can - add a hledger --conf shebang line to a config file and make it exe- - cutable. + To be precise, hledger looks for hledger.conf in the current directory + or above, or in your home directory (with a dotted name, + ~/.hledger.conf), or finally in your XDG config directory (~/.con- + fig/hledger/hledger.conf). Or you can select a particular config file + by using the --conf option, or by adding a hledger --conf shebang line + to a config file and executing it like a script (see the example file). + You can inspect the finding and processing of config files with --debug + or --debug=8. - A hledger config file contains command line options, to be used with - all commands that support them, and optionally command-specific options - in named sections. hledger.conf.sample is a sample demonstrating the - syntax; you can install it as ./hledger.conf or $HOME/.hledger.conf and - customise it. - - You can disable config files entirely by running with the -n/--no-conf - flag. This will ensure hledger runs with standard defaults, useful - when troubleshooting or when sharing examples with others. + If you want to run hledger without a config file, to ensure standard + defaults and behaviour, use the -n/--no-conf flag. This is useful when + troubleshooting problems or sharing examples. (Added in 1.40; experimental)