Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SOCKS5_GSSAPI_SERVICE.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
9: .\" *
10: .\" * This software is licensed as described in the file COPYING, which
11: .\" * you should have received as part of this distribution. The terms
12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13: .\" *
14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15: .\" * copies of the Software, and permit persons to whom the Software is
16: .\" * furnished to do so, under the terms of the COPYING file.
17: .\" *
18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19: .\" * KIND, either express or implied.
20: .\" *
21: .\" **************************************************************************
22: .\"
23: .TH CURLOPT_SOCKS5_GSSAPI_SERVICE 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_SOCKS5_GSSAPI_SERVICE \- SOCKS5 proxy authentication service name
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_GSSAPI_SERVICE, char *name);
31: .SH DESCRIPTION
32: Deprecated since 7.49.0. Use \fICURLOPT_PROXY_SERVICE_NAME(3)\fP instead.
33:
34: Pass a char * as parameter to a string holding the \fIname\fP of the service.
35: The default service name for a SOCKS5 server is "rcmd". This option allows you
36: to change it.
37:
38: The application does not have to keep the string around after setting this
39: option.
40: .SH DEFAULT
41: See above
42: .SH PROTOCOLS
43: All network protocols
44: .SH EXAMPLE
45: .nf
46: CURL *curl = curl_easy_init();
47: if(curl) {
48: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
49: curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://proxy");
50: curl_easy_setopt(curl, CURLOPT_SOCKS5_GSSAPI_SERVICE, "rcmd-special");
51: ret = curl_easy_perform(curl);
52: curl_easy_cleanup(curl);
53: }
54: .fi
55: .SH AVAILABILITY
56: Added in 7.19.4, deprecated in 7.49.0
57: .SH RETURN VALUE
58: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
59: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
60: .SH "SEE ALSO"
61: .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>