doc: define general options once
Well, twice: in lib.m4 and in CliOptions.hs. But no longer in every man page.
This commit is contained in:
		
							parent
							
								
									df07ad0109
								
							
						
					
					
						commit
						656734ccd3
					
				
							
								
								
									
										34
									
								
								doc/lib.m4
									
									
									
									
									
								
							
							
						
						
									
										34
									
								
								doc/lib.m4
									
									
									
									
									
								
							| @ -52,3 +52,37 @@ m4_define({{_csv_}},       {{```csv$1```}}            )m4_dnl | |||||||
| m4_define({{_rules_}},     {{```rules$1```}}          )m4_dnl | m4_define({{_rules_}},     {{```rules$1```}}          )m4_dnl | ||||||
| m4_define({{_timeclock_}}, {{```timeclock$1```}}      )m4_dnl | m4_define({{_timeclock_}}, {{```timeclock$1```}}      )m4_dnl | ||||||
| m4_define({{_timedot_}},   {{```timedot$1```}}        )m4_dnl | m4_define({{_timedot_}},   {{```timedot$1```}}        )m4_dnl | ||||||
|  | m4_dnl | ||||||
|  | m4_define({{_generaloptions_}}, {{ | ||||||
|  | 
 | ||||||
|  | `-h` | ||||||
|  | : show general usage (or if after COMMAND, the command's usage) | ||||||
|  | 
 | ||||||
|  | `--help` | ||||||
|  | : show the current program's manual as plain text (or after an add-on COMMAND, the add-on's manual) | ||||||
|  | 
 | ||||||
|  | `--man` | ||||||
|  | : show the current program's manual with man | ||||||
|  | 
 | ||||||
|  | `--info` | ||||||
|  | : show the current program's manual with info | ||||||
|  | 
 | ||||||
|  | `--version` | ||||||
|  | : show version | ||||||
|  | 
 | ||||||
|  | `--debug=N` | ||||||
|  | : show debug output if N is 1-9 (default: 0) | ||||||
|  | 
 | ||||||
|  | `-f FILE --file=FILE` | ||||||
|  | : use a different input file. For stdin, use - | ||||||
|  | 
 | ||||||
|  | `--rules-file=RULESFILE` | ||||||
|  | : Conversion rules file to use when reading CSV (default: FILE.rules) | ||||||
|  | 
 | ||||||
|  | `--alias=OLD=NEW` | ||||||
|  | : display accounts named OLD as NEW | ||||||
|  | 
 | ||||||
|  | `--ignore-assertions` | ||||||
|  | : ignore any failing balance assertions in the journal | ||||||
|  | 
 | ||||||
|  | }} )m4_dnl | ||||||
|  | |||||||
| @ -69,22 +69,23 @@ print API docs in Swagger 2.0 format, and exit | |||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-h\f[] | .B \f[C]\-h\f[] | ||||||
| show usage | show general usage (or if after COMMAND, the command\[aq]s usage) | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-\-help\f[] | .B \f[C]\-\-help\f[] | ||||||
| show manual | show the current program\[aq]s manual as plain text (or after an add\-on | ||||||
|  | COMMAND, the add\-on\[aq]s manual) | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-\-man\f[] | .B \f[C]\-\-man\f[] | ||||||
| show manual with man | show the current program\[aq]s manual with man | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-\-info\f[] | .B \f[C]\-\-info\f[] | ||||||
| show manual with info | show the current program\[aq]s manual with info | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| @ -92,6 +93,32 @@ show manual with info | |||||||
| show version | show version | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-debug=N\f[] | ||||||
|  | show debug output if N is 1\-9 (default: 0) | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-f\ FILE\ \-\-file=FILE\f[] | ||||||
|  | use a different input file. | ||||||
|  | For stdin, use \- | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-rules\-file=RULESFILE\f[] | ||||||
|  | Conversion rules file to use when reading CSV (default: FILE.rules) | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-alias=OLD=NEW\f[] | ||||||
|  | display accounts named OLD as NEW | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-ignore\-assertions\f[] | ||||||
|  | ignore any failing balance assertions in the journal | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
| .SH ENVIRONMENT | .SH ENVIRONMENT | ||||||
| .PP | .PP | ||||||
| \f[B]LEDGER_FILE\f[] sets the default journal file path. | \f[B]LEDGER_FILE\f[] sets the default journal file path. | ||||||
|  | |||||||
| @ -50,20 +50,36 @@ before options as shown above. | |||||||
|      print API docs in Swagger 2.0 format, and exit |      print API docs in Swagger 2.0 format, and exit | ||||||
| 
 | 
 | ||||||
