CURLOPT_PROXYPORT.3 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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.61.1" "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. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPORT, long port);
  29. .SH DESCRIPTION
  30. Pass a long with this option to set the proxy port to connect to unless it is
  31. specified in the proxy string \fICURLOPT_PROXY(3)\fP or uses 443 for https
  32. proxies and 1080 for all others as default.
  33. While this accepts a 'long', the port number is 16 bit so it can't be larger
  34. than 65535.
  35. .SH DEFAULT
  36. 0, not specified which makes it use the default port
  37. .SH PROTOCOLS
  38. All
  39. .SH EXAMPLE
  40. .nf
  41. CURL *curl = curl_easy_init();
  42. if(curl) {
  43. curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
  44. curl_easy_setopt(curl, CURLOPT_PROXY, "localhost");
  45. curl_easy_setopt(curl, CURLOPT_PROXYPORT, 8080L);
  46. ret = curl_easy_perform(curl);
  47. curl_easy_cleanup(curl);
  48. }
  49. .fi
  50. .SH AVAILABILITY
  51. Always
  52. .SH RETURN VALUE
  53. Returns CURLE_OK
  54. .SH "SEE ALSO"
  55. .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "