From 24c6828a5c53315dd2aafe1636b5d90f6da54fa1 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 25 Jan 2020 17:10:34 -0800 Subject: [PATCH] ;doc: regen manuals [ci skip] --- hledger-lib/hledger_csv.info | 126 ++-- hledger-lib/hledger_journal.info | 232 +++--- hledger-lib/hledger_timeclock.info | 14 +- hledger-lib/hledger_timedot.5 | 1 - hledger-lib/hledger_timedot.info | 24 +- hledger-lib/hledger_timedot.txt | 1 - hledger-ui/hledger-ui.1 | 6 +- hledger-ui/hledger-ui.info | 102 ++- hledger-ui/hledger-ui.txt | 8 +- hledger-web/hledger-web.1 | 6 +- hledger-web/hledger-web.info | 81 +- hledger-web/hledger-web.txt | 8 +- hledger/hledger.1 | 11 +- hledger/hledger.info | 484 +++++++----- hledger/hledger.txt | 1101 ++++++++++++++-------------- 15 files changed, 1227 insertions(+), 978 deletions(-) diff --git a/hledger-lib/hledger_csv.info b/hledger-lib/hledger_csv.info index 6b6892301..aa0430a14 100644 --- a/hledger-lib/hledger_csv.info +++ b/hledger-lib/hledger_csv.info @@ -6,10 +6,12 @@ File: hledger_csv.info, Node: Top, Next: EXAMPLES, Up: (dir) hledger_csv(5) hledger 1.16.99 ****************************** -hledger can read CSV (Comma Separated Value/Character Separated Value) -files as if they were journal files, automatically converting each CSV -record into a transaction. (To learn about _writing_ CSV, see CSV -output.) +CSV - how hledger reads CSV data, and the CSV rules file format + + hledger can read CSV (Comma Separated Value/Character Separated +Value) files as if they were journal files, automatically converting +each CSV record into a transaction. (To learn about _writing_ CSV, see +CSV output.) We describe each CSV file's format with a corresponding _rules file_. By default this is named like the CSV file with a '.rules' extension @@ -966,64 +968,64 @@ command the user specified.  Tag Table: Node: Top72 -Node: EXAMPLES2031 -Ref: #examples2137 -Node: Basic2345 -Ref: #basic2445 -Node: Bank of Ireland2987 -Ref: #bank-of-ireland3122 -Node: Amazon4585 -Ref: #amazon4703 -Node: Paypal6636 -Ref: #paypal6730 -Node: CSV RULES14613 -Ref: #csv-rules14722 -Node: skip14998 -Ref: #skip15091 -Node: fields15466 -Ref: #fields15588 -Node: Transaction field names16753 -Ref: #transaction-field-names16913 -Node: Posting field names17024 -Ref: #posting-field-names17176 -Node: field assignment18467 -Ref: #field-assignment18610 -Node: separator19428 -Ref: #separator19557 -Node: if19968 -Ref: #if20070 -Node: end21786 -Ref: #end21892 -Node: date-format22116 -Ref: #date-format22248 -Node: newest-first22997 -Ref: #newest-first23135 -Node: include23818 -Ref: #include23947 -Node: balance-type24391 -Ref: #balance-type24511 -Node: TIPS25211 -Ref: #tips25293 -Node: Rapid feedback25549 -Ref: #rapid-feedback25666 -Node: Valid CSV26126 -Ref: #valid-csv26256 -Node: File Extension26448 -Ref: #file-extension26600 -Node: Reading multiple CSV files27010 -Ref: #reading-multiple-csv-files27195 -Node: Valid transactions27436 -Ref: #valid-transactions27614 -Node: Deduplicating importing28242 -Ref: #deduplicating-importing28421 -Node: Setting amounts29454 -Ref: #setting-amounts29623 -Node: Setting currency/commodity30609 -Ref: #setting-currencycommodity30801 -Node: Referencing other fields31604 -Ref: #referencing-other-fields31804 -Node: How CSV rules are evaluated32701 -Ref: #how-csv-rules-are-evaluated32874 +Node: EXAMPLES2099 +Ref: #examples2205 +Node: Basic2413 +Ref: #basic2513 +Node: Bank of Ireland3055 +Ref: #bank-of-ireland3190 +Node: Amazon4653 +Ref: #amazon4771 +Node: Paypal6704 +Ref: #paypal6798 +Node: CSV RULES14681 +Ref: #csv-rules14790 +Node: skip15066 +Ref: #skip15159 +Node: fields15534 +Ref: #fields15656 +Node: Transaction field names16821 +Ref: #transaction-field-names16981 +Node: Posting field names17092 +Ref: #posting-field-names17244 +Node: field assignment18535 +Ref: #field-assignment18678 +Node: separator19496 +Ref: #separator19625 +Node: if20036 +Ref: #if20138 +Node: end21854 +Ref: #end21960 +Node: date-format22184 +Ref: #date-format22316 +Node: newest-first23065 +Ref: #newest-first23203 +Node: include23886 +Ref: #include24015 +Node: balance-type24459 +Ref: #balance-type24579 +Node: TIPS25279 +Ref: #tips25361 +Node: Rapid feedback25617 +Ref: #rapid-feedback25734 +Node: Valid CSV26194 +Ref: #valid-csv26324 +Node: File Extension26516 +Ref: #file-extension26668 +Node: Reading multiple CSV files27078 +Ref: #reading-multiple-csv-files27263 +Node: Valid transactions27504 +Ref: #valid-transactions27682 +Node: Deduplicating importing28310 +Ref: #deduplicating-importing28489 +Node: Setting amounts29522 +Ref: #setting-amounts29691 +Node: Setting currency/commodity30677 +Ref: #setting-currencycommodity30869 +Node: Referencing other fields31672 +Ref: #referencing-other-fields31872 +Node: How CSV rules are evaluated32769 +Ref: #how-csv-rules-are-evaluated32942  End Tag Table diff --git a/hledger-lib/hledger_journal.info b/hledger-lib/hledger_journal.info index b6455d771..7425605f7 100644 --- a/hledger-lib/hledger_journal.info +++ b/hledger-lib/hledger_journal.info @@ -7,7 +7,9 @@ File: hledger_journal.info, Node: Top, Next: FILE FORMAT, Up: (dir) hledger_journal(5) hledger 1.16.99 ********************************** -hledger's usual data source is a plain text file containing journal +Journal - hledger's default file format, representing a General Journal + + hledger's usual data source is a plain text file containing journal entries in hledger journal format. This file represents a standard accounting general journal. I use file names ending in '.journal', but that's not required. The journal file contains a number of transaction @@ -1752,120 +1754,120 @@ See the Editor configuration at hledger.org for the latest information.  Tag Table: Node: Top76 -Node: FILE FORMAT2358 -Ref: #file-format2482 -Node: Transactions2785 -Ref: #transactions2906 -Node: Postings3590 -Ref: #postings3717 -Node: Dates4712 -Ref: #dates4827 -Node: Simple dates4892 -Ref: #simple-dates5018 -Node: Secondary dates5384 -Ref: #secondary-dates5538 -Node: Posting dates7101 -Ref: #posting-dates7230 -Node: Status8602 -Ref: #status8722 -Node: Description10430 -Ref: #description10568 -Node: Payee and note10888 -Ref: #payee-and-note11002 -Node: Account names11337 -Ref: #account-names11480 -Node: Amounts11967 -Ref: #amounts12103 -Node: Digit group marks13036 -Ref: #digit-group-marks13185 -Node: Amount display format14123 -Ref: #amount-display-format14280 -Node: Virtual Postings15305 -Ref: #virtual-postings15464 -Node: Balance Assertions16684 -Ref: #balance-assertions16859 -Node: Assertions and ordering17892 -Ref: #assertions-and-ordering18078 -Node: Assertions and included files18778 -Ref: #assertions-and-included-files19019 -Node: Assertions and multiple -f options19352 -Ref: #assertions-and-multiple--f-options19606 -Node: Assertions and commodities19738 -Ref: #assertions-and-commodities19968 -Node: Assertions and prices21124 -Ref: #assertions-and-prices21336 -Node: Assertions and subaccounts21776 -Ref: #assertions-and-subaccounts22003 -Node: Assertions and virtual postings22327 -Ref: #assertions-and-virtual-postings22567 -Node: Assertions and precision22709 -Ref: #assertions-and-precision22900 -Node: Balance Assignments23167 -Ref: #balance-assignments23348 -Node: Balance assignments and prices24513 -Ref: #balance-assignments-and-prices24685 -Node: Transaction prices24909 -Ref: #transaction-prices25078 -Node: Comments27344 -Ref: #comments27478 -Node: Tags28648 -Ref: #tags28766 -Node: Directives30159 -Ref: #directives30302 -Node: Comment blocks35981 -Ref: #comment-blocks36126 -Node: Including other files36302 -Ref: #including-other-files36482 -Node: Default year36890 -Ref: #default-year37059 -Node: Declaring commodities37466 -Ref: #declaring-commodities37649 -Node: Default commodity39310 -Ref: #default-commodity39486 -Node: Market prices40120 -Ref: #market-prices40285 -Node: Declaring accounts41126 -Ref: #declaring-accounts41302 -Node: Account comments42227 -Ref: #account-comments42390 -Node: Account subdirectives42814 -Ref: #account-subdirectives43009 -Node: Account types43322 -Ref: #account-types43506 -Node: Account display order45148 -Ref: #account-display-order45318 -Node: Rewriting accounts46447 -Ref: #rewriting-accounts46632 -Node: Basic aliases47358 -Ref: #basic-aliases47504 -Node: Regex aliases48208 -Ref: #regex-aliases48380 -Node: Combining aliases49098 -Ref: #combining-aliases49276 -Node: end aliases50552 -Ref: #end-aliases50700 -Node: Default parent account50801 -Ref: #default-parent-account50967 -Node: Periodic transactions51851 -Ref: #periodic-transactions52049 -Node: Periodic rule syntax53921 -Ref: #periodic-rule-syntax54127 -Node: Two spaces between period expression and description!54831 -Ref: #two-spaces-between-period-expression-and-description55150 -Node: Forecasting with periodic transactions55834 -Ref: #forecasting-with-periodic-transactions56139 -Node: Budgeting with periodic transactions58165 -Ref: #budgeting-with-periodic-transactions58404 -Node: Auto postings / transaction modifiers58853 -Ref: #auto-postings-transaction-modifiers59064 -Node: Auto postings and dates61293 -Ref: #auto-postings-and-dates61550 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions61725 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions62100 -Node: Auto posting tags62478 -Ref: #auto-posting-tags62717 -Node: EDITOR SUPPORT63382 -Ref: #editor-support63500 +Node: FILE FORMAT2434 +Ref: #file-format2558 +Node: Transactions2861 +Ref: #transactions2982 +Node: Postings3666 +Ref: #postings3793 +Node: Dates4788 +Ref: #dates4903 +Node: Simple dates4968 +Ref: #simple-dates5094 +Node: Secondary dates5460 +Ref: #secondary-dates5614 +Node: Posting dates7177 +Ref: #posting-dates7306 +Node: Status8678 +Ref: #status8798 +Node: Description10506 +Ref: #description10644 +Node: Payee and note10964 +Ref: #payee-and-note11078 +Node: Account names11413 +Ref: #account-names11556 +Node: Amounts12043 +Ref: #amounts12179 +Node: Digit group marks13112 +Ref: #digit-group-marks13261 +Node: Amount display format14199 +Ref: #amount-display-format14356 +Node: Virtual Postings15381 +Ref: #virtual-postings15540 +Node: Balance Assertions16760 +Ref: #balance-assertions16935 +Node: Assertions and ordering17968 +Ref: #assertions-and-ordering18154 +Node: Assertions and included files18854 +Ref: #assertions-and-included-files19095 +Node: Assertions and multiple -f options19428 +Ref: #assertions-and-multiple--f-options19682 +Node: Assertions and commodities19814 +Ref: #assertions-and-commodities20044 +Node: Assertions and prices21200 +Ref: #assertions-and-prices21412 +Node: Assertions and subaccounts21852 +Ref: #assertions-and-subaccounts22079 +Node: Assertions and virtual postings22403 +Ref: #assertions-and-virtual-postings22643 +Node: Assertions and precision22785 +Ref: #assertions-and-precision22976 +Node: Balance Assignments23243 +Ref: #balance-assignments23424 +Node: Balance assignments and prices24589 +Ref: #balance-assignments-and-prices24761 +Node: Transaction prices24985 +Ref: #transaction-prices25154 +Node: Comments27420 +Ref: #comments27554 +Node: Tags28724 +Ref: #tags28842 +Node: Directives30235 +Ref: #directives30378 +Node: Comment blocks36057 +Ref: #comment-blocks36202 +Node: Including other files36378 +Ref: #including-other-files36558 +Node: Default year36966 +Ref: #default-year37135 +Node: Declaring commodities37542 +Ref: #declaring-commodities37725 +Node: Default commodity39386 +Ref: #default-commodity39562 +Node: Market prices40196 +Ref: #market-prices40361 +Node: Declaring accounts41202 +Ref: #declaring-accounts41378 +Node: Account comments42303 +Ref: #account-comments42466 +Node: Account subdirectives42890 +Ref: #account-subdirectives43085 +Node: Account types43398 +Ref: #account-types43582 +Node: Account display order45224 +Ref: #account-display-order45394 +Node: Rewriting accounts46523 +Ref: #rewriting-accounts46708 +Node: Basic aliases47434 +Ref: #basic-aliases47580 +Node: Regex aliases48284 +Ref: #regex-aliases48456 +Node: Combining aliases49174 +Ref: #combining-aliases49352 +Node: end aliases50628 +Ref: #end-aliases50776 +Node: Default parent account50877 +Ref: #default-parent-account51043 +Node: Periodic transactions51927 +Ref: #periodic-transactions52125 +Node: Periodic rule syntax53997 +Ref: #periodic-rule-syntax54203 +Node: Two spaces between period expression and description!54907 +Ref: #two-spaces-between-period-expression-and-description55226 +Node: Forecasting with periodic transactions55910 +Ref: #forecasting-with-periodic-transactions56215 +Node: Budgeting with periodic transactions58241 +Ref: #budgeting-with-periodic-transactions58480 +Node: Auto postings / transaction modifiers58929 +Ref: #auto-postings-transaction-modifiers59140 +Node: Auto postings and dates61369 +Ref: #auto-postings-and-dates61626 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions61801 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions62176 +Node: Auto posting tags62554 +Ref: #auto-posting-tags62793 +Node: EDITOR SUPPORT63458 +Ref: #editor-support63576  End Tag Table diff --git a/hledger-lib/hledger_timeclock.info b/hledger-lib/hledger_timeclock.info index 8872f4007..50cf76ff3 100644 --- a/hledger-lib/hledger_timeclock.info +++ b/hledger-lib/hledger_timeclock.info @@ -7,12 +7,14 @@ File: hledger_timeclock.info, Node: Top, Up: (dir) hledger_timeclock(5) hledger 1.16.99 ************************************ -hledger can read timeclock files. As with Ledger, these are (a subset -of) timeclock.el's format, containing clock-in and clock-out entries as -in the example below. The date is a simple date. The time format is -HH:MM[:SS][+-ZZZZ]. Seconds and timezone are optional. The timezone, if -present, must be four digits and is ignored (currently the time is -always interpreted as a local time). +Timeclock - the time logging format of timeclock.el, as read by hledger + + hledger can read timeclock files. As with Ledger, these are (a +subset of) timeclock.el's format, containing clock-in and clock-out +entries as in the example below. The date is a simple date. The time +format is HH:MM[:SS][+-ZZZZ]. Seconds and timezone are optional. The +timezone, if present, must be four digits and is ignored (currently the +time is always interpreted as a local time). i 2015/03/30 09:00:00 some:account name optional description after two spaces o 2015/03/30 09:20:00 diff --git a/hledger-lib/hledger_timedot.5 b/hledger-lib/hledger_timedot.5 index 36514800a..a97e14bdd 100644 --- a/hledger-lib/hledger_timedot.5 +++ b/hledger-lib/hledger_timedot.5 @@ -20,7 +20,6 @@ Though called \[dq]timedot\[dq], this format is read by hledger as commodityless quantities, so it could be used to represent dated quantities other than time. In the docs below we\[aq]ll assume it\[aq]s time. -.SH FILE FORMAT .PP A timedot file contains a series of day entries. A day entry begins with a date, and is followed by category/quantity diff --git a/hledger-lib/hledger_timedot.info b/hledger-lib/hledger_timedot.info index 39bf11804..7aa2682f5 100644 --- a/hledger-lib/hledger_timedot.info +++ b/hledger-lib/hledger_timedot.info @@ -2,14 +2,16 @@ This is hledger_timedot.info, produced by makeinfo version 6.7 from stdin.  -File: hledger_timedot.info, Node: Top, Next: FILE FORMAT, Up: (dir) +File: hledger_timedot.info, Node: Top, Up: (dir) hledger_timedot(5) hledger 1.16.99 ********************************** -Timedot is a plain text format for logging dated, categorised quantities -(of time, usually), supported by hledger. It is convenient for -approximate and retroactive time logging, eg when the real-time +Timedot - hledger's human-friendly time logging format + + Timedot is a plain text format for logging dated, categorised +quantities (of time, usually), supported by hledger. It is convenient +for approximate and retroactive time logging, eg when the real-time clock-in/out required with a timeclock file is too precise or too interruptive. It can be formatted like a bar chart, making clear at a glance where time was spent. @@ -18,17 +20,7 @@ glance where time was spent. commodityless quantities, so it could be used to represent dated quantities other than time. In the docs below we'll assume it's time. -* Menu: - -* FILE FORMAT:: - - -File: hledger_timedot.info, Node: FILE FORMAT, Prev: Top, Up: Top - -1 FILE FORMAT -************* - -A timedot file contains a series of day entries. A day entry begins + A timedot file contains a series of day entries. A day entry begins with a date, and is followed by category/quantity pairs, one per line. Dates are hledger-style simple dates (see hledger_journal(5)). Categories are hledger-style account names, optionally indented. As in @@ -111,8 +103,6 @@ $ hledger -f t.timedot --alias /\\./=: bal date:2016/2/4  Tag Table: Node: Top76 -Node: FILE FORMAT814 -Ref: #file-format915  End Tag Table diff --git a/hledger-lib/hledger_timedot.txt b/hledger-lib/hledger_timedot.txt index ef9a4a14b..76d8ec9b4 100644 --- a/hledger-lib/hledger_timedot.txt +++ b/hledger-lib/hledger_timedot.txt @@ -18,7 +18,6 @@ DESCRIPTION less quantities, so it could be used to represent dated quantities other than time. In the docs below we'll assume it's time. -FILE FORMAT A timedot file contains a series of day entries. A day entry begins with a date, and is followed by category/quantity pairs, one per line. Dates are hledger-style simple dates (see hledger_journal(5)). Cate- diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1 index 93b107a42..115194846 100644 --- a/hledger-ui/hledger-ui.1 +++ b/hledger-ui/hledger-ui.1 @@ -15,9 +15,9 @@ hledger-ui - terminal interface for the hledger accounting tool \f[C]hledger ui -- [OPTIONS] [QUERYARGS]\f[R] .SH DESCRIPTION .PP -hledger is a cross-platform program for tracking money, time, or any -other commodity, using double-entry accounting and a simple, editable -file format. +hledger is a reliable, cross-platform set of programs for tracking +money, time, or any other commodity, using double-entry accounting and a +simple, editable file format. hledger is inspired by and largely compatible with ledger(1). .PP hledger-ui is hledger\[aq]s terminal interface, providing an efficient diff --git a/hledger-ui/hledger-ui.info b/hledger-ui/hledger-ui.info index 3d8085f1e..a67d0d3eb 100644 --- a/hledger-ui/hledger-ui.info +++ b/hledger-ui/hledger-ui.info @@ -6,7 +6,17 @@ File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir) hledger-ui(1) hledger-ui 1.16.99 ******************************** -hledger-ui is hledger's terminal interface, providing an efficient +hledger-ui - terminal interface for the hledger accounting tool + + 'hledger-ui [OPTIONS] [QUERYARGS]' +'hledger ui -- [OPTIONS] [QUERYARGS]' + + hledger is a reliable, cross-platform set of programs for tracking +money, time, or any other commodity, using double-entry accounting and a +simple, editable file format. hledger is inspired by and largely +compatible with ledger(1). + + hledger-ui is hledger's terminal interface, providing an efficient full-window text UI for viewing accounts and transactions, and some limited data entry capability. It is easier than hledger's command-line interface, and sometimes quicker and more convenient than the web @@ -30,6 +40,9 @@ hledger_journal(5) etc. * OPTIONS:: * KEYS:: * SCREENS:: +* ENVIRONMENT:: +* FILES:: +* BUGS::  File: hledger-ui.info, Node: OPTIONS, Next: KEYS, Prev: Top, Up: Top @@ -278,7 +291,7 @@ exit the transaction screen. Additional screen-specific keys are described below.  -File: hledger-ui.info, Node: SCREENS, Prev: KEYS, Up: Top +File: hledger-ui.info, Node: SCREENS, Next: ENVIRONMENT, Prev: KEYS, Up: Top 3 SCREENS ********* @@ -421,23 +434,80 @@ when you press g to reload. Once you have fixed the problem, press g again to reload and resume normal operation. (Or, you can press escape to cancel the reload attempt.) + +File: hledger-ui.info, Node: ENVIRONMENT, Next: FILES, Prev: SCREENS, Up: Top + +4 ENVIRONMENT +************* + +*COLUMNS* The screen width to use. Default: the full terminal width. + + *LEDGER_FILE* The journal file path when not specified with '-f'. +Default: '~/.hledger.journal' (on windows, perhaps +'C:/Users/USER/.hledger.journal'). + + +File: hledger-ui.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top + +5 FILES +******* + +Reads data from one or more files in hledger journal, timeclock, +timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or +'$HOME/.hledger.journal' (on windows, perhaps +'C:/Users/USER/.hledger.journal'). + + +File: hledger-ui.info, Node: BUGS, Prev: FILES, Up: Top + +6 BUGS +****** + +The need to precede options with '--' when invoked from hledger is +awkward. + + '-f-' doesn't work (hledger-ui can't read from stdin). + + '-V' affects only the accounts screen. + + When you press 'g', the current and all previous screens are +regenerated, which may cause a noticeable pause with large files. Also +there is no visual indication that this is in progress. + + '--watch' is not yet fully robust. It works well for normal usage, +but many file changes in a short time (eg saving the file thousands of +times with an editor macro) can cause problems at least on OSX. Symptoms +include: unresponsive UI, periodic resetting of the cursor position, +momentary display of parse errors, high CPU usage eventually subsiding, +and possibly a small but persistent build-up of CPU usage until the +program is restarted. + + Also, if you are viewing files mounted from another machine, +'--watch' requires that both machine clocks are roughly in step. +  Tag Table: Node: Top71 -Node: OPTIONS1103 -Ref: #options1200 -Node: KEYS4636 -Ref: #keys4731 -Node: SCREENS9038 -Ref: #screens9123 -Node: Accounts screen9213 -Ref: #accounts-screen9341 -Node: Register screen11557 -Ref: #register-screen11712 -Node: Transaction screen13708 -Ref: #transaction-screen13866 -Node: Error screen14736 -Ref: #error-screen14858 +Node: OPTIONS1520 +Ref: #options1617 +Node: KEYS5053 +Ref: #keys5148 +Node: SCREENS9455 +Ref: #screens9560 +Node: Accounts screen9650 +Ref: #accounts-screen9778 +Node: Register screen11994 +Ref: #register-screen12149 +Node: Transaction screen14145 +Ref: #transaction-screen14303 +Node: Error screen15173 +Ref: #error-screen15295 +Node: ENVIRONMENT15539 +Ref: #environment15653 +Node: FILES15880 +Ref: #files15979 +Node: BUGS16192 +Ref: #bugs16269  End Tag Table diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt index 8f49fa3c7..8ffe6ab1d 100644 --- a/hledger-ui/hledger-ui.txt +++ b/hledger-ui/hledger-ui.txt @@ -11,10 +11,10 @@ SYNOPSIS hledger ui -- [OPTIONS] [QUERYARGS] DESCRIPTION - hledger is a cross-platform program for tracking money, time, or any - other commodity, using double-entry accounting and a simple, editable - file format. hledger is inspired by and largely compatible with - ledger(1). + hledger is a reliable, cross-platform set of programs for tracking + money, time, or any other commodity, using double-entry accounting and + a simple, editable file format. hledger is inspired by and largely + compatible with ledger(1). hledger-ui is hledger's terminal interface, providing an efficient full-window text UI for viewing accounts and transactions, and some diff --git a/hledger-web/hledger-web.1 b/hledger-web/hledger-web.1 index d95a550b9..2a68a72a6 100644 --- a/hledger-web/hledger-web.1 +++ b/hledger-web/hledger-web.1 @@ -15,9 +15,9 @@ hledger-web - web interface for the hledger accounting tool \f[C]hledger web -- [OPTIONS]\f[R] .SH DESCRIPTION .PP -hledger is a cross-platform program for tracking money, time, or any -other commodity, using double-entry accounting and a simple, editable -file format. +hledger is a reliable, cross-platform set of programs for tracking +money, time, or any other commodity, using double-entry accounting and a +simple, editable file format. hledger is inspired by and largely compatible with ledger(1). .PP hledger-web is hledger\[aq]s web interface. diff --git a/hledger-web/hledger-web.info b/hledger-web/hledger-web.info index 4841020a7..326a762f8 100644 --- a/hledger-web/hledger-web.info +++ b/hledger-web/hledger-web.info @@ -6,7 +6,17 @@ File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir) hledger-web(1) hledger-web 1.16.99 ********************************** -hledger-web is hledger's web interface. It starts a simple web +hledger-web - web interface for the hledger accounting tool + + 'hledger-web [OPTIONS]' +'hledger web -- [OPTIONS]' + + hledger is a reliable, cross-platform set of programs for tracking +money, time, or any other commodity, using double-entry accounting and a +simple, editable file format. hledger is inspired by and largely +compatible with ledger(1). + + hledger-web is hledger's web interface. It starts a simple web application for browsing and adding transactions, and optionally opens it in a web browser window if possible. It provides a more user-friendly UI than the hledger CLI or hledger-ui interface, showing @@ -33,6 +43,9 @@ hledger_journal(5) etc. * EDITING UPLOADING DOWNLOADING:: * RELOADING:: * JSON API:: +* ENVIRONMENT:: +* FILES:: +* BUGS::  File: hledger-web.info, Node: OPTIONS, Next: PERMISSIONS, Prev: Top, Up: Top @@ -311,7 +324,7 @@ file has been fixed. sure that both machine clocks are roughly in step.)  -File: hledger-web.info, Node: JSON API, Prev: RELOADING, Up: Top +File: hledger-web.info, Node: JSON API, Next: ENVIRONMENT, Prev: RELOADING, Up: Top 5 JSON API ********** @@ -356,19 +369,63 @@ $ curl -s http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' - Running with '--serve-api' disables the former, useful if you only want to serve the API. + +File: hledger-web.info, Node: ENVIRONMENT, Next: FILES, Prev: JSON API, Up: Top + +6 ENVIRONMENT +************* + +*LEDGER_FILE* The journal file path when not specified with '-f'. +Default: '~/.hledger.journal' (on windows, perhaps +'C:/Users/USER/.hledger.journal'). + + +File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top + +7 FILES +******* + +Reads data from one or more files in hledger journal, timeclock, +timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or +'$HOME/.hledger.journal' (on windows, perhaps +'C:/Users/USER/.hledger.journal'). + + +File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top + +8 BUGS +****** + +The need to precede options with '--' when invoked from hledger is +awkward. + + '-f-' doesn't work (hledger-web can't read from stdin). + + Query arguments and some hledger options are ignored. + + Does not work in text-mode browsers. + + Does not work well on small screens. +  Tag Table: Node: Top72 -Node: OPTIONS1361 -Ref: #options1466 -Node: PERMISSIONS7739 -Ref: #permissions7878 -Node: EDITING UPLOADING DOWNLOADING9090 -Ref: #editing-uploading-downloading9271 -Node: RELOADING10105 -Ref: #reloading10239 -Node: JSON API10672 -Ref: #json-api10766 +Node: OPTIONS1752 +Ref: #options1857 +Node: PERMISSIONS8130 +Ref: #permissions8269 +Node: EDITING UPLOADING DOWNLOADING9481 +Ref: #editing-uploading-downloading9662 +Node: RELOADING10496 +Ref: #reloading10630 +Node: JSON API11063 +Ref: #json-api11177 +Node: ENVIRONMENT12618 +Ref: #environment12734 +Node: FILES12887 +Ref: #files12987 +Node: BUGS13200 +Ref: #bugs13278  End Tag Table diff --git a/hledger-web/hledger-web.txt b/hledger-web/hledger-web.txt index 5897beec5..629169e17 100644 --- a/hledger-web/hledger-web.txt +++ b/hledger-web/hledger-web.txt @@ -11,10 +11,10 @@ SYNOPSIS hledger web -- [OPTIONS] DESCRIPTION - hledger is a cross-platform program for tracking money, time, or any - other commodity, using double-entry accounting and a simple, editable - file format. hledger is inspired by and largely compatible with - ledger(1). + hledger is a reliable, cross-platform set of programs for tracking + money, time, or any other commodity, using double-entry accounting and + a simple, editable file format. hledger is inspired by and largely + compatible with ledger(1). hledger-web is hledger's web interface. It starts a simple web appli- cation for browsing and adding transactions, and optionally opens it in diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 3aae72968..e902c2555 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -20,15 +20,10 @@ hledger - a command-line accounting tool \f[C]hledger\f[R] .SH DESCRIPTION .PP -hledger is a cross-platform program for tracking money, time, or any -other commodity, using double-entry accounting and a simple, editable -file format. +hledger is a reliable, cross-platform set of programs for tracking +money, time, or any other commodity, using double-entry accounting and a +simple, editable file format. hledger is inspired by and largely compatible with ledger(1). -.PD 0 -.P -.PD -Tested on unix, mac, windows, hledger aims to be a reliable, practical -tool for daily use. .PP This is hledger\[cq]s command-line interface (there are also terminal and web interfaces). diff --git a/hledger/hledger.info b/hledger/hledger.info index 031b9630d..b38c496c2 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -6,7 +6,18 @@ File: hledger.info, Node: Top, Next: EXAMPLES, Up: (dir) hledger(1) hledger 1.16.99 ************************** -This is hledger's command-line interface (there are also terminal and +hledger - a command-line accounting tool + + 'hledger [-f FILE] COMMAND [OPTIONS] [ARGS]' +'hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]' +'hledger' + + hledger is a reliable, cross-platform set of programs for tracking +money, time, or any other commodity, using double-entry accounting and a +simple, editable file format. hledger is inspired by and largely +compatible with ledger(1). + + This is hledger's command-line interface (there are also terminal and web interfaces). Its basic function is to read a plain text file describing financial transactions (in accounting terms, a general journal) and print useful reports on standard output, or export them as @@ -48,6 +59,10 @@ try some commands like 'hledger print' or 'hledger balance'. Run * QUERIES:: * COMMANDS:: * ADD-ON COMMANDS:: +* ENVIRONMENT:: +* FILES:: +* LIMITATIONS:: +* TROUBLESHOOTING::  File: hledger.info, Node: EXAMPLES, Next: OPTIONS, Prev: Top, Up: Top @@ -3080,7 +3095,7 @@ $ hledger test -- -pData.Amount --color=never ('-- --help' currently doesn't show them).  -File: hledger.info, Node: ADD-ON COMMANDS, Prev: COMMANDS, Up: Top +File: hledger.info, Node: ADD-ON COMMANDS, Next: ENVIRONMENT, Prev: COMMANDS, Up: Top 5 ADD-ON COMMANDS ***************** @@ -3213,180 +3228,303 @@ File: hledger.info, Node: chart, Prev: autosync, Up: Experimental add-ons hledger-chart.hs is an old very basic pie chart generator. + +File: hledger.info, Node: ENVIRONMENT, Next: FILES, Prev: ADD-ON COMMANDS, Up: Top + +6 ENVIRONMENT +************* + +*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.journal'). + + +File: hledger.info, Node: FILES, Next: LIMITATIONS, Prev: ENVIRONMENT, Up: Top + +7 FILES +******* + +Reads data from one or more files in hledger journal, timeclock, +timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or +'$HOME/.hledger.journal' (on windows, perhaps +'C:/Users/USER/.hledger.journal'). + + +File: hledger.info, Node: LIMITATIONS, Next: TROUBLESHOOTING, Prev: FILES, Up: Top + +8 LIMITATIONS +************* + +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 must be configured (or there will be an unhelpful error). Eg on +POSIX, set LANG to something other than C. + + In a Microsoft Windows CMD window, non-ascii characters and colours +are not supported. + + On Windows, non-ascii characters may not display correctly when +running a hledger built in CMD in MSYS/CYGWIN, or vice-versa. + + In a Cygwin/MSYS/Mintty window, the tab key is not supported in +hledger add. + + Not all of Ledger's journal file syntax is supported. See file +format differences. + + On large data files, hledger is slower and uses more memory than +Ledger. + + +File: hledger.info, Node: TROUBLESHOOTING, Prev: LIMITATIONS, Up: Top + +9 TROUBLESHOOTING +***************** + +Here are some issues you might encounter when you run hledger (and +remember you can also seek help from the IRC channel, mail list or bug +tracker): + + *Successfully installed, but "No command 'hledger' found"* +stack and cabal install binaries into a special directory, which should +be added to your PATH environment variable. Eg on unix-like systems, +that is ~/.local/bin and ~/.cabal/bin respectively. + + *I set a custom LEDGER_FILE, but hledger is still using the default +file* +'LEDGER_FILE' should be a real environment variable, not just a shell +variable. The command 'env | grep LEDGER_FILE' should show it. You may +need to use 'export'. Here's an explanation. + + *"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 +supports 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 +gnu/linux: + +$ file my.journal +my.journal: UTF-8 Unicode text # <- the file is UTF8-encoded +$ locale -a +C +en_US.utf8 # <- a UTF8-aware locale is available +POSIX +$ LANG=en_US.utf8 hledger -f my.journal print # <- use it for this command + + Here's one way to set it permanently, there are probably better ways: + +$ 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 +first: + +$ apt-get install language-pack-fr +$ locale -a +C +en_US.utf8 +fr_BE.utf8 +fr_CA.utf8 +fr_CH.utf8 +fr_FR.utf8 +fr_LU.utf8 +POSIX +$ LANG=fr_FR.utf8 hledger -f my.journal print + + Note some platforms allow variant locale spellings, but not all +(ubuntu accepts 'fr_FR.UTF8', mac osx requires exactly 'fr_FR.UTF-8'). +  Tag Table: Node: Top68 -Node: EXAMPLES1893 -Ref: #examples1993 -Node: OPTIONS3639 -Ref: #options3741 -Node: General options4140 -Ref: #general-options4265 -Node: Command options6964 -Ref: #command-options7115 -Node: Command arguments7513 -Ref: #command-arguments7667 -Node: Argument files7788 -Ref: #argument-files7964 -Node: Special characters in arguments and queries8720 -Ref: #special-characters-in-arguments-and-queries8954 -Node: More escaping9405 -Ref: #more-escaping9567 -Node: Even more escaping9863 -Ref: #even-more-escaping10057 -Node: Less escaping10728 -Ref: #less-escaping10890 -Node: Command line tips11135 -Ref: #command-line-tips11321 -Node: Unicode characters11698 -Ref: #unicode-characters11854 -Node: Input files13266 -Ref: #input-files13402 -Node: Smart dates15331 -Ref: #smart-dates15472 -Node: Report start & end date16878 -Ref: #report-start-end-date17050 -Node: Report intervals18474 -Ref: #report-intervals18639 -Node: Period expressions19029 -Ref: #period-expressions19189 -Node: Depth limiting23144 -Ref: #depth-limiting23288 -Node: Pivoting23630 -Ref: #pivoting23753 -Node: Valuation25429 -Ref: #valuation25558 -Node: -B Cost25738 -Ref: #b-cost25849 -Node: -V Market value26047 -Ref: #v-market-value26221 -Node: -X Market value in specified commodity27653 -Ref: #x-market-value-in-specified-commodity27892 -Node: --value Flexible valuation28068 -Ref: #value-flexible-valuation28294 -Node: Effect of --value on reports32484 -Ref: #effect-of---value-on-reports32700 -Node: Combining -B -V -X --value37631 -Ref: #combining--b--v--x---value37814 -Node: Output destination37850 -Ref: #output-destination38002 -Node: Output format38285 -Ref: #output-format38437 -Node: Regular expressions38822 -Ref: #regular-expressions38959 -Node: QUERIES40320 -Ref: #queries40422 -Node: COMMANDS44384 -Ref: #commands44496 -Node: accounts45560 -Ref: #accounts45658 -Node: activity46357 -Ref: #activity46467 -Node: add46850 -Ref: #add46949 -Node: balance49688 -Ref: #balance49799 -Node: Classic balance report51257 -Ref: #classic-balance-report51430 -Node: Customising the classic balance report52799 -Ref: #customising-the-classic-balance-report53027 -Node: Colour support55103 -Ref: #colour-support55270 -Node: Flat mode55443 -Ref: #flat-mode55591 -Node: Depth limited balance reports56004 -Ref: #depth-limited-balance-reports56189 -Node: Percentages56645 -Ref: #percentages56811 -Node: Multicolumn balance report57948 -Ref: #multicolumn-balance-report58128 -Node: Budget report63442 -Ref: #budget-report63585 -Node: Nested budgets68787 -Ref: #nested-budgets68899 -Ref: #output-format-172380 -Node: balancesheet72458 -Ref: #balancesheet72594 -Node: balancesheetequity73977 -Ref: #balancesheetequity74126 -Node: cashflow74687 -Ref: #cashflow74815 -Node: check-dates75911 -Ref: #check-dates76038 -Node: check-dupes76317 -Ref: #check-dupes76441 -Node: close76734 -Ref: #close76848 -Node: close usage78370 -Ref: #close-usage78463 -Node: commodities81276 -Ref: #commodities81403 -Node: descriptions81485 -Ref: #descriptions81613 -Node: diff81794 -Ref: #diff81900 -Node: files82947 -Ref: #files83047 -Node: help83194 -Ref: #help83294 -Node: import84375 -Ref: #import84489 -Node: Importing balance assignments85382 -Ref: #importing-balance-assignments85530 -Node: incomestatement86179 -Ref: #incomestatement86312 -Node: notes87716 -Ref: #notes87829 -Node: payees87955 -Ref: #payees88061 -Node: prices88219 -Ref: #prices88325 -Node: print88666 -Ref: #print88776 -Node: print-unique93420 -Ref: #print-unique93546 -Node: register93831 -Ref: #register93958 -Node: Custom register output98130 -Ref: #custom-register-output98259 -Node: register-match99521 -Ref: #register-match99655 -Node: rewrite100006 -Ref: #rewrite100121 -Node: Re-write rules in a file101976 -Ref: #re-write-rules-in-a-file102110 -Node: Diff output format103320 -Ref: #diff-output-format103489 -Node: rewrite vs print --auto104581 -Ref: #rewrite-vs.-print---auto104760 -Node: roi105316 -Ref: #roi105414 -Node: stats106426 -Ref: #stats106525 -Node: tags107313 -Ref: #tags107411 -Node: test107705 -Ref: #test107789 -Node: ADD-ON COMMANDS108536 -Ref: #add-on-commands108646 -Node: Official add-ons109934 -Ref: #official-add-ons110074 -Node: ui110154 -Ref: #ui110241 -Node: web110295 -Ref: #web110384 -Node: Third party add-ons110430 -Ref: #third-party-add-ons110605 -Node: iadd110724 -Ref: #iadd110825 -Node: interest110907 -Ref: #interest111016 -Node: Experimental add-ons111111 -Ref: #experimental-add-ons111263 -Node: autosync111501 -Ref: #autosync111612 -Node: chart111851 -Ref: #chart111956 +Node: EXAMPLES2345 +Ref: #examples2445 +Node: OPTIONS4091 +Ref: #options4193 +Node: General options4592 +Ref: #general-options4717 +Node: Command options7416 +Ref: #command-options7567 +Node: Command arguments7965 +Ref: #command-arguments8119 +Node: Argument files8240 +Ref: #argument-files8416 +Node: Special characters in arguments and queries9172 +Ref: #special-characters-in-arguments-and-queries9406 +Node: More escaping9857 +Ref: #more-escaping10019 +Node: Even more escaping10315 +Ref: #even-more-escaping10509 +Node: Less escaping11180 +Ref: #less-escaping11342 +Node: Command line tips11587 +Ref: #command-line-tips11773 +Node: Unicode characters12150 +Ref: #unicode-characters12306 +Node: Input files13718 +Ref: #input-files13854 +Node: Smart dates15783 +Ref: #smart-dates15924 +Node: Report start & end date17330 +Ref: #report-start-end-date17502 +Node: Report intervals18926 +Ref: #report-intervals19091 +Node: Period expressions19481 +Ref: #period-expressions19641 +Node: Depth limiting23596 +Ref: #depth-limiting23740 +Node: Pivoting24082 +Ref: #pivoting24205 +Node: Valuation25881 +Ref: #valuation26010 +Node: -B Cost26190 +Ref: #b-cost26301 +Node: -V Market value26499 +Ref: #v-market-value26673 +Node: -X Market value in specified commodity28105 +Ref: #x-market-value-in-specified-commodity28344 +Node: --value Flexible valuation28520 +Ref: #value-flexible-valuation28746 +Node: Effect of --value on reports32936 +Ref: #effect-of---value-on-reports33152 +Node: Combining -B -V -X --value38083 +Ref: #combining--b--v--x---value38266 +Node: Output destination38302 +Ref: #output-destination38454 +Node: Output format38737 +Ref: #output-format38889 +Node: Regular expressions39274 +Ref: #regular-expressions39411 +Node: QUERIES40772 +Ref: #queries40874 +Node: COMMANDS44836 +Ref: #commands44948 +Node: accounts46012 +Ref: #accounts46110 +Node: activity46809 +Ref: #activity46919 +Node: add47302 +Ref: #add47401 +Node: balance50140 +Ref: #balance50251 +Node: Classic balance report51709 +Ref: #classic-balance-report51882 +Node: Customising the classic balance report53251 +Ref: #customising-the-classic-balance-report53479 +Node: Colour support55555 +Ref: #colour-support55722 +Node: Flat mode55895 +Ref: #flat-mode56043 +Node: Depth limited balance reports56456 +Ref: #depth-limited-balance-reports56641 +Node: Percentages57097 +Ref: #percentages57263 +Node: Multicolumn balance report58400 +Ref: #multicolumn-balance-report58580 +Node: Budget report63894 +Ref: #budget-report64037 +Node: Nested budgets69239 +Ref: #nested-budgets69351 +Ref: #output-format-172832 +Node: balancesheet72910 +Ref: #balancesheet73046 +Node: balancesheetequity74429 +Ref: #balancesheetequity74578 +Node: cashflow75139 +Ref: #cashflow75267 +Node: check-dates76363 +Ref: #check-dates76490 +Node: check-dupes76769 +Ref: #check-dupes76893 +Node: close77186 +Ref: #close77300 +Node: close usage78822 +Ref: #close-usage78915 +Node: commodities81728 +Ref: #commodities81855 +Node: descriptions81937 +Ref: #descriptions82065 +Node: diff82246 +Ref: #diff82352 +Node: files83399 +Ref: #files83499 +Node: help83646 +Ref: #help83746 +Node: import84827 +Ref: #import84941 +Node: Importing balance assignments85834 +Ref: #importing-balance-assignments85982 +Node: incomestatement86631 +Ref: #incomestatement86764 +Node: notes88168 +Ref: #notes88281 +Node: payees88407 +Ref: #payees88513 +Node: prices88671 +Ref: #prices88777 +Node: print89118 +Ref: #print89228 +Node: print-unique93872 +Ref: #print-unique93998 +Node: register94283 +Ref: #register94410 +Node: Custom register output98582 +Ref: #custom-register-output98711 +Node: register-match99973 +Ref: #register-match100107 +Node: rewrite100458 +Ref: #rewrite100573 +Node: Re-write rules in a file102428 +Ref: #re-write-rules-in-a-file102562 +Node: Diff output format103772 +Ref: #diff-output-format103941 +Node: rewrite vs print --auto105033 +Ref: #rewrite-vs.-print---auto105212 +Node: roi105768 +Ref: #roi105866 +Node: stats106878 +Ref: #stats106977 +Node: tags107765 +Ref: #tags107863 +Node: test108157 +Ref: #test108241 +Node: ADD-ON COMMANDS108988 +Ref: #add-on-commands109118 +Node: Official add-ons110406 +Ref: #official-add-ons110546 +Node: ui110626 +Ref: #ui110713 +Node: web110767 +Ref: #web110856 +Node: Third party add-ons110902 +Ref: #third-party-add-ons111077 +Node: iadd111196 +Ref: #iadd111297 +Node: interest111379 +Ref: #interest111488 +Node: Experimental add-ons111583 +Ref: #experimental-add-ons111735 +Node: autosync111973 +Ref: #autosync112084 +Node: chart112323 +Ref: #chart112428 +Node: ENVIRONMENT112488 +Ref: #environment112607 +Node: FILES112856 +Ref: #files-1112959 +Node: LIMITATIONS113172 +Ref: #limitations113291 +Node: TROUBLESHOOTING114033 +Ref: #troubleshooting114146  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 0a46dccaf..0009f0b9a 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -12,30 +12,28 @@ SYNOPSIS hledger DESCRIPTION - hledger is a cross-platform program for tracking money, time, or any - other commodity, using double-entry accounting and a simple, editable - file format. hledger is inspired by and largely compatible with - ledger(1). - Tested on unix, mac, windows, hledger aims to be a reliable, practical - tool for daily use. + hledger is a reliable, cross-platform set of programs for tracking + money, time, or any other commodity, using double-entry accounting and + a simple, editable file format. hledger is inspired by and largely + compatible with ledger(1). - This is hledger's command-line interface (there are also terminal and - web interfaces). Its basic function is to read a plain text file de- - scribing financial transactions (in accounting terms, a general jour- - nal) and print useful reports on standard output, or export them as - CSV. hledger can also read some other file formats such as CSV files, - translating them to journal format. Additionally, hledger lists other - hledger-* executables found in the user's $PATH and can invoke them as + This is hledger's command-line interface (there are also terminal and + web interfaces). Its basic function is to read a plain text file de- + scribing financial transactions (in accounting terms, a general jour- + nal) and print useful reports on standard output, or export them as + CSV. hledger can also read some other file formats such as CSV files, + translating them to journal format. Additionally, hledger lists other + hledger-* executables found in the user's $PATH and can invoke them as subcommands. - hledger reads data from one or more files in hledger journal, time- - clock, timedot, or CSV format specified with -f, or $LEDGER_FILE, or - $HOME/.hledger.journal (on windows, perhaps + hledger reads data from one or more files in hledger journal, time- + clock, timedot, or CSV format specified with -f, or $LEDGER_FILE, or + $HOME/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.journal). If using $LEDGER_FILE, note this must - be a real environment variable, not a shell variable. You can specify + be a real environment variable, not a shell variable. You can specify standard input with -f-. - Transactions are dated movements of money between two (or more) named + Transactions are dated movements of money between two (or more) named accounts, and are recorded with journal entries like this: 2015/10/16 bought food @@ -44,14 +42,14 @@ DESCRIPTION For more about this format, see hledger_journal(5). - Most users use a text editor to edit the journal, usually with an edi- + Most users use a text editor to edit the journal, usually with an edi- tor mode such as ledger-mode for added convenience. hledger's interac- - tive add command is another way to record new transactions. hledger + tive add command is another way to record new transactions. hledger never changes existing transactions. - To get started, you can either save some entries like the above in - ~/.hledger.journal, or run hledger add and follow the prompts. Then - try some commands like hledger print or hledger balance. Run hledger + To get started, you can either save some entries like the above in + ~/.hledger.journal, or run hledger add and follow the prompts. Then + try some commands like hledger print or hledger balance. Run hledger with no arguments for a list of commands. EXAMPLES @@ -110,7 +108,7 @@ EXAMPLES OPTIONS General options - To see general usage help, including general options which are sup- + To see general usage help, including general options which are sup- ported by most hledger commands, run hledger -h. General help options: @@ -131,7 +129,7 @@ OPTIONS $LEDGER_FILE or $HOME/.hledger.journal) --rules-file=RULESFILE - Conversion rules file to use when reading CSV (default: + Conversion rules file to use when reading CSV (default: FILE.rules) --separator=CHAR @@ -173,7 +171,7 @@ OPTIONS multiperiod/multicolumn report by year -p --period=PERIODEXP - set start date, end date, and/or reporting interval all at once + set start date, end date, and/or reporting interval all at once using period expressions syntax --date2 @@ -196,21 +194,21 @@ OPTIONS hide/aggregate accounts or postings more than NUM levels deep -E --empty - show items with zero amount, normally hidden (and vice-versa in + show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) -B --cost - convert amounts to their cost at transaction time (using the + convert amounts to their cost at transaction time (using the transaction price, if any) -V --value - convert amounts to their market value on the report end date + convert amounts to their market value on the report end date (using the most recent applicable market price, if any) --auto apply automated posting rules to modify transactions. --forecast - apply periodic transaction rules to generate future transac- + apply periodic transaction rules to generate future transac- tions, to 6 months from now or report end date. When a reporting option appears more than once in the command line, the @@ -222,27 +220,27 @@ OPTIONS To see options for a particular command, including command-specific op- tions, run: hledger COMMAND -h. - Command-specific options must be written after the command name, eg: + Command-specific options must be written after the command name, eg: hledger print -x. - Additionally, if the command is an addon, you may need to put its op- - tions after a double-hyphen, eg: hledger ui -- --watch. Or, you can + Additionally, if the command is an addon, you may need to put its op- + tions after a double-hyphen, eg: hledger ui -- --watch. Or, you can run the addon executable directly: hledger-ui --watch. Command arguments - Most hledger commands accept arguments after the command name, which + Most hledger commands accept arguments after the command name, which are often a query, filtering the data in some way. Argument files - You can save a set of command line options/arguments in a file, and - then reuse them by writing @FILENAME as a command line argument. Eg: - hledger bal @foo.args. (To prevent this, eg if you have an argument - that begins with a literal @, precede it with --, eg: hledger bal -- + You can save a set of command line options/arguments in a file, and + then reuse them by writing @FILENAME as a command line argument. Eg: + hledger bal @foo.args. (To prevent this, eg if you have an argument + that begins with a literal @, precede it with --, eg: hledger bal -- @ARG). - Inside the argument file, each line should contain just one option or + Inside the argument file, each line should contain just one option or argument. Avoid the use of spaces, except inside quotes (or you'll see - a confusing error). Between a flag and its argument, use = (or noth- + a confusing error). Between a flag and its argument, use = (or noth- ing). Bad: assets depth:2 @@ -254,7 +252,7 @@ OPTIONS depth:2 -X=USD - For special characters (see below), use one less level of quoting than + For special characters (see below), use one less level of quoting than you would at the command prompt. Bad: -X"$" @@ -268,15 +266,15 @@ OPTIONS Special characters in arguments and queries In shell command lines, option and argument values which contain "prob- lematic" characters, ie spaces, and also characters significant to your - shell such as <, >, (, ), | and $, should be escaped by enclosing them + shell such as <, >, (, ), | and $, should be escaped by enclosing them in quotes or by writing backslashes before the characters. Eg: - hledger register -p 'last year' "accounts receivable (receiv- + hledger register -p 'last year' "accounts receivable (receiv- able|payable)" amt:\>100. More escaping Characters significant both to the shell and in regular expressions may - need one extra level of escaping. These include parentheses, the pipe + need one extra level of escaping. These include parentheses, the pipe symbol and the dollar sign. Eg, to match the dollar symbol, bash users should do: @@ -287,9 +285,9 @@ OPTIONS hledger balance cur:\\$ Even more escaping - When hledger runs an addon executable (eg you type hledger ui, hledger - runs hledger-ui), it de-escapes command-line options and arguments - once, so you might need to triple-escape. Eg in bash, running the ui + When hledger runs an addon executable (eg you type hledger ui, hledger + runs hledger-ui), it de-escapes command-line options and arguments + once, so you might need to triple-escape. Eg in bash, running the ui command and matching the dollar sign, it's: hledger ui cur:'\\$' @@ -314,8 +312,8 @@ OPTIONS hledger-ui cur:\\$ Less escaping - Inside an argument file, or in the search field of hledger-ui or - hledger-web, or at a GHCI prompt, you need one less level of escaping + Inside an argument file, or in the search field of hledger-ui or + hledger-web, or at a GHCI prompt, you need one less level of escaping than at the command line. And backslashes may work better than quotes. Eg: @@ -332,47 +330,47 @@ OPTIONS 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 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 @@ -386,24 +384,24 @@ 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 @@ -414,7 +412,7 @@ 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 @@ -422,69 +420,69 @@ OPTIONS 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: @@ -493,7 +491,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 @@ -508,31 +506,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" @@ -547,69 +545,68 @@ OPTIONS -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 @@ -618,47 +615,47 @@ 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. @@ -684,7 +681,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=. @@ -692,7 +689,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:. @@ -703,23 +700,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: @@ -745,15 +742,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 @@ -773,43 +770,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 @@ -847,7 +844,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 @@ -884,7 +881,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 @@ -898,10 +895,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 @@ -917,10 +914,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, @@ -930,11 +927,11 @@ OPTIONS posting cost value at report value at report value at amounts end or today or journal end DATE/today balance asser- unchanged unchanged unchanged unchanged - tions / as- + 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 @@ -953,31 +950,29 @@ 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- @@ -988,29 +983,29 @@ 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). @@ -1018,16 +1013,16 @@ OPTIONS The rightmost of these flags wins. Output destination - Some commands (print, register, stats, the balance commands) can write - their output to a destination other than the console. This is con- + Some commands (print, register, stats, the balance commands) can write + their output to a destination other than the console. This is con- trolled by the -o/--output-file option. $ hledger balance -o - # write to stdout (the default) $ hledger balance -o FILE # write to FILE Output format - Some commands can write their output in other formats. Eg print and - register can output CSV, and the balance commands can output CSV or + Some commands can write their output in other formats. Eg print and + register can output CSV, and the balance commands can output CSV or HTML. This is controlled by the -O/--output-format option, or by spec- ifying a .csv or .html file extension with -o/--output-file. @@ -1037,56 +1032,56 @@ OPTIONS Regular expressions hledger uses regular expressions in a number of places: - o query terms, on the command line and in the hledger-web search form: + o query terms, on the command line and in the hledger-web search form: REGEX, desc:REGEX, cur:REGEX, tag:...=REGEX o CSV rules conditional blocks: if REGEX ... - o account alias directives and options: alias /REGEX/ = REPLACEMENT, + o account alias directives and options: alias /REGEX/ = REPLACEMENT, --alias /REGEX/=REPLACEMENT - hledger's regular expressions come from the regex-tdfa library. In + hledger's regular expressions come from the regex-tdfa library. In general they: o are case insensitive - o are infix matching (do not need to match the entire thing being + o are infix matching (do not need to match the entire thing being matched) o are POSIX extended regular expressions o also support GNU word boundaries (\<, \>, \b, \B) - o and parenthesised capturing groups and numeric backreferences in re- + 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, + o In the alias directive and --alias option, regular expressions must + be enclosed in forward slashes (/REGEX/). Elsewhere in hledger, these are not required. - o In queries, to match a regular expression metacharacter like $ as a - literal character, prepend a backslash. Eg to search for amounts + o In queries, to match a regular expression metacharacter like $ as a + literal character, prepend a backslash. Eg to search for amounts with the dollar sign in hledger-web, write cur:\$. - o On the command line, some metacharacters like $ have a special mean- + o On the command line, some metacharacters like $ have a special mean- ing to the shell and so must be escaped at least once more. See Spe- cial characters. QUERIES - One of hledger's strengths is being able to quickly report on precise - subsets of your data. Most commands accept an optional query expres- - sion, written as arguments after the command name, to filter the data - by date, account name or other criteria. The syntax is similar to a + One of hledger's strengths is being able to quickly report on precise + subsets of your data. Most commands accept an optional query expres- + sion, written as arguments after the command name, to filter the data + by date, account name or other criteria. The syntax is similar to a web search: one or more space-separated search terms, quotes to enclose - whitespace, prefixes to match specific fields, a not: prefix to negate + whitespace, prefixes to match specific fields, a not: prefix to negate the match. - We do not yet support arbitrary boolean combinations of search terms; - instead most commands show transactions/postings/accounts which match + We do not yet support arbitrary boolean combinations of search terms; + instead most commands show transactions/postings/accounts which match (or negatively match): o any of the description terms AND @@ -1107,31 +1102,31 @@ QUERIES o match all the other terms. - The following kinds of search terms can be used. Remember these can + The following kinds of search terms can be used. Remember these can also be prefixed with not:, eg to exclude a particular subaccount. REGEX, acct:REGEX - match account names by this regular expression. (With no pre- + match account names by this regular expression. (With no pre- fix, acct: is assumed.) same as above amt:N, amt:N, amt:>=N - match postings with a single-commodity amount that is equal to, - less than, or greater than N. (Multi-commodity amounts are not + match postings with a single-commodity amount that is equal to, + less than, or greater than N. (Multi-commodity amounts are not tested, and will always match.) The comparison has two modes: if N is preceded by a + or - sign (or is 0), the two signed numbers - are compared. Otherwise, the absolute magnitudes are compared, + are compared. Otherwise, the absolute magnitudes are compared, ignoring sign. code:REGEX match by transaction code (eg check number) cur:REGEX - match postings or transactions including any amounts whose cur- - rency/commodity symbol is fully matched by REGEX. (For a par- + match postings or transactions including any amounts whose cur- + rency/commodity symbol is fully matched by REGEX. (For a par- tial match, use .*REGEX.*). Note, to match characters which are regex-significant, like the dollar sign ($), you need to prepend - \. And when using the command line you need to add one more - level of quoting to hide it from the shell, so eg do: hledger + \. And when using the command line you need to add one more + level of quoting to hide it from the shell, so eg do: hledger print cur:'\$' or hledger print cur:\\$. desc:REGEX @@ -1139,20 +1134,20 @@ QUERIES date:PERIODEXPR match dates within the specified period. PERIODEXPR is a period - expression (with no report interval). Examples: date:2016, - date:thismonth, date:2000/2/1-2/15, date:lastweek-. If the - --date2 command line flag is present, this matches secondary + expression (with no report interval). Examples: date:2016, + date:thismonth, date:2000/2/1-2/15, date:lastweek-. If the + --date2 command line flag is present, this matches secondary dates instead. date2:PERIODEXPR match secondary dates within the specified period. depth:N - match (or display, depending on command) accounts at or above + match (or display, depending on command) accounts at or above this depth note:REGEX - match transaction notes (part of description right of |, or + match transaction notes (part of description right of |, or whole description when there's no |) payee:REGEX @@ -1166,51 +1161,51 @@ QUERIES match unmarked, pending, or cleared transactions respectively tag:REGEX[=REGEX] - match by tag name, and optionally also by tag value. Note a - tag: query is considered to match a transaction if it matches - any of the postings. Also remember that postings inherit the + match by tag name, and optionally also by tag value. Note a + tag: query is considered to match a transaction if it matches + any of the postings. Also remember that postings inherit the tags of their parent transaction. The following special search term is used automatically in hledger-web, only: inacct:ACCTNAME - tells hledger-web to show the transaction register for this ac- + tells hledger-web to show the transaction register for this ac- count. Can be filtered further with acct etc. Some of these can also be expressed as command-line options (eg depth:2 - is equivalent to --depth 2). Generally you can mix options and query - arguments, and the resulting query will be their intersection (perhaps + is equivalent to --depth 2). Generally you can mix options and query + arguments, and the resulting query will be their intersection (perhaps excluding the -p/--period option). COMMANDS - hledger provides a number of subcommands; hledger with no arguments + hledger provides a number of subcommands; hledger with no arguments shows a list. If you install additional hledger-* packages, or if you put programs or - scripts named hledger-NAME in your PATH, these will also be listed as + scripts named hledger-NAME in your PATH, these will also be listed as subcommands. - Run a subcommand by writing its name as first argument (eg hledger in- - comestatement). You can also write one of the standard short aliases - displayed in parentheses in the command list (hledger b), or any any + Run a subcommand by writing its name as first argument (eg hledger 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: @@ -1229,8 +1224,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: @@ -1245,22 +1240,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. @@ -1268,10 +1263,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. @@ -1280,7 +1275,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): @@ -1310,8 +1305,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 @@ -1319,29 +1314,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 @@ -1359,22 +1354,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 @@ -1383,7 +1378,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)" @@ -1401,7 +1396,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) @@ -1412,14 +1407,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) @@ -1436,14 +1431,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 @@ -1454,9 +1449,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. @@ -1465,8 +1460,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 @@ -1479,9 +1474,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 -% @@ -1491,32 +1486,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 @@ -1532,7 +1527,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 @@ -1548,8 +1543,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: @@ -1568,26 +1563,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: @@ -1611,20 +1606,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 @@ -1671,25 +1666,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 @@ -1731,12 +1726,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: @@ -1746,13 +1741,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: @@ -1778,9 +1773,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: @@ -1796,7 +1791,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 @@ -1814,17 +1809,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). @@ -1850,20 +1845,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: @@ -1894,10 +1889,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). @@ -1918,89 +1913,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: @@ -2055,18 +2050,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. @@ -2084,20 +2079,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: @@ -2124,9 +2119,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 @@ -2137,36 +2132,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 @@ -2191,12 +2186,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 @@ -2224,10 +2219,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 @@ -2235,11 +2230,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 @@ -2266,41 +2261,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 @@ -2317,20 +2312,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 @@ -2354,7 +2349,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 @@ -2365,8 +2360,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 @@ -2376,18 +2371,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 @@ -2399,7 +2394,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 @@ -2416,7 +2411,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 @@ -2424,17 +2419,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): @@ -2452,27 +2447,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: @@ -2488,7 +2483,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: @@ -2498,16 +2493,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. @@ -2522,7 +2517,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. @@ -2535,12 +2530,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' @@ -2564,10 +2559,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: @@ -2575,48 +2570,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: @@ -2634,14 +2629,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. @@ -2649,13 +2644,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 -- @@ -2664,32 +2659,32 @@ 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. Here are some hledger add-ons available: @@ -2704,7 +2699,7 @@ ADD-ON COMMANDS hledger-web provides a simple web interface. Third party add-ons - These are maintained separately, and usually updated shortly after a + These are maintained separately, and usually updated shortly after a hledger release. iadd @@ -2716,35 +2711,35 @@ ADD-ON COMMANDS ing to various schemes. Experimental add-ons - These are available in source form in the hledger repo's bin/ direc- - tory. They may be less mature and documented than built-in commands. + These are available in source form in the hledger repo's bin/ direc- + tory. They may be less mature and documented than built-in commands. Reading and tweaking these is a good way to start making your own! autosync hledger-autosync is a symbolic link for easily running ledger-autosync, - if installed. ledger-autosync does deduplicating conversion of OFX - data and some CSV formats, and can also download the data if your bank + if installed. ledger-autosync does deduplicating conversion of OFX + data and some CSV formats, and can also download the data if your bank offers OFX Direct Connect. chart hledger-chart.hs is an old very basic pie chart generator. ENVIRONMENT - COLUMNS The screen width used by the register command. Default: the + COLUMNS The screen width used by the register command. Default: the full terminal width. LEDGER_FILE The journal file path when not specified with -f. Default: - ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- + ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- nal). FILES - Reads data from one or more files in hledger journal, timeclock, time- - dot, or CSV format specified with -f, or $LEDGER_FILE, or - $HOME/.hledger.journal (on windows, perhaps + Reads data from one or more files in hledger journal, timeclock, time- + dot, or CSV format specified with -f, or $LEDGER_FILE, or + $HOME/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.journal). LIMITATIONS - The need to precede addon command options with -- when invoked from + The need to precede addon command options with -- when invoked from hledger is awkward. When input data contains non-ascii characters, a suitable system locale @@ -2760,33 +2755,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 @@ -2805,7 +2800,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 @@ -2826,7 +2821,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) @@ -2840,7 +2835,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)