From 75909e05a93d040acefc4f8d06c68d021634dcd5 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Tue, 14 Dec 2010 15:06:04 +0100 Subject: [PATCH] libssh2_sftp_open_ex: man page extended and cleaned up I added the missing documentation for the 'flags' argument. --- docs/libssh2_sftp_open_ex.3 | 40 +++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/docs/libssh2_sftp_open_ex.3 b/docs/libssh2_sftp_open_ex.3 index 981c32d..56a5bbd 100644 --- a/docs/libssh2_sftp_open_ex.3 +++ b/docs/libssh2_sftp_open_ex.3 @@ -4,31 +4,45 @@ .SH NAME libssh2_sftp_open - open filehandle for file on SFTP. .SH SYNOPSIS +.nf #include #include LIBSSH2_SFTP_HANDLE * -libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len, unsigned long flags, long mode, int open_type); - -LIBSSH2_SFTP_HANDLE * -libssh2_sftp_open(LIBSSH2_SFTP *sftp, const char *filename, unsigned long flags, long mode); - -LIBSSH2_SFTP_HANDLE * -libssh2_sftp_opendir(LIBSSH2_SFTP *sftp, const char *path); - +libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, const char *filename, + unsigned int filename_len, unsigned long flags, + long mode, int open_type); .SH DESCRIPTION -\fIsftp\fP - SFTP instance as returned by -.BR libssh2_sftp_init(3) +\fIsftp\fP - SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP \fIfilename\fP - Remote file/directory resource to open \fIfilename_len\fP - Length of filename -\fIflags\fP - Any (reasonable) combination of the LIBSSH2_FXF_* constants -corresponding fopen modes. +\fIflags\fP - Any reasonable combination of the LIBSSH2_FXF_* constants: +.RS +.IP LIBSSH2_FXF_READ +Open the file for reading. +.IP LIBSSH2_FXF_WRITE +Open the file for writing. If both this and LIBSSH2_FXF_READ are specified, +the file is opened for both reading and writing. +.IP LIBSSH2_FXF_APPEND +Force all writes to append data at the end of the file. +.IP LIBSSH2_FXF_CREAT, +If this flag is specified, then a new file will be created if one does not +already exist (if LIBSSH2_FXF_TRUNC is specified, the new file will be +truncated to zero length if it previously exists) +.IP LIBSSH2_FXF_TRUNC +Forces an existing file with the same name to be truncated to zero length when +creating a file by specifying LIBSSH2_FXF_CREAT. LIBSSH2_FXF_CREAT MUST also +be specified if this flag is used. +.IP LIBSSH2_FXF_EXCL +Causes the request to fail if the named file already exists. +LIBSSH2_FXF_CREAT MUST also be specified if this flag is used. +.RE \fImode\fP - POSIX file permissions to assign if the file is being newly -created. +created. See the LIBSSH2_SFTP_S_* convenience defines in \fIopen_type\fP - Either of LIBSSH2_SFTP_OPENFILE (to open a file) or LIBSSH2_SFTP_OPENDIR (to open a directory).