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

doc: fixes for the help command's docs

Browse Source
This commit is contained in:
Simon Michael 2016-04-14 19:22:21 -07:00
parent bace208e98
commit 990294f53e
3 changed files with 127 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -236,23 +236,22 @@ Total:
}}) }})
## help ## help
Show detailed help (the main hledger man pages). Show detailed help.
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](/docs.html), as fixed-width text.
The `help` command can display any of the main hledger man pages. (Unlike `hledger --help`, which displays only the hledger man page.)
Run `hledger help` with no arguments to see a list of topics. Run it with no arguments to list available topics (their names are shortened for easier typing),
These correspond to the [man pages](/docs.html), shortened for easy typing. and run `hledger help TOPIC` to select one.
Run `hledger help TOPIC` to view that topic. The output may be long, so you may wish to pipe it into a pager.
You may wish to pipe the output into a pager for easier viewing.
_col3_({{
_shell_({{ _shell_({{
$ hledger help $ hledger help
Please choose a topic, eg: hledger help ui Please choose a topic, eg: hledger help ui
Topics: cli, ui, web, api, journal, csv, timeclock, timedot Topics: cli, ui, web, api, journal, csv, timeclock, timedot
}}), }})
_shell_({{ _shell_({{
$ hledger help cli $ hledger help cli | less
hledger(1) hledger User Manuals hledger(1) hledger(1) hledger User Manuals hledger(1)
@ -262,8 +261,9 @@ NAME
hledger - a command-line accounting tool hledger - a command-line accounting tool
SYNOPSIS SYNOPSIS
... hledger [-f FILE] COMMAND [OPTIONS] [CMDARGS]
}}) hledger [-f FILE] ADDONCMD -- [OPTIONS] [CMDARGS]
:
}}) }})
## incomestatement ## incomestatement

32
hledger/doc/hledger.1
View File

@ -1299,21 +1299,27 @@ Total:
.fi .fi
.SS help .SS help
.PP .PP
Show detailed help (the main hledger man pages). Show detailed help.
.PP .PP
The long \f[C]\-\-help\f[] flag displays the hledger man page, as The \f[C]help\f[] command can display any of the main hledger man pages,
fixed\-width text. as fixed\-width text.
The \f[C]help\f[] command can display any of the main hledger man pages. (Unlike \f[C]hledger\ \-\-help\f[], which displays only the hledger man
Run \f[C]hledger\ help\f[] with no arguments to see a list of topics. page.) Run it with no arguments to list available topics (their names
These correspond to the man pages, shortened for easy typing. are shortened for easier typing), and run \f[C]hledger\ help\ TOPIC\f[]
Run \f[C]hledger\ help\ TOPIC\f[] to view that topic. to select one.
You may wish to pipe the output into a pager for easier viewing. The output may be long, so you may wish to pipe it into a pager.
.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 .IP
.nf .nf
\f[C] \f[C]
$\ hledger\ help\ cli $\ hledger\ help
Please\ choose\ a\ topic,\ eg:\ hledger\ help\ ui
Topics:\ cli,\ ui,\ web,\ api,\ journal,\ csv,\ timeclock,\ timedot
\f[]
.fi
.IP
.nf
\f[C]
$\ hledger\ help\ cli\ |\ less
hledger(1)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ hledger\ User\ Manuals\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ hledger(1) hledger(1)\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ hledger\ User\ Manuals\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ hledger(1)
@ -1323,7 +1329,9 @@ NAME
\ \ \ \ \ \ \ hledger\ \-\ a\ command\-line\ accounting\ tool \ \ \ \ \ \ \ hledger\ \-\ a\ command\-line\ accounting\ tool
SYNOPSIS SYNOPSIS
\&... \ \ \ \ \ \ \ hledger\ [\-f\ FILE]\ COMMAND\ [OPTIONS]\ [CMDARGS]
\ \ \ \ \ \ \ hledger\ [\-f\ FILE]\ ADDONCMD\ \-\-\ [OPTIONS]\ [CMDARGS]
:
\f[] \f[]
.fi .fi
.SS incomestatement .SS incomestatement

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

@ -940,19 +940,20 @@ CCOOMMMMAANNDDSS
$-1 $-1
hheellpp hheellpp
Show detailed help (the main hledger man pages). Show detailed help.
The long --help flag displays the hledger man page, as fixed-width The help command can display any of the main hledger man pages, as
text. The help command can display any of the main hledger man pages. fixed-width text. (Unlike hledger --help, which displays only the
Run hledger help with no arguments to see a list of topics. These cor- hledger man page.) Run it with no arguments to list available topics
respond to the man pages, shortened for easy typing. Run (their names are shortened for easier typing), and run
hledger help TOPIC to view that topic. You may wish to pipe the output hledger help TOPIC to select one. The output may be long, so you may
into a pager for easier viewing. wish to pipe it into a pager.
{.shell .clear} $ hledger help Please choose a topic, eg: hledger help ui Top- $ hledger help
ics: cli, ui, web, api, journal, csv, timeclock, timedot, Please choose a topic, eg: hledger help ui
Topics: cli, ui, web, api, journal, csv, timeclock, timedot
$ hledger help cli $ hledger help cli | less
hledger(1) hledger User Manuals hledger(1) hledger(1) hledger User Manuals hledger(1)
@ -962,7 +963,9 @@ CCOOMMMMAANNDDSS
hledger - a command-line accounting tool hledger - a command-line accounting tool
SYNOPSIS SYNOPSIS
... hledger [-f FILE] COMMAND [OPTIONS] [CMDARGS]
hledger [-f FILE] ADDONCMD -- [OPTIONS] [CMDARGS]
:
iinnccoommeessttaatteemmeenntt iinnccoommeessttaatteemmeenntt
Show an income statement. Alias: is. Show an income statement. Alias: is.