From d67aaaffc4c9b4a6f8295b4c1d4d4111a12e13d1 Mon Sep 17 00:00:00 2001 From: Viktor Szakats Date: Thu, 27 Apr 2023 14:17:52 +0000 Subject: [PATCH] tidy-up: text nits, English contractions [ci skip] In input/output text and docs mostly. --- CMakeLists.txt | 6 +++--- acinclude.m4 | 2 +- configure.ac | 2 +- docs/AUTHORS | 2 +- docs/HACKING-CRYPTO | 2 +- docs/INSTALL_AUTOTOOLS | 8 ++++---- docs/INSTALL_CMAKE.md | 8 ++++---- docs/SECURITY.md | 10 +++++----- docs/TODO | 6 +++--- docs/libssh2_agent_connect.3 | 2 +- docs/libssh2_agent_init.3 | 2 +- docs/libssh2_banner_set.3 | 2 +- docs/libssh2_base64_decode.3 | 4 ++-- docs/libssh2_channel_close.3 | 2 +- docs/libssh2_channel_flush_ex.3 | 2 +- docs/libssh2_channel_forward_cancel.3 | 2 +- docs/libssh2_channel_free.3 | 2 +- docs/libssh2_channel_process_startup.3 | 2 +- docs/libssh2_channel_read_ex.3 | 2 +- docs/libssh2_channel_request_auth_agent.3 | 2 +- docs/libssh2_channel_request_pty_ex.3 | 2 +- docs/libssh2_channel_send_eof.3 | 2 +- docs/libssh2_channel_setenv_ex.3 | 2 +- docs/libssh2_channel_wait_closed.3 | 2 +- docs/libssh2_channel_wait_eof.3 | 2 +- docs/libssh2_channel_write_ex.3 | 2 +- docs/libssh2_channel_x11_req_ex.3 | 2 +- docs/libssh2_exit.3 | 2 +- docs/libssh2_knownhost_add.3 | 2 +- docs/libssh2_knownhost_addc.3 | 2 +- docs/libssh2_knownhost_check.3 | 2 +- docs/libssh2_knownhost_checkp.3 | 2 +- docs/libssh2_knownhost_init.3 | 2 +- docs/libssh2_session_abstract.3 | 2 +- docs/libssh2_session_banner_set.3 | 2 +- docs/libssh2_session_callback_set.3 | 6 +++--- docs/libssh2_session_disconnect_ex.3 | 2 +- docs/libssh2_session_free.3 | 2 +- docs/libssh2_session_method_pref.3 | 2 +- docs/libssh2_sftp_close_handle.3 | 2 +- docs/libssh2_sftp_fstat_ex.3 | 2 +- docs/libssh2_sftp_fsync.3 | 2 +- docs/libssh2_sftp_mkdir_ex.3 | 2 +- docs/libssh2_sftp_read.3 | 2 +- docs/libssh2_sftp_readdir_ex.3 | 2 +- docs/libssh2_sftp_rename_ex.3 | 2 +- docs/libssh2_sftp_rmdir_ex.3 | 2 +- docs/libssh2_sftp_shutdown.3 | 2 +- docs/libssh2_sftp_stat_ex.3 | 2 +- docs/libssh2_sftp_statvfs.3 | 2 +- docs/libssh2_sftp_symlink_ex.3 | 2 +- docs/libssh2_sftp_unlink_ex.3 | 2 +- docs/libssh2_sftp_write.3 | 10 +++++----- docs/libssh2_userauth_keyboard_interactive_ex.3 | 2 +- docs/libssh2_userauth_password_ex.3 | 2 +- docs/libssh2_userauth_publickey_fromfile_ex.3 | 2 +- docs/libssh2_userauth_publickey_frommemory.3 | 4 ++-- docs/libssh2_userauth_publickey_sk.3 | 2 +- docs/libssh2_version.3 | 2 +- example/scp_write.c | 2 +- example/scp_write_nonblock.c | 2 +- example/sftp_RW_nonblock.c | 6 +++--- example/sftp_append.c | 2 +- example/sftp_write.c | 2 +- example/sftp_write_nonblock.c | 2 +- example/sftp_write_sliding.c | 2 +- example/ssh2_agent.c | 2 +- example/ssh2_agent_forwarding.c | 6 +++--- maketgz | 2 +- src/channel.c | 2 +- tests/test_auth_keyboard_fail.c | 2 +- tests/test_auth_password_fail_password.c | 2 +- tests/test_auth_password_fail_username.c | 2 +- 73 files changed, 99 insertions(+), 99 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index c3d742c1..f84d4b77 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -118,7 +118,7 @@ set(LIB_SHARED "libssh2_shared") # Must match libssh2_shared_EXPORTS macro in i # Symbol hiding -option(HIDE_SYMBOLS "Set to ON to hide all libssh2 symbols that aren't officially external" ON) +option(HIDE_SYMBOLS "Set to ON to hide all libssh2 symbols that are not officially external" ON) mark_as_advanced(HIDE_SYMBOLS) if(HIDE_SYMBOLS) set(LIB_SHARED_DEFINITIONS LIBSSH2_EXPORTS) @@ -168,7 +168,7 @@ else() endif() check_symbol_exists(strtoll stdlib.h HAVE_STRTOLL) if(NOT HAVE_STRTOLL) - # Try _strtoi64 if strtoll isn't available + # Try _strtoi64() if strtoll() is not available check_symbol_exists(_strtoi64 stdlib.h HAVE_STRTOI64) endif() check_symbol_exists(snprintf stdio.h HAVE_SNPRINTF) @@ -190,7 +190,7 @@ if(${CMAKE_SYSTEM_NAME} STREQUAL "Darwin" OR # have been in a bad mood, because poll() only works on the /proc # filesystem here" # - # Mac OS X's poll has funny behaviors, like: + # macOS poll() has funny behaviors, like: # not being able to do poll on no filedescriptors (10.3?) # not being able to poll on some files (like anything in /dev) # not having reliable timeout support diff --git a/acinclude.m4 b/acinclude.m4 index 0a3a37da..49592e5c 100644 --- a/acinclude.m4 +++ b/acinclude.m4 @@ -123,7 +123,7 @@ AC_DEFUN([CURL_CHECK_COMPILER_CLANG], [ clangver=`echo $fullclangver | grep "based on LLVM " | "$SED" 's/.*(based on LLVM \(@<:@0-9@:>@*\.@<:@0-9@:>@*\).*)/\1/'` if test -z "$clangver"; then if echo $fullclangver | grep "Apple LLVM version " >/dev/null; then - dnl Starting with XCode 7 / clang 3.7, Apple clang won't tell its upstream version + dnl Starting with Xcode 7 / clang 3.7, Apple clang won't tell its upstream version clangver="3.7" else clangver=`echo $fullclangver | "$SED" 's/.*version \(@<:@0-9@:>@*\.@<:@0-9@:>@*\).*/\1/'` diff --git a/configure.ac b/configure.ac index 466193cf..140cf179 100644 --- a/configure.ac +++ b/configure.ac @@ -303,7 +303,7 @@ case $host in dnl Interix: "does provide poll(), but the implementing developer must dnl have been in a bad mood, because poll() only works on the /proc dnl filesystem here" - dnl Mac OS X's poll has funny behaviors, like: + dnl macOS poll() has funny behaviors, like: dnl not being able to do poll on no fildescriptors (10.3?) dnl not being able to poll on some files (like anything in /dev) dnl not having reliable timeout support diff --git a/docs/AUTHORS b/docs/AUTHORS index 5c7445bf..3abc9390 100644 --- a/docs/AUTHORS +++ b/docs/AUTHORS @@ -1,5 +1,5 @@ libssh2 is the result of many friendly people. This list is an attempt to - mention all contributors. If we've missed anyone, tell us! + mention all contributors. If we have missed anyone, tell us! This list of names is a-z sorted. diff --git a/docs/HACKING-CRYPTO b/docs/HACKING-CRYPTO index b8519832..f1c025bd 100644 --- a/docs/HACKING-CRYPTO +++ b/docs/HACKING-CRYPTO @@ -58,7 +58,7 @@ Terminates the crypto library use. May be an empty macro if not needed. 1.1) Crypto runtime detection The libssh2_crypto_engine_t enum must include the new engine, and -libssh2_crypto_engine() must return it when it's built in. +libssh2_crypto_engine() must return it when it is built in. 2) HMAC diff --git a/docs/INSTALL_AUTOTOOLS b/docs/INSTALL_AUTOTOOLS index b4a0cf19..607ef079 100644 --- a/docs/INSTALL_AUTOTOOLS +++ b/docs/INSTALL_AUTOTOOLS @@ -46,7 +46,7 @@ cache files.) to figure out how `configure' could check whether to do them, and mail diffs or instructions to the address given in the `README' so they can be considered for the next release. If you are using the cache, and at -some point `config.cache' contains results you don't want to keep, you +some point `config.cache' contains results you do not want to keep, you may remove or edit it. The file `configure.ac' (or `configure.in') is used to create @@ -57,7 +57,7 @@ a newer version of `autoconf'. The simplest way to compile this package is: 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. If you're + `./configure' to configure the package for your system. If you are using `csh' on an old version of System V, you might need to type `sh ./configure' instead to prevent `csh' from trying to execute `configure' itself. @@ -148,7 +148,7 @@ is something like `gnu-as' or `x' (for the X Window System). The package recognizes. For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, +find the X include and library files automatically, but if it does not, you can use the `configure' options `--x-includes=DIR' and `--x-libraries=DIR' to specify their locations. @@ -170,7 +170,7 @@ where SYSTEM can have one of these forms: OS KERNEL-OS See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't +`config.sub' is not included in this package, then this package does not need to know the machine type. If you are _building_ compiler tools for cross-compiling, you should diff --git a/docs/INSTALL_CMAKE.md b/docs/INSTALL_CMAKE.md index 23a8ce9b..600edad4 100644 --- a/docs/INSTALL_CMAKE.md +++ b/docs/INSTALL_CMAKE.md @@ -107,7 +107,7 @@ or cmake --build . --target RUN_TESTS ``` -How do I use libssh2 in my project if my project doesn't use CMake? +How do I use libssh2 in my project if my project does not use CMake? ------------------------------------------------------------------- If you are not using CMake for your own project, install libssh2 @@ -122,14 +122,14 @@ or ``` and then specify the install location to your project in the normal -way for your build environment. If you don't like the default install +way for your build environment. If you do not like the default install location, add `-DCMAKE_INSTALL_PREFIX=` when initially configuring the project. How can I use libssh2 in my project if it also uses CMake? ---------------------------------------------------------- -If your own project also uses CMake, you don't need to worry about +If your own project also uses CMake, you do not need to worry about setting it up with libssh2's location. Just add just the following lines and CMake will find libssh2 on your system, set up the necessary paths and link the library with your binary. @@ -139,7 +139,7 @@ paths and link the library with your binary. Of course, you still have to make libssh2 available on your system first. You can install it in the traditional way shown above, but you -don't have to. Instead you can just build it, which will export its +do not have to. Instead you can just build it, which will export its location to the user package registry [3] where `find_package` will find it. diff --git a/docs/SECURITY.md b/docs/SECURITY.md index 4dfcf806..99fef457 100644 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -28,8 +28,8 @@ reference to the security nature of the commit if done prior to the public announcement. - The person discovering the issue, the reporter, reports the vulnerability - privately to `libssh2-security@haxx.se`. That's an email alias that reaches a - handful of selected and trusted people. + privately to `libssh2-security@haxx.se`. That is an email alias that reaches + a handful of selected and trusted people. - Messages that do not relate to the reporting or managing of an undisclosed security vulnerability in libssh2 are ignored and no further action is @@ -64,7 +64,7 @@ announcement. [distros@openwall](https://oss-security.openwall.org/wiki/mailing-lists/distros) when also informing and preparing them for the upcoming public security vulnerability announcement - attach the advisory draft for information. Note - that 'distros' won't accept an embargo longer than 14 days. + that 'distros' will not accept an embargo longer than 14 days. - Update the "security advisory" with the CVE number. @@ -90,10 +90,10 @@ LIBSSH2-SECURITY (at haxx dot se) -------------------------------- Who is on this list? There are a couple of criteria you must meet, and then we -might ask you to join the list or you can ask to join it. It really isn't very +might ask you to join the list or you can ask to join it. It really is not very formal. We basically only require that you have a long-term presence in the libssh2 project and you have shown an understanding for the project and its way -of working. You must've been around for a good while and you should have no +of working. You must have been around for a good while and you should have no plans in vanishing in the near future. We do not make the list of participants public mostly because it tends to vary diff --git a/docs/TODO b/docs/TODO index a097c4f0..5a65179a 100644 --- a/docs/TODO +++ b/docs/TODO @@ -5,13 +5,13 @@ Things TODO Improvements" below for details * make sure the windowing code adapts better to slow situations so that it - doesn't then use as much memory as today. Possibly by an app-controllable + does not then use as much memory as today. Possibly by an app-controllable "Window mode"? * Decrease the number of mallocs. Everywhere. Will get easier once the buffering improvements have been done. -* Use SO_NOSIGPIPE for Mac OS/BSD systems where MSG_NOSIGNAL doesn't +* Use SO_NOSIGPIPE for Mac OS/BSD systems where MSG_NOSIGNAL does not exist/work * Extend the test suite to actually test lots of aspects of libssh2 @@ -119,7 +119,7 @@ I suggest we introduce two new helper functions: short return, nothing more should be attempted to get sent until select() (or equivalent) has been used on the master socket again. -I haven't yet figured out a sensible API for how these functions should return +I have not yet figured out a sensible API for how these functions should return that info, but if we agree on the general principles I guess we can work that out. diff --git a/docs/libssh2_agent_connect.3 b/docs/libssh2_agent_connect.3 index 07c683de..e8ba1587 100644 --- a/docs/libssh2_agent_connect.3 +++ b/docs/libssh2_agent_connect.3 @@ -15,7 +15,7 @@ libssh2_agent_connect(LIBSSH2_AGENT *agent); Connect to an ssh-agent running on the system. Call \fBlibssh2_agent_disconnect(3)\fP to close the connection after -you're doing using it. +you are doing using it. .SH RETURN VALUE Returns 0 if succeeded, or a negative value for error. .SH AVAILABILITY diff --git a/docs/libssh2_agent_init.3 b/docs/libssh2_agent_init.3 index 352a73a7..6a535dc7 100644 --- a/docs/libssh2_agent_init.3 +++ b/docs/libssh2_agent_init.3 @@ -17,7 +17,7 @@ representation of an ssh-agent connection. After the successful initialization, an application can call \fBlibssh2_agent_connect(3)\fP to connect to a running ssh-agent. -Call \fBlibssh2_agent_free(3)\fP to free the handle again after you're +Call \fBlibssh2_agent_free(3)\fP to free the handle again after you are doing using it. .SH RETURN VALUE Returns a handle pointer or NULL if something went wrong. The returned handle diff --git a/docs/libssh2_banner_set.3 b/docs/libssh2_banner_set.3 index c443d8f1..11d2d770 100644 --- a/docs/libssh2_banner_set.3 +++ b/docs/libssh2_banner_set.3 @@ -24,7 +24,7 @@ started with .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH AVAILABILITY Marked as deprecated since 1.4.0 .SH ERRORS diff --git a/docs/libssh2_base64_decode.3 b/docs/libssh2_base64_decode.3 index 8856f220..627b89f2 100644 --- a/docs/libssh2_base64_decode.3 +++ b/docs/libssh2_base64_decode.3 @@ -12,7 +12,7 @@ libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest, .fi .SH DESCRIPTION This function is deemed DEPRECATED and will be removed from libssh2 in a -future version. Don't use it! +future version. Do not use it! Decode a base64 chunk and store it into a newly allocated buffer. 'dest_len' will be set to hold the length of the returned buffer that '*dest' will point @@ -22,7 +22,7 @@ The returned buffer is allocated by this function, but it is not clear how to free that memory! .SH BUGS The memory that *dest points to is allocated by the malloc function libssh2 -uses, but there's no way for an application to free this data in a safe and +uses, but there is no way for an application to free this data in a safe and reliable way! .SH RETURN VALUE 0 if successful, \-1 if any error occurred. diff --git a/docs/libssh2_channel_close.3 b/docs/libssh2_channel_close.3 index abc1619c..78d2729b 100644 --- a/docs/libssh2_channel_close.3 +++ b/docs/libssh2_channel_close.3 @@ -20,7 +20,7 @@ connection as well, follow this command with .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. .SH SEE ALSO diff --git a/docs/libssh2_channel_flush_ex.3 b/docs/libssh2_channel_flush_ex.3 index 6e7b167e..0b125fa6 100644 --- a/docs/libssh2_channel_flush_ex.3 +++ b/docs/libssh2_channel_flush_ex.3 @@ -29,4 +29,4 @@ be flushed by number or using one of the provided macros. .SH RETURN VALUE Return the number of bytes flushed or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. diff --git a/docs/libssh2_channel_forward_cancel.3 b/docs/libssh2_channel_forward_cancel.3 index 55cb287b..c43989bb 100644 --- a/docs/libssh2_channel_forward_cancel.3 +++ b/docs/libssh2_channel_forward_cancel.3 @@ -16,7 +16,7 @@ Instruct the remote host to stop listening for new connections on a previously r .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_channel_free.3 b/docs/libssh2_channel_free.3 index 8e63845e..d41f09fb 100644 --- a/docs/libssh2_channel_free.3 +++ b/docs/libssh2_channel_free.3 @@ -19,6 +19,6 @@ can safely free its own resources. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH SEE ALSO .BR libssh2_channel_close(3) diff --git a/docs/libssh2_channel_process_startup.3 b/docs/libssh2_channel_process_startup.3 index 1237e489..e92a19f8 100644 --- a/docs/libssh2_channel_process_startup.3 +++ b/docs/libssh2_channel_process_startup.3 @@ -29,7 +29,7 @@ Initiate a request on a session type channel such as returned by .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_channel_read_ex.3 b/docs/libssh2_channel_read_ex.3 index fed03f90..5dcf3fe4 100644 --- a/docs/libssh2_channel_read_ex.3 +++ b/docs/libssh2_channel_read_ex.3 @@ -36,7 +36,7 @@ macros. .SH RETURN VALUE Actual number of bytes read or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. Note that a return value of zero (0) can in fact be a legitimate value and only signals that no payload data was read. It is not an error. diff --git a/docs/libssh2_channel_request_auth_agent.3 b/docs/libssh2_channel_request_auth_agent.3 index 8ac65972..675eb2a0 100644 --- a/docs/libssh2_channel_request_auth_agent.3 +++ b/docs/libssh2_channel_request_auth_agent.3 @@ -19,4 +19,4 @@ for the duration of the SSH session. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. diff --git a/docs/libssh2_channel_request_pty_ex.3 b/docs/libssh2_channel_request_pty_ex.3 index 4186da2e..f36c82d1 100644 --- a/docs/libssh2_channel_request_pty_ex.3 +++ b/docs/libssh2_channel_request_pty_ex.3 @@ -41,7 +41,7 @@ success. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_channel_send_eof.3 b/docs/libssh2_channel_send_eof.3 index 5e26b026..bbc39376 100644 --- a/docs/libssh2_channel_send_eof.3 +++ b/docs/libssh2_channel_send_eof.3 @@ -14,7 +14,7 @@ channel. Processes typically interpret this as a closed stdin descriptor. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. .SH SEE ALSO diff --git a/docs/libssh2_channel_setenv_ex.3 b/docs/libssh2_channel_setenv_ex.3 index 57e8f9d2..84889b2c 100644 --- a/docs/libssh2_channel_setenv_ex.3 +++ b/docs/libssh2_channel_setenv_ex.3 @@ -33,7 +33,7 @@ server despite returning success. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_channel_wait_closed.3 b/docs/libssh2_channel_wait_closed.3 index 4797b9c3..ab627818 100644 --- a/docs/libssh2_channel_wait_closed.3 +++ b/docs/libssh2_channel_wait_closed.3 @@ -16,7 +16,7 @@ examine the exit status. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative -number, it isn't really a failure per se. +number, it is not really a failure per se. .SH SEE ALSO .BR libssh2_channel_send_eof(3) .BR libssh2_channel_eof(3) diff --git a/docs/libssh2_channel_wait_eof.3 b/docs/libssh2_channel_wait_eof.3 index 44708bc9..59c751da 100644 --- a/docs/libssh2_channel_wait_eof.3 +++ b/docs/libssh2_channel_wait_eof.3 @@ -14,7 +14,7 @@ Wait for the remote end to send EOF. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH SEE ALSO .BR libssh2_channel_send_eof(3) .BR libssh2_channel_eof(3) diff --git a/docs/libssh2_channel_write_ex.3 b/docs/libssh2_channel_write_ex.3 index 467b983b..9ca1c95f 100644 --- a/docs/libssh2_channel_write_ex.3 +++ b/docs/libssh2_channel_write_ex.3 @@ -34,7 +34,7 @@ least 32K of data to this function. .SH RETURN VALUE Actual number of bytes written or negative on failure. LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_channel_x11_req_ex.3 b/docs/libssh2_channel_x11_req_ex.3 index 36c5d1e9..c0584e52 100644 --- a/docs/libssh2_channel_x11_req_ex.3 +++ b/docs/libssh2_channel_x11_req_ex.3 @@ -33,7 +33,7 @@ invoked when the remote host accepts the X11 forwarding. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_exit.3 b/docs/libssh2_exit.3 index 9f8f8438..84f834ec 100644 --- a/docs/libssh2_exit.3 +++ b/docs/libssh2_exit.3 @@ -9,7 +9,7 @@ void libssh2_exit(void); .fi .SH DESCRIPTION -Exit the libssh2 functions and free's all memory used internal. +Exit the libssh2 functions and frees all memory used internal. .SH AVAILABILITY Added in libssh2 1.2.5 .SH SEE ALSO diff --git a/docs/libssh2_knownhost_add.3 b/docs/libssh2_knownhost_add.3 index 7100741b..d0af2b6d 100644 --- a/docs/libssh2_knownhost_add.3 +++ b/docs/libssh2_knownhost_add.3 @@ -53,7 +53,7 @@ LIBSSH2_KNOWNHOST_KEY_RSA1, LIBSSH2_KNOWNHOST_KEY_SSHRSA or LIBSSH2_KNOWNHOST_KEY_SSHDSS. \fIstore\fP should point to a pointer that gets filled in to point to the -known host data after the addition. NULL can be passed if you don't care about +known host data after the addition. NULL can be passed if you do not care about this pointer. .SH RETURN VALUE Returns a regular libssh2 error code, where negative values are error codes diff --git a/docs/libssh2_knownhost_addc.3 b/docs/libssh2_knownhost_addc.3 index 30fc9bc3..21367e11 100644 --- a/docs/libssh2_knownhost_addc.3 +++ b/docs/libssh2_knownhost_addc.3 @@ -58,7 +58,7 @@ LIBSSH2_KNOWNHOST_KEY_RSA1, LIBSSH2_KNOWNHOST_KEY_SSHRSA or LIBSSH2_KNOWNHOST_KEY_SSHDSS. \fIstore\fP should point to a pointer that gets filled in to point to the -known host data after the addition. NULL can be passed if you don't care about +known host data after the addition. NULL can be passed if you do not care about this pointer. .SH RETURN VALUE Returns a regular libssh2 error code, where negative values are error codes diff --git a/docs/libssh2_knownhost_check.3 b/docs/libssh2_knownhost_check.3 index 2524e956..1ce050f5 100644 --- a/docs/libssh2_knownhost_check.3 +++ b/docs/libssh2_knownhost_check.3 @@ -50,7 +50,7 @@ LIBSSH2_KNOWNHOST_CHECK_NOTFOUND - no host match was found LIBSSH2_KNOWNHOST_CHECK_MATCH - hosts and keys match. -LIBSSH2_KNOWNHOST_CHECK_MISMATCH - host was found, but the keys didn't match! +LIBSSH2_KNOWNHOST_CHECK_MISMATCH - host was found, but the keys did not match! .SH AVAILABILITY Added in libssh2 1.2 .SH EXAMPLE diff --git a/docs/libssh2_knownhost_checkp.3 b/docs/libssh2_knownhost_checkp.3 index 6c481011..f35f55ab 100644 --- a/docs/libssh2_knownhost_checkp.3 +++ b/docs/libssh2_knownhost_checkp.3 @@ -55,7 +55,7 @@ LIBSSH2_KNOWNHOST_CHECK_NOTFOUND - no host match was found LIBSSH2_KNOWNHOST_CHECK_MATCH - hosts and keys match. -LIBSSH2_KNOWNHOST_CHECK_MISMATCH - host was found, but the keys didn't match! +LIBSSH2_KNOWNHOST_CHECK_MISMATCH - host was found, but the keys did not match! .SH AVAILABILITY Added in libssh2 1.2.6 .SH EXAMPLE diff --git a/docs/libssh2_knownhost_init.3 b/docs/libssh2_knownhost_init.3 index 0b903be1..d09142be 100644 --- a/docs/libssh2_knownhost_init.3 +++ b/docs/libssh2_knownhost_init.3 @@ -15,7 +15,7 @@ libssh2_knownhost_init(LIBSSH2_SESSION *session); Init a collection of known hosts for this session. Returns the handle to an internal representation of a known host collection. -Call \fBlibssh2_knownhost_free(3)\fP to free the collection again after you're +Call \fBlibssh2_knownhost_free(3)\fP to free the collection again after you are doing using it. .SH RETURN VALUE Returns a handle pointer or NULL if something went wrong. The returned handle diff --git a/docs/libssh2_session_abstract.3 b/docs/libssh2_session_abstract.3 index 7f82b6e5..67129253 100644 --- a/docs/libssh2_session_abstract.3 +++ b/docs/libssh2_session_abstract.3 @@ -17,7 +17,7 @@ Return a pointer to where the abstract pointer provided to de-referenced pointer, the internal storage of the session instance may be modified in place. .SH RETURN VALUE -A pointer to session internal storage who's contents point to previously +A pointer to session internal storage whose contents point to previously provided abstract data. .SH SEE ALSO .BR libssh2_session_init_ex(3) diff --git a/docs/libssh2_session_banner_set.3 b/docs/libssh2_session_banner_set.3 index 2ba53cae..2581a622 100644 --- a/docs/libssh2_session_banner_set.3 +++ b/docs/libssh2_session_banner_set.3 @@ -21,7 +21,7 @@ corresponding to the protocol and libssh2 version will be sent by default. .SH RETURN VALUE 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 -number, it isn't really a failure per se. +number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. .SH AVAILABILITY diff --git a/docs/libssh2_session_callback_set.3 b/docs/libssh2_session_callback_set.3 index ed578b40..4c06db42 100644 --- a/docs/libssh2_session_callback_set.3 +++ b/docs/libssh2_session_callback_set.3 @@ -46,8 +46,8 @@ ssize_t sendcb(libssh2_socket_t sockfd, const void *buffer, \fBsockfd\fP is the socket to write to, \fBbuffer\fP points to the data to send, \fBlength\fP is the size of the data, \fBflags\fP is the flags that -would've 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. +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. 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 @@ -65,7 +65,7 @@ ssize_t recvcb(libssh2_socket_t sockfd, void *buffer, \fBsockfd\fP is the socket to read from, \fBbuffer\fP where to store received data into, \fBlength\fP is the size of the buffer, \fBflags\fP is the flags -that would've 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. The callback returns the number of bytes read, or -1 for error. The special diff --git a/docs/libssh2_session_disconnect_ex.3 b/docs/libssh2_session_disconnect_ex.3 index 961791de..85d54a40 100644 --- a/docs/libssh2_session_disconnect_ex.3 +++ b/docs/libssh2_session_disconnect_ex.3 @@ -36,6 +36,6 @@ and \fIlang\fP set to an empty string. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH SEE ALSO .BR libssh2_session_init_ex(3) diff --git a/docs/libssh2_session_free.3 b/docs/libssh2_session_free.3 index 12b12c86..c0de271f 100644 --- a/docs/libssh2_session_free.3 +++ b/docs/libssh2_session_free.3 @@ -14,7 +14,7 @@ Frees all resources associated with a session instance. Typically called after .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH SEE ALSO .BR libssh2_session_init_ex(3) .BR libssh2_session_disconnect_ex(3) diff --git a/docs/libssh2_session_method_pref.3 b/docs/libssh2_session_method_pref.3 index 1e7718ec..7038b585 100644 --- a/docs/libssh2_session_method_pref.3 +++ b/docs/libssh2_session_method_pref.3 @@ -27,7 +27,7 @@ as they are used during the protocol initiation phase. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid. diff --git a/docs/libssh2_sftp_close_handle.3 b/docs/libssh2_sftp_close_handle.3 index 5450d450..b5d862d8 100644 --- a/docs/libssh2_sftp_close_handle.3 +++ b/docs/libssh2_sftp_close_handle.3 @@ -26,7 +26,7 @@ are macros for \fBlibssh2_sftp_close_handle(3)\fP. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_sftp_fstat_ex.3 b/docs/libssh2_sftp_fstat_ex.3 index 2a559f94..04eccbde 100644 --- a/docs/libssh2_sftp_fstat_ex.3 +++ b/docs/libssh2_sftp_fstat_ex.3 @@ -85,7 +85,7 @@ Test for a socket .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_sftp_fsync.3 b/docs/libssh2_sftp_fsync.3 index d293d2e6..7766ed9c 100644 --- a/docs/libssh2_sftp_fsync.3 +++ b/docs/libssh2_sftp_fsync.3 @@ -20,7 +20,7 @@ For this to work requires fsync@openssh.com support on the server. .SH RETURN VALUE Returns 0 on success or negative on failure. If used in non-blocking mode, it returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_sftp_mkdir_ex.3 b/docs/libssh2_sftp_mkdir_ex.3 index 946b6e63..0ec51738 100644 --- a/docs/libssh2_sftp_mkdir_ex.3 +++ b/docs/libssh2_sftp_mkdir_ex.3 @@ -31,7 +31,7 @@ Create a directory on the remote file system. .SH RETURN VALUE Return 0 on success or negative on failure. LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_sftp_read.3 b/docs/libssh2_sftp_read.3 index 9d874223..c1709ef5 100644 --- a/docs/libssh2_sftp_read.3 +++ b/docs/libssh2_sftp_read.3 @@ -29,7 +29,7 @@ to block. .SH RETURN VALUE Number of bytes actually populated into buffer, or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_sftp_readdir_ex.3 b/docs/libssh2_sftp_readdir_ex.3 index cdac3ddb..c655298e 100644 --- a/docs/libssh2_sftp_readdir_ex.3 +++ b/docs/libssh2_sftp_readdir_ex.3 @@ -41,7 +41,7 @@ statbuf style data into. .SH RETURN VALUE Number of bytes actually populated into buffer (not counting the terminating zero), or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would -otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't +otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH BUG Passing in a too small buffer for 'buffer' or 'longentry' when receiving data diff --git a/docs/libssh2_sftp_rename_ex.3 b/docs/libssh2_sftp_rename_ex.3 index 7731bcff..b6d4a5d3 100644 --- a/docs/libssh2_sftp_rename_ex.3 +++ b/docs/libssh2_sftp_rename_ex.3 @@ -46,7 +46,7 @@ and/or using native system calls when possible. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_sftp_rmdir_ex.3 b/docs/libssh2_sftp_rmdir_ex.3 index bb1db085..c2682970 100644 --- a/docs/libssh2_sftp_rmdir_ex.3 +++ b/docs/libssh2_sftp_rmdir_ex.3 @@ -23,7 +23,7 @@ remove. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_sftp_shutdown.3 b/docs/libssh2_sftp_shutdown.3 index 1a22a475..d3424499 100644 --- a/docs/libssh2_sftp_shutdown.3 +++ b/docs/libssh2_sftp_shutdown.3 @@ -18,6 +18,6 @@ associated with it. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH SEE ALSO .BR libssh2_sftp_init(3) diff --git a/docs/libssh2_sftp_stat_ex.3 b/docs/libssh2_sftp_stat_ex.3 index 2484a97f..14974cb0 100644 --- a/docs/libssh2_sftp_stat_ex.3 +++ b/docs/libssh2_sftp_stat_ex.3 @@ -61,7 +61,7 @@ struct LIBSSH2_SFTP_ATTRIBUTES { .SH RETURN VALUE 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 -number, it isn't really a failure per se. +number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_sftp_statvfs.3 b/docs/libssh2_sftp_statvfs.3 index 5f083a58..c38cc14a 100644 --- a/docs/libssh2_sftp_statvfs.3 +++ b/docs/libssh2_sftp_statvfs.3 @@ -60,7 +60,7 @@ Set-user-ID/set-group-ID bits are ignored by \fBexec\fP(3). .SH RETURN VALUE Returns 0 on success or negative on failure. If used in non-blocking mode, it returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_sftp_symlink_ex.3 b/docs/libssh2_sftp_symlink_ex.3 index f0f485da..377ae975 100644 --- a/docs/libssh2_sftp_symlink_ex.3 +++ b/docs/libssh2_sftp_symlink_ex.3 @@ -57,7 +57,7 @@ number of bytes it copied to the target buffer (not including the terminating zero) or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. From 1.2.8, LIBSSH2_ERROR_BUFFER_TOO_SMALL is returned if the given 'target' buffer is too small to fit the requested object name. diff --git a/docs/libssh2_sftp_unlink_ex.3 b/docs/libssh2_sftp_unlink_ex.3 index 05861c60..9a0107bb 100644 --- a/docs/libssh2_sftp_unlink_ex.3 +++ b/docs/libssh2_sftp_unlink_ex.3 @@ -25,7 +25,7 @@ Unlink (delete) a file from the remote filesystem. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_sftp_write.3 b/docs/libssh2_sftp_write.3 index 6ca0171e..8b62e941 100644 --- a/docs/libssh2_sftp_write.3 +++ b/docs/libssh2_sftp_write.3 @@ -33,15 +33,15 @@ create several smaller outgoing packets for all data you pass to this function and it will return a positive number as soon as the first packet is acknowledged from the server. -This has the effect that sometimes more data has been sent off but isn't acked +This has the effect that sometimes more data has been sent off but is not acked yet when this function returns, and when this function is subsequently called again to write more data, libssh2 will immediately figure out that the data is already received remotely. In most normal situation this should not cause any problems, but it should be -noted that if you've once called libssh2_sftp_write() with data and it returns -short, you MUST still assume that the rest of the data might've been cached so -you need to make sure you don't alter that data and think that the version you +noted that if you have once called libssh2_sftp_write() with data and it returns +short, you MUST still assume that the rest of the data might have been cached so +you need to make sure you do not alter that data and think that the version you have in your next function invoke will be detected or used. The reason for this funny behavior is that SFTP can only send 32K data in each @@ -52,7 +52,7 @@ latency connections. And we want that. Actual number of bytes written or negative on failure. If used in non-blocking mode, it returns LIBSSH2_ERROR_EAGAIN when it would -otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't +otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. If this function returns 0 (zero) it should not be considered an error, but diff --git a/docs/libssh2_userauth_keyboard_interactive_ex.3 b/docs/libssh2_userauth_keyboard_interactive_ex.3 index cc8daa45..8e392aa7 100644 --- a/docs/libssh2_userauth_keyboard_interactive_ex.3 +++ b/docs/libssh2_userauth_keyboard_interactive_ex.3 @@ -47,7 +47,7 @@ may use keyboard-interactive authentication type too. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative -number, it isn't really a failure per se. +number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_userauth_password_ex.3 b/docs/libssh2_userauth_password_ex.3 index aa5d8601..d63d2e08 100644 --- a/docs/libssh2_userauth_password_ex.3 +++ b/docs/libssh2_userauth_password_ex.3 @@ -42,7 +42,7 @@ PAM or another authentication backed) instead. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS Some of the errors this function may return include: diff --git a/docs/libssh2_userauth_publickey_fromfile_ex.3 b/docs/libssh2_userauth_publickey_fromfile_ex.3 index d060d68f..3d7cead0 100644 --- a/docs/libssh2_userauth_publickey_fromfile_ex.3 +++ b/docs/libssh2_userauth_publickey_fromfile_ex.3 @@ -34,7 +34,7 @@ on disk .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_userauth_publickey_frommemory.3 b/docs/libssh2_userauth_publickey_frommemory.3 index 6bd26fd1..f3b8cbe6 100644 --- a/docs/libssh2_userauth_publickey_frommemory.3 +++ b/docs/libssh2_userauth_publickey_frommemory.3 @@ -17,7 +17,7 @@ libssh2_userauth_publickey_frommemory(LIBSSH2_SESSION *session, .fi .SH DESCRIPTION This function allows to authenticate a session with a public key read from memory. -It's only supported when libssh2 is backed by OpenSSL. +It is only supported when libssh2 is backed by OpenSSL. \fIsession\fP - Session instance as returned by .BR libssh2_session_init_ex(3) @@ -39,7 +39,7 @@ Attempt public key authentication using a PEM encoded private key file stored in .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. diff --git a/docs/libssh2_userauth_publickey_sk.3 b/docs/libssh2_userauth_publickey_sk.3 index bee31eae..bff76837 100644 --- a/docs/libssh2_userauth_publickey_sk.3 +++ b/docs/libssh2_userauth_publickey_sk.3 @@ -127,7 +127,7 @@ NULL. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While -LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. +LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. .SH ERRORS Some of the errors this function may return include: diff --git a/docs/libssh2_version.3 b/docs/libssh2_version.3 index 2fe99a3d..6bd49036 100644 --- a/docs/libssh2_version.3 +++ b/docs/libssh2_version.3 @@ -19,7 +19,7 @@ bit number in the 0xMMmmpp format. MM for major, mm for minor and pp for patch number. .SH RETURN VALUE The version number of libssh2 is returned as a pointer to a zero terminated -string or NULL if the \fIrequired_version\fP isn't fulfilled. +string or NULL if the \fIrequired_version\fP is not fulfilled. .SH EXAMPLE To make sure you run with the correct libssh2 version: diff --git a/example/scp_write.c b/example/scp_write.c index ac66c0f1..7da38ac7 100644 --- a/example/scp_write.c +++ b/example/scp_write.c @@ -84,7 +84,7 @@ int main(int argc, char *argv[]) local = fopen(loclfile, "rb"); if(!local) { - fprintf(stderr, "Can't open local file %s\n", loclfile); + fprintf(stderr, "Cannot open local file %s\n", loclfile); return 1; } diff --git a/example/scp_write_nonblock.c b/example/scp_write_nonblock.c index 2cc176c2..996778cb 100644 --- a/example/scp_write_nonblock.c +++ b/example/scp_write_nonblock.c @@ -122,7 +122,7 @@ int main(int argc, char *argv[]) local = fopen(loclfile, "rb"); if(!local) { - fprintf(stderr, "Can't open local file %s\n", loclfile); + fprintf(stderr, "Cannot open local file %s\n", loclfile); return 1; } diff --git a/example/sftp_RW_nonblock.c b/example/sftp_RW_nonblock.c index 023aefbd..61dda867 100644 --- a/example/sftp_RW_nonblock.c +++ b/example/sftp_RW_nonblock.c @@ -167,7 +167,7 @@ int main(int argc, char *argv[]) tempstorage = fopen(storage, "wb"); if(!tempstorage) { - fprintf(stderr, "Can't open temp storage file %s\n", storage); + fprintf(stderr, "Cannot open temp storage file %s\n", storage); goto shutdown; } @@ -271,8 +271,8 @@ int main(int argc, char *argv[]) tempstorage = fopen(storage, "rb"); if(!tempstorage) { - /* weird, we can't read the file we just wrote to... */ - fprintf(stderr, "can't open %s for reading\n", storage); + /* weird, we cannot read the file we just wrote to... */ + fprintf(stderr, "Cannot open %s for reading\n", storage); goto shutdown; } diff --git a/example/sftp_append.c b/example/sftp_append.c index db80e106..6793ccb7 100644 --- a/example/sftp_append.c +++ b/example/sftp_append.c @@ -92,7 +92,7 @@ int main(int argc, char *argv[]) local = fopen(loclfile, "rb"); if(!local) { - fprintf(stderr, "Can't open local file %s\n", loclfile); + fprintf(stderr, "Cannot open local file %s\n", loclfile); return 1; } diff --git a/example/sftp_write.c b/example/sftp_write.c index 62b0ee0f..b2169e40 100644 --- a/example/sftp_write.c +++ b/example/sftp_write.c @@ -91,7 +91,7 @@ int main(int argc, char *argv[]) local = fopen(loclfile, "rb"); if(!local) { - fprintf(stderr, "Can't open local file %s\n", loclfile); + fprintf(stderr, "Cannot open local file %s\n", loclfile); return 1; } diff --git a/example/sftp_write_nonblock.c b/example/sftp_write_nonblock.c index 958084b7..602a780c 100644 --- a/example/sftp_write_nonblock.c +++ b/example/sftp_write_nonblock.c @@ -128,7 +128,7 @@ int main(int argc, char *argv[]) local = fopen(loclfile, "rb"); if(!local) { - fprintf(stderr, "Can't open local file %s\n", loclfile); + fprintf(stderr, "Cannot open local file %s\n", loclfile); return 1; } diff --git a/example/sftp_write_sliding.c b/example/sftp_write_sliding.c index b8169002..b1b7972b 100644 --- a/example/sftp_write_sliding.c +++ b/example/sftp_write_sliding.c @@ -128,7 +128,7 @@ int main(int argc, char *argv[]) local = fopen(loclfile, "rb"); if(!local) { - fprintf(stderr, "Can't open local file %s\n", loclfile); + fprintf(stderr, "Cannot open local file %s\n", loclfile); return 1; } diff --git a/example/ssh2_agent.c b/example/ssh2_agent.c index 3bf66e47..6ad76313 100644 --- a/example/ssh2_agent.c +++ b/example/ssh2_agent.c @@ -165,7 +165,7 @@ int main(int argc, char *argv[]) prev_identity = identity; } if(rc) { - fprintf(stderr, "Couldn't continue authentication\n"); + fprintf(stderr, "Could not continue authentication\n"); goto shutdown; } } diff --git a/example/ssh2_agent_forwarding.c b/example/ssh2_agent_forwarding.c index 8718e885..047920c9 100644 --- a/example/ssh2_agent_forwarding.c +++ b/example/ssh2_agent_forwarding.c @@ -185,7 +185,7 @@ int main(int argc, char *argv[]) prev_identity = identity; } if(rc) { - fprintf(stderr, "Couldn't continue authentication\n"); + fprintf(stderr, "Could not continue authentication\n"); goto shutdown; } @@ -214,8 +214,8 @@ int main(int argc, char *argv[]) waitsocket(sock, session); } if(rc) { - fprintf(stderr, "Error, couldn't request auth agent, error code %d.\n", - rc); + fprintf(stderr, "Error, could not request auth agent, " + "error code %d.\n", rc); exit(1); } else { diff --git a/maketgz b/maketgz index 2fae14b9..3f5a1932 100755 --- a/maketgz +++ b/maketgz @@ -79,7 +79,7 @@ findprog() { # if { findprog automake >/dev/null 2>/dev/null; } then - echo "- Could not find or run automake, I hope you know what you're doing!" + echo "- Could not find or run automake, I hope you know what you are doing!" else echo "Runs automake --include-deps" automake --include-deps Makefile >/dev/null diff --git a/src/channel.c b/src/channel.c index 8aee7b52..cf094298 100644 --- a/src/channel.c +++ b/src/channel.c @@ -2361,7 +2361,7 @@ _libssh2_channel_write(LIBSSH2_CHANNEL *channel, int stream_id, if(channel->local.close) return _libssh2_error(channel->session, LIBSSH2_ERROR_CHANNEL_CLOSED, - "We've already closed this channel"); + "We have already closed this channel"); else if(channel->local.eof) return _libssh2_error(channel->session, LIBSSH2_ERROR_CHANNEL_EOF_SENT, diff --git a/tests/test_auth_keyboard_fail.c b/tests/test_auth_keyboard_fail.c index e8e5942b..e697d3df 100644 --- a/tests/test_auth_keyboard_fail.c +++ b/tests/test_auth_keyboard_fail.c @@ -4,5 +4,5 @@ int test(LIBSSH2_SESSION *session) { return test_auth_keyboard(session, TEST_AUTH_SHOULDFAIL, "libssh2", /* set in Dockerfile */ - "I'm the wrong password"); + "I am the wrong password"); } diff --git a/tests/test_auth_password_fail_password.c b/tests/test_auth_password_fail_password.c index c1383213..0991f5ef 100644 --- a/tests/test_auth_password_fail_password.c +++ b/tests/test_auth_password_fail_password.c @@ -4,5 +4,5 @@ int test(LIBSSH2_SESSION *session) { return test_auth_password(session, TEST_AUTH_SHOULDFAIL, "libssh2", /* set in Dockerfile */ - "I'm the wrong password"); + "I am the wrong password"); } diff --git a/tests/test_auth_password_fail_username.c b/tests/test_auth_password_fail_username.c index 6478d0f4..f6ea33a0 100644 --- a/tests/test_auth_password_fail_username.c +++ b/tests/test_auth_password_fail_username.c @@ -3,6 +3,6 @@ int test(LIBSSH2_SESSION *session) { return test_auth_password(session, TEST_AUTH_SHOULDFAIL, - "I'm the wrong username", + "I am the wrong username", "my test password"); /* set in Dockerfile */ }