1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
- .\" *
- .\" * This software is licensed as described in the file COPYING, which
- .\" * you should have received as part of this distribution. The terms
- .\" * are also available at http://curl.haxx.se/docs/copyright.html.
- .\" *
- .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
- .\" * copies of the Software, and permit persons to whom the Software is
- .\" * furnished to do so, under the terms of the COPYING file.
- .\" *
- .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
- .\" * KIND, either express or implied.
- .\" *
- .\" **************************************************************************
- .\"
- .TH CURLOPT_QUOTE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_QUOTE \- (S)FTP commands to run before transfer
- .SH SYNOPSIS
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_QUOTE, struct curl_slist *cmds);
- .SH DESCRIPTION
- Pass a pointer to a linked list of FTP or SFTP commands to pass to the server
- prior to your request. This will be done before any other commands are issued
- (even before the CWD command for FTP). The linked list should be a fully valid
- list of 'struct curl_slist' structs properly filled in with text strings. Use
- \fIcurl_slist_append(3)\fP to append strings (commands) to the list, and clear
- the entire list afterwards with \fIcurl_slist_free_all(3)\fP. Disable this
- operation again by setting a NULL to this option. When speaking to a FTP
- server, prefix the command with an asterisk (*) to make libcurl continue even
- if the command fails as by default libcurl will stop at first failure.
- The set of valid FTP commands depends on the server (see RFC959 for a list of
- mandatory commands).
- The valid SFTP commands are:
- .RS
- .IP "chgrp group file"
- The chgrp command sets the group ID of the file named by the file operand to
- the group ID specified by the group operand. The group operand is a decimal
- integer group ID.
- .IP "chmod mode file"
- The chmod command modifies the file mode bits of the specified file. The
- mode operand is an octal integer mode number.
- .IP "chown user file"
- The chown command sets the owner of the file named by the file operand to the
- user ID specified by the user operand. The user operand is a decimal
- integer user ID.
- .IP "ln source_file target_file"
- The ln and symlink commands create a symbolic link at the target_file location
- pointing to the source_file location.
- .IP "mkdir directory_name"
- The mkdir command creates the directory named by the directory_name operand.
- .IP "pwd"
- The pwd command returns the absolute pathname of the current working directory.
- .IP "rename source target"
- The rename command renames the file or directory named by the source
- operand to the destination path named by the target operand.
- .IP "rm file"
- The rm command removes the file specified by the file operand.
- .IP "rmdir directory"
- The rmdir command removes the directory entry specified by the directory
- operand, provided it is empty.
- .IP "symlink source_file target_file"
- See ln.
- .RE
- .SH DEFAULT
- NULL
- .SH PROTOCOLS
- SFTP and FTP
- .SH EXAMPLE
- TODO
- .SH AVAILABILITY
- SFTP support added in 7.16.3. *-prefix for SFTP added in 7.24.0
- .SH RETURN VALUE
- Returns CURLE_OK
- .SH "SEE ALSO"
- .BR CURLOPT_POSTQUOTE "(3), " CURLOPT_PREQUOTE "(3), "
|