lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-29 13:01:14 +03:00
Code Activity

docs: simplify .TH header & other cleanups [ci skip]

Browse Source 
- 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.
This commit is contained in:
Viktor Szakats
2023-04-26 17:49:01 +00:00
parent d7bec41df3
commit 592e2b37fa
183 changed files with 199 additions and 283 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/libssh2_agent_connect.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daiki Ueno .\" Copyright (c) 2009 by Daiki Ueno
.\" .\"
.TH libssh2_agent_connect 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_agent_connect 3 "23 Dec 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_agent_connect - connect to an ssh-agent libssh2_agent_connect - connect to an ssh-agent
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_agent_disconnect.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daiki Ueno .\" Copyright (c) 2009 by Daiki Ueno
.\" .\"
.TH libssh2_agent_disconnect 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_agent_disconnect 3 "23 Dec 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_agent_disconnect - close a connection to an ssh-agent libssh2_agent_disconnect - close a connection to an ssh-agent
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_agent_free.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daiki Ueno .\" Copyright (c) 2009 by Daiki Ueno
.\" .\"
.TH libssh2_agent_free 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_agent_free 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_agent_free - free an ssh-agent handle libssh2_agent_free - free an ssh-agent handle
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_agent_get_identity.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daiki Ueno .\" Copyright (c) 2009 by Daiki Ueno
.\" .\"
.TH libssh2_agent_get_identity 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_agent_get_identity 3 "23 Dec 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_agent_get_identity - get a public key off the collection of public keys managed by ssh-agent libssh2_agent_get_identity - get a public key off the collection of public keys managed by ssh-agent
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_agent_get_identity_path.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2019 by Will Cosgrove .\" Copyright (c) 2019 by Will Cosgrove
.\" .\"
.TH libssh2_agent_get_identity_path 3 "6 Mar 2019" "libssh2 1.9" "libssh2 manual" .TH libssh2_agent_get_identity_path 3 "6 Mar 2019" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_agent_get_identity_path - gets the custom ssh-agent socket path libssh2_agent_get_identity_path - gets the custom ssh-agent socket path
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_agent_init.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daiki Ueno .\" Copyright (c) 2009 by Daiki Ueno
.\" .\"
.TH libssh2_agent_init 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_agent_init 3 "23 Dec 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_agent_init - init an ssh-agent handle libssh2_agent_init - init an ssh-agent handle
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_agent_list_identities.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daiki Ueno .\" Copyright (c) 2009 by Daiki Ueno
.\" .\"
.TH libssh2_agent_list_identities 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_agent_list_identities 3 "23 Dec 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_agent_list_identities - request an ssh-agent to list of public keys. libssh2_agent_list_identities - request an ssh-agent to list of public keys.
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_agent_set_identity_path.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2019 by Will Cosgrove .\" Copyright (c) 2019 by Will Cosgrove
.\" .\"
.TH libssh2_agent_set_identity_path 3 "6 Mar 2019" "libssh2 1.9" "libssh2 manual" .TH libssh2_agent_set_identity_path 3 "6 Mar 2019" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_agent_set_identity_path - set an ssh-agent socket path on disk libssh2_agent_set_identity_path - set an ssh-agent socket path on disk
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_agent_sign.3
View File

@ -1,4 +1,4 @@
.TH libssh2_agent_sign 3 "1 Oct 2022" "libssh2 1.11.0" "libssh2 manual" .TH libssh2_agent_sign 3 "1 Oct 2022" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_agent_sign - sign data, with the help of ssh-agent libssh2_agent_sign - sign data, with the help of ssh-agent
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_agent_userauth.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daiki Ueno .\" Copyright (c) 2009 by Daiki Ueno
.\" .\"
.TH libssh2_agent_userauth 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_agent_userauth 3 "23 Dec 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_agent_userauth - authenticate a session with a public key, with the help of ssh-agent libssh2_agent_userauth - authenticate a session with a public key, with the help of ssh-agent
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_banner_set.3
View File

@ -1,4 +1,4 @@
.TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_banner_set - set the SSH protocol banner for the local client libssh2_banner_set - set the SSH protocol banner for the local client
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_base64_decode.3
View File

