slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: document the help command

Browse Source
This commit is contained in:
Simon Michael 2016-04-14 18:38:36 -07:00
parent b7d2d612a8
commit bace208e98
4 changed files with 88 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
hledger/doc/commands.m4.md
View File

@ -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
Show an income statement. Alias: is.

31
hledger/doc/hledger.1
View File

@ -175,7 +175,7 @@ show general usage or (after command) command usage
.RE
.TP
.B \f[C]\-\-help\f[]
show detailed help
show detailed help (man page)
.RS
.RE
.TP
@ -1297,6 +1297,35 @@ Total:
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $\-1
\f[]
.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
.PP
Show an income statement.

27
hledger/doc/hledger.1.txt
View File

@ -124,7 +124,7 @@ OOPPTTIIOONNSS
--hh show general usage or (after command) command usage
----hheellpp show detailed help
----hheellpp show detailed help (man page)
----vveerrssiioonn
show version information
@ -939,6 +939,31 @@ CCOOMMMMAANNDDSS
--------------------
$-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
Show an income statement. Alias: is.

2
hledger/doc/options.m4.md
View File

@ -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
`--help`
: show detailed help
: show detailed help (man page)
`--version`
: show version information