;update manuals
This commit is contained in:
Simon Michael
parent
982486e5d2
commit
255d475380
@ -168,7 +168,7 @@ fos.ledger ..
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$ hledger -f t.timedot --alias /\[rs]\[rs]./=: bal date:2016/2/4
|
||||
$ hledger -f t.timedot --alias /\[rs]\[rs]./=: bal date:2016/2/4 --tree
|
||||
4.50 fos
|
||||
4.00 hledger:timedot
|
||||
0.50 ledger
|
||||
|
||||
@ -129,7 +129,7 @@ make this work with an account alias:
|
||||
fos.hledger.timedot 4
|
||||
fos.ledger ..
|
||||
|
||||
$ hledger -f t.timedot --alias /\\./=: bal date:2016/2/4
|
||||
$ hledger -f t.timedot --alias /\\./=: bal date:2016/2/4 --tree
|
||||
4.50 fos
|
||||
4.00 hledger:timedot
|
||||
0.50 ledger
|
||||
|
||||
@ -127,7 +127,7 @@ DESCRIPTION
|
||||
fos.hledger.timedot 4
|
||||
fos.ledger ..
|
||||
|
||||
$ hledger -f t.timedot --alias /\\./=: bal date:2016/2/4
|
||||
$ hledger -f t.timedot --alias /\\./=: bal date:2016/2/4 --tree
|
||||
4.50 fos
|
||||
4.00 hledger:timedot
|
||||
0.50 ledger
|
||||
|
||||
@ -1774,15 +1774,19 @@ this order of preference :
|
||||
.IP "1." 3
|
||||
A \f[I]declared market price\f[R] or \f[I]inferred market price\f[R]:
|
||||
A\[aq]s latest market price in B on or before the valuation date as
|
||||
declared by a P directive, or (if the \f[C]--infer-value\f[R] flag is
|
||||
used) inferred from transaction prices.
|
||||
declared by a P directive, or (with the \f[C]--infer-value\f[R] flag)
|
||||
inferred from transaction prices.
|
||||
.IP "2." 3
|
||||
A \f[I]reverse market price\f[R]: the inverse of a declared or inferred
|
||||
market price from B to A.
|
||||
.IP "3." 3
|
||||
A \f[I]chained market price\f[R]: a synthetic price formed by combining
|
||||
the shortest chain of market prices (any of the above types) leading
|
||||
from A to B.
|
||||
A \f[I]a forward chain of market prices\f[R]: a synthetic price formed
|
||||
by combining the shortest chain of \[dq]forward\[dq] (only 1 above)
|
||||
market prices, leading from A to B.
|
||||
.IP "4." 3
|
||||
A \f[I]any chain of market prices\f[R]: a chain of any market prices,
|
||||
including both forward and reverse prices (1 and 2 above), leading from
|
||||
A to B.
|
||||
.PP
|
||||
Amounts for which no applicable market price can be found, are not
|
||||
converted.
|
||||
@ -3189,7 +3193,60 @@ Budget performance in 2017/11/01-2017/12/31:
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
For more examples, see Budgeting and Forecasting.
|
||||
For more examples and notes, see Budgeting.
|
||||
.SS Budget report start date
|
||||
.PP
|
||||
This might be a bug, but for now: when making budget reports, it\[aq]s a
|
||||
good idea to explicitly set the report\[aq]s start date to the first day
|
||||
of a reporting period, because a periodic rule like
|
||||
\f[C]\[ti] monthly\f[R] generates its transactions on the 1st of each
|
||||
month, and if your journal has no regular transactions on the 1st, the
|
||||
default report start date could exclude that budget goal, which can be a
|
||||
little surprising.
|
||||
Eg here the default report period is just the day of 2020-01-15:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
\[ti] monthly in 2020
|
||||
(expenses:food) $500
|
||||
|
||||
2020-01-15
|
||||
expenses:food $400
|
||||
assets:checking
|
||||
\f[R]
|
||||
.fi
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$ hledger bal expenses --budget
|
||||
Budget performance in 2020-01-15:
|
||||
|
||||
|| 2020-01-15
|
||||
==============++============
|
||||
<unbudgeted> || $400
|
||||
--------------++------------
|
||||
|| $400
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
To avoid this, specify the budget report\[aq]s period, or at least the
|
||||
start date, with \f[C]-b\f[R]/\f[C]-e\f[R]/\f[C]-p\f[R]/\f[C]date:\f[R],
|
||||
to ensure it includes the budget goal transactions (periodic
|
||||
transactions) that you want.
|
||||
Eg, adding \f[C]-b 2020/1/1\f[R] to the above:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$ hledger bal expenses --budget -b 2020/1/1
|
||||
Budget performance in 2020-01-01..2020-01-15:
|
||||
|
||||
|| 2020-01-01..2020-01-15
|
||||
===============++========================
|
||||
expenses:food || $400 [80% of $500]
|
||||
---------------++------------------------
|
||||
|| $400 [80% of $500]
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Nested budgets
|
||||
.PP
|
||||
You can add budgets to any account in your account hierarchy.
|
||||
|
||||
@ -1489,14 +1489,18 @@ this order of preference :
|
||||
|
||||
1. A _declared market price_ or _inferred market price_: A's latest
|
||||
market price in B on or before the valuation date as declared by a
|
||||
P directive, or (if the '--infer-value' flag is used) inferred from
|
||||
P directive, or (with the '--infer-value' flag) inferred from
|
||||
transaction prices.
|
||||
|
||||
2. A _reverse market price_: the inverse of a declared or inferred
|
||||
market price from B to A.
|
||||
|
||||
3. A _chained market price_: a synthetic price formed by combining the
|
||||
shortest chain of market prices (any of the above types) leading
|
||||
3. A _a forward chain of market prices_: a synthetic price formed by
|
||||
combining the shortest chain of "forward" (only 1 above) market
|
||||
prices, leading from A to B.
|
||||
|
||||
4. A _any chain of market prices_: a chain of any market prices,
|
||||
including both forward and reverse prices (1 and 2 above), leading
|
||||
from A to B.
|
||||
|
||||
Amounts for which no applicable market price can be found, are not
|
||||
@ -2647,16 +2651,61 @@ Budget performance in 2017/11/01-2017/12/31:
|
||||
----------------------++----------------------------------------------------
|
||||
|| 0 [ 0] 0 [ 0]
|
||||
|
||||
For more examples, see Budgeting and Forecasting.
|
||||
For more examples and notes, see Budgeting.
|
||||
|
||||
* Menu:
|
||||
|
||||
* Budget report start date::
|
||||
* Nested budgets::
|
||||
|
||||
|
||||
File: hledger.info, Node: Nested budgets, Up: Budget report
|
||||
File: hledger.info, Node: Budget report start date, Next: Nested budgets, Up: Budget report
|
||||
|
||||
3.5.9.1 Nested budgets
|
||||
3.5.9.1 Budget report start date
|
||||
................................
|
||||
|
||||
This might be a bug, but for now: when making budget reports, it's a
|
||||
good idea to explicitly set the report's start date to the first day of
|
||||
a reporting period, because a periodic rule like '~ monthly' generates
|
||||
its transactions on the 1st of each month, and if your journal has no
|
||||
regular transactions on the 1st, the default report start date could
|
||||
exclude that budget goal, which can be a little surprising. Eg here the
|
||||
default report period is just the day of 2020-01-15:
|
||||
|
||||
~ monthly in 2020
|
||||
(expenses:food) $500
|
||||
|
||||
2020-01-15
|
||||
expenses:food $400
|
||||
assets:checking
|
||||
|
||||
$ hledger bal expenses --budget
|
||||
Budget performance in 2020-01-15:
|
||||
|
||||
|| 2020-01-15
|
||||
==============++============
|
||||
<unbudgeted> || $400
|
||||
--------------++------------
|
||||
|| $400
|
||||
|
||||
To avoid this, specify the budget report's period, or at least the
|
||||
start date, with '-b'/'-e'/'-p'/'date:', to ensure it includes the
|
||||
budget goal transactions (periodic transactions) that you want. Eg,
|
||||
adding '-b 2020/1/1' to the above:
|
||||
|
||||
$ hledger bal expenses --budget -b 2020/1/1
|
||||
Budget performance in 2020-01-01..2020-01-15:
|
||||
|
||||
|| 2020-01-01..2020-01-15
|
||||
===============++========================
|
||||
expenses:food || $400 [80% of $500]
|
||||
---------------++------------------------
|
||||
|| $400 [80% of $500]
|
||||
|
||||
|
||||
File: hledger.info, Node: Nested budgets, Prev: Budget report start date, Up: Budget report
|
||||
|
||||
3.5.9.2 Nested budgets
|
||||
......................
|
||||
|
||||
You can add budgets to any account in your account hierarchy. If you
|
||||
@ -4407,138 +4456,140 @@ Node: Valuation date49953
|
||||
Ref: #valuation-date50121
|
||||
Node: Market prices50543
|
||||
Ref: #market-prices50723
|
||||
Node: --infer-value market prices from transactions51500
|
||||
Ref: #infer-value-market-prices-from-transactions51749
|
||||
Node: Valuation commodity53031
|
||||
Ref: #valuation-commodity53240
|
||||
Node: Simple valuation examples54466
|
||||
Ref: #simple-valuation-examples54668
|
||||
Node: --value Flexible valuation55327
|
||||
Ref: #value-flexible-valuation55535
|
||||
Node: More valuation examples57482
|
||||
Ref: #more-valuation-examples57691
|
||||
Node: Effect of valuation on reports59696
|
||||
Ref: #effect-of-valuation-on-reports59884
|
||||
Node: COMMANDS66903
|
||||
Ref: #commands67011
|
||||
Node: accounts68119
|
||||
Ref: #accounts68217
|
||||
Node: activity68916
|
||||
Ref: #activity69026
|
||||
Node: add69409
|
||||
Ref: #add69510
|
||||
Node: aregister72303
|
||||
Ref: #aregister72415
|
||||
Node: aregister and custom posting dates73788
|
||||
Ref: #aregister-and-custom-posting-dates73961
|
||||
Ref: #output-format-174554
|
||||
Node: balance74959
|
||||
Ref: #balance75076
|
||||
Node: Classic balance report76556
|
||||
Ref: #classic-balance-report76729
|
||||
Node: Customising the classic balance report78053
|
||||
Ref: #customising-the-classic-balance-report78281
|
||||
Node: Colour support80357
|
||||
Ref: #colour-support80524
|
||||
Node: Flat mode80620
|
||||
Ref: #flat-mode80768
|
||||
Node: Depth limited balance reports81181
|
||||
Ref: #depth-limited-balance-reports81366
|
||||
Node: Percentages81822
|
||||
Ref: #percentages81979
|
||||
Node: Sorting by amount83116
|
||||
Ref: #sorting-by-amount83282
|
||||
Node: Multicolumn balance report83776
|
||||
Ref: #multicolumn-balance-report83962
|
||||
Node: Budget report89559
|
||||
Ref: #budget-report89702
|
||||
Node: Nested budgets94968
|
||||
Ref: #nested-budgets95080
|
||||
Ref: #output-format-298563
|
||||
Node: balancesheet98724
|
||||
Ref: #balancesheet98860
|
||||
Node: balancesheetequity100372
|
||||
Ref: #balancesheetequity100521
|
||||
Node: cashflow101597
|
||||
Ref: #cashflow101725
|
||||
Node: check-dates102941
|
||||
Ref: #check-dates103068
|
||||
Node: check-dupes103347
|
||||
Ref: #check-dupes103473
|
||||
Node: close103766
|
||||
Ref: #close103874
|
||||
Node: close usage105396
|
||||
Ref: #close-usage105489
|
||||
Node: codes108302
|
||||
Ref: #codes108410
|
||||
Node: commodities109122
|
||||
Ref: #commodities109249
|
||||
Node: descriptions109331
|
||||
Ref: #descriptions109459
|
||||
Node: diff109763
|
||||
Ref: #diff109869
|
||||
Node: files110916
|
||||
Ref: #files111016
|
||||
Node: help111163
|
||||
Ref: #help111263
|
||||
Node: import112344
|
||||
Ref: #import112458
|
||||
Node: Importing balance assignments113380
|
||||
Ref: #importing-balance-assignments113561
|
||||
Node: Commodity display styles114210
|
||||
Ref: #commodity-display-styles114381
|
||||
Node: incomestatement114510
|
||||
Ref: #incomestatement114643
|
||||
Node: notes115988
|
||||
Ref: #notes116101
|
||||
Node: payees116469
|
||||
Ref: #payees116575
|
||||
Node: prices116995
|
||||
Ref: #prices117101
|
||||
Node: print117442
|
||||
Ref: #print117552
|
||||
Node: print-unique122348
|
||||
Ref: #print-unique122474
|
||||
Node: register122759
|
||||
Ref: #register122886
|
||||
Node: Custom register output127335
|
||||
Ref: #custom-register-output127464
|
||||
Node: register-match128801
|
||||
Ref: #register-match128935
|
||||
Node: rewrite129286
|
||||
Ref: #rewrite129401
|
||||
Node: Re-write rules in a file131256
|
||||
Ref: #re-write-rules-in-a-file131390
|
||||
Node: Diff output format132600
|
||||
Ref: #diff-output-format132769
|
||||
Node: rewrite vs print --auto133861
|
||||
Ref: #rewrite-vs.-print---auto134040
|
||||
Node: roi134596
|
||||
Ref: #roi134694
|
||||
Node: stats146904
|
||||
Ref: #stats147003
|
||||
Node: tags147791
|
||||
Ref: #tags147889
|
||||
Node: test148408
|
||||
Ref: #test148516
|
||||
Node: Add-on commands149263
|
||||
Ref: #add-on-commands149380
|
||||
Node: ui150723
|
||||
Ref: #ui150811
|
||||
Node: web150865
|
||||
Ref: #web150968
|
||||
Node: iadd151084
|
||||
Ref: #iadd151195
|
||||
Node: interest151277
|
||||
Ref: #interest151384
|
||||
Node: ENVIRONMENT151624
|
||||
Ref: #environment151736
|
||||
Node: FILES152721
|
||||
Ref: #files-1152824
|
||||
Node: LIMITATIONS153037
|
||||
Ref: #limitations153156
|
||||
Node: TROUBLESHOOTING153898
|
||||
Ref: #troubleshooting154011
|
||||
Node: --infer-value market prices from transactions51665
|
||||
Ref: #infer-value-market-prices-from-transactions51914
|
||||
Node: Valuation commodity53196
|
||||
Ref: #valuation-commodity53405
|
||||
Node: Simple valuation examples54631
|
||||
Ref: #simple-valuation-examples54833
|
||||
Node: --value Flexible valuation55492
|
||||
Ref: #value-flexible-valuation55700
|
||||
Node: More valuation examples57647
|
||||
Ref: #more-valuation-examples57856
|
||||
Node: Effect of valuation on reports59861
|
||||
Ref: #effect-of-valuation-on-reports60049
|
||||
Node: COMMANDS67068
|
||||
Ref: #commands67176
|
||||
Node: accounts68284
|
||||
Ref: #accounts68382
|
||||
Node: activity69081
|
||||
Ref: #activity69191
|
||||
Node: add69574
|
||||
Ref: #add69675
|
||||
Node: aregister72468
|
||||
Ref: #aregister72580
|
||||
Node: aregister and custom posting dates73953
|
||||
Ref: #aregister-and-custom-posting-dates74126
|
||||
Ref: #output-format-174719
|
||||
Node: balance75124
|
||||
Ref: #balance75241
|
||||
Node: Classic balance report76721
|
||||
Ref: #classic-balance-report76894
|
||||
Node: Customising the classic balance report78218
|
||||
Ref: #customising-the-classic-balance-report78446
|
||||
Node: Colour support80522
|
||||
Ref: #colour-support80689
|
||||
Node: Flat mode80785
|
||||
Ref: #flat-mode80933
|
||||
Node: Depth limited balance reports81346
|
||||
Ref: #depth-limited-balance-reports81531
|
||||
Node: Percentages81987
|
||||
Ref: #percentages82144
|
||||
Node: Sorting by amount83281
|
||||
Ref: #sorting-by-amount83447
|
||||
Node: Multicolumn balance report83941
|
||||
Ref: #multicolumn-balance-report84127
|
||||
Node: Budget report89724
|
||||
Ref: #budget-report89867
|
||||
Node: Budget report start date95156
|
||||
Ref: #budget-report-start-date95321
|
||||
Node: Nested budgets96653
|
||||
Ref: #nested-budgets96798
|
||||
Ref: #output-format-2100281
|
||||
Node: balancesheet100442
|
||||
Ref: #balancesheet100578
|
||||
Node: balancesheetequity102090
|
||||
Ref: #balancesheetequity102239
|
||||
Node: cashflow103315
|
||||
Ref: #cashflow103443
|
||||
Node: check-dates104659
|
||||
Ref: #check-dates104786
|
||||
Node: check-dupes105065
|
||||
Ref: #check-dupes105191
|
||||
Node: close105484
|
||||
Ref: #close105592
|
||||
Node: close usage107114
|
||||
Ref: #close-usage107207
|
||||
Node: codes110020
|
||||
Ref: #codes110128
|
||||
Node: commodities110840
|
||||
Ref: #commodities110967
|
||||
Node: descriptions111049
|
||||
Ref: #descriptions111177
|
||||
Node: diff111481
|
||||
Ref: #diff111587
|
||||
Node: files112634
|
||||
Ref: #files112734
|
||||
Node: help112881
|
||||
Ref: #help112981
|
||||
Node: import114062
|
||||
Ref: #import114176
|
||||
Node: Importing balance assignments115098
|
||||
Ref: #importing-balance-assignments115279
|
||||
Node: Commodity display styles115928
|
||||
Ref: #commodity-display-styles116099
|
||||
Node: incomestatement116228
|
||||
Ref: #incomestatement116361
|
||||
Node: notes117706
|
||||
Ref: #notes117819
|
||||
Node: payees118187
|
||||
Ref: #payees118293
|
||||
Node: prices118713
|
||||
Ref: #prices118819
|
||||
Node: print119160
|
||||
Ref: #print119270
|
||||
Node: print-unique124066
|
||||
Ref: #print-unique124192
|
||||
Node: register124477
|
||||
Ref: #register124604
|
||||
Node: Custom register output129053
|
||||
Ref: #custom-register-output129182
|
||||
Node: register-match130519
|
||||
Ref: #register-match130653
|
||||
Node: rewrite131004
|
||||
Ref: #rewrite131119
|
||||
Node: Re-write rules in a file132974
|
||||
Ref: #re-write-rules-in-a-file133108
|
||||
Node: Diff output format134318
|
||||
Ref: #diff-output-format134487
|
||||
Node: rewrite vs print --auto135579
|
||||
Ref: #rewrite-vs.-print---auto135758
|
||||
Node: roi136314
|
||||
Ref: #roi136412
|
||||
Node: stats148622
|
||||
Ref: #stats148721
|
||||
Node: tags149509
|
||||
Ref: #tags149607
|
||||
Node: test150126
|
||||
Ref: #test150234
|
||||
Node: Add-on commands150981
|
||||
Ref: #add-on-commands151098
|
||||
Node: ui152441
|
||||
Ref: #ui152529
|
||||
Node: web152583
|
||||
Ref: #web152686
|
||||
Node: iadd152802
|
||||
Ref: #iadd152913
|
||||
Node: interest152995
|
||||
Ref: #interest153102
|
||||
Node: ENVIRONMENT153342
|
||||
Ref: #environment153454
|
||||
Node: FILES154439
|
||||
Ref: #files-1154542
|
||||
Node: LIMITATIONS154755
|
||||
Ref: #limitations154874
|
||||
Node: TROUBLESHOOTING155616
|
||||
Ref: #troubleshooting155729
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
||||
@ -1268,15 +1268,19 @@ OPTIONS
|
||||
|
||||
1. A declared market price or inferred market price: A's latest market
|
||||
price in B on or before the valuation date as declared by a P direc-
|
||||
tive, or (if the --infer-value flag is used) inferred from transac-
|
||||
tion prices.
|
||||
tive, or (with the --infer-value flag) inferred from transaction
|
||||
prices.
|
||||
|
||||
2. A reverse market price: the inverse of a declared or inferred market
|
||||
price from B to A.
|
||||
|
||||
3. A chained market price: a synthetic price formed by combining the
|
||||
shortest chain of market prices (any of the above types) leading
|
||||
from A to B.
|
||||
3. A a forward chain of market prices: a synthetic price formed by com-
|
||||
bining the shortest chain of "forward" (only 1 above) market prices,
|
||||
leading from A to B.
|
||||
|
||||
4. A any chain of market prices: a chain of any market prices, includ-
|
||||
ing both forward and reverse prices (1 and 2 above), leading from A
|
||||
to B.
|
||||
|
||||
Amounts for which no applicable market price can be found, are not con-
|
||||
verted.
|
||||
@ -1553,8 +1557,6 @@ OPTIONS
|
||||
posting cost value at re- value at value at re- value at
|
||||
amounts port end or posting date port or jour- DATE/today
|
||||
today nal end
|
||||
|
||||
|
||||
summary summarised value at pe- sum of post- value at pe- value at
|
||||
posting cost riod ends ings in in- riod ends DATE/today
|
||||
amounts terval, val-
|
||||
@ -1567,6 +1569,8 @@ OPTIONS
|
||||
balance
|
||||
(bs, bse,
|
||||
cf, is)
|
||||
|
||||
|
||||
balance sums of costs value at re- not sup- value at re- value at
|
||||
changes port end or ported port or jour- DATE/today of
|
||||
today of sums nal end of sums of post-
|
||||
@ -2267,7 +2271,46 @@ COMMANDS
|
||||
----------------------++----------------------------------------------------
|
||||
|| 0 [ 0] 0 [ 0]
|
||||
|
||||
For more examples, see Budgeting and Forecasting.
|
||||
For more examples and notes, see Budgeting.
|
||||
|
||||
Budget report start date
|
||||
This might be a bug, but for now: when making budget reports, it's a
|
||||
good idea to explicitly set the report's start date to the first day of
|
||||
a reporting period, because a periodic rule like ~ monthly generates
|
||||
its transactions on the 1st of each month, and if your journal has no
|
||||
regular transactions on the 1st, the default report start date could
|
||||
exclude that budget goal, which can be a little surprising. Eg here
|
||||
the default report period is just the day of 2020-01-15:
|
||||
|
||||
~ monthly in 2020
|
||||
(expenses:food) $500
|
||||
|
||||
2020-01-15
|
||||
expenses:food $400
|
||||
assets:checking
|
||||
|
||||
$ hledger bal expenses --budget
|
||||
Budget performance in 2020-01-15:
|
||||
|
||||
|| 2020-01-15
|
||||
==============++============
|
||||
<unbudgeted> || $400
|
||||
--------------++------------
|
||||
|| $400
|
||||
|
||||
To avoid this, specify the budget report's period, or at least the
|
||||
start date, with -b/-e/-p/date:, to ensure it includes the budget goal
|
||||
transactions (periodic transactions) that you want. Eg, adding -b
|
||||
2020/1/1 to the above:
|
||||
|
||||
$ hledger bal expenses --budget -b 2020/1/1
|
||||
Budget performance in 2020-01-01..2020-01-15:
|
||||
|
||||
|| 2020-01-01..2020-01-15
|
||||
===============++========================
|
||||
expenses:food || $400 [80% of $500]
|
||||
---------------++------------------------
|
||||
|| $400 [80% of $500]
|
||||
|
||||
Nested budgets
|
||||
You can add budgets to any account in your account hierarchy. If you
|
||||
|
||||
Loading…
Reference in New Issue
Block a user