diff --git a/docs/libssh2_agent_connect.3 b/docs/libssh2_agent_connect.3 index 491ca06d..07c683de 100644 --- a/docs/libssh2_agent_connect.3 +++ b/docs/libssh2_agent_connect.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_agent_connect - connect to an ssh-agent .SH SYNOPSIS diff --git a/docs/libssh2_agent_disconnect.3 b/docs/libssh2_agent_disconnect.3 index 41eb1d40..b87a4b1b 100644 --- a/docs/libssh2_agent_disconnect.3 +++ b/docs/libssh2_agent_disconnect.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_agent_disconnect - close a connection to an ssh-agent .SH SYNOPSIS diff --git a/docs/libssh2_agent_free.3 b/docs/libssh2_agent_free.3 index 2f18cc8d..3df9632a 100644 --- a/docs/libssh2_agent_free.3 +++ b/docs/libssh2_agent_free.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_agent_free - free an ssh-agent handle .SH SYNOPSIS diff --git a/docs/libssh2_agent_get_identity.3 b/docs/libssh2_agent_get_identity.3 index c4a33fa9..0663ae6d 100644 --- a/docs/libssh2_agent_get_identity.3 +++ b/docs/libssh2_agent_get_identity.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_agent_get_identity - get a public key off the collection of public keys managed by ssh-agent .SH SYNOPSIS diff --git a/docs/libssh2_agent_get_identity_path.3 b/docs/libssh2_agent_get_identity_path.3 index 748995da..6b296ec7 100644 --- a/docs/libssh2_agent_get_identity_path.3 +++ b/docs/libssh2_agent_get_identity_path.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_agent_get_identity_path - gets the custom ssh-agent socket path .SH SYNOPSIS diff --git a/docs/libssh2_agent_init.3 b/docs/libssh2_agent_init.3 index 4b25508f..352a73a7 100644 --- a/docs/libssh2_agent_init.3 +++ b/docs/libssh2_agent_init.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_agent_init - init an ssh-agent handle .SH SYNOPSIS diff --git a/docs/libssh2_agent_list_identities.3 b/docs/libssh2_agent_list_identities.3 index e1d7c40d..4e1b3a78 100644 --- a/docs/libssh2_agent_list_identities.3 +++ b/docs/libssh2_agent_list_identities.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_agent_list_identities - request an ssh-agent to list of public keys. .SH SYNOPSIS diff --git a/docs/libssh2_agent_set_identity_path.3 b/docs/libssh2_agent_set_identity_path.3 index 6ee42599..6097bc4e 100644 --- a/docs/libssh2_agent_set_identity_path.3 +++ b/docs/libssh2_agent_set_identity_path.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_agent_set_identity_path - set an ssh-agent socket path on disk .SH SYNOPSIS diff --git a/docs/libssh2_agent_sign.3 b/docs/libssh2_agent_sign.3 index 670e5940..95bf44bb 100644 --- a/docs/libssh2_agent_sign.3 +++ b/docs/libssh2_agent_sign.3 @@ -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 libssh2_agent_sign - sign data, with the help of ssh-agent .SH SYNOPSIS diff --git a/docs/libssh2_agent_userauth.3 b/docs/libssh2_agent_userauth.3 index 0eeea004..b0e77962 100644 --- a/docs/libssh2_agent_userauth.3 +++ b/docs/libssh2_agent_userauth.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_agent_userauth - authenticate a session with a public key, with the help of ssh-agent .SH SYNOPSIS diff --git a/docs/libssh2_banner_set.3 b/docs/libssh2_banner_set.3 index c6e874de..c443d8f1 100644 --- a/docs/libssh2_banner_set.3 +++ b/docs/libssh2_banner_set.3 @@ -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 libssh2_banner_set - set the SSH protocol banner for the local client .SH SYNOPSIS diff --git a/docs/libssh2_base64_decode.3 b/docs/libssh2_base64_decode.3 index c05fbec3..8856f220 100644 --- a/docs/libssh2_base64_decode.3 +++ b/docs/libssh2_base64_decode.3 @@ -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 libssh2_base64_decode - decode a base64 encoded string .SH SYNOPSIS diff --git a/docs/libssh2_channel_close.3 b/docs/libssh2_channel_close.3 index 1c6ef6f9..abc1619c 100644 --- a/docs/libssh2_channel_close.3 +++ b/docs/libssh2_channel_close.3 @@ -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 libssh2_channel_close - close a channel .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 connection as well, follow this command with .BR libssh2_channel_wait_closed(3) - .SH 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 isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. - .SH SEE ALSO .BR libssh2_channel_open_ex(3) diff --git a/docs/libssh2_channel_direct_streamlocal_ex.3 b/docs/libssh2_channel_direct_streamlocal_ex.3 index c28f68d7..f737afa0 100644 --- a/docs/libssh2_channel_direct_streamlocal_ex.3 +++ b/docs/libssh2_channel_direct_streamlocal_ex.3 @@ -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 libssh2_channel_direct_streamlocal_ex - Tunnel a UNIX socket connection through an SSH session .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 encrypted, communication from the server to the 3rd party host travels in cleartext. - .SH RETURN VALUE Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. .SH ERRORS diff --git a/docs/libssh2_channel_direct_tcpip.3 b/docs/libssh2_channel_direct_tcpip.3 index 81c495df..45d2aca0 100644 --- a/docs/libssh2_channel_direct_tcpip.3 +++ b/docs/libssh2_channel_direct_tcpip.3 @@ -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 libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_tcpip_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_direct_tcpip_ex.3 b/docs/libssh2_channel_direct_tcpip_ex.3 index 22963599..e22f400d 100644 --- a/docs/libssh2_channel_direct_tcpip_ex.3 +++ b/docs/libssh2_channel_direct_tcpip_ex.3 @@ -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 libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session .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 encrypted, communication from the server to the 3rd party host travels in cleartext. - .SH RETURN VALUE Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. .SH ERRORS diff --git a/docs/libssh2_channel_eof.3 b/docs/libssh2_channel_eof.3 index d948eece..94e3ebe3 100644 --- a/docs/libssh2_channel_eof.3 +++ b/docs/libssh2_channel_eof.3 @@ -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 libssh2_channel_eof - check a channel's EOF status .SH SYNOPSIS diff --git a/docs/libssh2_channel_exec.3 b/docs/libssh2_channel_exec.3 index 312372cd..723fda4d 100644 --- a/docs/libssh2_channel_exec.3 +++ b/docs/libssh2_channel_exec.3 @@ -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 libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_flush.3 b/docs/libssh2_channel_flush.3 index 3e9c4fd0..49bc03d7 100644 --- a/docs/libssh2_channel_flush.3 +++ b/docs/libssh2_channel_flush.3 @@ -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 libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_flush_ex.3 b/docs/libssh2_channel_flush_ex.3 index af5c48d3..6e7b167e 100644 --- a/docs/libssh2_channel_flush_ex.3 +++ b/docs/libssh2_channel_flush_ex.3 @@ -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 libssh2_channel_flush_ex - flush a channel .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 be flushed by number or using one of the provided macros. - .SH RETURN VALUE Return the number of bytes flushed or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While diff --git a/docs/libssh2_channel_flush_stderr.3 b/docs/libssh2_channel_flush_stderr.3 index b211c1b1..c758351f 100644 --- a/docs/libssh2_channel_flush_stderr.3 +++ b/docs/libssh2_channel_flush_stderr.3 @@ -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 libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_forward_accept.3 b/docs/libssh2_channel_forward_accept.3 index fdf82a85..7f78505d 100644 --- a/docs/libssh2_channel_forward_accept.3 +++ b/docs/libssh2_channel_forward_accept.3 @@ -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 libssh2_channel_forward_accept - accept a queued connection .SH SYNOPSIS diff --git a/docs/libssh2_channel_forward_cancel.3 b/docs/libssh2_channel_forward_cancel.3 index 5663c0ab..55cb287b 100644 --- a/docs/libssh2_channel_forward_cancel.3 +++ b/docs/libssh2_channel_forward_cancel.3 @@ -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 libssh2_channel_forward_cancel - cancel a forwarded TCP port .SH SYNOPSIS @@ -13,16 +13,13 @@ libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener); .BR libssh2_channel_forward_listen_ex(3) Instruct the remote host to stop listening for new connections on a previously requested host/port. - .SH 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 isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. - .SH SEE ALSO .BR libssh2_channel_forward_listen_ex(3) diff --git a/docs/libssh2_channel_forward_listen.3 b/docs/libssh2_channel_forward_listen.3 index a5494a6d..d471a7cf 100644 --- a/docs/libssh2_channel_forward_listen.3 +++ b/docs/libssh2_channel_forward_listen.3 @@ -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 libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forward_listen_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_forward_listen_ex.3 b/docs/libssh2_channel_forward_listen_ex.3 index 14f598af..9852d0bd 100644 --- a/docs/libssh2_channel_forward_listen_ex.3 +++ b/docs/libssh2_channel_forward_listen_ex.3 @@ -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 libssh2_channel_forward_listen_ex - listen to inbound connections .SH SYNOPSIS diff --git a/docs/libssh2_channel_free.3 b/docs/libssh2_channel_free.3 index d0ded798..8e63845e 100644 --- a/docs/libssh2_channel_free.3 +++ b/docs/libssh2_channel_free.3 @@ -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 libssh2_channel_free - free all resources associated with a channel .SH SYNOPSIS @@ -16,11 +16,9 @@ not yet been closed with .BR libssh2_channel_close(3) , it will be called automatically so that the remote end may know that it can safely free its own resources. - .SH 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 isn't really a failure per se. - .SH SEE ALSO .BR libssh2_channel_close(3) diff --git a/docs/libssh2_channel_get_exit_signal.3 b/docs/libssh2_channel_get_exit_signal.3 index d2b46c71..2f74edcb 100644 --- a/docs/libssh2_channel_get_exit_signal.3 +++ b/docs/libssh2_channel_get_exit_signal.3 @@ -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 libssh2_channel_get_exit_signal - get the remote exit signal .SH SYNOPSIS @@ -33,6 +33,5 @@ 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. - .SH RETURN VALUE Numeric error code corresponding to the the Error Code constants. diff --git a/docs/libssh2_channel_get_exit_status.3 b/docs/libssh2_channel_get_exit_status.3 index e619bc8b..3357bba3 100644 --- a/docs/libssh2_channel_get_exit_status.3 +++ b/docs/libssh2_channel_get_exit_status.3 @@ -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 libssh2_channel_get_exit_status - get the remote exit code .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 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. - .SH RETURN VALUE Returns 0 on failure, otherwise the \fIExit Status\fP reported by remote host diff --git a/docs/libssh2_channel_handle_extended_data.3 b/docs/libssh2_channel_handle_extended_data.3 index 8adc6cb9..5fe06bc7 100644 --- a/docs/libssh2_channel_handle_extended_data.3 +++ b/docs/libssh2_channel_handle_extended_data.3 @@ -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 libssh2_channel_handle_extended_data - set extended data handling mode .SH SYNOPSIS diff --git a/docs/libssh2_channel_handle_extended_data2.3 b/docs/libssh2_channel_handle_extended_data2.3 index 0988873b..62c08281 100644 --- a/docs/libssh2_channel_handle_extended_data2.3 +++ b/docs/libssh2_channel_handle_extended_data2.3 @@ -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 libssh2_channel_handle_extended_data2 - set extended data handling mode .SH SYNOPSIS @@ -28,10 +28,8 @@ arrives. Change how a channel deals with extended data packets. By default all extended data is queued until read by .BR libssh2_channel_read_ex(3) - .SH RETURN VALUE Return 0 on success or LIBSSH2_ERROR_EAGAIN when it would otherwise block. - .SH SEE ALSO .BR libssh2_channel_handle_extended_data(3) .BR libssh2_channel_read_ex(3) diff --git a/docs/libssh2_channel_ignore_extended_data.3 b/docs/libssh2_channel_ignore_extended_data.3 index 5f49abba..09ff2579 100644 --- a/docs/libssh2_channel_ignore_extended_data.3 +++ b/docs/libssh2_channel_ignore_extended_data.3 @@ -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 libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_handle_extended_data(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_open_ex.3 b/docs/libssh2_channel_open_ex.3 index f978675e..0b203c2c 100644 --- a/docs/libssh2_channel_open_ex.3 +++ b/docs/libssh2_channel_open_ex.3 @@ -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 libssh2_channel_open_ex - establish a generic session channel .SH SYNOPSIS @@ -42,10 +42,8 @@ or via .BR libssh2_channel_direct_tcpip(3) or .BR libssh2_channel_forward_listen(3) - .SH RETURN VALUE Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. - .SH ERRORS \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_EAGAIN\fP - Marked for non-blocking I/O but the call would block. - .SH SEE ALSO Add related functions diff --git a/docs/libssh2_channel_open_session.3 b/docs/libssh2_channel_open_session.3 index 83e5e620..f63c8c79 100644 --- a/docs/libssh2_channel_open_session.3 +++ b/docs/libssh2_channel_open_session.3 @@ -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 libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_process_startup.3 b/docs/libssh2_channel_process_startup.3 index e1cf436c..1237e489 100644 --- a/docs/libssh2_channel_process_startup.3 +++ b/docs/libssh2_channel_process_startup.3 @@ -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 libssh2_channel_process_startup - request a shell on a channel .SH SYNOPSIS diff --git a/docs/libssh2_channel_read.3 b/docs/libssh2_channel_read.3 index 80966e28..c7f72a6c 100644 --- a/docs/libssh2_channel_read.3 +++ b/docs/libssh2_channel_read.3 @@ -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 libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_read_ex.3 b/docs/libssh2_channel_read_ex.3 index 7f895999..fed03f90 100644 --- a/docs/libssh2_channel_read_ex.3 +++ b/docs/libssh2_channel_read_ex.3 @@ -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 libssh2_channel_read_ex - read data from a channel stream .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_CHANNEL_CLOSED\fP - The channel has been closed. - .SH SEE ALSO .BR libssh2_poll_channel_read(3) diff --git a/docs/libssh2_channel_read_stderr.3 b/docs/libssh2_channel_read_stderr.3 index e23e47b4..ef1f8fe4 100644 --- a/docs/libssh2_channel_read_stderr.3 +++ b/docs/libssh2_channel_read_stderr.3 @@ -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 libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_receive_window_adjust.3 b/docs/libssh2_channel_receive_window_adjust.3 index 731558fc..8f7c1d79 100644 --- a/docs/libssh2_channel_receive_window_adjust.3 +++ b/docs/libssh2_channel_receive_window_adjust.3 @@ -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 libssh2_channel_receive_window_adjust - adjust the channel window .SH SYNOPSIS diff --git a/docs/libssh2_channel_receive_window_adjust2.3 b/docs/libssh2_channel_receive_window_adjust2.3 index e4681f78..777307bf 100644 --- a/docs/libssh2_channel_receive_window_adjust2.3 +++ b/docs/libssh2_channel_receive_window_adjust2.3 @@ -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 libssh2_channel_receive_window_adjust2 - adjust the channel window .SH SYNOPSIS diff --git a/docs/libssh2_channel_request_auth_agent.3 b/docs/libssh2_channel_request_auth_agent.3 index 22f988d6..8ac65972 100644 --- a/docs/libssh2_channel_request_auth_agent.3 +++ b/docs/libssh2_channel_request_auth_agent.3 @@ -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 libssh2_channel_request_auth_agent - request agent forwarding for a session .SH SYNOPSIS @@ -16,7 +16,6 @@ for the duration of the SSH session. \fIchannel\fP - Previously opened channel instance such as returned by .BR libssh2_channel_open_ex(3) - .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While diff --git a/docs/libssh2_channel_request_pty.3 b/docs/libssh2_channel_request_pty.3 index 4adb846a..06e9f480 100644 --- a/docs/libssh2_channel_request_pty.3 +++ b/docs/libssh2_channel_request_pty.3 @@ -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 libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_pty_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_request_pty_ex.3 b/docs/libssh2_channel_request_pty_ex.3 index 933cdf2f..4186da2e 100644 --- a/docs/libssh2_channel_request_pty_ex.3 +++ b/docs/libssh2_channel_request_pty_ex.3 @@ -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 libssh2_channel_request_pty_ex - short function description .SH SYNOPSIS diff --git a/docs/libssh2_channel_request_pty_size.3 b/docs/libssh2_channel_request_pty_size.3 index fd58bd36..347f6408 100644 --- a/docs/libssh2_channel_request_pty_size.3 +++ b/docs/libssh2_channel_request_pty_size.3 @@ -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 libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_request_pty_size_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_request_pty_size_ex.3 b/docs/libssh2_channel_request_pty_size_ex.3 index ca172a14..0624c752 100644 --- a/docs/libssh2_channel_request_pty_size_ex.3 +++ b/docs/libssh2_channel_request_pty_size_ex.3 @@ -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 libssh2_channel_request_pty_size_ex - TODO .SH SYNOPSIS .nf .fi .SH DESCRIPTION - .SH RETURN VALUE - .SH ERRORS - .SH SEE ALSO diff --git a/docs/libssh2_channel_send_eof.3 b/docs/libssh2_channel_send_eof.3 index 6dc02860..5e26b026 100644 --- a/docs/libssh2_channel_send_eof.3 +++ b/docs/libssh2_channel_send_eof.3 @@ -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 libssh2_channel_send_eof - send EOF to remote server .SH SYNOPSIS @@ -11,15 +11,12 @@ libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel); .SH DESCRIPTION Tell the remote host that no further data will be sent on the specified channel. Processes typically interpret this as a closed stdin descriptor. - .SH 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 isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. - .SH SEE ALSO .BR libssh2_channel_wait_eof(3) .BR libssh2_channel_eof(3) diff --git a/docs/libssh2_channel_set_blocking.3 b/docs/libssh2_channel_set_blocking.3 index 4c61b14a..18dd6067 100644 --- a/docs/libssh2_channel_set_blocking.3 +++ b/docs/libssh2_channel_set_blocking.3 @@ -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 libssh2_channel_set_blocking - set or clear blocking mode on channel .SH SYNOPSIS diff --git a/docs/libssh2_channel_setenv.3 b/docs/libssh2_channel_setenv.3 index e9d553b7..986eea30 100644 --- a/docs/libssh2_channel_setenv.3 +++ b/docs/libssh2_channel_setenv.3 @@ -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 libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_setenv_ex.3 b/docs/libssh2_channel_setenv_ex.3 index c01b94b0..57e8f9d2 100644 --- a/docs/libssh2_channel_setenv_ex.3 +++ b/docs/libssh2_channel_setenv_ex.3 @@ -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 libssh2_channel_setenv_ex - set an environment variable on the channel .SH SYNOPSIS diff --git a/docs/libssh2_channel_shell.3 b/docs/libssh2_channel_shell.3 index bbff5b69..22438ccc 100644 --- a/docs/libssh2_channel_shell.3 +++ b/docs/libssh2_channel_shell.3 @@ -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 libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_signal_ex.3 b/docs/libssh2_channel_signal_ex.3 index 236657e3..d54de075 100644 --- a/docs/libssh2_channel_signal_ex.3 +++ b/docs/libssh2_channel_signal_ex.3 @@ -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 libssh2_channel_signal_ex -- Send a signal to process previously opened on channel. .SH SYNOPSIS @@ -23,10 +23,8 @@ message. \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) diff --git a/docs/libssh2_channel_subsystem.3 b/docs/libssh2_channel_subsystem.3 index 6f3b8bcd..aecdbfb3 100644 --- a/docs/libssh2_channel_subsystem.3 +++ b/docs/libssh2_channel_subsystem.3 @@ -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 libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_wait_closed.3 b/docs/libssh2_channel_wait_closed.3 index cbd242f9..4797b9c3 100644 --- a/docs/libssh2_channel_wait_closed.3 +++ b/docs/libssh2_channel_wait_closed.3 @@ -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 libssh2_channel_wait_closed - wait for the remote to close the channel .SH SYNOPSIS diff --git a/docs/libssh2_channel_wait_eof.3 b/docs/libssh2_channel_wait_eof.3 index 777f9f55..44708bc9 100644 --- a/docs/libssh2_channel_wait_eof.3 +++ b/docs/libssh2_channel_wait_eof.3 @@ -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 libssh2_channel_wait_eof - wait for the remote to reply to an EOF request .SH SYNOPSIS diff --git a/docs/libssh2_channel_window_read.3 b/docs/libssh2_channel_window_read.3 index 41efb4c8..a4c00e01 100644 --- a/docs/libssh2_channel_window_read.3 +++ b/docs/libssh2_channel_window_read.3 @@ -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 libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_read_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_window_read_ex.3 b/docs/libssh2_channel_window_read_ex.3 index f5cdab35..cbb5dd30 100644 --- a/docs/libssh2_channel_window_read_ex.3 +++ b/docs/libssh2_channel_window_read_ex.3 @@ -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 libssh2_channel_window_read_ex - Check the status of the read window .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 window limit .SH ERRORS - .SH SEE ALSO .BR libssh2_channel_receive_window_adjust(3), .BR libssh2_channel_window_write_ex(3) diff --git a/docs/libssh2_channel_window_write.3 b/docs/libssh2_channel_window_write.3 index 61815eb0..80721b77 100644 --- a/docs/libssh2_channel_window_write.3 +++ b/docs/libssh2_channel_window_write.3 @@ -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 libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_write_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_window_write_ex.3 b/docs/libssh2_channel_window_write_ex.3 index 2803d5b8..13e02970 100644 --- a/docs/libssh2_channel_window_write_ex.3 +++ b/docs/libssh2_channel_window_write_ex.3 @@ -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 libssh2_channel_window_write_ex - Check the status of the write window .SH SYNOPSIS @@ -17,7 +17,6 @@ the channel_open request .SH RETURN VALUE Number of bytes which may be safely written on the channel without blocking. .SH ERRORS - .SH SEE ALSO .BR libssh2_channel_window_read_ex(3), .BR libssh2_channel_receive_window_adjust(3) diff --git a/docs/libssh2_channel_write.3 b/docs/libssh2_channel_write.3 index dd463be2..234eb00c 100644 --- a/docs/libssh2_channel_write.3 +++ b/docs/libssh2_channel_write.3 @@ -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 libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP .SH SYNOPSIS diff --git a/docs/libssh2_channel_write_ex.3 b/docs/libssh2_channel_write_ex.3 index 0abf3c12..467b983b 100644 --- a/docs/libssh2_channel_write_ex.3 +++ b/docs/libssh2_channel_write_ex.3 @@ -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 libssh2_channel_write_ex - write data to a channel stream blocking .SH SYNOPSIS diff --git a/docs/libssh2_channel_write_stderr.3 b/docs/libssh2_channel_write_stderr.3 index 89a60883..661bad48 100644 --- a/docs/libssh2_channel_write_stderr.3 +++ b/docs/libssh2_channel_write_stderr.3 @@ -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 libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex(3)\fP .SH SYNOPSIS diff --git a/docs/libssh2_channel_x11_req.3 b/docs/libssh2_channel_x11_req.3 index dfd71aac..8181a257 100644 --- a/docs/libssh2_channel_x11_req.3 +++ b/docs/libssh2_channel_x11_req.3 @@ -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 libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_channel_x11_req_ex.3 b/docs/libssh2_channel_x11_req_ex.3 index 32121e18..36c5d1e9 100644 --- a/docs/libssh2_channel_x11_req_ex.3 +++ b/docs/libssh2_channel_x11_req_ex.3 @@ -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 libssh2_channel_x11_req_ex - request an X11 forwarding channel .SH SYNOPSIS @@ -30,19 +30,16 @@ Request an X11 forwarding on \fIchannel\fP. To use X11 forwarding, .BR libssh2_session_callback_set(3) must first be called to set \fBLIBSSH2_CALLBACK_X11\fP. This callback will be invoked when the remote host accepts the X11 forwarding. - .SH 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 isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - - .SH SEE ALSO .BR libssh2_channel_open_ex(3) .BR libssh2_session_callback_set(3) diff --git a/docs/libssh2_crypto_engine.3 b/docs/libssh2_crypto_engine.3 index c1d95eaf..58a39bcb 100644 --- a/docs/libssh2_crypto_engine.3 +++ b/docs/libssh2_crypto_engine.3 @@ -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 libssh2_crypto_engine - retrieve used crypto engine .SH SYNOPSIS diff --git a/docs/libssh2_exit.3 b/docs/libssh2_exit.3 index cfab6518..9f8f8438 100644 --- a/docs/libssh2_exit.3 +++ b/docs/libssh2_exit.3 @@ -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 libssh2_exit - global library deinitialization .SH SYNOPSIS diff --git a/docs/libssh2_free.3 b/docs/libssh2_free.3 index db494e7d..a057f800 100644 --- a/docs/libssh2_free.3 +++ b/docs/libssh2_free.3 @@ -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 libssh2_free - deallocate libssh2 memory .SH SYNOPSIS diff --git a/docs/libssh2_hostkey_hash.3 b/docs/libssh2_hostkey_hash.3 index 663a00f8..27eebdf3 100644 --- a/docs/libssh2_hostkey_hash.3 +++ b/docs/libssh2_hostkey_hash.3 @@ -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 libssh2_hostkey_hash - return a hash of the remote host's key .SH SYNOPSIS diff --git a/docs/libssh2_init.3 b/docs/libssh2_init.3 index 0adff7ba..cebd5192 100644 --- a/docs/libssh2_init.3 +++ b/docs/libssh2_init.3 @@ -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 libssh2_init - global library initialization .SH SYNOPSIS diff --git a/docs/libssh2_keepalive_config.3 b/docs/libssh2_keepalive_config.3 index 698befa7..584b03ec 100644 --- a/docs/libssh2_keepalive_config.3 +++ b/docs/libssh2_keepalive_config.3 @@ -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 libssh2_keepalive_config - short function description .SH SYNOPSIS diff --git a/docs/libssh2_keepalive_send.3 b/docs/libssh2_keepalive_send.3 index 78221efe..1eef17b2 100644 --- a/docs/libssh2_keepalive_send.3 +++ b/docs/libssh2_keepalive_send.3 @@ -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 libssh2_keepalive_send - short function description .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_add.3 b/docs/libssh2_knownhost_add.3 index 79ea8b78..7100741b 100644 --- a/docs/libssh2_knownhost_add.3 +++ b/docs/libssh2_knownhost_add.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_add - add a known host .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_addc.3 b/docs/libssh2_knownhost_addc.3 index e1575e6b..30fc9bc3 100644 --- a/docs/libssh2_knownhost_addc.3 +++ b/docs/libssh2_knownhost_addc.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_addc - add a known host .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_check.3 b/docs/libssh2_knownhost_check.3 index 36496459..2524e956 100644 --- a/docs/libssh2_knownhost_check.3 +++ b/docs/libssh2_knownhost_check.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_check - check a host+key against the list of known hosts .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_checkp.3 b/docs/libssh2_knownhost_checkp.3 index 92e1403f..6c481011 100644 --- a/docs/libssh2_knownhost_checkp.3 +++ b/docs/libssh2_knownhost_checkp.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_checkp - check a host+key against the list of known hosts .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_del.3 b/docs/libssh2_knownhost_del.3 index d7cbeff9..f280f9eb 100644 --- a/docs/libssh2_knownhost_del.3 +++ b/docs/libssh2_knownhost_del.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_del - delete a known host entry .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_free.3 b/docs/libssh2_knownhost_free.3 index 01ea209a..ee600ed0 100644 --- a/docs/libssh2_knownhost_free.3 +++ b/docs/libssh2_knownhost_free.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_free - free a collection of known hosts .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_get.3 b/docs/libssh2_knownhost_get.3 index 8a20b429..dff6179c 100644 --- a/docs/libssh2_knownhost_get.3 +++ b/docs/libssh2_knownhost_get.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_get - get a known host off the collection of known hosts .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_init.3 b/docs/libssh2_knownhost_init.3 index 159c7aac..0b903be1 100644 --- a/docs/libssh2_knownhost_init.3 +++ b/docs/libssh2_knownhost_init.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_init - init a collection of known hosts .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_readfile.3 b/docs/libssh2_knownhost_readfile.3 index 3bc678e5..590c546d 100644 --- a/docs/libssh2_knownhost_readfile.3 +++ b/docs/libssh2_knownhost_readfile.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_readfile - parse a file of known hosts .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_readline.3 b/docs/libssh2_knownhost_readline.3 index eb43c79f..88e57365 100644 --- a/docs/libssh2_knownhost_readline.3 +++ b/docs/libssh2_knownhost_readline.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_readline - read a known host line .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_writefile.3 b/docs/libssh2_knownhost_writefile.3 index 0457ecef..bbe772fb 100644 --- a/docs/libssh2_knownhost_writefile.3 +++ b/docs/libssh2_knownhost_writefile.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_writefile - write a collection of known hosts to a file .SH SYNOPSIS diff --git a/docs/libssh2_knownhost_writeline.3 b/docs/libssh2_knownhost_writeline.3 index 4a0cbfc3..95f57a60 100644 --- a/docs/libssh2_knownhost_writeline.3 +++ b/docs/libssh2_knownhost_writeline.3 @@ -1,7 +1,7 @@ .\" .\" 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 libssh2_knownhost_writeline - convert a known host to a line for storage .SH SYNOPSIS diff --git a/docs/libssh2_poll.3 b/docs/libssh2_poll.3 index 34cef037..be6eac09 100644 --- a/docs/libssh2_poll.3 +++ b/docs/libssh2_poll.3 @@ -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 libssh2_poll - poll for activity on a socket, channel or listener .SH SYNOPSIS diff --git a/docs/libssh2_poll_channel_read.3 b/docs/libssh2_poll_channel_read.3 index 45d5702d..7e4e9596 100644 --- a/docs/libssh2_poll_channel_read.3 +++ b/docs/libssh2_poll_channel_read.3 @@ -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 libssh2_poll_channel_read - check if data is available .SH SYNOPSIS diff --git a/docs/libssh2_publickey_add.3 b/docs/libssh2_publickey_add.3 index d967a715..dc537636 100644 --- a/docs/libssh2_publickey_add.3 +++ b/docs/libssh2_publickey_add.3 @@ -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 libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_publickey_add_ex.3 b/docs/libssh2_publickey_add_ex.3 index 5499b11a..8d397b7e 100644 --- a/docs/libssh2_publickey_add_ex.3 +++ b/docs/libssh2_publickey_add_ex.3 @@ -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 libssh2_publickey_add_ex - Add a public key entry .SH SYNOPSIS diff --git a/docs/libssh2_publickey_init.3 b/docs/libssh2_publickey_init.3 index 2bf3d062..4e4f1e52 100644 --- a/docs/libssh2_publickey_init.3 +++ b/docs/libssh2_publickey_init.3 @@ -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 libssh2_publickey_init - TODO .SH SYNOPSIS .nf .fi .SH DESCRIPTION - .SH RETURN VALUE - .SH ERRORS - +.SH AVAILABILITY +Added in libssh2 ?.?.? .SH SEE ALSO diff --git a/docs/libssh2_publickey_list_fetch.3 b/docs/libssh2_publickey_list_fetch.3 index f38d494f..8c95d079 100644 --- a/docs/libssh2_publickey_list_fetch.3 +++ b/docs/libssh2_publickey_list_fetch.3 @@ -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 libssh2_publickey_list_fetch - TODO .SH SYNOPSIS .nf .fi .SH DESCRIPTION - .SH RETURN VALUE - .SH ERRORS - +.SH AVAILABILITY +Added in libssh2 ?.?.? .SH SEE ALSO diff --git a/docs/libssh2_publickey_list_free.3 b/docs/libssh2_publickey_list_free.3 index 3761c128..1a4bb49d 100644 --- a/docs/libssh2_publickey_list_free.3 +++ b/docs/libssh2_publickey_list_free.3 @@ -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 libssh2_publickey_list_free - TODO .SH SYNOPSIS .nf .fi .SH DESCRIPTION - .SH RETURN VALUE - .SH ERRORS - +.SH AVAILABILITY +Added in libssh2 ?.?.? .SH SEE ALSO diff --git a/docs/libssh2_publickey_remove.3 b/docs/libssh2_publickey_remove.3 index 9295806d..6942d0dd 100644 --- a/docs/libssh2_publickey_remove.3 +++ b/docs/libssh2_publickey_remove.3 @@ -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 libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_publickey_remove_ex.3 b/docs/libssh2_publickey_remove_ex.3 index a83ee2d0..5d09343a 100644 --- a/docs/libssh2_publickey_remove_ex.3 +++ b/docs/libssh2_publickey_remove_ex.3 @@ -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 libssh2_publickey_list_remove_ex - TODO .SH SYNOPSIS .nf .fi .SH DESCRIPTION - .SH RETURN VALUE - .SH ERRORS - +.SH AVAILABILITY +Added in libssh2 ?.?.? .SH SEE ALSO diff --git a/docs/libssh2_publickey_shutdown.3 b/docs/libssh2_publickey_shutdown.3 index 8eabf633..86c51bef 100644 --- a/docs/libssh2_publickey_shutdown.3 +++ b/docs/libssh2_publickey_shutdown.3 @@ -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 libssh2_publickey_shutdown - TODO .SH SYNOPSIS .nf .fi .SH DESCRIPTION - .SH RETURN VALUE - .SH ERRORS - +.SH AVAILABILITY +Added in libssh2 ?.?.? .SH SEE ALSO diff --git a/docs/libssh2_scp_recv.3 b/docs/libssh2_scp_recv.3 index 607d49ae..7d194d46 100644 --- a/docs/libssh2_scp_recv.3 +++ b/docs/libssh2_scp_recv.3 @@ -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 libssh2_scp_recv - request a remote file via SCP .SH SYNOPSIS diff --git a/docs/libssh2_scp_recv2.3 b/docs/libssh2_scp_recv2.3 index 06c88d6b..4d763fc2 100644 --- a/docs/libssh2_scp_recv2.3 +++ b/docs/libssh2_scp_recv2.3 @@ -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 libssh2_scp_recv2 - request a remote file via SCP .SH SYNOPSIS diff --git a/docs/libssh2_scp_send.3 b/docs/libssh2_scp_send.3 index 65477c46..678b6e98 100644 --- a/docs/libssh2_scp_send.3 +++ b/docs/libssh2_scp_send.3 @@ -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 libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_scp_send64.3 b/docs/libssh2_scp_send64.3 index 53b6d5c4..df63b7e4 100644 --- a/docs/libssh2_scp_send64.3 +++ b/docs/libssh2_scp_send64.3 @@ -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 libssh2_scp_send64 - Send a file via SCP .SH SYNOPSIS diff --git a/docs/libssh2_scp_send_ex.3 b/docs/libssh2_scp_send_ex.3 index cb4d362e..9926d383 100644 --- a/docs/libssh2_scp_send_ex.3 +++ b/docs/libssh2_scp_send_ex.3 @@ -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 libssh2_scp_send_ex - Send a file via SCP .SH SYNOPSIS diff --git a/docs/libssh2_session_abstract.3 b/docs/libssh2_session_abstract.3 index a28bff64..7f82b6e5 100644 --- a/docs/libssh2_session_abstract.3 +++ b/docs/libssh2_session_abstract.3 @@ -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 libssh2_session_abstract - return a pointer to a session's abstract pointer .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 de-referenced pointer, the internal storage of the session instance may be modified in place. - .SH RETURN VALUE A pointer to session internal storage who's contents point to previously provided abstract data. - .SH SEE ALSO .BR libssh2_session_init_ex(3) diff --git a/docs/libssh2_session_banner_get.3 b/docs/libssh2_session_banner_get.3 index f1097b3c..9e5a23df 100644 --- a/docs/libssh2_session_banner_get.3 +++ b/docs/libssh2_session_banner_get.3 @@ -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 libssh2_session_banner_get - get the remote banner .SH SYNOPSIS diff --git a/docs/libssh2_session_banner_set.3 b/docs/libssh2_session_banner_set.3 index bcb79235..2ba53cae 100644 --- a/docs/libssh2_session_banner_set.3 +++ b/docs/libssh2_session_banner_set.3 @@ -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 libssh2_session_banner_set - set the SSH protocol banner for the local client .SH SYNOPSIS diff --git a/docs/libssh2_session_block_directions.3 b/docs/libssh2_session_block_directions.3 index 0c40eaf1..def9c771 100644 --- a/docs/libssh2_session_block_directions.3 +++ b/docs/libssh2_session_block_directions.3 @@ -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 libssh2_session_block_directions - get directions to wait for .SH SYNOPSIS diff --git a/docs/libssh2_session_callback_set.3 b/docs/libssh2_session_callback_set.3 index 861b320e..ed578b40 100644 --- a/docs/libssh2_session_callback_set.3 +++ b/docs/libssh2_session_callback_set.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_callback_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_callback_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_callback_set - set a callback function .SH SYNOPSIS diff --git a/docs/libssh2_session_disconnect.3 b/docs/libssh2_session_disconnect.3 index 63b08725..1af247bb 100644 --- a/docs/libssh2_session_disconnect.3 +++ b/docs/libssh2_session_disconnect.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_disconnect 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_session_disconnect 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_session_disconnect - convenience macro for \fIlibssh2_session_disconnect_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_session_disconnect_ex.3 b/docs/libssh2_session_disconnect_ex.3 index 35eb8d78..961791de 100644 --- a/docs/libssh2_session_disconnect_ex.3 +++ b/docs/libssh2_session_disconnect_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_disconnect_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_disconnect_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_disconnect_ex - terminate transport layer .SH SYNOPSIS @@ -33,7 +33,6 @@ is provided. It calls .BR libssh2_session_disconnect_ex(3) with \fIreason\fP set to SSH_DISCONNECT_BY_APPLICATION and \fIlang\fP set to an empty string. - .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While diff --git a/docs/libssh2_session_flag.3 b/docs/libssh2_session_flag.3 index 71d82e4c..0ed517d1 100644 --- a/docs/libssh2_session_flag.3 +++ b/docs/libssh2_session_flag.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_flag 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_flag 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_flag - TODO .SH SYNOPSIS diff --git a/docs/libssh2_session_free.3 b/docs/libssh2_session_free.3 index 50d2cb28..12b12c86 100644 --- a/docs/libssh2_session_free.3 +++ b/docs/libssh2_session_free.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_free - frees resources associated with a session instance .SH SYNOPSIS diff --git a/docs/libssh2_session_get_blocking.3 b/docs/libssh2_session_get_blocking.3 index 9bd12134..e3efbd0b 100644 --- a/docs/libssh2_session_get_blocking.3 +++ b/docs/libssh2_session_get_blocking.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_get_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_get_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_get_blocking - TODO .SH SYNOPSIS diff --git a/docs/libssh2_session_get_read_timeout.3 b/docs/libssh2_session_get_read_timeout.3 index a39e7aee..324fe238 100644 --- a/docs/libssh2_session_get_read_timeout.3 +++ b/docs/libssh2_session_get_read_timeout.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_get_read_timeout 3 "13 Jan 2023" "libssh2 1.10.1" "libssh2 manual" +.TH libssh2_session_get_read_timeout 3 "13 Jan 2023" "libssh2" "libssh2" .SH NAME libssh2_session_get_read_timeout - get the timeout for packet read functions .SH SYNOPSIS diff --git a/docs/libssh2_session_get_timeout.3 b/docs/libssh2_session_get_timeout.3 index 488918d2..62adeda1 100644 --- a/docs/libssh2_session_get_timeout.3 +++ b/docs/libssh2_session_get_timeout.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_get_timeout 3 "4 May 2011" "libssh2 1.2.9" "libssh2 manual" +.TH libssh2_session_get_timeout 3 "4 May 2011" "libssh2" "libssh2" .SH NAME libssh2_session_get_timeout - get the timeout for blocking functions .SH SYNOPSIS diff --git a/docs/libssh2_session_handshake.3 b/docs/libssh2_session_handshake.3 index b22e2c5a..68166454 100644 --- a/docs/libssh2_session_handshake.3 +++ b/docs/libssh2_session_handshake.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_handshake 3 "7 Oct 2010" "libssh2 1.2.8" "libssh2 manual" +.TH libssh2_session_handshake 3 "7 Oct 2010" "libssh2" "libssh2" .SH NAME libssh2_session_handshake - perform the SSH handshake .SH SYNOPSIS diff --git a/docs/libssh2_session_hostkey.3 b/docs/libssh2_session_hostkey.3 index 8d45b53b..d57c7eab 100644 --- a/docs/libssh2_session_hostkey.3 +++ b/docs/libssh2_session_hostkey.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_hostkey 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_hostkey 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_hostkey - get the remote key .SH SYNOPSIS diff --git a/docs/libssh2_session_init.3 b/docs/libssh2_session_init.3 index a9d524c4..ec114ecd 100644 --- a/docs/libssh2_session_init.3 +++ b/docs/libssh2_session_init.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_init 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_session_init 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_session_init - convenience macro for \fIlibssh2_session_init_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_session_init_ex.3 b/docs/libssh2_session_init_ex.3 index e54ff7ff..ff2f5578 100644 --- a/docs/libssh2_session_init_ex.3 +++ b/docs/libssh2_session_init_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_init_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_init_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_init_ex - initializes an SSH session object .SH SYNOPSIS diff --git a/docs/libssh2_session_last_errno.3 b/docs/libssh2_session_last_errno.3 index e6076dc1..54d37656 100644 --- a/docs/libssh2_session_last_errno.3 +++ b/docs/libssh2_session_last_errno.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_last_errno 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_last_errno 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_last_errno - get the most recent error number .SH SYNOPSIS @@ -13,10 +13,8 @@ libssh2_session_last_errno(LIBSSH2_SESSION *session); .BR libssh2_session_init_ex(3) Determine the most recent error condition. - .SH RETURN VALUE Numeric error code corresponding to the the Error Code constants. - .SH SEE ALSO .BR libssh2_session_last_error(3) .BR libssh2_session_set_last_error(3) diff --git a/docs/libssh2_session_last_error.3 b/docs/libssh2_session_last_error.3 index fa7285cc..f5172793 100644 --- a/docs/libssh2_session_last_error.3 +++ b/docs/libssh2_session_last_error.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_last_error - get the most recent error .SH SYNOPSIS @@ -25,10 +25,8 @@ buffer will be given to the calling scope. If necessary, the errmsg buffer will be duplicated. Determine the most recent error condition and its cause. - .SH RETURN VALUE Numeric error code corresponding to the the Error Code constants. - .SH SEE ALSO .BR libssh2_session_last_errno(3) .BR libssh2_session_set_last_error(3) diff --git a/docs/libssh2_session_method_pref.3 b/docs/libssh2_session_method_pref.3 index cb6f33d6..1e7718ec 100644 --- a/docs/libssh2_session_method_pref.3 +++ b/docs/libssh2_session_method_pref.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_method_pref 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_method_pref 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_method_pref - set preferred key exchange method .SH SYNOPSIS @@ -24,19 +24,16 @@ Set preferred methods to be negotiated. These preferences must be set prior to calling .BR libssh2_session_handshake(3) as they are used during the protocol initiation phase. - .SH 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 isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid. \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - The requested method is not supported. - .SH SEE ALSO .BR libssh2_session_init_ex(3) .BR libssh2_session_handshake(3) diff --git a/docs/libssh2_session_methods.3 b/docs/libssh2_session_methods.3 index 089f7a13..9dc383d0 100644 --- a/docs/libssh2_session_methods.3 +++ b/docs/libssh2_session_methods.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_methods 3 "8 Nov 2021" "libssh2 1.11" "libssh2 manual" +.TH libssh2_session_methods 3 "8 Nov 2021" "libssh2 1.11" "libssh2" .SH NAME libssh2_session_methods - return the currently active algorithms .SH SYNOPSIS diff --git a/docs/libssh2_session_set_blocking.3 b/docs/libssh2_session_set_blocking.3 index 7cde73aa..ec19213a 100644 --- a/docs/libssh2_session_set_blocking.3 +++ b/docs/libssh2_session_set_blocking.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_set_blocking - set or clear blocking mode on session .SH SYNOPSIS @@ -23,9 +23,7 @@ session will return immediately with an empty buffer. If a write is performed on a session with no room for more data, a blocking session will wait for room. A non-blocking session will return immediately without writing anything. - .SH RETURN VALUE None - .SH SEE ALSO .BR libssh2_session_init_ex(3) diff --git a/docs/libssh2_session_set_last_error.3 b/docs/libssh2_session_set_last_error.3 index e00cbd22..bca1bd55 100644 --- a/docs/libssh2_session_set_last_error.3 +++ b/docs/libssh2_session_set_last_error.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_set_last_error 3 "26 Oct 2015" "libssh2 1.6.1" "libssh2 manual" +.TH libssh2_session_set_last_error 3 "26 Oct 2015" "libssh2" "libssh2" .SH NAME libssh2_session_set_last_error - sets the internal error state .SH SYNOPSIS @@ -23,13 +23,10 @@ This function is provided for high level language wrappers (i.e. Python or Perl) and other libraries that may extend libssh2 with additional features while still relying on its error reporting mechanism. - .SH RETURN VALUE Numeric error code corresponding to the the Error Code constants. - .SH AVAILABILITY Added in 1.6.1 - .SH SEE ALSO .BR libssh2_session_last_error(3) .BR libssh2_session_last_errno(3) diff --git a/docs/libssh2_session_set_read_timeout.3 b/docs/libssh2_session_set_read_timeout.3 index c97e7ae6..5be5265b 100644 --- a/docs/libssh2_session_set_read_timeout.3 +++ b/docs/libssh2_session_set_read_timeout.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_set_read_timeout 3 "13 Jan 2023" "libssh2 1.10.1" "libssh2 manual" +.TH libssh2_session_set_read_timeout 3 "13 Jan 2023" "libssh2" "libssh2" .SH NAME libssh2_session_set_read_timeout - set timeout for packet read functions .SH SYNOPSIS diff --git a/docs/libssh2_session_set_timeout.3 b/docs/libssh2_session_set_timeout.3 index b151d11c..01eed43e 100644 --- a/docs/libssh2_session_set_timeout.3 +++ b/docs/libssh2_session_set_timeout.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_set_timeout 3 "4 May 2011" "libssh2 1.2.9" "libssh2 manual" +.TH libssh2_session_set_timeout 3 "4 May 2011" "libssh2" "libssh2" .SH NAME libssh2_session_set_timeout - set timeout for blocking functions .SH SYNOPSIS diff --git a/docs/libssh2_session_startup.3 b/docs/libssh2_session_startup.3 index af66243d..cf5b5a13 100644 --- a/docs/libssh2_session_startup.3 +++ b/docs/libssh2_session_startup.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_session_startup - begin transport layer .SH SYNOPSIS @@ -38,7 +38,6 @@ host failed. the socket. \fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. - .SH SEE ALSO .BR libssh2_session_free(3) .BR libssh2_session_init_ex(3) diff --git a/docs/libssh2_session_supported_algs.3 b/docs/libssh2_session_supported_algs.3 index 89de417e..09439f6b 100644 --- a/docs/libssh2_session_supported_algs.3 +++ b/docs/libssh2_session_supported_algs.3 @@ -1,4 +1,4 @@ -.TH libssh2_session_supported_algs 3 "23 Oct 2011" "libssh2 1.4.0" "libssh2 manual" +.TH libssh2_session_supported_algs 3 "23 Oct 2011" "libssh2" "libssh2" .SH NAME libssh2_session_supported_algs - get list of supported algorithms .SH SYNOPSIS diff --git a/docs/libssh2_sftp_close.3 b/docs/libssh2_sftp_close.3 index f4155191..ea9f0d6e 100644 --- a/docs/libssh2_sftp_close.3 +++ b/docs/libssh2_sftp_close.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_close 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_close 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_close - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_close_handle.3 b/docs/libssh2_sftp_close_handle.3 index 1f5d0ef1..5450d450 100644 --- a/docs/libssh2_sftp_close_handle.3 +++ b/docs/libssh2_sftp_close_handle.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_close_handle 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_close_handle 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_close_handle - close filehandle .SH SYNOPSIS @@ -23,12 +23,10 @@ Close an active LIBSSH2_SFTP_HANDLE. Because files and directories share the same underlying storage mechanism these methods may be used interchangeably. \fBlibssh2_sftp_close(3)\fP and \fBlibssh2_sftp_closedir(3)\fP are macros for \fBlibssh2_sftp_close_handle(3)\fP. - .SH 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 isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. @@ -39,6 +37,5 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. - .SH SEE ALSO .BR libssh2_sftp_open_ex(3) diff --git a/docs/libssh2_sftp_closedir.3 b/docs/libssh2_sftp_closedir.3 index f4b4452e..9d6b94e7 100644 --- a/docs/libssh2_sftp_closedir.3 +++ b/docs/libssh2_sftp_closedir.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_closedir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_closedir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_closedir - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_fsetstat.3 b/docs/libssh2_sftp_fsetstat.3 index 2f45f4f3..acf7ab96 100644 --- a/docs/libssh2_sftp_fsetstat.3 +++ b/docs/libssh2_sftp_fsetstat.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_fsetstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_fsetstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_fsetstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_fstat.3 b/docs/libssh2_sftp_fstat.3 index 809b5311..9113bc16 100644 --- a/docs/libssh2_sftp_fstat.3 +++ b/docs/libssh2_sftp_fstat.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_fstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_fstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_fstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_fstat_ex.3 b/docs/libssh2_sftp_fstat_ex.3 index 3c6967b4..2a559f94 100644 --- a/docs/libssh2_sftp_fstat_ex.3 +++ b/docs/libssh2_sftp_fstat_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_fstat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_fstat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_fstat_ex - get or set attributes on an SFTP file handle .SH SYNOPSIS diff --git a/docs/libssh2_sftp_fsync.3 b/docs/libssh2_sftp_fsync.3 index 646760a0..d293d2e6 100644 --- a/docs/libssh2_sftp_fsync.3 +++ b/docs/libssh2_sftp_fsync.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_fsync 3 "8 Apr 2013" "libssh2 1.4.4" "libssh2 manual" +.TH libssh2_sftp_fsync 3 "8 Apr 2013" "libssh2" "libssh2" .SH NAME libssh2_sftp_fsync - synchronize file to disk .SH SYNOPSIS @@ -17,7 +17,6 @@ For this to work requires fsync@openssh.com support on the server. \fIhandle\fP - SFTP File Handle as returned by .BR libssh2_sftp_open_ex(3) - .SH RETURN VALUE Returns 0 on success or negative on failure. If used in non-blocking mode, it returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While @@ -32,7 +31,6 @@ was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. In particular, this can be returned if the SSH server does not support the fsync operation: the SFTP subcode \fILIBSSH2_FX_OP_UNSUPPORTED\fP will be returned in this case. - .SH AVAILABILITY Added in libssh2 1.4.4 and OpenSSH 6.3. .SH SEE ALSO diff --git a/docs/libssh2_sftp_get_channel.3 b/docs/libssh2_sftp_get_channel.3 index 1e24f10e..0a1d4636 100644 --- a/docs/libssh2_sftp_get_channel.3 +++ b/docs/libssh2_sftp_get_channel.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_get_channel 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual" +.TH libssh2_sftp_get_channel 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2" .SH NAME libssh2_sftp_get_channel - return the channel of sftp .SH SYNOPSIS diff --git a/docs/libssh2_sftp_init.3 b/docs/libssh2_sftp_init.3 index ea602d82..3ebc3538 100644 --- a/docs/libssh2_sftp_init.3 +++ b/docs/libssh2_sftp_init.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_init - open SFTP channel for the given SSH session. .SH SYNOPSIS diff --git a/docs/libssh2_sftp_last_error.3 b/docs/libssh2_sftp_last_error.3 index 91dd6fdf..0933689c 100644 --- a/docs/libssh2_sftp_last_error.3 +++ b/docs/libssh2_sftp_last_error.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_last_error - return the last SFTP-specific error code .SH SYNOPSIS @@ -17,9 +17,7 @@ Returns the last error code produced by the SFTP layer. Note that this only returns a sensible error code if libssh2 returned LIBSSH2_ERROR_SFTP_PROTOCOL in a previous call. Using \fBlibssh2_sftp_last_error(3)\fP without a preceding SFTP protocol error, it will return an unspecified value. - .SH RETURN VALUE Current error code state of the SFTP instance. - .SH SEE ALSO .BR libssh2_sftp_init(3) diff --git a/docs/libssh2_sftp_lstat.3 b/docs/libssh2_sftp_lstat.3 index fc0ecd4e..1faf34f4 100644 --- a/docs/libssh2_sftp_lstat.3 +++ b/docs/libssh2_sftp_lstat.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_lstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_lstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_lstat - convenience macro for \fIlibssh2_sftp_stat_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_mkdir.3 b/docs/libssh2_sftp_mkdir.3 index 63e4c3b4..ba4f77d1 100644 --- a/docs/libssh2_sftp_mkdir.3 +++ b/docs/libssh2_sftp_mkdir.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_mkdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_mkdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_mkdir - convenience macro for \fIlibssh2_sftp_mkdir_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_mkdir_ex.3 b/docs/libssh2_sftp_mkdir_ex.3 index 4bf73b84..946b6e63 100644 --- a/docs/libssh2_sftp_mkdir_ex.3 +++ b/docs/libssh2_sftp_mkdir_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_mkdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_mkdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_mkdir_ex - create a directory on the remote file system .SH SYNOPSIS diff --git a/docs/libssh2_sftp_open.3 b/docs/libssh2_sftp_open.3 index 85d54f67..5643c937 100644 --- a/docs/libssh2_sftp_open.3 +++ b/docs/libssh2_sftp_open.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_open 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_open 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_open - convenience macro for \fIlibssh2_sftp_open_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_open_ex.3 b/docs/libssh2_sftp_open_ex.3 index c23108c8..fed36092 100644 --- a/docs/libssh2_sftp_open_ex.3 +++ b/docs/libssh2_sftp_open_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_open_ex - open filehandle for file on SFTP. .SH SYNOPSIS diff --git a/docs/libssh2_sftp_open_ex_r.3 b/docs/libssh2_sftp_open_ex_r.3 index a7326718..a2f65e34 100644 --- a/docs/libssh2_sftp_open_ex_r.3 +++ b/docs/libssh2_sftp_open_ex_r.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_open_ex_r 3 "10 Apr 2023" "libssh2 1.11.0" "libssh2 manual" +.TH libssh2_sftp_open_ex_r 3 "10 Apr 2023" "libssh2" "libssh2" .SH NAME libssh2_sftp_open_ex_r - open filehandle for file on SFTP. .SH SYNOPSIS @@ -68,6 +68,8 @@ returned by the server. \fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. +.SH AVAILABILITY +Added in libssh2 1.11.0 .SH SEE ALSO .BR libssh2_sftp_close_handle(3) .BR libssh2_sftp_fstat_ex(3) diff --git a/docs/libssh2_sftp_open_r.3 b/docs/libssh2_sftp_open_r.3 index bccc0df3..4bdd1fa1 100644 --- a/docs/libssh2_sftp_open_r.3 +++ b/docs/libssh2_sftp_open_r.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_open_r 3 "10 Apr 2023" "libssh2 1.11.0" "libssh2 manual" +.TH libssh2_sftp_open_r 3 "10 Apr 2023" "libssh2 1.11.0" "libssh2" .SH NAME libssh2_sftp_open_r - convenience macro for \fIlibssh2_sftp_open_ex_r(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_opendir.3 b/docs/libssh2_sftp_opendir.3 index ad78cea2..198eec6a 100644 --- a/docs/libssh2_sftp_opendir.3 +++ b/docs/libssh2_sftp_opendir.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_opendir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_opendir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_opendir - convenience macro for \fIlibssh2_sftp_open_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_read.3 b/docs/libssh2_sftp_read.3 index c998e2c9..9d874223 100644 --- a/docs/libssh2_sftp_read.3 +++ b/docs/libssh2_sftp_read.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_read 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_read 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_read - read data from an SFTP handle .SH SYNOPSIS diff --git a/docs/libssh2_sftp_readdir.3 b/docs/libssh2_sftp_readdir.3 index f0fc9561..cc1367f4 100644 --- a/docs/libssh2_sftp_readdir.3 +++ b/docs/libssh2_sftp_readdir.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_readdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_readdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_readdir - convenience macro for \fIlibssh2_sftp_readdir_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_readdir_ex.3 b/docs/libssh2_sftp_readdir_ex.3 index 6ea3e048..cdac3ddb 100644 --- a/docs/libssh2_sftp_readdir_ex.3 +++ b/docs/libssh2_sftp_readdir_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_readdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_readdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_readdir_ex - read directory data from an SFTP handle .SH SYNOPSIS diff --git a/docs/libssh2_sftp_readlink.3 b/docs/libssh2_sftp_readlink.3 index e6d79be7..fe601582 100644 --- a/docs/libssh2_sftp_readlink.3 +++ b/docs/libssh2_sftp_readlink.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_readlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_readlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_readlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP .SH SYNOPSIS diff --git a/docs/libssh2_sftp_realpath.3 b/docs/libssh2_sftp_realpath.3 index 9dd51c5a..e11849c9 100644 --- a/docs/libssh2_sftp_realpath.3 +++ b/docs/libssh2_sftp_realpath.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_realpath 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_realpath 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_realpath - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP .SH SYNOPSIS diff --git a/docs/libssh2_sftp_rename.3 b/docs/libssh2_sftp_rename.3 index fd0e1185..3b34a209 100644 --- a/docs/libssh2_sftp_rename.3 +++ b/docs/libssh2_sftp_rename.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_rename 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_rename 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_rename - convenience macro for \fIlibssh2_sftp_rename_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_rename_ex.3 b/docs/libssh2_sftp_rename_ex.3 index d29b42aa..7731bcff 100644 --- a/docs/libssh2_sftp_rename_ex.3 +++ b/docs/libssh2_sftp_rename_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_rename_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_rename_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_rename_ex - rename an SFTP file .SH SYNOPSIS @@ -43,12 +43,10 @@ flag is not set and the destfile entry already exists, the operation will fail. Use of the other two flags indicate a preference (but not a requirement) for the remote end to perform an atomic rename operation and/or using native system calls when possible. - .SH 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 isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. @@ -59,6 +57,5 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. - .SH SEE ALSO .BR libssh2_sftp_init(3) diff --git a/docs/libssh2_sftp_rewind.3 b/docs/libssh2_sftp_rewind.3 index 867bfd8b..e8415289 100644 --- a/docs/libssh2_sftp_rewind.3 +++ b/docs/libssh2_sftp_rewind.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_rewind 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_rewind 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_rewind - convenience macro for \fIlibssh2_sftp_seek64(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_rmdir.3 b/docs/libssh2_sftp_rmdir.3 index fb797c23..49101ea0 100644 --- a/docs/libssh2_sftp_rmdir.3 +++ b/docs/libssh2_sftp_rmdir.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_rmdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_rmdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_rmdir - convenience macro for \fIlibssh2_sftp_rmdir_ex(3)\fP .SH SYNOPSIS diff --git a/docs/libssh2_sftp_rmdir_ex.3 b/docs/libssh2_sftp_rmdir_ex.3 index 1b1bb081..bb1db085 100644 --- a/docs/libssh2_sftp_rmdir_ex.3 +++ b/docs/libssh2_sftp_rmdir_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_rmdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_rmdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_rmdir_ex - remove an SFTP directory .SH SYNOPSIS diff --git a/docs/libssh2_sftp_seek.3 b/docs/libssh2_sftp_seek.3 index ce3aeeb1..f5d313bf 100644 --- a/docs/libssh2_sftp_seek.3 +++ b/docs/libssh2_sftp_seek.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_seek 3 "22 Dec 2008" "libssh2 1.0" "libssh2 manual" +.TH libssh2_sftp_seek 3 "22 Dec 2008" "libssh2 1.0" "libssh2" .SH NAME libssh2_sftp_seek - set the read/write position indicator within a file .SH SYNOPSIS diff --git a/docs/libssh2_sftp_seek64.3 b/docs/libssh2_sftp_seek64.3 index c7fd62a5..e3f56407 100644 --- a/docs/libssh2_sftp_seek64.3 +++ b/docs/libssh2_sftp_seek64.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_seek64 3 "22 Dec 2008" "libssh2 1.0" "libssh2 manual" +.TH libssh2_sftp_seek64 3 "22 Dec 2008" "libssh2" "libssh2" .SH NAME libssh2_sftp_seek64 - set the read/write position within a file .SH SYNOPSIS diff --git a/docs/libssh2_sftp_setstat.3 b/docs/libssh2_sftp_setstat.3 index 07284d89..6e1a67d0 100644 --- a/docs/libssh2_sftp_setstat.3 +++ b/docs/libssh2_sftp_setstat.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_setstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_setstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_setstat - convenience macro for \fIlibssh2_sftp_stat_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_shutdown.3 b/docs/libssh2_sftp_shutdown.3 index d73a7af9..1a22a475 100644 --- a/docs/libssh2_sftp_shutdown.3 +++ b/docs/libssh2_sftp_shutdown.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_shutdown - shut down an SFTP session .SH SYNOPSIS @@ -15,11 +15,9 @@ libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp); Destroys a previously initialized SFTP session and frees all resources associated with it. - .SH 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 isn't really a failure per se. - .SH SEE ALSO .BR libssh2_sftp_init(3) diff --git a/docs/libssh2_sftp_stat.3 b/docs/libssh2_sftp_stat.3 index 59abb59e..1f4b37bc 100644 --- a/docs/libssh2_sftp_stat.3 +++ b/docs/libssh2_sftp_stat.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_stat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_stat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_stat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_stat_ex.3 b/docs/libssh2_sftp_stat_ex.3 index 6b035395..2484a97f 100644 --- a/docs/libssh2_sftp_stat_ex.3 +++ b/docs/libssh2_sftp_stat_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_stat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_stat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_stat_ex - get status about an SFTP file .SH SYNOPSIS diff --git a/docs/libssh2_sftp_statvfs.3 b/docs/libssh2_sftp_statvfs.3 index 1b5feb1d..5f083a58 100644 --- a/docs/libssh2_sftp_statvfs.3 +++ b/docs/libssh2_sftp_statvfs.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_statvfs 3 "22 May 2010" "libssh2 1.2.6" "libssh2 manual" +.TH libssh2_sftp_statvfs 3 "22 May 2010" "libssh2" "libssh2" .SH NAME libssh2_sftp_statvfs, libssh2_sftp_fstatvfs - get file system statistics .SH SYNOPSIS @@ -30,7 +30,6 @@ statvfs@openssh.com and fstatvfs@openssh.com extension support on the server. \fIst\fP - Pointer to a LIBSSH2_SFTP_STATVFS structure to place file system statistics into. - .SH DATA TYPES LIBSSH2_SFTP_STATVFS is a typedefed struct that is defined as below @@ -58,7 +57,6 @@ The field \fIf_flag\fP is a bit mask. Bits are defined as follows: Read-only file system. .IP LIBSSH2_SFTP_ST_NOSUID Set-user-ID/set-group-ID bits are ignored by \fBexec\fP(3). - .SH RETURN VALUE Returns 0 on success or negative on failure. If used in non-blocking mode, it returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While diff --git a/docs/libssh2_sftp_symlink.3 b/docs/libssh2_sftp_symlink.3 index 60c8550b..8b8e6129 100644 --- a/docs/libssh2_sftp_symlink.3 +++ b/docs/libssh2_sftp_symlink.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_symlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_symlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_symlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP .SH SYNOPSIS diff --git a/docs/libssh2_sftp_symlink_ex.3 b/docs/libssh2_sftp_symlink_ex.3 index 8ef4a1f6..f0f485da 100644 --- a/docs/libssh2_sftp_symlink_ex.3 +++ b/docs/libssh2_sftp_symlink_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_symlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_symlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_symlink_ex - read or set a symbolic link .SH SYNOPSIS @@ -75,6 +75,5 @@ for the application to tell when it happens! \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. - .SH SEE ALSO .BR libssh2_sftp_init(3) diff --git a/docs/libssh2_sftp_tell.3 b/docs/libssh2_sftp_tell.3 index 4e99bd03..2c656517 100644 --- a/docs/libssh2_sftp_tell.3 +++ b/docs/libssh2_sftp_tell.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_tell 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_tell 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_tell - get the current read/write position indicator for a file .SH SYNOPSIS diff --git a/docs/libssh2_sftp_tell64.3 b/docs/libssh2_sftp_tell64.3 index d0c03777..f3af30be 100644 --- a/docs/libssh2_sftp_tell64.3 +++ b/docs/libssh2_sftp_tell64.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_tell64 3 "22 Dec 2008" "libssh2 1.0" "libssh2 manual" +.TH libssh2_sftp_tell64 3 "22 Dec 2008" "libssh2 1.0" "libssh2" .SH NAME libssh2_sftp_tell64 - get the current read/write position indicator for a file .SH SYNOPSIS diff --git a/docs/libssh2_sftp_unlink.3 b/docs/libssh2_sftp_unlink.3 index f83fd7e9..3d00a37a 100644 --- a/docs/libssh2_sftp_unlink.3 +++ b/docs/libssh2_sftp_unlink.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_unlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_sftp_unlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_sftp_unlink - convenience macro for \fIlibssh2_sftp_unlink_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_sftp_unlink_ex.3 b/docs/libssh2_sftp_unlink_ex.3 index 95893050..05861c60 100644 --- a/docs/libssh2_sftp_unlink_ex.3 +++ b/docs/libssh2_sftp_unlink_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_unlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_unlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_unlink_ex - unlink an SFTP file .SH SYNOPSIS @@ -22,12 +22,10 @@ libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); filesystem entry Unlink (delete) a file from the remote filesystem. - .SH 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 isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. @@ -38,6 +36,5 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. - .SH SEE ALSO .BR libssh2_sftp_init(3) diff --git a/docs/libssh2_sftp_write.3 b/docs/libssh2_sftp_write.3 index 8518eea0..6ca0171e 100644 --- a/docs/libssh2_sftp_write.3 +++ b/docs/libssh2_sftp_write.3 @@ -1,4 +1,4 @@ -.TH libssh2_sftp_write 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_write 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_sftp_write - write SFTP data .SH SYNOPSIS @@ -27,7 +27,6 @@ possible to write all bytes as requested. put it into a single SFTP protocol packet. This means that to get maximum performance when sending larger files, you should try to always pass in at least 32K of data to this function. - .SH WRITE AHEAD Starting in libssh2 version 1.2.8, the default behavior of libssh2 is to create several smaller outgoing packets for all data you pass to this function diff --git a/docs/libssh2_sign_sk.3 b/docs/libssh2_sign_sk.3 index a1dcbc2a..cb5f56b4 100644 --- a/docs/libssh2_sign_sk.3 +++ b/docs/libssh2_sign_sk.3 @@ -1,4 +1,4 @@ -.TH libssh2_sign_sk 3 "1 Jun 2022" "libssh2 1.10.0" "libssh2 manual" +.TH libssh2_sign_sk 3 "1 Jun 2022" "libssh2 1.10.0" "libssh2" .SH NAME libssh2_sign_sk - Create a signature from a FIDO2 authenticator. .SH SYNOPSIS @@ -79,9 +79,7 @@ return 0. On failure, it should return a negative number. See \fIorig_abstract\fP - User-defined data. When a PIN is required, use this to pass in the PIN, or a function pointer to retrieve the PIN. - .SH RETURN VALUE Return 0 on success or negative on failure. - .SH SEE ALSO .BR libssh2_userauth_publickey_sk(3) diff --git a/docs/libssh2_trace.3 b/docs/libssh2_trace.3 index 94e6d634..113767f1 100644 --- a/docs/libssh2_trace.3 +++ b/docs/libssh2_trace.3 @@ -1,4 +1,4 @@ -.TH libssh2_trace 3 "26 Dec 2008" "libssh2 1.0" "libssh2 manual" +.TH libssh2_trace 3 "26 Dec 2008" "libssh2 1.0" "libssh2" .SH NAME libssh2_trace - enable debug info from inside libssh2 .SH SYNOPSIS diff --git a/docs/libssh2_trace_sethandler.3 b/docs/libssh2_trace_sethandler.3 index 03eada56..2262d8c0 100644 --- a/docs/libssh2_trace_sethandler.3 +++ b/docs/libssh2_trace_sethandler.3 @@ -1,4 +1,4 @@ -.TH libssh2_trace_sethandler 3 "15 Jan 2010" "libssh2 1.2.3" "libssh2 manual" +.TH libssh2_trace_sethandler 3 "15 Jan 2010" "libssh2" "libssh2" .SH NAME libssh2_trace_sethandler - set a trace output handler .SH SYNOPSIS diff --git a/docs/libssh2_userauth_authenticated.3 b/docs/libssh2_userauth_authenticated.3 index ea2cb4da..10d6810f 100644 --- a/docs/libssh2_userauth_authenticated.3 +++ b/docs/libssh2_userauth_authenticated.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_authenticated 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_userauth_authenticated 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_userauth_authenticated - return authentication status .SH SYNOPSIS @@ -13,9 +13,7 @@ libssh2_userauth_authenticated(LIBSSH2_SESSION *session); .BR libssh2_session_init_ex(3) Indicates whether or not the named session has been successfully authenticated. - .SH RETURN VALUE Returns 1 if authenticated and 0 if not. - .SH SEE ALSO .BR libssh2_session_init_ex(3) diff --git a/docs/libssh2_userauth_banner.3 b/docs/libssh2_userauth_banner.3 index f463bcf8..8bfaddf4 100644 --- a/docs/libssh2_userauth_banner.3 +++ b/docs/libssh2_userauth_banner.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_banner 3 "1 Jun 2021" "libssh2 1.9.0" "libssh2 manual" +.TH libssh2_userauth_banner 3 "1 Jun 2021" "libssh2 1.9.0" "libssh2" .SH NAME libssh2_userauth_banner - get the server's userauth banner message .SH SYNOPSIS diff --git a/docs/libssh2_userauth_hostbased_fromfile.3 b/docs/libssh2_userauth_hostbased_fromfile.3 index 2d0c4759..3e18d36f 100644 --- a/docs/libssh2_userauth_hostbased_fromfile.3 +++ b/docs/libssh2_userauth_hostbased_fromfile.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_hostbased_fromfile 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_userauth_hostbased_fromfile 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_userauth_hostbased_fromfile - convenience macro for \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_userauth_hostbased_fromfile_ex.3 b/docs/libssh2_userauth_hostbased_fromfile_ex.3 index f1baa41a..b71ceb28 100644 --- a/docs/libssh2_userauth_hostbased_fromfile_ex.3 +++ b/docs/libssh2_userauth_hostbased_fromfile_ex.3 @@ -1,13 +1,10 @@ -.TH libssh2_userauth_hostbased_fromfile_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_userauth_hostbased_fromfile_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_userauth_hostbased_fromfile_ex - TODO .SH SYNOPSIS .nf .fi .SH DESCRIPTION - .SH RETURN VALUE - .SH ERRORS - .SH SEE ALSO diff --git a/docs/libssh2_userauth_keyboard_interactive.3 b/docs/libssh2_userauth_keyboard_interactive.3 index 492ed50a..27424c6b 100644 --- a/docs/libssh2_userauth_keyboard_interactive.3 +++ b/docs/libssh2_userauth_keyboard_interactive.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_keyboard_interactive 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_userauth_keyboard_interactive 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_userauth_keyboard_interactive - convenience macro for \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_userauth_keyboard_interactive_ex.3 b/docs/libssh2_userauth_keyboard_interactive_ex.3 index 6137c5ba..cc8daa45 100644 --- a/docs/libssh2_userauth_keyboard_interactive_ex.3 +++ b/docs/libssh2_userauth_keyboard_interactive_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_keyboard_interactive_ex 3 "8 Mar 2008" "libssh2 0.19" "libssh2 manual" +.TH libssh2_userauth_keyboard_interactive_ex 3 "8 Mar 2008" "libssh2 0.19" "libssh2" .SH NAME libssh2_userauth_keyboard_interactive_ex - authenticate a session using keyboard-interactive authentication diff --git a/docs/libssh2_userauth_list.3 b/docs/libssh2_userauth_list.3 index aa77298b..efb9207a 100644 --- a/docs/libssh2_userauth_list.3 +++ b/docs/libssh2_userauth_list.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_list 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_userauth_list 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_userauth_list - list supported authentication methods .SH SYNOPSIS diff --git a/docs/libssh2_userauth_password.3 b/docs/libssh2_userauth_password.3 index f067196c..e0a3300b 100644 --- a/docs/libssh2_userauth_password.3 +++ b/docs/libssh2_userauth_password.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_password 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_userauth_password 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_userauth_password - convenience macro for \fIlibssh2_userauth_password_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_userauth_password_ex.3 b/docs/libssh2_userauth_password_ex.3 index 784ef802..aa5d8601 100644 --- a/docs/libssh2_userauth_password_ex.3 +++ b/docs/libssh2_userauth_password_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_password_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_userauth_password_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_userauth_password_ex - authenticate a session with username and password .SH SYNOPSIS @@ -39,12 +39,10 @@ Attempt basic password authentication. Note that many SSH servers which appear to support ordinary password authentication actually have it disabled and use Keyboard Interactive authentication (routed via PAM or another authentication backed) instead. - .SH 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 isn't really a failure per se. - .SH ERRORS Some of the errors this function may return include: diff --git a/docs/libssh2_userauth_publickey.3 b/docs/libssh2_userauth_publickey.3 index 5712f4ce..10dafdfe 100644 --- a/docs/libssh2_userauth_publickey.3 +++ b/docs/libssh2_userauth_publickey.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_publickey 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_userauth_publickey 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_userauth_publickey - authenticate using a callback function .SH SYNOPSIS diff --git a/docs/libssh2_userauth_publickey_fromfile.3 b/docs/libssh2_userauth_publickey_fromfile.3 index 7be047d2..c26ad470 100644 --- a/docs/libssh2_userauth_publickey_fromfile.3 +++ b/docs/libssh2_userauth_publickey_fromfile.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_publickey_fromfile 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.TH libssh2_userauth_publickey_fromfile 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2" .SH NAME libssh2_userauth_publickey_fromfile - convenience macro for \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP calls .SH SYNOPSIS diff --git a/docs/libssh2_userauth_publickey_fromfile_ex.3 b/docs/libssh2_userauth_publickey_fromfile_ex.3 index fbd75ebd..d060d68f 100644 --- a/docs/libssh2_userauth_publickey_fromfile_ex.3 +++ b/docs/libssh2_userauth_publickey_fromfile_ex.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_publickey_fromfile_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_userauth_publickey_fromfile_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" .SH NAME libssh2_userauth_publickey_fromfile_ex - authenticate a session with a public key, read from a file .SH SYNOPSIS @@ -31,12 +31,10 @@ can be set to NULL. Attempt public key authentication using a PEM encoded private key file stored on disk - .SH 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 isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. @@ -49,6 +47,5 @@ combination was invalid. \fILIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - Authentication using the supplied public key was not accepted. - .SH SEE ALSO .BR libssh2_session_init_ex(3) diff --git a/docs/libssh2_userauth_publickey_frommemory.3 b/docs/libssh2_userauth_publickey_frommemory.3 index 0509f1a7..6bd26fd1 100644 --- a/docs/libssh2_userauth_publickey_frommemory.3 +++ b/docs/libssh2_userauth_publickey_frommemory.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_publickey_frommemory 3 "1 Sep 2014" "libssh2 1.5" "libssh2 manual" +.TH libssh2_userauth_publickey_frommemory 3 "1 Sep 2014" "libssh2" "libssh2" .SH NAME libssh2_userauth_publickey_frommemory - authenticate a session with a public key, read from memory .SH SYNOPSIS diff --git a/docs/libssh2_userauth_publickey_sk.3 b/docs/libssh2_userauth_publickey_sk.3 index 38df52f2..bee31eae 100644 --- a/docs/libssh2_userauth_publickey_sk.3 +++ b/docs/libssh2_userauth_publickey_sk.3 @@ -1,4 +1,4 @@ -.TH libssh2_userauth_publickey_sk 3 "1 Jun 2022" "libssh2 1.10.0" "libssh2 manual" +.TH libssh2_userauth_publickey_sk 3 "1 Jun 2022" "libssh2" "libssh2" .SH NAME libssh2_userauth_publickey_sk - authenticate a session with a FIDO2 authenticator .SH SYNOPSIS @@ -124,12 +124,10 @@ memory. It will be freed by the caller. For Ed25519 signatures, set this to NULL. \fIsig_s_len\fP - The length of the sig_s parameter. - .SH 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 isn't really a failure per se. - .SH ERRORS Some of the errors this function may return include: @@ -138,5 +136,7 @@ Some of the errors this function may return include: \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - failed, invalid username/key. +.SH AVAILABILITY +Added in libssh2 1.10.0 .SH SEE ALSO .BR libssh2_session_init_ex(3) diff --git a/docs/libssh2_version.3 b/docs/libssh2_version.3 index a2e608eb..2fe99a3d 100644 --- a/docs/libssh2_version.3 +++ b/docs/libssh2_version.3 @@ -1,4 +1,4 @@ -.TH libssh2_version 3 "23 Feb 2009" "libssh2 1.1" "libssh2 manual" +.TH libssh2_version 3 "23 Feb 2009" "libssh2" "libssh2" .SH NAME libssh2_version - return the libssh2 version number .SH SYNOPSIS diff --git a/docs/template.3 b/docs/template.3 index e6b0ac02..473e0bd3 100644 --- a/docs/template.3 +++ b/docs/template.3 @@ -1,4 +1,4 @@ -.TH libssh2_template 3 "1 Jun 2022" "libssh2 1.10.0" "libssh2 manual" +.TH libssh2_template 3 "1 Jun 2022" "libssh2" "libssh2" .SH NAME libssh2_template - short function description .SH SYNOPSIS @@ -10,12 +10,11 @@ libssh2_template(void); .fi .SH DESCRIPTION Long text describing the function and its input arguments. - .SH RETURN VALUE Describe what the function returns. - .SH ERRORS Add error codes - +.SH AVAILABILITY +Added in libssh2 ?.?.? .SH SEE ALSO Add related functions