1---
2c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_SOCKS5_GSSAPI_SERVICE
5Section: 3
6Source: libcurl
7See-also:
8  - CURLOPT_PROXY (3)
9  - CURLOPT_PROXYTYPE (3)
10---
11
12# NAME
13
14CURLOPT_SOCKS5_GSSAPI_SERVICE - SOCKS5 proxy authentication service name
15
16# SYNOPSIS
17
18~~~c
19#include <curl/curl.h>
20
21CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_GSSAPI_SERVICE,
22                          char *name);
23~~~
24
25# DESCRIPTION
26
27Deprecated since 7.49.0. Use CURLOPT_PROXY_SERVICE_NAME(3) instead.
28
29Pass a char pointer as parameter to a string holding the *name* of the
30service. The default service name for a SOCKS5 server is *rcmd*. This option
31allows you to change it.
32
33The application does not have to keep the string around after setting this
34option.
35
36# DEFAULT
37
38See above
39
40# PROTOCOLS
41
42All network protocols
43
44# EXAMPLE
45
46~~~c
47int main(void)
48{
49  CURL *curl = curl_easy_init();
50  if(curl) {
51    CURLcode res;
52    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
53    curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://proxy");
54    curl_easy_setopt(curl, CURLOPT_SOCKS5_GSSAPI_SERVICE, "rcmd-special");
55    res = curl_easy_perform(curl);
56    curl_easy_cleanup(curl);
57  }
58}
59~~~
60
61# AVAILABILITY
62
63Added in 7.19.4, deprecated in 7.49.0
64
65# RETURN VALUE
66
67Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
68CURLE_OUT_OF_MEMORY if there was insufficient heap space.
69