CURLOPT_PROXYPORT.3 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  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 http://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. 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 the default one.
  32. While this accepts a 'long', the port number is 16 bit so it can't be larger
  33. than 65535.
  34. .SH DEFAULT
  35. 0, not specified which makes it use the default port
  36. .SH PROTOCOLS
  37. All
  38. .SH EXAMPLE
  39. TODO
  40. .SH AVAILABILITY
  41. Always
  42. .SH RETURN VALUE
  43. Returns CURLE_OK
  44. .SH "SEE ALSO"
  45. .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "