generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fixed some spelling mistakes in documentation.

Browse Source
This commit is contained in:
Dan Fandrich 2007-04-12 21:30:03 +00:00
parent 164c6e9fc5
commit 4e920fe2be
7 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README
View File

@ -12,13 +12,13 @@ options deserve additional comments:
The SSH2 Transport allows for unencrypted data The SSH2 Transport allows for unencrypted data
transmission using the "none" cipher. Because this is transmission using the "none" cipher. Because this is
such a huge security hole, it is typically disabled on such a huge security hole, it is typically disabled on
SSH2 implementations and is diabled in libssh2 by SSH2 implementations and is disabled in libssh2 by
default as well. default as well.
Enabling this option will allow for "none" as a Enabling this option will allow for "none" as a
negotiable method, however it still requires that the negotiable method, however it still requires that the
method be advertized by the remote end and that no method be advertized by the remote end and that no
more-prefferable methods are available. more-preferable methods are available.
* --enable-mac-none * --enable-mac-none
@ -31,7 +31,7 @@ options deserve additional comments:
Enabling this option will allow for "none" as a Enabling this option will allow for "none" as a
negotiable method, however it still requires that the negotiable method, however it still requires that the
method be advertized by the remote end and that no method be advertized by the remote end and that no
more-prefferable methods are available. more-preferable methods are available.
* --disable-gex-new * --disable-gex-new
@ -55,7 +55,7 @@ options deserve additional comments:
Configure will attempt to locate Libgcrypt in the Configure will attempt to locate Libgcrypt in the
default location, but if you have installed it default location, but if you have installed it
somewhere else, use the --with-libgrypt-prefic=DIR somewhere else, use the --with-libgrypt-prefix=DIR
parameter. parameter.
* --with-openssl=[DIR] * --with-openssl=[DIR]

4
docs/libssh2_channel_forward_listen_ex.3
View File

@ -1,4 +1,4 @@
.\" $Id: libssh2_channel_forward_listen_ex.3,v 1.1 2006/12/21 14:09:13 bagder Exp $ .\" $Id: libssh2_channel_forward_listen_ex.3,v 1.2 2007/04/12 21:30:03 dfandrich Exp $
.\" .\"
.TH libssh2_channel_forward_listen_ex 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" .TH libssh2_channel_forward_listen_ex 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
.SH NAME .SH NAME
@ -30,7 +30,7 @@ host will select the first available dynamic port.
\fIbound_port\fP - Populated with the actual port bound on the remote \fIbound_port\fP - Populated with the actual port bound on the remote
host. Useful when requesting dynamic port numbers. host. Useful when requesting dynamic port numbers.
\fIqueue_maxsize\fP - Maximum nuber of pending connections to queue before \fIqueue_maxsize\fP - Maximum number of pending connections to queue before
rejecting further attempts. rejecting further attempts.
\fIlibssh2_channel_forward_listen(3)\fP is a macro. \fIlibssh2_channel_forward_listen(3)\fP is a macro.

8
docs/libssh2_poll.3
View File

@ -1,4 +1,4 @@
.\" $Id: libssh2_poll.3,v 1.1 2007/02/23 10:20:56 bagder Exp $ .\" $Id: libssh2_poll.3,v 1.2 2007/04/12 21:30:03 dfandrich Exp $
.\" .\"
.TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" .TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
.SH NAME .SH NAME
@ -11,9 +11,9 @@ int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);
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
\fIpoll(2)\fP however the structure of fds is somewhat more complex in order \fIpoll(2)\fP however the structure of fds is somewhat more complex in order
to accomodate the disparate datatypes, POLLFD constants have been namespaced to accommodate the disparate datatypes, POLLFD constants have been namespaced
to avoid platform discrepencies, and revents has additional values defined. to avoid platform discrepancies, and revents has additional values defined.
.SH "RETURN VALUE" .SH "RETURN VALUE"
Number of fds with interresting events. Number of fds with interesting events.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR libssh2_poll_channel_read(3) .BR libssh2_poll_channel_read(3)

4
docs/libssh2_session_init.3
View File

