From cd077c350f2ac173fc34b2f5e07bdc3ac3e5249a Mon Sep 17 00:00:00 2001 From: James Housley Date: Thu, 14 Jun 2007 15:45:03 +0000 Subject: [PATCH] Add libssh2_sftp_close_handle.3 and libssh2_sftp_fstat_ex.3 --- docs/Makefile.am | 4 ++- docs/libssh2_sftp_close_handle.3 | 52 ++++++++++++++++++++++++++++++++ docs/libssh2_sftp_fstat_ex.3 | 49 ++++++++++++++++++++++++++++++ 3 files changed, 104 insertions(+), 1 deletion(-) create mode 100644 docs/libssh2_sftp_close_handle.3 create mode 100644 docs/libssh2_sftp_fstat_ex.3 diff --git a/docs/Makefile.am b/docs/Makefile.am index aaf544f..e16ee3e 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -# $Id: Makefile.am,v 1.18 2007/06/14 15:26:58 jehousley Exp $ +# $Id: Makefile.am,v 1.19 2007/06/14 15:45:03 jehousley Exp $ EXTRA_DIST = template.3 @@ -38,6 +38,8 @@ dist_man_MANS = libssh2_session_startup.3 \ libssh2_poll.3 \ libssh2_poll_channel_read.3 \ + libssh2_sftp_close_handle.3 \ + libssh2_sftp_fstat_ex.3 \ libssh2_sftp_init.3 \ libssh2_sftp_open_ex.3 \ libssh2_sftp_mkdir_ex.3 \ diff --git a/docs/libssh2_sftp_close_handle.3 b/docs/libssh2_sftp_close_handle.3 new file mode 100644 index 0000000..37c87e2 --- /dev/null +++ b/docs/libssh2_sftp_close_handle.3 @@ -0,0 +1,52 @@ +.\" $Id: libssh2_sftp_close_handle.3,v 1.1 2007/06/14 15:45:03 jehousley Exp $ +.\" +.TH libssh2_sftp_close_handle 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_close_handle - close filehandle +.SH SYNOPSIS +#include +#include + +int +libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle); + +int +libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle); + +int +libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle); + +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open(3) +or +.BR libssh2_sftp_opendir(3) + +Close an active LIBSSH2_SFTP_HANDLE. Because files and directories +share the same underlying storage mechanism these methods may be used +interchangably. It is recommended that +.BR libssh2_sftp_close() +be used for files and that +.BR libssh2_sftp_closedir() +be used for directories so that future changes in the library +may cause minimal disruption. + +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. + +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. + +.SH SEE ALSO +.BR libssh2_sftp_open(3) +.BR libssh2_sftp_opendir(3) diff --git a/docs/libssh2_sftp_fstat_ex.3 b/docs/libssh2_sftp_fstat_ex.3 new file mode 100644 index 0000000..45e4f4f --- /dev/null +++ b/docs/libssh2_sftp_fstat_ex.3 @@ -0,0 +1,49 @@ +.\" $Id: libssh2_sftp_fstat_ex.3,v 1.1 2007/06/14 15:45:03 jehousley Exp $ +.\" +.TH libssh2_sftp_fstat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_fstat_ex - get or set attributes on a file handle +.SH SYNOPSIS +#include +#include + +int +libssh2_sftp_fstat_ex(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs, int setstat) + +int +libssh2_sftp_fstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs) + +int +libssh2_sftp_fsetstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs) + +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open(3) + +\fIattrs\fP - Pointer to attribute structure to set file metadata +from or into depending on the value of setstat. + +\fIsetstat\fP - When non-zero, the file's metadata will be updated +with the data found in attrs according to the values of attrs->flags +and other relevant member attributes. + +Get or Set statbuf type data for a given LIBSSH2_SFTP_HANDLE instance. + +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. + +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to +be returned by the server. + +.SH SEE ALSO +.BR libssh2_sftp_open(3)