@ -1,4 +1,4 @@
.TH libssh2_base64_decode 3 "23 Dec 2008" "libssh2 1.0" "libssh2 manual" .TH libssh2_base64_decode 3 "23 Dec 2008" "libssh2 1.0" "libssh2"
.SH NAME .SH NAME
libssh2_base64_decode - decode a base64 encoded string libssh2_base64_decode - decode a base64 encoded string
.SH SYNOPSIS .SH SYNOPSIS

5
docs/libssh2_channel_close.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_close 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_close 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_close - close a channel libssh2_channel_close - close a channel
.SH SYNOPSIS .SH SYNOPSIS
@ -17,14 +17,11 @@ will be sent to it. The remote host may still send data back until it sends
its own close message in response. To wait for the remote end to close its its own close message in response. To wait for the remote end to close its
connection as well, follow this command with connection as well, follow this command with
.BR libssh2_channel_wait_closed(3) .BR libssh2_channel_wait_closed(3)
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
.SH ERRORS .SH ERRORS
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_channel_open_ex(3) .BR libssh2_channel_open_ex(3)

3
docs/libssh2_channel_direct_streamlocal_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_direct_streamlocal_ex 3 "10 Apr 2023" "libssh2 1.11.0" "libssh2 manual" .TH libssh2_channel_direct_streamlocal_ex 3 "10 Apr 2023" "libssh2 1.11.0" "libssh2"
.SH NAME .SH NAME
libssh2_channel_direct_streamlocal_ex - Tunnel a UNIX socket connection through an SSH session libssh2_channel_direct_streamlocal_ex - Tunnel a UNIX socket connection through an SSH session
.SH SYNOPSIS .SH SYNOPSIS
@ -24,7 +24,6 @@ Tunnel a UNIX socket connection through the SSH transport via the remote host to
a third party. Communication from the client to the SSH server remains a third party. Communication from the client to the SSH server remains
encrypted, communication from the server to the 3rd party host travels encrypted, communication from the server to the 3rd party host travels
in cleartext. in cleartext.
.SH RETURN VALUE .SH RETURN VALUE
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
.SH ERRORS .SH ERRORS

2
docs/libssh2_channel_direct_tcpip.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_direct_tcpip 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_direct_tcpip 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_tcpip_ex(3)\fP calls libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_tcpip_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

3
docs/libssh2_channel_direct_tcpip_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_direct_tcpip_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_direct_tcpip_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session
.SH SYNOPSIS .SH SYNOPSIS
@ -30,7 +30,6 @@ Tunnel a TCP/IP connection through the SSH transport via the remote host to
a third party. Communication from the client to the SSH server remains a third party. Communication from the client to the SSH server remains
encrypted, communication from the server to the 3rd party host travels encrypted, communication from the server to the 3rd party host travels
in cleartext. in cleartext.
.SH RETURN VALUE .SH RETURN VALUE
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
.SH ERRORS .SH ERRORS

2
docs/libssh2_channel_eof.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_eof - check a channel's EOF status libssh2_channel_eof - check a channel's EOF status
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_exec.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_exec 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_exec 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_flush.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_flush 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_flush 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

3
docs/libssh2_channel_flush_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_flush_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_flush_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_flush_ex - flush a channel libssh2_channel_flush_ex - flush a channel
.SH SYNOPSIS .SH SYNOPSIS
@ -26,7 +26,6 @@ be flushed by passing on of the following Constants.
Flush the read buffer for a given channel instance. Individual substreams may Flush the read buffer for a given channel instance. Individual substreams may
be flushed by number or using one of the provided macros. be flushed by number or using one of the provided macros.
.SH RETURN VALUE .SH RETURN VALUE
Return the number of bytes flushed or negative on failure. Return the number of bytes flushed or negative on failure.
It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While

2
docs/libssh2_channel_flush_stderr.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_flush_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_flush_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_forward_accept.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_forward_accept - accept a queued connection libssh2_channel_forward_accept - accept a queued connection
.SH SYNOPSIS .SH SYNOPSIS

5
docs/libssh2_channel_forward_cancel.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_forward_cancel 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_forward_cancel 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_forward_cancel - cancel a forwarded TCP port libssh2_channel_forward_cancel - cancel a forwarded TCP port
.SH SYNOPSIS .SH SYNOPSIS
@ -13,16 +13,13 @@ libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener);
.BR libssh2_channel_forward_listen_ex(3) .BR libssh2_channel_forward_listen_ex(3)
Instruct the remote host to stop listening for new connections on a previously requested host/port. Instruct the remote host to stop listening for new connections on a previously requested host/port.
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
.SH ERRORS .SH ERRORS
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_channel_forward_listen_ex(3) .BR libssh2_channel_forward_listen_ex(3)

