generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
59207291fc
ssh2/docs/libssh2_channel_write.3

21 lines
682 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
.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
.\"
.TH libssh2_channel_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
.SH NAME
libssh2_channel_write: show how the macro is defined
2010-06-13 16:59:18 +02:00
libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_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 SYNOPSIS
libssh2_channel_write: show how the macro is defined
2010-06-13 16:59:18 +02:00
.nf
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
#include <libssh2.h>
libssh2_channel_write: show how the macro is defined
2010-06-13 16:59:18 +02:00
#define libssh2_channel_write(channel, buf, buflen) \\
libssh2_channel_write_ex((channel), 0, (buf), (buflen))
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
underlying function \fIlibssh2_channel_write_ex(3)\fP.
.SH RETURN VALUE
See \fIlibssh2_channel_write_ex(3)\fP
.SH ERRORS
See \fIlibssh2_channel_write_ex(3)\fP
.SH SEE ALSO
.BR \fIlibssh2_channel_write_ex(3)\fP
Reference in New Issue Copy Permalink