mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-29 00:54:50 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
69 lines
1.7 KiB
Markdown
69 lines
1.7 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_channel_request_pty_ex
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_channel_open_ex(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_channel_request_pty_ex - short function description
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term,
|
|
unsigned int term_len,
|
|
const char *modes, unsigned int modes_len,
|
|
int width, int height,
|
|
int width_px, int height_px);
|
|
|
|
int
|
|
libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, const char *term);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
*channel* - Previously opened channel instance such as returned by
|
|
libssh2_channel_open_ex(3)
|
|
|
|
*term* - Terminal emulation (e.g. vt102, ansi, etc...)
|
|
|
|
*term_len* - Length of term parameter
|
|
|
|
*modes* - Terminal mode modifier values
|
|
|
|
*modes_len* - Length of modes parameter.
|
|
|
|
*width* - Width of pty in characters
|
|
|
|
*height* - Height of pty in characters
|
|
|
|
*width_px* - Width of pty in pixels
|
|
|
|
*height_px* - Height of pty in pixels
|
|
|
|
Request a PTY on an established channel. Note that this does not make sense
|
|
for all channel types and may be ignored by the server despite returning
|
|
success.
|
|
|
|
# RETURN VALUE
|
|
|
|
Return 0 on success or negative on failure. It returns
|
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
|
|
|
# ERRORS
|
|
|
|
*LIBSSH2_ERROR_ALLOC* - An internal memory allocation call failed.
|
|
|
|
*LIBSSH2_ERROR_SOCKET_SEND* - Unable to send data on socket.
|
|
|
|
*LIBSSH2_ERROR_CHANNEL_REQUEST_DENIED* -
|