Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PREQUOTE.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2020, 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_PREQUOTE 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_PREQUOTE \- commands to run before an FTP transfer
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PREQUOTE,
                     31:                           struct curl_slist *cmds);
                     32: .SH DESCRIPTION
                     33: Pass a pointer to a linked list of FTP commands to pass to the server after
                     34: the transfer type is set. The linked list should be a fully valid list of
                     35: struct curl_slist structs properly filled in as described for
                     36: \fICURLOPT_QUOTE(3)\fP. Disable this operation again by setting a NULL to this
                     37: option.
                     38: 
                     39: While \fICURLOPT_QUOTE(3)\fP and \fICURLOPT_POSTQUOTE(3)\fP work for SFTP,
                     40: this option does not.
                     41: .SH DEFAULT
                     42: NULL
                     43: .SH PROTOCOLS
                     44: FTP
                     45: .SH EXAMPLE
                     46: .nf
                     47: struct curl_slist *cmdlist = NULL;
                     48: cmdlist = curl_slist_append(cmdlist, "SYST");
                     49: 
                     50: curl = curl_easy_init();
                     51: if(curl) {
                     52:   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
                     53: 
                     54:   /* pass in the FTP commands to run */
                     55:   curl_easy_setopt(curl, CURLOPT_PREQUOTE, cmdlist);
                     56: 
                     57:   ret = curl_easy_perform(curl);
                     58: 
                     59:   curl_easy_cleanup(curl);
                     60: }
                     61: .fi
                     62: .SH AVAILABILITY
                     63: Along with the protocol support
                     64: .SH RETURN VALUE
                     65: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     66: .SH "SEE ALSO"
                     67: .BR CURLOPT_QUOTE "(3), " CURLOPT_POSTQUOTE "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>