doc: regen manuals

[ci skip]
This commit is contained in:
Simon Michael 2019-02-11 14:14:25 -08:00
parent 2364a53f49
commit 21fac53954
25 changed files with 470 additions and 445 deletions

View File

@ -1,5 +1,5 @@
.TH "hledger\-api" "1" "February 2019" "hledger\-api 1.13" "hledger User Manuals"
.TH "hledger\-api" "1" "February 2019" "hledger\-api 1.13.99" "hledger User Manuals"

View File

@ -3,8 +3,8 @@ This is hledger-api.info, produced by makeinfo version 6.5 from stdin.

File: hledger-api.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-api(1) hledger-api 1.13
*******************************
hledger-api(1) hledger-api 1.13.99
**********************************
hledger-api is a simple web API server, intended to support client-side
web apps operating on hledger data. It comes with a series of simple
@ -80,7 +80,7 @@ options as shown above.

Tag Table:
Node: Top72
Node: OPTIONS1660
Ref: #options1745
Node: OPTIONS1666
Ref: #options1751

End Tag Table

View File

@ -117,4 +117,4 @@ SEE ALSO
hledger-api 1.13 February 2019 hledger-api(1)
hledger-api 1.13.99 February 2019 hledger-api(1)

View File

@ -1,5 +1,5 @@
.TH "hledger_csv" "5" "February 2019" "hledger 1.13" "hledger User Manuals"
.TH "hledger_csv" "5" "February 2019" "hledger 1.13.99" "hledger User Manuals"

View File

@ -3,8 +3,8 @@ This is hledger_csv.info, produced by makeinfo version 6.5 from stdin.

File: hledger_csv.info, Node: Top, Next: CSV RULES, Up: (dir)
hledger_csv(5) hledger 1.13
***************************
hledger_csv(5) hledger 1.13.99
******************************
hledger can read CSV (comma-separated value) files as if they were
journal files, automatically converting each CSV record into a
@ -317,33 +317,33 @@ one rules file will be used for all the CSV files being read.

Tag Table:
Node: Top72
Node: CSV RULES2163
Ref: #csv-rules2271
Node: skip2533
Ref: #skip2627
Node: date-format2799
Ref: #date-format2926
Node: field list3476
Ref: #field-list3613
Node: field assignment4318
Ref: #field-assignment4473
Node: conditional block4977
Ref: #conditional-block5131
Node: include6027
Ref: #include6157
Node: newest-first6388
Ref: #newest-first6502
Node: CSV TIPS6913
Ref: #csv-tips7007
Node: CSV ordering7125
Ref: #csv-ordering7243
Node: CSV accounts7424
Ref: #csv-accounts7562
Node: CSV amounts7816
Ref: #csv-amounts7962
Node: CSV balance assertions8737
Ref: #csv-balance-assertions8919
Node: Reading multiple CSV files9124
Ref: #reading-multiple-csv-files9294
Node: CSV RULES2169
Ref: #csv-rules2277
Node: skip2539
Ref: #skip2633
Node: date-format2805
Ref: #date-format2932
Node: field list3482
Ref: #field-list3619
Node: field assignment4324
Ref: #field-assignment4479
Node: conditional block4983
Ref: #conditional-block5137
Node: include6033
Ref: #include6163
Node: newest-first6394
Ref: #newest-first6508
Node: CSV TIPS6919
Ref: #csv-tips7013
Node: CSV ordering7131
Ref: #csv-ordering7249
Node: CSV accounts7430
Ref: #csv-accounts7568
Node: CSV amounts7822
Ref: #csv-amounts7968
Node: CSV balance assertions8743
Ref: #csv-balance-assertions8925
Node: Reading multiple CSV files9130
Ref: #reading-multiple-csv-files9300

End Tag Table

View File

@ -249,4 +249,4 @@ SEE ALSO
hledger 1.13 February 2019 hledger_csv(5)
hledger 1.13.99 February 2019 hledger_csv(5)

View File

@ -1,6 +1,6 @@
.\"t
.TH "hledger_journal" "5" "February 2019" "hledger 1.13" "hledger User Manuals"
.TH "hledger_journal" "5" "February 2019" "hledger 1.13.99" "hledger User Manuals"

View File

@ -4,8 +4,8 @@ stdin.

File: hledger_journal.info, Node: Top, Next: FILE FORMAT, Up: (dir)
hledger_journal(5) hledger 1.13
*******************************
hledger_journal(5) hledger 1.13.99
**********************************
hledger's usual data source is a plain text file containing journal
entries in hledger journal format. This file represents a standard
@ -1605,109 +1605,109 @@ Code

Tag Table:
Node: Top76
Node: FILE FORMAT2372
Ref: #file-format2496
Node: Transactions2783
Ref: #transactions2904
Node: Postings3588
Ref: #postings3715
Node: Dates4710
Ref: #dates4825
Node: Simple dates4890
Ref: #simple-dates5016
Node: Secondary dates5382
Ref: #secondary-dates5536
Node: Posting dates7099
Ref: #posting-dates7228
Node: Status8602
Ref: #status8722
Node: Description10430
Ref: #description10568
Node: Payee and note10887
Ref: #payee-and-note11001
Node: Account names11243
Ref: #account-names11386
Node: Amounts11873
Ref: #amounts12009
Node: Virtual Postings15026
Ref: #virtual-postings15185
Node: Balance Assertions16405
Ref: #balance-assertions16580
Node: Assertions and ordering17531
Ref: #assertions-and-ordering17717
Node: Assertions and included files18417
Ref: #assertions-and-included-files18658
Node: Assertions and multiple -f options18991
Ref: #assertions-and-multiple--f-options19245
Node: Assertions and commodities19377
Ref: #assertions-and-commodities19607
Node: Assertions and prices20795
Ref: #assertions-and-prices21007
Node: Assertions and subaccounts21447
Ref: #assertions-and-subaccounts21674
Node: Assertions and virtual postings22195
Ref: #assertions-and-virtual-postings22435
Node: Assertions and precision22577
Ref: #assertions-and-precision22768
Node: Balance Assignments23035
Ref: #balance-assignments23216
Node: Balance assignments and prices24380
Ref: #balance-assignments-and-prices24552
Node: Transaction prices24776
Ref: #transaction-prices24945
Node: Comments27213
Ref: #comments27347
Node: Tags28517
Ref: #tags28635
Node: Directives30037
Ref: #directives30180
Node: Comment blocks35787
Ref: #comment-blocks35932
Node: Including other files36108
Ref: #including-other-files36288
Node: Default year36696
Ref: #default-year36865
Node: Declaring commodities37288
Ref: #declaring-commodities37471
Node: Default commodity38698
Ref: #default-commodity38874
Node: Market prices39510
Ref: #market-prices39675
Node: Declaring accounts40516
Ref: #declaring-accounts40692
Node: Account comments41617
Ref: #account-comments41780
Node: Account subdirectives42175
Ref: #account-subdirectives42370
Node: Account types42683
Ref: #account-types42867
Node: Account display order44511
Ref: #account-display-order44681
Node: Rewriting accounts45810
Ref: #rewriting-accounts45995
Node: Basic aliases46729
Ref: #basic-aliases46875
Node: Regex aliases47579
Ref: #regex-aliases47750
Node: Multiple aliases48468
Ref: #multiple-aliases48643
Node: end aliases49141
Ref: #end-aliases49288
Node: Default parent account49389
Ref: #default-parent-account49555
Node: Periodic transactions50439
Ref: #periodic-transactions50621
Node: Two spaces after the period expression51746
Ref: #two-spaces-after-the-period-expression51991
Node: Forecasting with periodic transactions52476
Ref: #forecasting-with-periodic-transactions52766
Node: Budgeting with periodic transactions54453
Ref: #budgeting-with-periodic-transactions54692
Node: Transaction modifiers55151
Ref: #transaction-modifiers55314
Node: Auto postings and transaction balancing / inferred amounts / balance assertions57298
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions57599
Node: EDITOR SUPPORT57977
Ref: #editor-support58095
Node: FILE FORMAT2378
Ref: #file-format2502
Node: Transactions2789
Ref: #transactions2910
Node: Postings3594
Ref: #postings3721
Node: Dates4716
Ref: #dates4831
Node: Simple dates4896
Ref: #simple-dates5022
Node: Secondary dates5388
Ref: #secondary-dates5542
Node: Posting dates7105
Ref: #posting-dates7234
Node: Status8608
Ref: #status8728
Node: Description10436
Ref: #description10574
Node: Payee and note10893
Ref: #payee-and-note11007
Node: Account names11249
Ref: #account-names11392
Node: Amounts11879
Ref: #amounts12015
Node: Virtual Postings15032
Ref: #virtual-postings15191
Node: Balance Assertions16411
Ref: #balance-assertions16586
Node: Assertions and ordering17537
Ref: #assertions-and-ordering17723
Node: Assertions and included files18423
Ref: #assertions-and-included-files18664
Node: Assertions and multiple -f options18997
Ref: #assertions-and-multiple--f-options19251
Node: Assertions and commodities19383
Ref: #assertions-and-commodities19613
Node: Assertions and prices20801
Ref: #assertions-and-prices21013
Node: Assertions and subaccounts21453
Ref: #assertions-and-subaccounts21680
Node: Assertions and virtual postings22201
Ref: #assertions-and-virtual-postings22441
Node: Assertions and precision22583
Ref: #assertions-and-precision22774
Node: Balance Assignments23041
Ref: #balance-assignments23222
Node: Balance assignments and prices24386
Ref: #balance-assignments-and-prices24558
Node: Transaction prices24782
Ref: #transaction-prices24951
Node: Comments27219
Ref: #comments27353
Node: Tags28523
Ref: #tags28641
Node: Directives30043
Ref: #directives30186
Node: Comment blocks35793
Ref: #comment-blocks35938
Node: Including other files36114
Ref: #including-other-files36294
Node: Default year36702
Ref: #default-year36871
Node: Declaring commodities37294
Ref: #declaring-commodities37477
Node: Default commodity38704
Ref: #default-commodity38880
Node: Market prices39516
Ref: #market-prices39681
Node: Declaring accounts40522
Ref: #declaring-accounts40698
Node: Account comments41623
Ref: #account-comments41786
Node: Account subdirectives42181
Ref: #account-subdirectives42376
Node: Account types42689
Ref: #account-types42873
Node: Account display order44517
Ref: #account-display-order44687
Node: Rewriting accounts45816
Ref: #rewriting-accounts46001
Node: Basic aliases46735
Ref: #basic-aliases46881
Node: Regex aliases47585
Ref: #regex-aliases47756
Node: Multiple aliases48474
Ref: #multiple-aliases48649
Node: end aliases49147
Ref: #end-aliases49294
Node: Default parent account49395
Ref: #default-parent-account49561
Node: Periodic transactions50445
Ref: #periodic-transactions50627
Node: Two spaces after the period expression51752
Ref: #two-spaces-after-the-period-expression51997
Node: Forecasting with periodic transactions52482
Ref: #forecasting-with-periodic-transactions52772
Node: Budgeting with periodic transactions54459
Ref: #budgeting-with-periodic-transactions54698
Node: Transaction modifiers55157
Ref: #transaction-modifiers55320
Node: Auto postings and transaction balancing / inferred amounts / balance assertions57304
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions57605
Node: EDITOR SUPPORT57983
Ref: #editor-support58101

