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

man: fixups

- add missing `.fi` tags.
- fix misplaced `.nf` tags.
- add `.nf`/`.fi` tags `SYNOPSIS` where missing.
- fix missing/wrong function name from `SH NAME`.
- fix wrong function name in `TH`.
- keep return values in a separate line.
- indent.
- fold long lines.
- deleted `libssh2_channel_direct_streamlocal()`, there is no such function.
- add missing types.
- add missing headers.

Closes #949
This commit is contained in:
Viktor Szakats
2023-04-11 00:38:35 +00:00
parent 504026262d
commit e590450dcc
176 changed files with 761 additions and 358 deletions

View File

@ -5,9 +5,12 @@
.SH NAME .SH NAME
libssh2_agent_connect - connect to an ssh-agent libssh2_agent_connect - connect to an ssh-agent
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_agent_connect(LIBSSH2_AGENT *agent); int
libssh2_agent_connect(LIBSSH2_AGENT *agent);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Connect to an ssh-agent running on the system. Connect to an ssh-agent running on the system.

View File

@ -5,9 +5,12 @@
.SH NAME .SH NAME
libssh2_agent_disconnect - close a connection to an ssh-agent libssh2_agent_disconnect - close a connection to an ssh-agent
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_agent_disconnect(LIBSSH2_AGENT *agent); int
libssh2_agent_disconnect(LIBSSH2_AGENT *agent);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Close a connection to an ssh-agent. Close a connection to an ssh-agent.

View File

@ -5,9 +5,12 @@
.SH NAME .SH NAME
libssh2_agent_free - free an ssh-agent handle libssh2_agent_free - free an ssh-agent handle
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
void libssh2_agent_free(LIBSSH2_AGENT *agent); void
libssh2_agent_free(LIBSSH2_AGENT *agent);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Free an ssh-agent handle. This function also frees the internal Free an ssh-agent handle. This function also frees the internal
collection of public keys. collection of public keys.

View File

@ -5,11 +5,14 @@
.SH NAME .SH NAME
libssh2_agent_get_identity - get a public key off the collection of public keys managed by ssh-agent libssh2_agent_get_identity - get a public key off the collection of public keys managed by ssh-agent
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_agent_get_identity(LIBSSH2_AGENT *agent, int
struct libssh2_agent_publickey **store, libssh2_agent_get_identity(LIBSSH2_AGENT *agent,
struct libssh2_agent_publickey *prev); struct libssh2_agent_publickey **store,
struct libssh2_agent_publickey *prev);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIlibssh2_agent_get_identity(3)\fP allows an application to iterate \fIlibssh2_agent_get_identity(3)\fP allows an application to iterate
over all public keys in the collection managed by ssh-agent. over all public keys in the collection managed by ssh-agent.

View File

@ -5,10 +5,12 @@
.SH NAME .SH NAME
libssh2_agent_get_identity_path - gets the custom ssh-agent socket path libssh2_agent_get_identity_path - gets the custom ssh-agent socket path
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
const char * const char *
libssh2_agent_get_identity_path(LIBSSH2_AGENT *agent); libssh2_agent_get_identity_path(LIBSSH2_AGENT *agent);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Returns the custom agent identity socket path if set using libssh2_agent_set_identity_path() Returns the custom agent identity socket path if set using libssh2_agent_set_identity_path()

View File

@ -5,9 +5,12 @@
.SH NAME .SH NAME
libssh2_agent_init - init an ssh-agent handle libssh2_agent_init - init an ssh-agent handle
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_AGENT *libssh2_agent_init(LIBSSH2_SESSION *session); LIBSSH2_AGENT *
libssh2_agent_init(LIBSSH2_SESSION *session);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Init an ssh-agent handle. Returns the handle to an internal Init an ssh-agent handle. Returns the handle to an internal
representation of an ssh-agent connection. After the successful representation of an ssh-agent connection. After the successful

View File

@ -5,9 +5,12 @@
.SH NAME .SH NAME
libssh2_agent_list_identities - request an ssh-agent to list of public keys. libssh2_agent_list_identities - request an ssh-agent to list of public keys.
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_agent_list_identities(LIBSSH2_AGENT *agent); int
libssh2_agent_list_identities(LIBSSH2_AGENT *agent);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Request an ssh-agent to list of public keys, and stores them in the Request an ssh-agent to list of public keys, and stores them in the
internal collection of the handle. Call internal collection of the handle. Call

View File

@ -5,10 +5,12 @@
.SH NAME .SH NAME
libssh2_agent_set_identity_path - set an ssh-agent socket path on disk libssh2_agent_set_identity_path - set an ssh-agent socket path on disk
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
void void
libssh2_agent_set_identity_path(LIBSSH2_AGENT *agent, const char *path); libssh2_agent_set_identity_path(LIBSSH2_AGENT *agent, const char *path);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Allows a custom agent identity socket path instead of the default SSH_AUTH_SOCK env value Allows a custom agent identity socket path instead of the default SSH_AUTH_SOCK env value

View File

@ -5,11 +5,14 @@
.SH NAME .SH NAME
libssh2_agent_userauth - authenticate a session with a public key, with the help of ssh-agent libssh2_agent_userauth - authenticate a session with a public key, with the help of ssh-agent
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_agent_userauth(LIBSSH2_AGENT *agent, int
const char *username, libssh2_agent_userauth(LIBSSH2_AGENT *agent,
struct libssh2_agent_publickey *identity); const char *username,
struct libssh2_agent_publickey *identity);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIagent\fP - ssh-agent handle as returned by \fIagent\fP - ssh-agent handle as returned by
.BR libssh2_agent_init(3) .BR libssh2_agent_init(3)

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_banner_set - set the SSH protocol banner for the local client libssh2_banner_set - set the SSH protocol banner for the local client
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner); libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This function is \fBDEPRECATED\fP. Use \fIlibssh2_session_banner_set(3)\fP This function is \fBDEPRECATED\fP. Use \fIlibssh2_session_banner_set(3)\fP
instead! instead!

