docs/libcurl/opts/CURLOPT_PROXYPORT.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_PROXYPORT \- port number the proxy listens on
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPORT, long port);
  31 .SH DESCRIPTION
  32 Pass a long with this option to set the proxy port to connect to unless it is
  33 specified in the proxy string \fICURLOPT_PROXY(3)\fP or uses 443 for https
  34 proxies and 1080 for all others as default.
  35
  36 While this accepts a 'long', the port number is 16 bit so it can't be larger
  37 than 65535.
  38 .SH DEFAULT
  39 0, not specified which makes it use the default port
  40 .SH PROTOCOLS
  41 All
  42 .SH EXAMPLE
  43 .nf
  44 CURL *curl = curl_easy_init();
  45 if(curl) {
  46   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
  47   curl_easy_setopt(curl, CURLOPT_PROXY, "localhost");
  48   curl_easy_setopt(curl, CURLOPT_PROXYPORT, 8080L);
  49   ret = curl_easy_perform(curl);
  50   curl_easy_cleanup(curl);
  51 }
  52 .fi
  53 .SH AVAILABILITY
  54 Always
  55 .SH RETURN VALUE
  56 Returns CURLE_OK
  57 .SH "SEE ALSO"
  58 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "