diff --git a/docs/Makefile.am b/docs/Makefile.am index 549acc3..4195dd3 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -# $Id: Makefile.am,v 1.21 2007/06/14 16:33:38 jehousley Exp $ +# $Id: Makefile.am,v 1.22 2007/06/14 16:46:14 jehousley Exp $ EXTRA_DIST = template.3 @@ -52,4 +52,6 @@ dist_man_MANS = libssh2_sftp_shutdown.3 \ libssh2_sftp_stat_ex.3 \ libssh2_sftp_symlink_ex.3 \ - libssh2_sftp_tell.3 + libssh2_sftp_tell.3 \ + libssh2_sftp_unlink_ex.3 \ + libssh2_sftp_write.3 diff --git a/docs/libssh2_sftp_unlink_ex.3 b/docs/libssh2_sftp_unlink_ex.3 new file mode 100644 index 0000000..3f111c7 --- /dev/null +++ b/docs/libssh2_sftp_unlink_ex.3 @@ -0,0 +1,44 @@ +.\" $Id: libssh2_sftp_unlink_ex.3,v 1.1 2007/06/14 16:46:14 jehousley Exp $ +.\" +.TH libssh2_sftp_unlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_unlink_ex - rename a file +.SH SYNOPSIS +#include +#include + +int +libssh2_sftp_unlink_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len); + +int +libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); + +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIfilename\fP - Path and name of the existing filesystem entry + +\fIfilename_len\fP - Length of the path and name of the existing +filesystem entry + +Unlink (delete) a file from the remote filesystem. + +.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_init(3) diff --git a/docs/libssh2_sftp_write.3 b/docs/libssh2_sftp_write.3 new file mode 100644 index 0000000..575a5e9 --- /dev/null +++ b/docs/libssh2_sftp_write.3 @@ -0,0 +1,41 @@ +.\" $Id: libssh2_sftp_write.3,v 1.1 2007/06/14 16:46:14 jehousley Exp $ +.\" +.TH libssh2_sftp_rename_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_rename_ex - rename a file +.SH SYNOPSIS +#include +#include + +ssize_t +libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, const char *buffer, size_t count); + +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open(3) + +\fIbuffer\fP - Pre-initialized data buffer to write to the LIBSSH2_SFTP_HANDLE. + +\fIcount\fP - Number of bytes from buffer to write. Note that it may not +be possible to write all bytes as requested. + +Write a block of data to a LIBSSH2_SFTP_HANDLE. This method is modeled after the POSIX write() function and uses the same calling semantics. + +.SH RETURN VALUE +Actual number of bytes written 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)