2380e09ec7ee534a28fcab0cf40e1b91da2ee725
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_PROXYPORT.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_PROXYPORT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_PROXYPORT \- port number the proxy listens on
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPORT, long port);
30 .SH DESCRIPTION
31 Pass a long with this option to set the proxy port to connect to unless it is
32 specified in the proxy string \fICURLOPT_PROXY(3)\fP or uses the default one.
33
34 While this accepts a 'long', the port number is 16 bit so it can't be larger
35 than 65535.
36 .SH DEFAULT
37 0, not specified which makes it use the default port
38 .SH PROTOCOLS
39 All
40 .SH EXAMPLE
41 TODO
42 .SH AVAILABILITY
43 Always
44 .SH RETURN VALUE
45 Returns CURLE_OK
46 .SH "SEE ALSO"
47 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "