diff --git a/docs/Makefile.am b/docs/Makefile.am index 6569fe0d..d657cb27 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -# $Id: Makefile.am,v 1.4 2007/04/21 18:07:17 jehousley Exp $ +# $Id: Makefile.am,v 1.5 2007/04/22 19:51:53 jehousley Exp $ EXTRA_DIST = template.3 @@ -9,4 +9,5 @@ dist_man_MANS = libssh2_channel_forward_accept.3 \ libssh2_sftp_open_ex.3 libssh2_channel_set_blocking.3 \ libssh2_session_free.3 libssh2_poll.3 libssh2_poll_channel_read.3 \ libssh2_sftp_read.3 libssh2_sftp_readnb.3 libssh2_sftp_readdir.3 \ - libssh2_sftp_readdirnb.3 + libssh2_sftp_readdirnb.3 libssh2_sftp_mkdir_ex.3 \ + libssh2_sftp_mkdirnb_ex.3 diff --git a/docs/libssh2_sftp_mkdir_ex.3 b/docs/libssh2_sftp_mkdir_ex.3 new file mode 100644 index 00000000..025ee62a --- /dev/null +++ b/docs/libssh2_sftp_mkdir_ex.3 @@ -0,0 +1,26 @@ +.\" $Id: libssh2_sftp_mkdir_ex.3,v 1.1 2007/04/22 19:51:53 jehousley Exp $ +.\" +.TH libssh2_sftp_mkdir_ex 3 "16 Apr 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_mkdir_ex - create a directory on the remote file system +.SH SYNOPSIS +#include +#include + +int libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, + unsigned int path_len, long mode); + +.SH DESCRIPTION +\fIsftp\fP SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP. + +\fIpath\fP full path of the new directory to create. Note that the new +directory's parents must all exist priot to making this call. + +\fIpath_len\fP length of the full path of the new directory to create. + +\fImode\fP directory creation mode (e.g. 0755). + +.SH RETURN VALUE +0 on success, or -1 on failure. +.SH "SEE ALSO" +.BR libssh2_sftp_opendir(3) diff --git a/docs/libssh2_sftp_mkdirnb_ex.3 b/docs/libssh2_sftp_mkdirnb_ex.3 new file mode 100644 index 00000000..388d46b6 --- /dev/null +++ b/docs/libssh2_sftp_mkdirnb_ex.3 @@ -0,0 +1,29 @@ +.\" $Id: libssh2_sftp_mkdirnb_ex.3,v 1.1 2007/04/22 19:51:54 jehousley Exp $ +.\" +.TH libssh2_sftp_mkdir_ex 3 "16 Apr 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_mkdir_ex - create a directory on the remote file system in +non-blocking mode +.SH SYNOPSIS +#include +#include + +int libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, + unsigned int path_len, long mode); + +.SH DESCRIPTION +\fIsftp\fP SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP. + +\fIpath\fP full path of the new directory to create. Note that the new +directory's parents must all exist priot to making this call. + +\fIpath_len\fP length of the full path of the new directory to create. + +\fImode\fP directory creation mode (e.g. 0755). + +.SH RETURN VALUE +0 on success, or -1 on failure. It returns LIBSSH2CHANNEL_EAGAIN when +it would otherwise block. While LIBSSH2CHANNEL_EAGAIN is a negative +number, it isn't really a failure per se. +.SH "SEE ALSO" +.BR libssh2_sftp_opendir(3)