ec699ef684
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.
20 строки
597 B
Groff
20 строки
597 B
Groff
.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
|
|
.\"
|
|
.TH libssh2_channel_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls
|
|
.SH SYNOPSIS
|
|
#include <libssh2.h>
|
|
|
|
libssh2_channel_read(arguments)
|
|
|
|
.SH DESCRIPTION
|
|
This is a macro defined in a public libssh2 header file that is using the
|
|
underlying function \fIlibssh2_channel_read_ex(3)\fP.
|
|
.SH RETURN VALUE
|
|
See \fIlibssh2_channel_read_ex(3)\fP
|
|
.SH ERRORS
|
|
See \fIlibssh2_channel_read_ex(3)\fP
|
|
.SH SEE ALSO
|
|
.BR \fIlibssh2_channel_read_ex(3)\fP
|