docs: fixed a bunch of typos
This commit is contained in:
parent
7b80a188dd
commit
1e4fb7ee9f
@ -1,6 +1,6 @@
|
|||||||
.TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
.TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
libssh2_banner_set - set the SSH prococol banner for the local client
|
libssh2_banner_set - set the SSH protocol banner for the local client
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
#include <libssh2.h>
|
#include <libssh2.h>
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@ libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_w
|
|||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
#include <libssh2.h>
|
#include <libssh2.h>
|
||||||
|
|
||||||
unsigend long libssh2_channel_window_write(LIBSSH2_CHANNEL *channel);
|
unsigned long libssh2_channel_window_write(LIBSSH2_CHANNEL *channel);
|
||||||
|
|
||||||
.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
|
||||||
|
@ -9,11 +9,11 @@ libssh2_channel_window_write_ex(LIBSSH2_CHANNEL *channel,
|
|||||||
unsigned long *window_size_initial)
|
unsigned long *window_size_initial)
|
||||||
.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 writen on the channel without blocking. 'window_size_initial' (if
|
safely written on the channel without blocking. 'window_size_initial' (if
|
||||||
passed) will be populated with the size of the initial window as defined by
|
passed) will be populated with the size of the initial window as defined by
|
||||||
the channel_open request
|
the channel_open request
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
Number of bytes which may be safely writen on the channel without blocking.
|
Number of bytes which may be safely written on the channel without blocking.
|
||||||
.SH ERRORS
|
.SH ERRORS
|
||||||
|
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
@ -36,7 +36,7 @@ The salt has to be provided base64 encoded with a trailing zero byte.
|
|||||||
argument
|
argument
|
||||||
|
|
||||||
\fItypemask\fP is a bitmask that specifies format and info about the data
|
\fItypemask\fP is a bitmask that specifies format and info about the data
|
||||||
passed to this function. Specificly, it details what format the host name is,
|
passed to this function. Specifically, it details what format the host name is,
|
||||||
what format the key is and what key type it is.
|
what format the key is and what key type it is.
|
||||||
|
|
||||||
The host name is given as one of the following types:
|
The host name is given as one of the following types:
|
||||||
|
@ -40,7 +40,7 @@ argument
|
|||||||
\fIcommentlen\fP is the total size in bytes of the comment pointed to by the \fIcomment\fP argument
|
\fIcommentlen\fP is the total size in bytes of the comment pointed to by the \fIcomment\fP argument
|
||||||
|
|
||||||
\fItypemask\fP is a bitmask that specifies format and info about the data
|
\fItypemask\fP is a bitmask that specifies format and info about the data
|
||||||
passed to this function. Specificly, it details what format the host name is,
|
passed to this function. Specifically, it details what format the host name is,
|
||||||
what format the key is and what key type it is.
|
what format the key is and what key type it is.
|
||||||
|
|
||||||
The host name is given as one of the following types:
|
The host name is given as one of the following types:
|
||||||
|
@ -25,7 +25,7 @@ IP numerical address of the host or the full name.
|
|||||||
argument
|
argument
|
||||||
|
|
||||||
\fItypemask\fP is a bitmask that specifies format and info about the data
|
\fItypemask\fP is a bitmask that specifies format and info about the data
|
||||||
passed to this function. Specificly, it details what format the host name is,
|
passed to this function. Specifically, it details what format the host name is,
|
||||||
what format the key is and what key type it is.
|
what format the key is and what key type it is.
|
||||||
|
|
||||||
The host name is given as one of the following types:
|
The host name is given as one of the following types:
|
||||||
|
@ -30,7 +30,7 @@ addition to the plain host name only check.
|
|||||||
argument
|
argument
|
||||||
|
|
||||||
\fItypemask\fP is a bitmask that specifies format and info about the data
|
\fItypemask\fP is a bitmask that specifies format and info about the data
|
||||||
passed to this function. Specificly, it details what format the host name is,
|
passed to this function. Specifically, it details what format the host name is,
|
||||||
what format the key is and what key type it is.
|
what format the key is and what key type it is.
|
||||||
|
|
||||||
The host name is given as one of the following types:
|
The host name is given as one of the following types:
|
||||||
|
@ -8,7 +8,7 @@ int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);
|
|||||||
.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
|
||||||
when specific sockets are ready to get recevied from or send to.
|
when specific sockets are ready to get received from or send to.
|
||||||
|
|
||||||
Poll for activity on a socket, channel, listener, or any combination of these
|
Poll for activity on a socket, channel, listener, or any combination of these
|
||||||
three types. The calling semantics for this function generally match
|
three types. The calling semantics for this function generally match
|
||||||
|
@ -17,7 +17,7 @@ de-referenced pointer, the internal storage of the session instance may be
|
|||||||
modified in place.
|
modified in place.
|
||||||
|
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
A pointer to session internal storage whos contents point to previously
|
A pointer to session internal storage who's contents point to previously
|
||||||
provided abstract data.
|
provided abstract data.
|
||||||
|
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
.TH libssh2_session_banner_set 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual"
|
.TH libssh2_session_banner_set 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
libssh2_session_banner_set - set the SSH prococol banner for the local client
|
libssh2_session_banner_set - set the SSH protocol banner for the local client
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
#include <libssh2.h>
|
#include <libssh2.h>
|
||||||
|
|
||||||
|
@ -18,7 +18,7 @@ libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description);
|
|||||||
|
|
||||||
\fIdescription\fP - Human readable reason for disconnection.
|
\fIdescription\fP - Human readable reason for disconnection.
|
||||||
|
|
||||||
\fIlang\fP - Localization string describing the langauge/encoding of the description provided.
|
\fIlang\fP - Localization string describing the language/encoding of the description provided.
|
||||||
|
|
||||||
Send a disconnect message to the remote host associated with \fIsession\fP,
|
Send a disconnect message to the remote host associated with \fIsession\fP,
|
||||||
along with a \fIreason\fP symbol and a verbose \fIdescription\fP.
|
along with a \fIreason\fP symbol and a verbose \fIdescription\fP.
|
||||||
|
@ -19,7 +19,7 @@ If a method is listed which is not supported by libssh2 it will be
|
|||||||
ignored and not sent to the remote host during protocol negotiation.
|
ignored and not sent to the remote host during protocol negotiation.
|
||||||
|
|
||||||
Set preferred methods to be negotiated. These
|
Set preferred methods to be negotiated. These
|
||||||
preferrences must be set prior to calling
|
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.
|
||||||
|
|
||||||
|
@ -12,7 +12,7 @@ int libssh2_session_supported_algs(LIBSSH2_SESSION* session,
|
|||||||
\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 - Method
|
use its pointer to the memory allocation function). \fImethod_type\fP - Method
|
||||||
type. See .BR \fIlibssh2_session_method_pref(3)\fP. \fIalgs\fP - Address of a
|
type. See .BR \fIlibssh2_session_method_pref(3)\fP. \fIalgs\fP - Address of a
|
||||||
pointer that will point to an array af returned algorithms
|
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
|
||||||
method_type parameter is equivalent to method_type in
|
method_type parameter is equivalent to method_type in
|
||||||
@ -36,7 +36,7 @@ const char **algorithms;
|
|||||||
int rc, i;
|
int rc, i;
|
||||||
LIBSSH2_SESSION *session;
|
LIBSSH2_SESSION *session;
|
||||||
|
|
||||||
/* initilize session */
|
/* initialize session */
|
||||||
session = libssh2_session_init();
|
session = libssh2_session_init();
|
||||||
rc = libssh2_session_supported_algs(session,
|
rc = libssh2_session_supported_algs(session,
|
||||||
LIBSSH2_METHOD_CRYPT_CS,
|
LIBSSH2_METHOD_CRYPT_CS,
|
||||||
|
@ -20,7 +20,7 @@ or \fBlibssh2_sftp_opendir(3)\fP (which is a macro).
|
|||||||
|
|
||||||
Close an active LIBSSH2_SFTP_HANDLE. Because files and directories share the
|
Close an active LIBSSH2_SFTP_HANDLE. Because files and directories share the
|
||||||
same underlying storage mechanism these methods may be used
|
same underlying storage mechanism these methods may be used
|
||||||
interchangably. \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
|
||||||
|
@ -10,7 +10,7 @@ int
|
|||||||
libssh2_sftp_fstat_ex(LIBSSH2_SFTP_HANDLE *handle,
|
libssh2_sftp_fstat_ex(LIBSSH2_SFTP_HANDLE *handle,
|
||||||
LIBSSH2_SFTP_ATTRIBUTES *attrs, int setstat)
|
LIBSSH2_SFTP_ATTRIBUTES *attrs, int setstat)
|
||||||
|
|
||||||
#define libbssh2_sftp_fstat(handle, attrs) \\
|
#define libssh2_sftp_fstat(handle, attrs) \\
|
||||||
libssh2_sftp_fstat_ex((handle), (attrs), 0)
|
libssh2_sftp_fstat_ex((handle), (attrs), 0)
|
||||||
#define libssh2_sftp_fsetstat(handle, attrs) \\
|
#define libssh2_sftp_fsetstat(handle, attrs) \\
|
||||||
libssh2_sftp_fstat_ex((handle), (attrs), 1)
|
libssh2_sftp_fstat_ex((handle), (attrs), 1)
|
||||||
@ -60,7 +60,7 @@ most common ones are:
|
|||||||
|
|
||||||
To check for specific user permissions, the set of defines are in the
|
To check for specific user permissions, the set of defines are in the
|
||||||
pattern LIBSSH2_SFTP_S_I<action><who> where <action> is R, W or X for
|
pattern LIBSSH2_SFTP_S_I<action><who> where <action> is R, W or X for
|
||||||
read, write and excutable and <who> is USR, GRP and OTH for user,
|
read, write and executable and <who> is USR, GRP and OTH for user,
|
||||||
group and other. So, you check for a user readable file, use the bit
|
group and other. So, you check for a user readable file, use the bit
|
||||||
\fILIBSSH2_SFTP_S_IRUSR\fP while you want to see if it is executable
|
\fILIBSSH2_SFTP_S_IRUSR\fP while you want to see if it is executable
|
||||||
for other, you use \fILIBSSH2_SFTP_S_IXOTH\fP and so on.
|
for other, you use \fILIBSSH2_SFTP_S_IXOTH\fP and so on.
|
||||||
|
@ -15,7 +15,7 @@ libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, const char *path, long mode);
|
|||||||
.BR libssh2_sftp_init(3)
|
.BR libssh2_sftp_init(3)
|
||||||
|
|
||||||
\fIpath\fP - full path of the new directory to create. Note that the new
|
\fIpath\fP - full path of the new directory to create. Note that the new
|
||||||
directory's parents must all exist priot to making this call.
|
directory's parents must all exist prior to making this call.
|
||||||
|
|
||||||
\fIpath_len\fP - length of the full path of the new directory to create.
|
\fIpath_len\fP - length of the full path of the new directory to create.
|
||||||
|
|
||||||
|
@ -29,7 +29,7 @@ filesystem entry
|
|||||||
Bitmask flags made up of LIBSSH2_SFTP_RENAME_* constants.
|
Bitmask flags made up of LIBSSH2_SFTP_RENAME_* constants.
|
||||||
|
|
||||||
Rename a filesystem object on the remote filesystem. The semantics of
|
Rename a filesystem object on the remote filesystem. The semantics of
|
||||||
this command typically include the ability to move a filsystem object
|
this command typically include the ability to move a filesystem object
|
||||||
between folders and/or filesystem mounts. If the LIBSSH2_SFTP_RENAME_OVERWRITE
|
between folders and/or filesystem mounts. If the LIBSSH2_SFTP_RENAME_OVERWRITE
|
||||||
flag is not set and the destfile entry already exists, the operation
|
flag is not set and the destfile entry already exists, the operation
|
||||||
will fail. Use of the other two flags indicate a preference (but not a
|
will fail. Use of the other two flags indicate a preference (but not a
|
||||||
|
@ -4,7 +4,7 @@ libssh2_sftp_rewind - convenience macro for \fIlibssh2_sftp_seek64(3)\fP calls
|
|||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
#include <libssh2.h>
|
#include <libssh2.h>
|
||||||
|
|
||||||
int libssh2_sftp_rewind(LINBSSH2_SFTP_HANDLE *handle);
|
int libssh2_sftp_rewind(LIBSSH2_SFTP_HANDLE *handle);
|
||||||
|
|
||||||
.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
|
||||||
|
@ -4,7 +4,7 @@ libssh2_sftp_stat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls
|
|||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
#include <libssh2.h>
|
#include <libssh2.h>
|
||||||
|
|
||||||
int libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_STFP_ATTRIBUTES *attrs);
|
int libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs);
|
||||||
|
|
||||||
.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
|
||||||
|
@ -48,7 +48,7 @@ These are convenience macros:
|
|||||||
.BR libssh2_sftp_realpath(3)
|
.BR libssh2_sftp_realpath(3)
|
||||||
: Resolve a complex, relative, or symlinked filepath to its effective target.
|
: Resolve a complex, relative, or symlinked filepath to its effective target.
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
When using LIBSSH2_SFTP_SYMLINK, this funtion returns 0 on success or negative
|
When using LIBSSH2_SFTP_SYMLINK, this function returns 0 on success or negative
|
||||||
on failure.
|
on failure.
|
||||||
|
|
||||||
When using LIBSSH2_SFTP_READLINK or LIBSSH2_SFTP_REALPATH, it returns the
|
When using LIBSSH2_SFTP_READLINK or LIBSSH2_SFTP_REALPATH, it returns the
|
||||||
|
@ -28,7 +28,7 @@ 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 ruturns 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.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user