Return to CURLOPT_QUOTE.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_QUOTE.3, revision 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_QUOTE 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_QUOTE \- (S)FTP commands to run before transfer
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_QUOTE, struct curl_slist *cmds);
        !            31: .SH DESCRIPTION
        !            32: Pass a pointer to a linked list of FTP or SFTP commands to pass to the server
        !            33: prior to your request. This will be done before any other commands are issued
        !            34: (even before the CWD command for FTP). The linked list should be a fully valid
        !            35: list of 'struct curl_slist' structs properly filled in with text strings. Use
        !            36: \fIcurl_slist_append(3)\fP to append strings (commands) to the list, and clear
        !            37: the entire list afterwards with \fIcurl_slist_free_all(3)\fP. Disable this
        !            38: operation again by setting a NULL to this option. When speaking to an FTP
        !            39: server, prefix the command with an asterisk (*) to make libcurl continue even
        !            40: if the command fails as by default libcurl will stop at first failure.
        !            41: 
        !            42: The set of valid FTP commands depends on the server (see RFC959 for a list of
        !            43: mandatory commands).
        !            44: 
        !            45: The valid SFTP commands are:
        !            46: .RS
        !            47: .IP "chgrp group file"
        !            48: The chgrp command sets the group ID of the file named by the file operand to
        !            49: the group ID specified by the group operand. The group operand is a decimal
        !            50: integer group ID.
        !            51: .IP "chmod mode file"
        !            52: The chmod command modifies the file mode bits of the specified file. The
        !            53: mode operand is an octal integer mode number.
        !            54: .IP "chown user file"
        !            55: The chown command sets the owner of the file named by the file operand to the
        !            56: user ID specified by the user operand. The user operand is a decimal
        !            57: integer user ID.
        !            58: .IP "ln source_file target_file"
        !            59: The ln and symlink commands create a symbolic link at the target_file location
        !            60: pointing to the source_file location.
        !            61: .IP "mkdir directory_name"
        !            62: The mkdir command creates the directory named by the directory_name operand.
        !            63: .IP "pwd"
        !            64: The pwd command returns the absolute pathname of the current working directory.
        !            65: .IP "rename source target"
        !            66: The rename command renames the file or directory named by the source
        !            67: operand to the destination path named by the target operand.
        !            68: .IP "rm file"
        !            69: The rm command removes the file specified by the file operand.
        !            70: .IP "rmdir directory"
        !            71: The rmdir command removes the directory entry specified by the directory
        !            72: operand, provided it is empty.
        !            73: .IP "statvfs file"
        !            74: The statvfs command returns statistics on the file system in which specified
        !            75: file resides. (Added in 7.49.0)
        !            76: .IP "symlink source_file target_file"
        !            77: See ln.
        !            78: .RE
        !            79: .SH DEFAULT
        !            80: NULL
        !            81: .SH PROTOCOLS
        !            82: SFTP and FTP
        !            83: .SH EXAMPLE
        !            84: .nf
        !            85: struct curl_slist *cmdlist = NULL;
        !            86: cmdlist = curl_slist_append(cmdlist, "RNFR source-name");
        !            87: cmdlist = curl_slist_append(cmdlist, "RNTO new-name");
        !            88: 
        !            89: curl = curl_easy_init();
        !            90: if(curl) {
        !            91:   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
        !            92: 
        !            93:   /* pass in the FTP commands to run before the transfer */
        !            94:   curl_easy_setopt(curl, CURLOPT_QUOTE, cmdlist);
        !            95: 
        !            96:   ret = curl_easy_perform(curl);
        !            97: 
        !            98:   curl_easy_cleanup(curl);
        !            99: }
        !           100: .fi
        !           101: .SH AVAILABILITY
        !           102: SFTP support added in 7.16.3. *-prefix for SFTP added in 7.24.0
        !           103: .SH RETURN VALUE
        !           104: Returns CURLE_OK
        !           105: .SH "SEE ALSO"
        !           106: .BR CURLOPT_POSTQUOTE "(3), " CURLOPT_PREQUOTE "(3), "