@ -1,4 +1,4 @@
.\" $Id: libssh2_session_init.3,v 1.1 2006/12/21 14:09:13 bagder Exp $ .\" $Id: libssh2_session_init.3,v 1.2 2007/04/12 21:30:03 dfandrich Exp $
.\" .\"
.TH libssh2_session_init 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" .TH libssh2_session_init 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
.SH NAME .SH NAME
@ -15,7 +15,7 @@ LIBSSH2_SESSION *libssh2_session_init_ex(
LIBSSH2_SESSION *libssh2_session_init(void); LIBSSH2_SESSION *libssh2_session_init(void);
.SH DESCRIPTION .SH DESCRIPTION
Initializes an SSH session object. By default system memory allocators Initializes an SSH session object. By default system memory allocators
(malloc(), free(), realloc()) will be used for any dynamicly allocated memory (malloc(), free(), realloc()) will be used for any dynamically allocated memory
blocks. Alternate memory allocation functions may be specified using the blocks. Alternate memory allocation functions may be specified using the
extended version of this API call, and/or optional application specific data extended version of this API call, and/or optional application specific data
may be attached to the session object. may be attached to the session object.

4
docs/libssh2_sftp_read.3
View File

@ -1,4 +1,4 @@
.\" $Id: libssh2_sftp_read.3,v 1.1 2007/02/23 10:20:56 bagder Exp $ .\" $Id: libssh2_sftp_read.3,v 1.2 2007/04/12 21:30:03 dfandrich Exp $
.\" .\"
.TH libssh2_sftp_read 3 "6 Feb 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_sftp_read 3 "6 Feb 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME .SH NAME
@ -9,7 +9,7 @@ libssh2_sftp_read - read data from an SFTP handle
ssize_t libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle, ssize_t libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle,
char *buffer, size_t buffer_maxlen); char *buffer, size_t buffer_maxlen);
.SH DESCRIPTION .SH DESCRIPTION
Reads a block of data from an LIBSSH2_SFTP_HANDLE. This method is modeled Reads a block of data from an LIBSSH2_SFTP_HANDLE. This method is modelled
after the POSIX \Iread(3)\fP function and uses the same calling after the POSIX \Iread(3)\fP function and uses the same calling
semantics. \fIlibssh2_sftp_read(3)\fP will attempt to read as much as possible semantics. \fIlibssh2_sftp_read(3)\fP will attempt to read as much as possible
however it may not fill all of buffer if the file pointer reaches the end or however it may not fill all of buffer if the file pointer reaches the end or

4
docs/libssh2_sftp_readnb.3
View File

@ -1,4 +1,4 @@
.\" $Id: libssh2_sftp_readnb.3,v 1.1 2007/02/23 10:20:56 bagder Exp $ .\" $Id: libssh2_sftp_readnb.3,v 1.2 2007/04/12 21:30:03 dfandrich Exp $
.\" .\"
.TH libssh2_sftp_read 3 "6 Feb 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_sftp_read 3 "6 Feb 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME .SH NAME
@ -10,7 +10,7 @@ ssize_t libssh2_sftp_readnb(LIBSSH2_SFTP_HANDLE *handle,
char *buffer, size_t buffer_maxlen); char *buffer, size_t buffer_maxlen);
.SH DESCRIPTION .SH DESCRIPTION
Reads a block of data from an LIBSSH2_SFTP_HANDLE non-blocking. This method is Reads a block of data from an LIBSSH2_SFTP_HANDLE non-blocking. This method is
modeled after the POSIX \Iread(3)\fP function and uses the same calling modelled after the POSIX \Iread(3)\fP function and uses the same calling
semantics. \fIlibssh2_sftp_read(3)\fP will attempt to read as much as possible semantics. \fIlibssh2_sftp_read(3)\fP will attempt to read as much as possible
however it may not fill all of buffer if the file pointer reaches the end or however it may not fill all of buffer if the file pointer reaches the end or
if further reads would cause the socket to block. if further reads would cause the socket to block.

4
docs/template.3
View File

@ -1,4 +1,4 @@
.\" $Id: template.3,v 1.1 2007/02/02 16:09:12 bagder Exp $ .\" $Id: template.3,v 1.2 2007/04/12 21:30:03 dfandrich Exp $
.\" .\"
.TH libssh2_template 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" .TH libssh2_template 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
.SH NAME .SH NAME
@ -10,6 +10,6 @@ void libssh2_template(void);
.SH DESCRIPTION .SH DESCRIPTION
Long text describing the function and its input arguments. Long text describing the function and its input arguments.
.SH RETURN VALUE .SH RETURN VALUE
Describe what the funtion returns. Describe what the function returns.
.SH "SEE ALSO" .SH "SEE ALSO"
Add related functions Add related functions