diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2016-11-15 09:08:50 +0100 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2016-11-15 09:08:50 +0100 |
| commit | b8c35f40f99cd1965d6e3152fc01071b73c3d2f1 (patch) | |
| tree | 508893b8a3d421e4c31e288de0871e4e1a2ada8b /docs/cmdline-opts/MANPAGE.md | |
| parent | 7c9b9add6ff5626fc8712d8f8b4e607dcbe8dbfe (diff) | |
cmdline-opts: support generating the --help output
Diffstat (limited to 'docs/cmdline-opts/MANPAGE.md')
| -rw-r--r-- | docs/cmdline-opts/MANPAGE.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/cmdline-opts/MANPAGE.md b/docs/cmdline-opts/MANPAGE.md index d5077636a..f776f81f0 100644 --- a/docs/cmdline-opts/MANPAGE.md +++ b/docs/cmdline-opts/MANPAGE.md @@ -26,6 +26,7 @@ Each file has a set of meta-data and a body of text. Mutexed: (space separated list of options this overrides) Requires: (space separated list of features this option requres) See-also: (space separated list of related options) + Help: (short text for the --help output for this option) --- (end of meta-data) ### Body @@ -37,11 +38,15 @@ correct markup that shows both short and long version. ## Header `page-header` is the nroff formatted file that will be output before the -generated options output. +generated options output for the master man page. ## Generate -`perl gen.pl` +`./gen.pl mainpage` -This command outputs an nroff file, meant to become `curl.1`. The full curl -man page. +This command outputs a single huge nroff file, meant to become `curl.1`. The +full curl man page. + +`./gen.pl listhelp` + +Generates a full `curl --help` output for all known command line options. |