View File

@ -2,11 +2,14 @@
.SH NAME .SH NAME
libssh2_base64_decode - decode a base64 encoded string libssh2_base64_decode - decode a base64 encoded string
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest, int
unsigned int *dest_len, const char *src, libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest,
unsigned int src_len); unsigned int *dest_len, const char *src,
unsigned int src_len);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This function is deemed DEPRECATED and will be removed from libssh2 in a This function is deemed DEPRECATED and will be removed from libssh2 in a
future version. Don't use it! future version. Don't use it!

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_close - close a channel libssh2_channel_close - close a channel
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_close(LIBSSH2_CHANNEL *channel); libssh2_channel_close(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - active channel stream to set closed status on. \fIchannel\fP - active channel stream to set closed status on.

View File

@ -2,14 +2,14 @@
.SH NAME .SH NAME
libssh2_channel_direct_streamlocal_ex - Tunnel a UNIX socket connection through an SSH session libssh2_channel_direct_streamlocal_ex - Tunnel a UNIX socket connection through an SSH session
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_channel_direct_streamlocal_ex(LIBSSH2_SESSION *session, const char *socket_path, const char *shost, int sport); libssh2_channel_direct_streamlocal_ex(LIBSSH2_SESSION *session,
const char *socket_path,
LIBSSH2_CHANNEL * const char *shost, int sport);
libssh2_channel_direct_streamlocal(LIBSSH2_SESSION *session, const char *socket_path, const char *shost, int sport); .fi
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)

View File

@ -2,11 +2,13 @@
.SH NAME .SH NAME
libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_tcpip_ex(3)\fP calls libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_tcpip_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port); libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session,
const char *host, int port);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_direct_tcpip_ex(3)\fP. underlying function \fIlibssh2_channel_direct_tcpip_ex(3)\fP.

View File

@ -2,14 +2,18 @@
.SH NAME .SH NAME
libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session, const char *host, int port, const char *shost, int sport); libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session,
const char *host, int port,
const char *shost, int sport);
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port); libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session,
const char *host, int port);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_eof - check a channel's EOF status libssh2_channel_eof - check a channel's EOF status
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_eof(LIBSSH2_CHANNEL *channel); libssh2_channel_eof(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - active channel stream to set closed status on. \fIchannel\fP - active channel stream to set closed status on.

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *command); int
libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *command);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_process_startup(3)\fP. underlying function \fIlibssh2_channel_process_startup(3)\fP.

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_flush(LIBSSH2_CHANNEL *channel); int
libssh2_channel_flush(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_flush_ex(3)\fP. underlying function \fIlibssh2_channel_flush_ex(3)\fP.

View File

@ -2,6 +2,7 @@
.SH NAME .SH NAME
libssh2_channel_flush_ex - flush a channel libssh2_channel_flush_ex - flush a channel
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
@ -12,7 +13,7 @@ libssh2_channel_flush(LIBSSH2_CHANNEL *channel);
int int
libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - Active channel stream to flush. \fIchannel\fP - Active channel stream to flush.

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); int
libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_flush_ex(3)\fP. underlying function \fIlibssh2_channel_flush_ex(3)\fP.

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_forward_accept - accept a queued connection libssh2_channel_forward_accept - accept a queued connection
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener); libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIlistener\fP is a forwarding listener instance as returned by \fIlistener\fP is a forwarding listener instance as returned by
\fBlibssh2_channel_forward_listen_ex(3)\fP. \fBlibssh2_channel_forward_listen_ex(3)\fP.

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_forward_cancel - cancel a forwarded TCP port libssh2_channel_forward_cancel - cancel a forwarded TCP port
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener); libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIlistener\fP - Forwarding listener instance as returned by \fIlistener\fP - Forwarding listener instance as returned by
.BR libssh2_channel_forward_listen_ex(3) .BR libssh2_channel_forward_listen_ex(3)

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forward_listen_ex(3)\fP calls libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forward_listen_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port); int
libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_forward_listen_ex(3)\fP. underlying function \fIlibssh2_channel_forward_listen_ex(3)\fP.

View File

@ -2,14 +2,17 @@
.SH NAME .SH NAME
libssh2_channel_forward_listen_ex - listen to inbound connections libssh2_channel_forward_listen_ex - listen to inbound connections
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_LISTENER * LIBSSH2_LISTENER *
libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session, char *host, int port, int *bound_port, int queue_maxsize); libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session,
char *host, int port,
int *bound_port, int queue_maxsize);
LIBSSH2_LISTENER * LIBSSH2_LISTENER *
libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port); libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Instruct the remote SSH server to begin listening for inbound TCP/IP Instruct the remote SSH server to begin listening for inbound TCP/IP
connections. New connections will be queued by the library until accepted by connections. New connections will be queued by the library until accepted by

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_free - free all resources associated with a channel libssh2_channel_free - free all resources associated with a channel
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_free(LIBSSH2_CHANNEL *channel); libssh2_channel_free(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - Channel stream to free. \fIchannel\fP - Channel stream to free.

View File

@ -2,11 +2,15 @@
.SH NAME .SH NAME
libssh2_channel_get_exit_signal - get the remote exit signal libssh2_channel_get_exit_signal - get the remote exit signal
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_get_exit_signal(LIBSSH2_CHANNEL *channel, char **exitsignal, size_t *exitsignal_len, char **errmsg, size_t *errmsg_len, char **langtag, size_t *langtag_len); libssh2_channel_get_exit_signal(LIBSSH2_CHANNEL *channel,
char **exitsignal, size_t *exitsignal_len,
char **errmsg, size_t *errmsg_len,
char **langtag, size_t *langtag_len);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - Closed channel stream to retrieve exit signal from. \fIchannel\fP - Closed channel stream to retrieve exit signal from.

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_get_exit_status - get the remote exit code libssh2_channel_get_exit_status - get the remote exit code
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel) libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel)
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - Closed channel stream to retrieve exit status from. \fIchannel\fP - Closed channel stream to retrieve exit status from.

