440f0894f6c0a7d5457653943dd375ce05ef7d8f
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_SOCKS5_GSSAPI_SERVICE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2016, 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 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_SOCKS5_GSSAPI_SERVICE \- SOCKS5 proxy authentication service name
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_GSSAPI_SERVICE, char *name);
30 .SH DESCRIPTION
31 Deprecated since 7.49.0. Use \fICURLOPT_PROXY_SERVICE_NAME(3)\fP instead.
32
33 Pass a char * as parameter to a string holding the \fIname\fP of the service.
34 The default service name for a SOCKS5 server is "rcmd". This option allows you
35 to change it.
36 .SH DEFAULT
37 See above
38 .SH PROTOCOLS
39 All network protocols
40 .SH EXAMPLE
41 TODO
42 .SH AVAILABILITY
43 Added in 7.19.4, deprecated in 7.49.0
44 .SH RETURN VALUE
45 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
46 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
47 .SH "SEE ALSO"
48 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "