Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_FTP_SSL_CCC.3
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_FTP_SSL_CCC 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_FTP_SSL_CCC \- switch off SSL again with FTP after auth
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_SSL_CCC,
31                           long how);
32 .SH DESCRIPTION
33 If enabled, this option makes libcurl use CCC (Clear Command Channel). It
34 shuts down the SSL/TLS layer after authenticating. The rest of the control
35 channel communication will be unencrypted. This allows NAT routers to follow
36 the FTP transaction. Pass a long using one of the values below
37 .IP CURLFTPSSL_CCC_NONE
38 Don't attempt to use CCC.
39 .IP CURLFTPSSL_CCC_PASSIVE
40 Do not initiate the shutdown, but wait for the server to do it. Do not send a
41 reply.
42 .IP CURLFTPSSL_CCC_ACTIVE
43 Initiate the shutdown and wait for a reply.
44 .SH DEFAULT
45 CURLFTPSSL_CCC_NONE
46 .SH PROTOCOLS
47 FTP
48 .SH EXAMPLE
49 .nf
50 CURL *curl = curl_easy_init();
51 if(curl) {
52   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/file.txt");
53   curl_easy_setopt(curl, CURLOPT_USE_SSL, CURLUSESSL_CONTROL);
54   /* go back to clear-text FTP after authenticating */
55   curl_easy_setopt(curl, CURLOPT_FTP_SSL_CCC, CURLFTPSSL_CCC_ACTIVE);
56   ret = curl_easy_perform(curl);
57   curl_easy_cleanup(curl);
58 }
59 .fi
60 .SH AVAILABILITY
61 Added in 7.16.1
62 .SH RETURN VALUE
63 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
64 .SH "SEE ALSO"
65 .BR CURLOPT_USE_SSL "(3), " CURLOPT_FTPSSLAUTH "(3), "