View File

@ -2,11 +2,13 @@
.SH NAME .SH NAME
libssh2_channel_handle_extended_data - set extended data handling mode libssh2_channel_handle_extended_data - set extended data handling mode
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
void void
libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel, int ignore_mode); libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel,
int ignore_mode);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This function is deprecated. Use the This function is deprecated. Use the
\fIlibssh2_channel_handle_extended_data2(3)\fP function instead! \fIlibssh2_channel_handle_extended_data2(3)\fP function instead!

View File

@ -2,11 +2,13 @@
.SH NAME .SH NAME
libssh2_channel_handle_extended_data2 - set extended data handling mode libssh2_channel_handle_extended_data2 - set extended data handling mode
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel, int ignore_mode); libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel,
int ignore_mode);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - Active channel stream to change extended data handling on. \fIchannel\fP - Active channel stream to change extended data handling on.

View File

@ -2,10 +2,13 @@
.SH NAME .SH NAME
libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_handle_extended_data(3)\fP calls libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_handle_extended_data(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
libssh2_channel_ignore_extended_data(arguments) void
libssh2_channel_ignore_extended_data(LIBSSH2_CHANNEL *channel,
int ignore_mode);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This function is deprecated. Use the This function is deprecated. Use the
\fIlibssh2_channel_handle_extended_data2(3)\fP function instead! \fIlibssh2_channel_handle_extended_data2(3)\fP function instead!

View File

@ -2,14 +2,19 @@
.SH NAME .SH NAME
libssh2_channel_open_ex - establish a generic session channel libssh2_channel_open_ex - establish a generic session channel
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type, unsigned int channel_type_len, unsigned int window_size, unsigned int packet_size, const char *message, unsigned int message_len); libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type,
unsigned int channel_type_len,
unsigned int window_size,
unsigned int packet_size,
const char *message, unsigned int message_len);
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_channel_open_session(session); libssh2_channel_open_session(session);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex(3)\fP calls libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_channel_open_session(LIBSSH2_SESSION *session); libssh2_channel_open_session(LIBSSH2_SESSION *session);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_open_ex(3)\fP. underlying function \fIlibssh2_channel_open_ex(3)\fP.

View File

@ -5,11 +5,13 @@ libssh2_channel_process_startup - request a shell on a channel
.nf .nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel, int
const char *request, libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel,
unsigned int request_len, const char *request,
const char *message, unsigned int request_len,
unsigned int message_len); const char *message,
unsigned int message_len);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - Active session channel instance. \fIchannel\fP - Active session channel instance.

View File

@ -2,10 +2,13 @@
.SH NAME .SH NAME
libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
ssize_t libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); ssize_t
libssh2_channel_read(LIBSSH2_CHANNEL *channel,
char *buf, size_t buflen);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_read_ex(3)\fP. underlying function \fIlibssh2_channel_read_ex(3)\fP.

View File

@ -2,17 +2,21 @@
.SH NAME .SH NAME
libssh2_channel_read_ex - read data from a channel stream libssh2_channel_read_ex - read data from a channel stream
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
ssize_t ssize_t
libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id, char *buf, size_t buflen); libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id,
char *buf, size_t buflen);
ssize_t ssize_t
libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); libssh2_channel_read(LIBSSH2_CHANNEL *channel,
char *buf, size_t buflen);
ssize_t ssize_t
libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel,
char *buf, size_t buflen);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Attempt to read data from an active channel stream. All channel streams have Attempt to read data from an active channel stream. All channel streams have
one standard I/O substream (stream_id == 0), and may have up to 2^32 extended one standard I/O substream (stream_id == 0), and may have up to 2^32 extended

View File

@ -2,10 +2,13 @@
.SH NAME .SH NAME
libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
ssize_t libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); ssize_t
libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel,
char *buf, size_t buflen);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_read_ex(3)\fP. underlying function \fIlibssh2_channel_read_ex(3)\fP.

View File

@ -2,13 +2,14 @@
.SH NAME .SH NAME
libssh2_channel_receive_window_adjust - adjust the channel window libssh2_channel_receive_window_adjust - adjust the channel window
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
unsigned long unsigned long
libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel, libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel,
unsigned long adjustment, unsigned long adjustment,
unsigned char force); unsigned char force);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This function is deprecated in 1.1. Use This function is deprecated in 1.1. Use
\fIlibssh2_channel_receive_window_adjust2(3)\fP! \fIlibssh2_channel_receive_window_adjust2(3)\fP!

View File

@ -2,6 +2,7 @@
.SH NAME .SH NAME
libssh2_channel_receive_window_adjust2 - adjust the channel window libssh2_channel_receive_window_adjust2 - adjust the channel window
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
@ -9,7 +10,7 @@ libssh2_channel_receive_window_adjust2(LIBSSH2_CHANNEL * channel,
unsigned long adjustment, unsigned long adjustment,
unsigned char force, unsigned char force,
unsigned int *window); unsigned int *window);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Adjust the receive window for a channel by adjustment bytes. If the amount to Adjust the receive window for a channel by adjustment bytes. If the amount to
be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_request_auth_agent - request agent forwarding for a session libssh2_channel_request_auth_agent - request agent forwarding for a session
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel); libssh2_channel_request_auth_agent(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Request that agent forwarding be enabled for this SSH session. This sends the Request that agent forwarding be enabled for this SSH session. This sends the
request over this specific channel, which causes the agent listener to be request over this specific channel, which causes the agent listener to be

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_pty_ex(3)\fP calls libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_pty_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_request_pty(LIBSSH2_SESSION *session, const char *term); int
libssh2_channel_request_pty(LIBSSH2_SESSION *session, const char *term);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_request_pty_ex(3)\fP. underlying function \fIlibssh2_channel_request_pty_ex(3)\fP.

View File

@ -2,14 +2,19 @@
.SH NAME .SH NAME
libssh2_channel_request_pty_ex - short function description libssh2_channel_request_pty_ex - short function description
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term, unsigned int term_len, const char *modes, unsigned int modes_len, int width, int height, int width_px, int height_px); libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term,
unsigned int term_len,
const char *modes, unsigned int modes_len,
int width, int height,
int width_px, int height_px);
int int
libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, char *term); libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, const char *term);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - Previously opened channel instance such as returned by \fIchannel\fP - Previously opened channel instance such as returned by
.BR libssh2_channel_open_ex(3) .BR libssh2_channel_open_ex(3)

