;doc: update CLI usage texts
This commit is contained in:
		
							parent
							
								
									f8cc6edbde
								
							
						
					
					
						commit
						085b7d4b88
					
				| @ -234,7 +234,10 @@ Sorting by amount | |||||||
| 
 | 
 | ||||||
| With -S/--sort-amount, accounts with the largest (most positive) | With -S/--sort-amount, accounts with the largest (most positive) | ||||||
| balances are shown first. Eg: hledger bal expenses -MAS shows your | balances are shown first. Eg: hledger bal expenses -MAS shows your | ||||||
| biggest averaged monthly expenses first. | biggest averaged monthly expenses first. When more than one commodity is | ||||||
|  | present, they will be sorted by the alphabetically earliest commodity | ||||||
|  | first, and then by subsequent commodities (if an amount is missing a | ||||||
|  | commodity, it is treated as 0). | ||||||
| 
 | 
 | ||||||
| Revenues and liability balances are typically negative, however, so -S | Revenues and liability balances are typically negative, however, so -S | ||||||
| shows these in reverse order. To work around this, you can add --invert | shows these in reverse order. To work around this, you can add --invert | ||||||
| @ -579,7 +582,7 @@ Budget performance in 2020-01-01..2020-01-15: | |||||||
| ---------------++------------------------ | ---------------++------------------------ | ||||||
|                ||     $400 [80% of $500]  |                ||     $400 [80% of $500]  | ||||||
| 
 | 
 | ||||||
| Nested budgets | Budgets and subaccounts | ||||||
| 
 | 
 | ||||||
| You can add budgets to any account in your account hierarchy. If you | You can add budgets to any account in your account hierarchy. If you | ||||||
| have budgets on both parent account and some of its children, then | have budgets on both parent account and some of its children, then | ||||||
| @ -664,6 +667,28 @@ Budget performance in 2019/01: | |||||||
| ----------------------------------------++------------------------------- | ----------------------------------------++------------------------------- | ||||||
|                                         ||        0 [                 0]  |                                         ||        0 [                 0]  | ||||||
| 
 | 
 | ||||||
|  | Selecting budget goals | ||||||
|  | 
 | ||||||
|  | The budget report evaluates periodic transaction rules to generate | ||||||
|  | special "goal transactions", which generate the goal amounts for each | ||||||
|  | account in each report subperiod. When troubleshooting, you can use the | ||||||
|  | print command to show these as forecasted transactions: | ||||||
|  | 
 | ||||||
|  | $ hledger print --forecast=BUDGETREPORTPERIOD tag:generated | ||||||
|  | 
 | ||||||
|  | By default, the budget report uses all available periodic transaction | ||||||
|  | rules to generate goals. This includes rules with a different report | ||||||
|  | interval from your report. Eg if you have daily, weekly and monthly | ||||||
|  | periodic rules, all of these will contribute to the goals in a monthly | ||||||
|  | budget report. | ||||||
|  | 
 | ||||||
|  | You can select a subset of periodic rules by providing an argument to | ||||||
|  | the --budget flag. --budget=DESCPAT will match all periodic rules whose | ||||||
|  | description contains DESCPAT, a case-insensitive substring (not a | ||||||
|  | regular expression or query). This means you can give your periodic | ||||||
|  | rules descriptions (remember that two spaces are needed), and then | ||||||
|  | select from multiple budgets defined in your journal. | ||||||
|  | 
 | ||||||
| Customising single-period balance reports | Customising single-period balance reports | ||||||
| 
 | 
 | ||||||
| For single-period balance reports displayed in the terminal (only), you | For single-period balance reports displayed in the terminal (only), you | ||||||
|  | |||||||
| @ -37,6 +37,21 @@ Examples: | |||||||
| 
 | 
 | ||||||
| -   Cookbook -> Return on Investment | -   Cookbook -> Return on Investment | ||||||
| 
 | 
 | ||||||
|  | Spaces and special characters in --inv and --pnl | ||||||
|  | 
 | ||||||
|  | Note that --inv and --pnl's argument is a query, and queries could have | ||||||
|  | several space-separated terms (see QUERIES). | ||||||
|  | 
 | ||||||
|  | To indicate that all search terms form single command-line argument, you | ||||||
|  | will need to put them in quotes (see Special characters): | ||||||
|  | 
 | ||||||
|  | $ hledger roi --inv 'term1 term2 term3 ...' | ||||||
|  | 
 | ||||||
|  | If any query terms contain spaces themselves, you will need an extra | ||||||
|  | level of nested quoting, eg: | ||||||
|  | 
 | ||||||
|  | $ hledger roi --inv="'Assets:Test 1'" --pnl="'Equity:Unrealized Profit and Loss'" | ||||||
|  | 
 | ||||||
| Semantics of --inv and --pnl | Semantics of --inv and --pnl | ||||||
| 
 | 
 | ||||||
| Query supplied to --inv has to match all transactions that are related | Query supplied to --inv has to match all transactions that are related | ||||||
|  | |||||||
		Loading…
	
		Reference in New Issue
	
	Block a user