CURLOPT_PROXYPORT.3 2.1 KB

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