View File

@ -2,10 +2,13 @@
.SH NAME .SH NAME
libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_request_pty_size_ex(3)\fP calls libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_request_pty_size_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_request_pty_size(LIBSSH2_CHANNEL *channel, int width, int height); int
libssh2_channel_request_pty_size(LIBSSH2_CHANNEL *channel,
int width, int height);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_request_pty_size_ex(3)\fP. underlying function \fIlibssh2_channel_request_pty_size_ex(3)\fP.

View File

@ -2,7 +2,8 @@
.SH NAME .SH NAME
libssh2_channel_request_pty_size_ex - TODO libssh2_channel_request_pty_size_ex - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf
.fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_send_eof - send EOF to remote server libssh2_channel_send_eof - send EOF to remote server
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel); libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Tell the remote host that no further data will be sent on the specified Tell the remote host that no further data will be sent on the specified
channel. Processes typically interpret this as a closed stdin descriptor. channel. Processes typically interpret this as a closed stdin descriptor.

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_set_blocking - set or clear blocking mode on channel libssh2_channel_set_blocking - set or clear blocking mode on channel
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
void void
libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking); libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - channel stream to set or clean blocking status on. \fIchannel\fP - channel stream to set or clean blocking status on.

View File

@ -2,10 +2,13 @@
.SH NAME .SH NAME
libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\fP calls libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, const char *varname, const char *value); int
libssh2_channel_setenv(LIBSSH2_CHANNEL *channel,
const char *varname, const char *value);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_setenv_ex(3)\fP. underlying function \fIlibssh2_channel_setenv_ex(3)\fP.

View File

@ -2,14 +2,18 @@
.SH NAME .SH NAME
libssh2_channel_setenv_ex - set an environment variable on the channel libssh2_channel_setenv_ex - set an environment variable on the channel
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, char *varname, unsigned int varname_len, const char *value, unsigned int value_len); libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel,
char *varname, unsigned int varname_len,
const char *value, unsigned int value_len);
int int
libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, char *varname, const char *value); libssh2_channel_setenv(LIBSSH2_CHANNEL *channel,
char *varname, const char *value);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - Previously opened channel instance such as returned by \fIchannel\fP - Previously opened channel instance such as returned by
.BR libssh2_channel_open_ex(3) .BR libssh2_channel_open_ex(3)

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_shell(LIBSSH2_CHANNEL *channel); int
libssh2_channel_shell(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_process_startup(3)\fP. underlying function \fIlibssh2_channel_process_startup(3)\fP.

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *subsystem); int
libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *subsystem);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_process_startup(3)\fP. underlying function \fIlibssh2_channel_process_startup(3)\fP.

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_wait_closed - wait for the remote to close the channel libssh2_channel_wait_closed - wait for the remote to close the channel
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel); libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Enter a temporary blocking state until the remote host closes the named Enter a temporary blocking state until the remote host closes the named
channel. Typically sent after \fIlibssh2_channel_close(3)\fP in order to channel. Typically sent after \fIlibssh2_channel_close(3)\fP in order to

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_wait_eof - wait for the remote to reply to an EOF request libssh2_channel_wait_eof - wait for the remote to reply to an EOF request
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_wait_eof(LIBSSH2_CHANNEL *channel); libssh2_channel_wait_eof(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Wait for the remote end to send EOF. Wait for the remote end to send EOF.

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_read_ex(3)\fP calls libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_read_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
unsigned long libssh2_channel_window_read(LIBSSH2_CHANNEL *channel); unsigned long
libssh2_channel_window_read(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_window_read_ex(3)\fP. underlying function \fIlibssh2_channel_window_read_ex(3)\fP.

View File

@ -2,12 +2,14 @@
.SH NAME .SH NAME
libssh2_channel_window_read_ex - Check the status of the read window libssh2_channel_window_read_ex - Check the status of the read window
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
unsigned long unsigned long
libssh2_channel_window_read_ex(LIBSSH2_CHANNEL *channel, libssh2_channel_window_read_ex(LIBSSH2_CHANNEL *channel,
unsigned long *read_avail, unsigned long *read_avail,
unsigned long *window_size_initial) unsigned long *window_size_initial)
.fi
.SH DESCRIPTION .SH DESCRIPTION
Check the status of the read window. Returns the number of bytes which the Check the status of the read window. Returns the number of bytes which the
remote end may send without overflowing the window limit read_avail (if remote end may send without overflowing the window limit read_avail (if

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_write_ex(3)\fP calls libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_write_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
unsigned long libssh2_channel_window_write(LIBSSH2_CHANNEL *channel); unsigned long
libssh2_channel_window_write(LIBSSH2_CHANNEL *channel);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_window_write_ex(3)\fP. underlying function \fIlibssh2_channel_window_write_ex(3)\fP.

View File

@ -2,11 +2,13 @@
.SH NAME .SH NAME
libssh2_channel_window_write_ex - Check the status of the write window libssh2_channel_window_write_ex - Check the status of the write window
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
unsigned long unsigned long
libssh2_channel_window_write_ex(LIBSSH2_CHANNEL *channel, libssh2_channel_window_write_ex(LIBSSH2_CHANNEL *channel,
unsigned long *window_size_initial) unsigned long *window_size_initial)
.fi
.SH DESCRIPTION .SH DESCRIPTION
Check the status of the write window Returns the number of bytes which may be Check the status of the write window Returns the number of bytes which may be
safely written on the channel without blocking. 'window_size_initial' (if safely written on the channel without blocking. 'window_size_initial' (if

View File

@ -5,8 +5,10 @@ libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP
.nf .nf
#include <libssh2.h> #include <libssh2.h>
ssize_t libssh2_channel_write(LIBSSH2_CHANNEL *channel, const char *buf, size_t buflen); ssize_t
libssh2_channel_write(LIBSSH2_CHANNEL *channel,
const char *buf, size_t buflen);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_write_ex(3)\fP. underlying function \fIlibssh2_channel_write_ex(3)\fP.

View File

@ -5,9 +5,11 @@ libssh2_channel_write_ex - write data to a channel stream blocking
.nf .nf
#include <libssh2.h> #include <libssh2.h>
ssize_t libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel, ssize_t
int stream_id, char *buf, libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel,
size_t buflen); int stream_id, char *buf,
size_t buflen);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Write data to a channel stream. All channel streams have one standard I/O Write data to a channel stream. All channel streams have one standard I/O
substream (stream_id == 0), and may have up to 2^32 extended data streams as substream (stream_id == 0), and may have up to 2^32 extended data streams as

View File

@ -5,8 +5,10 @@ libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex
.nf .nf
#include <libssh2.h> #include <libssh2.h>
ssize_t libssh2_channel_write_stderr(LIBSSH2_CHANNEL *channel, const char *buf, size_t buflen); ssize_t
libssh2_channel_write_stderr(LIBSSH2_CHANNEL *channel,
const char *buf, size_t buflen);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_write_ex(3)\fP. underlying function \fIlibssh2_channel_write_ex(3)\fP.

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3)\fP calls libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number); int
libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_channel_x11_req_ex(3)\fP. underlying function \fIlibssh2_channel_x11_req_ex(3)\fP.

View File

@ -2,14 +2,18 @@
.SH NAME .SH NAME
libssh2_channel_x11_req_ex - request an X11 forwarding channel libssh2_channel_x11_req_ex - request an X11 forwarding channel
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection, const char *auth_proto, const char *auth_cookie, int screen_number); libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection,
const char *auth_proto, const char *auth_cookie,
int screen_number);
int int
libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number); libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel,
int screen_number);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIchannel\fP - Previously opened channel instance such as returned by \fIchannel\fP - Previously opened channel instance such as returned by
.BR libssh2_channel_open_ex(3) .BR libssh2_channel_open_ex(3)