End Tag Table

View File

@ -1322,4 +1322,4 @@ SEE ALSO
hledger 1.13 February 2019 hledger_journal(5)
hledger 1.13.99 February 2019 hledger_journal(5)

View File

@ -1,5 +1,5 @@
.TH "hledger_timeclock" "5" "February 2019" "hledger 1.13" "hledger User Manuals"
.TH "hledger_timeclock" "5" "February 2019" "hledger 1.13.99" "hledger User Manuals"

View File

@ -4,8 +4,8 @@ stdin.

File: hledger_timeclock.info, Node: Top, Up: (dir)
hledger_timeclock(5) hledger 1.13
*********************************
hledger_timeclock(5) hledger 1.13.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

View File

@ -77,4 +77,4 @@ SEE ALSO
hledger 1.13 February 2019 hledger_timeclock(5)
hledger 1.13.99 February 2019 hledger_timeclock(5)

View File

@ -1,5 +1,5 @@
.TH "hledger_timedot" "5" "February 2019" "hledger 1.13" "hledger User Manuals"
.TH "hledger_timedot" "5" "February 2019" "hledger 1.13.99" "hledger User Manuals"

View File

@ -4,8 +4,8 @@ stdin.

File: hledger_timedot.info, Node: Top, Next: FILE FORMAT, Up: (dir)
hledger_timedot(5) hledger 1.13
*******************************
hledger_timedot(5) hledger 1.13.99
**********************************
Timedot is a plain text format for logging dated, categorised quantities
(of time, usually), supported by hledger. It is convenient for
@ -110,7 +110,7 @@ $ hledger -f t.timedot --alias /\\./=: bal date:2016/2/4

