CURLOPT_SOCKS5_GSSAPI_SERVICE.3 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .\" generated by cd2nroff 0.1 from CURLOPT_SOCKS5_GSSAPI_SERVICE.md
  2. .TH CURLOPT_SOCKS5_GSSAPI_SERVICE 3 "2025-01-17" libcurl
  3. .SH NAME
  4. CURLOPT_SOCKS5_GSSAPI_SERVICE \- SOCKS5 proxy authentication service name
  5. .SH SYNOPSIS
  6. .nf
  7. #include <curl/curl.h>
  8. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_GSSAPI_SERVICE,
  9. char *name);
  10. .fi
  11. .SH DESCRIPTION
  12. Deprecated since 7.49.0. Use \fICURLOPT_PROXY_SERVICE_NAME(3)\fP instead.
  13. Pass a char pointer as parameter to a string holding the \fIname\fP of the
  14. service. The default service name for a SOCKS5 server is \fIrcmd\fP. This option
  15. allows you to change it.
  16. The application does not have to keep the string around after setting this
  17. option.
  18. .SH DEFAULT
  19. See above
  20. .SH PROTOCOLS
  21. This functionality affects all supported protocols
  22. .SH EXAMPLE
  23. .nf
  24. int main(void)
  25. {
  26. CURL *curl = curl_easy_init();
  27. if(curl) {
  28. CURLcode res;
  29. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  30. curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://proxy");
  31. curl_easy_setopt(curl, CURLOPT_SOCKS5_GSSAPI_SERVICE, "rcmd-special");
  32. res = curl_easy_perform(curl);
  33. curl_easy_cleanup(curl);
  34. }
  35. }
  36. .fi
  37. .SH DEPRECATED
  38. Deprecated since 7.49.0
  39. .SH AVAILABILITY
  40. Added in curl 7.19.4
  41. .SH RETURN VALUE
  42. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  43. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  44. .SH SEE ALSO
  45. .BR CURLOPT_PROXY (3),
  46. .BR CURLOPT_PROXYTYPE (3)