;update manuals
This commit is contained in:
		
							parent
							
								
									982486e5d2
								
							
						
					
					
						commit
						255d475380
					
				| @ -168,7 +168,7 @@ fos.ledger           .. | |||||||
| .IP | .IP | ||||||
| .nf | .nf | ||||||
| \f[C] | \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.50  fos | ||||||
|                 4.00    hledger:timedot |                 4.00    hledger:timedot | ||||||
|                 0.50    ledger |                 0.50    ledger | ||||||
|  | |||||||
| @ -129,7 +129,7 @@ make this work with an account alias: | |||||||
| fos.hledger.timedot  4 | fos.hledger.timedot  4 | ||||||
| fos.ledger           .. | 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.50  fos | ||||||
|                 4.00    hledger:timedot |                 4.00    hledger:timedot | ||||||
|                 0.50    ledger |                 0.50    ledger | ||||||
|  | |||||||
| @ -127,7 +127,7 @@ DESCRIPTION | |||||||
|               fos.hledger.timedot  4 |               fos.hledger.timedot  4 | ||||||
|               fos.ledger           .. |               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.50  fos | ||||||
|                               4.00    hledger:timedot |                               4.00    hledger:timedot | ||||||
|                               0.50    ledger |                               0.50    ledger | ||||||
|  | |||||||
| @ -1774,15 +1774,19 @@ this order of preference : | |||||||
| .IP "1." 3 | .IP "1." 3 | ||||||
| A \f[I]declared market price\f[R] or \f[I]inferred market price\f[R]: | 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 | 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 | declared by a P directive, or (with the \f[C]--infer-value\f[R] flag) | ||||||
| used) inferred from transaction prices. | inferred from transaction prices. | ||||||
| .IP "2." 3 | .IP "2." 3 | ||||||
| A \f[I]reverse market price\f[R]: the inverse of a declared or inferred | A \f[I]reverse market price\f[R]: the inverse of a declared or inferred | ||||||
| market price from B to A. | market price from B to A. | ||||||
| .IP "3." 3 | .IP "3." 3 | ||||||
| A \f[I]chained market price\f[R]: a synthetic price formed by combining | A \f[I]a forward chain of market prices\f[R]: a synthetic price formed | ||||||
| the shortest chain of market prices (any of the above types) leading | by combining the shortest chain of \[dq]forward\[dq] (only 1 above) | ||||||
| from A to B. | 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 | .PP | ||||||
| Amounts for which no applicable market price can be found, are not | Amounts for which no applicable market price can be found, are not | ||||||
| converted. | converted. | ||||||
| @ -3189,7 +3193,60 @@ Budget performance in 2017/11/01-2017/12/31: | |||||||
| \f[R] | \f[R] | ||||||
| .fi | .fi | ||||||
| .PP | .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 | .SS Nested budgets | ||||||
| .PP | .PP | ||||||
| You can add budgets to any account in your account hierarchy. | 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 |   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 |      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. |      transaction prices. | ||||||
| 
 | 
 | ||||||
|   2. A _reverse market price_: the inverse of a declared or inferred |   2. A _reverse market price_: the inverse of a declared or inferred | ||||||
|      market price from B to A. |      market price from B to A. | ||||||
| 
 | 
 | ||||||
|   3. A _chained market price_: a synthetic price formed by combining the |   3. A _a forward chain of market prices_: a synthetic price formed by | ||||||
|      shortest chain of market prices (any of the above types) leading |      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. |      from A to B. | ||||||
| 
 | 
 | ||||||
|    Amounts for which no applicable market price can be found, are not |    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]  |                       ||      0 [              0]       0 [              0]  | ||||||
| 
 | 
 | ||||||
|    For more examples, see Budgeting and Forecasting. |    For more examples and notes, see Budgeting. | ||||||
| 
 | 
 | ||||||
| * Menu: | * Menu: | ||||||
| 
 | 
 | ||||||
