Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SERVICE_NAME.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_SERVICE_NAME 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_SERVICE_NAME \- authentication service name
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SERVICE_NAME, char *name);
31: .SH DESCRIPTION
32: Pass a char * as parameter to a string holding the \fIname\fP of the service
33: for DIGEST-MD5, SPNEGO and Kerberos 5 authentication mechanisms. The default
34: service names are "ftp", "HTTP", "imap", "pop" and "smtp". This option allows
35: you to change them.
36:
37: The application does not have to keep the string around after setting this
38: option.
39: .SH DEFAULT
40: See above
41: .SH PROTOCOLS
42: HTTP, FTP, IMAP, POP and SMTP
43: .SH EXAMPLE
44: .nf
45: CURL *curl = curl_easy_init();
46: if(curl) {
47: CURLcode ret;
48: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
49: curl_easy_setopt(curl, CURLOPT_SERVICE_NAME, "custom");
50: ret = curl_easy_perform(curl);
51: }
52: .fi
53: .SH AVAILABILITY
54: Added in 7.43.0 for HTTP, 7.49.0 for FTP, IMAP, POP3 and SMTP.
55: .SH RETURN VALUE
56: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
57: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
58: .SH "SEE ALSO"
59: .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>