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