Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_FTP_ALTERNATIVE_TO_USER.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2014, 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_FTP_ALTERNATIVE_TO_USER 3 "May 05, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_FTP_ALTERNATIVE_TO_USER \- command to use instead of USER with FTP
! 27: .SH SYNOPSIS
! 28: .nf
! 29: #include <curl/curl.h>
! 30:
! 31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_ALTERNATIVE_TO_USER,
! 32: char *cmd);
! 33: .SH DESCRIPTION
! 34: Pass a char * as parameter, pointing to a string which will be used to
! 35: authenticate if the usual FTP "USER user" and "PASS password" negotiation
! 36: fails. This is currently only known to be required when connecting to
! 37: Tumbleweed's Secure Transport FTPS server using client certificates for
! 38: authentication.
! 39:
! 40: The application does not have to keep the string around after setting this
! 41: option.
! 42: .SH DEFAULT
! 43: NULL
! 44: .SH PROTOCOLS
! 45: FTP
! 46: .SH EXAMPLE
! 47: .nf
! 48: CURL *curl = curl_easy_init();
! 49: if(curl) {
! 50: curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
! 51:
! 52: curl_easy_setopt(curl, CURLOPT_FTP_ALTERNATIVE_TO_USER, "two users");
! 53:
! 54: ret = curl_easy_perform(curl);
! 55:
! 56: curl_easy_cleanup(curl);
! 57: }
! 58: .fi
! 59: .SH AVAILABILITY
! 60: Added in 7.15.5
! 61: .SH RETURN VALUE
! 62: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
! 63: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
! 64: .SH "SEE ALSO"
! 65: .BR CURLOPT_FTP_SKIP_PASV_IP "(3), " CURLOPT_FTP_RESPONSE_TIMEOUT "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>