aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl')
-rw-r--r--docs/libcurl/opts/CURLOPT_PRE_PROXY.3 (renamed from docs/libcurl/opts/CURLOPT_SOCKS_PROXY.3)22
-rw-r--r--docs/libcurl/opts/Makefile.am6
2 files changed, 16 insertions, 12 deletions
diff --git a/docs/libcurl/opts/CURLOPT_SOCKS_PROXY.3 b/docs/libcurl/opts/CURLOPT_PRE_PROXY.3
index d3e6905bf..035dd3ac6 100644
--- a/docs/libcurl/opts/CURLOPT_SOCKS_PROXY.3
+++ b/docs/libcurl/opts/CURLOPT_PRE_PROXY.3
@@ -20,15 +20,15 @@
.\" *
.\" **************************************************************************
.\"
-.TH CURLOPT_SOCKS_PROXY 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
+.TH CURLOPT_PRE_PROXY 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
.SH NAME
-CURLOPT_SOCKS_PROXY \- set SOCKS proxy to use
+CURLOPT_PRE_PROXY \- set pre-proxy to use
.SH SYNOPSIS
#include <curl/curl.h>
-CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS_PROXY, char *proxy);
+CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRE_PROXY, char *preproxy);
.SH DESCRIPTION
-Set the SOCKS \fIproxy\fP to use for the upcoming request. The parameter
+Set the \fIpreproxy\fP to use for the upcoming request. The parameter
should be a char * to a zero terminated string holding the host name or dotted
numerical IP address. A numerical IPv6 address must be written within
[brackets].
@@ -38,16 +38,20 @@ name. The proxy's port number may optionally be specified with the separate
option \fICURLOPT_PROXYPORT(3)\fP. If not specified, libcurl will default to
using port 1080 for proxies.
-The proxy string may be prefixed with [scheme]:// to specify which kind of
-proxy is used. Use socks4://, socks4a://, socks5:// or socks5h:// (the last
+A pre proxy is a SOCKS proxy that curl connects to before it connects to the
+HTTP(S) proxy specified in the \fICURLOPT_PROXY\fP option. The pre proxy can
+only be a SOCKS proxy.
+
+The pre proxy string should be prefixed with [scheme]:// to specify which kind
+of socks is used. Use socks4://, socks4a://, socks5:// or socks5h:// (the last
one to enable socks5 and asking the proxy to do the resolving, also known as
\fICURLPROXY_SOCKS5_HOSTNAME\fP type) to request the specific SOCKS version to
be used. Otherwise SOCKS4 is used as default.
-Setting the proxy string to "" (an empty string) will explicitly disable the
-use of a proxy, even if there is an environment variable set for it.
+Setting the pre proxy string to "" (an empty string) will explicitly disable
+the use of a pre proxy.
.SH DEFAULT
-Default is NULL, meaning no socks proxy is used.
+Default is NULL, meaning no pre proxy is used.
When you set a host name to use, do not assume that there's any particular
single port number used widely for proxies. Specify it!
diff --git a/docs/libcurl/opts/Makefile.am b/docs/libcurl/opts/Makefile.am
index 9a9cba1d8..eb7ca1bb5 100644
--- a/docs/libcurl/opts/Makefile.am
+++ b/docs/libcurl/opts/Makefile.am
@@ -212,6 +212,7 @@ man_MANS = \
CURLOPT_POSTQUOTE.3 \
CURLOPT_POSTREDIR.3 \
CURLOPT_PREQUOTE.3 \
+ CURLOPT_PRE_PROXY.3 \
CURLOPT_PRIVATE.3 \
CURLOPT_PROGRESSDATA.3 \
CURLOPT_PROGRESSFUNCTION.3 \
@@ -269,7 +270,6 @@ man_MANS = \
CURLOPT_SOCKOPTFUNCTION.3 \
CURLOPT_SOCKS5_GSSAPI_NEC.3 \
CURLOPT_SOCKS5_GSSAPI_SERVICE.3 \
- CURLOPT_SOCKS_PROXY.3 \
CURLOPT_SSH_AUTH_TYPES.3 \
CURLOPT_SSH_HOST_PUBLIC_KEY_MD5.3 \
CURLOPT_SSH_KEYDATA.3 \
@@ -522,6 +522,7 @@ HTMLPAGES = \
CURLOPT_POSTQUOTE.html \
CURLOPT_POSTREDIR.html \
CURLOPT_PREQUOTE.html \
+ CURLOPT_PRE_PROXY.html \
CURLOPT_PRIVATE.html \
CURLOPT_PROGRESSDATA.html \
CURLOPT_PROGRESSFUNCTION.html \
@@ -579,7 +580,6 @@ HTMLPAGES = \
CURLOPT_SOCKOPTFUNCTION.html \
CURLOPT_SOCKS5_GSSAPI_NEC.html \
CURLOPT_SOCKS5_GSSAPI_SERVICE.html \
- CURLOPT_SOCKS_PROXY.html \
CURLOPT_SSH_AUTH_TYPES.html \
CURLOPT_SSH_HOST_PUBLIC_KEY_MD5.html \
CURLOPT_SSH_KEYDATA.html \
@@ -832,6 +832,7 @@ PDFPAGES = \
CURLOPT_POSTQUOTE.pdf \
CURLOPT_POSTREDIR.pdf \
CURLOPT_PREQUOTE.pdf \
+ CURLOPT_PRE_PROXY.pdf \
CURLOPT_PRIVATE.pdf \
CURLOPT_PROGRESSDATA.pdf \
CURLOPT_PROGRESSFUNCTION.pdf \
@@ -889,7 +890,6 @@ PDFPAGES = \
CURLOPT_SOCKOPTFUNCTION.pdf \
CURLOPT_SOCKS5_GSSAPI_NEC.pdf \
CURLOPT_SOCKS5_GSSAPI_SERVICE.pdf \
- CURLOPT_SOCKS_PROXY.pdf \
CURLOPT_SSH_AUTH_TYPES.pdf \
CURLOPT_SSH_HOST_PUBLIC_KEY_MD5.pdf \
CURLOPT_SSH_KEYDATA.pdf \