;update manuals

This commit is contained in:
Simon Michael 2021-05-18 10:48:42 -10:00
parent 031219e792
commit 6a3019c5a8
9 changed files with 594 additions and 571 deletions

View File

@ -97,10 +97,12 @@ do extra error checking (check that all posted accounts are declared)
hledger reporting options:
.TP
\f[B]\f[CB]-b --begin=DATE\f[B]\f[R]
include postings/txns on or after this date
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
.TP
\f[B]\f[CB]-e --end=DATE\f[B]\f[R]
include postings/txns before this date
include postings/txns before this date (will be adjusted to following
subperiod end when using a report interval)
.TP
\f[B]\f[CB]-D --daily\f[B]\f[R]
multiperiod/multicolumn report by day

View File

@ -107,10 +107,12 @@ the data.
hledger reporting options:
`-b --begin=DATE'
include postings/txns on or after this date
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
`-e --end=DATE'
include postings/txns before this date
include postings/txns before this date (will be adjusted to
following subperiod end when using a report interval)
`-D --daily'
multiperiod/multicolumn report by day
@ -529,23 +531,23 @@ Tag Table:
Node: Top82
Node: OPTIONS1478
Ref: #options1575
Node: KEYS5808
Ref: #keys5903
Node: SCREENS10199
Ref: #screens10304
Node: Accounts screen10394
Ref: #accounts-screen10522
Node: Register screen12726
Ref: #register-screen12881
Node: Transaction screen14876
Ref: #transaction-screen15034
Node: Error screen15901
Ref: #error-screen16023
Node: ENVIRONMENT16265
Ref: #environment16379
Node: FILES17184
Ref: #files17283
Node: BUGS17496
Ref: #bugs17573
Node: KEYS5970
Ref: #keys6065
Node: SCREENS10361
Ref: #screens10466
Node: Accounts screen10556
Ref: #accounts-screen10684
Node: Register screen12888
Ref: #register-screen13043
Node: Transaction screen15038
Ref: #transaction-screen15196
Node: Error screen16063
Ref: #error-screen16185
Node: ENVIRONMENT16427
Ref: #environment16541
Node: FILES17346
Ref: #files17445
Node: BUGS17658
Ref: #bugs17735

End Tag Table

View File

@ -92,10 +92,12 @@ OPTIONS
hledger reporting options:
-b --begin=DATE
include postings/txns on or after this date
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
-e --end=DATE
include postings/txns before this date
include postings/txns before this date (will be adjusted to fol-
lowing subperiod end when using a report interval)
-D --daily
multiperiod/multicolumn report by day

View File

@ -126,10 +126,12 @@ do extra error checking (check that all posted accounts are declared)
hledger reporting options:
.TP
\f[B]\f[CB]-b --begin=DATE\f[B]\f[R]
include postings/txns on or after this date
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
.TP
\f[B]\f[CB]-e --end=DATE\f[B]\f[R]
include postings/txns before this date
include postings/txns before this date (will be adjusted to following
subperiod end when using a report interval)
.TP
\f[B]\f[CB]-D --daily\f[B]\f[R]
multiperiod/multicolumn report by day

View File

@ -133,10 +133,12 @@ before options, as shown in the synopsis above.
hledger reporting options:
`-b --begin=DATE'
include postings/txns on or after this date
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
`-e --end=DATE'
include postings/txns before this date
include postings/txns before this date (will be adjusted to
following subperiod end when using a report interval)
`-D --daily'
multiperiod/multicolumn report by day
@ -608,19 +610,19 @@ Tag Table:
Node: Top84
Node: OPTIONS1727
Ref: #options1832
Node: PERMISSIONS9083
Ref: #permissions9222
Node: EDITING UPLOADING DOWNLOADING10434
Ref: #editing-uploading-downloading10615
Node: RELOADING11446
Ref: #reloading11580
Node: JSON API12012
Ref: #json-api12126
Node: ENVIRONMENT17615
Ref: #environment17731
Node: FILES18463
Ref: #files18563
Node: BUGS18776
Ref: #bugs18854
Node: PERMISSIONS9245
Ref: #permissions9384
Node: EDITING UPLOADING DOWNLOADING10596
Ref: #editing-uploading-downloading10777
Node: RELOADING11608
Ref: #reloading11742
Node: JSON API12174
Ref: #json-api12288
Node: ENVIRONMENT17777
Ref: #environment17893
Node: FILES18625
Ref: #files18725
Node: BUGS18938
Ref: #bugs19016

End Tag Table

View File

@ -115,10 +115,12 @@ OPTIONS
hledger reporting options:
-b --begin=DATE
include postings/txns on or after this date
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
-e --end=DATE
include postings/txns before this date
include postings/txns before this date (will be adjusted to fol-
lowing subperiod end when using a report interval)
-D --daily
multiperiod/multicolumn report by day

View File

@ -119,10 +119,12 @@ do extra error checking (check that all posted accounts are declared)
General reporting options:
.TP
\f[B]\f[CB]-b --begin=DATE\f[B]\f[R]
include postings/txns on or after this date
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
.TP
\f[B]\f[CB]-e --end=DATE\f[B]\f[R]
include postings/txns before this date
include postings/txns before this date (will be adjusted to following
subperiod end when using a report interval)
.TP
\f[B]\f[CB]-D --daily\f[B]\f[R]
multiperiod/multicolumn report by day
@ -780,6 +782,9 @@ The effective report start and end dates are the intersection of the
start/end dates from options and that from \f[C]date:\f[R] queries.
That is, \f[C]date:2019-01 date:2019 -p\[aq]2000 to 2030\[aq]\f[R]
yields January 2019, the smallest common time span.
.IP \[bu] 2
A report interval (see below) will adjust start/end dates, when needed,
so that they fall on subperiod boundaries.
.PP
Examples:
.PP
@ -1207,6 +1212,8 @@ Examples: \f[C]date:2016\f[R], \f[C]date:thismonth\f[R],
\f[C]date:2000/2/1-2/15\f[R], \f[C]date:lastweek-\f[R].
If the \f[C]--date2\f[R] command line flag is present, this matches
secondary dates instead.
(Report intervals will adjust start/end dates to preceding/following
subperiod boundaries.)
.TP
\f[B]\f[R]\f[C]date2:PERIODEXPR\f[R]\f[B]\f[R]
match secondary dates within the specified period.

View File

@ -149,10 +149,12 @@ by most hledger commands, run `hledger -h'.
General reporting options:
`-b --begin=DATE'
include postings/txns on or after this date
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
`-e --end=DATE'
include postings/txns before this date
include postings/txns before this date (will be adjusted to
following subperiod end when using a report interval)
`-D --daily'
multiperiod/multicolumn report by day
@ -726,6 +728,9 @@ these accept the smart date syntax.
That is, `date:2019-01 date:2019 -p'2000 to 2030'' yields January
2019, the smallest common time span.
* A report interval (see below) will adjust start/end dates, when
needed, so that they fall on subperiod boundaries.
Examples:
`-b begin on St. Patrick's day 2016
@ -982,7 +987,8 @@ also be prefixed with *`not:'*, eg to exclude a particular subaccount.
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.
dates instead. (Report intervals will adjust start/end dates to
preceding/following subperiod boundaries.)
*`date2:PERIODEXPR'*
match secondary dates within the specified period.
@ -8691,447 +8697,447 @@ Node: OPTIONS2449
Ref: #options2550
Node: General options2692
Ref: #general-options2817
Node: Command options6386
Ref: #command-options6537
Node: Command arguments6936
Ref: #command-arguments7094
Node: Special characters7972
Ref: #special-characters8135
Node: Single escaping shell metacharacters8298
Ref: #single-escaping-shell-metacharacters8539
Node: Double escaping regular expression metacharacters8941
Ref: #double-escaping-regular-expression-metacharacters9252
Node: Triple escaping for add-on commands9778
Ref: #triple-escaping-for-add-on-commands10038
Node: Less escaping10684
Ref: #less-escaping10838
Node: Unicode characters11164
Ref: #unicode-characters11329
Node: Regular expressions12738
Ref: #regular-expressions12878
Node: ENVIRONMENT14619
Ref: #environment14735
Node: DATA FILES15717
Ref: #data-files15836
Node: Data formats16377
Ref: #data-formats16495
Node: Multiple files17977
Ref: #multiple-files18119
Node: Strict mode18589
Ref: #strict-mode18704
Node: TIME PERIODS19355
Ref: #time-periods19472
Node: Smart dates19570
Ref: #smart-dates19696
Node: Report start & end date21000
Ref: #report-start-end-date21175
Node: Report intervals22719
Ref: #report-intervals22887
Node: Period expressions24161
Ref: #period-expressions24301
Node: DEPTH28680
Ref: #depth28780
Node: QUERIES29111
Ref: #queries29210
Node: COSTING33162
Ref: #costing33265
Node: VALUATION33538
Ref: #valuation33646
Node: -V Value34369
Ref: #v-value34493
Node: -X Value in specified commodity34687
Ref: #x-value-in-specified-commodity34880
Node: Valuation date35029
Ref: #valuation-date35191
Node: Market prices35628
Ref: #market-prices35809
Node: --infer-market-price market prices from transactions36991
Ref: #infer-market-price-market-prices-from-transactions37255
Node: Valuation commodity38604
Ref: #valuation-commodity38814
Node: Simple valuation examples40039
Ref: #simple-valuation-examples40235
Node: --value Flexible valuation40897
Ref: #value-flexible-valuation41099
Node: More valuation examples42741
Ref: #more-valuation-examples42942
Node: Effect of valuation on reports44948
Ref: #effect-of-valuation-on-reports45130
Node: PIVOTING53027
Ref: #pivoting53132
Node: OUTPUT54811
Ref: #output54913
Node: Output destination54964
Ref: #output-destination55097
Node: Output format55753
Ref: #output-format55876
Node: COMMANDS58039
Ref: #commands58151
Node: accounts61541
Ref: #accounts61641
Node: activity62333
Ref: #activity62445
Node: add62827
Ref: #add62930
Node: aregister65725
Ref: #aregister65839
Node: aregister and custom posting dates68034
Ref: #aregister-and-custom-posting-dates68200
Node: balance69021
Ref: #balance69140
Node: balance features70053
Ref: #balance-features70193
Node: Simple balance report71863
Ref: #simple-balance-report72045
Node: Filtered balance report73493
Ref: #filtered-balance-report73680
Node: List or tree mode73977
Ref: #list-or-tree-mode74145
Node: Depth limiting75462
Ref: #depth-limiting75628
Node: Multi-period balance report76386
Ref: #multi-period-balance-report76578
Node: Sorting by amount78834
Ref: #sorting-by-amount79003
Node: Percentages79465
Ref: #percentages79621
Node: Balance change end balance80553
Ref: #balance-change-end-balance80744
Node: Balance report types82168
Ref: #balance-report-types82358
Node: Useful balance reports86522
Ref: #useful-balance-reports86703
Node: Budget report87787
Ref: #budget-report87971
Node: Budget report start date93140
Ref: #budget-report-start-date93309
Node: Nested budgets94636
Ref: #nested-budgets94785
Node: Customising single-period balance reports98172
Ref: #customising-single-period-balance-reports98381
Node: balancesheet100538
Ref: #balancesheet100676
Node: balancesheetequity101974
Ref: #balancesheetequity102125
Node: cashflow103505
Ref: #cashflow103629
Node: check104775
Ref: #check104880
Node: Basic checks105513
Ref: #basic-checks105631
Node: Strict checks106164
Ref: #strict-checks106305
Node: Other checks106609
Ref: #other-checks106749
Node: Custom checks107106
Ref: #custom-checks107226
Node: close107644
Ref: #close107748
Node: close usage109265
Ref: #close-usage109360
Node: codes112168
Ref: #codes112278
Node: commodities112991
Ref: #commodities113120
Node: descriptions113202
Ref: #descriptions113332
Node: diff113636
Ref: #diff113744
Node: files114789
Ref: #files114891
Node: help115037
Ref: #help115139
Node: import115862
Ref: #import115978
Node: Deduplication116840
Ref: #deduplication116965
Node: Import testing118853
Ref: #import-testing119018
Node: Importing balance assignments119508
Ref: #importing-balance-assignments119714
Node: Commodity display styles120361
Ref: #commodity-display-styles120534
Node: incomestatement120663
Ref: #incomestatement120798
Node: notes122099
Ref: #notes122214
Node: payees122581
Ref: #payees122689
Node: prices123215
Ref: #prices123323
Node: print123662
Ref: #print123774
Node: print-unique129084
Ref: #print-unique129212
Node: register129498
Ref: #register129627
Node: Custom register output134071
Ref: #custom-register-output134202
Node: register-match135539
Ref: #register-match135675
Node: rewrite136023
Ref: #rewrite136140
Node: Re-write rules in a file138046
Ref: #re-write-rules-in-a-file138209
Node: Diff output format139359
Ref: #diff-output-format139542
Node: rewrite vs print --auto140634
Ref: #rewrite-vs.-print---auto140794
Node: roi141344
Ref: #roi141444
Node: Semantics of --inv and --pnl143079
Ref: #semantics-of---inv-and---pnl143261
Node: IRR and TWR explained145107
Ref: #irr-and-twr-explained145267
Node: stats148329
Ref: #stats148430
Node: tags149217
Ref: #tags149317
Node: test149834
Ref: #test149950
Node: About add-on commands150695
Ref: #about-add-on-commands150832
Node: JOURNAL FORMAT151965
Ref: #journal-format152093
Node: Transactions154273
Ref: #transactions154388
Node: Dates155405
Ref: #dates155521
Node: Simple dates155586
Ref: #simple-dates155706
Node: Secondary dates156213
Ref: #secondary-dates156361
Node: Posting dates157695
Ref: #posting-dates157818
Node: Status159187
Ref: #status159304
Node: Description161009
Ref: #description161139
Node: Payee and note161457
Ref: #payee-and-note161565
Node: Comments161899
Ref: #comments162021
Node: Tags163214
Ref: #tags-1163325
Node: Postings164723
Ref: #postings164847
Node: Virtual postings165871
Ref: #virtual-postings165982
Node: Account names167284
Ref: #account-names167421
Node: Amounts167907
Ref: #amounts168042
Node: Decimal marks digit group marks169000
Ref: #decimal-marks-digit-group-marks169175
Node: Commodity170047
Ref: #commodity170205
Node: Commodity directives171155
Ref: #commodity-directives171327
Node: Commodity display style171813
Ref: #commodity-display-style171990
Node: Rounding174098
Ref: #rounding174216
Node: Transaction prices174626
Ref: #transaction-prices174792
Node: Lot prices lot dates177222
Ref: #lot-prices-lot-dates177405
Node: Balance assertions177892
Ref: #balance-assertions178070
Node: Assertions and ordering179100
Ref: #assertions-and-ordering179282
Node: Assertions and included files179979
Ref: #assertions-and-included-files180216
Node: Assertions and multiple -f options180547
Ref: #assertions-and-multiple--f-options180797
Node: Assertions and commodities180928
Ref: #assertions-and-commodities181154
Node: Assertions and prices182309
Ref: #assertions-and-prices182517
Node: Assertions and subaccounts182958
Ref: #assertions-and-subaccounts183181
Node: Assertions and virtual postings183505
Ref: #assertions-and-virtual-postings183741
Node: Assertions and precision183882
Ref: #assertions-and-precision184069
Node: Balance assignments184334
Ref: #balance-assignments184504
Node: Balance assignments and prices185667
Ref: #balance-assignments-and-prices185833
Node: Directives186059
Ref: #directives186222
Node: Directives and multiple files191627
Ref: #directives-and-multiple-files191823
Node: Comment blocks192485
Ref: #comment-blocks192662
Node: Including other files192837
Ref: #including-other-files193011
Node: Default year193935
Ref: #default-year194093
Node: Declaring payees194500
Ref: #declaring-payees194666
Node: Declaring commodities194911
Ref: #declaring-commodities195092
Node: Commodity error checking197468
Ref: #commodity-error-checking197618
Node: Default commodity197874
Ref: #default-commodity198054
Node: Declaring market prices198928
Ref: #declaring-market-prices199117
Node: Declaring accounts199975
Ref: #declaring-accounts200155
Node: Account error checking201362
Ref: #account-error-checking201528
Node: Account comments202705
Ref: #account-comments202889
Node: Account subdirectives203315
Ref: #account-subdirectives203500
Node: Account types203815
Ref: #account-types203989
Node: Declaring account types204724
Ref: #declaring-account-types204903
Node: Auto-detected account types205554
Ref: #auto-detected-account-types205795
Node: Interference from auto-detected account types206761
Ref: #interference-from-auto-detected-account-types207038
Node: Old account type syntax207521
Ref: #old-account-type-syntax207718
Node: Account display order208019
Ref: #account-display-order208179
Node: Rewriting accounts209330
Ref: #rewriting-accounts209509
Node: Basic aliases210268
Ref: #basic-aliases210404
Node: Regex aliases211106
Ref: #regex-aliases211268
Node: Combining aliases211988
Ref: #combining-aliases212171
Node: Aliases and multiple files213448
Ref: #aliases-and-multiple-files213647
Node: end aliases214228
Ref: #end-aliases214375
Node: Default parent account214477
Ref: #default-parent-account214667
Node: Periodic transactions215551
Ref: #periodic-transactions215734
Node: Periodic rule syntax217651
Ref: #periodic-rule-syntax217851
Node: Two spaces between period expression and description!218554
Ref: #two-spaces-between-period-expression-and-description218867
Node: Forecasting with periodic transactions219552
Ref: #forecasting-with-periodic-transactions219851
Node: Budgeting with periodic transactions221897
Ref: #budgeting-with-periodic-transactions222130
Node: Auto postings222537
Ref: #auto-postings222673
Node: Auto postings and multiple files224856
Ref: #auto-postings-and-multiple-files225054
Node: Auto postings and dates225262
Ref: #auto-postings-and-dates225530
Node: Auto postings and transaction balancing / inferred amounts / balance assertions225705
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions226051
Node: Auto posting tags226396
Ref: #auto-posting-tags226605
Node: CSV FORMAT227242
Ref: #csv-format227370
Node: Examples229951
Ref: #examples230054
Node: Basic230261
Ref: #basic230363
Node: Bank of Ireland230907
Ref: #bank-of-ireland231044
Node: Amazon232509
Ref: #amazon232629
Node: Paypal234350
Ref: #paypal234446
Node: CSV rules242094
Ref: #csv-rules242212
Node: skip242524
Ref: #skip242619
Node: fields242991
Ref: #fields243115
Node: Transaction field names244276
Ref: #transaction-field-names244438
Node: Posting field names244549
Ref: #posting-field-names244703
Node: field assignment247064
Ref: #field-assignment247209
Node: separator248023
Ref: #separator248160
Node: if block248702
Ref: #if-block248829
Node: Matching the whole record249227
Ref: #matching-the-whole-record249404
Node: Matching individual fields250207
Ref: #matching-individual-fields250413
Node: Combining matchers250637
Ref: #combining-matchers250835
Node: Rules applied on successful match251149
Ref: #rules-applied-on-successful-match251342
Node: if table251999
Ref: #if-table252120
Node: end253856
Ref: #end253970
Node: date-format254194
Ref: #date-format254328
Node: decimal-mark255078
Ref: #decimal-mark255223
Node: newest-first255560
Ref: #newest-first255703
Node: include256386
Ref: #include256519
Node: balance-type256961
Ref: #balance-type257083
Node: Tips257783
Ref: #tips257874
Node: Rapid feedback258173
Ref: #rapid-feedback258292
Node: Valid CSV258751
Ref: #valid-csv258883
Node: File Extension259075
Ref: #file-extension259229
Node: Reading multiple CSV files259658
Ref: #reading-multiple-csv-files259845
Node: Valid transactions260085
Ref: #valid-transactions260265
Node: Deduplicating importing260893
Ref: #deduplicating-importing261074
Node: Setting amounts262106
Ref: #setting-amounts262263
Node: Amount signs264482
Ref: #amount-signs264636
Node: Setting currency/commodity265323
Ref: #setting-currencycommodity265511
Node: Amount decimal places266691
Ref: #amount-decimal-places266883
Node: Referencing other fields267195
Ref: #referencing-other-fields267394
Node: How CSV rules are evaluated268292
Ref: #how-csv-rules-are-evaluated268467
Node: TIMECLOCK FORMAT269916
Ref: #timeclock-format270056
Node: TIMEDOT FORMAT272124
Ref: #timedot-format272262
Node: COMMON TASKS276525
Ref: #common-tasks276654
Node: Getting help277061
Ref: #getting-help277195
Node: Constructing command lines277746
Ref: #constructing-command-lines277940
Node: Starting a journal file278639
Ref: #starting-a-journal-file278839
Node: Setting opening balances280026
Ref: #setting-opening-balances280224
Node: Recording transactions283357
Ref: #recording-transactions283539
Node: Reconciling284096
Ref: #reconciling284241
Node: Reporting286486
Ref: #reporting286628
Node: Migrating to a new file290548
Ref: #migrating-to-a-new-file290698
Node: LIMITATIONS290996
Ref: #limitations291124
Node: TROUBLESHOOTING291865
Ref: #troubleshooting291980
Node: Command options6548
Ref: #command-options6699
Node: Command arguments7098
Ref: #command-arguments7256
Node: Special characters8134
Ref: #special-characters8297
Node: Single escaping shell metacharacters8460
Ref: #single-escaping-shell-metacharacters8701
Node: Double escaping regular expression metacharacters9103
Ref: #double-escaping-regular-expression-metacharacters9414
Node: Triple escaping for add-on commands9940
Ref: #triple-escaping-for-add-on-commands10200
Node: Less escaping10846
Ref: #less-escaping11000
Node: Unicode characters11326
Ref: #unicode-characters11491
Node: Regular expressions12900
Ref: #regular-expressions13040
Node: ENVIRONMENT14781
Ref: #environment14897
Node: DATA FILES15879
Ref: #data-files15998
Node: Data formats16539
Ref: #data-formats16657
Node: Multiple files18139
Ref: #multiple-files18281
Node: Strict mode18751
Ref: #strict-mode18866
Node: TIME PERIODS19517
Ref: #time-periods19634
Node: Smart dates19732
Ref: #smart-dates19858
Node: Report start & end date21162
Ref: #report-start-end-date21337
Node: Report intervals23007
Ref: #report-intervals23175
Node: Period expressions24449
Ref: #period-expressions24589
Node: DEPTH28968
Ref: #depth29068
Node: QUERIES29399
Ref: #queries29498
Node: COSTING33547
Ref: #costing33650
Node: VALUATION33923
Ref: #valuation34031
Node: -V Value34754
Ref: #v-value34878
Node: -X Value in specified commodity35072
Ref: #x-value-in-specified-commodity35265
Node: Valuation date35414
Ref: #valuation-date35576
Node: Market prices36013
Ref: #market-prices36194
Node: --infer-market-price market prices from transactions37376
Ref: #infer-market-price-market-prices-from-transactions37640
Node: Valuation commodity38989
Ref: #valuation-commodity39199
Node: Simple valuation examples40424
Ref: #simple-valuation-examples40620
Node: --value Flexible valuation41282
Ref: #value-flexible-valuation41484
Node: More valuation examples43126
Ref: #more-valuation-examples43327
Node: Effect of valuation on reports45333
Ref: #effect-of-valuation-on-reports45515
Node: PIVOTING53412
Ref: #pivoting53517
Node: OUTPUT55196
Ref: #output55298
Node: Output destination55349
Ref: #output-destination55482
Node: Output format56138
Ref: #output-format56261
Node: COMMANDS58424
Ref: #commands58536
Node: accounts61926
Ref: #accounts62026
Node: activity62718
Ref: #activity62830
Node: add63212
Ref: #add63315
Node: aregister66110
Ref: #aregister66224
Node: aregister and custom posting dates68419
Ref: #aregister-and-custom-posting-dates68585
Node: balance69406
Ref: #balance69525
Node: balance features70438
Ref: #balance-features70578
Node: Simple balance report72248
Ref: #simple-balance-report72430
Node: Filtered balance report73878
Ref: #filtered-balance-report74065
Node: List or tree mode74362
Ref: #list-or-tree-mode74530
Node: Depth limiting75847
Ref: #depth-limiting76013
Node: Multi-period balance report76771
Ref: #multi-period-balance-report76963
Node: Sorting by amount79219
Ref: #sorting-by-amount79388
Node: Percentages79850
Ref: #percentages80006
Node: Balance change end balance80938
Ref: #balance-change-end-balance81129
Node: Balance report types82553
Ref: #balance-report-types82743
Node: Useful balance reports86907
Ref: #useful-balance-reports87088
Node: Budget report88172
Ref: #budget-report88356
Node: Budget report start date93525
Ref: #budget-report-start-date93694
Node: Nested budgets95021
Ref: #nested-budgets95170
Node: Customising single-period balance reports98557
Ref: #customising-single-period-balance-reports98766
Node: balancesheet100923
Ref: #balancesheet101061
Node: balancesheetequity102359
Ref: #balancesheetequity102510
Node: cashflow103890
Ref: #cashflow104014
Node: check105160
Ref: #check105265
Node: Basic checks105898
Ref: #basic-checks106016
Node: Strict checks106549
Ref: #strict-checks106690
Node: Other checks106994
Ref: #other-checks107134
Node: Custom checks107491
Ref: #custom-checks107611
Node: close108029
Ref: #close108133
Node: close usage109650
Ref: #close-usage109745
Node: codes112553
Ref: #codes112663
Node: commodities113376
Ref: #commodities113505
Node: descriptions113587
Ref: #descriptions113717
Node: diff114021
Ref: #diff114129
Node: files115174
Ref: #files115276
Node: help115422
Ref: #help115524
Node: import116247
Ref: #import116363
Node: Deduplication117225
Ref: #deduplication117350
Node: Import testing119238
Ref: #import-testing119403
Node: Importing balance assignments119893
Ref: #importing-balance-assignments120099
Node: Commodity display styles120746
Ref: #commodity-display-styles120919
Node: incomestatement121048
Ref: #incomestatement121183
Node: notes122484
Ref: #notes122599
Node: payees122966
Ref: #payees123074
Node: prices123600
Ref: #prices123708
Node: print124047
Ref: #print124159
Node: print-unique129469
Ref: #print-unique129597
Node: register129883
Ref: #register130012
Node: Custom register output134456
Ref: #custom-register-output134587
Node: register-match135924
Ref: #register-match136060
Node: rewrite136408
Ref: #rewrite136525
Node: Re-write rules in a file138431
Ref: #re-write-rules-in-a-file138594
Node: Diff output format139744
Ref: #diff-output-format139927
Node: rewrite vs print --auto141019
Ref: #rewrite-vs.-print---auto141179
Node: roi141729
Ref: #roi141829
Node: Semantics of --inv and --pnl143464
Ref: #semantics-of---inv-and---pnl143646
Node: IRR and TWR explained145492
Ref: #irr-and-twr-explained145652
Node: stats148714
Ref: #stats148815
Node: tags149602
Ref: #tags149702
Node: test150219
Ref: #test150335
Node: About add-on commands151080
Ref: #about-add-on-commands151217
Node: JOURNAL FORMAT152350
Ref: #journal-format152478
Node: Transactions154658
Ref: #transactions154773
Node: Dates155790
Ref: #dates155906
Node: Simple dates155971
Ref: #simple-dates156091
Node: Secondary dates156598
Ref: #secondary-dates156746
Node: Posting dates158080
Ref: #posting-dates158203
Node: Status159572
Ref: #status159689
Node: Description161394
Ref: #description161524
Node: Payee and note161842
Ref: #payee-and-note161950
Node: Comments162284
Ref: #comments162406
Node: Tags163599
Ref: #tags-1163710
Node: Postings165108
Ref: #postings165232
Node: Virtual postings166256
Ref: #virtual-postings166367
Node: Account names167669
Ref: #account-names167806
Node: Amounts168292
Ref: #amounts168427
Node: Decimal marks digit group marks169385
Ref: #decimal-marks-digit-group-marks169560
Node: Commodity170432
Ref: #commodity170590
Node: Commodity directives171540
Ref: #commodity-directives171712
Node: Commodity display style172198
Ref: #commodity-display-style172375
Node: Rounding174483
Ref: #rounding174601
Node: Transaction prices175011
Ref: #transaction-prices175177
Node: Lot prices lot dates177607
Ref: #lot-prices-lot-dates177790
Node: Balance assertions178277
Ref: #balance-assertions178455
Node: Assertions and ordering179485
Ref: #assertions-and-ordering179667
Node: Assertions and included files180364
Ref: #assertions-and-included-files180601
Node: Assertions and multiple -f options180932
Ref: #assertions-and-multiple--f-options181182
Node: Assertions and commodities181313
Ref: #assertions-and-commodities181539
Node: Assertions and prices182694
Ref: #assertions-and-prices182902
Node: Assertions and subaccounts183343
Ref: #assertions-and-subaccounts183566
Node: Assertions and virtual postings183890
Ref: #assertions-and-virtual-postings184126
Node: Assertions and precision184267
Ref: #assertions-and-precision184454
Node: Balance assignments184719
Ref: #balance-assignments184889
Node: Balance assignments and prices186052
Ref: #balance-assignments-and-prices186218
Node: Directives186444
Ref: #directives186607
Node: Directives and multiple files192012
Ref: #directives-and-multiple-files192208
Node: Comment blocks192870
Ref: #comment-blocks193047
Node: Including other files193222
Ref: #including-other-files193396
Node: Default year194320
Ref: #default-year194478
Node: Declaring payees194885
Ref: #declaring-payees195051
Node: Declaring commodities195296
Ref: #declaring-commodities195477
Node: Commodity error checking197853
Ref: #commodity-error-checking198003
Node: Default commodity198259
Ref: #default-commodity198439
Node: Declaring market prices199313
Ref: #declaring-market-prices199502
Node: Declaring accounts200360
Ref: #declaring-accounts200540
Node: Account error checking201747
Ref: #account-error-checking201913
Node: Account comments203090
Ref: #account-comments203274
Node: Account subdirectives203700
Ref: #account-subdirectives203885
Node: Account types204200
Ref: #account-types204374
Node: Declaring account types205109
Ref: #declaring-account-types205288
Node: Auto-detected account types205939
Ref: #auto-detected-account-types206180
Node: Interference from auto-detected account types207146
Ref: #interference-from-auto-detected-account-types207423
Node: Old account type syntax207906
Ref: #old-account-type-syntax208103
Node: Account display order208404
Ref: #account-display-order208564
Node: Rewriting accounts209715
Ref: #rewriting-accounts209894
Node: Basic aliases210653
Ref: #basic-aliases210789
Node: Regex aliases211491
Ref: #regex-aliases211653
Node: Combining aliases212373
Ref: #combining-aliases212556
Node: Aliases and multiple files213833
Ref: #aliases-and-multiple-files214032
Node: end aliases214613
Ref: #end-aliases214760
Node: Default parent account214862
Ref: #default-parent-account215052
Node: Periodic transactions215936
Ref: #periodic-transactions216119
Node: Periodic rule syntax218036
Ref: #periodic-rule-syntax218236
Node: Two spaces between period expression and description!218939
Ref: #two-spaces-between-period-expression-and-description219252
Node: Forecasting with periodic transactions219937
Ref: #forecasting-with-periodic-transactions220236
Node: Budgeting with periodic transactions222282
Ref: #budgeting-with-periodic-transactions222515
Node: Auto postings222922
Ref: #auto-postings223058
Node: Auto postings and multiple files225241
Ref: #auto-postings-and-multiple-files225439
Node: Auto postings and dates225647
Ref: #auto-postings-and-dates225915
Node: Auto postings and transaction balancing / inferred amounts / balance assertions226090
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions226436
Node: Auto posting tags226781
Ref: #auto-posting-tags226990
Node: CSV FORMAT227627
Ref: #csv-format227755
Node: Examples230336
Ref: #examples230439
Node: Basic230646
Ref: #basic230748
Node: Bank of Ireland231292
Ref: #bank-of-ireland231429
Node: Amazon232894
Ref: #amazon233014
Node: Paypal234735
Ref: #paypal234831
Node: CSV rules242479
Ref: #csv-rules242597
Node: skip242909
Ref: #skip243004
Node: fields243376
Ref: #fields243500
Node: Transaction field names244661
Ref: #transaction-field-names244823
Node: Posting field names244934
Ref: #posting-field-names245088
Node: field assignment247449
Ref: #field-assignment247594
Node: separator248408
Ref: #separator248545
Node: if block249087
Ref: #if-block249214
Node: Matching the whole record249612
Ref: #matching-the-whole-record249789
Node: Matching individual fields250592
Ref: #matching-individual-fields250798
Node: Combining matchers251022
Ref: #combining-matchers251220
Node: Rules applied on successful match251534
Ref: #rules-applied-on-successful-match251727
Node: if table252384
Ref: #if-table252505
Node: end254241
Ref: #end254355
Node: date-format254579
Ref: #date-format254713
Node: decimal-mark255463
Ref: #decimal-mark255608
Node: newest-first255945
Ref: #newest-first256088
Node: include256771
Ref: #include256904
Node: balance-type257346
Ref: #balance-type257468
Node: Tips258168
Ref: #tips258259
Node: Rapid feedback258558
Ref: #rapid-feedback258677
Node: Valid CSV259136
Ref: #valid-csv259268
Node: File Extension259460
Ref: #file-extension259614
Node: Reading multiple CSV files260043
Ref: #reading-multiple-csv-files260230
Node: Valid transactions260470
Ref: #valid-transactions260650
Node: Deduplicating importing261278
Ref: #deduplicating-importing261459
Node: Setting amounts262491
Ref: #setting-amounts262648
Node: Amount signs264867
Ref: #amount-signs265021
Node: Setting currency/commodity265708
Ref: #setting-currencycommodity265896
Node: Amount decimal places267076
Ref: #amount-decimal-places267268
Node: Referencing other fields267580
Ref: #referencing-other-fields267779
Node: How CSV rules are evaluated268677
Ref: #how-csv-rules-are-evaluated268852
Node: TIMECLOCK FORMAT270301
Ref: #timeclock-format270441
Node: TIMEDOT FORMAT272509
Ref: #timedot-format272647
Node: COMMON TASKS276910
Ref: #common-tasks277039
Node: Getting help277446
Ref: #getting-help277580
Node: Constructing command lines278131
Ref: #constructing-command-lines278325
Node: Starting a journal file279024
Ref: #starting-a-journal-file279224
Node: Setting opening balances280411
Ref: #setting-opening-balances280609
Node: Recording transactions283742
Ref: #recording-transactions283924
Node: Reconciling284481
Ref: #reconciling284626
Node: Reporting286871
Ref: #reporting287013
Node: Migrating to a new file290933
Ref: #migrating-to-a-new-file291083
Node: LIMITATIONS291381
Ref: #limitations291509
Node: TROUBLESHOOTING292250
Ref: #troubleshooting292365

End Tag Table

View File

@ -105,10 +105,12 @@ OPTIONS
General reporting options:
-b --begin=DATE
include postings/txns on or after this date
include postings/txns on or after this date (will be adjusted to
preceding subperiod start when using a report interval)
-e --end=DATE
include postings/txns before this date
include postings/txns before this date (will be adjusted to fol-
lowing subperiod end when using a report interval)
-D --daily
multiperiod/multicolumn report by day
@ -559,15 +561,18 @@ TIME PERIODS
date:2019-01 date:2019 -p'2000 to 2030' yields January 2019, the
smallest common time span.
o A report interval (see below) will adjust start/end dates, when
needed, so that they fall on subperiod boundaries.
Examples:
-b 2016/3/17 begin on St. Patrick's day 2016
-e 12/1 end at the start of december 1st of the current year
-e 12/1 end at the start of december 1st of the current year
(11/30 will be the last date included)
-b thismonth all transactions on or after the 1st of the current month
-p thismonth all transactions in the current month
date:2016/3/17.. the above written as queries instead (.. can also be
date:2016/3/17.. the above written as queries instead (.. can also be
replaced with -)
date:..12/1
date:thismonth..
@ -583,37 +588,37 @@ TIME PERIODS
-D/--daily, -W/--weekly, -M/--monthly, -Q/--quarterly, -Y/--yearly.
These standard intervals always start on natural interval boundaries:
eg --weekly starts on mondays, --monthly starts on the first of the
These standard intervals always start on natural interval boundaries:
eg --weekly starts on mondays, --monthly starts on the first of the
month, --yearly always starts on January 1st, etc.
Certain more complex intervals, and more flexible boundary dates, can
be specified by -p/--period. These are described in period expres-
Certain more complex intervals, and more flexible boundary dates, can
be specified by -p/--period. These are described in period expres-
sions, below.
Report intervals can only be specified by the flags above, and not by
Report intervals can only be specified by the flags above, and not by
query arguments, currently.
Report intervals have another effect: multi-period reports are always
expanded to fill a whole number of subperiods. So if you use a report
interval (other than --daily), and you have specified a start or end
date, you may notice those dates being overridden (ie, the report
starts earlier than your requested start date, or ends later than your
Report intervals have another effect: multi-period reports are always
expanded to fill a whole number of subperiods. So if you use a report
interval (other than --daily), and you have specified a start or end
date, you may notice those dates being overridden (ie, the report
starts earlier than your requested start date, or ends later than your
requested end date). This is done to ensure "full" first and last sub-
periods, so that all subperiods' numbers are comparable.
Period expressions
The -p/--period option accepts period expressions, a shorthand way of
expressing a start date, end date, and/or report interval all at once.
The -p/--period option accepts period expressions, a shorthand way of
expressing a start date, end date, and/or report interval all at once.
Here's a basic period expression specifying the first quarter of 2009.
Note, hledger always treats start dates as inclusive and end dates as
Here's a basic period expression specifying the first quarter of 2009.
Note, hledger always treats start dates as inclusive and end dates as
exclusive:
-p "from 2009/1/1 to 2009/4/1"
Keywords like "from" and "to" are optional, and so are the spaces, as
long as you don't run two dates together. "to" can also be written as
Keywords like "from" and "to" are optional, and so are the spaces, as
long as you don't run two dates together. "to" can also be written as
".." or "-". These are equivalent to the above:
@ -621,10 +626,11 @@ TIME PERIODS
-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"
-p "january-apr"
-p "this year to 4/1"
@ -637,34 +643,34 @@ TIME PERIODS
1, 2009
-p "from 2009/1" the same
-p "from 2009" the same
-p "to 2009" everything before january
-p "to 2009" everything before january
1, 2009
A single date with no "from" or "to" defines both the start and end
A single date with no "from" or "to" defines both the start and end
date like so:
-p "2009" the year 2009; equivalent
-p "2009" the year 2009; equivalent
to "2009/1/1 to 2010/1/1"
-p "2009/1" the month of jan; equiva-
-p "2009/1" the month of jan; equiva-
lent to "2009/1/1 to
2009/2/1"
-p "2009/1/1" just that day; equivalent
-p "2009/1/1" just that day; equivalent
to "2009/1/1 to 2009/1/2"
Or you can specify a single quarter like so:
-p "2009Q1" first quarter of 2009,
-p "2009Q1" first quarter of 2009,
equivalent to "2009/1/1 to
2009/4/1"
-p "q4" fourth quarter of the cur-
rent year
The argument of -p can also begin with, or be, a report interval
expression. The basic report intervals are daily, weekly, monthly,
The argument of -p can also begin with, or be, a report interval
expression. The basic report intervals are daily, weekly, monthly,
quarterly, 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
-Y flags. Between report interval and start/end dates (if any), the
word in is optional. Examples:
@ -672,45 +678,45 @@ TIME PERIODS
-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
will end on the last day of same period, even if associated period
expression specifies different explicit start and end date.
For example:
-p "weekly from 2009/1/1 starts on 2008/12/29, closest preceding Mon-
-p "weekly from 2009/1/1 starts on 2008/12/29, closest preceding Mon-
to 2009/4/1" day
-p "monthly in starts on 2018/11/01
-p "monthly in starts on 2018/11/01
2008/11/25"
-p "quarterly from starts on 2009/04/01, ends on 2009/06/30,
-p "quarterly from starts on 2009/04/01, ends on 2009/06/30,
2009-05-05 to 2009-06-01" which are first and last days of Q2 2009
-p "yearly from starts on 2009/01/01, first day of 2009
2009-12-29"
The following more complex report intervals are also supported:
biweekly, fortnightly, bimonthly, every day|week|month|quarter|year,
biweekly, fortnightly, 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 will have boundaries on 2008/01/01,
-p "bimonthly from 2008" periods will have boundaries on 2008/01/01,
2008/03/01, ...
-p "every 2 weeks" starts on closest preceding Monday
-p "every 5 month from periods will have boundaries on 2009/03/01,
-p "every 5 month from periods will have boundaries on 2009/03/01,
2009/03" 2009/08/01, ...
If you want intervals that start on arbitrary day of your choosing and
If you want intervals that start on arbitrary day of your choosing and
span a week, month or year, you need to use any of the following:
every Nth day of week, every WEEKDAYNAME (eg
every Nth day of week, every WEEKDAYNAME (eg
mon|tue|wed|thu|fri|sat|sun), every Nth day [of month], every Nth WEEK-
DAYNAME [of month], every MM/DD [of year], every Nth MMM [of year],
DAYNAME [of month], every MM/DD [of year], every Nth MMM [of year],
every MMM Nth [of year].
Examples:
@ -719,42 +725,42 @@ TIME PERIODS
-p "every 2nd day of periods will go from Tue to Tue
week"
-p "every Tue" same
-p "every 15th day" period boundaries will be on 15th of each
-p "every 15th day" period boundaries will be on 15th of each
month
-p "every 2nd Monday" period boundaries will be on second Monday of
-p "every 2nd Monday" period boundaries will be on second Monday of
each month
-p "every 11/05" yearly periods with boundaries on 5th of Nov
-p "every 5th Nov" same
-p "every Nov 5th" same
Show historical balances at end of 15th each month (N is exclusive end
Show historical balances at end of 15th each month (N is exclusive end
date):
hledger balance -H -p "every 16th day"
Group postings from start of wednesday to end of next tuesday (N is
Group postings from start of wednesday to end of next tuesday (N is
start date and exclusive end date):
hledger register checking -p "every 3rd day of week"
DEPTH
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
detail. This flag has the same effect as a depth: query argument (so
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
detail. This flag has the same effect as a depth: query argument (so
-2, --depth=2 or depth:2 are equivalent).
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
@ -775,31 +781,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, 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
@ -807,10 +813,11 @@ 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
dates instead.
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. (Report intervals will adjust start/end dates to
preceding/following subperiod boundaries.)
date2:PERIODEXPR
match secondary dates within the specified period.
@ -1196,6 +1203,8 @@ VALUATION
or today of journal end sums of post-
sums of of sums of ings
postings postings
budget like balance like balance like balance like bal- like balance
amounts changes changes changes ances changes
(--budget)
@ -1218,12 +1227,6 @@ VALUATION
is, bs postings in period at respec- each period, sums of post-
--change, cf period tive posting valued at ings
--change) dates period ends
end balances sums of same as sums of values of period end value at
(bal -H, is costs of --value=end postings from balances, DATE/today of
--H, bs, cf) postings before period valued at sums of post-
@ -4405,11 +4408,6 @@ JOURNAL FORMAT
ment until end of cur-
rent file or end
directive
commod- format declare a commodity and its number notation:
ity number notation & display following entries
style in that commodity