generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
87f79f177f
ssh2/docs/libssh2_sftp_readdir.3

18 lines
616 B
Groff
Raw Normal View History

added man pages for API macros all #defined macros in the public headers are considered to be part of the API and I've generated individual man pages for each of them to A) make it easier to figure out what each function/macro actually is for so that automated lookups work better and for B) make sure we have all public functions document (both macros and functions) to make it easier for us to work away from all the macros in a future release.
2010-02-15 14:24:40 +01:00
.TH libssh2_sftp_readdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
.SH NAME
libssh2_exit and libssh2_sftp_readdir man page fixes
2010-05-22 08:07:55 +02:00
libssh2_sftp_readdir - convenience macro for \fIlibssh2_sftp_readdir_ex(3)\fP calls
added man pages for API macros all #defined macros in the public headers are considered to be part of the API and I've generated individual man pages for each of them to A) make it easier to figure out what each function/macro actually is for so that automated lookups work better and for B) make sure we have all public functions document (both macros and functions) to make it easier for us to work away from all the macros in a future release.
2010-02-15 14:24:40 +01:00
.SH SYNOPSIS
#include <libssh2.h>
Document prototypes for macro defined functions
2011-08-06 13:44:00 +02:00
int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs);
added man pages for API macros all #defined macros in the public headers are considered to be part of the API and I've generated individual man pages for each of them to A) make it easier to figure out what each function/macro actually is for so that automated lookups work better and for B) make sure we have all public functions document (both macros and functions) to make it easier for us to work away from all the macros in a future release.
2010-02-15 14:24:40 +01:00
.SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the
libssh2_exit and libssh2_sftp_readdir man page fixes
2010-05-22 08:07:55 +02:00
underlying function \fIlibssh2_sftp_readdir_ex(3)\fP.
added man pages for API macros all #defined macros in the public headers are considered to be part of the API and I've generated individual man pages for each of them to A) make it easier to figure out what each function/macro actually is for so that automated lookups work better and for B) make sure we have all public functions document (both macros and functions) to make it easier for us to work away from all the macros in a future release.
2010-02-15 14:24:40 +01:00
.SH RETURN VALUE
libssh2_exit and libssh2_sftp_readdir man page fixes
2010-05-22 08:07:55 +02:00
See \fIlibssh2_sftp_readdir_ex(3)\fP
added man pages for API macros all #defined macros in the public headers are considered to be part of the API and I've generated individual man pages for each of them to A) make it easier to figure out what each function/macro actually is for so that automated lookups work better and for B) make sure we have all public functions document (both macros and functions) to make it easier for us to work away from all the macros in a future release.
2010-02-15 14:24:40 +01:00
.SH ERRORS
libssh2_exit and libssh2_sftp_readdir man page fixes
2010-05-22 08:07:55 +02:00
See \fIlibssh2_sftp_readdir_ex(3)\fP
added man pages for API macros all #defined macros in the public headers are considered to be part of the API and I've generated individual man pages for each of them to A) make it easier to figure out what each function/macro actually is for so that automated lookups work better and for B) make sure we have all public functions document (both macros and functions) to make it easier for us to work away from all the macros in a future release.
2010-02-15 14:24:40 +01:00
.SH SEE ALSO
man page: fix .BR lines We don't use \fI etc on .BR lines
2011-05-30 09:26:34 +02:00
.BR libssh2_sftp_readdir_ex(3)
Reference in New Issue Copy Permalink