Daniel Stenberg
76d6e719d9
docs: address proselint nits
...
- avoid exclamation marks
- use consistent number of spaces after periods: one
- avoid clichés
- avoid using 'very'
Closes #8060
2021-11-26 14:27:07 +01:00
Daniel Stenberg
ddaa85893d
curl.1: require "see also" for every documented option
...
gen.pl now generates a warning if the "See Also" field is not filled in for a
command line option
All command line options now provide one or more related options. 167
"See alsos" added!
Closes #8019
2021-11-15 23:06:41 +01:00
Daniel Stenberg
ce6e3e5320
cmdline-opts: made the 'Added:' field mandatory
...
Since "too old" versions are no longer included in the generated man
page, this field is now mandatory so that it won't be forgotten and then
not included in the documentation.
Closes #7786
2021-09-28 16:20:12 +02:00
Daniel Stenberg
68784d73c3
curl.1: provide examples for each option
...
The file format for each option now features a "Example:" header that
can provide one or more examples that get rendered appropriately in the
output. All options MUST have at least one example or gen.pl complains
at build-time.
This fix also does a few other minor format and consistency cleanups.
Closes #7654
2021-09-01 14:02:43 +02:00
Daniel Stenberg
4e53b9430c
man pages: remove trailing whitespaces
...
Extended test 1173 (via the manpage-syntax.pl script) to detect and warn
for them.
Ref: #7602
Reported-by: a1346054 on github
Closes #7604
2021-08-21 16:44:03 +02:00
Josh Soref
4d145346ae
docs: fix grammar
...
Fixes https://github.com/curl/curl/issues/7444
Fixes https://github.com/curl/curl/issues/7451
Fixes https://github.com/curl/curl/issues/7465
Closes https://github.com/curl/curl/pull/7495
2021-07-27 13:44:30 -04:00
Борис Верховский
60dc3d1a5b
docs: document missing arguments to commands
...
This is a followup to commit f410b9e538Closes #7382
Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
2021-07-13 23:49:35 +02:00
Daniel Stenberg
d7f737dd13
docs: make gen.pl support *italic* and **bold**
...
Remove some nroffisms from the cmdline doc files to simplify editing,
and instead support this markdown style.
Closes #6771
2021-03-22 16:50:58 +01:00
Emil Engler
5dddc1dc7e
docs: add categories to all cmdline opts
...
Adapted gen.pl with 'listcats'
This commit is a part of "--help me if you can"
Closes #5680
2020-09-04 15:38:14 +02:00
COFFEETALES
fab5185275
sftp: add new quote commands 'atime' and 'mtime'
...
Closes #5810
2020-08-24 09:01:56 +02:00
Daniel Stenberg
9dd731c94e
quote.d: asterisk prefix works for SFTP as well
...
Reported-by: Ben Voris
Fixes #4017
Closes #4019
2019-06-13 08:48:46 +02:00
Daniel Stenberg
4b8b7a2d36
cmdline-opts: added some missing info
2016-12-16 22:01:01 +01:00
Daniel Stenberg
5c4a526388
cmdline-opts: more command line options documented
...
Moved over to the new format
2016-11-28 00:50:25 +01:00
