;doc: update manuals
This commit is contained in:
		
							parent
							
								
									6b174ae8a5
								
							
						
					
					
						commit
						2bce910904
					
				| @ -1,2 +1,2 @@ | |||||||
| m4_dnl Date to show in man pages. Updated by "Shake manuals" | m4_dnl Date to show in man pages. Updated by "Shake manuals" | ||||||
| m4_define({{_monthyear_}}, {{April 2022}})m4_dnl | m4_define({{_monthyear_}}, {{May 2022}})m4_dnl | ||||||
|  | |||||||
| @ -1,2 +1,2 @@ | |||||||
| m4_dnl Date to show in man pages. Updated by "Shake manuals" | m4_dnl Date to show in man pages. Updated by "Shake manuals" | ||||||
| m4_define({{_monthyear_}}, {{April 2022}})m4_dnl | m4_define({{_monthyear_}}, {{May 2022}})m4_dnl | ||||||
|  | |||||||
| @ -1,5 +1,5 @@ | |||||||
| 
 | 
 | ||||||
| .TH "HLEDGER-UI" "1" "April 2022" "hledger-ui-1.25.99 " "hledger User Manuals" | .TH "HLEDGER-UI" "1" "May 2022" "hledger-ui-1.25.99 " "hledger User Manuals" | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -548,4 +548,4 @@ SEE ALSO | |||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| hledger-ui-1.25.99                April 2022                     HLEDGER-UI(1) | hledger-ui-1.25.99                 May 2022                      HLEDGER-UI(1) | ||||||
|  | |||||||
| @ -1,2 +1,2 @@ | |||||||
| m4_dnl Date to show in man pages. Updated by "Shake manuals" | m4_dnl Date to show in man pages. Updated by "Shake manuals" | ||||||
| m4_define({{_monthyear_}}, {{April 2022}})m4_dnl | m4_define({{_monthyear_}}, {{May 2022}})m4_dnl | ||||||
|  | |||||||
| @ -1,5 +1,5 @@ | |||||||
| 
 | 
 | ||||||
| .TH "HLEDGER-WEB" "1" "April 2022" "hledger-web-1.25.99 " "hledger User Manuals" | .TH "HLEDGER-WEB" "1" "May 2022" "hledger-web-1.25.99 " "hledger User Manuals" | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -585,4 +585,4 @@ SEE ALSO | |||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| hledger-web-1.25.99               April 2022                    HLEDGER-WEB(1) | hledger-web-1.25.99                May 2022                     HLEDGER-WEB(1) | ||||||
|  | |||||||
| @ -1,2 +1,2 @@ | |||||||
| m4_dnl Date to show in man pages. Updated by "Shake manuals" | m4_dnl Date to show in man pages. Updated by "Shake manuals" | ||||||
| m4_define({{_monthyear_}}, {{April 2022}})m4_dnl | m4_define({{_monthyear_}}, {{May 2022}})m4_dnl | ||||||
|  | |||||||
| @ -1,6 +1,6 @@ | |||||||
| .\"t | .\"t | ||||||
| 
 | 
 | ||||||
