mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-28 11:45:02 +03:00
e590450dcc
- add missing `.fi` tags. - fix misplaced `.nf` tags. - add `.nf`/`.fi` tags `SYNOPSIS` where missing. - fix missing/wrong function name from `SH NAME`. - fix wrong function name in `TH`. - keep return values in a separate line. - indent. - fold long lines. - deleted `libssh2_channel_direct_streamlocal()`, there is no such function. - add missing types. - add missing headers. Closes #949
40 lines
1.3 KiB
Groff
40 lines
1.3 KiB
Groff
.TH libssh2_channel_direct_tcpip_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
LIBSSH2_CHANNEL *
|
|
libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session,
|
|
const char *host, int port,
|
|
const char *shost, int sport);
|
|
|
|
LIBSSH2_CHANNEL *
|
|
libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session,
|
|
const char *host, int port);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\fIsession\fP - Session instance as returned by
|
|
.BR libssh2_session_init_ex(3)
|
|
|
|
\fIhost\fP - Third party host to connect to using the SSH host as a proxy.
|
|
|
|
\fIport\fP - Port on third party host to connect to.
|
|
|
|
\fIshost\fP - Host to tell the SSH server the connection originated on.
|
|
|
|
\fIsport\fP - Port to tell the SSH server the connection originated from.
|
|
|
|
Tunnel a TCP/IP connection through the SSH transport via the remote host to
|
|
a third party. Communication from the client to the SSH server remains
|
|
encrypted, communication from the server to the 3rd party host travels
|
|
in cleartext.
|
|
|
|
.SH RETURN VALUE
|
|
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
|
.SH ERRORS
|
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_init_ex(3)
|