2
docs/libssh2_channel_forward_listen.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_forward_listen 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_forward_listen 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forward_listen_ex(3)\fP calls libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forward_listen_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_forward_listen_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_forward_listen_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_forward_listen_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_forward_listen_ex - listen to inbound connections libssh2_channel_forward_listen_ex - listen to inbound connections
.SH SYNOPSIS .SH SYNOPSIS

4
docs/libssh2_channel_free.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_free - free all resources associated with a channel libssh2_channel_free - free all resources associated with a channel
.SH SYNOPSIS .SH SYNOPSIS
@ -16,11 +16,9 @@ not yet been closed with
.BR libssh2_channel_close(3) .BR libssh2_channel_close(3)
, it will be called automatically so that the remote end may know that it , it will be called automatically so that the remote end may know that it
can safely free its own resources. can safely free its own resources.
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_channel_close(3) .BR libssh2_channel_close(3)

3
docs/libssh2_channel_get_exit_signal.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_get_exit_signal 3 "4 Oct 2010" "libssh2 1.2.8" "libssh2 manual" .TH libssh2_channel_get_exit_signal 3 "4 Oct 2010" "libssh2 1.2.8" "libssh2"
.SH NAME .SH NAME
libssh2_channel_get_exit_signal - get the remote exit signal libssh2_channel_get_exit_signal - get the remote exit signal
.SH SYNOPSIS .SH SYNOPSIS
@ -33,6 +33,5 @@ string is stored in a newly allocated buffer.
string is stored in a newly allocated buffer. string is stored in a newly allocated buffer.
\fIlangtag_len\fP - If not NULL, is populated by reference with the length of langtag. \fIlangtag_len\fP - If not NULL, is populated by reference with the length of langtag.
.SH RETURN VALUE .SH RETURN VALUE
Numeric error code corresponding to the the Error Code constants. Numeric error code corresponding to the the Error Code constants.

3
docs/libssh2_channel_get_exit_status.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_get_exit_status 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_get_exit_status 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_get_exit_status - get the remote exit code libssh2_channel_get_exit_status - get the remote exit code
.SH SYNOPSIS .SH SYNOPSIS
@ -14,6 +14,5 @@ libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel)
Returns the exit code raised by the process running on the remote host at Returns the exit code raised by the process running on the remote host at
the other end of the named channel. Note that the exit status may not be the other end of the named channel. Note that the exit status may not be
available if the remote end has not yet set its status to closed. available if the remote end has not yet set its status to closed.
.SH RETURN VALUE .SH RETURN VALUE
Returns 0 on failure, otherwise the \fIExit Status\fP reported by remote host Returns 0 on failure, otherwise the \fIExit Status\fP reported by remote host

2
docs/libssh2_channel_handle_extended_data.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_handle_extended_data 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_handle_extended_data 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_handle_extended_data - set extended data handling mode libssh2_channel_handle_extended_data - set extended data handling mode
.SH SYNOPSIS .SH SYNOPSIS

4
docs/libssh2_channel_handle_extended_data2.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_handle_extended_data2 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_handle_extended_data2 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_handle_extended_data2 - set extended data handling mode libssh2_channel_handle_extended_data2 - set extended data handling mode
.SH SYNOPSIS .SH SYNOPSIS
@ -28,10 +28,8 @@ arrives.
Change how a channel deals with extended data packets. By default all Change how a channel deals with extended data packets. By default all
extended data is queued until read by extended data is queued until read by
.BR libssh2_channel_read_ex(3) .BR libssh2_channel_read_ex(3)
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or LIBSSH2_ERROR_EAGAIN when it would otherwise block. Return 0 on success or LIBSSH2_ERROR_EAGAIN when it would otherwise block.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_channel_handle_extended_data(3) .BR libssh2_channel_handle_extended_data(3)
.BR libssh2_channel_read_ex(3) .BR libssh2_channel_read_ex(3)

