Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_FTPSSLAUTH.3, revision 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_FTPSSLAUTH 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_FTPSSLAUTH \- set order in which to attempt TLS vs SSL when using FTP
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTPSSLAUTH, long order);
! 31: .SH DESCRIPTION
! 32: Pass a long using one of the values from below, to alter how libcurl issues
! 33: \&"AUTH TLS" or "AUTH SSL" when FTP over SSL is activated. This is only
! 34: interesting if \fICURLOPT_USE_SSL(3)\fP is also set.
! 35:
! 36: Possible \fIorder\fP values:
! 37: .IP CURLFTPAUTH_DEFAULT
! 38: Allow libcurl to decide.
! 39: .IP CURLFTPAUTH_SSL
! 40: Try "AUTH SSL" first, and only if that fails try "AUTH TLS".
! 41: .IP CURLFTPAUTH_TLS
! 42: Try "AUTH TLS" first, and only if that fails try "AUTH SSL".
! 43: .SH DEFAULT
! 44: CURLFTPAUTH_DEFAULT
! 45: .SH PROTOCOLS
! 46: FTP
! 47: .SH EXAMPLE
! 48: .nf
! 49: CURL *curl = curl_easy_init();
! 50: if(curl) {
! 51: curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/file.txt");
! 52: curl_easy_setopt(curl, CURLOPT_USE_SSL, CURLUSESSL_TRY);
! 53: /* funny server, ask for SSL before TLS */
! 54: curl_easy_setopt(curl, CURLOPT_FTPSSLAUTH, CURLFTPAUTH_SSL);
! 55: ret = curl_easy_perform(curl);
! 56: curl_easy_cleanup(curl);
! 57: }
! 58: .fi
! 59: .SH AVAILABILITY
! 60: Added in 7.12.2
! 61: .SH RETURN VALUE
! 62: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
! 63: .SH "SEE ALSO"
! 64: .BR CURLOPT_USE_SSL "(3), " CURLOPT_FTP_SSL_CCC "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>