|  | * Budget report start date:: | ||||||
| * Nested budgets:: | * 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 | You can add budgets to any account in your account hierarchy.  If you | ||||||
| @ -4407,138 +4456,140 @@ Node: Valuation date49953 | |||||||
| Ref: #valuation-date50121 | Ref: #valuation-date50121 | ||||||
| Node: Market prices50543 | Node: Market prices50543 | ||||||
| Ref: #market-prices50723 | Ref: #market-prices50723 | ||||||
| Node: --infer-value market prices from transactions51500 | Node: --infer-value market prices from transactions51665 | ||||||
| Ref: #infer-value-market-prices-from-transactions51749 | Ref: #infer-value-market-prices-from-transactions51914 | ||||||
| Node: Valuation commodity53031 | Node: Valuation commodity53196 | ||||||
| Ref: #valuation-commodity53240 | Ref: #valuation-commodity53405 | ||||||
| Node: Simple valuation examples54466 | Node: Simple valuation examples54631 | ||||||
| Ref: #simple-valuation-examples54668 | Ref: #simple-valuation-examples54833 | ||||||
| Node: --value Flexible valuation55327 | Node: --value Flexible valuation55492 | ||||||
| Ref: #value-flexible-valuation55535 | Ref: #value-flexible-valuation55700 | ||||||
| Node: More valuation examples57482 | Node: More valuation examples57647 | ||||||
| Ref: #more-valuation-examples57691 | Ref: #more-valuation-examples57856 | ||||||
| Node: Effect of valuation on reports59696 | Node: Effect of valuation on reports59861 | ||||||
| Ref: #effect-of-valuation-on-reports59884 | Ref: #effect-of-valuation-on-reports60049 | ||||||
| Node: COMMANDS66903 | Node: COMMANDS67068 | ||||||
| Ref: #commands67011 | Ref: #commands67176 | ||||||
| Node: accounts68119 | Node: accounts68284 | ||||||
| Ref: #accounts68217 | Ref: #accounts68382 | ||||||
| Node: activity68916 | Node: activity69081 | ||||||
| Ref: #activity69026 | Ref: #activity69191 | ||||||
| Node: add69409 | Node: add69574 | ||||||
| Ref: #add69510 | Ref: #add69675 | ||||||
| Node: aregister72303 | Node: aregister72468 | ||||||
| Ref: #aregister72415 | Ref: #aregister72580 | ||||||
| Node: aregister and custom posting dates73788 | Node: aregister and custom posting dates73953 | ||||||
| Ref: #aregister-and-custom-posting-dates73961 | Ref: #aregister-and-custom-posting-dates74126 | ||||||
| Ref: #output-format-174554 | Ref: #output-format-174719 | ||||||
| Node: balance74959 | Node: balance75124 | ||||||
| Ref: #balance75076 | Ref: #balance75241 | ||||||
| Node: Classic balance report76556 | Node: Classic balance report76721 | ||||||
| Ref: #classic-balance-report76729 | Ref: #classic-balance-report76894 | ||||||
| Node: Customising the classic balance report78053 | Node: Customising the classic balance report78218 | ||||||
| Ref: #customising-the-classic-balance-report78281 | Ref: #customising-the-classic-balance-report78446 | ||||||
| Node: Colour support80357 | Node: Colour support80522 | ||||||
| Ref: #colour-support80524 | Ref: #colour-support80689 | ||||||
| Node: Flat mode80620 | Node: Flat mode80785 | ||||||
| Ref: #flat-mode80768 | Ref: #flat-mode80933 | ||||||
| Node: Depth limited balance reports81181 | Node: Depth limited balance reports81346 | ||||||
| Ref: #depth-limited-balance-reports81366 | Ref: #depth-limited-balance-reports81531 | ||||||
| Node: Percentages81822 | Node: Percentages81987 | ||||||
| Ref: #percentages81979 | Ref: #percentages82144 | ||||||
| Node: Sorting by amount83116 | Node: Sorting by amount83281 | ||||||
| Ref: #sorting-by-amount83282 | Ref: #sorting-by-amount83447 | ||||||
| Node: Multicolumn balance report83776 | Node: Multicolumn balance report83941 | ||||||
| Ref: #multicolumn-balance-report83962 | Ref: #multicolumn-balance-report84127 | ||||||
| Node: Budget report89559 | Node: Budget report89724 | ||||||
| Ref: #budget-report89702 | Ref: #budget-report89867 | ||||||
| Node: Nested budgets94968 | Node: Budget report start date95156 | ||||||
| Ref: #nested-budgets95080 | Ref: #budget-report-start-date95321 | ||||||
| Ref: #output-format-298563 | Node: Nested budgets96653 | ||||||
| Node: balancesheet98724 | Ref: #nested-budgets96798 | ||||||
| Ref: #balancesheet98860 | Ref: #output-format-2100281 | ||||||
| Node: balancesheetequity100372 | Node: balancesheet100442 | ||||||
| Ref: #balancesheetequity100521 | Ref: #balancesheet100578 | ||||||
| Node: cashflow101597 | Node: balancesheetequity102090 | ||||||
| Ref: #cashflow101725 | Ref: #balancesheetequity102239 | ||||||
| Node: check-dates102941 | Node: cashflow103315 | ||||||
| Ref: #check-dates103068 | Ref: #cashflow103443 | ||||||
| Node: check-dupes103347 | Node: check-dates104659 | ||||||
| Ref: #check-dupes103473 | Ref: #check-dates104786 | ||||||
| Node: close103766 | Node: check-dupes105065 | ||||||
| Ref: #close103874 | Ref: #check-dupes105191 | ||||||
| Node: close usage105396 | Node: close105484 | ||||||
| Ref: #close-usage105489 | Ref: #close105592 | ||||||
| Node: codes108302 | Node: close usage107114 | ||||||
| Ref: #codes108410 | Ref: #close-usage107207 | ||||||
| Node: commodities109122 | Node: codes110020 | ||||||
| Ref: #commodities109249 | Ref: #codes110128 | ||||||
| Node: descriptions109331 | Node: commodities110840 | ||||||
| Ref: #descriptions109459 | Ref: #commodities110967 | ||||||
| Node: diff109763 | Node: descriptions111049 | ||||||
| Ref: #diff109869 | Ref: #descriptions111177 | ||||||
| Node: files110916 | Node: diff111481 | ||||||
| Ref: #files111016 | Ref: #diff111587 | ||||||
| Node: help111163 | Node: files112634 | ||||||
| Ref: #help111263 | Ref: #files112734 | ||||||
| Node: import112344 | Node: help112881 | ||||||
| Ref: #import112458 | Ref: #help112981 | ||||||
| Node: Importing balance assignments113380 | Node: import114062 | ||||||
| Ref: #importing-balance-assignments113561 | Ref: #import114176 | ||||||
| Node: Commodity display styles114210 | Node: Importing balance assignments115098 | ||||||
| Ref: #commodity-display-styles114381 | Ref: #importing-balance-assignments115279 | ||||||
| Node: incomestatement114510 | Node: Commodity display styles115928 | ||||||
| Ref: #incomestatement114643 | Ref: #commodity-display-styles116099 | ||||||
| Node: notes115988 | Node: incomestatement116228 | ||||||
| Ref: #notes116101 | Ref: #incomestatement116361 | ||||||
| Node: payees116469 | Node: notes117706 | ||||||
| Ref: #payees116575 | Ref: #notes117819 | ||||||
| Node: prices116995 | Node: payees118187 | ||||||
| Ref: #prices117101 | Ref: #payees118293 | ||||||
| Node: print117442 | Node: prices118713 | ||||||
| Ref: #print117552 | Ref: #prices118819 | ||||||
| Node: print-unique122348 | Node: print119160 | ||||||
| Ref: #print-unique122474 | Ref: #print119270 | ||||||
| Node: register122759 | Node: print-unique124066 | ||||||
| Ref: #register122886 | Ref: #print-unique124192 | ||||||
| Node: Custom register output127335 | Node: register124477 | ||||||
| Ref: #custom-register-output127464 | Ref: #register124604 | ||||||
| Node: register-match128801 | Node: Custom register output129053 | ||||||
| Ref: #register-match128935 | Ref: #custom-register-output129182 | ||||||
| Node: rewrite129286 | Node: register-match130519 | ||||||
| Ref: #rewrite129401 | Ref: #register-match130653 | ||||||
| Node: Re-write rules in a file131256 | Node: rewrite131004 | ||||||
| Ref: #re-write-rules-in-a-file131390 | Ref: #rewrite131119 | ||||||
| Node: Diff output format132600 | Node: Re-write rules in a file132974 | ||||||
| Ref: #diff-output-format132769 | Ref: #re-write-rules-in-a-file133108 | ||||||
| Node: rewrite vs print --auto133861 | Node: Diff output format134318 | ||||||
| Ref: #rewrite-vs.-print---auto134040 | Ref: #diff-output-format134487 | ||||||
| Node: roi134596 | Node: rewrite vs print --auto135579 | ||||||
| Ref: #roi134694 | Ref: #rewrite-vs.-print---auto135758 | ||||||
| Node: stats146904 | Node: roi136314 | ||||||
| Ref: #stats147003 | Ref: #roi136412 | ||||||
| Node: tags147791 | Node: stats148622 | ||||||
| Ref: #tags147889 | Ref: #stats148721 | ||||||
| Node: test148408 | Node: tags149509 | ||||||
| Ref: #test148516 | Ref: #tags149607 | ||||||
| Node: Add-on commands149263 | Node: test150126 | ||||||
| Ref: #add-on-commands149380 | Ref: #test150234 | ||||||
| Node: ui150723 | Node: Add-on commands150981 | ||||||
| Ref: #ui150811 | Ref: #add-on-commands151098 | ||||||
| Node: web150865 | Node: ui152441 | ||||||
| Ref: #web150968 | Ref: #ui152529 | ||||||
| Node: iadd151084 | Node: web152583 | ||||||
| Ref: #iadd151195 | Ref: #web152686 | ||||||
| Node: interest151277 | Node: iadd152802 | ||||||
| Ref: #interest151384 | Ref: #iadd152913 | ||||||
| Node: ENVIRONMENT151624 | Node: interest152995 | ||||||
| Ref: #environment151736 | Ref: #interest153102 | ||||||
| Node: FILES152721 | Node: ENVIRONMENT153342 | ||||||
| Ref: #files-1152824 | Ref: #environment153454 | ||||||
| Node: LIMITATIONS153037 | Node: FILES154439 | ||||||
| Ref: #limitations153156 | Ref: #files-1154542 | ||||||
| Node: TROUBLESHOOTING153898 | Node: LIMITATIONS154755 | ||||||
| Ref: #troubleshooting154011 | Ref: #limitations154874 | ||||||
|  | Node: TROUBLESHOOTING155616 | ||||||
|  | Ref: #troubleshooting155729 | ||||||
|  |  | ||||||
| End Tag Table | End Tag Table | ||||||
| 
 | 
 | ||||||
|  | |||||||
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
		Loading…
	
		Reference in New Issue
	
	Block a user