Tag Table:
Node: Top76
Node: FILE FORMAT807
Ref: #file-format908
Node: FILE FORMAT813
Ref: #file-format914

End Tag Table

View File

@ -124,4 +124,4 @@ SEE ALSO
hledger 1.13 February 2019 hledger_timedot(5)
hledger 1.13.99 February 2019 hledger_timedot(5)

View File

@ -1,5 +1,5 @@
.TH "hledger\-ui" "1" "February 2019" "hledger\-ui 1.13" "hledger User Manuals"
.TH "hledger\-ui" "1" "February 2019" "hledger\-ui 1.13.99" "hledger User Manuals"

View File

@ -3,8 +3,8 @@ This is hledger-ui.info, produced by makeinfo version 6.5 from stdin.

File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-ui(1) hledger-ui 1.13
*****************************
hledger-ui(1) hledger-ui 1.13.99
********************************
hledger-ui is hledger's curses-style interface, providing an efficient
full-window text UI for viewing accounts and transactions, and some
@ -398,19 +398,19 @@ to cancel the reload attempt.)

Tag Table:
Node: Top71
Node: OPTIONS1100
Ref: #options1197
Node: KEYS4616
Ref: #keys4711
Node: SCREENS7967
Ref: #screens8052
Node: Accounts screen8142
Ref: #accounts-screen8270
Node: Register screen10486
Ref: #register-screen10641
Node: Transaction screen12637
Ref: #transaction-screen12795
Node: Error screen13665
Ref: #error-screen13787
Node: OPTIONS1106
Ref: #options1203
Node: KEYS4622
Ref: #keys4717
Node: SCREENS7973
Ref: #screens8058
Node: Accounts screen8148
Ref: #accounts-screen8276
Node: Register screen10492
Ref: #register-screen10647
Node: Transaction screen12643
Ref: #transaction-screen12801
Node: Error screen13671
Ref: #error-screen13793

End Tag Table

View File

@ -406,4 +406,4 @@ SEE ALSO
hledger-ui 1.13 February 2019 hledger-ui(1)
hledger-ui 1.13.99 February 2019 hledger-ui(1)

View File

@ -1,5 +1,5 @@
.TH "hledger\-web" "1" "February 2019" "hledger\-web 1.13" "hledger User Manuals"
.TH "hledger\-web" "1" "February 2019" "hledger\-web 1.13.99" "hledger User Manuals"

View File

@ -3,8 +3,8 @@ This is hledger-web.info, produced by makeinfo version 6.5 from stdin.

File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir)
hledger-web(1) hledger-web 1.13
*******************************
hledger-web(1) hledger-web 1.13.99
**********************************
hledger-web is hledger's web interface. It starts a simple web
application for browsing and adding transactions, and optionally opens
@ -212,7 +212,7 @@ this, insert a '--' argument before.)

Tag Table:
Node: Top72
Node: OPTIONS3154
Ref: #options3239
Node: OPTIONS3160
Ref: #options3245

End Tag Table

View File

@ -87,20 +87,19 @@ web app detects changes made by other means and will show the new data
on the next request. If a change makes the file unparseable,
hledger-web will show an error until the file has been fixed.
---
# disabled
# edit form
# Note: unlike any other hledger command, `web` can alter existing journal
# data, via the edit form. A numbered backup of the file is saved on
# each edit, normally (ie if file permissions allow, disk is not full, etc.)
# Also, there is no built-in access control. So unless you run it behind an
# authenticating proxy, any visitor to your server will be able to see and
# overwrite the journal file (and included files.)
# hledger-web disallows edits which would leave the journal file not in
# valid [journal format](#journal). If the file becomes unparseable
# by other means, hledger-web will show an error until the file has been
# fixed.
...
<!--
edit form
Note: unlike any other hledger command, `web` can alter existing journal
data, via the edit form. A numbered backup of the file is saved on
each edit, normally (ie if file permissions allow, disk is not full, etc.)
Also, there is no built-in access control. So unless you run it behind an
authenticating proxy, any visitor to your server will be able to see and
overwrite the journal file (and included files.)
hledger-web disallows edits which would leave the journal file not in
valid [journal format](#journal). If the file becomes unparseable
by other means, hledger-web will show an error until the file has been
fixed.
-->
# OPTIONS

View File

@ -251,4 +251,4 @@ SEE ALSO
hledger-web 1.13 February 2019 hledger-web(1)
hledger-web 1.13.99 February 2019 hledger-web(1)

View File

@ -1,6 +1,6 @@
.\"t
.TH "hledger" "1" "February 2019" "hledger 1.13" "hledger User Manuals"
.TH "hledger" "1" "February 2019" "hledger 1.13.99" "hledger User Manuals"
@ -2659,6 +2659,18 @@ The \f[C]\-\-related\f[]/\f[C]\-r\f[] flag shows the \f[I]other\f[]
postings in the transactions of the postings which would normally be
shown.
.PP
The \f[C]\-\-invert\f[] flag negates all amounts.
For example, it can be used on an income account where amounts are
normally displayed as negative numbers.
It\[aq]s also useful to show postings on the checking account together
with the related account:
.IP
.nf
\f[C]
$\ hledger\ register\ \-\-related\ \-\-invert\ assets:checking
\f[]
.fi
.PP
With a reporting interval, register shows summary postings, one per
interval, aggregating the postings to each account:
.IP

View File

@ -3,8 +3,8 @@ This is hledger.info, produced by makeinfo version 6.5 from stdin.

File: hledger.info, Node: Top, Next: EXAMPLES, Up: (dir)
hledger(1) hledger 1.13
***********************
hledger(1) hledger 1.13.99
**************************
This is hledger's command-line interface (there are also curses and web
interfaces). Its basic function is to read a plain text file describing
@ -2170,6 +2170,13 @@ just one account and one commodity.
The '--related'/'-r' flag shows the _other_ postings in the
transactions of the postings which would normally be shown.
The '--invert' flag negates all amounts. For example, it can be used
on an income account where amounts are normally displayed as negative
numbers. It's also useful to show postings on the checking account
together with the related account:
$ hledger register --related --invert assets:checking
With a reporting interval, register shows summary postings, one per
interval, aggregating the postings to each account:
@ -2678,160 +2685,160 @@ hledger-check.hs checks more powerful account balance assertions.