2
docs/libssh2_channel_ignore_extended_data.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_ignore_extended_data 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_ignore_extended_data 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_handle_extended_data(3)\fP calls libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_handle_extended_data(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

5
docs/libssh2_channel_open_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_open_ex - establish a generic session channel libssh2_channel_open_ex - establish a generic session channel
.SH SYNOPSIS .SH SYNOPSIS
@ -42,10 +42,8 @@ or via
.BR libssh2_channel_direct_tcpip(3) .BR libssh2_channel_direct_tcpip(3)
or or
.BR libssh2_channel_forward_listen(3) .BR libssh2_channel_forward_listen(3)
.SH RETURN VALUE .SH RETURN VALUE
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
.SH ERRORS .SH ERRORS
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
@ -54,6 +52,5 @@ Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
\fILIBSSH2_ERROR_CHANNEL_FAILURE\fP - \fILIBSSH2_ERROR_CHANNEL_FAILURE\fP -
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. \fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
.SH SEE ALSO .SH SEE ALSO
Add related functions Add related functions

2
docs/libssh2_channel_open_session.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_open_session 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_open_session 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex(3)\fP calls libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_process_startup.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_process_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_process_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_process_startup - request a shell on a channel libssh2_channel_process_startup - request a shell on a channel
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_read.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

3
docs/libssh2_channel_read_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_read_ex - read data from a channel stream libssh2_channel_read_ex - read data from a channel stream
.SH SYNOPSIS .SH SYNOPSIS
@ -44,6 +44,5 @@ only signals that no payload data was read. It is not an error.
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
\fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed. \fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_poll_channel_read(3) .BR libssh2_poll_channel_read(3)

2
docs/libssh2_channel_read_stderr.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_read_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_read_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_receive_window_adjust.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_receive_window_adjust 3 "15 Mar 2009" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_receive_window_adjust 3 "15 Mar 2009" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_receive_window_adjust - adjust the channel window libssh2_channel_receive_window_adjust - adjust the channel window
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_receive_window_adjust2.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_receive_window_adjust2 3 "26 Mar 2009" "libssh2 1.1" "libssh2 manual" .TH libssh2_channel_receive_window_adjust2 3 "26 Mar 2009" "libssh2 1.1" "libssh2"
.SH NAME .SH NAME
libssh2_channel_receive_window_adjust2 - adjust the channel window libssh2_channel_receive_window_adjust2 - adjust the channel window
.SH SYNOPSIS .SH SYNOPSIS

3
docs/libssh2_channel_request_auth_agent.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_request_auth_agent 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_request_auth_agent 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_request_auth_agent - request agent forwarding for a session libssh2_channel_request_auth_agent - request agent forwarding for a session
.SH SYNOPSIS .SH SYNOPSIS
@ -16,7 +16,6 @@ for the duration of the SSH session.
\fIchannel\fP - Previously opened channel instance such as returned by \fIchannel\fP - Previously opened channel instance such as returned by
.BR libssh2_channel_open_ex(3) .BR libssh2_channel_open_ex(3)
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN when it would otherwise block. While

2
docs/libssh2_channel_request_pty.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_request_pty 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_request_pty 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_pty_ex(3)\fP calls libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_pty_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_request_pty_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_request_pty_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_request_pty_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_request_pty_ex - short function description libssh2_channel_request_pty_ex - short function description
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_request_pty_size.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_request_pty_size 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_request_pty_size 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_request_pty_size_ex(3)\fP calls libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_request_pty_size_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

5
docs/libssh2_channel_request_pty_size_ex.3
View File

@ -1,13 +1,10 @@
.TH libssh2_channel_request_pty_size_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_request_pty_size_ex 3 "1 Jun 2007" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_channel_request_pty_size_ex - TODO libssh2_channel_request_pty_size_ex - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE
.SH ERRORS .SH ERRORS
.SH SEE ALSO .SH SEE ALSO

5
docs/libssh2_channel_send_eof.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_send_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_send_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_send_eof - send EOF to remote server libssh2_channel_send_eof - send EOF to remote server
.SH SYNOPSIS .SH SYNOPSIS
@ -11,15 +11,12 @@ libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel);
.SH DESCRIPTION .SH DESCRIPTION
Tell the remote host that no further data will be sent on the specified Tell the remote host that no further data will be sent on the specified
channel. Processes typically interpret this as a closed stdin descriptor. channel. Processes typically interpret this as a closed stdin descriptor.
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
.SH ERRORS .SH ERRORS
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_channel_wait_eof(3) .BR libssh2_channel_wait_eof(3)
.BR libssh2_channel_eof(3) .BR libssh2_channel_eof(3)

