tizen 2.3.1 release
[external/curl.git] / docs / libcurl / opts / CURLOPT_FTP_ALTERNATIVE_TO_USER.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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 http://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_FTP_ALTERNATIVE_TO_USER 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_FTP_ALTERNATIVE_TO_USER \- command to use instead of USER with FTP
26 .SH SYNOPSIS
27 .nf
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_ALTERNATIVE_TO_USER,
31                           char *cmd);
32 .SH DESCRIPTION
33 Pass a char * as parameter, pointing to a string which will be used to
34 authenticate if the usual FTP "USER user" and "PASS password" negotiation
35 fails. This is currently only known to be required when connecting to
36 Tumbleweed's Secure Transport FTPS server using client certificates for
37 authentication.
38 .SH DEFAULT
39 NULL
40 .SH PROTOCOLS
41 FTP
42 .SH EXAMPLE
43 TODO
44 .SH AVAILABILITY
45 Added in 7.15.5
46 .SH RETURN VALUE
47 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
48 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
49 .SH "SEE ALSO"
50 .BR CURLOPT_FTP_SKIP_PASV_IP "(3), " CURLOPT_FTP_RESPONSE_TIMEOUT "(3), "