doc: document the help command
This commit is contained in:
		
							parent
							
								
									b7d2d612a8
								
							
						
					
					
						commit
						bace208e98
					
				| @ -235,6 +235,37 @@ Total: | |||||||
| }}) | }}) | ||||||
| }}) | }}) | ||||||
| 
 | 
 | ||||||
|  | ## help | ||||||
|  | Show detailed help (the main hledger man pages). | ||||||
|  | 
 | ||||||
|  | The long `--help` flag displays the hledger man page, as fixed-width text. | ||||||
|  | The `help` command can display any of the main hledger man pages. | ||||||
|  | Run `hledger help` with no arguments to see a list of topics. | ||||||
|  | These correspond to the [man pages](/docs.html), shortened for easy typing. | ||||||
|  | Run `hledger help TOPIC` to view that topic. | ||||||
|  | You may wish to pipe the output into a pager for easier viewing. | ||||||
|  | 
 | ||||||
|  | _col3_({{ | ||||||
|  | _shell_({{ | ||||||
|  | $ hledger help | ||||||
|  | Please choose a topic, eg: hledger help ui | ||||||
|  | Topics: cli, ui, web, api, journal, csv, timeclock, timedot | ||||||
|  | }}), | ||||||
|  | _shell_({{ | ||||||
|  | $ hledger help cli | ||||||
|  | 
 | ||||||
|  | hledger(1)                   hledger User Manuals                   hledger(1) | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | NAME | ||||||
|  |        hledger - a command-line accounting tool | ||||||
|  | 
 | ||||||
|  | SYNOPSIS | ||||||
|  | ... | ||||||
|  | }}) | ||||||
|  | }}) | ||||||
|  | 
 | ||||||
| ## incomestatement | ## incomestatement | ||||||
| Show an income statement. Alias: is. | Show an income statement. Alias: is. | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -175,7 +175,7 @@ show general usage or (after command) command usage | |||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| .B \f[C]\-\-help\f[] | .B \f[C]\-\-help\f[] | ||||||
| show detailed help | show detailed help (man page) | ||||||
| .RS | .RS | ||||||
| .RE | .RE | ||||||
| .TP | .TP | ||||||
| @ -1297,6 +1297,35 @@ Total: | |||||||
| \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $\-1 | \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $\-1 | ||||||
| \f[] | \f[] | ||||||
| .fi | .fi | ||||||
|  | .SS help | ||||||
|  | .PP | ||||||
|  | Show detailed help (the main hledger man pages). | ||||||
|  | .PP | ||||||
|  | The long \f[C]\-\-help\f[] flag displays the hledger man page, as | ||||||
|  | fixed\-width text. | ||||||
|  | The \f[C]help\f[] command can display any of the main hledger man pages. | ||||||
|  | Run \f[C]hledger\ help\f[] with no arguments to see a list of topics. | ||||||
|  | These correspond to the man pages, shortened for easy typing. | ||||||
|  | Run \f[C]hledger\ help\ TOPIC\f[] to view that topic. | ||||||
|  | You may wish to pipe the output into a pager for easier viewing. | ||||||
|  | .PP | ||||||
|  | \f[C]{.shell\ .clear}\ $\ hledger\ help\ Please\ choose\ a\ topic,\ eg:\ hledger\ help\ ui\ Topics:\ cli,\ ui,\ web,\ api,\ journal,\ csv,\ timeclock,\ timedot\f[], | ||||||
|  | .IP | ||||||
|  | .nf | ||||||
|  | \f[C] | ||||||
|  | $\ hledger\ help\ cli | ||||||
|  | 
 | ||||||
|  | hledger(1)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ hledger\ User\ Manuals\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ hledger(1) | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | NAME | ||||||
|  | \ \ \ \ \ \ \ hledger\ \-\ a\ command\-line\ accounting\ tool | ||||||
|  | 
 | ||||||
|  | SYNOPSIS | ||||||
|  | \&... | ||||||
|  | \f[] | ||||||
|  | .fi | ||||||
| .SS incomestatement | .SS incomestatement | ||||||
| .PP | .PP | ||||||
| Show an income statement. | Show an income statement. | ||||||
|  | |||||||
| @ -124,7 +124,7 @@ OOPPTTIIOONNSS | |||||||
| 
 | 
 | ||||||
|        --hh     show general usage or (after command) command usage |        --hh     show general usage or (after command) command usage | ||||||
| 
 | 
 | ||||||
|        ----hheellpp show detailed help |        ----hheellpp show detailed help (man page) | ||||||
| 
 | 
 | ||||||
|        ----vveerrssiioonn |        ----vveerrssiioonn | ||||||
|               show version information |               show version information | ||||||
| @ -939,6 +939,31 @@ CCOOMMMMAANNDDSS | |||||||
|               -------------------- |               -------------------- | ||||||
|                                $-1 |                                $-1 | ||||||
| 
 | 
 | ||||||
|  |    hheellpp | ||||||
|  |        Show detailed help (the main hledger man pages). | ||||||
|  | 
 | ||||||
|  |        The long --help flag displays the  hledger  man  page,  as  fixed-width | ||||||
|  |        text.   The help command can display any of the main hledger man pages. | ||||||
|  |        Run hledger help with no arguments to see a list of topics.  These cor- | ||||||
|  |        respond   to   the   man   pages,   shortened  for  easy  typing.   Run | ||||||
|  |        hledger help TOPIC to view that topic.  You may wish to pipe the output | ||||||
|  |        into a pager for easier viewing. | ||||||
|  | 
 | ||||||
|  |        {.shell .clear} $ hledger help Please choose a topic, eg: hledger help ui Top- | ||||||
|  |        ics: cli, ui, web, api, journal, csv, timeclock, timedot, | ||||||
|  | 
 | ||||||
|  |               $ hledger help cli | ||||||
|  | 
 | ||||||
|  |               hledger(1)                   hledger User Manuals                   hledger(1) | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  |               NAME | ||||||
|  |                      hledger - a command-line accounting tool | ||||||
|  | 
 | ||||||
|  |               SYNOPSIS | ||||||
|  |               ... | ||||||
|  | 
 | ||||||
|    iinnccoommeessttaatteemmeenntt |    iinnccoommeessttaatteemmeenntt | ||||||
|        Show an income statement.  Alias: is. |        Show an income statement.  Alias: is. | ||||||
| 
 | 
 | ||||||
|  | |||||||
| @ -25,7 +25,7 @@ General options are always available and can appear anywhere in the command line | |||||||
| : show general usage or (after command) command usage | : show general usage or (after command) command usage | ||||||
| 
 | 
 | ||||||
| `--help` | `--help` | ||||||
| : show detailed help | : show detailed help (man page) | ||||||
| 
 | 
 | ||||||
| `--version` | `--version` | ||||||
| : show version information | : show version information | ||||||
|  | |||||||
		Loading…
	
		Reference in New Issue
	
	Block a user