2
docs/libssh2_channel_set_blocking.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_set_blocking - set or clear blocking mode on channel libssh2_channel_set_blocking - set or clear blocking mode on channel
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_setenv.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_setenv 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_setenv 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\fP calls libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_setenv_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_setenv_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_setenv_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_setenv_ex - set an environment variable on the channel libssh2_channel_setenv_ex - set an environment variable on the channel
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_shell.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_shell 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_shell 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

4
docs/libssh2_channel_signal_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_signal_ex 3 "20 Apr 2023" "libssh2 1.11.0" "libssh2 manual" .TH libssh2_channel_signal_ex 3 "20 Apr 2023" "libssh2 1.11.0" "libssh2"
.SH NAME .SH NAME
libssh2_channel_signal_ex -- Send a signal to process previously opened on channel. libssh2_channel_signal_ex -- Send a signal to process previously opened on channel.
.SH SYNOPSIS .SH SYNOPSIS
@ -23,10 +23,8 @@ message.
\fIsigname_len\fP - Length of passed signal name parameter. \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. There is also a macro \fIlibssh2_channel_signal(channel, signame)\fP that supplies the strlen of the signame.
.SH RETURN VALUE .SH RETURN VALUE
Normal channel error codes. Normal channel error codes.
LIBSSH2_ERROR_EAGAIN when it would block. LIBSSH2_ERROR_EAGAIN when it would block.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_channel_get_exit_signal(3) .BR libssh2_channel_get_exit_signal(3)

2
docs/libssh2_channel_subsystem.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_subsystem 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_subsystem 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_wait_closed.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_wait_closed 3 "29 Nov 2007" "libssh2 0.19" "libssh2 manual" .TH libssh2_channel_wait_closed 3 "29 Nov 2007" "libssh2 0.19" "libssh2"
.SH NAME .SH NAME
libssh2_channel_wait_closed - wait for the remote to close the channel libssh2_channel_wait_closed - wait for the remote to close the channel
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_wait_eof.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_wait_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_wait_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_wait_eof - wait for the remote to reply to an EOF request libssh2_channel_wait_eof - wait for the remote to reply to an EOF request
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_window_read.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_window_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_window_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_read_ex(3)\fP calls libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_read_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

3
docs/libssh2_channel_window_read_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_window_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_window_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_window_read_ex - Check the status of the read window libssh2_channel_window_read_ex - Check the status of the read window
.SH SYNOPSIS .SH SYNOPSIS
@ -20,7 +20,6 @@ window_size_initial as defined by the channel_open request
The number of bytes which the remote end may send without overflowing the The number of bytes which the remote end may send without overflowing the
window limit window limit
.SH ERRORS .SH ERRORS
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_channel_receive_window_adjust(3), .BR libssh2_channel_receive_window_adjust(3),
.BR libssh2_channel_window_write_ex(3) .BR libssh2_channel_window_write_ex(3)

2
docs/libssh2_channel_window_write.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_window_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_window_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_write_ex(3)\fP calls libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_write_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

3
docs/libssh2_channel_window_write_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_window_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_window_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_window_write_ex - Check the status of the write window libssh2_channel_window_write_ex - Check the status of the write window
.SH SYNOPSIS .SH SYNOPSIS
@ -17,7 +17,6 @@ the channel_open request
.SH RETURN VALUE .SH RETURN VALUE
Number of bytes which may be safely written on the channel without blocking. Number of bytes which may be safely written on the channel without blocking.
.SH ERRORS .SH ERRORS
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_channel_window_read_ex(3), .BR libssh2_channel_window_read_ex(3),
.BR libssh2_channel_receive_window_adjust(3) .BR libssh2_channel_receive_window_adjust(3)

2
docs/libssh2_channel_write.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_write_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_write_ex - write data to a channel stream blocking libssh2_channel_write_ex - write data to a channel stream blocking
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_write_stderr.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_write_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_write_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex(3)\fP libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex(3)\fP
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_channel_x11_req.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_x11_req 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_channel_x11_req 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3)\fP calls libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

