summaryrefslogtreecommitdiff
path: root/docs/cmdline-opts
Commit message (Collapse)AuthorAgeFilesLines
* curl.1: require "see also" for every documented optionbagder/curl-1-seealsoDaniel Stenberg2021-11-15168-8/+179
| | | | | | | 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.
* Revert "form-escape.d: double the back-slashes for proper man page output"Daniel Stenberg2021-11-151-1/+1
| | | | | | This reverts commit a2d8eac04a4eb1d5a98cf24b4e5cec5cec565d27. silly me, it was intended to be one backslash!
* form-escape.d: double the back-slashes for proper man page outputDaniel Stenberg2021-11-151-1/+1
|
* page-footer: add a mention of how to report bugs to the man pageDaniel Stenberg2021-11-151-0/+3
|
* mime: use percent-escaping for multipart form field and file namesPatrick Monnerat2021-11-152-0/+11
| | | | | | | | | | | | | | | | | | Until now, form field and file names where escaped using the backslash-escaping algorithm defined for multipart mails. This commit replaces this with the percent-escaping method for URLs. As this may introduce incompatibilities with server-side applications, a new libcurl option CURLOPT_MIME_OPTIONS with bitmask CURLMIMEOPT_FORMESCAPE is introduced to revert to legacy use of backslash-escaping. This is controlled by new cli tool option --form-escape. New tests and documentation are provided for this feature. Reported by: Ryan Sleevi Fixes #7789 Closes #7805
* limit-rate.d: this is average over several secondsDaniel Stenberg2021-11-081-0/+3
| | | | Closes #7970
* docs: reduce/avoid English contractionsDaniel Stenberg2021-11-0744-79/+79
| | | | | | | | | | | You're => You are Hasn't => Has not Doesn't => Does not Don't => Do not You'll => You will etc Closes #7930
* curl.1: fix typos in the manpageSergio Durigan Junior2021-11-012-3/+3
| | | | | | | | s/transfering/transferring/ s/transfered/transferred/ Signed-off-by: Sergio Durigan Junior <sergiodj@sergiodj.net> Closes #7937
* docs: reduce use of "very"Daniel Stenberg2021-11-016-13/+13
| | | | | | | "Very" should be avoided in most texts. If intensifiers are needed, try find better words instead. Closes #7936
* gen.pl: replace leading single quotes with \(aqDaniel Stenberg2021-11-015-4/+6
| | | | | | | | | | ... and allow single quotes to be used "normally" in the .d files. Makes the output curl.1 use better nroff. Reported-by: Sergio Durigan Junior Ref: #7928 Closes #7933
* tool_listhelp: easier to generate with gen.plDaniel Stenberg2021-09-301-0/+42
| | | | | | | | | | | | | | | tool_listhelp.c is now a separate file with only the command line --help output, exactly as generated by gen.pl. This makes it easier to generate updates according to what's in the docs/cmdline-opts docs. cd $srcroot/docs/cmdline-opts ./gen.pl listhelp *.d > $srcroot/src/tool_listhelp.c With a configure build, this also works: make -C src listhelp Closes #7787
* gen.pl: make the output date format work betterDaniel Stenberg2021-09-301-1/+1
| | | | | | | | | | | Follow-up to 15910dfd143dd The previous strftime format used didn't work correctly on Windows, so change to %B %d %Y which today looks like "September 29 2021". Reported-by: Gisle Vanem Bug: #7782 Closes #7793
* cmdline-opts: made the 'Added:' field mandatoryDaniel Stenberg2021-09-28111-15/+124
| | | | | | | | 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
* curl.1: remove mentions of really old version changesDaniel Stenberg2021-09-2812-27/+46
| | | | | | | | | | | | | | | | | | | To make the man page more readable, this change removes all references to changes in support/versions etc that happened before 7.30.0 from the curl.1 output file. 7.30.0 was released on Apr 12 2013. This particular limit is a bit arbitrary but was fairly easy to grep for. It is handled like this: the 'Added' keyword is only used in output if it refers to 7.30.0 or later. All occurances of "(Added in $VERSION)" in description will be stripped out if the mentioned $VERSION is from before 7.30.0. It is therefore important that the "Added in..." references are always written exactly like that - and on a single line, not split over two. This change removes about 80 version number references from curl.1, down to 138 from 218. Closes #7786
* gen.pl: insert the current date and version in generated man pageDaniel Stenberg2021-09-272-1/+16
| | | | | | Reported-by: Gisle Vanem Ref: #7780 Closes #7782
* libssh2: add SHA256 fingerprint supportMats Lindestam2021-09-262-0/+12
| | | | | | | Added support for SHA256 fingerprint in command line curl and in libcurl. Closes #7646
* write-out.d: clarify size_download/uploadDaniel Stenberg2021-09-121-2/+4
| | | | | | They show the number of "body" bytes transfered. Fixes #7702 Closes #7706
* docs: remove experimental mentions from HSTS and MQTTDaniel Stenberg2021-09-071-2/+2
| | | | | | Reported-by: Jonathan Cardoso Bug: https://github.com/curl/curl/pull/6700#issuecomment-913792863 Closes #7681
* config.d: note that curlrc is used even when --configJay Satiro2021-09-051-2/+2
| | | | | | | Bug: https://github.com/curl/curl/pull/7666#issuecomment-912214751 Reported-by: Viktor Szakats Closes https://github.com/curl/curl/pull/7667
* get.d: provide more useful examplesDaniel Stenberg2021-09-041-0/+2
| | | | Closes #7668
* page-header: add GOPHERS, simplify wording in the 1st paraDaniel Stenberg2021-09-031-6/+5
| | | | Closes #7665
* curl.1: provide examples for each optionDaniel Stenberg2021-09-01244-50/+345
| | | | | | | | | | | 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
* setopt: enable CURLOPT_IGNORE_CONTENT_LENGTH for hyperDaniel Stenberg2021-08-231-1/+1
| | | | | | | | | | | Since this option is also used for FTP, it needs to work to set for applications even if hyper doesn't support it for HTTP. Verified by test 1137. Updated docs to specify that the option doesn't work for HTTP when using the hyper backend. Closes #7614
* man pages: remove trailing whitespacesDaniel Stenberg2021-08-216-6/+0
| | | | | | | | | Extended test 1173 (via the manpage-syntax.pl script) to detect and warn for them. Ref: #7602 Reported-by: a1346054 on github Closes #7604
* config.d: escape the backslash properlyDaniel Stenberg2021-08-211-1/+1
| | | | Closes #7603
* output.d: add method to suppress response bodiesBarry Pollard2021-08-121-0/+8
| | | | Closes #7560
* happy-eyeballs-timeout-ms.d: polish the wordingDaniel Stenberg2021-08-081-5/+5
| | | | | | Reported-by: Josh Soref Fixes #7433 Closes #7542
* compressed.d: it's a request, not an orderDaniel Stenberg2021-07-301-1/+2
| | | | | | | | | Clarified Reported-by: Dan Jacobson Reviewed-by: Daniel Gustafsson Fixes #7516 Closes #7517
* curl.1: mention "global" flagsDaniel Stenberg2021-07-2812-0/+36
| | | | | | | | | | | Mention options that are "global". A global command line option is one that doesn't get reset at --next uses and therefore don't need to be used again. Reported-by: Josh Soref Fixes #7457 Closes #7510
* docs: fix grammarJosh Soref2021-07-273-8/+10
| | | | | | | 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
* mail-rcpt.d: fix grammarJay Satiro2021-07-271-4/+1
| | | | | | | | | | Remove confusing sentence that says to specify an e-mail address for mail transfer, since that's implied. Reported-by: Josh Soref Fixes https://github.com/curl/curl/issues/7452 Closes https://github.com/curl/curl/pull/7495
* limit-rate.d: clarify base unitJosh Soref2021-07-261-1/+2
| | | | | Fixes #7439 Closes #7494
* docs: change max-filesize caveat againJay Satiro2021-07-231-3/+4
| | | | | | | | | | | | | | | - Add protocols field to max-filesize.d. - Revert wording on unknown file size caveat and do not discuss specific protocols in that section. Partial revert of ecf0225. All max-filesize options now have the list of protocols and it's clearer just to have that list without discussing specific protocols in the caveat. Reported-by: Josh Soref Ref: https://github.com/curl/curl/issues/7453#issuecomment-884128762
* docs: mention max-filesize options also apply to MQTT transfersJay Satiro2021-07-211-3/+3
| | | | | | | | | | Also make it clearer that the caveat 'if the file size is unknown it the option will have no effect' may apply to protocols other than FTP and HTTP. Reported-by: Josh Soref Fixes https://github.com/curl/curl/issues/7453
* docs/cmdline: fix grammar and typosJosh Soref2021-07-202-3/+3
|
* dump-header.d: Drop suggestion to use for cookie storageJosh Soref2021-07-201-8/+2
| | | | | | | | | Since --cookie-jar is the preferred way to store cookies, no longer suggest using --dump-header to do so. Co-authored-by: Daniel Stenberg Closes https://github.com/curl/curl/issues/7414
* doc/cmdline: fix grammar and typosJosh Soref2021-07-208-37/+36
| | | | | | | | | | | Closes https://github.com/curl/curl/pull/7454 Closes https://github.com/curl/curl/pull/7455 Closes https://github.com/curl/curl/pull/7456 Closes https://github.com/curl/curl/pull/7459 Closes https://github.com/curl/curl/pull/7460 Closes https://github.com/curl/curl/pull/7461 Closes https://github.com/curl/curl/pull/7462 Closes https://github.com/curl/curl/pull/7463
* docs/cmdline: fix grammar and typosJosh Soref2021-07-205-13/+13
| | | | | | | | Closes https://github.com/curl/curl/pull/7432 Closes https://github.com/curl/curl/pull/7436 Closes https://github.com/curl/curl/pull/7438 Closes https://github.com/curl/curl/pull/7440 Closes https://github.com/curl/curl/pull/7445
* delegation.d: mention what happens when used multiple timesJosh Soref2021-07-201-0/+2
| | | | Closes https://github.com/curl/curl/pull/7408
* create-file-mode.d: mention what happens when used multiple timesJosh Soref2021-07-201-0/+2
| | | | Closes https://github.com/curl/curl/pull/7407
* config.d: split comments and option-per lineJosh Soref2021-07-201-3/+6
| | | | Closes https://github.com/curl/curl/pull/7405
* docs: spell out directories instead of dirs in create-dirsJosh Soref2021-07-181-3/+4
| | | | | | | | | | Write out directories rather than using the dirs abbrevation. Also use plural form consistently, even if the code in the end might just create a single directory. Closes #7406 Reviewed-by: Daniel Stenberg <daniel@haxx.se> Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
* docs/cmdline: mention what happens when used multiple timesJosh Soref2021-07-183-0/+6
| | | | | | | | For --dns-ipv4-addr, --dns-ipv6-addr and --dns-servers Closes #7410 Closes #7411 Closes #7412
* disable-epsv.d: remove duplicate "(FTP)"Daniel Stenberg2021-07-181-3/+3
| | | | | ... since the tooling adds that to the output based on the "Protocols:" tag.
* docs: make the documentation for --etag-save match the program behaviourMax Zettlmeißl2021-07-182-18/+11
| | | | | | | | | | | | | | | | | | When using curl with the option `--etag-save` I expected it to save the ETag without its surrounding quotes, as stated by the documentation in the repository and by the generated man pages. My first endeavour was to fix the program, but while investigating the history of the relevant parts, I discovered that curl once saved the ETag without the quotes. This was undone by Daniel Stenberg in commit `98c94596f5928840177b6bd3c7b0f0dd03a431af`, therefore I decided that in this case the documentation should be adjusted to match the behaviour of curl. The changed save behaviour also made parts of the `--etag-compare` documentation wrong or superfluous, so I adjusted those accordingly. Closes #7429
* write-out.d: add missing periodsJosh Soref2021-07-181-6/+6
| | | | Closes #7404
* cleanup: spell DoH with a lowercase oJosh Soref2021-07-163-7/+7
| | | | | | Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Closes #7413
* form.d: add examples of `,`/`;` for file[name]Josh Soref2021-07-161-2/+2
| | | | | Fixes #7415 Closes #7417
* docs: document missing arguments to commandsБорис Верховский2021-07-133-0/+3
| | | | | | | | This is a followup to commit f410b9e538129e77607fef1 fixing a few more commands which takes arguments. Closes #7382 Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
* tool_help: Document that --tlspassword takes a passwordБорис Верховский2021-07-121-0/+1
| | | | | Closes #7378 Reviewed-by: Daniel Stenberg <daniel@haxx.se>
View Lorry Controller Status