View File

@ -1,11 +1,13 @@
.TH libssh2_crypto_engine 3 "22 Nov 2021" "libssh2 1.11" "libssh2 manual" .TH libssh2_crypto_engine 3 "22 Nov 2021" "libssh2 1.11" "libssh2 manual"
.SH NAME .SH NAME
- retrieve used crypto engine libssh2_crypto_engine - retrieve used crypto engine
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
libssh2_crypto_engine_t libssh2_crypto_engine_t
libssh2_crypto_engine(); libssh2_crypto_engine(void);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Returns currently used crypto engine, as en enum value. Returns currently used crypto engine, as en enum value.
.SH AVAILABILITY .SH AVAILABILITY

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_exit - global library deinitialization libssh2_exit - global library deinitialization
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
void void
libssh2_exit(void); libssh2_exit(void);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Exit the libssh2 functions and free's all memory used internal. Exit the libssh2 functions and free's all memory used internal.
.SH AVAILABILITY .SH AVAILABILITY

View File

@ -1,11 +1,13 @@
.TH libssh2_exit 3 "13 Oct 2010" "libssh2 1.2.8" "libssh2 manual" .TH libssh2_free 3 "13 Oct 2010" "libssh2 1.2.8" "libssh2 manual"
.SH NAME .SH NAME
libssh2_free - deallocate libssh2 memory libssh2_free - deallocate libssh2 memory
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
void void
libssh2_free(LIBSSH2_SESSION *session, void *ptr); libssh2_free(LIBSSH2_SESSION *session, void *ptr);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Deallocate memory allocated by earlier call to libssh2 functions. It Deallocate memory allocated by earlier call to libssh2 functions. It
uses the memory allocation callbacks provided by the application, if uses the memory allocation callbacks provided by the application, if

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_hostkey_hash - return a hash of the remote host's key libssh2_hostkey_hash - return a hash of the remote host's key
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
const char * const char *
libssh2_hostkey_hash(LIBSSH2_SESSION *session, int hash_type); libssh2_hostkey_hash(LIBSSH2_SESSION *session, int hash_type);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)

View File

@ -2,12 +2,14 @@
.SH NAME .SH NAME
libssh2_init - global library initialization libssh2_init - global library initialization
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
#define LIBSSH2_INIT_NO_CRYPTO 0x0001 #define LIBSSH2_INIT_NO_CRYPTO 0x0001
int int
libssh2_init(int flags); libssh2_init(int flags);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Initialize the libssh2 functions. This typically initialize the Initialize the libssh2 functions. This typically initialize the
crypto library. It uses a global state, and is not thread safe -- you crypto library. It uses a global state, and is not thread safe -- you

View File

@ -2,12 +2,13 @@
.SH NAME .SH NAME
libssh2_keepalive_config - short function description libssh2_keepalive_config - short function description
.SH SYNOPSIS .SH SYNOPSIS
#include <libssh2.h>
.nf .nf
#include <libssh2.h>
void libssh2_keepalive_config(LIBSSH2_SESSION *session, void
int want_reply, libssh2_keepalive_config(LIBSSH2_SESSION *session,
unsigned interval); int want_reply,
unsigned interval);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
Set how often keepalive messages should be sent. \fBwant_reply\fP indicates Set how often keepalive messages should be sent. \fBwant_reply\fP indicates

