mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-03 22:13:11 +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
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_channel_process_startup
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_channel_open_ex(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_channel_process_startup - request a shell on a channel
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel,
|
|
const char *request,
|
|
unsigned int request_len,
|
|
const char *message,
|
|
unsigned int message_len);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
*channel* - Active session channel instance.
|
|
|
|
*request* - Type of process to startup. The SSH2 protocol currently
|
|
defines shell, exec, and subsystem as standard process services.
|
|
|
|
*request_len* - Length of request parameter.
|
|
|
|
*message* - Request specific message data to include.
|
|
|
|
*message_len* - Length of message parameter.
|
|
|
|
Initiate a request on a session type channel such as returned by
|
|
libssh2_channel_open_ex(3).
|
|
|
|
# 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* -
|