diff --git a/docs/libssh2_sftp_stat_ex.3 b/docs/libssh2_sftp_stat_ex.3 index 8bff685..8343336 100644 --- a/docs/libssh2_sftp_stat_ex.3 +++ b/docs/libssh2_sftp_stat_ex.3 @@ -4,21 +4,13 @@ .SH NAME libssh2_sftp_stat_ex - get status about an SFTP file .SH SYNOPSIS +.nf #include #include -int -libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, int stat_type, LIBSSH2_SFTP_ATTRIBUTES *attrs); - -int -libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs); - -int -libssh2_sftp_lstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs); - -int -libssh2_sftp_setstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs); - +int libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path, + unsigned int path_len, int stat_type, + LIBSSH2_SFTP_ATTRIBUTES *attrs); .SH DESCRIPTION \fIsftp\fP - SFTP instance as returned by .BR libssh2_sftp_init(3) @@ -29,7 +21,8 @@ libssh2_sftp_setstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUT to stat/lstat/setstat. \fIstat_type\fP - One of the three constants specifying the type of -stat operation to perform. +stat operation to perform: + .br \fBLIBSSH2_SFTP_STAT\fP: performs stat(2) operation .br @@ -37,22 +30,38 @@ stat operation to perform. .br \fBLIBSSH2_SFTP_SETSTAT\fP: performs operation to set stat info on file -\fIattrs\fP - Pointer to attribute structure to set file metadata -from or into depending on the value of stat_type. +\fIattrs\fP - Pointer to a \fBLIBSSH2_SFTP_ATTRIBUTES\fP structure to set file +metadata from or into depending on the value of stat_type. -Get or Set statbuf type data on a remote filesystem object. When -getting statbuf data, +Get or Set statbuf type data on a remote filesystem object. When getting +statbuf data, .BR libssh2_sftp_stat(3) will follow all symlinks, while .BR libssh2_sftp_lstat(3) will return data about the object encountered, even if that object happens to be a symlink. -.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. +The LIBSSH2_SFTP_ATTRIBUTES struct looks like this: +.nf +struct LIBSSH2_SFTP_ATTRIBUTES { + /* If flags & ATTR_* bit is set, then the value in this struct will be + * meaningful Otherwise it should be ignored + */ + unsigned long flags; + + libssh2_uint64_t filesize; + unsigned long uid; + unsigned long gid; + unsigned long permissions; + unsigned long atime; + unsigned long mtime; +}; +.fi +.SH RETURN VALUE +Returns 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. @@ -63,6 +72,5 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \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)