View File

@ -2,11 +2,13 @@
.SH NAME .SH NAME
libssh2_keepalive_send - short function description libssh2_keepalive_send - short function description
.SH SYNOPSIS .SH SYNOPSIS
#include <libssh2.h>
.nf .nf
#include <libssh2.h>
int libssh2_keepalive_send(LIBSSH2_SESSION *session, int
int *seconds_to_next); libssh2_keepalive_send(LIBSSH2_SESSION *session,
int *seconds_to_next);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Send a keepalive message if needed. \fBseconds_to_next\fP indicates how many Send a keepalive message if needed. \fBseconds_to_next\fP indicates how many
seconds you can sleep after this call before you need to call it again. seconds you can sleep after this call before you need to call it again.

View File

@ -1,4 +1,4 @@
.\"
.\" Copyright (c) 2009, 2010 by Daniel Stenberg .\" Copyright (c) 2009, 2010 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_add 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_add 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
@ -8,11 +8,13 @@ libssh2_knownhost_add - add a known host
.nf .nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_knownhost_add(LIBSSH2_KNOWNHOSTS *hosts, int
char *host, char *salt, libssh2_knownhost_add(LIBSSH2_KNOWNHOSTS *hosts,
char *key, size_t keylen, char *host, char *salt,
int typemask, char *key, size_t keylen,
struct libssh2_knownhost **store); int typemask,
struct libssh2_knownhost **store);
.fi
.SH DESCRIPTION .SH DESCRIPTION
We discourage use of this function as of libssh2 1.2.5. Instead we strongly We discourage use of this function as of libssh2 1.2.5. Instead we strongly
urge users to use \fIlibssh2_knownhost_addc(3)\fP instead, which as a more urge users to use \fIlibssh2_knownhost_addc(3)\fP instead, which as a more

View File

@ -1,18 +1,21 @@
.\"
.\" Copyright (c) 2009, 2010 by Daniel Stenberg .\" Copyright (c) 2009, 2010 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_add 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" .TH libssh2_knownhost_addc 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
.SH NAME .SH NAME
libssh2_knownhost_add - add a known host libssh2_knownhost_addc - add a known host
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_knownhost_addc(LIBSSH2_KNOWNHOSTS *hosts, int
char *host, char *salt, libssh2_knownhost_addc(LIBSSH2_KNOWNHOSTS *hosts,
char *key, size_t keylen, char *host, char *salt,
const char *comment, size_t commentlen, char *key, size_t keylen,
int typemask, const char *comment, size_t commentlen,
struct libssh2_knownhost **store); int typemask,
struct libssh2_knownhost **store);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Adds a known host to the collection of known hosts identified by the 'hosts' Adds a known host to the collection of known hosts identified by the 'hosts'
handle. handle.

View File

@ -5,13 +5,16 @@
.SH NAME .SH NAME
libssh2_knownhost_check - check a host+key against the list of known hosts libssh2_knownhost_check - check a host+key against the list of known hosts
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_knownhost_check(LIBSSH2_KNOWNHOSTS *hosts, int
const char *host, libssh2_knownhost_check(LIBSSH2_KNOWNHOSTS *hosts,
const char *key, size_t keylen, const char *host,
int typemask, const char *key, size_t keylen,
struct libssh2_knownhost **knownhost); int typemask,
struct libssh2_knownhost **knownhost);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Checks a host and its associated key against the collection of known hosts, Checks a host and its associated key against the collection of known hosts,
and returns info back about the (partially) matched entry. and returns info back about the (partially) matched entry.

View File

@ -1,17 +1,20 @@
.\" .\"
.\" Copyright (c) 2009-2010 by Daniel Stenberg .\" Copyright (c) 2009-2010 by Daniel Stenberg
.\" .\"
.TH libssh2_knownhost_check 3 "1 May 2010" "libssh2 1.2.6" "libssh2 manual" .TH libssh2_knownhost_checkp 3 "1 May 2010" "libssh2 1.2.6" "libssh2 manual"
.SH NAME .SH NAME
libssh2_knownhost_checkp - check a host+key against the list of known hosts libssh2_knownhost_checkp - check a host+key against the list of known hosts
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_knownhost_checkp(LIBSSH2_KNOWNHOSTS *hosts, int
const char *host, int port, libssh2_knownhost_checkp(LIBSSH2_KNOWNHOSTS *hosts,
const char *key, size_t keylen, const char *host, int port,
int typemask, const char *key, size_t keylen,
struct libssh2_knownhost **knownhost); int typemask,
struct libssh2_knownhost **knownhost);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Checks a host and its associated key against the collection of known hosts, Checks a host and its associated key against the collection of known hosts,
and returns info back about the (partially) matched entry. and returns info back about the (partially) matched entry.

View File

@ -5,10 +5,13 @@
.SH NAME .SH NAME
libssh2_knownhost_del - delete a known host entry libssh2_knownhost_del - delete a known host entry
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_knownhost_del(LIBSSH2_KNOWNHOSTS *hosts, int
struct libssh2_knownhost *entry); libssh2_knownhost_del(LIBSSH2_KNOWNHOSTS *hosts,
struct libssh2_knownhost *entry);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Delete a known host entry from the collection of known hosts. Delete a known host entry from the collection of known hosts.

View File

