From c67f84209335f0db8c4ac30d620290f39abf32b0 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Sun, 27 Nov 2016 00:21:15 +0100 Subject: CURLOPT_PROXY_*.3: polished some proxy option man pages --- docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.3 | 16 ++++++++++------ docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3 | 18 ++++++++++-------- docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.3 | 17 ++++++----------- 3 files changed, 26 insertions(+), 25 deletions(-) (limited to 'docs/libcurl/opts') diff --git a/docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.3 b/docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.3 index 1abd329d3..bddecd124 100644 --- a/docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.3 +++ b/docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.3 @@ -28,19 +28,23 @@ CURLOPT_PROXY_KEYPASSWD \- set passphrase to proxy private key CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_KEYPASSWD, char *pwd); .SH DESCRIPTION -TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX) +This option is for connecting to a HTTPS proxy, not a HTTPS server. + Pass a pointer to a zero terminated string as parameter. It will be used as -the password required to use the \fICURLOPT_SSLKEY(3)\fP or -\fICURLOPT_SSH_PRIVATE_KEYFILE(3)\fP private key. You never needed a pass -phrase to load a certificate but you need one to load your private key. +the password required to use the \fICURLOPT_PROXY_SSLKEY(3)\fP private key. +You never needed a pass phrase to load a certificate but you need one to load +your private key. .SH DEFAULT NULL .SH PROTOCOLS -All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. +Used with HTTPS proxy .SH EXAMPLE TODO +.SH AVAILABILITY +Added in 7.52.0 .SH RETURN VALUE Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space. .SH "SEE ALSO" -.BR CURLOPT_SSLKEY "(3), " CURLOPT_SSH_PRIVATE_KEYFILE "(3), " +.BR CURLOPT_PROXY_SSLKEY "(3), " CURLOPT_SSH_PRIVATE_KEYFILE "(3), " +.BR CURLOPT_SSLKEY "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3 index d69f6e632..9d3c029a0 100644 --- a/docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3 +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3 @@ -28,11 +28,12 @@ CURLOPT_PROXY_SSLCERT \- set SSL proxy client certificate CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLCERT, char *cert); .SH DESCRIPTION -TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX) +This option is for connecting to a HTTPS proxy, not a HTTPS server. + Pass a pointer to a zero terminated string as parameter. The string should be -the file name of your client certificate. The default format is "P12" on -Secure Transport and "PEM" on other engines, and can be changed with -\fICURLOPT_SSLCERTTYPE(3)\fP. +the file name of your client certificate used to connect to the HTTPS proxy. +The default format is "P12" on Secure Transport and "PEM" on other engines, +and can be changed with \fICURLOPT_PROXY_SSLCERTTYPE(3)\fP. With NSS or Secure Transport, this can also be the nickname of the certificate you wish to authenticate with as it is named in the security database. If you @@ -40,17 +41,18 @@ want to use a file from the current directory, please precede it with "./" prefix, in order to avoid confusion with a nickname. When using a client certificate, you most likely also need to provide a -private key with \fICURLOPT_SSLKEY(3)\fP. +private key with \fICURLOPT_PROXY_SSLKEY(3)\fP. .SH DEFAULT NULL .SH PROTOCOLS -All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. +Used with HTTPS proxy .SH EXAMPLE TODO .SH AVAILABILITY -If built TLS enabled. +Added in 7.52.0 .SH RETURN VALUE Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space. .SH "SEE ALSO" -.BR CURLOPT_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), " +.BR CURLOPT_PROXY_SSLCERTTYPE "(3), " CURLOPT_PROXY_SSLKEY "(3), " +.BR CURLOPT_SSLCERT "(3), " diff --git a/docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.3 b/docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.3 index 97454f925..c167b6d58 100644 --- a/docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.3 +++ b/docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.3 @@ -28,24 +28,19 @@ CURLOPT_PROXY_SSLKEYTYPE \- set type of the proxy private key file CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEYTYPE, char *type); .SH DESCRIPTION -TODO: Make this text specific to HTTPS proxy. (Added in 7.XXX) +This option is for connecting to a HTTPS proxy, not a HTTPS server. + Pass a pointer to a zero terminated string as parameter. The string should be the format of your private key. Supported formats are "PEM", "DER" and "ENG". - -The format "ENG" enables you to load the private key from a crypto engine. In -this case \fICURLOPT_SSLKEY(3)\fP is used as an identifier passed to the -engine. You have to set the crypto engine with \fICURLOPT_SSLENGINE(3)\fP. -\&"DER" format key file currently does not work because of a bug in OpenSSL. -.SH DEFAULT -"PEM" .SH PROTOCOLS -All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. +Used with HTTPS proxy .SH EXAMPLE TODO .SH AVAILABILITY -If built TLS enabled. +Added in 7.52.0 .SH RETURN VALUE Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space. .SH "SEE ALSO" -.BR CURLOPT_SSLKEY "(3), " CURLOPT_SSLCERT "(3), " +.BR CURLOPT_PROXY_SSLKEY "(3), " CURLOPT_PROXY_SSLCERT "(3), " +.BR CURLOPT_SSLKEYTYPE "(3), " -- cgit v1.2.3