curl/docs/libcurl/opts/CURLOPT_SOCKS5_GSSAPI_SERVICE.md
Daniel Stenberg 2c6f13093e
libcurl docs: reduce 'since ...' in descriptions
Reduce mentions of libcurl versions like "since 7.xx ..." in option
descriptions to reduce clutter and make the texts easier to read. Keep
them in, or move them to, the HISTORY or DEPRECATED sections

The last version 7 release (7.88.1) shipped on Februrary 20, 2023.

Closes #20369
2026-01-20 11:22:27 +01:00

73 lines
1.4 KiB
Markdown

---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: CURLOPT_SOCKS5_GSSAPI_SERVICE
Section: 3
Source: libcurl
See-also:
- CURLOPT_PROXY (3)
- CURLOPT_PROXYTYPE (3)
Protocol:
- All
Added-in: 7.19.4
---
# NAME
CURLOPT_SOCKS5_GSSAPI_SERVICE - SOCKS5 proxy authentication service name
# SYNOPSIS
~~~c
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_GSSAPI_SERVICE,
char *name);
~~~
# DESCRIPTION
Deprecated. Use CURLOPT_PROXY_SERVICE_NAME(3) instead.
Pass a char pointer as parameter to a string holding the *name* of the
service. The default service name for a SOCKS5 server is *rcmd*. This option
allows you to change it.
The application does not have to keep the string around after setting this
option.
# DEFAULT
See above
# %PROTOCOLS%
# EXAMPLE
~~~c
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode result;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://proxy");
curl_easy_setopt(curl, CURLOPT_SOCKS5_GSSAPI_SERVICE, "rcmd-special");
result = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
}
~~~
# DEPRECATED
Deprecated since 7.49.0
# %AVAILABILITY%
# RETURN VALUE
curl_easy_setopt(3) returns a CURLcode indicating success or error.
CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
libcurl-errors(3).