Tag Table:
Node: Top68
Node: EXAMPLES1884
Ref: #examples1984
Node: OPTIONS3630
Ref: #options3732
Node: General options4167
Ref: #general-options4292
Node: Command options6974
Ref: #command-options7125
Node: Command arguments7523
Ref: #command-arguments7677
Node: Argument files7798
Ref: #argument-files7974
Node: Special characters in arguments and queries8240
Ref: #special-characters-in-arguments-and-queries8474
Node: More escaping8924
Ref: #more-escaping9086
Node: Even more escaping9382
Ref: #even-more-escaping9576
Node: Less escaping10247
Ref: #less-escaping10409
Node: Command line tips10654
Ref: #command-line-tips10840
Node: Unicode characters11217
Ref: #unicode-characters11373
Node: Input files12098
Ref: #input-files12234
Node: Smart dates14204
Ref: #smart-dates14345
Node: Report start & end date15751
Ref: #report-start-end-date15923
Node: Report intervals16989
Ref: #report-intervals17154
Node: Period expressions17555
Ref: #period-expressions17715
Node: Depth limiting21672
Ref: #depth-limiting21816
Node: Pivoting22158
Ref: #pivoting22276
Node: Cost23952
Ref: #cost24060
Node: Market value24178
Ref: #market-value24313
Node: Combining -B and -V25679
Ref: #combining--b-and--v25842
Node: Output destination25989
Ref: #output-destination26151
Node: Output format26434
Ref: #output-format26586
Node: Regular expressions26971
Ref: #regular-expressions27108
Node: QUERIES28469
Ref: #queries28571
Node: COMMANDS32533
Ref: #commands32645
Node: accounts33645
Ref: #accounts33743
Node: activity34442
Ref: #activity34552
Node: add34935
Ref: #add35034
Node: balance37621
Ref: #balance37732
Node: Classic balance report39173
Ref: #classic-balance-report39346
Node: Customising the classic balance report40715
Ref: #customising-the-classic-balance-report40943
Node: Colour support43017
Ref: #colour-support43184
Node: Flat mode43357
Ref: #flat-mode43505
Node: Depth limited balance reports43918
Ref: #depth-limited-balance-reports44118
Node: Multicolumn balance report44574
Ref: #multicolumn-balance-report44772
Node: Budget report50012
Ref: #budget-report50155
Node: Nested budgets54839
Ref: #nested-budgets54951
Ref: #output-format-158431
Node: balancesheet58509
Ref: #balancesheet58645
Node: balancesheetequity59879
Ref: #balancesheetequity60028
Node: cashflow60589
Ref: #cashflow60717
Node: check-dates61745
Ref: #check-dates61872
Node: check-dupes62151
Ref: #check-dupes62275
Node: close62568
Ref: #close62676
Node: files66089
Ref: #files66190
Node: help66337
Ref: #help66437
Node: import67530
Ref: #import67644
Node: incomestatement68388
Ref: #incomestatement68522
Node: prices69858
Ref: #prices69973
Node: print70252
Ref: #print70362
Node: print-unique74855
Ref: #print-unique74981
Node: register75266
Ref: #register75393
Node: Custom register output79262
Ref: #custom-register-output79391
Node: register-match80653
Ref: #register-match80787
Node: rewrite81138
Ref: #rewrite81253
Node: Re-write rules in a file83102
Ref: #re-write-rules-in-a-file83236
Node: Diff output format84446
Ref: #diff-output-format84615
Node: rewrite vs print --auto85707
Ref: #rewrite-vs.-print---auto85886
Node: roi86442
Ref: #roi86540
Node: stats87552
Ref: #stats87651
Node: tags88405
Ref: #tags88503
Node: test88733
Ref: #test88817
Node: ADD-ON COMMANDS89578
Ref: #add-on-commands89688
Node: Official add-ons90975
Ref: #official-add-ons91115
Node: api91202
Ref: #api91291
Node: ui91343
Ref: #ui91442
Node: web91500
Ref: #web91589
Node: Third party add-ons91635
Ref: #third-party-add-ons91810
Node: diff91945
Ref: #diff92042
Node: iadd92141
Ref: #iadd92255
Node: interest92338
Ref: #interest92459
Node: irr92554
Ref: #irr92652
Node: Experimental add-ons92783
Ref: #experimental-add-ons92935
Node: autosync93215
Ref: #autosync93326
Node: chart93565
Ref: #chart93684
Node: check93755
Ref: #check93857
Node: EXAMPLES1890
Ref: #examples1990
Node: OPTIONS3636
Ref: #options3738
Node: General options4173
Ref: #general-options4298
Node: Command options6980
Ref: #command-options7131
Node: Command arguments7529
Ref: #command-arguments7683
Node: Argument files7804
Ref: #argument-files7980
Node: Special characters in arguments and queries8246
Ref: #special-characters-in-arguments-and-queries8480
Node: More escaping8930
Ref: #more-escaping9092
Node: Even more escaping9388
Ref: #even-more-escaping9582
Node: Less escaping10253
Ref: #less-escaping10415
Node: Command line tips10660
Ref: #command-line-tips10846
Node: Unicode characters11223
Ref: #unicode-characters11379
Node: Input files12104
Ref: #input-files12240
Node: Smart dates14210
Ref: #smart-dates14351
Node: Report start & end date15757
Ref: #report-start-end-date15929
Node: Report intervals16995
Ref: #report-intervals17160
Node: Period expressions17561
Ref: #period-expressions17721
Node: Depth limiting21678
Ref: #depth-limiting21822
Node: Pivoting22164
Ref: #pivoting22282
Node: Cost23958
Ref: #cost24066
Node: Market value24184
Ref: #market-value24319
Node: Combining -B and -V25685
Ref: #combining--b-and--v25848
Node: Output destination25995
Ref: #output-destination26157
Node: Output format26440
Ref: #output-format26592
Node: Regular expressions26977
Ref: #regular-expressions27114
Node: QUERIES28475
Ref: #queries28577
Node: COMMANDS32539
Ref: #commands32651
Node: accounts33651
Ref: #accounts33749
Node: activity34448
Ref: #activity34558
Node: add34941
Ref: #add35040
Node: balance37627
Ref: #balance37738
Node: Classic balance report39179
Ref: #classic-balance-report39352
Node: Customising the classic balance report40721
Ref: #customising-the-classic-balance-report40949
Node: Colour support43023
Ref: #colour-support43190
Node: Flat mode43363
Ref: #flat-mode43511
Node: Depth limited balance reports43924
Ref: #depth-limited-balance-reports44124
Node: Multicolumn balance report44580
Ref: #multicolumn-balance-report44778
Node: Budget report50018
Ref: #budget-report50161
Node: Nested budgets54845
Ref: #nested-budgets54957
Ref: #output-format-158437
Node: balancesheet58515
Ref: #balancesheet58651
Node: balancesheetequity59885
Ref: #balancesheetequity60034
Node: cashflow60595
Ref: #cashflow60723
Node: check-dates61751
Ref: #check-dates61878
Node: check-dupes62157
Ref: #check-dupes62281
Node: close62574
Ref: #close62682
Node: files66095
Ref: #files66196
Node: help66343
Ref: #help66443
Node: import67536
Ref: #import67650
Node: incomestatement68394
Ref: #incomestatement68528
Node: prices69864
Ref: #prices69979
Node: print70258
Ref: #print70368
Node: print-unique74861
Ref: #print-unique74987
Node: register75272
Ref: #register75399
Node: Custom register output79570
Ref: #custom-register-output79699
Node: register-match80961
Ref: #register-match81095
Node: rewrite81446
Ref: #rewrite81561
Node: Re-write rules in a file83410
Ref: #re-write-rules-in-a-file83544
Node: Diff output format84754
Ref: #diff-output-format84923
Node: rewrite vs print --auto86015
Ref: #rewrite-vs.-print---auto86194
Node: roi86750
Ref: #roi86848
Node: stats87860
Ref: #stats87959
Node: tags88713
Ref: #tags88811
Node: test89041
Ref: #test89125
Node: ADD-ON COMMANDS89886
Ref: #add-on-commands89996
Node: Official add-ons91283
Ref: #official-add-ons91423
Node: api91510
Ref: #api91599
Node: ui91651
Ref: #ui91750
Node: web91808
Ref: #web91897
Node: Third party add-ons91943
Ref: #third-party-add-ons92118
Node: diff92253
Ref: #diff92350
Node: iadd92449
Ref: #iadd92563
Node: interest92646
Ref: #interest92767
Node: irr92862
Ref: #irr92960
Node: Experimental add-ons93091
Ref: #experimental-add-ons93243
Node: autosync93523
Ref: #autosync93634
Node: chart93873
Ref: #chart93992
Node: check94063
Ref: #check94165

End Tag Table

View File

@ -1935,14 +1935,21 @@ COMMANDS
The --related/-r flag shows the other postings in the transactions of
the postings which would normally be shown.
With a reporting interval, register shows summary postings, one per
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
together with the related account:
$ hledger register --related --invert assets:checking
With a reporting interval, register shows summary postings, one per
interval, aggregating the postings to each account:
$ hledger register --monthly income
2008/01 income:salary $-1 $-1
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
@ -1959,7 +1966,7 @@ COMMANDS
2008/11 0 $-2
2008/12 0 $-2
Often, you'll want to see just one line per interval. The --depth
Often, you'll want to see just one line per interval. The --depth
option helps with this, causing subaccounts to be aggregated:
$ hledger register --monthly assets --depth 1h
@ -1967,19 +1974,19 @@ 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
intervals. 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
intervals. 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
(about half of (width - 40) each). You can adjust this by adding a
description width as part of --width's argument, comma-separated:
The description and account columns normally share the space equally
(about half of (width - 40) each). You can adjust this by adding a
description width as part of --width's argument, comma-separated:
--width W,D . Here's a diagram (won't display correctly in --help):
<--------------------------------- width (W) ---------------------------------->
@ -1995,27 +2002,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
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-autosync 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:
@ -2031,7 +2038,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:
@ -2041,16 +2048,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
includes a commodity name, the new posting amount will be in the new
commodity; otherwise, it will be in the matched posting amount's com-
factor for an amount of original matched posting. If the amount
includes a commodity name, the new posting amount will be in the new
commodity; otherwise, it will be in the matched posting amount's com-
modity.
Re-write rules in a file
During the run this tool will execute so called "Automated Transac-
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.
@ -2065,7 +2072,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.
@ -2078,12 +2085,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'
@ -2107,10 +2114,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:
@ -2118,48 +2125,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
account name) to select your investments with --inv, and another query
At a minimum, you need to supply a query (which could be just an
account name) to select your investments with --inv, and another query
to identify your profit and loss transactions with --pnl.
It will compute and display the internalized rate of return (IRR) and
time-weighted rate of return (TWR) for your investments for the time
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:
@ -2176,60 +2183,60 @@ COMMANDS
Accounts : 8 (depth 3)
Commodities : 1 ($)
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.
test
test
Run built-in unit tests.
This command runs the unit tests built in to hledger-lib and hledger,
This command runs the unit tests built in to hledger-lib and hledger,
printing test names and results on stdout. If any test fails, the exit
code will be non-zero.
Test names include a group prefix. If a (exact, case sensitive) group
prefix, or a full test name is provided as the first argument, only
Test names include a group prefix. If a (exact, case sensitive) group
prefix, or a full test name is provided as the first argument, only
that group or test is run.
If a numeric second argument is provided, it will set the randomness
seed, for repeatable results from tests using randomness (currently
If a numeric second argument is provided, it will set the randomness
seed, for repeatable results from tests using randomness (currently
none of them).
This is mainly used by developers, but it's nice to be able to san-
This is mainly used by developers, but it's nice to be able to san-
ity-check your installed hledger executable at any time. All tests are
expected to pass - if you ever see otherwise, something has gone wrong,
please report a bug!
ADD-ON COMMANDS
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
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:
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:
@ -2247,7 +2254,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.
diff
@ -2255,7 +2262,7 @@ ADD-ON COMMANDS
journal file and another.
iadd
hledger-iadd is a curses-style, more interactive replacement for the
hledger-iadd is a curses-style, more interactive replacement for the
add command.
interest
@ -2263,19 +2270,19 @@ ADD-ON COMMANDS
ing to various schemes.
irr
hledger-irr calculates the internal rate of return of an investment
hledger-irr calculates the internal rate of return of an investment
account, but it's superseded now by the built-in roi command.
Experimental add-ons
These are available in source form in the hledger repo's bin/ direc-
These are available in source form in the hledger repo's bin/ direc-
tory; installing them is pretty easy. They may be less mature and doc-
umented than built-in commands. Reading and tweaking these is a good
umented 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
@ -2285,21 +2292,21 @@ ADD-ON COMMANDS
hledger-check.hs checks more powerful account balance assertions.
ENVIRONMENT
COLUMNS The screen width used by the register command. Default: the
COLUMNS The screen width used by the register command. Default: the
full terminal width.
LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FILES
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
BUGS
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
@ -2312,33 +2319,33 @@ BUGS
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
remember you can also seek help from the IRC channel, mail list or bug
Here are some issues you might encounter when you run hledger (and
remember you can also seek help from the IRC channel, mail list or bug
tracker):
Successfully installed, but "No command 'hledger' found"
stack and cabal install binaries into a special directory, which should
be added to your PATH environment variable. Eg on unix-like systems,
be added to your PATH environment variable. Eg on unix-like systems,
that is ~/.local/bin and ~/.cabal/bin respectively.
I set a custom LEDGER_FILE, but hledger is still using the default file
LEDGER_FILE should be a real environment variable, not just a shell
variable. The command env | grep LEDGER_FILE should show it. You may
LEDGER_FILE should be a real environment variable, not just a shell
variable. The command env | grep LEDGER_FILE should show it. You may
need to use export. Here's an explanation.
"Illegal byte sequence" or "Invalid or incomplete multibyte or wide
"Illegal byte sequence" or "Invalid or incomplete multibyte or wide
character" errors
In order to handle non-ascii letters and symbols (like ), hledger needs
an appropriate locale. This is usually configured system-wide; you can
also configure it temporarily. The locale may need to be one that sup-
ports UTF-8, if you built hledger with GHC < 7.2 (or possibly always,
ports UTF-8, if you built hledger with GHC < 7.2 (or possibly always,
I'm not sure yet).
Here's an example of setting the locale temporarily, on ubuntu
@ -2357,7 +2364,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
@ -2378,7 +2385,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)
@ -2392,7 +2399,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)
@ -2400,4 +2407,4 @@ SEE ALSO
hledger 1.13 February 2019 hledger(1)
hledger 1.13.99 February 2019 hledger(1)