5
docs/libssh2_channel_x11_req_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_channel_x11_req_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_x11_req_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_channel_x11_req_ex - request an X11 forwarding channel libssh2_channel_x11_req_ex - request an X11 forwarding channel
.SH SYNOPSIS .SH SYNOPSIS
@ -30,19 +30,16 @@ Request an X11 forwarding on \fIchannel\fP. To use X11 forwarding,
.BR libssh2_session_callback_set(3) .BR libssh2_session_callback_set(3)
must first be called to set \fBLIBSSH2_CALLBACK_X11\fP. This callback will be must first be called to set \fBLIBSSH2_CALLBACK_X11\fP. This callback will be
invoked when the remote host accepts the X11 forwarding. invoked when the remote host accepts the X11 forwarding.
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns Return 0 on success or negative on failure. It returns
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
.SH ERRORS .SH ERRORS
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - \fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP -
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_channel_open_ex(3) .BR libssh2_channel_open_ex(3)
.BR libssh2_session_callback_set(3) .BR libssh2_session_callback_set(3)

2
docs/libssh2_crypto_engine.3
View File

@ -1,4 +1,4 @@
.TH libssh2_crypto_engine 3 "22 Nov 2021" "libssh2 1.11" "libssh2 manual" .TH libssh2_crypto_engine 3 "22 Nov 2021" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_crypto_engine - retrieve used crypto engine libssh2_crypto_engine - retrieve used crypto engine
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_exit.3
View File

@ -1,4 +1,4 @@
.TH libssh2_exit 3 "19 Mar 2010" "libssh2 1.2.5" "libssh2 manual" .TH libssh2_exit 3 "19 Mar 2010" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_exit - global library deinitialization libssh2_exit - global library deinitialization
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_free.3
View File

@ -1,4 +1,4 @@
.TH libssh2_free 3 "13 Oct 2010" "libssh2 1.2.8" "libssh2 manual" .TH libssh2_free 3 "13 Oct 2010" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_free - deallocate libssh2 memory libssh2_free - deallocate libssh2 memory
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_hostkey_hash.3
View File

@ -1,4 +1,4 @@
.TH libssh2_hostkey_hash 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_hostkey_hash 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_hostkey_hash - return a hash of the remote host's key libssh2_hostkey_hash - return a hash of the remote host's key
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_init.3
View File

@ -1,4 +1,4 @@
.TH libssh2_init 3 "19 Mar 2010" "libssh2 1.2.5" "libssh2 manual" .TH libssh2_init 3 "19 Mar 2010" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_init - global library initialization libssh2_init - global library initialization
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_keepalive_config.3
View File

@ -1,4 +1,4 @@
.TH libssh2_keepalive_config 3 "12 Apr 2011" "libssh2 1.2.5" "libssh2 manual" .TH libssh2_keepalive_config 3 "12 Apr 2011" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_keepalive_config - short function description libssh2_keepalive_config - short function description
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_keepalive_send.3
View File

@ -1,4 +1,4 @@
.TH libssh2_keepalive_send 3 "13 Apr 2011" "libssh2 1.2.5" "libssh2 manual" .TH libssh2_keepalive_send 3 "13 Apr 2011" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_keepalive_send - short function description libssh2_keepalive_send - short function description
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_add.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009, 2010 by Daniel Stenberg .\" Copyright (c) 2009, 2010 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_add 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_add 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_add - add a known host libssh2_knownhost_add - add a known host
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_addc.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009, 2010 by Daniel Stenberg .\" Copyright (c) 2009, 2010 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_addc 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_addc 3 "28 May 2009" "libssh2 1.2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_addc - add a known host libssh2_knownhost_addc - add a known host
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_check.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daniel Stenberg .\" Copyright (c) 2009 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_check 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_check 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_check - check a host+key against the list of known hosts libssh2_knownhost_check - check a host+key against the list of known hosts
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_checkp.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009-2010 by Daniel Stenberg .\" Copyright (c) 2009-2010 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_checkp 3 "1 May 2010" "libssh2 1.2.6" "libssh2 manual" .TH libssh2_knownhost_checkp 3 "1 May 2010" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_checkp - check a host+key against the list of known hosts libssh2_knownhost_checkp - check a host+key against the list of known hosts
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_del.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daniel Stenberg .\" Copyright (c) 2009 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_del 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_del 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_del - delete a known host entry libssh2_knownhost_del - delete a known host entry
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_free.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daniel Stenberg .\" Copyright (c) 2009 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_free 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_free 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_free - free a collection of known hosts libssh2_knownhost_free - free a collection of known hosts
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_get.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daniel Stenberg .\" Copyright (c) 2009 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_get 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_get 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_get - get a known host off the collection of known hosts libssh2_knownhost_get - get a known host off the collection of known hosts
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_init.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daniel Stenberg .\" Copyright (c) 2009 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_init 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_init 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_init - init a collection of known hosts libssh2_knownhost_init - init a collection of known hosts
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_readfile.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009-2011 by Daniel Stenberg .\" Copyright (c) 2009-2011 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_readfile 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_readfile 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_readfile - parse a file of known hosts libssh2_knownhost_readfile - parse a file of known hosts
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_readline.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daniel Stenberg .\" Copyright (c) 2009 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_readline 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_readline 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_readline - read a known host line libssh2_knownhost_readline - read a known host line
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_writefile.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daniel Stenberg .\" Copyright (c) 2009 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_writefile 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_writefile 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_writefile - write a collection of known hosts to a file libssh2_knownhost_writefile - write a collection of known hosts to a file
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_knownhost_writeline.3
View File

@ -1,7 +1,7 @@
.\" .\"
.\" Copyright (c) 2009 by Daniel Stenberg .\" Copyright (c) 2009 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_writeline 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_writeline 3 "28 May 2009" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_knownhost_writeline - convert a known host to a line for storage libssh2_knownhost_writeline - convert a known host to a line for storage
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_poll.3
View File

@ -1,4 +1,4 @@
.TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" .TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_poll - poll for activity on a socket, channel or listener libssh2_poll - poll for activity on a socket, channel or listener
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_poll_channel_read.3
View File

@ -1,4 +1,4 @@
.TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" .TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_poll_channel_read - check if data is available libssh2_poll_channel_read - check if data is available
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_publickey_add.3
View File

@ -1,4 +1,4 @@
.TH libssh2_publickey_add 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_publickey_add 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP calls libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_publickey_add_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_publickey_add_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_publickey_add_ex 3 "1 Jun 2007" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_publickey_add_ex - Add a public key entry libssh2_publickey_add_ex - Add a public key entry
.SH SYNOPSIS .SH SYNOPSIS

7
docs/libssh2_publickey_init.3
View File

@ -1,13 +1,12 @@
.TH libssh2_publickey_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_publickey_init 3 "1 Jun 2007" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_publickey_init - TODO libssh2_publickey_init - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE
.SH ERRORS .SH ERRORS
.SH AVAILABILITY
Added in libssh2 ?.?.?
.SH SEE ALSO .SH SEE ALSO

7
docs/libssh2_publickey_list_fetch.3
View File

@ -1,13 +1,12 @@
.TH libssh2_publickey_list_fetch 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_publickey_list_fetch 3 "1 Jun 2007" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_publickey_list_fetch - TODO libssh2_publickey_list_fetch - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE
.SH ERRORS .SH ERRORS
.SH AVAILABILITY
Added in libssh2 ?.?.?
.SH SEE ALSO .SH SEE ALSO

7
docs/libssh2_publickey_list_free.3
View File

@ -1,13 +1,12 @@
.TH libssh2_publickey_list_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_publickey_list_free 3 "1 Jun 2007" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_publickey_list_free - TODO libssh2_publickey_list_free - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE
.SH ERRORS .SH ERRORS
.SH AVAILABILITY
Added in libssh2 ?.?.?
.SH SEE ALSO .SH SEE ALSO

2
docs/libssh2_publickey_remove.3
View File

@ -1,4 +1,4 @@
.TH libssh2_publickey_remove 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_publickey_remove 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex(3)\fP calls libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

7
docs/libssh2_publickey_remove_ex.3
View File

@ -1,13 +1,12 @@
.TH libssh2_publickey_list_remove_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_publickey_list_remove_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_publickey_list_remove_ex - TODO libssh2_publickey_list_remove_ex - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE
.SH ERRORS .SH ERRORS
.SH AVAILABILITY
Added in libssh2 ?.?.?
.SH SEE ALSO .SH SEE ALSO

