diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2021-11-15 15:58:20 +0100 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2021-11-15 15:58:20 +0100 |
| commit | 32ae3e1a1c40d67f7b2ab2b32f5c83e734c4fbea (patch) | |
| tree | ddc46ff9372ecba641e9dc9648e801142b7e0d07 | |
| parent | 3bf54f90f3875062c0aa984cb90ddd35565d01cd (diff) | |
| download | curl-bagder/curl-1-seealso.tar.gz | |
curl.1: require "see also" for every documented optionbagder/curl-1-seealso
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.
168 files changed, 179 insertions, 8 deletions
diff --git a/docs/cmdline-opts/abstract-unix-socket.d b/docs/cmdline-opts/abstract-unix-socket.d index e26048f1d..fcd2d94c9 100644 --- a/docs/cmdline-opts/abstract-unix-socket.d +++ b/docs/cmdline-opts/abstract-unix-socket.d @@ -4,6 +4,7 @@ Help: Connect via abstract Unix domain socket Added: 7.53.0 Protocols: HTTP Category: connection +See-also: unix-socket Example: --abstract-unix-socket socketpath $URL --- Connect through an abstract Unix domain socket, instead of using the network. diff --git a/docs/cmdline-opts/alt-svc.d b/docs/cmdline-opts/alt-svc.d index 914b1fbc6..3ad223049 100644 --- a/docs/cmdline-opts/alt-svc.d +++ b/docs/cmdline-opts/alt-svc.d @@ -4,6 +4,7 @@ Protocols: HTTPS Help: Enable alt-svc with this cache file Added: 7.64.1 Category: http +See-also: resolve connect-to Example: --alt-svc svc.txt $URL --- This option enables the alt-svc parser in curl. If the file name points to an diff --git a/docs/cmdline-opts/append.d b/docs/cmdline-opts/append.d index c332b7bd9..2ccb9dbaa 100644 --- a/docs/cmdline-opts/append.d +++ b/docs/cmdline-opts/append.d @@ -3,6 +3,7 @@ Long: append Help: Append to target file when uploading Protocols: FTP SFTP Category: ftp sftp +See-also: range continue-at Example: --upload-file local --append ftp://example.com/ Added: 4.8 --- diff --git a/docs/cmdline-opts/aws-sigv4.d b/docs/cmdline-opts/aws-sigv4.d index db988640b..c13b8da76 100644 --- a/docs/cmdline-opts/aws-sigv4.d +++ b/docs/cmdline-opts/aws-sigv4.d @@ -3,6 +3,7 @@ Arg: <provider1[:provider2[:region[:service]]]> Help: Use AWS V4 signature authentication Category: auth http Added: 7.75.0 +See-also: basic user Example: --aws-sigv4 "aws:amz:east-2:es" --user "key:secret" $URL --- Use AWS V4 signature authentication in the transfer. diff --git a/docs/cmdline-opts/cacert.d b/docs/cmdline-opts/cacert.d index 07612e4f2..e066471c6 100644 --- a/docs/cmdline-opts/cacert.d +++ b/docs/cmdline-opts/cacert.d @@ -3,6 +3,7 @@ Arg: <file> Help: CA certificate to verify peer against Protocols: TLS Category: tls +See-also: capath insecure Example: --cacert CA-file.txt $URL Added: 7.5 --- diff --git a/docs/cmdline-opts/capath.d b/docs/cmdline-opts/capath.d index 190aa4d29..7f879a2a4 100644 --- a/docs/cmdline-opts/capath.d +++ b/docs/cmdline-opts/capath.d @@ -3,6 +3,7 @@ Arg: <dir> Help: CA directory to verify peer against Protocols: TLS Category: tls +See-also: cacert insecure Example: --capath /local/directory $URL Added: 7.9.8 --- diff --git a/docs/cmdline-opts/cert-status.d b/docs/cmdline-opts/cert-status.d index 360e5c901..c3b9bdb36 100644 --- a/docs/cmdline-opts/cert-status.d +++ b/docs/cmdline-opts/cert-status.d @@ -3,6 +3,7 @@ Protocols: TLS Added: 7.41.0 Help: Verify the status of the server cert via OCSP-staple Category: tls +See-also: pinnedpubkey Example: --cert-status $URL --- Tells curl to verify the status of the server certificate by using the diff --git a/docs/cmdline-opts/ciphers.d b/docs/cmdline-opts/ciphers.d index 985acc8c7..24d3d5863 100644 --- a/docs/cmdline-opts/ciphers.d +++ b/docs/cmdline-opts/ciphers.d @@ -3,6 +3,7 @@ Arg: <list of ciphers> Help: SSL ciphers to use Protocols: TLS Category: tls +See-also: tlsv1.3 Example: --ciphers ECDHE-ECDSA-AES256-CCM8 $URL Added: 7.9 --- diff --git a/docs/cmdline-opts/compressed-ssh.d b/docs/cmdline-opts/compressed-ssh.d index d95c6adfb..0d198578b 100644 --- a/docs/cmdline-opts/compressed-ssh.d +++ b/docs/cmdline-opts/compressed-ssh.d @@ -3,6 +3,7 @@ Help: Enable SSH compression Protocols: SCP SFTP Added: 7.56.0 Category: scp ssh +See-also: compressed Example: --compressed-ssh sftp://example.com/ --- Enables built-in SSH compression. diff --git a/docs/cmdline-opts/compressed.d b/docs/cmdline-opts/compressed.d index fe26902bc..8e8db97cc 100644 --- a/docs/cmdline-opts/compressed.d +++ b/docs/cmdline-opts/compressed.d @@ -3,6 +3,7 @@ Help: Request compressed response Protocols: HTTP Category: http Example: --compressed $URL +See-also: compressed-ssh Added: 7.10 --- Request a compressed response using one of the algorithms curl supports, and diff --git a/docs/cmdline-opts/config.d b/docs/cmdline-opts/config.d index e356dc939..dfeb0ec7e 100644 --- a/docs/cmdline-opts/config.d +++ b/docs/cmdline-opts/config.d @@ -5,6 +5,7 @@ Short: K Category: curl Example: --config file.txt $URL Added: 4.10 +See-also: disable --- Specify a text file to read curl arguments from. The command line arguments found in the text file will be used as if they were provided on the command diff --git a/docs/cmdline-opts/cookie-jar.d b/docs/cmdline-opts/cookie-jar.d index 234ba489b..0a02c05b5 100644 --- a/docs/cmdline-opts/cookie-jar.d +++ b/docs/cmdline-opts/cookie-jar.d @@ -7,6 +7,7 @@ Category: http Example: -c store-here.txt $URL Example: -c store-here.txt -b read-these $URL Added: 7.9 +See-also: cookie --- Specify to which file you want curl to write all cookies after a completed operation. Curl writes all cookies from its in-memory cookie storage to the diff --git a/docs/cmdline-opts/cookie.d b/docs/cmdline-opts/cookie.d index a4be033cd..1ac6183fe 100644 --- a/docs/cmdline-opts/cookie.d +++ b/docs/cmdline-opts/cookie.d @@ -6,6 +6,7 @@ Help: Send cookies from string/file Category: http Example: -b cookiefile $URL Example: -b cookiefile -c cookiefile $URL +See-also: cookie-jar junk-session-cookies Added: 4.9 --- Pass the data to the HTTP server in the Cookie header. It is supposedly diff --git a/docs/cmdline-opts/create-dirs.d b/docs/cmdline-opts/create-dirs.d index 742a1eaa1..5d2065903 100644 --- a/docs/cmdline-opts/create-dirs.d +++ b/docs/cmdline-opts/create-dirs.d @@ -3,6 +3,7 @@ Help: Create necessary local directory hierarchy Category: curl Example: --create-dirs --output local/dir/file $URL Added: 7.10.3 +See-also: ftp-create-dirs output-dir --- When used in conjunction with the --output option, curl will create the necessary local directory hierarchy as needed. This option creates the diff --git a/docs/cmdline-opts/crlf.d b/docs/cmdline-opts/crlf.d index 1266b6490..3772fcf2c 100644 --- a/docs/cmdline-opts/crlf.d +++ b/docs/cmdline-opts/crlf.d @@ -4,6 +4,7 @@ Protocols: FTP SMTP Category: ftp smtp Example: --crlf -T file ftp://example.com/ Added: 5.7 +See-also: use-ascii --- Convert LF to CRLF in upload. Useful for MVS (OS/390). diff --git a/docs/cmdline-opts/crlfile.d b/docs/cmdline-opts/crlfile.d index 21e86a8c2..1fdc12575 100644 --- a/docs/cmdline-opts/crlfile.d +++ b/docs/cmdline-opts/crlfile.d @@ -5,6 +5,7 @@ Help: Use this CRL list Added: 7.19.7 Category: tls Example: --crlfile rejects.txt $URL +See-also: cacert capath --- Provide a file using PEM format with a Certificate Revocation List that may specify peer certificates that are to be considered revoked. diff --git a/docs/cmdline-opts/curves.d b/docs/cmdline-opts/curves.d index ac5ab1016..75b731279 100644 --- a/docs/cmdline-opts/curves.d +++ b/docs/cmdline-opts/curves.d @@ -5,6 +5,7 @@ Protocols: TLS Added: 7.73.0 Category: tls Example: --curves X25519 $URL +See-also: ciphers --- Tells curl to request specific curves to use during SSL session establishment according to RFC 8422, 5.1. Multiple algorithms can be provided by separating diff --git a/docs/cmdline-opts/data-ascii.d b/docs/cmdline-opts/data-ascii.d index ff2c0bc38..52366dc43 100644 --- a/docs/cmdline-opts/data-ascii.d +++ b/docs/cmdline-opts/data-ascii.d @@ -5,5 +5,6 @@ Protocols: HTTP Category: http post upload Example: --data-ascii @file $URL Added: 7.2 +See-also: data-binary data-raw data-urlencode --- This is just an alias for --data. diff --git a/docs/cmdline-opts/data-binary.d b/docs/cmdline-opts/data-binary.d index 60951a4bf..161df587d 100644 --- a/docs/cmdline-opts/data-binary.d +++ b/docs/cmdline-opts/data-binary.d @@ -5,6 +5,7 @@ Protocols: HTTP Category: http post upload Example: --data-binary @filename $URL Added: 7.2 +See-also: data-ascii --- This posts data exactly as specified with no extra processing whatsoever. diff --git a/docs/cmdline-opts/delegation.d b/docs/cmdline-opts/delegation.d index 3d7e59fe7..858ff0406 100644 --- a/docs/cmdline-opts/delegation.d +++ b/docs/cmdline-opts/delegation.d @@ -5,6 +5,7 @@ Protocols: GSS/kerberos Category: auth Example: --delegation "none" $URL Added: 7.22.0 +See-also: insecure ssl --- Set LEVEL to tell the server what it is allowed to delegate when it comes to user credentials. diff --git a/docs/cmdline-opts/disable-eprt.d b/docs/cmdline-opts/disable-eprt.d index 9a927a92b..6b82f1376 100644 --- a/docs/cmdline-opts/disable-eprt.d +++ b/docs/cmdline-opts/disable-eprt.d @@ -4,6 +4,7 @@ Protocols: FTP Category: ftp Example: --disable-eprt ftp://example.com/ Added: 7.10.5 +See-also: disable-epsv ftp-port --- Tell curl to disable the use of the EPRT and LPRT commands when doing active FTP transfers. Curl will normally always first attempt to use EPRT, then LPRT diff --git a/docs/cmdline-opts/disable-epsv.d b/docs/cmdline-opts/disable-epsv.d index dfd8f7365..468472626 100644 --- a/docs/cmdline-opts/disable-epsv.d +++ b/docs/cmdline-opts/disable-epsv.d @@ -4,6 +4,7 @@ Protocols: FTP Category: ftp Example: --disable-epsv ftp://example.com/ Added: 7.9.2 +See-also: disable-eprt ftp-port --- Tell curl to disable the use of the EPSV command when doing passive FTP transfers. Curl will normally always first attempt to use EPSV before diff --git a/docs/cmdline-opts/disable.d b/docs/cmdline-opts/disable.d index e7dd6c722..e417571f1 100644 --- a/docs/cmdline-opts/disable.d +++ b/docs/cmdline-opts/disable.d @@ -4,6 +4,7 @@ Help: Disable .curlrc Category: curl Example: -q $URL Added: 5.0 +See-also: config --- If used as the first parameter on the command line, the *curlrc* config file will not be read and used. See the --config for details on the default diff --git a/docs/cmdline-opts/dns-servers.d b/docs/cmdline-opts/dns-servers.d index 089473580..8a2341528 100644 --- a/docs/cmdline-opts/dns-servers.d +++ b/docs/cmdline-opts/dns-servers.d @@ -5,6 +5,7 @@ Requires: c-ares Added: 7.33.0 Category: dns Example: --dns-servers 192.168.0.1,192.168.0.2 $URL +See-also: dns-interface dns-ipv4-addr --- Set the list of DNS servers to be used instead of the system default. The list of IP addresses should be separated with commas. Port numbers diff --git a/docs/cmdline-opts/doh-cert-status.d b/docs/cmdline-opts/doh-cert-status.d index a760a6fb1..0e382339c 100644 --- a/docs/cmdline-opts/doh-cert-status.d +++ b/docs/cmdline-opts/doh-cert-status.d @@ -4,5 +4,6 @@ Protocols: all Added: 7.76.0 Category: dns tls Example: --doh-cert-status --doh-url https://doh.example $URL +See-also: doh-insecure --- Same as --cert-status but used for DoH (DNS-over-HTTPS). diff --git a/docs/cmdline-opts/doh-insecure.d b/docs/cmdline-opts/doh-insecure.d index 907a5dcd6..f68bf8a6f 100644 --- a/docs/cmdline-opts/doh-insecure.d +++ b/docs/cmdline-opts/doh-insecure.d @@ -4,5 +4,6 @@ Protocols: all Added: 7.76.0 Category: dns tls Example: --doh-insecure --doh-url https://doh.example $URL +See-also: doh-url --- Same as --insecure but used for DoH (DNS-over-HTTPS). diff --git a/docs/cmdline-opts/doh-url.d b/docs/cmdline-opts/doh-url.d index 80ff96ccc..b2fc89498 100644 --- a/docs/cmdline-opts/doh-url.d +++ b/docs/cmdline-opts/doh-url.d @@ -5,6 +5,7 @@ Protocols: all Added: 7.62.0 Category: dns Example: --doh-url https://doh.example $URL +See-also: doh-insecure --- Specifies which DNS-over-HTTPS (DoH) server to use to resolve hostnames, instead of using the default name resolver mechanism. The URL must be HTTPS. diff --git a/docs/cmdline-opts/engine.d b/docs/cmdline-opts/engine.d index 16349e560..6382dfdab 100644 --- a/docs/cmdline-opts/engine.d +++ b/docs/cmdline-opts/engine.d @@ -5,6 +5,7 @@ Protocols: TLS Category: tls Example: --engine flavor $URL Added: 7.9.3 +See-also: ciphers curves --- Select the OpenSSL crypto engine to use for cipher operations. Use --engine list to print a list of build-time supported engines. Note that not all (and diff --git a/docs/cmdline-opts/etag-compare.d b/docs/cmdline-opts/etag-compare.d index fa1676287..494633f5c 100644 --- a/docs/cmdline-opts/etag-compare.d +++ b/docs/cmdline-opts/etag-compare.d @@ -5,6 +5,7 @@ Protocols: HTTP Added: 7.68.0 Category: http Example: --etag-compare etag.txt $URL +See-also: etag-save time-cond --- This option makes a conditional HTTP request for the specific ETag read from the given file by sending a custom If-None-Match header using the diff --git a/docs/cmdline-opts/etag-save.d b/docs/cmdline-opts/etag-save.d index 8efad9044..5cce0ee1c 100644 --- a/docs/cmdline-opts/etag-save.d +++ b/docs/cmdline-opts/etag-save.d @@ -5,6 +5,7 @@ Protocols: HTTP Added: 7.68.0 Category: http Example: --etag-save storetag.txt $URL +See-also: etag-compare --- This option saves an HTTP ETag to the specified file. An ETag is a caching related header, usually returned in a response. diff --git a/docs/cmdline-opts/fail-early.d b/docs/cmdline-opts/fail-early.d index aad15c3fe..fc3e45aef 100644 --- a/docs/cmdline-opts/fail-early.d +++ b/docs/cmdline-opts/fail-early.d @@ -3,6 +3,7 @@ Help: Fail on first transfer error, do not continue Added: 7.52.0 Category: curl Example: --fail-early $URL https://two.example +See-also: fail fail-with-body --- Fail and exit on the first detected transfer error. diff --git a/docs/cmdline-opts/false-start.d b/docs/cmdline-opts/false-start.d index de36962ee..4fe4eaa7b 100644 --- a/docs/cmdline-opts/false-start.d +++ b/docs/cmdline-opts/false-start.d @@ -4,6 +4,7 @@ Protocols: TLS Added: 7.42.0 Category: tls Example: --false-start $URL +See-also: tcp-fastopen --- Tells curl to use false start during the TLS handshake. False start is a mode where a TLS client will start sending application data before verifying the diff --git a/docs/cmdline-opts/form.d b/docs/cmdline-opts/form.d index 737d2b398..2549d0ebf 100644 --- a/docs/cmdline-opts/form.d +++ b/docs/cmdline-opts/form.d @@ -7,6 +7,7 @@ Mutexed: data head upload-file Category: http upload Example: --form "name=curl" --form "file=@loadthis" $URL Added: 5.0 +See-also: data form-string form-escape --- For HTTP protocol family, this lets curl emulate a filled-in form in which a user has pressed the submit button. This causes curl to POST data using the diff --git a/docs/cmdline-opts/ftp-account.d b/docs/cmdline-opts/ftp-account.d index ce816f10d..e47b44cb4 100644 --- a/docs/cmdline-opts/ftp-account.d +++ b/docs/cmdline-opts/ftp-account.d @@ -5,6 +5,7 @@ Protocols: FTP Added: 7.13.0 Category: ftp auth Example: --ftp-account "mr.robot" ftp://example.com/ +See-also: user --- When an FTP server asks for "account data" after user name and password has been provided, this data is sent off using the ACCT command. diff --git a/docs/cmdline-opts/ftp-alternative-to-user.d b/docs/cmdline-opts/ftp-alternative-to-user.d index a5fb9853d..fdf3b417a 100644 --- a/docs/cmdline-opts/ftp-alternative-to-user.d +++ b/docs/cmdline-opts/ftp-alternative-to-user.d @@ -5,6 +5,7 @@ Protocols: FTP Added: 7.15.5 Category: ftp Example: --ftp-alternative-to-user "U53r" ftp://example.com +See-also: ftp-account user --- If authenticating with the USER and PASS commands fails, send this command. When connecting to Tumbleweed's Secure Transport server over FTPS using a diff --git a/docs/cmdline-opts/ftp-method.d b/docs/cmdline-opts/ftp-method.d index 82ab4819a..0d69356c6 100644 --- a/docs/cmdline-opts/ftp-method.d +++ b/docs/cmdline-opts/ftp-method.d @@ -7,6 +7,7 @@ Category: ftp Example: --ftp-method multicwd ftp://example.com/dir1/dir2/file Example: --ftp-method nocwd ftp://example.com/dir1/dir2/file Example: --ftp-method singlecwd ftp://example.com/dir1/dir2/file +See-also: list-only --- Control what method curl should use to reach a file on an FTP(S) server. The method argument should be one of the following alternatives: diff --git a/docs/cmdline-opts/ftp-pret.d b/docs/cmdline-opts/ftp-pret.d index 453d8cf85..8d9d7749c 100644 --- a/docs/cmdline-opts/ftp-pret.d +++ b/docs/cmdline-opts/ftp-pret.d @@ -4,6 +4,7 @@ Protocols: FTP Added: 7.20.0 Category: ftp Example: --ftp-pret ftp://example.com/ +See-also: ftp-port ftp-pasv --- Tell curl to send a PRET command before PASV (and EPSV). Certain FTP servers, mainly drftpd, require this non-standard command for directory listings as diff --git a/docs/cmdline-opts/ftp-ssl-control.d b/docs/cmdline-opts/ftp-ssl-control.d index c2dee3134..7221b996b 100644 --- a/docs/cmdline-opts/ftp-ssl-control.d +++ b/docs/cmdline-opts/ftp-ssl-control.d @@ -4,6 +4,7 @@ Protocols: FTP Added: 7.16.0 Category: ftp tls Example: --ftp-ssl-control ftp://example.com +See-also: ssl --- Require SSL/TLS for the FTP login, clear for transfer. Allows secure authentication, but non-encrypted data transfers for efficiency. Fails the diff --git a/docs/cmdline-opts/gen.pl b/docs/cmdline-opts/gen.pl index e891f6709..fc3c50fda 100755 --- a/docs/cmdline-opts/gen.pl +++ b/docs/cmdline-opts/gen.pl @@ -228,19 +228,23 @@ sub single { elsif(/^---/) { if(!$long) { print STDERR "ERROR: no 'Long:' in $f\n"; - exit 1; + return 1; } if(!$category) { print STDERR "ERROR: no 'Category:' in $f\n"; - exit 2; + return 2; } if(!$examples[0]) { print STDERR "$f:$line:1:ERROR: no 'Example:' present\n"; - exit 2; + return 2; } if(!$added) { print STDERR "$f:$line:1:ERROR: no 'Added:' version present\n"; - exit 2; + return 2; + } + if(!$seealso) { + print STDERR "$f:$line:1:ERROR: no 'See-also:' field present\n"; + return 2; } last; } @@ -304,7 +308,7 @@ sub single { my $i = 0; for my $k (@m) { if(!$helplong{$k}) { - print STDERR "WARN: $f see-alsos a non-existing option: $k\n"; + print STDERR "$f:$line:1:WARN: see-also a non-existing option: $k\n"; } my $l = manpageify($k); my $sep = " and"; @@ -522,17 +526,17 @@ sub listcats { sub mainpage { my (@files) = @_; + my $ret; # show the page header header("page-header"); # output docs for all options foreach my $f (sort @files) { - if(single($f, 0)) { - print STDERR "Can't read $f?\n"; - } + $ret += single($f, 0); } header("page-footer"); + exit $ret if($ret); } sub showonly { diff --git a/docs/cmdline-opts/get.d b/docs/cmdline-opts/get.d index 22a5522f6..3920d686c 100644 --- a/docs/cmdline-opts/get.d +++ b/docs/cmdline-opts/get.d @@ -6,6 +6,7 @@ Example: --get $URL Example: --get -d "tool=curl" -d "age=old" $URL Example: --get -I -d "tool=curl" $URL Added: 7.8.1 +See-also: data request --- When used, this option will make all data specified with --data, --data-binary or --data-urlencode to be used in an HTTP GET request instead of the POST diff --git a/docs/cmdline-opts/globoff.d b/docs/cmdline-opts/globoff.d index 642cb4b8c..7660c8b71 100644 --- a/docs/cmdline-opts/globoff.d +++ b/docs/cmdline-opts/globoff.d @@ -4,6 +4,7 @@ Help: Disable URL sequences and ranges using {} and [] Category: curl Example: -g "https://example.com/{[]}}}}" Added: 7.6 +See-also: config disable --- This option switches off the "URL globbing parser". When you set this option, you can specify URLs that contain the letters {}[] without having curl itself diff --git a/docs/cmdline-opts/happy-eyeballs-timeout-ms.d b/docs/cmdline-opts/happy-eyeballs-timeout-ms.d index c3b2a5132..6897a69a5 100644 --- a/docs/cmdline-opts/happy-eyeballs-timeout-ms.d +++ b/docs/cmdline-opts/happy-eyeballs-timeout-ms.d @@ -4,6 +4,7 @@ Help: Time for IPv6 before trying IPv4 Added: 7.59.0 Category: connection Example: --happy-eyeballs-timeout-ms 500 $URL +See-also: max-time connect-timeout --- Happy Eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6 addresses for dual-stack hosts, giving IPv6 a head-start of the specified diff --git a/docs/cmdline-opts/haproxy-protocol.d b/docs/cmdline-opts/haproxy-protocol.d index 446dc6572..792db6766 100644 --- a/docs/cmdline-opts/haproxy-protocol.d +++ b/docs/cmdline-opts/haproxy-protocol.d @@ -4,6 +4,7 @@ Protocols: HTTP Added: 7.60.0 Category: http proxy Example: --haproxy-protocol $URL +See-also: proxy --- Send a HAProxy PROXY protocol v1 header at the beginning of the connection. This is used by some load balancers and reverse proxies to diff --git a/docs/cmdline-opts/head.d b/docs/cmdline-opts/head.d index c8297c0a5..c659337ff 100644 --- a/docs/cmdline-opts/head.d +++ b/docs/cmdline-opts/head.d @@ -5,6 +5,7 @@ Protocols: HTTP FTP FILE Category: http ftp file Example: -I $URL Added: 4.0 +See-also: get verbose trace-ascii --- Fetch the headers only! HTTP-servers feature the command HEAD which this uses to get nothing but the header of a document. When used on an FTP or FILE file, diff --git a/docs/cmdline-opts/help.d b/docs/cmdline-opts/help.d index 1600b8bca..664c040a8 100644 --- a/docs/cmdline-opts/help.d +++ b/docs/cmdline-opts/help.d @@ -5,6 +5,7 @@ Help: Get help for commands Category: important curl Example: --help all Added: 4.0 +See-also: verbose --- Usage help. This lists all commands of the <category>. If no arg was provided, curl will display the most important diff --git a/docs/cmdline-opts/hostpubmd5.d b/docs/cmdline-opts/hostpubmd5.d index 833db950c..d3ea6b6f4 100644 --- a/docs/cmdline-opts/hostpubmd5.d +++ b/docs/cmdline-opts/hostpubmd5.d @@ -5,6 +5,7 @@ Protocols: SFTP SCP Added: 7.17.1 Category: sftp scp Example: --hostpubmd5 e5c1c49020640a5ab0f2034854c321a8 sftp://example.com/ +See-also: hostpubsha256 --- Pass a string containing 32 hexadecimal digits. The string should be the 128 bit MD5 checksum of the remote host's public key, curl will refuse diff --git a/docs/cmdline-opts/hostpubsha256.d b/docs/cmdline-opts/hostpubsha256.d index 81e6f9851..2330d1a36 100644 --- a/docs/cmdline-opts/hostpubsha256.d +++ b/docs/cmdline-opts/hostpubsha256.d @@ -5,6 +5,7 @@ Protocols: SFTP SCP Added: 7.80.0 Category: sftp scp Example: --hostpubsha256 NDVkMTQxMGQ1ODdmMjQ3MjczYjAyOTY5MmRkMjVmNDQ= sftp://example.com/ +See-also: hostpubmd5 --- Pass a string containing a Base64-encoded SHA256 hash of the remote host's public key. Curl will refuse the connection with the host diff --git a/docs/cmdline-opts/hsts.d b/docs/cmdline-opts/hsts.d index f9cd453da..65526f050 100644 --- a/docs/cmdline-opts/hsts.d +++ b/docs/cmdline-opts/hsts.d @@ -5,6 +5,7 @@ Help: Enable HSTS with this cache file Added: 7.74.0 Category: http Example: --hsts cache.txt $URL +See-also: proto --- This option enables HSTS for the transfer. If the file name points to an existing HSTS cache file, that will be used. After a completed transfer, the diff --git a/docs/cmdline-opts/http0.9.d b/docs/cmdline-opts/http0.9.d index 03def27c0..5797b2d7d 100644 --- a/docs/cmdline-opts/http0.9.d +++ b/docs/cmdline-opts/http0.9.d @@ -5,6 +5,7 @@ Help: Allow HTTP 0.9 responses Category: http Example: --http0.9 $URL Added: 7.64.0 +See-also: http1.1 http2 http3 --- Tells curl to be fine with HTTP version 0.9 response. diff --git a/docs/cmdline-opts/http1.0.d b/docs/cmdline-opts/http1.0.d index 3060a13c9..84e390055 100644 --- a/docs/cmdline-opts/http1.0.d +++ b/docs/cmdline-opts/http1.0.d @@ -7,6 +7,7 @@ Mutexed: http1.1 http2 Help: Use HTTP 1.0 Category: http Example: --http1.0 $URL +See-also: http0.9 http1.1 --- Tells curl to use HTTP version 1.0 instead of using its internally preferred HTTP version. diff --git a/docs/cmdline-opts/http1.1.d b/docs/cmdline-opts/http1.1.d index 01fa76d33..84b2c59d8 100644 --- a/docs/cmdline-opts/http1.1.d +++ b/docs/cmdline-opts/http1.1.d @@ -6,5 +6,6 @@ Mutexed: http1.0 http2 Help: Use HTTP 1.1 Category: http Example: --http1.1 $URL +See-also: http1.1 http0.9 --- Tells curl to use HTTP version 1.1. diff --git a/docs/cmdline-opts/http2-prior-knowledge.d b/docs/cmdline-opts/http2-prior-knowledge.d index e3b32f6ba..4e9446729 100644 --- a/docs/cmdline-opts/http2-prior-knowledge.d +++ b/docs/cmdline-opts/http2-prior-knowledge.d @@ -7,6 +7,7 @@ Requires: HTTP/2 Help: Use HTTP 2 without HTTP/1.1 Upgrade Category: http Example: --http2-prior-knowledge $URL +See-also: http2 http3 --- Tells curl to issue its non-TLS HTTP requests using HTTP/2 without HTTP/1.1 Upgrade. It requires prior knowledge that the server supports HTTP/2 straight diff --git a/docs/cmdline-opts/ignore-content-length.d b/docs/cmdline-opts/ignore-content-length.d index 8badf4ea0..4844ecafd 100644 --- a/docs/cmdline-opts/ignore-content-length.d +++ b/docs/cmdline-opts/ignore-content-length.d @@ -4,6 +4,7 @@ Protocols: FTP HTTP Category: http ftp Example: --ignore-content-length $URL Added: 7.14.1 +See-also: ftp-skip-pasv-ip --- For HTTP, Ignore the Content-Length header. This is particularly useful for servers running Apache 1.x, which will report incorrect Content-Length for diff --git a/docs/cmdline-opts/keepalive-time.d b/docs/cmdline-opts/keepalive-time.d index 1b96c4dc5..cdc150aa7 100644 --- a/docs/cmdline-opts/keepalive-time.d +++ b/docs/cmdline-opts/keepalive-time.d @@ -4,6 +4,7 @@ Help: Interval time for keepalive probes Added: 7.18.0 Category: connection Example: --keepalive-time 20 $URL +See-also: no-keepalive max-time --- This option sets the time a connection needs to remain idle before sending keepalive probes and the time between individual keepalive probes. It is diff --git a/docs/cmdline-opts/key-type.d b/docs/cmdline-opts/key-type.d index 6fbec77b3..7a073a803 100644 --- a/docs/cmdline-opts/key-type.d +++ b/docs/cmdline-opts/key-type.d @@ -5,6 +5,7 @@ Protocols: TLS Category: tls Example: --key-type DER --key here $URL Added: 7.9.3 +See-also: key --- Private key file type. Specify which type your --key provided private key is. DER, PEM, and ENG are supported. If not specified, PEM is assumed. diff --git a/docs/cmdline-opts/key.d b/docs/cmdline-opts/key.d index b8a37384f..8d9c1136c 100644 --- a/docs/cmdline-opts/key.d +++ b/docs/cmdline-opts/key.d @@ -5,6 +5,7 @@ Help: Private key file name Category: tls ssh Example: --cert certificate --key here $URL Added: 7.9.3 +See-also: key-type cert --- Private key file name. Allows you to provide your private key in this separate file. For SSH, if not specified, curl tries the following candidates in order: diff --git a/docs/cmdline-opts/krb.d b/docs/cmdline-opts/krb.d index 36a084704..ad2d8f679 100644 --- a/docs/cmdline-opts/krb.d +++ b/docs/cmdline-opts/krb.d @@ -6,6 +6,7 @@ Requires: Kerberos Category: ftp Example: --krb clear ftp://example.com/ Added: 7.3 +See-also: delegation ssl --- Enable Kerberos authentication and use. The level must be entered and should be one of 'clear', 'safe', 'confidential', or 'private'. Should you use a diff --git a/docs/cmdline-opts/libcurl.d b/docs/cmdline-opts/libcurl.d index b7371fffe..752eda31a 100644 --- a/docs/cmdline-opts/libcurl.d +++ b/docs/cmdline-opts/libcurl.d @@ -4,6 +4,7 @@ Help: Dump libcurl equivalent code of this command line Added: 7.16.1 Category: curl Example: --libcurl client.c $URL +See-also: verbose --- Append this option to any ordinary curl command line, and you will get libcurl-using C source code written to the file that does the equivalent diff --git a/docs/cmdline-opts/limit-rate.d b/docs/cmdline-opts/limit-rate.d index 6a46c0006..9594dfee2 100644 --- a/docs/cmdline-opts/limit-rate.d +++ b/docs/cmdline-opts/limit-rate.d @@ -6,6 +6,7 @@ Example: --limit-rate 100K $URL Example: --limit-rate 1000 $URL Example: --limit-rate 10M $URL Added: 7.10 +See-also: speed-limit speed-time --- Specify the maximum transfer rate you want curl to use - for both downloads and uploads. This feature is useful if you have a limited pipe and you would like diff --git a/docs/cmdline-opts/list-only.d b/docs/cmdline-opts/list-only.d index c7bf7b4ac..4fb2f6b9b 100644 --- a/docs/cmdline-opts/list-only.d +++ b/docs/cmdline-opts/list-only.d @@ -5,6 +5,7 @@ Help: List only mode Added: 4.0 Category: ftp pop3 Example: --list-only ftp://example.com/dir/ +See-also: quote request --- (FTP) When listing an FTP directory, this switch forces a name-only view. This is diff --git a/docs/cmdline-opts/local-port.d b/docs/cmdline-opts/local-port.d index 776641700..fd157d93c 100644 --- a/docs/cmdline-opts/local-port.d +++ b/docs/cmdline-opts/local-port.d @@ -4,6 +4,7 @@ Help: Force use of RANGE for local port numbers Added: 7.15.2 Category: connection Example: --local-port 1000-3000 $URL +See-also: globoff --- Set a preferred single number or range (FROM-TO) of local port numbers to use for the connection(s). Note that port numbers by nature are a scarce resource diff --git a/docs/cmdline-opts/location.d b/docs/cmdline-opts/location.d index 941390a7f..e694dfad1 100644 --- a/docs/cmdline-opts/location.d +++ b/docs/cmdline-opts/location.d @@ -5,6 +5,7 @@ Protocols: HTTP Category: http Example: -L $URL Added: 4.9 +See-also: resolve alt-svc --- If the server reports that the requested page has moved to a different location (indicated with a Location: header and a 3XX response code), this diff --git a/docs/cmdline-opts/login-options.d b/docs/cmdline-opts/login-options.d index de7728854..4c53db3fd 100644 --- a/docs/cmdline-opts/login-options.d +++ b/docs/cmdline-opts/login-options.d @@ -5,6 +5,7 @@ Help: Server login options Added: 7.34.0 Category: imap pop3 smtp auth Example: --login-options 'AUTH=*' imap://example.com +See-also: user --- Specify the login options to use during server authentication. diff --git a/docs/cmdline-opts/mail-rcpt-allowfails.d b/docs/cmdline-opts/mail-rcpt-allowfails.d index 36d555e17..12296afdc 100644 --- a/docs/cmdline-opts/mail-rcpt-allowfails.d +++ b/docs/cmdline-opts/mail-rcpt-allowfails.d @@ -4,6 +4,7 @@ Protocols: SMTP Added: 7.69.0 Category: smtp Example: --mail-rcpt-allowfails --mail-rcpt dest@example.com smtp://example.com +See-also: mail-rcpt --- When sending data to multiple recipients, by default curl will abort SMTP conversation if at least one of the recipients causes RCPT TO command to diff --git a/docs/cmdline-opts/mail-rcpt.d b/docs/cmdline-opts/mail-rcpt.d index d4a2502ee..240f7e5c4 100644 --- a/docs/cmdline-opts/mail-rcpt.d +++ b/docs/cmdline-opts/mail-rcpt.d @@ -5,6 +5,7 @@ Protocols: SMTP Added: 7.20.0 Category: smtp Example: --mail-rcpt user@example.net smtp://example.com +See-also: mail-rcpt-allowfails --- Specify a single e-mail address, user name or mailing list name. Repeat this option several times to send to multiple recipients. diff --git a/docs/cmdline-opts/manual.d b/docs/cmdline-opts/manual.d index b4ebf3e1f..9674a465d 100644 --- a/docs/cmdline-opts/manual.d +++ b/docs/cmdline-opts/manual.d @@ -4,5 +4,6 @@ Help: Display the full manual Category: curl Example: --manual Added: 5.2 +See-also: verbose libcurl trace --- Manual. Display the huge help text. diff --git a/docs/cmdline-opts/max-redirs.d b/docs/cmdline-opts/max-redirs.d index bb045140a..a0b549399 100644 --- a/docs/cmdline-opts/max-redirs.d +++ b/docs/cmdline-opts/max-redirs.d @@ -5,6 +5,7 @@ Protocols: HTTP Category: http Example: --max-redirs 3 --location $URL Added: 7.5 +See-also: location --- Set maximum number of redirections to follow. When --location is used, to prevent curl from following too many redirects, by default, the limit is diff --git a/docs/cmdline-opts/metalink.d b/docs/cmdline-opts/metalink.d index 1fc108742..f1c0aeefe 100644 --- a/docs/cmdline-opts/metalink.d +++ b/docs/cmdline-opts/metalink.d @@ -3,6 +3,7 @@ Help: Process given URLs as metalink XML file Added: 7.27.0 Category: misc Example: --metalink file $URL +See-also: parallel --- This option was previously used to specify a metalink resource. Metalink support has been disabled in curl since 7.78.0 for security reasons. diff --git a/docs/cmdline-opts/netrc-file.d b/docs/cmdline-opts/netrc-file.d index df89d51f5..3f6f7b105 100644 --- a/docs/cmdline-opts/netrc-file.d +++ b/docs/cmdline-opts/netrc-file.d @@ -5,6 +5,7 @@ Added: 7.21.5 Mutexed: netrc Category: curl Example: --netrc-file netrc $URL +See-also: netrc user config --- This option is similar to --netrc, except that you provide the path (absolute or relative) to the netrc file that curl should use. You can only specify one diff --git a/docs/cmdline-opts/netrc.d b/docs/cmdline-opts/netrc.d index 8a366bdc1..86d84cd4d 100644 --- a/docs/cmdline-opts/netrc.d +++ b/docs/cmdline-opts/netrc.d @@ -4,6 +4,7 @@ Help: Must read .netrc for user name and password Category: curl Example: --netrc $URL Added: 4.6 +See-also: netrc-file config user --- Makes curl scan the *.netrc* (*_netrc* on Windows) file in the user's home directory for login name and password. This is typically used for FTP on diff --git a/docs/cmdline-opts/next.d b/docs/cmdline-opts/next.d index bcbad68e5..d3da64f54 100644 --- a/docs/cmdline-opts/next.d +++ b/docs/cmdline-opts/next.d @@ -8,6 +8,7 @@ Help: Make next URL use its separate set of options Category: curl Example: $URL --next -d postthis www2.example.com Example: -I $URL --next https://example.net/ +See-also: parallel config --- Tells curl to use a separate operation for the following URL and associated options. This allows you to send several URL requests, each with their own diff --git a/docs/cmdline-opts/no-buffer.d b/docs/cmdline-opts/no-buffer.d index fe19292a3..c356eb34d 100644 --- a/docs/cmdline-opts/no-buffer.d +++ b/docs/cmdline-opts/no-buffer.d @@ -4,6 +4,7 @@ Help: Disable buffering of the output stream Category: curl Example: --no-buffer $URL Added: 6.5 +See-also: progress-bar --- Disables the buffering of the output stream. In normal work situations, curl will use a standard buffered output stream that will have the effect that it diff --git a/docs/cmdline-opts/no-keepalive.d b/docs/cmdline-opts/no-keepalive.d index e62f8d880..d65a3bd21 100644 --- a/docs/cmdline-opts/no-keepalive.d +++ b/docs/cmdline-opts/no-keepalive.d @@ -3,6 +3,7 @@ Help: Disable TCP keepalive on the connection Category: connection Example: --no-keepalive $URL Added: 7.18.0 +See-also: keepalive-time --- Disables the use of keepalive messages on the TCP connection. curl otherwise enables them by default. diff --git a/docs/cmdline-opts/no-sessionid.d b/docs/cmdline-opts/no-sessionid.d index 70a32210e..d51dac6f3 100644 --- a/docs/cmdline-opts/no-sessionid.d +++ b/docs/cmdline-opts/no-sessionid.d @@ -4,6 +4,7 @@ Protocols: TLS Added: 7.16.0 Category: tls Example: --no-sessionid $URL +See-also: insecure --- Disable curl's use of SSL session-ID caching. By default all transfers are done using the cache. Note that while nothing should ever get hurt by diff --git a/docs/cmdline-opts/noproxy.d b/docs/cmdline-opts/noproxy.d index ee0978e03..0ed390779 100644 --- a/docs/cmdline-opts/noproxy.d +++ b/docs/cmdline-opts/noproxy.d @@ -4,6 +4,7 @@ Help: List of hosts which do not use proxy Added: 7.19.4 Category: proxy Example: --noproxy "www.example" $URL +See-also: proxy --- Comma-separated list of hosts for which not to use a proxy, if one is specified. The only wildcard is a single * character, which matches all hosts, diff --git a/docs/cmdline-opts/oauth2-bearer.d b/docs/cmdline-opts/oauth2-bearer.d index 49691622f..e5ed0e87f 100644 --- a/docs/cmdline-opts/oauth2-bearer.d +++ b/docs/cmdline-opts/oauth2-bearer.d @@ -5,6 +5,7 @@ Protocols: IMAP POP3 SMTP HTTP Category: auth Example: --oauth2-bearer "mF_9.B5f-4.1JqM" $URL Added: 7.33.0 +See-also: basic ntlm digest --- Specify the Bearer Token for OAUTH 2.0 server authentication. The Bearer Token is used in conjunction with the user name which can be specified as part of diff --git a/docs/cmdline-opts/parallel.d b/docs/cmdline-opts/parallel.d index 2a0ca4340..f2ccaa78e 100644 --- a/docs/cmdline-opts/parallel.d +++ b/docs/cmdline-opts/parallel.d @@ -4,6 +4,7 @@ Help: Perform transfers in parallel Added: 7.66.0 Category: connection curl Example: --parallel $URL -o file1 $URL -o file2 +See-also: next verbose --- Makes curl perform its transfers in parallel as compared to the regular serial manner. diff --git a/docs/cmdline-opts/pass.d b/docs/cmdline-opts/pass.d index 3c85c5e92..621754d61 100644 --- a/docs/cmdline-opts/pass.d +++ b/docs/cmdline-opts/pass.d @@ -5,6 +5,7 @@ Protocols: SSH TLS Category: ssh tls auth Example: --pass secret --key file $URL Added: 7.9.3 +See-also: key user --- Passphrase for the private key. diff --git a/docs/cmdline-opts/path-as-is.d b/docs/cmdline-opts/path-as-is.d index fb87def94..3a82c4409 100644 --- a/docs/cmdline-opts/path-as-is.d +++ b/docs/cmdline-opts/path-as-is.d @@ -3,6 +3,7 @@ Help: Do not squash .. sequences in URL path Added: 7.42.0 Category: curl Example: --path-as-is https://example.com/../../etc/passwd +See-also: request-target --- Tell curl to not handle sequences of /../ or /./ in the given URL path. Normally curl will squash or merge them according to standards but with diff --git a/docs/cmdline-opts/pinnedpubkey.d b/docs/cmdline-opts/pinnedpubkey.d index 7985cb2b3..b47c42a8f 100644 --- a/docs/cmdline-opts/pinnedpubkey.d +++ b/docs/cmdline-opts/pinnedpubkey.d @@ -6,6 +6,7 @@ Category: tls Example: --pinnedpubkey keyfile $URL Example: --pinnedpubkey 'sha256//ce118b51897f4452dc' $URL Added: 7.39.0 +See-also: hostpubsha256 --- Tells curl to use the specified public key file (or hashes) to verify the peer. This can be a path to a file which contains a single public key in PEM diff --git a/docs/cmdline-opts/preproxy.d b/docs/cmdline-opts/preproxy.d index c91565c0e..e5dfb7f94 100644 --- a/docs/cmdline-opts/preproxy.d +++ b/docs/cmdline-opts/preproxy.d @@ -4,6 +4,7 @@ Help: Use this proxy first Added: 7.52.0 Category: proxy Example: --preproxy socks5://proxy.example -x http://http.example $URL +See-also: proxy socks5 --- Use the specified SOCKS proxy before connecting to an HTTP or HTTPS --proxy. In such a case curl first connects to the SOCKS proxy and then connects (through diff --git a/docs/cmdline-opts/progress-bar.d b/docs/cmdline-opts/progress-bar.d index f00be881d..549acb9b1 100644 --- a/docs/cmdline-opts/progress-bar.d +++ b/docs/cmdline-opts/progress-bar.d @@ -4,6 +4,7 @@ Help: Display transfer progress as a bar Category: verbose Example: -# -O $URL Added: 5.10 +See-also: styled-output --- Make curl display transfer progress as a simple progress bar instead of the standard, more informational, meter. diff --git a/docs/cmdline-opts/proto-default.d b/docs/cmdline-opts/proto-default.d index a659b840d..86c59f5c6 100644 --- a/docs/cmdline-opts/proto-default.d +++ b/docs/cmdline-opts/proto-default.d @@ -4,6 +4,7 @@ Arg: <protocol> Added: 7.45.0 Category: connection curl Example: --proto-default https ftp.example.com +See-also: proto proto-redir --- Tells curl to use *protocol* for any URL missing a scheme name. diff --git a/docs/cmdline-opts/proto-redir.d b/docs/cmdline-opts/proto-redir.d index 73a27d039..d8cd296ff 100644 --- a/docs/cmdline-opts/proto-redir.d +++ b/docs/cmdline-opts/proto-redir.d @@ -4,6 +4,7 @@ Help: Enable/disable PROTOCOLS on redirect Added: 7.20.2 Category: connection curl Example: --proto-redir =http,https $URL +See-also: proto --- Tells curl to limit what protocols it may use on redirect. Protocols denied by --proto are not overridden by this option. See --proto for how protocols are diff --git a/docs/cmdline-opts/proxy-cert-type.d b/docs/cmdline-opts/proxy-cert-type.d index 2152f537d..9e09fdbbc 100644 --- a/docs/cmdline-opts/proxy-cert-type.d +++ b/docs/cmdline-opts/proxy-cert-type.d @@ -4,5 +4,6 @@ Added: 7.52.0 Help: Client certificate type for HTTPS proxy Category: proxy tls Example: --proxy-cert-type PEM --proxy-cert file -x https://proxy $URL +See-also: proxy-cert --- Same as --cert-type but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-cert.d b/docs/cmdline-opts/proxy-cert.d index 3cf54b73f..5eae2a549 100644 --- a/docs/cmdline-opts/proxy-cert.d +++ b/docs/cmdline-opts/proxy-cert.d @@ -4,5 +4,6 @@ Help: Set client certificate for proxy Added: 7.52.0 Category: proxy tls Example: --proxy-cert file -x https://proxy $URL +See-also: proxy-cert-type --- Same as --cert but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-ciphers.d b/docs/cmdline-opts/proxy-ciphers.d index b4c358091..aefcc92c0 100644 --- a/docs/cmdline-opts/proxy-ciphers.d +++ b/docs/cmdline-opts/proxy-ciphers.d @@ -4,5 +4,6 @@ Help: SSL ciphers to use for proxy Added: 7.52.0 Category: proxy tls Example: --proxy-ciphers ECDHE-ECDSA-AES256-CCM8 -x https://proxy $URL +See-also: ciphers curves proxy --- Same as --ciphers but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-crlfile.d b/docs/cmdline-opts/proxy-crlfile.d index 1ac199965..3dd018075 100644 --- a/docs/cmdline-opts/proxy-crlfile.d +++ b/docs/cmdline-opts/proxy-crlfile.d @@ -4,5 +4,6 @@ Help: Set a CRL list for proxy Added: 7.52.0 Category: proxy tls Example: --proxy-crlfile rejects.txt -x https://proxy $URL +See-also: crlfile proxy --- Same as --crlfile but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-header.d b/docs/cmdline-opts/proxy-header.d index 273a773d9..8ea209387 100644 --- a/docs/cmdline-opts/proxy-header.d +++ b/docs/cmdline-opts/proxy-header.d @@ -7,6 +7,7 @@ Category: proxy Example: --proxy-header "X-First-Name: Joe" -x http://proxy $URL Example: --proxy-header "User-Agent: surprise" -x http://proxy $URL Example: --proxy-header "Host:" -x http://proxy $URL +See-also: proxy --- Extra header to include in the request when sending HTTP to a proxy. You may specify any number of extra headers. This is the equivalent option to --header diff --git a/docs/cmdline-opts/proxy-insecure.d b/docs/cmdline-opts/proxy-insecure.d index 3f4f7c180..738d42286 100644 --- a/docs/cmdline-opts/proxy-insecure.d +++ b/docs/cmdline-opts/proxy-insecure.d @@ -3,5 +3,6 @@ Help: Do HTTPS proxy connections without verifying the proxy Added: 7.52.0 Category: proxy tls Example: --proxy-insecure -x https://proxy $URL +See-also: proxy insecure --- Same as --insecure but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-key-type.d b/docs/cmdline-opts/proxy-key-type.d index 31f47afa4..0194ba67c 100644 --- a/docs/cmdline-opts/proxy-key-type.d +++ b/docs/cmdline-opts/proxy-key-type.d @@ -4,5 +4,6 @@ Help: Private key file type for proxy Added: 7.52.0 Category: proxy tls Example: --proxy-key-type DER --proxy-key here -x https://proxy $URL +See-also: proxy-key proxy --- Same as --key-type but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-key.d b/docs/cmdline-opts/proxy-key.d index d0b2c1309..bf6868a43 100644 --- a/docs/cmdline-opts/proxy-key.d +++ b/docs/cmdline-opts/proxy-key.d @@ -4,5 +4,6 @@ Arg: <key> Category: proxy tls Example: --proxy-key here -x https://proxy $URL Added: 7.52.0 +See-also: proxy-key-type proxy --- Same as --key but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-pass.d b/docs/cmdline-opts/proxy-pass.d index b71468413..a513991d0 100644 --- a/docs/cmdline-opts/proxy-pass.d +++ b/docs/cmdline-opts/proxy-pass.d @@ -4,5 +4,6 @@ Help: Pass phrase for the private key for HTTPS proxy Added: 7.52.0 Category: proxy tls auth Example: --proxy-pass secret --proxy-key here -x https://proxy $URL +See-also: proxy proxy-key --- Same as --pass but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-pinnedpubkey.d b/docs/cmdline-opts/proxy-pinnedpubkey.d index 17a57ff2a..4e168ef6c 100644 --- a/docs/cmdline-opts/proxy-pinnedpubkey.d +++ b/docs/cmdline-opts/proxy-pinnedpubkey.d @@ -6,6 +6,7 @@ Category: proxy tls Example: --proxy-pinnedpubkey keyfile $URL Example: --proxy-pinnedpubkey 'sha256//ce118b51897f4452dc' $URL Added: 7.59.0 +See-also: pinnedpubkey proxy --- Tells curl to use the specified public key file (or hashes) to verify the proxy. This can be a path to a file which contains a single public key in PEM diff --git a/docs/cmdline-opts/proxy-service-name.d b/docs/cmdline-opts/proxy-service-name.d index fbed17570..230b802d7 100644 --- a/docs/cmdline-opts/proxy-service-name.d +++ b/docs/cmdline-opts/proxy-service-name.d @@ -4,5 +4,6 @@ Help: SPNEGO proxy service name Added: 7.43.0 Category: proxy tls Example: --proxy-service-name "shrubbery" -x proxy $URL +See-also: service-name proxy --- This option allows you to change the service name for proxy negotiation. diff --git a/docs/cmdline-opts/proxy-ssl-allow-beast.d b/docs/cmdline-opts/proxy-ssl-allow-beast.d index b3e701f05..d712429e3 100644 --- a/docs/cmdline-opts/proxy-ssl-allow-beast.d +++ b/docs/cmdline-opts/proxy-ssl-allow-beast.d @@ -3,5 +3,6 @@ Help: Allow security flaw for interop for HTTPS proxy Added: 7.52.0 Category: proxy tls Example: --proxy-ssl-allow-beast -x https://proxy $URL +See-also: ssl-allow-beast proxy --- Same as --ssl-allow-beast but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-ssl-auto-client-cert.d b/docs/cmdline-opts/proxy-ssl-auto-client-cert.d index 7c071d7ec..77eb53520 100644 --- a/docs/cmdline-opts/proxy-ssl-auto-client-cert.d +++ b/docs/cmdline-opts/proxy-ssl-auto-client-cert.d @@ -3,5 +3,6 @@ Help: Use auto client certificate for proxy (Schannel) Added: 7.77.0 Category: proxy tls Example: --proxy-ssl-auto-client-cert -x https://proxy $URL +See-also: ssl-auto-client-cert proxy --- Same as --ssl-auto-client-cert but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-tls13-ciphers.d b/docs/cmdline-opts/proxy-tls13-ciphers.d index e9524515e..5ec835c7f 100644 --- a/docs/cmdline-opts/proxy-tls13-ciphers.d +++ b/docs/cmdline-opts/proxy-tls13-ciphers.d @@ -5,6 +5,7 @@ Protocols: TLS Category: proxy tls Example: --proxy-tls13-ciphers TLS_AES_128_GCM_SHA256 -x proxy $URL Added: 7.61.0 +See-also: tls13-ciphers curves --- Specifies which cipher suites to use in the connection to your HTTPS proxy when it negotiates TLS 1.3. The list of ciphers suites must specify valid diff --git a/docs/cmdline-opts/proxy-tlsauthtype.d b/docs/cmdline-opts/proxy-tlsauthtype.d index c00928ed5..4d58af5a2 100644 --- a/docs/cmdline-opts/proxy-tlsauthtype.d +++ b/docs/cmdline-opts/proxy-tlsauthtype.d @@ -4,5 +4,6 @@ Help: TLS authentication type for HTTPS proxy Added: 7.52.0 Category: proxy tls auth Example: --proxy-tlsauthtype SRP -x https://proxy $URL +See-also: proxy proxy-tlsuser --- Same as --tlsauthtype but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-tlspassword.d b/docs/cmdline-opts/proxy-tlspassword.d index 89b551d68..6b41ed3c9 100644 --- a/docs/cmdline-opts/proxy-tlspassword.d +++ b/docs/cmdline-opts/proxy-tlspassword.d @@ -4,5 +4,6 @@ Help: TLS password for HTTPS proxy Added: 7.52.0 Category: proxy tls auth Example: --proxy-tlspassword passwd -x https://proxy $URL +See-also: proxy proxy-tlsuser --- Same as --tlspassword but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-tlsuser.d b/docs/cmdline-opts/proxy-tlsuser.d index b3c400ed5..8291ab26a 100644 --- a/docs/cmdline-opts/proxy-tlsuser.d +++ b/docs/cmdline-opts/proxy-tlsuser.d @@ -4,5 +4,6 @@ Help: TLS username for HTTPS proxy Added: 7.52.0 Category: proxy tls auth Example: --proxy-tlsuser smith -x https://proxy $URL +See-also: proxy proxy-tlspassword --- Same as --tlsuser but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-tlsv1.d b/docs/cmdline-opts/proxy-tlsv1.d index c54782e8f..7175e6174 100644 --- a/docs/cmdline-opts/proxy-tlsv1.d +++ b/docs/cmdline-opts/proxy-tlsv1.d @@ -3,5 +3,6 @@ Help: Use TLSv1 for HTTPS proxy Added: 7.52.0 Category: proxy tls auth Example: --proxy-tlsv1 -x https://proxy $URL +See-also: proxy --- Same as --tlsv1 but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-user.d b/docs/cmdline-opts/proxy-user.d index 1d63f4d01..9fd81292d 100644 --- a/docs/cmdline-opts/proxy-user.d +++ b/docs/cmdline-opts/proxy-user.d @@ -5,6 +5,7 @@ Help: Proxy user and password Category: proxy auth Example: --proxy-user name:pwd -x proxy $URL Added: 4.0 +See-also: proxy-pass --- Specify the user name and password to use for proxy authentication. diff --git a/docs/cmdline-opts/proxy.d b/docs/cmdline-opts/proxy.d index 3f6ef7acf..3ad312dd0 100644 --- a/docs/cmdline-opts/proxy.d +++ b/docs/cmdline-opts/proxy.d @@ -5,6 +5,7 @@ Help: Use this proxy Category: proxy Example: --proxy http://proxy.example $URL Added: 4.0 +See-also: socks5 proxy-basic --- Use the specified proxy. diff --git a/docs/cmdline-opts/proxy1.0.d b/docs/cmdline-opts/proxy1.0.d index 8aea3abdd..65faf4b35 100644 --- a/docs/cmdline-opts/proxy1.0.d +++ b/docs/cmdline-opts/proxy1.0.d @@ -4,6 +4,7 @@ Help: Use HTTP/1.0 proxy on given port Category: proxy Example: --proxy1.0 -x http://proxy $URL Added: 7.19.4 +See-also: proxy socks5 preproxy --- Use the specified HTTP 1.0 proxy. If the port number is not specified, it is assumed at port 1080. diff --git a/docs/cmdline-opts/pubkey.d b/docs/cmdline-opts/pubkey.d index cbd60f780..277904912 100644 --- a/docs/cmdline-opts/pubkey.d +++ b/docs/cmdline-opts/pubkey.d @@ -5,6 +5,7 @@ Help: SSH Public key file name Category: sftp scp auth Example: --pubkey file.pub sftp://example.com/ Added: 7.16.2 +See-also: pass --- Public key file name. Allows you to provide your public key in this separate file. diff --git a/docs/cmdline-opts/quote.d b/docs/cmdline-opts/quote.d index 25da93f1d..4b31d0810 100644 --- a/docs/cmdline-opts/quote.d +++ b/docs/cmdline-opts/quote.d @@ -6,6 +6,7 @@ Protocols: FTP SFTP Category: ftp sftp Example: --quote "DELE file" ftp://example.com/foo Added: 5.3 +See-also: request --- Send an arbitrary command to the remote FTP or SFTP server. Quote commands are sent BEFORE the transfer takes place (just after the initial PWD command in an diff --git a/docs/cmdline-opts/random-file.d b/docs/cmdline-opts/random-file.d index d74148a1f..f3e4e10d9 100644 --- a/docs/cmdline-opts/random-file.d +++ b/docs/cmdline-opts/random-file.d @@ -4,6 +4,7 @@ Help: File for reading random data from Category: misc Example: --random-file rubbish $URL Added: 7.7 +See-also: egd-file --- Specify the path name to file containing what will be considered as random data. The data may be used to seed the random engine for SSL connections. See diff --git a/docs/cmdline-opts/range.d b/docs/cmdline-opts/range.d index 90c74b147..7ebf843aa 100644 --- a/docs/cmdline-opts/range.d +++ b/docs/cmdline-opts/range.d @@ -6,6 +6,7 @@ Protocols: HTTP FTP SFTP FILE Category: http ftp sftp file Example: --range 22-44 $URL Added: 4.0 +See-also: continue-at append --- Retrieve a byte range (i.e. a partial document) from an HTTP/1.1, FTP or SFTP server or a local FILE. Ranges can be specified in a number of ways. diff --git a/docs/cmdline-opts/raw.d b/docs/cmdline-opts/raw.d index c44d33f5c..dcf77fc46 100644 --- a/docs/cmdline-opts/raw.d +++ b/docs/cmdline-opts/raw.d @@ -4,6 +4,7 @@ Added: 7.16.2 Protocols: HTTP Category: http Example: --raw $URL +See-also: tr-encoding --- When used, it disables all internal HTTP decoding of content or transfer encodings and instead makes them passed on unaltered, raw. diff --git a/docs/cmdline-opts/remote-header-name.d b/docs/cmdline-opts/remote-header-name.d index 12a805fc3..e34f65c0f 100644 --- a/docs/cmdline-opts/remote-header-name.d +++ b/docs/cmdline-opts/remote-header-name.d @@ -5,6 +5,7 @@ Help: Use the header-provided filename Category: output Example: -OJ https://example.com/file Added: 7.20.0 +See-also: remote-name --- This option tells the --remote-name option to use the server-specified Content-Disposition filename instead of extracting a filename from the URL. diff --git a/docs/cmdline-opts/remote-name-all.d b/docs/cmdline-opts/remote-name-all.d index e27bd5f48..80e8a0a2e 100644 --- a/docs/cmdline-opts/remote-name-all.d +++ b/docs/cmdline-opts/remote-name-all.d @@ -3,6 +3,7 @@ Help: Use the remote file name for all URLs Added: 7.19.0 Category: output Example: --remote-name-all ftp://example.com/file1 ftp://example.com/file2 +See-also: remote-name --- This option changes the default action for all given URLs to be dealt with as if --remote-name were used for each one. So if you want to disable that for a diff --git a/docs/cmdline-opts/remote-name.d b/docs/cmdline-opts/remote-name.d index f7e03f42f..c149c185c 100644 --- a/docs/cmdline-opts/remote-name.d +++ b/docs/cmdline-opts/remote-name.d @@ -4,6 +4,7 @@ Help: Write output to a file named as the remote file Category: important output Example: -O https://example.com/filename Added: 4.0 +See-also: remote-name-all --- Write output to a local file named like the remote file we get. (Only the file part of the remote file is used, the path is cut off.) diff --git a/docs/cmdline-opts/remote-time.d b/docs/cmdline-opts/remote-time.d index c8bd168ac..572873723 100644 --- a/docs/cmdline-opts/remote-time.d +++ b/docs/cmdline-opts/remote-time.d @@ -4,6 +4,7 @@ Help: Set the remote file's time on the local output Category: output Example: --remote-time -o foo $URL Added: 7.9 +See-also: remote-name time-cond --- When used, this will make curl attempt to figure out the timestamp of the remote file, and if that is available make the local file get that same diff --git a/docs/cmdline-opts/request-target.d b/docs/cmdline-opts/request-target.d index 6e21a6bde..d901fd887 100644 --- a/docs/cmdline-opts/request-target.d +++ b/docs/cmdline-opts/request-target.d @@ -5,6 +5,7 @@ Protocols: HTTP Added: 7.55.0 Category: http Example: --request-target "*" -X OPTIONS $URL +See-also: request --- Tells curl to use an alternative "target" (path) instead of using the path as provided in the URL. Particularly useful when wanting to issue HTTP requests diff --git a/docs/cmdline-opts/request.d b/docs/cmdline-opts/request.d index b73e7823c..f7c0bbef8 100644 --- a/docs/cmdline-opts/request.d +++ b/docs/cmdline-opts/request.d @@ -6,6 +6,7 @@ Category: connection Example: -X "DELETE" $URL Example: -X NLST ftp://example.com/ Added: 6.0 +See-also: request-target --- (HTTP) Specifies a custom request method to use when communicating with the HTTP server. The specified request method will be used instead of the method diff --git a/docs/cmdline-opts/resolve.d b/docs/cmdline-opts/resolve.d index 6464c42fb..cbe288738 100644 --- a/docs/cmdline-opts/resolve.d +++ b/docs/cmdline-opts/resolve.d @@ -4,6 +4,7 @@ Help: Resolve the host+port to this address Added: 7.21.3 Category: connection Example: --resolve example.com:443:127.0.0.1 $URL +See-also: connect-to alt-svc --- Provide a custom address for a specific host and port pair. Using this, you can make the curl requests(s) use a specified address and prevent the diff --git a/docs/cmdline-opts/retry-all-errors.d b/docs/cmdline-opts/retry-all-errors.d index 2a9c552fc..61946c507 100644 --- a/docs/cmdline-opts/retry-all-errors.d +++ b/docs/cmdline-opts/retry-all-errors.d @@ -3,6 +3,7 @@ Help: Retry all errors (use with --retry) Added: 7.71.0 Category: curl Example: --retry-all-errors $URL +See-also: retry --- Retry on any error. This option is used together with --retry. diff --git a/docs/cmdline-opts/retry-connrefused.d b/docs/cmdline-opts/retry-connrefused.d index ad079e096..13574e80c 100644 --- a/docs/cmdline-opts/retry-connrefused.d +++ b/docs/cmdline-opts/retry-connrefused.d @@ -3,6 +3,7 @@ Help: Retry on connection refused (use with --retry) Added: 7.52.0 Category: curl Example: --retry-connrefused --retry $URL +See-also: retry retry-all-errors --- In addition to the other conditions, consider ECONNREFUSED as a transient error too for --retry. This option is used together with --retry. diff --git a/docs/cmdline-opts/retry-delay.d b/docs/cmdline-opts/retry-delay.d index 283912904..c4970bc8c 100644 --- a/docs/cmdline-opts/retry-delay.d +++ b/docs/cmdline-opts/retry-delay.d @@ -4,6 +4,7 @@ Help: Wait time between retries Added: 7.12.3 Category: curl Example: --retry-delay 5 --retry $URL +See-also: retry --- Make curl sleep this amount of time before each retry when a transfer has failed with a transient error (it changes the default backoff time algorithm diff --git a/docs/cmdline-opts/retry-max-time.d b/docs/cmdline-opts/retry-max-time.d index f859f3ab6..260ad4bad 100644 --- a/docs/cmdline-opts/retry-max-time.d +++ b/docs/cmdline-opts/retry-max-time.d @@ -4,6 +4,7 @@ Help: Retry only within this period Added: 7.12.3 Category: curl Example: --retry-max-time 30 --retry 10 $URL +See-also: retry --- The retry timer is reset before the first transfer attempt. Retries will be done as usual (see --retry) as long as the timer has not reached this given diff --git a/docs/cmdline-opts/retry.d b/docs/cmdline-opts/retry.d index 6238383fe..c4385f73d 100644 --- a/docs/cmdline-opts/retry.d +++ b/docs/cmdline-opts/retry.d @@ -4,6 +4,7 @@ Added: 7.12.3 Help: Retry request if transient problems occur Category: curl Example: --retry 7 $URL +See-also: retry-max-time --- If a transient error is returned when curl tries to perform a transfer, it will retry this number of times before giving up. Setting the number to 0 diff --git a/docs/cmdline-opts/sasl-authzid.d b/docs/cmdline-opts/sasl-authzid.d index 867aac094..d80e30f52 100644 --- a/docs/cmdline-opts/sasl-authzid.d +++ b/docs/cmdline-opts/sasl-authzid.d @@ -4,6 +4,7 @@ Help: Identity for SASL PLAIN authentication Added: 7.66.0 Category: auth Example: --sasl-authzid zid imap://example.com/ +See-also: login-options --- Use this authorisation identity (authzid), during SASL PLAIN authentication, in addition to the authentication identity (authcid) as specified by --user. diff --git a/docs/cmdline-opts/sasl-ir.d b/docs/cmdline-opts/sasl-ir.d index 5004306a4..f1289fd76 100644 --- a/docs/cmdline-opts/sasl-ir.d +++ b/docs/cmdline-opts/sasl-ir.d @@ -3,5 +3,6 @@ Help: Enable initial response in SASL authentication Added: 7.31.0 Category: auth Example: --sasl-ir imap://example.com/ +See-also: sasl-authzid --- Enable initial response in SASL authentication. diff --git a/docs/cmdline-opts/service-name.d b/docs/cmdline-opts/service-name.d index 3a5559bc8..fd9cb436b 100644 --- a/docs/cmdline-opts/service-name.d +++ b/docs/cmdline-opts/service-name.d @@ -4,6 +4,7 @@ Arg: <name> Added: 7.43.0 Category: misc Example: --service-name sockd/server $URL +See-also: negotiate proxy-service-name --- This option allows you to change the service name for SPNEGO. diff --git a/docs/cmdline-opts/socks4.d b/docs/cmdline-opts/socks4.d index 6494f33d3..a1fb1b344 100644 --- a/docs/cmdline-opts/socks4.d +++ b/docs/cmdline-opts/socks4.d @@ -4,6 +4,7 @@ Help: SOCKS4 proxy on given host + port Added: 7.15.2 Category: proxy Example: --socks4 hostname:4096 $URL +See-also: socks4a socks5 socks5-hostname --- Use the specified SOCKS4 proxy. If the port number is not specified, it is assumed at port 1080. Using this socket type make curl resolve the host name diff --git a/docs/cmdline-opts/socks4a.d b/docs/cmdline-opts/socks4a.d index 28359e05f..e39b968aa 100644 --- a/docs/cmdline-opts/socks4a.d +++ b/docs/cmdline-opts/socks4a.d @@ -4,6 +4,7 @@ Help: SOCKS4a proxy on given host + port Added: 7.18.0 Category: proxy Example: --socks4a hostname:4096 $URL +See-also: socks4 socks5 socks5-hostname --- Use the specified SOCKS4a proxy. If the port number is not specified, it is assumed at port 1080. This asks the proxy to resolve the host name. diff --git a/docs/cmdline-opts/socks5-basic.d b/docs/cmdline-opts/socks5-basic.d index f32e0bf3e..2e62bec5a 100644 --- a/docs/cmdline-opts/socks5-basic.d +++ b/docs/cmdline-opts/socks5-basic.d @@ -3,6 +3,7 @@ Help: Enable username/password auth for SOCKS5 proxies Added: 7.55.0 Category: proxy auth Example: --socks5-basic --socks5 hostname:4096 $URL +See-also: socks5 --- Tells curl to use username/password authentication when connecting to a SOCKS5 proxy. The username/password authentication is enabled by default. Use diff --git a/docs/cmdline-opts/socks5-gssapi-nec.d b/docs/cmdline-opts/socks5-gssapi-nec.d index 73cac7a22..c173c6bfc 100644 --- a/docs/cmdline-opts/socks5-gssapi-nec.d +++ b/docs/cmdline-opts/socks5-gssapi-nec.d @@ -3,6 +3,7 @@ Help: Compatibility with NEC SOCKS5 server Added: 7.19.4 Category: proxy auth Example: --socks5-gssapi-nec --socks5 hostname:4096 $URL +See-also: socks5 --- As part of the GSS-API negotiation a protection mode is negotiated. RFC 1961 says in section 4.3/4.4 it should be protected, but the NEC reference diff --git a/docs/cmdline-opts/socks5-gssapi-service.d b/docs/cmdline-opts/socks5-gssapi-service.d index 451be8e2d..5ce82ac3a 100644 --- a/docs/cmdline-opts/socks5-gssapi-service.d +++ b/docs/cmdline-opts/socks5-gssapi-service.d @@ -4,6 +4,7 @@ Help: SOCKS5 proxy service name for GSS-API Added: 7.19.4 Category: proxy auth Example: --socks5-gssapi-service sockd --socks5 hostname:4096 $URL +See-also: socks5 --- The default service name for a socks server is rcmd/server-fqdn. This option allows you to change it. diff --git a/docs/cmdline-opts/socks5-gssapi.d b/docs/cmdline-opts/socks5-gssapi.d index 2ce806955..662094020 100644 --- a/docs/cmdline-opts/socks5-gssapi.d +++ b/docs/cmdline-opts/socks5-gssapi.d @@ -3,6 +3,7 @@ Help: Enable GSS-API auth for SOCKS5 proxies Added: 7.55.0 Category: proxy auth Example: --socks5-gssapi --socks5 hostname:4096 $URL +See-also: socks5 --- Tells curl to use GSS-API authentication when connecting to a SOCKS5 proxy. The GSS-API authentication is enabled by default (if curl is compiled with diff --git a/docs/cmdline-opts/socks5-hostname.d b/docs/cmdline-opts/socks5-hostname.d index 599e80ef3..6530429a9 100644 --- a/docs/cmdline-opts/socks5-hostname.d +++ b/docs/cmdline-opts/socks5-hostname.d @@ -4,6 +4,7 @@ Help: SOCKS5 proxy, pass host name to proxy Added: 7.18.0 Category: proxy Example: --socks5-hostname proxy.example:7000 $URL +See-also: socks5 socks4a --- Use the specified SOCKS5 proxy (and let the proxy resolve the host name). If the port number is not specified, it is assumed at port 1080. diff --git a/docs/cmdline-opts/socks5.d b/docs/cmdline-opts/socks5.d index 85c349d6b..af1c05771 100644 --- a/docs/cmdline-opts/socks5.d +++ b/docs/cmdline-opts/socks5.d @@ -4,6 +4,7 @@ Help: SOCKS5 proxy on given host + port Added: 7.18.0 Category: proxy Example: --socks5 proxy.example:7000 $URL +See-also: socks5-hostname socks4a --- Use the specified SOCKS5 proxy - but resolve the host name locally. If the port number is not specified, it is assumed at port 1080. diff --git a/docs/cmdline-opts/speed-limit.d b/docs/cmdline-opts/speed-limit.d index 8351d932e..c07b1d760 100644 --- a/docs/cmdline-opts/speed-limit.d +++ b/docs/cmdline-opts/speed-limit.d @@ -5,6 +5,7 @@ Help: Stop transfers slower than this Category: connection Example: --speed-limit 300 --speed-time 10 $URL Added: 4.7 +See-also: speed-time limit-rate max-time --- If a download is slower than this given speed (in bytes per second) for speed-time seconds it gets aborted. speed-time is set with --speed-time and is diff --git a/docs/cmdline-opts/speed-time.d b/docs/cmdline-opts/speed-time.d index f32711fed..89cba59b6 100644 --- a/docs/cmdline-opts/speed-time.d +++ b/docs/cmdline-opts/speed-time.d @@ -5,6 +5,7 @@ Help: Trigger 'speed-limit' abort after this time Category: connection Example: --speed-limit 300 --speed-time 10 $URL Added: 4.7 +See-also: speed-limit limit-rate --- If a download is slower than speed-limit bytes per second during a speed-time period, the download gets aborted. If speed-time is used, the default diff --git a/docs/cmdline-opts/ssl-allow-beast.d b/docs/cmdline-opts/ssl-allow-beast.d index 869ff49ba..5a7fe995f 100644 --- a/docs/cmdline-opts/ssl-allow-beast.d +++ b/docs/cmdline-opts/ssl-allow-beast.d @@ -3,6 +3,7 @@ Help: Allow security flaw to improve interop Added: 7.25.0 Category: tls Example: --ssl-allow-beast $URL +See-also: proxy-ssl-allow-beast insecure --- This option tells curl to not work around a security flaw in the SSL3 and TLS1.0 protocols known as BEAST. If this option is not used, the SSL layer diff --git a/docs/cmdline-opts/ssl-no-revoke.d b/docs/cmdline-opts/ssl-no-revoke.d index dde77aa11..ba4b661f1 100644 --- a/docs/cmdline-opts/ssl-no-revoke.d +++ b/docs/cmdline-opts/ssl-no-revoke.d @@ -3,6 +3,7 @@ Help: Disable cert revocation checks (Schannel) Added: 7.44.0 Category: tls Example: --ssl-no-revoke $URL +See-also: crlfile --- (Schannel) This option tells curl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask diff --git a/docs/cmdline-opts/ssl-reqd.d b/docs/cmdline-opts/ssl-reqd.d index df50eb147..81e0ea794 100644 --- a/docs/cmdline-opts/ssl-reqd.d +++ b/docs/cmdline-opts/ssl-reqd.d @@ -4,6 +4,7 @@ Protocols: FTP IMAP POP3 SMTP Added: 7.20.0 Category: tls Example: --ssl-reqd ftp://example.com +See-also: ssl insecure --- Require SSL/TLS for the connection. Terminates the connection if the server does not support SSL/TLS. diff --git a/docs/cmdline-opts/ssl-revoke-best-effort.d b/docs/cmdline-opts/ssl-revoke-best-effort.d index 2db32192e..aad3ab0b4 100644 --- a/docs/cmdline-opts/ssl-revoke-best-effort.d +++ b/docs/cmdline-opts/ssl-revoke-best-effort.d @@ -3,6 +3,7 @@ Help: Ignore missing/offline cert CRL dist points Added: 7.70.0 Category: tls Example: --ssl-revoke-best-effort $URL +See-also: crlfile insecure --- (Schannel) This option tells curl to ignore certificate revocation checks when they failed due to missing/offline distribution points for the revocation check diff --git a/docs/cmdline-opts/ssl.d b/docs/cmdline-opts/ssl.d index 2a0ea2793..6a12dc796 100644 --- a/docs/cmdline-opts/ssl.d +++ b/docs/cmdline-opts/ssl.d @@ -4,6 +4,7 @@ Protocols: FTP IMAP POP3 SMTP Added: 7.20.0 Category: tls Example: --ssl pop3://example.com/ +See-also: insecure ciphers --- Try to use SSL/TLS for the connection. Reverts to a non-secure connection if the server does not support SSL/TLS. See also --ftp-ssl-control and --ssl-reqd diff --git a/docs/cmdline-opts/styled-output.d b/docs/cmdline-opts/styled-output.d index bf636019a..364a18244 100644 --- a/docs/cmdline-opts/styled-output.d +++ b/docs/cmdline-opts/styled-output.d @@ -3,6 +3,7 @@ Help: Enable styled output for HTTP headers Added: 7.61.0 Category: verbose Example: --styled-output -I $URL +See-also: head verbose --- Enables the automatic use of bold font styles when writing HTTP headers to the terminal. Use --no-styled-output to switch them off. diff --git a/docs/cmdline-opts/tcp-fastopen.d b/docs/cmdline-opts/tcp-fastopen.d index e7e9d2e9a..7b96b2d81 100644 --- a/docs/cmdline-opts/tcp-fastopen.d +++ b/docs/cmdline-opts/tcp-fastopen.d @@ -3,5 +3,6 @@ Added: 7.49.0 Help: Use TCP Fast Open Category: connection Example: --tcp-fastopen $URL +See-also: false-start --- Enable use of TCP Fast Open (RFC7413). diff --git a/docs/cmdline-opts/tcp-nodelay.d b/docs/cmdline-opts/tcp-nodelay.d index 42161e7ca..a819b27fb 100644 --- a/docs/cmdline-opts/tcp-nodelay.d +++ b/docs/cmdline-opts/tcp-nodelay.d @@ -3,6 +3,7 @@ Help: Use the TCP_NODELAY option Added: 7.11.2 Category: connection Example: --tcp-nodelay $URL +See-also: no-buffer --- Turn on the TCP_NODELAY option. See the *curl_easy_setopt(3)* man page for details about this option. diff --git a/docs/cmdline-opts/telnet-option.d b/docs/cmdline-opts/telnet-option.d index 1751cbff4..50f0d4800 100644 --- a/docs/cmdline-opts/telnet-option.d +++ b/docs/cmdline-opts/telnet-option.d @@ -5,6 +5,7 @@ Help: Set telnet option Category: telnet Example: -t TTYPE=vt100 telnet://example.com/ Added: 7.7 +See-also: config --- Pass options to the telnet protocol. Supported options are: diff --git a/docs/cmdline-opts/tftp-blksize.d b/docs/cmdline-opts/tftp-blksize.d index 3b19e5cf7..c180569a4 100644 --- a/docs/cmdline-opts/tftp-blksize.d +++ b/docs/cmdline-opts/tftp-blksize.d @@ -5,6 +5,7 @@ Protocols: TFTP Added: 7.20.0 Category: tftp Example: --tftp-blksize 1024 tftp://example.com/file +See-also: tftp-no-options --- Set TFTP BLKSIZE option (must be >512). This is the block size that curl will try to use when transferring data to or from a TFTP server. By default 512 diff --git a/docs/cmdline-opts/tftp-no-options.d b/docs/cmdline-opts/tftp-no-options.d index 9ff334b86..a90655a02 100644 --- a/docs/cmdline-opts/tftp-no-options.d +++ b/docs/cmdline-opts/tftp-no-options.d @@ -4,6 +4,7 @@ Protocols: TFTP Added: 7.48.0 Category: tftp Example: --tftp-no-options tftp://192.168.0.1/ +See-also: tftp-blksize --- Tells curl not to send TFTP options requests. diff --git a/docs/cmdline-opts/time-cond.d b/docs/cmdline-opts/time-cond.d index b84897ff6..602d66849 100644 --- a/docs/cmdline-opts/time-cond.d +++ b/docs/cmdline-opts/time-cond.d @@ -8,6 +8,7 @@ Example: -z "Wed 01 Sep 2021 12:18:00" $URL Example: -z "-Wed 01 Sep 2021 12:18:00" $URL Example: -z file $URL Added: 5.8 +See-also: etag-compare remote-time --- Request a file that has been modified later than the given time and date, or one that has been modified before that time. The <date expression> can be all diff --git a/docs/cmdline-opts/tls13-ciphers.d b/docs/cmdline-opts/tls13-ciphers.d index 6ed00667f..ff3e5efdb 100644 --- a/docs/cmdline-opts/tls13-ciphers.d +++ b/docs/cmdline-opts/tls13-ciphers.d @@ -5,6 +5,7 @@ Protocols: TLS Category: tls Example: --tls13-ciphers TLS_AES_128_GCM_SHA256 $URL Added: 7.61.0 +See-also: ciphers curves --- Specifies which cipher suites to use in the connection if it negotiates TLS 1.3. The list of ciphers suites must specify valid ciphers. Read up on TLS 1.3 diff --git a/docs/cmdline-opts/tlsauthtype.d b/docs/cmdline-opts/tlsauthtype.d index 57b6ab8ad..82108afe9 100644 --- a/docs/cmdline-opts/tlsauthtype.d +++ b/docs/cmdline-opts/tlsauthtype.d @@ -4,6 +4,7 @@ Help: TLS authentication type Added: 7.21.4 Category: tls auth Example: --tlsauthtype SRP $URL +See-also: tlsuser --- Set TLS authentication type. Currently, the only supported option is "SRP", for TLS-SRP (RFC 5054). If --tlsuser and --tlspassword are specified but diff --git a/docs/cmdline-opts/tlspassword.d b/docs/cmdline-opts/tlspassword.d index 8bfc1d557..a52e0e34e 100644 --- a/docs/cmdline-opts/tlspassword.d +++ b/docs/cmdline-opts/tlspassword.d @@ -4,6 +4,7 @@ Help: TLS password Added: 7.21.4 Category: tls auth Example: --tlspassword pwd --tlsuser user $URL +See-also: tlsuser --- Set password for use with the TLS authentication method specified with --tlsauthtype. Requires that --tlsuser also be set. diff --git a/docs/cmdline-opts/tlsuser.d b/docs/cmdline-opts/tlsuser.d index 266d709ce..df5dd301f 100644 --- a/docs/cmdline-opts/tlsuser.d +++ b/docs/cmdline-opts/tlsuser.d @@ -4,6 +4,7 @@ Help: TLS user name Added: 7.21.4 Category: tls auth Example: --tlspassword pwd --tlsuser user $URL +See-also: tlspassword --- Set username for use with the TLS authentication method specified with --tlsauthtype. Requires that --tlspassword also is set. diff --git a/docs/cmdline-opts/tlsv1.0.d b/docs/cmdline-opts/tlsv1.0.d index 5fc18dcbe..ea6dd05a8 100644 --- a/docs/cmdline-opts/tlsv1.0.d +++ b/docs/cmdline-opts/tlsv1.0.d @@ -4,6 +4,7 @@ Protocols: TLS Added: 7.34.0 Category: tls Example: --tlsv1.0 $URL +See-also: tlsv1.3 --- Forces curl to use TLS version 1.0 or later when connecting to a remote TLS server. diff --git a/docs/cmdline-opts/tlsv1.1.d b/docs/cmdline-opts/tlsv1.1.d index 6d169bf30..29803b3ed 100644 --- a/docs/cmdline-opts/tlsv1.1.d +++ b/docs/cmdline-opts/tlsv1.1.d @@ -4,6 +4,7 @@ Protocols: TLS Added: 7.34.0 Category: tls Example: --tlsv1.1 $URL +See-also: tlsv1.3 --- Forces curl to use TLS version 1.1 or later when connecting to a remote TLS server. diff --git a/docs/cmdline-opts/tlsv1.2.d b/docs/cmdline-opts/tlsv1.2.d index 5df843f7c..1f6551ab7 100644 --- a/docs/cmdline-opts/tlsv1.2.d +++ b/docs/cmdline-opts/tlsv1.2.d @@ -4,6 +4,7 @@ Protocols: TLS Added: 7.34.0 Category: tls Example: --tlsv1.2 $URL +See-also: tlsv1.3 --- Forces curl to use TLS version 1.2 or later when connecting to a remote TLS server. diff --git a/docs/cmdline-opts/tlsv1.3.d b/docs/cmdline-opts/tlsv1.3.d index cc9a53bcd..858bf295c 100644 --- a/docs/cmdline-opts/tlsv1.3.d +++ b/docs/cmdline-opts/tlsv1.3.d @@ -4,6 +4,7 @@ Protocols: TLS Added: 7.52.0 Category: tls Example: --tlsv1.3 $URL +See-also: tlsv1.2 --- Forces curl to use TLS version 1.3 or later when connecting to a remote TLS server. diff --git a/docs/cmdline-opts/tr-encoding.d b/docs/cmdline-opts/tr-encoding.d index 7fdf9e098..4c25125a3 100644 --- a/docs/cmdline-opts/tr-encoding.d +++ b/docs/cmdline-opts/tr-encoding.d @@ -4,6 +4,7 @@ Help: Request compressed transfer encoding Protocols: HTTP Category: http Example: --tr-encoding $URL +See-also: compressed --- Request a compressed Transfer-Encoding response using one of the algorithms curl supports, and uncompress the data while receiving it. diff --git a/docs/cmdline-opts/trace-ascii.d b/docs/cmdline-opts/trace-ascii.d index 914392a15..9ac86e17a 100644 --- a/docs/cmdline-opts/trace-ascii.d +++ b/docs/cmdline-opts/trace-ascii.d @@ -5,6 +5,7 @@ Mutexed: trace verbose Category: verbose Example: --trace-ascii log.txt $URL Added: 7.9.7 +See-also: verbose trace --- Enables a full trace dump of all incoming and outgoing data, including descriptive information, to the given output file. Use "-" as filename to have diff --git a/docs/cmdline-opts/trace-time.d b/docs/cmdline-opts/trace-time.d index 083270dc6..ea276c388 100644 --- a/docs/cmdline-opts/trace-time.d +++ b/docs/cmdline-opts/trace-time.d @@ -3,6 +3,7 @@ Help: Add time stamps to trace/verbose output Added: 7.14.0 Category: verbose Example: --trace-time --trace-ascii output $URL +See-also: trace verbose --- Prepends a time stamp to each trace or verbose line that curl displays. diff --git a/docs/cmdline-opts/trace.d b/docs/cmdline-opts/trace.d index a00a54370..805afdd26 100644 --- a/docs/cmdline-opts/trace.d +++ b/docs/cmdline-opts/trace.d @@ -5,6 +5,7 @@ Mutexed: verbose trace-ascii Category: verbose Example: --trace log.txt $URL Added: 7.9.7 +See-also: trace-ascii trace-time --- Enables a full trace dump of all incoming and outgoing data, including descriptive information, to the given output file. Use "-" as filename to have diff --git a/docs/cmdline-opts/unix-socket.d b/docs/cmdline-opts/unix-socket.d index c526ca6bc..fd001e32c 100644 --- a/docs/cmdline-opts/unix-socket.d +++ b/docs/cmdline-opts/unix-socket.d @@ -4,6 +4,7 @@ Help: Connect through this Unix domain socket Added: 7.40.0 Protocols: HTTP Category: connection +See-also: abstract-unix-socket Example: --unix-socket socket-path $URL --- Connect through this Unix domain socket, instead of using the network. diff --git a/docs/cmdline-opts/upload-file.d b/docs/cmdline-opts/upload-file.d index fbf969e83..62fe6502c 100644 --- a/docs/cmdline-opts/upload-file.d +++ b/docs/cmdline-opts/upload-file.d @@ -7,6 +7,7 @@ Example: -T file $URL Example: -T "img[1-1000].png" ftp://ftp.example.com/ Example: --upload-file "{file1,file2}" $URL Added: 4.0 +See-also: get head --- This transfers the specified local file to the remote URL. If there is no file part in the specified URL, curl will append the local file name. NOTE that you diff --git a/docs/cmdline-opts/url.d b/docs/cmdline-opts/url.d index f0ce9f434..f91ee009b 100644 --- a/docs/cmdline-opts/url.d +++ b/docs/cmdline-opts/url.d @@ -4,6 +4,7 @@ Help: URL to work with Category: curl Example: --url $URL Added: 7.5 +See-also: next config --- Specify a URL to fetch. This option is mostly handy when you want to specify URL(s) in a config file. diff --git a/docs/cmdline-opts/use-ascii.d b/docs/cmdline-opts/use-ascii.d index dae934e19..d9d522421 100644 --- a/docs/cmdline-opts/use-ascii.d +++ b/docs/cmdline-opts/use-ascii.d @@ -5,6 +5,7 @@ Protocols: FTP LDAP Category: misc Example: -B ftp://example.com/README Added: 5.0 +See-also: crlf data-ascii --- Enable ASCII transfer. For FTP, this can also be enforced by using a URL that ends with ";type=A". This option causes data sent to stdout to be in text mode diff --git a/docs/cmdline-opts/user-agent.d b/docs/cmdline-opts/user-agent.d index 1b89af6d3..2412b9b2a 100644 --- a/docs/cmdline-opts/user-agent.d +++ b/docs/cmdline-opts/user-agent.d @@ -6,6 +6,7 @@ Protocols: HTTP Category: important http Example: -A "Agent 007" $URL Added: 4.5.1 +See-also: header proxy-header --- Specify the User-Agent string to send to the HTTP server. To encode blanks in the string, surround the string with single quote marks. This header can also diff --git a/docs/cmdline-opts/user.d b/docs/cmdline-opts/user.d index b84c620b8..144704edd 100644 --- a/docs/cmdline-opts/user.d +++ b/docs/cmdline-opts/user.d @@ -5,6 +5,7 @@ Help: Server user and password Category: important auth Example: -u user:secret $URL Added: 4.0 +See-also: netrc config --- Specify the user name and password to use for server authentication. Overrides --netrc and --netrc-optional. diff --git a/docs/cmdline-opts/version.d b/docs/cmdline-opts/version.d index 723386dca..7d3807774 100644 --- a/docs/cmdline-opts/version.d +++ b/docs/cmdline-opts/version.d @@ -4,6 +4,7 @@ Help: Show version number and quit Category: important curl Example: --version Added: 4.0 +See-also: help manual --- Displays information about curl and the libcurl version it uses. diff --git a/docs/cmdline-opts/write-out.d b/docs/cmdline-opts/write-out.d index e33babc24..9a57c3dbc 100644 --- a/docs/cmdline-opts/write-out.d +++ b/docs/cmdline-opts/write-out.d @@ -5,6 +5,7 @@ Help: Use output FORMAT after completion Category: verbose Example: -w '%{http_code}\\n' $URL Added: 6.5 +See-also: verbose head --- Make curl display information on stdout after a completed transfer. The format is a string that may contain plain text mixed with any number of diff --git a/docs/cmdline-opts/xattr.d b/docs/cmdline-opts/xattr.d index b5c17fdbc..51ca83480 100644 --- a/docs/cmdline-opts/xattr.d +++ b/docs/cmdline-opts/xattr.d @@ -3,6 +3,7 @@ Help: Store metadata in extended file attributes Category: misc Example: --xattr -o storage $URL Added: 7.21.3 +See-also: remote-time write-out verbose --- When saving output to a file, this option tells curl to store certain file metadata in extended file attributes. Currently, the URL is stored in the |