CURLOPT_PROXY_SERVICE_NAME.3 2.3 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_PROXY_SERVICE_NAME 3 "17 Jun 2015" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_PROXY_SERVICE_NAME \- proxy authentication service name
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SERVICE_NAME,
  32. char *name);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a char * as parameter to a string holding the \fIname\fP of the
  36. service. The default service name is \fB"HTTP"\fP for HTTP based proxies and
  37. \fB"rcmd"\fP for SOCKS5. This option allows you to change it.
  38. The application does not have to keep the string around after setting this
  39. option.
  40. .SH DEFAULT
  41. See above
  42. .SH PROTOCOLS
  43. All network protocols
  44. .SH EXAMPLE
  45. .nf
  46. CURL *curl = curl_easy_init();
  47. if(curl) {
  48. CURLcode ret;
  49. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  50. curl_easy_setopt(curl, CURLOPT_PROXY_SERVICE_NAME, "custom");
  51. ret = curl_easy_perform(curl);
  52. }
  53. .fi
  54. .SH AVAILABILITY
  55. Added in 7.43.0 for HTTP proxies, 7.49.0 for SOCKS5 proxies.
  56. .SH RETURN VALUE
  57. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  58. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  59. .SH "SEE ALSO"
  60. .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "