mirror of
https://github.com/libssh2/libssh2.git
synced 2025-07-02 22:02:25 +03:00
592e2b37fa
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
31 lines
1.0 KiB
Groff
31 lines
1.0 KiB
Groff
.TH libssh2_channel_signal_ex 3 "20 Apr 2023" "libssh2 1.11.0" "libssh2"
|
|
.SH NAME
|
|
libssh2_channel_signal_ex -- Send a signal to process previously opened on channel.
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_signal_ex(LIBSSH2_CHANNEL *channel,
|
|
const char *signame,
|
|
size_t signame_len)
|
|
.fi
|
|
.SH DESCRIPTION
|
|
A signal can be delivered to the remote process/service. Some servers or
|
|
systems may not implement signals, in which case they will probably ignore this
|
|
message.
|
|
|
|
\fIchannel\fP - Previously opened channel instance such as returned by
|
|
.BR libssh2_channel_open_ex(3)
|
|
|
|
\fIsigname\fP - The signal name is the same as the signal name constant, without the leading "SIG".
|
|
|
|
\fIsigname_len\fP - Length of passed signal name parameter.
|
|
|
|
There is also a macro \fIlibssh2_channel_signal(channel, signame)\fP that supplies the strlen of the signame.
|
|
.SH RETURN VALUE
|
|
Normal channel error codes.
|
|
LIBSSH2_ERROR_EAGAIN when it would block.
|
|
.SH SEE ALSO
|
|
.BR libssh2_channel_get_exit_signal(3)
|