romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-04-14 22:41:40 +03:00
Code Issues Projects Releases Packages Wiki Activity

docs: make gen.pl support *italic* and **bold**

Browse source 
Remove some nroffisms from the cmdline doc files to simplify editing,
and instead support this markdown style.

Closes #6771
This commit is contained in:
Daniel Stenberg 2021-03-22 16:50:57 +01:00
parent c915662485
commit d7f737dd13
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
21 changed files with 53 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/cmdline-opts/MANPAGE.md
View file

@ -3,7 +3,8 @@
This is the curl man page generator. It generates a single nroff man page
output from the set of sources files in this directory.
There is one source file for each supported command line option. The format is
There is one source file for each supported command line option. The output
gets `page-header` prepended and `page-footer` appended. The format is
described below.
## Option files
@ -32,13 +33,18 @@ Each file has a set of meta-data and a body of text.
### Body
The body of the description. Only refer to options with their long form option
version, like --verbose. The output generator will replace such with the
version, like `--verbose`. The output generator will replace such with the
correct markup that shows both short and long version.
## Header
Text written within `*asterisks*` will get shown using italics. Text within
two `**asterisks**` will get shown using bold.
`page-header` is the nroff formatted file that will be output before the
generated options output for the master man page.
## Header and footer
`page-header` is the file that will be output before the generated options
output for the master man page.
`page-footer` is appended after all the individual options.
## Generate