libssh2/share/man/man3/libssh2_channel_x11_req_ex.3

   1 .\" $Id: libssh2_channel_x11_req_ex.3,v 1.1 2007/06/13 21:30:15 jehousley Exp $
   2 .\"
   3 .TH libssh2_channel_x11_req_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_channel_x11_req_ex - request an X11 forwarding channel
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection, const char *auth_proto, const char *auth_cookie, int screen_number);
  11
  12 int
  13 libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number);
  14
  15 .SH DESCRIPTION
  16 \fIchannel\fP - Previously opened channel instance such as returned by
  17 .BR libssh2_channel_open_session(3)
  18
  19 \fIsingle_connection\fP - non-zero to only forward a single connection.
  20
  21 \fIauth_proto\fP - X11 authentication protocol to use
  22
  23 \fIauth_cookie\fP - the cookie (hexadecimal encoded).
  24
  25 \fIscreen_number\fP - the XLL screen to forward
  26
  27 Request an X11 forwarding on \fIchannel\fP. To use X11 forwarding,
  28 .BR libssh2_session_callback_set(3)
  29 must first be called to set \fBLIBSSH2_CALLBACK_X11/fP. This callback will
  30 be invoked when the remote host accepts the X11 forwarding.
  31
  32 .SH RETURN VALUE
  33 Return 0 on success or negative on failure.  It returns
  34 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  35 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  36
  37 .SH ERRORS
  38 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  39
  40 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  41
  42 \fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP -
  43
  44 .SH SEE ALSO
  45 .BR libssh2_channel_open_session(3)
  46 .BR libssh2_session_callback_set(3)