@ -5,9 +5,12 @@
.SH NAME .SH NAME
libssh2_knownhost_free - free a collection of known hosts libssh2_knownhost_free - free a collection of known hosts
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
void libssh2_knownhost_free(LIBSSH2_KNOWNHOSTS *hosts); void
libssh2_knownhost_free(LIBSSH2_KNOWNHOSTS *hosts);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Free a collection of known hosts. Free a collection of known hosts.
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -5,11 +5,14 @@
.SH NAME .SH NAME
libssh2_knownhost_get - get a known host off the collection of known hosts libssh2_knownhost_get - get a known host off the collection of known hosts
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_knownhost_get(LIBSSH2_KNOWNHOSTS *hosts, int
struct libssh2_knownhost **store, libssh2_knownhost_get(LIBSSH2_KNOWNHOSTS *hosts,
struct libssh2_knownhost *prev): struct libssh2_knownhost **store,
struct libssh2_knownhost *prev):
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIlibssh2_knownhost_get(3)\fP allows an application to iterate over all known \fIlibssh2_knownhost_get(3)\fP allows an application to iterate over all known
hosts in the collection. hosts in the collection.

View File

@ -5,9 +5,12 @@
.SH NAME .SH NAME
libssh2_knownhost_init - init a collection of known hosts libssh2_knownhost_init - init a collection of known hosts
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_KNOWNHOSTS *libssh2_knownhost_init(LIBSSH2_SESSION *session); LIBSSH2_KNOWNHOSTS *
libssh2_knownhost_init(LIBSSH2_SESSION *session);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Init a collection of known hosts for this session. Returns the handle to an Init a collection of known hosts for this session. Returns the handle to an
internal representation of a known host collection. internal representation of a known host collection.

View File

@ -5,10 +5,13 @@
.SH NAME .SH NAME
libssh2_knownhost_readfile - parse a file of known hosts libssh2_knownhost_readfile - parse a file of known hosts
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_knownhost_readfile(LIBSSH2_KNOWNHOSTS *hosts, int
const char *filename, int type); libssh2_knownhost_readfile(LIBSSH2_KNOWNHOSTS *hosts,
const char *filename, int type);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Reads a collection of known hosts from a specified file and adds them to the Reads a collection of known hosts from a specified file and adds them to the
collection of known hosts. collection of known hosts.

View File

@ -5,10 +5,13 @@
.SH NAME .SH NAME
libssh2_knownhost_readline - read a known host line libssh2_knownhost_readline - read a known host line
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_knownhost_readline(LIBSSH2_KNOWNHOSTS *hosts, int
const char *line, size_t len, int type): libssh2_knownhost_readline(LIBSSH2_KNOWNHOSTS *hosts,
const char *line, size_t len, int type):
.fi
.SH DESCRIPTION .SH DESCRIPTION
Tell libssh2 to read a buffer as it if is a line from a known hosts file. Tell libssh2 to read a buffer as it if is a line from a known hosts file.

View File

@ -5,10 +5,13 @@
.SH NAME .SH NAME
libssh2_knownhost_writefile - write a collection of known hosts to a file libssh2_knownhost_writefile - write a collection of known hosts to a file
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_knownhost_writefile(LIBSSH2_KNOWNHOSTS *hosts, int
const char *filename, int type); libssh2_knownhost_writefile(LIBSSH2_KNOWNHOSTS *hosts,
const char *filename, int type);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Writes all the known hosts to the specified file using the specified file Writes all the known hosts to the specified file using the specified file
format. format.

View File

@ -5,13 +5,16 @@
.SH NAME .SH NAME
libssh2_knownhost_writeline - convert a known host to a line for storage libssh2_knownhost_writeline - convert a known host to a line for storage
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int
libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts, libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts,
struct libssh2_knownhost *known, struct libssh2_knownhost *known,
char *buffer, size_t buflen, char *buffer, size_t buflen,
size_t *outlen, size_t *outlen,
int type); int type);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Converts a single known host to a single line of output for storage, using Converts a single known host to a single line of output for storage, using
the 'type' output format. the 'type' output format.

View File

@ -2,9 +2,12 @@
.SH NAME .SH NAME
libssh2_poll - poll for activity on a socket, channel or listener libssh2_poll - poll for activity on a socket, channel or listener
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout); int
libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This function is deprecated. Do note use. We encourage users to instead use This function is deprecated. Do note use. We encourage users to instead use
the \fIpoll(3)\fP or \fIselect(3)\fP functions to check for socket activity or the \fIpoll(3)\fP or \fIselect(3)\fP functions to check for socket activity or

View File

@ -2,9 +2,12 @@
.SH NAME .SH NAME
libssh2_poll_channel_read - check if data is available libssh2_poll_channel_read - check if data is available
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended); int
libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This function is deprecated. Do note use. This function is deprecated. Do note use.

View File

@ -2,13 +2,16 @@
.SH NAME .SH NAME
libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP calls libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_publickey_add(LIBSSH2_PUBLICKEY *pkey, int
const unsigned char *name, libssh2_publickey_add(LIBSSH2_PUBLICKEY *pkey,
const unsigned char *blob, unsigned long blob_len, char overwrite, const unsigned char *name,
unsigned long num_attrs, const libssh2_publickey_attribute attrs[]); const unsigned char *blob, unsigned long blob_len,
char overwrite, unsigned long num_attrs,
const libssh2_publickey_attribute attrs[]);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_publickey_add_ex(3)\fP. underlying function \fIlibssh2_publickey_add_ex(3)\fP.

View File

@ -2,15 +2,16 @@
.SH NAME .SH NAME
libssh2_publickey_add_ex - Add a public key entry libssh2_publickey_add_ex - Add a public key entry
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_publickey_add_ex(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, libssh2_publickey_add_ex(LIBSSH2_PUBLICKEY *pkey,
unsigned long name_len, const unsigned char *blob, const unsigned char *name, unsigned long name_len,
unsigned long blob_len, char overwrite, const unsigned char *blob, unsigned long blob_len,
unsigned long num_attrs, char overwrite, unsigned long num_attrs,
const libssh2_publickey_attribute attrs[]) const libssh2_publickey_attribute attrs[])
.fi
.SH DESCRIPTION .SH DESCRIPTION
TBD TBD
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -2,7 +2,8 @@
.SH NAME .SH NAME
libssh2_publickey_init - TODO libssh2_publickey_init - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf
.fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -2,7 +2,8 @@
.SH NAME .SH NAME
libssh2_publickey_list_fetch - TODO libssh2_publickey_list_fetch - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf
.fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -2,7 +2,8 @@
.SH NAME .SH NAME
libssh2_publickey_list_free - TODO libssh2_publickey_list_free - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf
.fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -2,12 +2,14 @@
.SH NAME .SH NAME
libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex(3)\fP calls libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_publickey_remove(LIBSSH2_PUBLICKEY *pkey, int
const unsigned char *name, unsigned long name_len, libssh2_publickey_remove(LIBSSH2_PUBLICKEY *pkey,
const unsigned char *blob, unsigned long blob_len); const unsigned char *name, unsigned long name_len,
const unsigned char *blob, unsigned long blob_len);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_publickey_remove_ex(3)\fP. underlying function \fIlibssh2_publickey_remove_ex(3)\fP.

View File

@ -2,7 +2,8 @@
.SH NAME .SH NAME
libssh2_publickey_list_remove_ex - TODO libssh2_publickey_list_remove_ex - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf
.fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -2,7 +2,8 @@
.SH NAME .SH NAME
libssh2_publickey_shutdown - TODO libssh2_publickey_shutdown - TODO
.SH SYNOPSIS .SH SYNOPSIS
.nf
.fi
.SH DESCRIPTION .SH DESCRIPTION
.SH RETURN VALUE .SH RETURN VALUE

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_scp_recv - request a remote file via SCP libssh2_scp_recv - request a remote file via SCP
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb); libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This function is \fBDEPRECATED\fP. Use \fIlibssh2_scp_recv2(3)\fP This function is \fBDEPRECATED\fP. Use \fIlibssh2_scp_recv2(3)\fP
instead! instead!

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_scp_recv2 - request a remote file via SCP libssh2_scp_recv2 - request a remote file via SCP
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_scp_recv2(LIBSSH2_SESSION *session, const char *path, struct_stat *sb); libssh2_scp_recv2(LIBSSH2_SESSION *session, const char *path, struct_stat *sb);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)

View File

@ -2,11 +2,13 @@
.SH NAME .SH NAME
libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_scp_send(LIBSSH2_SESSION *session, const char *path, int mode, size_t size); libssh2_scp_send(LIBSSH2_SESSION *session, const char *path,
int mode, size_t size);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_scp_send_ex(3)\fP. underlying function \fIlibssh2_scp_send_ex(3)\fP.

View File

@ -8,6 +8,7 @@ libssh2_scp_send64 - Send a file via SCP
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_scp_send64(LIBSSH2_SESSION *session, const char *path, int mode, libssh2_scp_send64(LIBSSH2_SESSION *session, const char *path, int mode,
libssh2_uint64_t size, time_t mtime, time_t atime); libssh2_uint64_t size, time_t mtime, time_t atime);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)

View File

@ -8,6 +8,7 @@ libssh2_scp_send_ex - Send a file via SCP
LIBSSH2_CHANNEL * LIBSSH2_CHANNEL *
libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode,
size_t size, long mtime, long atime); size_t size, long mtime, long atime);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This function has been deemed deprecated since libssh2 1.2.6. See This function has been deemed deprecated since libssh2 1.2.6. See
\fIlibssh2_scp_send64(3)\fP. \fIlibssh2_scp_send64(3)\fP.

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_session_abstract - return a pointer to a session's abstract pointer libssh2_session_abstract - return a pointer to a session's abstract pointer
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
void ** void **
libssh2_session_abstract(LIBSSH2_SESSION *session); libssh2_session_abstract(LIBSSH2_SESSION *session);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)

View File

@ -2,9 +2,12 @@
.SH NAME .SH NAME
libssh2_session_banner_get - get the remote banner libssh2_session_banner_get - get the remote banner
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
const char *libssh2_session_banner_get(oLIBSSH2_SESSION *session); const char *
libssh2_session_banner_get(oLIBSSH2_SESSION *session);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Once the session has been setup and \fIlibssh2_session_handshake(3)\fP has Once the session has been setup and \fIlibssh2_session_handshake(3)\fP has
completed successfully, this function can be used to get the server id from completed successfully, this function can be used to get the server id from

View File

@ -2,11 +2,12 @@
.SH NAME .SH NAME
libssh2_session_banner_set - set the SSH protocol banner for the local client libssh2_session_banner_set - set the SSH protocol banner for the local client
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner); libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_session_block_directions - get directions to wait for libssh2_session_block_directions - get directions to wait for
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_session_block_directions(LIBSSH2_SESSION *session); libssh2_session_block_directions(LIBSSH2_SESSION *session);
.fi
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fBlibssh2_session_init_ex(3)\fP \fIsession\fP - Session instance as returned by \fBlibssh2_session_init_ex(3)\fP

View File

@ -5,8 +5,10 @@ libssh2_session_callback_set - set a callback function
.nf .nf
#include <libssh2.h> #include <libssh2.h>
void *libssh2_session_callback_set(LIBSSH2_SESSION *session, void *
int cbtype, void *callback); libssh2_session_callback_set(LIBSSH2_SESSION *session,
int cbtype, void *callback);
.fi
.SH DESCRIPTION .SH DESCRIPTION
Sets a custom callback handler for a previously initialized session Sets a custom callback handler for a previously initialized session
object. Callbacks are triggered by the receipt of special packets at the object. Callbacks are triggered by the receipt of special packets at the

View File

@ -2,10 +2,12 @@
.SH NAME .SH NAME
libssh2_session_disconnect - convenience macro for \fIlibssh2_session_disconnect_ex(3)\fP calls libssh2_session_disconnect - convenience macro for \fIlibssh2_session_disconnect_ex(3)\fP calls
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description); int
libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description);
.fi
.SH DESCRIPTION .SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_session_disconnect_ex(3)\fP. underlying function \fIlibssh2_session_disconnect_ex(3)\fP.

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