1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-04-20 13:47:45 +03:00
libssh2/docs/libssh2_channel_signal_ex.3
Viktor Szakats a3ffc4221d
man: fix double spaces and dash escaping
- `-  ` -> `- `
- `.  ` -> `. `
- `\- ` -> `- `
- `-1` -> `\-1`
- fold long lines along the way

This makes the minus sign come out as a Unicode minus sign
(0x2212), and title separator dashes as Unicode hyphen (0x2010),
with `groff -Tutf8` v1.23.0.

Ref: https://lwn.net/Articles/947941/

Closes #1210
2023-11-03 19:57:56 +00:00

33 lines
1.1 KiB
Groff

.\" Copyright (C) The libssh2 project and its contributors.
.\" SPDX-License-Identifier: BSD-3-Clause
.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)