mirror of
https://github.com/libssh2/libssh2.git
synced 2025-07-29 13:01:14 +03:00
man: fix double spaces and dash escaping
- `- ` -> `- ` - `. ` -> `. ` - `\- ` -> `- ` - `-1` -> `\-1` - fold long lines along the way This makes the minus sign come out as a Unicode minus sign (0x2212), and title separator dashes as Unicode hyphen (0x2010), with `groff -Tutf8` v1.23.0. Ref: https://lwn.net/Articles/947941/ Closes #1210
This commit is contained in:
@ -11,7 +11,7 @@ void
|
|||||||
libssh2_agent_free(LIBSSH2_AGENT *agent);
|
libssh2_agent_free(LIBSSH2_AGENT *agent);
|
||||||
.fi
|
.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.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
None.
|
None.
|
||||||
|
@ -12,7 +12,7 @@ libssh2_agent_init(LIBSSH2_SESSION *session);
|
|||||||
.fi
|
.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
|
||||||
initialization, an application can call \fBlibssh2_agent_connect(3)\fP
|
initialization, an application can call \fBlibssh2_agent_connect(3)\fP
|
||||||
to connect to a running ssh-agent.
|
to connect to a running ssh-agent.
|
||||||
|
|
||||||
|
@ -12,7 +12,7 @@ libssh2_agent_list_identities(LIBSSH2_AGENT *agent);
|
|||||||
.fi
|
.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
|
||||||
\fIlibssh2_agent_get_identity(3)\fP to get a public key off the
|
\fIlibssh2_agent_get_identity(3)\fP to get a public key off the
|
||||||
collection.
|
collection.
|
||||||
|
|
||||||
|
@ -22,14 +22,15 @@ instead!
|
|||||||
Set the banner that will be sent to the remote host when the SSH session is
|
Set the banner that will be sent to the remote host when the SSH session is
|
||||||
started with
|
started with
|
||||||
.BR libssh2_session_handshake(3)
|
.BR libssh2_session_handshake(3)
|
||||||
This is optional; a banner corresponding to the protocol and libssh2 version will be sent by default.
|
This is optional; a banner corresponding to the protocol and libssh2 version
|
||||||
|
will be sent by default.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH AVAILABILITY
|
.SH AVAILABILITY
|
||||||
Marked as deprecated since 1.4.0
|
Marked as deprecated since 1.4.0
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
.BR libssh2_session_handshake(3)
|
.BR libssh2_session_handshake(3)
|
||||||
|
@ -20,7 +20,7 @@ its own close message in response. To wait for the remote end to close its
|
|||||||
connection as well, follow this command with
|
connection as well, follow this command with
|
||||||
.BR libssh2_channel_wait_closed(3)
|
.BR libssh2_channel_wait_closed(3)
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
|
@ -29,6 +29,6 @@ in cleartext.
|
|||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
.BR libssh2_session_init_ex(3)
|
.BR libssh2_session_init_ex(3)
|
||||||
|
@ -35,6 +35,6 @@ in cleartext.
|
|||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
.BR libssh2_session_init_ex(3)
|
.BR libssh2_session_init_ex(3)
|
||||||
|
@ -14,13 +14,14 @@ libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener);
|
|||||||
\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)
|
||||||
|
|
||||||
Instruct the remote host to stop listening for new connections on a previously requested host/port.
|
Instruct the remote host to stop listening for new connections on a previously
|
||||||
|
requested host/port.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
@ -19,7 +19,7 @@ not yet been closed with
|
|||||||
, it will be called automatically so that the remote end may know that it
|
, it will be called automatically so that the remote end may know that it
|
||||||
can safely free its own resources.
|
can safely free its own resources.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
@ -47,7 +47,7 @@ or
|
|||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -29,11 +29,11 @@ defines shell, exec, and subsystem as standard process services.
|
|||||||
Initiate a request on a session type channel such as returned by
|
Initiate a request on a session type channel such as returned by
|
||||||
.BR libssh2_channel_open_ex(3)
|
.BR libssh2_channel_open_ex(3)
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -19,6 +19,6 @@ for the duration of the SSH session.
|
|||||||
\fIchannel\fP - Previously opened channel instance such as returned by
|
\fIchannel\fP - Previously opened channel instance such as returned by
|
||||||
.BR libssh2_channel_open_ex(3)
|
.BR libssh2_channel_open_ex(3)
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
|
@ -41,11 +41,11 @@ Request a PTY on an established channel. Note that this does not make sense
|
|||||||
for all channel types and may be ignored by the server despite returning
|
for all channel types and may be ignored by the server despite returning
|
||||||
success.
|
success.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel);
|
|||||||
Tell the remote host that no further data will be sent on the specified
|
Tell the remote host that no further data will be sent on the specified
|
||||||
channel. Processes typically interpret this as a closed stdin descriptor.
|
channel. Processes typically interpret this as a closed stdin descriptor.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
|
@ -33,12 +33,12 @@ Set an environment variable in the remote channel's process space. Note that
|
|||||||
this does not make sense for all channel types and may be ignored by the
|
this does not make sense for all channel types and may be ignored by the
|
||||||
server despite returning success.
|
server despite returning success.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
|
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -13,7 +13,7 @@ libssh2_channel_signal_ex(LIBSSH2_CHANNEL *channel,
|
|||||||
size_t signame_len)
|
size_t signame_len)
|
||||||
.fi
|
.fi
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
A signal can be delivered to the remote process/service. Some servers or
|
A signal can be delivered to the remote process/service. Some servers or
|
||||||
systems may not implement signals, in which case they will probably ignore this
|
systems may not implement signals, in which case they will probably ignore this
|
||||||
message.
|
message.
|
||||||
|
|
||||||
|
@ -33,11 +33,11 @@ Request an X11 forwarding on \fIchannel\fP. To use X11 forwarding,
|
|||||||
must first be called to set \fBLIBSSH2_CALLBACK_X11\fP. This callback will be
|
must first be called to set \fBLIBSSH2_CALLBACK_X11\fP. This callback will be
|
||||||
invoked when the remote host accepts the X11 forwarding.
|
invoked when the remote host accepts the X11 forwarding.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -11,9 +11,9 @@ void
|
|||||||
libssh2_free(LIBSSH2_SESSION *session, void *ptr);
|
libssh2_free(LIBSSH2_SESSION *session, void *ptr);
|
||||||
.fi
|
.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 any.
|
||||||
any. Otherwise, this will call free().
|
Otherwise, this will call free().
|
||||||
|
|
||||||
This function is mostly useful under Windows when libssh2 is linked to
|
This function is mostly useful under Windows when libssh2 is linked to
|
||||||
one run-time library and the application to another.
|
one run-time library and the application to another.
|
||||||
|
@ -13,8 +13,8 @@ int
|
|||||||
libssh2_init(int flags);
|
libssh2_init(int flags);
|
||||||
.fi
|
.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
|
||||||
must make sure this function is not called concurrently.
|
must make sure this function is not called concurrently.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Returns 0 if succeeded, or a negative value for error.
|
Returns 0 if succeeded, or a negative value for error.
|
||||||
|
@ -16,7 +16,7 @@ libssh2_keepalive_config(LIBSSH2_SESSION *session,
|
|||||||
Set how often keepalive messages should be sent. \fBwant_reply\fP indicates
|
Set how often keepalive messages should be sent. \fBwant_reply\fP indicates
|
||||||
whether the keepalive messages should request a response from the server.
|
whether the keepalive messages should request a response from the server.
|
||||||
\fBinterval\fP is number of seconds that can pass without any I/O, use 0 (the
|
\fBinterval\fP is number of seconds that can pass without any I/O, use 0 (the
|
||||||
default) to disable keepalives. To avoid some busy-loop corner-cases, if you
|
default) to disable keepalives. To avoid some busy-loop corner-cases, if you
|
||||||
specify an interval of 1 it will be treated as 2.
|
specify an interval of 1 it will be treated as 2.
|
||||||
|
|
||||||
Note that non-blocking applications are responsible for sending the keepalive
|
Note that non-blocking applications are responsible for sending the keepalive
|
||||||
|
@ -12,7 +12,7 @@ libssh2_keepalive_send(LIBSSH2_SESSION *session,
|
|||||||
int *seconds_to_next);
|
int *seconds_to_next);
|
||||||
.fi
|
.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.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Returns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors.
|
Returns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors.
|
||||||
|
@ -26,7 +26,7 @@ Request a file from the remote host via SCP.
|
|||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SCP_PROTOCOL\fP -
|
\fILIBSSH2_ERROR_SCP_PROTOCOL\fP -
|
||||||
|
|
||||||
|
@ -23,7 +23,7 @@ Request a file from the remote host via SCP.
|
|||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SCP_PROTOCOL\fP -
|
\fILIBSSH2_ERROR_SCP_PROTOCOL\fP -
|
||||||
|
|
||||||
|
@ -35,7 +35,7 @@ Send a file to the remote host via SCP.
|
|||||||
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
||||||
|
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -36,7 +36,7 @@ Send a file to the remote host via SCP.
|
|||||||
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
|
||||||
|
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -21,11 +21,11 @@ Set the banner that will be sent to the remote host when the SSH session is
|
|||||||
started with \fIlibssh2_session_handshake(3)\fP This is optional; a banner
|
started with \fIlibssh2_session_handshake(3)\fP This is optional; a banner
|
||||||
corresponding to the protocol and libssh2 version will be sent by default.
|
corresponding to the protocol and libssh2 version will be sent by default.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Returns 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN
|
Returns 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN
|
||||||
when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative
|
when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative
|
||||||
number, it is not really a failure per se.
|
number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
.SH AVAILABILITY
|
.SH AVAILABILITY
|
||||||
Added in 1.4.0.
|
Added in 1.4.0.
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@ LIBSSH2_SESSION_BLOCK_OUTBOUND: Outbound direction blocked.
|
|||||||
|
|
||||||
Application should wait for data to be available for socket prior to calling a
|
Application should wait for data to be available for socket prior to calling a
|
||||||
libssh2 function again. If \fBLIBSSH2_SESSION_BLOCK_INBOUND\fP is set select
|
libssh2 function again. If \fBLIBSSH2_SESSION_BLOCK_INBOUND\fP is set select
|
||||||
should contain the session socket in readfds set. Correspondingly in case of
|
should contain the session socket in readfds set. Correspondingly in case of
|
||||||
\fBLIBSSH2_SESSION_BLOCK_OUTBOUND\fP writefds set should contain the socket.
|
\fBLIBSSH2_SESSION_BLOCK_OUTBOUND\fP writefds set should contain the socket.
|
||||||
.SH AVAILABILITY
|
.SH AVAILABILITY
|
||||||
Added in 1.0
|
Added in 1.0
|
||||||
|
@ -36,7 +36,7 @@ function returns 0, the packet will be accepted nonetheless.
|
|||||||
.IP LIBSSH2_CALLBACK_X11
|
.IP LIBSSH2_CALLBACK_X11
|
||||||
Called when an X11 connection has been accepted
|
Called when an X11 connection has been accepted
|
||||||
.IP LIBSSH2_CALLBACK_SEND
|
.IP LIBSSH2_CALLBACK_SEND
|
||||||
Called when libssh2 wants to send data on the connection. Can be set to a
|
Called when libssh2 wants to send data on the connection. Can be set to a
|
||||||
custom function to handle I/O your own way.
|
custom function to handle I/O your own way.
|
||||||
|
|
||||||
The prototype of the callback:
|
The prototype of the callback:
|
||||||
@ -51,7 +51,7 @@ send, \fBlength\fP is the size of the data, \fBflags\fP is the flags that
|
|||||||
would have been used to a \fIsend()\fP call and \fBabstract\fP is a pointer
|
would have been used to a \fIsend()\fP call and \fBabstract\fP is a pointer
|
||||||
to the abstract pointer set in the \fIlibssh2_session_init_ex(3)\fP call.
|
to the abstract pointer set in the \fIlibssh2_session_init_ex(3)\fP call.
|
||||||
|
|
||||||
The callback returns the number of bytes sent, or -1 for error. The special
|
The callback returns the number of bytes sent, or \-1 for error. The special
|
||||||
return code \fB-EAGAIN\fP can be returned to signal that the send was aborted
|
return code \fB-EAGAIN\fP can be returned to signal that the send was aborted
|
||||||
to prevent getting blocked and it needs to be called again.
|
to prevent getting blocked and it needs to be called again.
|
||||||
.IP LIBSSH2_CALLBACK_RECV
|
.IP LIBSSH2_CALLBACK_RECV
|
||||||
@ -70,7 +70,7 @@ data into, \fBlength\fP is the size of the buffer, \fBflags\fP is the flags
|
|||||||
that would have been used to a \fIrecv()\fP call and \fBabstract\fP is a pointer
|
that would have been used to a \fIrecv()\fP call and \fBabstract\fP is a pointer
|
||||||
to the abstract pointer set in the \fIlibssh2_session_init_ex(3)\fP call.
|
to the abstract pointer set in the \fIlibssh2_session_init_ex(3)\fP call.
|
||||||
|
|
||||||
The callback returns the number of bytes read, or -1 for error. The special
|
The callback returns the number of bytes read, or \-1 for error. The special
|
||||||
return code \fB-EAGAIN\fP can be returned to signal that the read was aborted
|
return code \fB-EAGAIN\fP can be returned to signal that the read was aborted
|
||||||
to prevent getting blocked and it needs to be called again.
|
to prevent getting blocked and it needs to be called again.
|
||||||
.IP LIBSSH2_CALLBACK_AUTHAGENT
|
.IP LIBSSH2_CALLBACK_AUTHAGENT
|
||||||
|
@ -36,7 +36,7 @@ is provided. It calls
|
|||||||
with \fIreason\fP set to SSH_DISCONNECT_BY_APPLICATION
|
with \fIreason\fP set to SSH_DISCONNECT_BY_APPLICATION
|
||||||
and \fIlang\fP set to an empty string.
|
and \fIlang\fP set to an empty string.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
@ -14,7 +14,7 @@ libssh2_session_free(LIBSSH2_SESSION *session);
|
|||||||
Frees all resources associated with a session instance. Typically called after
|
Frees all resources associated with a session instance. Typically called after
|
||||||
.BR libssh2_session_disconnect_ex(3)
|
.BR libssh2_session_disconnect_ex(3)
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
.\" SPDX-License-Identifier: BSD-3-Clause
|
.\" SPDX-License-Identifier: BSD-3-Clause
|
||||||
.TH libssh2_session_get_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
.TH libssh2_session_get_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
libssh2_session_get_blocking \- evaluate blocking mode on session
|
libssh2_session_get_blocking - evaluate blocking mode on session
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.nf
|
.nf
|
||||||
#include <libssh2.h>
|
#include <libssh2.h>
|
||||||
|
@ -27,13 +27,13 @@ preferences must be set prior to calling
|
|||||||
.BR libssh2_session_handshake(3)
|
.BR libssh2_session_handshake(3)
|
||||||
as they are used during the protocol initiation phase.
|
as they are used during the protocol initiation phase.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid.
|
\fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - The requested method is not supported.
|
\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - The requested method is not supported.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
@ -17,13 +17,13 @@ libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking);
|
|||||||
\fIblocking\fP - Set to a non-zero value to make the channel block, or zero to
|
\fIblocking\fP - Set to a non-zero value to make the channel block, or zero to
|
||||||
make it non-blocking.
|
make it non-blocking.
|
||||||
|
|
||||||
Set or clear blocking mode on the selected on the session. This will
|
Set or clear blocking mode on the selected on the session. This will
|
||||||
instantly affect any channels associated with this session. If a read is
|
instantly affect any channels associated with this session. If a read is
|
||||||
performed on a session with no data currently available, a blocking session
|
performed on a session with no data currently available, a blocking session
|
||||||
will wait for data to arrive and return what it receives. A non-blocking
|
will wait for data to arrive and return what it receives. A non-blocking
|
||||||
session will return immediately with an empty buffer. If a write is performed
|
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
|
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
|
room. A non-blocking session will return immediately without writing
|
||||||
anything.
|
anything.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
None
|
None
|
||||||
|
@ -14,8 +14,8 @@ libssh2_session_supported_algs(LIBSSH2_SESSION* session,
|
|||||||
.fi
|
.fi
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
\fIsession\fP - An instance of initialized LIBSSH2_SESSION (the function will
|
\fIsession\fP - An instance of initialized LIBSSH2_SESSION (the function will
|
||||||
use its pointer to the memory allocation function). \fImethod_type\fP -
|
use its pointer to the memory allocation function). \fImethod_type\fP -
|
||||||
Method type. See \fIlibssh2_session_method_pref(3)\fP. \fIalgs\fP - Address
|
Method type. See \fIlibssh2_session_method_pref(3)\fP. \fIalgs\fP - Address
|
||||||
of a pointer that will point to an array of returned algorithms
|
of a pointer that will point to an array of returned algorithms
|
||||||
|
|
||||||
Get a list of supported algorithms for the given \fImethod_type\fP. The
|
Get a list of supported algorithms for the given \fImethod_type\fP. The
|
||||||
@ -30,7 +30,7 @@ libssh2_session_flag(session, LIBSSH2_FLAG_COMPRESS, 1) must be called before
|
|||||||
calling this function, otherwise only "none" will be returned.
|
calling this function, otherwise only "none" will be returned.
|
||||||
|
|
||||||
If successful, the function will allocate and fill the array with supported
|
If successful, the function will allocate and fill the array with supported
|
||||||
algorithms (the same names as defined in RFC 4253). The array is not NULL
|
algorithms (the same names as defined in RFC 4253). The array is not NULL
|
||||||
terminated.
|
terminated.
|
||||||
.SH EXAMPLE
|
.SH EXAMPLE
|
||||||
.nf
|
.nf
|
||||||
@ -61,12 +61,12 @@ else {
|
|||||||
.fi
|
.fi
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
On success, a number of returned algorithms (i.e a positive number will be
|
On success, a number of returned algorithms (i.e a positive number will be
|
||||||
returned). In case of a failure, an error code (a negative number, see below)
|
returned). In case of a failure, an error code (a negative number, see below)
|
||||||
is returned. 0 should never be returned.
|
is returned. 0 should never be returned.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_BAD_USE\fP - Invalid address of algs.
|
\fILIBSSH2_ERROR_BAD_USE\fP - Invalid address of algs.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - Unknown method type.
|
\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - Unknown method type.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_INVAL\fP - Internal error (normally should not occur).
|
\fILIBSSH2_ERROR_INVAL\fP - Internal error (normally should not occur).
|
||||||
|
|
||||||
|
@ -26,11 +26,11 @@ same underlying storage mechanism these methods may be used
|
|||||||
interchangeably. \fBlibssh2_sftp_close(3)\fP and \fBlibssh2_sftp_closedir(3)\fP
|
interchangeably. \fBlibssh2_sftp_close(3)\fP and \fBlibssh2_sftp_closedir(3)\fP
|
||||||
are macros for \fBlibssh2_sftp_close_handle(3)\fP.
|
are macros for \fBlibssh2_sftp_close_handle(3)\fP.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -85,11 +85,11 @@ Test for a pipe or FIFO special file
|
|||||||
.IP LIBSSH2_SFTP_S_ISSOCK
|
.IP LIBSSH2_SFTP_S_ISSOCK
|
||||||
Test for a socket
|
Test for a socket
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -24,13 +24,13 @@ 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
|
returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response
|
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response
|
||||||
was received on the socket, or an SFTP operation caused an errorcode
|
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
|
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
|
the SSH server does not support the fsync operation: the SFTP subcode
|
||||||
\fILIBSSH2_FX_OP_UNSUPPORTED\fP will be returned in this case.
|
\fILIBSSH2_FX_OP_UNSUPPORTED\fP will be returned in this case.
|
||||||
.SH AVAILABILITY
|
.SH AVAILABILITY
|
||||||
|
@ -25,7 +25,7 @@ function.
|
|||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
A pointer to the newly allocated SFTP instance or NULL on failure.
|
A pointer to the newly allocated SFTP instance or NULL on failure.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -35,7 +35,7 @@ Return 0 on success or negative on failure.
|
|||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@ libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, const char *filename,
|
|||||||
.IP LIBSSH2_FXF_READ
|
.IP LIBSSH2_FXF_READ
|
||||||
Open the file for reading.
|
Open the file for reading.
|
||||||
.IP LIBSSH2_FXF_WRITE
|
.IP LIBSSH2_FXF_WRITE
|
||||||
Open the file for writing. If both this and LIBSSH2_FXF_READ are specified,
|
Open the file for writing. If both this and LIBSSH2_FXF_READ are specified,
|
||||||
the file is opened for both reading and writing.
|
the file is opened for both reading and writing.
|
||||||
.IP LIBSSH2_FXF_APPEND
|
.IP LIBSSH2_FXF_APPEND
|
||||||
Force all writes to append data at the end of the file.
|
Force all writes to append data at the end of the file.
|
||||||
@ -53,7 +53,7 @@ LIBSSH2_SFTP_OPENDIR (to open a directory).
|
|||||||
A pointer to the newly created LIBSSH2_SFTP_HANDLE instance or NULL on
|
A pointer to the newly created LIBSSH2_SFTP_HANDLE instance or NULL on
|
||||||
failure.
|
failure.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -28,7 +28,7 @@ libssh2_sftp_open_ex_r(LIBSSH2_SFTP *sftp, const char *filename,
|
|||||||
.IP LIBSSH2_FXF_READ
|
.IP LIBSSH2_FXF_READ
|
||||||
Open the file for reading.
|
Open the file for reading.
|
||||||
.IP LIBSSH2_FXF_WRITE
|
.IP LIBSSH2_FXF_WRITE
|
||||||
Open the file for writing. If both this and LIBSSH2_FXF_READ are specified,
|
Open the file for writing. If both this and LIBSSH2_FXF_READ are specified,
|
||||||
the file is opened for both reading and writing.
|
the file is opened for both reading and writing.
|
||||||
.IP LIBSSH2_FXF_APPEND
|
.IP LIBSSH2_FXF_APPEND
|
||||||
Force all writes to append data at the end of the file.
|
Force all writes to append data at the end of the file.
|
||||||
@ -58,7 +58,7 @@ libssh2_sftp_fstat_ex for detailed usage.
|
|||||||
A pointer to the newly created LIBSSH2_SFTP_HANDLE instance or NULL on
|
A pointer to the newly created LIBSSH2_SFTP_HANDLE instance or NULL on
|
||||||
failure.
|
failure.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -33,7 +33,7 @@ Number of bytes actually populated into buffer, or negative on failure.
|
|||||||
It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -42,7 +42,7 @@ the full directory entry is longer than the space provided by
|
|||||||
statbuf style data into.
|
statbuf style data into.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Number of bytes actually populated into buffer (not counting the terminating
|
Number of bytes actually populated into buffer (not counting the terminating
|
||||||
zero), or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would
|
zero), or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would
|
||||||
otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not
|
otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not
|
||||||
really a failure per se.
|
really a failure per se.
|
||||||
.SH BUG
|
.SH BUG
|
||||||
@ -50,7 +50,7 @@ Passing in a too small buffer for 'buffer' or 'longentry' when receiving data
|
|||||||
only results in libssh2 1.2.7 or earlier to not copy the entire data amount,
|
only results in libssh2 1.2.7 or earlier to not copy the entire data amount,
|
||||||
and it is not possible for the application to tell when it happens!
|
and it is not possible for the application to tell when it happens!
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -46,11 +46,11 @@ 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
|
requirement) for the remote end to perform an atomic rename operation
|
||||||
and/or using native system calls when possible.
|
and/or using native system calls when possible.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -23,11 +23,11 @@ Remove a directory from the remote file system.
|
|||||||
\fIsourcefile_len\fP - Length of the full path of the existing directory to
|
\fIsourcefile_len\fP - Length of the full path of the existing directory to
|
||||||
remove.
|
remove.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -18,7 +18,7 @@ libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp);
|
|||||||
Destroys a previously initialized SFTP session and frees all resources
|
Destroys a previously initialized SFTP session and frees all resources
|
||||||
associated with it.
|
associated with it.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
@ -61,11 +61,11 @@ struct LIBSSH2_SFTP_ATTRIBUTES {
|
|||||||
};
|
};
|
||||||
.fi
|
.fi
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Returns 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN
|
Returns 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN
|
||||||
when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative
|
when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative
|
||||||
number, it is not really a failure per se.
|
number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -64,7 +64,7 @@ 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
|
returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -68,7 +68,7 @@ Passing in a too small buffer when receiving data only results in libssh2
|
|||||||
1.2.7 or earlier to not copy the entire data amount, and it is not possible
|
1.2.7 or earlier to not copy the entire data amount, and it is not possible
|
||||||
for the application to tell when it happens!
|
for the application to tell when it happens!
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -25,11 +25,11 @@ filesystem entry
|
|||||||
|
|
||||||
Unlink (delete) a file from the remote filesystem.
|
Unlink (delete) a file from the remote filesystem.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -60,7 +60,7 @@ really a failure per se.
|
|||||||
If this function returns 0 (zero) it should not be considered an error, but
|
If this function returns 0 (zero) it should not be considered an error, but
|
||||||
that there was no error but yet no payload data got sent to the other end.
|
that there was no error but yet no payload data got sent to the other end.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -20,9 +20,9 @@ libssh2_trace_sethandler(LIBSSH2_SESSION *session,
|
|||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
libssh2_trace_sethandler installs a trace output handler for your application.
|
libssh2_trace_sethandler installs a trace output handler for your application.
|
||||||
By default, when tracing has been switched on via a call to libssh2_trace(),
|
By default, when tracing has been switched on via a call to libssh2_trace(),
|
||||||
all output is written to stderr. By calling this method and passing a
|
all output is written to stderr. By calling this method and passing a
|
||||||
function pointer that matches the libssh2_trace_handler_func prototype,
|
function pointer that matches the libssh2_trace_handler_func prototype,
|
||||||
libssh2 will call back as it generates trace output. This can be used to
|
libssh2 will call back as it generates trace output. This can be used to
|
||||||
capture the trace output and put it into a log file or diagnostic window.
|
capture the trace output and put it into a log file or diagnostic window.
|
||||||
This function has no effect unless libssh2 was built to support this option,
|
This function has no effect unless libssh2 was built to support this option,
|
||||||
and a typical "release build" might not.
|
and a typical "release build" might not.
|
||||||
|
@ -47,11 +47,11 @@ requesting actual password as response, but it is not required by the
|
|||||||
protocol, and various authentication schemes, such as smartcard authentication
|
protocol, and various authentication schemes, such as smartcard authentication
|
||||||
may use keyboard-interactive authentication type too.
|
may use keyboard-interactive authentication type too.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN
|
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
|
when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative
|
||||||
number, it is not really a failure per se.
|
number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -31,10 +31,10 @@ authentication succeeds, this method with return NULL. This case may be
|
|||||||
distinguished from a failing case by examining
|
distinguished from a failing case by examining
|
||||||
\fIlibssh2_userauth_authenticated(3)\fP.
|
\fIlibssh2_userauth_authenticated(3)\fP.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
On success a comma delimited list of supported authentication schemes. This
|
On success a comma delimited list of supported authentication schemes. This
|
||||||
list is internally managed by libssh2. On failure returns NULL.
|
list is internally managed by libssh2. On failure returns NULL.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -42,13 +42,13 @@ which appear to support ordinary password authentication actually have
|
|||||||
it disabled and use Keyboard Interactive authentication (routed via
|
it disabled and use Keyboard Interactive authentication (routed via
|
||||||
PAM or another authentication backed) instead.
|
PAM or another authentication backed) instead.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
Some of the errors this function may return include:
|
Some of the errors this function may return include:
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -34,11 +34,11 @@ can be set to NULL.
|
|||||||
Attempt public key authentication using a PEM encoded private key file stored
|
Attempt public key authentication using a PEM encoded private key file stored
|
||||||
on disk
|
on disk
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
@ -39,11 +39,11 @@ It is only supported when libssh2 is backed by OpenSSL.
|
|||||||
|
|
||||||
Attempt public key authentication using a PEM encoded private key file stored in memory.
|
Attempt public key authentication using a PEM encoded private key file stored in memory.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Return 0 on success or negative on failure. It returns
|
Return 0 on success or negative on failure. It returns
|
||||||
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
|
||||||
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||||||
|
|
||||||
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user