| `-h' | `-h' | ||||||
|      show usage |      show general usage (or if after COMMAND, the command's usage) | ||||||
| 
 | 
 | ||||||
| `--help' | `--help' | ||||||
|      show manual |      show the current program's manual as plain text (or after an add-on | ||||||
|  |      COMMAND, the add-on's manual) | ||||||
| 
 | 
 | ||||||
| `--man' | `--man' | ||||||
|      show manual with man |      show the current program's manual with man | ||||||
| 
 | 
 | ||||||
| `--info' | `--info' | ||||||
|      show manual with info |      show the current program's manual with info | ||||||
| 
 | 
 | ||||||
| `--version' | `--version' | ||||||
|      show version |      show version | ||||||
| 
 | 
 | ||||||
|  | `--debug=N' | ||||||
|  |      show debug output if N is 1-9 (default: 0) | ||||||
|  | 
 | ||||||
|  | `-f FILE --file=FILE' | ||||||
|  |      use a different input file. For stdin, use - | ||||||
|  | 
 | ||||||
|  | `--rules-file=RULESFILE' | ||||||
|  |      Conversion rules file to use when reading CSV (default: FILE.rules) | ||||||
|  | 
 | ||||||
|  | `--alias=OLD=NEW' | ||||||
|  |      display accounts named OLD as NEW | ||||||
|  | 
 | ||||||
|  | `--ignore-assertions' | ||||||
|  |      ignore any failing balance assertions in the journal | ||||||
|  | 
 | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
| Tag Table: | Tag Table: | ||||||
|  | |||||||
| @ -62,20 +62,7 @@ Note: if invoking hledger-api as a hledger subcommand, write `--` before options | |||||||
| `--swagger` | `--swagger` | ||||||
| : print API docs in Swagger 2.0 format, and exit | : print API docs in Swagger 2.0 format, and exit | ||||||
| 
 | 
 | ||||||
| `-h` | _generaloptions_ | ||||||
| : show usage |  | ||||||
| 
 |  | ||||||
| `--help` |  | ||||||
| : show manual |  | ||||||
| 
 |  | ||||||
| `--man` |  | ||||||
| : show manual with man |  | ||||||
| 
 |  | ||||||
| `--info` |  | ||||||
| : show manual with info |  | ||||||
| 
 |  | ||||||
| `--version` |  | ||||||
| : show version |  | ||||||
| 
 | 
 | ||||||
| _man_({{ | _man_({{ | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -50,17 +50,34 @@ OOPPTTIIOONNSS | |||||||
|        ----sswwaaggggeerr |        ----sswwaaggggeerr | ||||||
|               print API docs in Swagger 2.0 format, and exit |               print API docs in Swagger 2.0 format, and exit | ||||||
| 
 | 
 | ||||||
|        --hh     show usage |        --hh     show general usage (or if after COMMAND, the command's usage) | ||||||
| 
 | 
 | ||||||
|        ----hheellpp show manual |        ----hheellpp show the current program's manual as plain  text  (or  after  an | ||||||
|  |               add-on COMMAND, the add-on's manual) | ||||||
| 
 | 
 | ||||||
|        ----mmaann  show manual with man |        ----mmaann  show the current program's manual with man | ||||||
| 
 | 
 | ||||||
|        ----iinnffoo show manual with info |        ----iinnffoo show the current program's manual with info | ||||||
| 
 | 
 | ||||||
|        ----vveerrssiioonn |        ----vveerrssiioonn | ||||||
|               show version |               show version | ||||||
| 
 | 
 | ||||||
|  |        ----ddeebbuugg==NN | ||||||
|  |               show debug output if N is 1-9 (default: 0) | ||||||
|  | 
 | ||||||
|  |        --ff FFIILLEE ----ffiillee==FFIILLEE | ||||||
|  |               use a different input file.  For stdin, use - | ||||||
|  | 
 | ||||||
|  |        ----rruulleess--ffiillee==RRUULLEESSFFIILLEE | ||||||
|  |               Conversion   rules  file  to  use  when  reading  CSV  (default: | ||||||
|  |               FILE.rules) | ||||||
|  | 
 | ||||||
|  |        ----aalliiaass==OOLLDD==NNEEWW | ||||||
|  |               display accounts named OLD as NEW | ||||||
|  | 
 | ||||||
|  |        ----iiggnnoorree--aasssseerrttiioonnss | ||||||
|  |               ignore any failing balance assertions in the journal | ||||||
|  | 
 | ||||||
| EENNVVIIRROONNMMEENNTT | EENNVVIIRROONNMMEENNTT | ||||||
|        LLEEDDGGEERR__FFIILLEE sets the default journal file path.   If  not  set,  it  is |        LLEEDDGGEERR__FFIILLEE sets the default journal file path.   If  not  set,  it  is | ||||||
|        ~/.hledger.journal. |        ~/.hledger.journal. | ||||||
|  | |||||||
| @ -70,22 +70,23 @@ commodity (accounts screen only) | |||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-h\f[] | .B \f[C]\-h\f[] | ||||||
| show usage | show general usage (or if after COMMAND, the command\[aq]s usage) | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-\-help\f[] | .B \f[C]\-\-help\f[] | ||||||
| show manual | show the current program\[aq]s manual as plain text (or after an add\-on | ||||||
|  | COMMAND, the add\-on\[aq]s manual) | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-\-man\f[] | .B \f[C]\-\-man\f[] | ||||||
| show manual with man | show the current program\[aq]s manual with man | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-\-info\f[] | .B \f[C]\-\-info\f[] | ||||||
| show manual with info | show the current program\[aq]s manual with info | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| @ -93,6 +94,32 @@ show manual with info | |||||||
| show version | show version | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-debug=N\f[] | ||||||
|  | show debug output if N is 1\-9 (default: 0) | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-f\ FILE\ \-\-file=FILE\f[] | ||||||
|  | use a different input file. | ||||||
|  | For stdin, use \- | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-rules\-file=RULESFILE\f[] | ||||||
|  | Conversion rules file to use when reading CSV (default: FILE.rules) | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-alias=OLD=NEW\f[] | ||||||
|  | display accounts named OLD as NEW | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-ignore\-assertions\f[] | ||||||
|  | ignore any failing balance assertions in the journal | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
| .SS hledger options | .SS hledger options | ||||||
| .PP | .PP | ||||||
| The following common hledger options should also work: | The following common hledger options should also work: | ||||||
|  | |||||||
| @ -55,20 +55,36 @@ the data. | |||||||
|      valuation commodity (accounts screen only) |      valuation commodity (accounts screen only) | ||||||
| 
 | 
 | ||||||
| `-h' | `-h' | ||||||
|      show usage |      show general usage (or if after COMMAND, the command's usage) | ||||||
| 
 | 
 | ||||||
| `--help' | `--help' | ||||||
|      show manual |      show the current program's manual as plain text (or after an add-on | ||||||
|  |      COMMAND, the add-on's manual) | ||||||
| 
 | 
 | ||||||
| `--man' | `--man' | ||||||
|      show manual with man |      show the current program's manual with man | ||||||
| 
 | 
 | ||||||
| `--info' | `--info' | ||||||
|      show manual with info |      show the current program's manual with info | ||||||
| 
 | 
 | ||||||
| `--version' | `--version' | ||||||
|      show version |      show version | ||||||
| 
 | 
 | ||||||
|  | `--debug=N' | ||||||
|  |      show debug output if N is 1-9 (default: 0) | ||||||
|  | 
 | ||||||
|  | `-f FILE --file=FILE' | ||||||
|  |      use a different input file. For stdin, use - | ||||||
|  | 
 | ||||||
|  | `--rules-file=RULESFILE' | ||||||
|  |      Conversion rules file to use when reading CSV (default: FILE.rules) | ||||||
|  | 
 | ||||||
|  | `--alias=OLD=NEW' | ||||||
|  |      display accounts named OLD as NEW | ||||||
|  | 
 | ||||||
|  | `--ignore-assertions' | ||||||
|  |      ignore any failing balance assertions in the journal | ||||||
|  | 
 | ||||||
| * Menu: | * Menu: | ||||||
| 
 | 
 | ||||||
| * hledger options:: | * hledger options:: | ||||||
| @ -271,19 +287,19 @@ Tag Table: | |||||||
| Node: Top88 | Node: Top88 | ||||||
| Node: OPTIONS714 | Node: OPTIONS714 | ||||||
| Ref: #options813 | Ref: #options813 | ||||||
| Node: hledger options1579 | Node: hledger options2137 | ||||||
| Ref: #hledger-options1685 | Ref: #hledger-options2243 | ||||||
| Node: KEYS2868 | Node: KEYS3426 | ||||||
| Ref: #keys2965 | Ref: #keys3523 | ||||||
| Node: SCREENS3362 | Node: SCREENS3920 | ||||||
| Ref: #screens3449 | Ref: #screens4007 | ||||||
| Node: Accounts screen3539 | Node: Accounts screen4097 | ||||||
| Ref: #accounts-screen3669 | Ref: #accounts-screen4227 | ||||||
| Node: Register screen4514 | Node: Register screen5072 | ||||||
| Ref: #register-screen4671 | Ref: #register-screen5229 | ||||||
| Node: Transaction screen6053 | Node: Transaction screen6611 | ||||||
| Ref: #transaction-screen6213 | Ref: #transaction-screen6771 | ||||||
| Node: Error screen7080 | Node: Error screen7638 | ||||||
| Ref: #error-screen7204 | Ref: #error-screen7762 | ||||||
|  |  | ||||||
| End Tag Table | End Tag Table | ||||||
|  | |||||||
| @ -74,20 +74,7 @@ Any QUERYARGS are interpreted as a hledger search query which filters the data. | |||||||
| : show amounts as their current market value in their default valuation commodity | : show amounts as their current market value in their default valuation commodity | ||||||
| (accounts screen only) | (accounts screen only) | ||||||
| 
 | 
 | ||||||
| `-h` | _generaloptions_ | ||||||
| : show usage |  | ||||||
| 
 |  | ||||||
| `--help` |  | ||||||
| : show manual |  | ||||||
| 
 |  | ||||||
| `--man` |  | ||||||
| : show manual with man |  | ||||||
| 
 |  | ||||||
| `--info` |  | ||||||
| : show manual with info |  | ||||||
| 
 |  | ||||||
| `--version` |  | ||||||
| : show version |  | ||||||
| 
 | 
 | ||||||
| ## hledger options | ## hledger options | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -54,17 +54,34 @@ OOPPTTIIOONNSS | |||||||
|               show amounts as their current market value in their default val- |               show amounts as their current market value in their default val- | ||||||
|               uation commodity (accounts screen only) |               uation commodity (accounts screen only) | ||||||
| 
 | 
 | ||||||
|        --hh     show usage |        --hh     show general usage (or if after COMMAND, the command's usage) | ||||||
| 
 | 
 | ||||||
|        ----hheellpp show manual |        ----hheellpp show  the  current  program's  manual as plain text (or after an | ||||||
|  |               add-on COMMAND, the add-on's manual) | ||||||
| 
 | 
 | ||||||
|        ----mmaann  show manual with man |        ----mmaann  show the current program's manual with man | ||||||
| 
 | 
 | ||||||
|        ----iinnffoo show manual with info |        ----iinnffoo show the current program's manual with info | ||||||
| 
 | 
 | ||||||
|        ----vveerrssiioonn |        ----vveerrssiioonn | ||||||
|               show version |               show version | ||||||
| 
 | 
 | ||||||
|  |        ----ddeebbuugg==NN | ||||||
|  |               show debug output if N is 1-9 (default: 0) | ||||||
|  | 
 | ||||||
|  |        --ff FFIILLEE ----ffiillee==FFIILLEE | ||||||
|  |               use a different input file.  For stdin, use - | ||||||
|  | 
 | ||||||
|  |        ----rruulleess--ffiillee==RRUULLEESSFFIILLEE | ||||||
|  |               Conversion  rules  file  to  use  when  reading  CSV   (default: | ||||||
|  |               FILE.rules) | ||||||
|  | 
 | ||||||
|  |        ----aalliiaass==OOLLDD==NNEEWW | ||||||
|  |               display accounts named OLD as NEW | ||||||
|  | 
 | ||||||
|  |        ----iiggnnoorree--aasssseerrttiioonnss | ||||||
|  |               ignore any failing balance assertions in the journal | ||||||
|  | 
 | ||||||
|    hhlleeddggeerr ooppttiioonnss |    hhlleeddggeerr ooppttiioonnss | ||||||
|        The following common hledger options should also work: |        The following common hledger options should also work: | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -115,22 +115,23 @@ with this. | |||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-h\f[] | .B \f[C]\-h\f[] | ||||||
| show usage | show general usage (or if after COMMAND, the command\[aq]s usage) | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-\-help\f[] | .B \f[C]\-\-help\f[] | ||||||
| show manual | show the current program\[aq]s manual as plain text (or after an add\-on | ||||||
|  | COMMAND, the add\-on\[aq]s manual) | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-\-man\f[] | .B \f[C]\-\-man\f[] | ||||||
| show manual with man | show the current program\[aq]s manual with man | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-\-info\f[] | .B \f[C]\-\-info\f[] | ||||||
| show manual with info | show the current program\[aq]s manual with info | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| @ -138,6 +139,32 @@ show manual with info | |||||||
| show version | show version | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-debug=N\f[] | ||||||
|  | show debug output if N is 1\-9 (default: 0) | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-f\ FILE\ \-\-file=FILE\f[] | ||||||
|  | use a different input file. | ||||||
|  | For stdin, use \- | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-rules\-file=RULESFILE\f[] | ||||||
|  | Conversion rules file to use when reading CSV (default: FILE.rules) | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-alias=OLD=NEW\f[] | ||||||
|  | display accounts named OLD as NEW | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
|  | .B \f[C]\-\-ignore\-assertions\f[] | ||||||
|  | ignore any failing balance assertions in the journal | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
| .SS hledger options | .SS hledger options | ||||||
| .PP | .PP | ||||||
| The following common hledger options should also work: | The following common hledger options should also work: | ||||||
|  | |||||||
| @ -92,20 +92,36 @@ before options as shown above. | |||||||
|      with this. |      with this. | ||||||
| 
 | 
 | ||||||
| `-h' | `-h' | ||||||
|      show usage |      show general usage (or if after COMMAND, the command's usage) | ||||||
| 
 | 
 | ||||||
| `--help' | `--help' | ||||||
|      show manual |      show the current program's manual as plain text (or after an add-on | ||||||
|  |      COMMAND, the add-on's manual) | ||||||
| 
 | 
 | ||||||
| `--man' | `--man' | ||||||
|      show manual with man |      show the current program's manual with man | ||||||
| 
 | 
 | ||||||
| `--info' | `--info' | ||||||
|      show manual with info |      show the current program's manual with info | ||||||
| 
 | 
 | ||||||
| `--version' | `--version' | ||||||
|      show version |      show version | ||||||
| 
 | 
 | ||||||
|  | `--debug=N' | ||||||
|  |      show debug output if N is 1-9 (default: 0) | ||||||
|  | 
 | ||||||
|  | `-f FILE --file=FILE' | ||||||
|  |      use a different input file. For stdin, use - | ||||||
|  | 
 | ||||||
|  | `--rules-file=RULESFILE' | ||||||
|  |      Conversion rules file to use when reading CSV (default: FILE.rules) | ||||||
|  | 
 | ||||||
|  | `--alias=OLD=NEW' | ||||||
|  |      display accounts named OLD as NEW | ||||||
|  | 
 | ||||||
|  | `--ignore-assertions' | ||||||
|  |      ignore any failing balance assertions in the journal | ||||||
|  | 
 | ||||||
| * Menu: | * Menu: | ||||||
| 
 | 
 | ||||||
| * hledger options:: | * hledger options:: | ||||||
| @ -173,7 +189,7 @@ Tag Table: | |||||||
| Node: Top90 | Node: Top90 | ||||||
| Node: OPTIONS2868 | Node: OPTIONS2868 | ||||||
| Ref: #options2955 | Ref: #options2955 | ||||||
| Node: hledger options3818 | Node: hledger options4376 | ||||||
| Ref: #hledger-options3925 | Ref: #hledger-options4483 | ||||||
|  |  | ||||||
| End Tag Table | End Tag Table | ||||||
|  | |||||||
| @ -121,20 +121,7 @@ You would change this when sharing over the network, or integrating within a lar | |||||||
| hledger-web normally serves static files itself, but if you wanted to | hledger-web normally serves static files itself, but if you wanted to | ||||||
| serve them from another server for efficiency, you would set the url with this. | serve them from another server for efficiency, you would set the url with this. | ||||||
| 
 | 
 | ||||||
| `-h` | _generaloptions_ | ||||||
| : show usage |  | ||||||
| 
 |  | ||||||
| `--help` |  | ||||||
| : show manual |  | ||||||
| 
 |  | ||||||
| `--man` |  | ||||||
| : show manual with man |  | ||||||
| 
 |  | ||||||
| `--info` |  | ||||||
| : show manual with info |  | ||||||
| 
 |  | ||||||
| `--version` |  | ||||||
| : show version |  | ||||||
| 
 | 
 | ||||||
| ## hledger options | ## hledger options | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -92,17 +92,34 @@ OOPPTTIIOONNSS | |||||||
|               them  from  another server for efficiency, you would set the url |               them  from  another server for efficiency, you would set the url | ||||||
|               with this. |               with this. | ||||||
| 
 | 
 | ||||||
|        --hh     show usage |        --hh     show general usage (or if after COMMAND, the command's usage) | ||||||
| 
 | 
 | ||||||
|        ----hheellpp show manual |        ----hheellpp show the current program's manual as plain  text  (or  after  an | ||||||
|  |               add-on COMMAND, the add-on's manual) | ||||||
| 
 | 
 | ||||||
|        ----mmaann  show manual with man |        ----mmaann  show the current program's manual with man | ||||||
| 
 | 
 | ||||||
|        ----iinnffoo show manual with info |        ----iinnffoo show the current program's manual with info | ||||||
| 
 | 
 | ||||||
|        ----vveerrssiioonn |        ----vveerrssiioonn | ||||||
|               show version |               show version | ||||||
| 
 | 
 | ||||||
|  |        ----ddeebbuugg==NN | ||||||
|  |               show debug output if N is 1-9 (default: 0) | ||||||
|  | 
 | ||||||
|  |        --ff FFIILLEE ----ffiillee==FFIILLEE | ||||||
|  |               use a different input file.  For stdin, use - | ||||||
|  | 
 | ||||||
|  |        ----rruulleess--ffiillee==RRUULLEESSFFIILLEE | ||||||
|  |               Conversion   rules  file  to  use  when  reading  CSV  (default: | ||||||
|  |               FILE.rules) | ||||||
|  | 
 | ||||||
|  |        ----aalliiaass==OOLLDD==NNEEWW | ||||||
|  |               display accounts named OLD as NEW | ||||||
|  | 
 | ||||||
|  |        ----iiggnnoorree--aasssseerrttiioonnss | ||||||
|  |               ignore any failing balance assertions in the journal | ||||||
|  | 
 | ||||||
|    hhlleeddggeerr ooppttiioonnss |    hhlleeddggeerr ooppttiioonnss | ||||||
|        The following common hledger options should also work: |        The following common hledger options should also work: | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -218,6 +218,11 @@ show version | |||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
|  | .B \f[C]\-\-debug=N\f[] | ||||||
|  | show debug output if N is 1\-9 (default: 0) | ||||||
|  | .RS | ||||||
|  | .RE | ||||||
|  | .TP | ||||||
| .B \f[C]\-f\ FILE\ \-\-file=FILE\f[] | .B \f[C]\-f\ FILE\ \-\-file=FILE\f[] | ||||||
| use a different input file. | use a different input file. | ||||||
| For stdin, use \- | For stdin, use \- | ||||||
| @ -238,11 +243,6 @@ display accounts named OLD as NEW | |||||||
| ignore any failing balance assertions in the journal | ignore any failing balance assertions in the journal | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP |  | ||||||
| .B \f[C]\-\-debug=N\f[] |  | ||||||
| : show debug output if N is 1\-9 (default: 0) |  | ||||||
| .RS |  | ||||||
| .RE |  | ||||||
| .PP | .PP | ||||||
| Common reporting options are supported by most commands where | Common reporting options are supported by most commands where | ||||||
| applicable, and individual commands may provide additional | applicable, and individual commands may provide additional | ||||||
|  | |||||||
| @ -174,6 +174,9 @@ available and can appear anywhere in the command line: | |||||||
| `--version' | `--version' | ||||||
|      show version |      show version | ||||||
| 
 | 
 | ||||||
|  | `--debug=N' | ||||||
|  |      show debug output if N is 1-9 (default: 0) | ||||||
|  | 
 | ||||||
| `-f FILE --file=FILE' | `-f FILE --file=FILE' | ||||||
|      use a different input file. For stdin, use - |      use a different input file. For stdin, use - | ||||||
| 
 | 
 | ||||||
| @ -186,9 +189,6 @@ available and can appear anywhere in the command line: | |||||||
| `--ignore-assertions' | `--ignore-assertions' | ||||||
|      ignore any failing balance assertions in the journal |      ignore any failing balance assertions in the journal | ||||||
| 
 | 
 | ||||||
| `--debug=N' |  | ||||||
|      : show debug output if N is 1-9 (default: 0) |  | ||||||
| 
 |  | ||||||
|    Common reporting options are supported by most commands where |    Common reporting options are supported by most commands where | ||||||
| applicable, and individual commands may provide additional | applicable, and individual commands may provide additional | ||||||
| command-specific options. Both of these must be written after the | command-specific options. Both of these must be written after the | ||||||
| @ -2043,95 +2043,95 @@ Node: EXAMPLES1748 | |||||||
| Ref: #examples1850 | Ref: #examples1850 | ||||||
| Node: OPTIONS3854 | Node: OPTIONS3854 | ||||||
| Ref: #options3958 | Ref: #options3958 | ||||||
| Node: Multiple files7275 | Node: Multiple files7273 | ||||||
| Ref: #multiple-files7400 | Ref: #multiple-files7398 | ||||||
| Node: Repeated options7665 | Node: Repeated options7663 | ||||||
| Ref: #repeated-options7817 | Ref: #repeated-options7815 | ||||||
| Node: Depth limiting7937 | Node: Depth limiting7935 | ||||||
| Ref: #depth-limiting8082 | Ref: #depth-limiting8080 | ||||||
| Node: Smart dates8283 | Node: Smart dates8281 | ||||||
| Ref: #smart-dates8424 | Ref: #smart-dates8422 | ||||||
| Node: Reporting interval9421 | Node: Reporting interval9419 | ||||||
| Ref: #reporting-interval9580 | Ref: #reporting-interval9578 | ||||||
| Node: Period expressions9923 | Node: Period expressions9921 | ||||||
| Ref: #period-expressions10090 | Ref: #period-expressions10088 | ||||||
| Node: Regular Expressions12136 | Node: Regular Expressions12134 | ||||||
| Ref: #regular-expressions12278 | Ref: #regular-expressions12276 | ||||||
| Node: QUERIES13761 | Node: QUERIES13759 | ||||||
| Ref: #queries13865 | Ref: #queries13863 | ||||||
| Node: COMMANDS17167 | Node: COMMANDS17165 | ||||||
| Ref: #commands17281 | Ref: #commands17279 | ||||||
| Node: accounts17954 | Node: accounts17952 | ||||||
| Ref: #accounts18054 | Ref: #accounts18052 | ||||||
| Node: activity19036 | Node: activity19034 | ||||||
| Ref: #activity19148 | Ref: #activity19146 | ||||||
| Node: add19507 | Node: add19505 | ||||||
| Ref: #add19608 | Ref: #add19606 | ||||||
| Node: balance22267 | Node: balance22265 | ||||||
| Ref: #balance22380 | Ref: #balance22378 | ||||||
| Node: Flat mode25096 | Node: Flat mode25094 | ||||||
| Ref: #flat-mode25223 | Ref: #flat-mode25221 | ||||||
| Node: Depth limited balance reports25642 | Node: Depth limited balance reports25640 | ||||||
| Ref: #depth-limited-balance-reports25845 | Ref: #depth-limited-balance-reports25843 | ||||||
| Node: Multicolumn balance reports26266 | Node: Multicolumn balance reports26264 | ||||||
| Ref: #multicolumn-balance-reports26468 | Ref: #multicolumn-balance-reports26466 | ||||||
| Node: Market value31117 | Node: Market value31115 | ||||||
| Ref: #market-value31281 | Ref: #market-value31279 | ||||||
| Node: Custom balance output31774 | Node: Custom balance output31772 | ||||||
| Ref: #custom-balance-output31947 | Ref: #custom-balance-output31945 | ||||||
| Node: Output destination34051 | Node: Output destination34049 | ||||||
| Ref: #output-destination34216 | Ref: #output-destination34214 | ||||||
| Node: CSV output34486 | Node: CSV output34484 | ||||||
| Ref: #csv-output34605 | Ref: #csv-output34603 | ||||||
| Node: balancesheet35002 | Node: balancesheet35000 | ||||||
| Ref: #balancesheet35130 | Ref: #balancesheet35128 | ||||||
| Node: cashflow35782 | Node: cashflow35780 | ||||||
| Ref: #cashflow35899 | Ref: #cashflow35897 | ||||||
| Node: help36589 | Node: help36587 | ||||||
| Ref: #help36701 | Ref: #help36699 | ||||||
| Node: incomestatement37538 | Node: incomestatement37536 | ||||||
| Ref: #incomestatement37668 | Ref: #incomestatement37666 | ||||||
| Node: info38395 | Node: info38393 | ||||||
| Ref: #info38502 | Ref: #info38500 | ||||||
| Node: man38864 | Node: man38862 | ||||||
| Ref: #man38961 | Ref: #man38959 | ||||||
| Node: print39364 | Node: print39362 | ||||||
| Ref: #print39469 | Ref: #print39467 | ||||||
| Node: register40820 | Node: register40818 | ||||||
| Ref: #register40933 | Ref: #register40931 | ||||||
| Node: Custom register output45274 | Node: Custom register output45272 | ||||||
| Ref: #custom-register-output45405 | Ref: #custom-register-output45403 | ||||||
| Node: stats46702 | Node: stats46700 | ||||||
| Ref: #stats46808 | Ref: #stats46806 | ||||||
| Node: test47689 | Node: test47687 | ||||||
| Ref: #test47776 | Ref: #test47774 | ||||||
| Node: ADD-ON COMMANDS48143 | Node: ADD-ON COMMANDS48141 | ||||||
| Ref: #add-on-commands48279 | Ref: #add-on-commands48277 | ||||||
| Node: api49567 | Node: api49565 | ||||||
| Ref: #api49659 | Ref: #api49657 | ||||||
| Node: autosync49693 | Node: autosync49691 | ||||||
| Ref: #autosync49808 | Ref: #autosync49806 | ||||||
| Node: diff52123 | Node: diff52121 | ||||||
| Ref: #diff52233 | Ref: #diff52231 | ||||||
| Node: equity52897 | Node: equity52895 | ||||||
| Ref: #equity53011 | Ref: #equity53009 | ||||||
| Node: interest54339 | Node: interest54337 | ||||||
| Ref: #interest54456 | Ref: #interest54454 | ||||||
| Node: irr57540 | Node: irr57538 | ||||||
| Ref: #irr57653 | Ref: #irr57651 | ||||||
| Node: print-unique60028 | Node: print-unique60026 | ||||||
| Ref: #print-unique60158 | Ref: #print-unique60156 | ||||||
| Node: rewrite60416 | Node: rewrite60414 | ||||||
| Ref: #rewrite60535 | Ref: #rewrite60533 | ||||||
| Node: ui61064 | Node: ui61062 | ||||||
| Ref: #ui61164 | Ref: #ui61162 | ||||||
| Node: web61205 | Node: web61203 | ||||||
| Ref: #web61293 | Ref: #web61291 | ||||||
| Node: TROUBLESHOOTING61326 | Node: TROUBLESHOOTING61324 | ||||||
| Ref: #troubleshooting61445 | Ref: #troubleshooting61443 | ||||||
| Node: Run-time problems61499 | Node: Run-time problems61497 | ||||||
| Ref: #run-time-problems61642 | Ref: #run-time-problems61640 | ||||||
| Node: Known limitations63586 | Node: Known limitations63584 | ||||||
| Ref: #known-limitations63729 | Ref: #known-limitations63727 | ||||||
|  |  | ||||||
| End Tag Table | End Tag Table | ||||||
|  | |||||||
| @ -149,6 +149,9 @@ OOPPTTIIOONNSS | |||||||
|        ----vveerrssiioonn |        ----vveerrssiioonn | ||||||
|               show version |               show version | ||||||
| 
 | 
 | ||||||
|  |        ----ddeebbuugg==NN | ||||||
|  |               show debug output if N is 1-9 (default: 0) | ||||||
|  | 
 | ||||||
|        --ff FFIILLEE ----ffiillee==FFIILLEE |        --ff FFIILLEE ----ffiillee==FFIILLEE | ||||||
|               use a different input file.  For stdin, use - |               use a different input file.  For stdin, use - | ||||||
| 
 | 
 | ||||||
| @ -162,9 +165,6 @@ OOPPTTIIOONNSS | |||||||
|        ----iiggnnoorree--aasssseerrttiioonnss |        ----iiggnnoorree--aasssseerrttiioonnss | ||||||
|               ignore any failing balance assertions in the journal |               ignore any failing balance assertions in the journal | ||||||
| 
 | 
 | ||||||
|        ----ddeebbuugg==NN |  | ||||||
|               : show debug output if N is 1-9 (default: 0) |  | ||||||
| 
 |  | ||||||
|        Common reporting options are supported by most commands where  applica- |        Common reporting options are supported by most commands where  applica- | ||||||
|        ble,  and  individual  commands may provide additional command-specific |        ble,  and  individual  commands may provide additional command-specific | ||||||
|        options.  Both of these must be written after the command name. |        options.  Both of these must be written after the command name. | ||||||
|  | |||||||
| @ -22,35 +22,7 @@ interpreted as a search query which filters the data, see QUERIES. | |||||||
| There are three kinds of options. | There are three kinds of options. | ||||||
| General options are always available and can appear anywhere in the command line: | General options are always available and can appear anywhere in the command line: | ||||||
| 
 | 
 | ||||||
| `-h` | _generaloptions_ | ||||||
| : show general usage (or if after COMMAND, the command's usage) |  | ||||||
| 
 |  | ||||||
| `--help` |  | ||||||
| : show the current program's manual as plain text (or after an add-on COMMAND, the add-on's manual) |  | ||||||
| 
 |  | ||||||
| `--man` |  | ||||||
| : show the current program's manual with man |  | ||||||
| 
 |  | ||||||
| `--info` |  | ||||||
| : show the current program's manual with info |  | ||||||
| 
 |  | ||||||
| `--version` |  | ||||||
| : show version |  | ||||||
| 
 |  | ||||||
| `-f FILE --file=FILE` |  | ||||||
| : use a different input file. For stdin, use - |  | ||||||
| 
 |  | ||||||
| `--rules-file=RULESFILE` |  | ||||||
| : Conversion rules file to use when reading CSV (default: FILE.rules) |  | ||||||
| 
 |  | ||||||
| `--alias=OLD=NEW` |  | ||||||
| : display accounts named OLD as NEW |  | ||||||
| 
 |  | ||||||
| `--ignore-assertions` |  | ||||||
| : ignore any failing balance assertions in the journal |  | ||||||
| 
 |  | ||||||
| `--debug=N` |  | ||||||
| : : show debug output if N is 1-9 (default: 0) |  | ||||||
| 
 | 
 | ||||||
| Common reporting options are supported by most commands where applicable, | Common reporting options are supported by most commands where applicable, | ||||||
| and individual commands may provide additional command-specific options. | and individual commands may provide additional command-specific options. | ||||||
|  | |||||||
		Loading…
	
		Reference in New Issue
	
	Block a user