b9f491b03cce0f0d9da58a80600024dc0665e015
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_SERVICE_NAME.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_SERVICE_NAME 3 "17 Jun 2015" "libcurl 7.43.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_SERVICE_NAME \- authentication service name
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SERVICE_NAME, char *name);
30 .SH DESCRIPTION
31 Pass a char * as parameter to a string holding the \fIname\fP of the service
32 for DIGEST-MD5, SPNEGO and Kerberos 5 authentication mechanisms. The default
33 service names are "ftp", "HTTP", "imap", "pop" and "smtp". This option allows
34 you to change them.
35 .SH DEFAULT
36 See above
37 .SH PROTOCOLS
38 HTTP, FTP, IMAP, POP and SMTP
39 .SH EXAMPLE
40 TODO
41 .SH AVAILABILITY
42 Added in 7.43.0 for HTTP, 7.49.0 for FTP, IMAP, POP3 and SMTP.
43 .SH RETURN VALUE
44 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
45 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
46 .SH "SEE ALSO"
47 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "