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