2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-12-23 07:40:11 -07:00
repo/core/curl/files/CURLOPT_PROXYPORT.3
2024-08-02 20:52:59 -05:00

52 lines
1.4 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLOPT_PROXYPORT.md
.TH CURLOPT_PROXYPORT 3 "2024-08-02" libcurl
.SH NAME
CURLOPT_PROXYPORT \- port number the proxy listens on
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPORT, long port);
.fi
.SH DESCRIPTION
We discourage use of this option.
Pass a long with this option to set the proxy port to connect to unless it is
specified in the proxy string \fICURLOPT_PROXY(3)\fP or uses 443 for https proxies
and 1080 for all others as default.
Disabling this option, setting it to zero, makes it not specified which makes
libcurl use the default proxy port number or the port number specified in the
proxy URL string.
While this accepts a \(aqlong\(aq, the port number is 16 bit so it cannot be larger
than 65535.
.SH DEFAULT
0
.SH PROTOCOLS
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
curl_easy_setopt(curl, CURLOPT_PROXY, "localhost");
curl_easy_setopt(curl, CURLOPT_PROXYPORT, 8080L);
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
}
.fi
.SH AVAILABILITY
Added in curl 7.1
.SH RETURN VALUE
Returns CURLE_OK
.SH SEE ALSO
.BR CURLINFO_PRIMARY_PORT (3),
.BR CURLOPT_PORT (3),
.BR CURLOPT_PROXY (3),
.BR CURLOPT_PROXYTYPE (3)