aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Fandrich <dan@coneharvesters.com>2008-08-20 19:45:43 +0000
committerDan Fandrich <dan@coneharvesters.com>2008-08-20 19:45:43 +0000
commit6768e81d5dfd540c5db030a9fe1c3e2d433617c5 (patch)
treeefc15aa9d17594a5f50ecc6d3b7ac95e466c9410
parent3743f515cfc5ed1b6c7bb301ceca5bafdbcc1360 (diff)
Added an edited version of Vincent Le Normand's documentation of SFTP quote
commands to the man pages.
-rw-r--r--CHANGES4
-rw-r--r--docs/curl.139
-rw-r--r--docs/libcurl/curl_easy_setopt.38
3 files changed, 45 insertions, 6 deletions
diff --git a/CHANGES b/CHANGES
index b542d43c8..627cd2918 100644
--- a/CHANGES
+++ b/CHANGES
@@ -6,6 +6,10 @@
Changelog
+Daniel Fandrich (20 Aug 2008)
+- Added an edited version of Vincent Le Normand's documentation of SFTP quote
+ commands to the man pages.
+
Daniel Stenberg (20 Aug 2008)
- Phil Pellouchoud pointed out that the windows version of libcurl had a
memory leak because it never called the OpenSSL function
diff --git a/docs/curl.1 b/docs/curl.1
index a23f156a4..5a60aa907 100644
--- a/docs/curl.1
+++ b/docs/curl.1
@@ -934,11 +934,42 @@ just before the transfer command(s), prefix the command with '+' (this
is only supported for FTP). You may specify any number of commands. If
the server returns failure for one of the commands, the entire operation
will be aborted. You must send syntactically correct FTP commands as
-RFC959 defines to FTP servers, or one of the following commands (with
-appropriate arguments) to SFTP servers: chgrp, chmod, chown, ln, mkdir,
-pwd, rename, rm, rmdir, symlink.
+RFC959 defines to FTP servers, or one of the commands listed below to
+SFTP servers. This option can be used multiple times.
-This option can be used multiple times.
+SFTP is a binary protocol. Unlike for FTP, libcurl interprets SFTP quote
+commands before sending them to the server. Following is the list of
+all supported SFTP quote commands:
+.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
.IP "--random-file <file>"
(SSL) Specify the path name to file containing what will be considered as
random data. The data is used to seed the random engine for SSL connections.
diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3
index 6191469d6..84bcd1dc2 100644
--- a/docs/libcurl/curl_easy_setopt.3
+++ b/docs/libcurl/curl_easy_setopt.3
@@ -972,8 +972,12 @@ 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.
+The set of valid FTP commands depends on the server (see RFC959 for a
+list of mandatory commands).
The valid SFTP commands are: chgrp, chmod, chown, ln, mkdir, pwd,
-rename, rm, rmdir, symlink. (SFTP support added in 7.16.3)
+rename, rm, rmdir, symlink (see
+.BR curl (1))
+(SFTP support added in 7.16.3)
.IP CURLOPT_POSTQUOTE
Pass a pointer to a linked list of FTP or SFTP commands to pass to the
server after your ftp transfer request. The linked list should be a
@@ -1630,4 +1634,4 @@ If you try to set an option that libcurl doesn't know about, perhaps because
the library is too old to support it or the option was removed in a recent
version, this function will return \fICURLE_FAILED_INIT\fP.
.SH "SEE ALSO"
-.BR curl_easy_init "(3), " curl_easy_cleanup "(3), " curl_easy_reset "(3), "
+.BR curl_easy_init "(3), " curl_easy_cleanup "(3), " curl_easy_reset "(3)"