moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-11-13 13:05:03 -05:00
Code Issues Releases Wiki Activity

CURLOPT_PROXY_*.3: polished some proxy option man pages

Browse Source
This commit is contained in:
Daniel Stenberg 2016-11-27 00:21:15 +01:00
parent d2c5503e0c
commit c67f842093
3 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.3
View File

@ -28,19 +28,23 @@ CURLOPT_PROXY_KEYPASSWD \- set passphrase to proxy private key
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_KEYPASSWD, char *pwd); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_KEYPASSWD, char *pwd);
.SH DESCRIPTION .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 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 the password required to use the \fICURLOPT_PROXY_SSLKEY(3)\fP private key.
\fICURLOPT_SSH_PRIVATE_KEYFILE(3)\fP private key. You never needed a pass You never needed a pass phrase to load a certificate but you need one to load
phrase to load a certificate but you need one to load your private key. your private key.
.SH DEFAULT .SH DEFAULT
NULL NULL
.SH PROTOCOLS .SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. Used with HTTPS proxy
.SH EXAMPLE .SH EXAMPLE
TODO TODO
.SH AVAILABILITY
Added in 7.52.0
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .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), "

18
docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3
View File

@ -28,11 +28,12 @@ CURLOPT_PROXY_SSLCERT \- set SSL proxy client certificate
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLCERT, char *cert); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLCERT, char *cert);
.SH DESCRIPTION .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 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 the file name of your client certificate used to connect to the HTTPS proxy.
Secure Transport and "PEM" on other engines, and can be changed with The default format is "P12" on Secure Transport and "PEM" on other engines,
\fICURLOPT_SSLCERTTYPE(3)\fP. and can be changed with \fICURLOPT_PROXY_SSLCERTTYPE(3)\fP.
With NSS or Secure Transport, this can also be the nickname of the certificate 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 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. prefix, in order to avoid confusion with a nickname.
When using a client certificate, you most likely also need to provide a 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 .SH DEFAULT
NULL NULL
.SH PROTOCOLS .SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. Used with HTTPS proxy
.SH EXAMPLE .SH EXAMPLE
TODO TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. Added in 7.52.0
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), " .BR CURLOPT_PROXY_SSLCERTTYPE "(3), " CURLOPT_PROXY_SSLKEY "(3), "
.BR CURLOPT_SSLCERT "(3), "

17
docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.3
View File

@ -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); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEYTYPE, char *type);
.SH DESCRIPTION .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 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 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 .SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. Used with HTTPS proxy
.SH EXAMPLE .SH EXAMPLE
TODO TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. Added in 7.52.0
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSLKEY "(3), " CURLOPT_SSLCERT "(3), " .BR CURLOPT_PROXY_SSLKEY "(3), " CURLOPT_PROXY_SSLCERT "(3), "
.BR CURLOPT_SSLKEYTYPE "(3), "