7
docs/libssh2_publickey_shutdown.3
View File

@ -1,13 +1,12 @@
.TH libssh2_publickey_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_publickey_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_publickey_shutdown - TODO libssh2_publickey_shutdown - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE
.SH ERRORS .SH ERRORS
.SH AVAILABILITY
Added in libssh2 ?.?.?
.SH SEE ALSO .SH SEE ALSO

2
docs/libssh2_scp_recv.3
View File

@ -1,4 +1,4 @@
.TH libssh2_scp_recv 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_scp_recv 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_scp_recv - request a remote file via SCP libssh2_scp_recv - request a remote file via SCP
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_scp_recv2.3
View File

@ -1,4 +1,4 @@
.TH libssh2_scp_recv2 3 "29 Jun 2015" "libssh2 1.6.1" "libssh2 manual" .TH libssh2_scp_recv2 3 "29 Jun 2015" "libssh2 1.6.1" "libssh2"
.SH NAME .SH NAME
libssh2_scp_recv2 - request a remote file via SCP libssh2_scp_recv2 - request a remote file via SCP
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_scp_send.3
View File

@ -1,4 +1,4 @@
.TH libssh2_scp_send 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" .TH libssh2_scp_send 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
.SH NAME .SH NAME
libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_scp_send64.3
View File

@ -1,4 +1,4 @@
.TH libssh2_scp_send64 3 "17 Apr 2010" "libssh2 1.2.6" "libssh2 manual" .TH libssh2_scp_send64 3 "17 Apr 2010" "libssh2 1.2.6" "libssh2"
.SH NAME .SH NAME
libssh2_scp_send64 - Send a file via SCP libssh2_scp_send64 - Send a file via SCP
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_scp_send_ex.3
View File

@ -1,4 +1,4 @@
.TH libssh2_scp_send_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_scp_send_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_scp_send_ex - Send a file via SCP libssh2_scp_send_ex - Send a file via SCP
.SH SYNOPSIS .SH SYNOPSIS

4
docs/libssh2_session_abstract.3
View File

@ -1,4 +1,4 @@
.TH libssh2_session_abstract 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_session_abstract 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME .SH NAME
libssh2_session_abstract - return a pointer to a session's abstract pointer libssh2_session_abstract - return a pointer to a session's abstract pointer
.SH SYNOPSIS .SH SYNOPSIS
@ -16,10 +16,8 @@ Return a pointer to where the abstract pointer provided to
\fBlibssh2_session_init_ex(3)\fP is stored. By providing a doubly \fBlibssh2_session_init_ex(3)\fP is stored. By providing a doubly
de-referenced pointer, the internal storage of the session instance may be de-referenced pointer, the internal storage of the session instance may be
modified in place. modified in place.
.SH RETURN VALUE .SH RETURN VALUE
A pointer to session internal storage who's contents point to previously A pointer to session internal storage who's contents point to previously
provided abstract data. provided abstract data.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)

2
docs/libssh2_session_banner_get.3
View File

@ -1,4 +1,4 @@
.TH libssh2_session_banner_get 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual" .TH libssh2_session_banner_get 3 "9 Sep 2011" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_session_banner_get - get the remote banner libssh2_session_banner_get - get the remote banner
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_session_banner_set.3
View File

@ -1,4 +1,4 @@
.TH libssh2_session_banner_set 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual" .TH libssh2_session_banner_set 3 "9 Sep 2011" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_session_banner_set - set the SSH protocol banner for the local client libssh2_session_banner_set - set the SSH protocol banner for the local client
.SH SYNOPSIS .SH SYNOPSIS

2
docs/libssh2_session_block_directions.3
View File

@ -1,4 +1,4 @@
.TH libssh2_session_block_directions 3 "1 Oct 2008" "libssh2 1.0" "libssh2 manual" .TH libssh2_session_block_directions 3 "1 Oct 2008" "libssh2" "libssh2"
.SH NAME .SH NAME
libssh2_session_block_directions - get directions to wait for libssh2_session_block_directions - get directions to wait for
.SH SYNOPSIS .SH SYNOPSIS

Some files were not shown because too many files have changed in this diff Show More