| .TH "HLEDGER" "1" "April 2022" "hledger-1.25.99 " "hledger User Manuals" | .TH "HLEDGER" "1" "May 2022" "hledger-1.25.99 " "hledger User Manuals" | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| @ -1155,7 +1155,7 @@ Examples: | |||||||
| .PP | .PP | ||||||
| .TS | .TS | ||||||
| tab(@); | tab(@); | ||||||
| lw(25.5n) lw(44.5n). | lw(26.0n) lw(44.0n). | ||||||
| T{ | T{ | ||||||
| \f[C]-p \[dq]bimonthly from 2008\[dq]\f[R] | \f[C]-p \[dq]bimonthly from 2008\[dq]\f[R] | ||||||
| T}@T{ | T}@T{ | ||||||
| @ -1167,7 +1167,7 @@ T}@T{ | |||||||
| starts on closest preceding Monday | starts on closest preceding Monday | ||||||
| T} | T} | ||||||
| T{ | T{ | ||||||
| \f[C]-p \[dq]every 5 month from 2009/03\[dq]\f[R] | \f[C]-p \[dq]every 5 months from 2009/03\[dq]\f[R] | ||||||
| T}@T{ | T}@T{ | ||||||
| periods will have boundaries on 2009/03/01, 2009/08/01, ... | periods will have boundaries on 2009/03/01, 2009/08/01, ... | ||||||
| T} | T} | ||||||
| @ -3023,10 +3023,11 @@ Many hledger users edit their journals directly with a text editor, or | |||||||
| generate them from CSV. | generate them from CSV. | ||||||
| For more interactive data entry, there is the \f[C]add\f[R] command, | For more interactive data entry, there is the \f[C]add\f[R] command, | ||||||
| which prompts interactively on the console for new transactions, and | which prompts interactively on the console for new transactions, and | ||||||
| appends them to the journal file (if there are multiple | appends them to the main journal file (which should be in journal | ||||||
| \f[C]-f FILE\f[R] options, the first file is used.) Existing | format). | ||||||
| transactions are not changed. | Existing transactions are not changed. | ||||||
| This is the only hledger command that writes to the journal file. | This is one of the few hledger commands that writes to the journal file | ||||||
|  | (see also \f[C]import\f[R]). | ||||||
| .PP | .PP | ||||||
| To use it, just run \f[C]hledger add\f[R] and follow the prompts. | To use it, just run \f[C]hledger add\f[R] and follow the prompts. | ||||||
| You can add as many transactions as you like; when you are finished, | You can add as many transactions as you like; when you are finished, | ||||||
| @ -4539,17 +4540,36 @@ cashflow, cf | |||||||
| .P | .P | ||||||
| .PD | .PD | ||||||
| This command displays a cashflow statement, showing the inflows and | This command displays a cashflow statement, showing the inflows and | ||||||
| outflows affecting \[dq]cash\[dq] (ie, liquid) assets. | outflows affecting \[dq]cash\[dq] (ie, liquid, easily convertible) | ||||||
|  | assets. | ||||||
| Amounts are shown with normal positive sign, as in conventional | Amounts are shown with normal positive sign, as in conventional | ||||||
| financial statements. | financial statements. | ||||||
| .PP | .PP | ||||||
| The \[dq]cash\[dq] accounts shown are those accounts declared with the | \[dq]Cash\[dq] assets are those accounts which are (or whose parents | ||||||
| \f[C]Cash\f[R] type, or otherwise all accounts under a top-level | are) declared as \f[C]Cash\f[R] by an account directive, like this: | ||||||
| \f[C]asset\f[R] account (case insensitive, plural allowed) which do not | .IP | ||||||
| have \f[C]fixed\f[R], \f[C]investment\f[R], \f[C]receivable\f[R] or | .nf | ||||||
| \f[C]A/R\f[R] in their name. | \f[C] | ||||||
|  | account some:liquid:asset    ; type:C | ||||||
|  | \f[R] | ||||||
|  | .fi | ||||||
| .PP | .PP | ||||||
| Example: | Or if there are no such declarations, all accounts | ||||||
|  | .IP \[bu] 2 | ||||||
|  | under a top-level \f[C]asset\f[R] account (case insensitive, plural | ||||||
|  | allowed) | ||||||
|  | .IP \[bu] 2 | ||||||
|  | with some variation of \f[C]cash\f[R], \f[C]bank\f[R], | ||||||
|  | \f[C]checking\f[R] or \f[C]saving\f[R] in their name. | ||||||
|  | .PP | ||||||
|  | More precisely: all accounts matching this case insensitive regular | ||||||
|  | expression: | ||||||
|  | .PP | ||||||
|  | \f[C]\[ha]assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|currentcash)(:|$)\f[R] | ||||||
|  | .PP | ||||||
|  | and their subaccounts. | ||||||
|  | .PP | ||||||
|  | An example cashflow report: | ||||||
| .IP | .IP | ||||||
| .nf | .nf | ||||||
| \f[C] | \f[C] | ||||||
| @ -5118,11 +5138,17 @@ import | |||||||
| .P | .P | ||||||
| .PD | .PD | ||||||
| Read new transactions added to each FILE since last run, and add them to | Read new transactions added to each FILE since last run, and add them to | ||||||
| the main journal file. | the journal. | ||||||
| Or with --dry-run, just print the transactions that would be added. | Or with --dry-run, just print the transactions that would be added. | ||||||
| Or with --catchup, just mark all of the FILEs\[aq] transactions as | Or with --catchup, just mark all of the FILEs\[aq] transactions as | ||||||
| imported, without actually importing any. | imported, without actually importing any. | ||||||
| .PP | .PP | ||||||
|  | This command may append new transactions to the main journal file (which | ||||||
|  | should be in journal format). | ||||||
|  | Existing transactions are not changed. | ||||||
|  | This is one of the few hledger commands that writes to the journal file | ||||||
|  | (see also \f[C]add\f[R]). | ||||||
|  | .PP | ||||||
| Unlike other hledger commands, with \f[C]import\f[R] the journal file is | Unlike other hledger commands, with \f[C]import\f[R] the journal file is | ||||||
| an output file, and will be modified, though only by appending (existing | an output file, and will be modified, though only by appending (existing | ||||||
| data will not be changed). | data will not be changed). | ||||||
| @ -9812,7 +9838,7 @@ A number of other tools and workflows, hledger-specific and otherwise, | |||||||
| exist for converting, deduplicating, classifying and managing CSV data. | exist for converting, deduplicating, classifying and managing CSV data. | ||||||
| See: | See: | ||||||
| .IP \[bu] 2 | .IP \[bu] 2 | ||||||
| https://hledger.org -> sidebar -> real world setups | https://hledger.org/cookbook.html#setups-and-workflows | ||||||
| .IP \[bu] 2 | .IP \[bu] 2 | ||||||
| https://plaintextaccounting.org -> data import/conversion | https://plaintextaccounting.org -> data import/conversion | ||||||
| .SS Setting amounts | .SS Setting amounts | ||||||
| @ -10430,13 +10456,13 @@ https://hledger.org. | |||||||
| .IP | .IP | ||||||
| .nf | .nf | ||||||
| \f[C] | \f[C] | ||||||
| $ hledger                 # show available commands | $ hledger                  # show available commands | ||||||
| $ hledger --help          # show common options | $ hledger --help           # show common options | ||||||
| $ hledger CMD --help      # show common and command options, and command help | $ hledger CMD --help       # show common and command options, and command help | ||||||
| $ hledger help            # show available manuals/topics | $ hledger help             # show available manuals/topics | ||||||
| $ hledger help hledger    # show hledger manual as info/man/text (auto-chosen) | $ hledger help hledger     # show hledger manual, as info/man/text (auto-chosen) | ||||||
| $ hledger help journal --man  # show the journal manual as a man page | $ hledger help journal -m  # show the journal topic, as a man page scrolled to that section | ||||||
| $ hledger help --help     # show more detailed help for the help command | $ hledger help --help      # show more detailed help for the help command | ||||||
| \f[R] | \f[R] | ||||||
| .fi | .fi | ||||||
| .PP | .PP | ||||||
|  | |||||||
							
								
								
									
										1070
									
								
								hledger/hledger.info
									
									
									
									
									
								
							
							
						
						
									
										1070
									
								
								hledger/hledger.info
									
									
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										1919
									
								
								hledger/hledger.txt
									
									
									
									
									
								
							
							
						
						
									
										1919
									
								
								hledger/hledger.txt
									
									
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
		Loading…
	
		Reference in New Issue
	
	Block a user