RELEASE-NOTES: synced with 6bd584d29 for 1.4.0

We're bumping the minor number

AUTHORS

@@ -29,6 +29,7 @@ Mikhail Gusarov
 Neil Gierman
 Olivier Hervieu
 Paul Veldkamp
+Peter Krempa
 Peter O'Gorman
 Peter Stuge
 Romain Bondue

Makefile.am

@@ -25,12 +25,10 @@ VMSFILES = vms/libssh2_make_example.dcl vms/libssh2_make_help.dcl	\
 vms/libssh2_make_kit.dcl vms/libssh2_make_lib.dcl vms/man2help.c	\
 vms/readme.vms vms/libssh2_config.h
 
-
-WIN32FILES = win32/Makefile.win32 win32/libssh2.dsw     \
-win32/config.mk win32/Makefile win32/test/Makefile.win32 \
-win32/libssh2_config.h win32/tests.dsp win32/rules.mk $(DSP) \
-win32/msvcproj.head win32/msvcproj.foot win32/libssh2.rc \
-win32/Makefile.Watcom
+WIN32FILES = win32/GNUmakefile win32/test/GNUmakefile		\
+win32/libssh2_config.h win32/config.mk win32/rules.mk		\
+win32/Makefile.Watcom win32/libssh2.dsw win32/tests.dsp $(DSP)	\
+win32/msvcproj.head win32/msvcproj.foot win32/libssh2.rc
 
 EXTRA_DIST = $(WIN32FILES) buildconf $(NETWAREFILES) get_ver.awk HACKING \
  maketgz NMakefile TODO RELEASE-NOTES libssh2.pc.in $(VMSFILES)

RELEASE-NOTES

@@ -1,44 +1,30 @@
-libssh2 1.2.8
+libssh2 1.4.0
 
 This release includes the following changes:
 
- o added libssh2_free, libssh2_channel_get_exit_signal and
-   libssh2_session_handshake
- o SFTP read/write remade and now MUCH faster, especially on high latency
-   connections
- o added new examples: ssh2_echo.c, sftp_append.c and sftp_write_sliding.c
- o userauth: derive publickey from private
- o NEWS: now generated from git
+ o Added libssh2_session_supported_algs()
+ o Added libssh2_session_banner_get()
+ o Added libssh2_sftp_get_channel()
+ o libssh2.h: bump the default window size to 256K
 
 This release includes the following bugfixes:
 
- o Support unlimited number of host names in a single line of the
-   known_hosts file.
- o fix memory leak in userauth_keyboard_interactive()
- o fix memory leaks (two times cipher_data) for each sftp session
- o session_startup: manage server data before server identification
- o SCP: allow file names with bytes > 126
- o scp_recv: improved treatment of channel_read() returning zero
- o libssh2_userauth_authenticated: make it work as documented
- o variable size cleanup: match internal variable sizes better with the sizes
-   of the fields used on the wire
- o channel_request_pty_size: fix reqPTY_state
- o sftp_symlink: return error if receive buffer too small
- o sftp_readdir: return error if buffer is too small
- o libssh2_knownhost_readfile.3: clarify return value
- o configure: stop using the deprecated AM_INIT_AUTOMAKE syntax
- o Fixed Win32 makefile which was now broken at resource build
- o kex_agree_hostkey: fix NULL pointer derefence
- o _libssh2_ntohu64: fix conversion from network bytes to uint64
- o ssize_t: proper typedef with MSVC compilers
- o zlib: Add debug tracing of zlib errors
- o decomp: increase decompression buffer sizes
+ o sftp-seek: clear EOF flag
+ o userauth: Provide more informations if ssh pub key extraction fails
+ o ssh2_exec: skip error outputs for EAGAIN
+ o LIBSSH2_SFTP_PACKET_MAXLEN: increase to 80000
+ o knownhost_check(): Don't dereference ext if NULL is passed
+ o knownhost_add: Avoid dereferencing uninitialized memory on error path
+ o OpenSSL EVP: fix threaded use of structs
+ o _libssh2_channel_read: react on errors from receive_window_adjust
+ o sftp_read: cap the read ahead maximum amount
+ o _libssh2_channel_read: fix non-blocking window adjusting
 
 This release would not have looked like this without help, code, reports and
 advice from friends like these:
 
- Alexander Lamaison, Alfred Gebert, Guenter Knauf, Dan Fandrich,
- Daniel Stenberg, Jasmeet Bagga, Joey Degges, Mark Smith, Peter Stuge,
- Pierre Joye, Simon Josefsson, TJ Saunders, Tommy Lindgren
+ Gellule Xg, Jernej Kovacic, Peter Krempa, Vincent Torri, Kamil Dudka,
+ Peter Stuge, Guenter Knauf, John Engstrom, Alexander Lamaison,
+ Mikhail Gusarov
  
         Thanks! (and sorry if I forgot to mention someone)

TODO

@@ -8,12 +8,6 @@ Things TODO
   doesn't then use as much memory as today. Possibly by an app-controllable
   "Window mode"?
 
-* Introduce a function that can free data that is returned allocated from the
-  lib, like when libssh2_session_last_error() is asked to return the string
-  with 'want_buf' set to non-zero.
-
-* Add more info to the man pages.
-
 * Decrease the number of mallocs. Everywhere. Will get easier once the
   buffering improvements have been done.
 
@@ -26,10 +20,6 @@ Things TODO
 
 * Expose error messages sent by the server
 
-* Make SFTP transfers ask for and send several packages at once so that it
-  doesn't have to send-waitforack-send-waitforack as much. This will be
-  easier/smoother if we implement the "New SFTP API" described below.
-
 * select() is troublesome with libssh2 when using multiple channels over
   the same session. See "New Transport API" below for more details.
 
@@ -51,6 +41,7 @@ At next SONAME bump
   libssh2_poll()
   libssh2_poll_channel_read()
   libssh2_session_startup() (libssh2_session_handshake() is the replacement)
+  libssh2_banner_set() (libssh2_session_banner_set() is the repacement)
 
 * Rename a few function:
 

configure.ac

@@ -15,12 +15,14 @@ if test "x$SED" = "xsed-was-not-found-by-configure"; then
 fi
 
 dnl figure out the libssh2 version
-VERSION=`$SED -ne 's/^#define LIBSSH2_VERSION *"\(.*\)"/\1/p' ${srcdir}/include/libssh2.h`
+LIBSSH2VER=`$SED -ne 's/^#define LIBSSH2_VERSION *"\(.*\)"/\1/p' ${srcdir}/include/libssh2.h`
 AM_INIT_AUTOMAKE
 AC_MSG_CHECKING([libssh2 version])
-AC_MSG_RESULT($VERSION)
+AC_MSG_RESULT($LIBSSH2VER)
 
-AB_VERSION=$VERSION
+AC_SUBST(LIBSSH2VER)
+
+AB_VERSION=$LIBSSH2VER
 
 AB_INIT
 
@@ -30,7 +32,7 @@ AB_INIT
 AC_CANONICAL_HOST
 case "$host" in
     *-mingw*)
-    CFLAGS="$CFLAGS -DLIBSSH2_WIN32 -DWINSOCK_VERSION=0x0200"
+    CFLAGS="$CFLAGS -DLIBSSH2_WIN32"
     LIBS="$LIBS -lws2_32"
     ;;
 	*-cygwin)
@@ -289,7 +291,7 @@ AC_OUTPUT
 
 AC_MSG_NOTICE([summary of build options:
 
-  version:          ${VERSION}
+  version:          ${LIBSSH2VER}
   Host type:        ${host}
   Install prefix:   ${prefix}
   Compiler:         ${CC}

docs/Makefile.am

@@ -25,8 +25,8 @@ dist_man_MANS = \
 	libssh2_channel_forward_listen.3 \
 	libssh2_channel_forward_listen_ex.3 \
 	libssh2_channel_free.3 \
-	libssh2_channel_get_exit_status.3 \
 	libssh2_channel_get_exit_signal.3 \
+	libssh2_channel_get_exit_status.3 \
 	libssh2_channel_handle_extended_data.3 \
 	libssh2_channel_handle_extended_data2.3 \
 	libssh2_channel_ignore_extended_data.3 \
@@ -61,10 +61,10 @@ dist_man_MANS = \
 	libssh2_channel_x11_req_ex.3 \
 	libssh2_exit.3 \
 	libssh2_free.3 \
-	libssh2_free_host_entry.3 \
-	libssh2_host_entry_match.3 \
 	libssh2_hostkey_hash.3 \
 	libssh2_init.3 \
+	libssh2_keepalive_config.3 \
+	libssh2_keepalive_send.3 \
 	libssh2_knownhost_add.3 \
 	libssh2_knownhost_addc.3 \
 	libssh2_knownhost_check.3 \
@@ -77,7 +77,6 @@ dist_man_MANS = \
 	libssh2_knownhost_readline.3 \
 	libssh2_knownhost_writefile.3 \
 	libssh2_knownhost_writeline.3 \
-	libssh2_new_host_entry.3 \
 	libssh2_poll.3 \
 	libssh2_poll_channel_read.3 \
 	libssh2_publickey_add.3 \
@@ -90,9 +89,11 @@ dist_man_MANS = \
 	libssh2_publickey_shutdown.3 \
 	libssh2_scp_recv.3 \
 	libssh2_scp_send.3 \
-	libssh2_scp_send_ex.3 \
 	libssh2_scp_send64.3 \
+	libssh2_scp_send_ex.3 \
 	libssh2_session_abstract.3 \
+	libssh2_session_banner_get.3 \
+	libssh2_session_banner_set.3 \
 	libssh2_session_block_directions.3 \
 	libssh2_session_callback_set.3 \
 	libssh2_session_disconnect.3 \
@@ -100,6 +101,7 @@ dist_man_MANS = \
 	libssh2_session_flag.3 \
 	libssh2_session_free.3 \
 	libssh2_session_get_blocking.3 \
+	libssh2_session_get_timeout.3 \
 	libssh2_session_hostkey.3 \
 	libssh2_session_init.3 \
 	libssh2_session_init_ex.3 \
@@ -108,7 +110,9 @@ dist_man_MANS = \
 	libssh2_session_method_pref.3 \
 	libssh2_session_methods.3 \
 	libssh2_session_set_blocking.3 \
+	libssh2_session_set_timeout.3 \
 	libssh2_session_startup.3 \
+	libssh2_session_supported_algs.3 \
 	libssh2_sftp_close.3 \
 	libssh2_sftp_close_handle.3 \
 	libssh2_sftp_closedir.3 \
@@ -116,6 +120,7 @@ dist_man_MANS = \
 	libssh2_sftp_fstat.3 \
 	libssh2_sftp_fstat_ex.3 \
 	libssh2_sftp_fstatvfs.3 \
+	libssh2_sftp_get_channel.3 \
 	libssh2_sftp_init.3 \
 	libssh2_sftp_last_error.3 \
 	libssh2_sftp_lstat.3 \

docs/libssh2_banner_set.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_banner_set.3,v 1.3 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_banner_set - set the SSH prococol banner for the local client
@@ -10,6 +8,9 @@ int
 libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);
 
 .SH DESCRIPTION
+This function is \fBDEPRECATED\fP. Use \fIlibssh2_session_banner_set(3)\fP
+instead!
+
 \fIsession\fP - Session instance as returned by 
 .BR libssh2_session_init_ex(3)
 
@@ -17,16 +18,15 @@ libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);
 
 Set the banner that will be sent to the remote host when the SSH session is 
 started with 
-.BR libssh2_session_startup(3)
+.BR libssh2_session_handshake(3)
   This is optional; a banner corresponding to the protocol and libssh2 version will be sent by default.
-
 .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.
-
+.SH AVAILABILITY
+Marked as deprecated since 1.4.0
 .SH ERRORS
 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
-
 .SH SEE ALSO
-.BR libssh2_session_startup(3)
+.BR libssh2_session_handshake(3)

docs/libssh2_base64_decode.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_base64_decode.3,v 1.3 2009/02/17 16:22:51 dottedmag Exp $
-.\"
 .TH libssh2_base64_decode 3 "23 Dec 2008" "libssh2 1.0" "libssh2 manual"
 .SH NAME
 libssh2_base64_decode - decode a base64 encoded string

docs/libssh2_channel_close.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_close.3,v 1.3 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_close 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_close - close a channel

docs/libssh2_channel_direct_tcpip.3

@@ -1,12 +1,11 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_direct_tcpip 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_tcpip_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_direct_tcpip(arguments)
+LIBSSH2_CHANNEL *
+libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +15,4 @@ See \fIlibssh2_channel_direct_tcpip_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_direct_tcpip_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_direct_tcpip_ex(3)\fP
+.BR libssh2_channel_direct_tcpip_ex(3)

docs/libssh2_channel_direct_tcpip_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_direct_tcpip_ex.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_channel_direct_tcpip_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session

docs/libssh2_channel_eof.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_eof.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_eof - check a channel's EOF status

docs/libssh2_channel_exec.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_exec 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_exec(arguments)
+int libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *command);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_process_startup(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_process_startup(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_process_startup(3)\fP
+.BR libssh2_channel_process_startup(3)

docs/libssh2_channel_flush.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_flush 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_flush(arguments)
+int libssh2_channel_flush(LIBSSH2_CHANNEL *channel);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_flush_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_flush_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_flush_ex(3)\fP
+.BR libssh2_channel_flush_ex(3)

docs/libssh2_channel_flush_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_flush_ex.3,v 1.1 2007/06/13 19:53:09 jehousley Exp $
-.\"
 .TH libssh2_channel_flush_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_flush_ex - flush a channel

docs/libssh2_channel_flush_stderr.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_flush_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_flush_stderr(arguments)
+int libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_flush_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_flush_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_flush_ex(3)\fP
+.BR libssh2_channel_flush_ex(3)

docs/libssh2_channel_forward_accept.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_forward_accept.3,v 1.6 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_forward_accept - accept a queued connection
@@ -15,7 +13,8 @@ libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener);
 .SH RETURN VALUE
 A newly allocated channel instance or NULL on failure.
 .SH ERRORS
-\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call 
-would block.
+When this function returns NULL use \fIlibssh2_session_last_errno(3)\fP to
+extract the error code. If that code is \fILIBSSH2_ERROR_EAGAIN\fP, the
+session is set to do non-blocking I/O but the call would block.
 .SH SEE ALSO
 .BR libssh2_channel_forward_listen_ex(3)

docs/libssh2_channel_forward_cancel.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_forward_cancel.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_forward_cancel 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_forward_cancel - cancel a forwarded TCP port

docs/libssh2_channel_forward_listen.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_forward_listen 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forward_listen_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_forward_listen(arguments)
+int libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_forward_listen_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_forward_listen_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_forward_listen_ex(3)\fP
+.BR libssh2_channel_forward_listen_ex(3)

docs/libssh2_channel_forward_listen_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_forward_listen_ex.3,v 1.7 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_forward_listen_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_forward_listen_ex - listen to inbound connections

docs/libssh2_channel_free.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_free.3,v 1.1 2007/06/13 20:09:15 jehousley Exp $
-.\"
 .TH libssh2_channel_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_free - free all resources associated with a channel

docs/libssh2_channel_get_exit_signal.3

@@ -1,5 +1,3 @@
-.\" $Id$
-.\"
 .TH libssh2_channel_get_exit_signal 3 "4 Oct 2010" "libssh2 1.2.8" "libssh2 manual"
 .SH NAME
 libssh2_channel_get_exit_signal - get the remote exit signal

docs/libssh2_channel_get_exit_status.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_get_exit_status.3,v 1.1 2007/06/15 10:53:04 jehousley Exp $
-.\"
 .TH libssh2_channel_get_exit_status 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_get_exit_status - get the remote exit code

docs/libssh2_channel_handle_extended_data.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_handle_extended_data.3,v 1.2 2009/03/26 15:41:16 bagder Exp $
-.\"
 .TH libssh2_channel_handle_extended_data 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_handle_extended_data - set extended data handling mode

docs/libssh2_channel_handle_extended_data2.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_handle_extended_data2.3,v 1.1 2007/06/13 20:09:15 jehousley Exp $
-.\"
 .TH libssh2_channel_handle_extended_data2 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_handle_extended_data2 - set extended data handling mode

docs/libssh2_channel_ignore_extended_data.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_ignore_extended_data 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_handle_extended_data(3)\fP calls
@@ -9,6 +7,9 @@ libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_
 libssh2_channel_ignore_extended_data(arguments)
 
 .SH DESCRIPTION
+This function is deprecated. Use the
+\fIlibssh2_channel_handle_extended_data2(3)\fP function instead!
+
 This is a macro defined in a public libssh2 header file that is using the
 underlying function \fIlibssh2_channel_handle_extended_data(3)\fP.
 .SH RETURN VALUE
@@ -16,4 +17,4 @@ See \fIlibssh2_channel_handle_extended_data(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_handle_extended_data(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_handle_extended_data(3)\fP
+.BR libssh2_channel_handle_extended_data(3)

docs/libssh2_channel_open_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_open_ex.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_channel_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_open_ex - establish a generic session channel

docs/libssh2_channel_open_session.3

@@ -1,12 +1,11 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_open_session 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_open_session(arguments)
+LIBSSH2_CHANNEL *
+libssh2_channel_open_session(LIBSSH2_SESSION *session);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +15,4 @@ See \fIlibssh2_channel_open_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_open_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_open_ex(3)\fP
+.BR libssh2_channel_open_ex(3)

docs/libssh2_channel_process_startup.3

@@ -1,23 +1,15 @@
-.\" $Id: libssh2_channel_process_startup.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_process_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_process_startup - request a shell on a channel
 .SH SYNOPSIS
+.nf
 #include <libssh2.h>
 
-int
-libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel, const char *request, unsigned int request_len, const char *message, unsigned int message_len);
-
-int
-libssh2_channel_shell(LIBSSH2_CHANNEL *channel);
-
-int
-libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *message);
-
-int
-libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *message);
-
+int libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel,
+                                    const char *request,
+                                    unsigned int request_len,
+                                    const char *message,
+                                    unsigned int message_len);
 .SH DESCRIPTION
 \fIchannel\fP - Active session channel instance.
 

docs/libssh2_channel_read.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_read(arguments)
+ssize_t libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_read_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_read_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_read_ex(3)\fP
+.BR libssh2_channel_read_ex(3)

docs/libssh2_channel_read_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_read_ex.3,v 1.10 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_read_ex - read data from a channel stream

docs/libssh2_channel_read_stderr.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_read_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_read_stderr(arguments)
+ssize_t libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_read_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_read_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_read_ex(3)\fP
+.BR libssh2_channel_read_ex(3)

docs/libssh2_channel_receive_window_adjust.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_receive_window_adjust.3,v 1.3 2009/03/26 15:41:16 bagder Exp $
-.\"
 .TH libssh2_channel_receive_window_adjust 3 "15 Mar 2009" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_receive_window_adjust - adjust the channel window

docs/libssh2_channel_receive_window_adjust2.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_receive_window_adjust2.3,v 1.1 2009/03/26 15:41:16 bagder Exp $
-.\"
 .TH libssh2_channel_receive_window_adjust2 3 "26 Mar 2009" "libssh2 1.1" "libssh2 manual"
 .SH NAME
 libssh2_channel_receive_window_adjust2 - adjust the channel window

docs/libssh2_channel_request_pty.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_request_pty 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_pty_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_request_pty(arguments)
+int libssh2_channel_request_pty(LIBSSH2_SESSION *session, const char *term);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_request_pty_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_request_pty_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_request_pty_ex(3)\fP
+.BR libssh2_channel_request_pty_ex(3)

docs/libssh2_channel_request_pty_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_request_pty_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_request_pty_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_request_pty_ex - short function description

docs/libssh2_channel_request_pty_size.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_request_pty_size 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_request_pty_size_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_request_pty_size(arguments)
+int libssh2_channel_request_pty_size(LIBSSH2_CHANNEL *channel, int width, int height);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_request_pty_size_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_request_pty_size_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_request_pty_size_ex(3)\fP
+.BR libssh2_channel_request_pty_size_ex(3)

docs/libssh2_channel_request_pty_size_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_request_pty_size_ex.3,v 1.1 2009/03/16 15:00:45 bagder Exp $
-.\"
 .TH libssh2_channel_request_pty_size_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_request_pty_size_ex - TODO

docs/libssh2_channel_send_eof.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_send_eof.3,v 1.1 2007/06/13 21:07:59 jehousley Exp $
-.\"
 .TH libssh2_channel_send_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_send_eof - send EOF to remote server

docs/libssh2_channel_set_blocking.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_set_blocking.3,v 1.6 2009/03/26 15:41:16 bagder Exp $
-.\"
 .TH libssh2_channel_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_set_blocking - set or clear blocking mode on channel

docs/libssh2_channel_setenv.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_setenv 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_setenv(arguments)
+int libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, const char *varname, const char *value);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_setenv_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_setenv_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_setenv_ex(3)\fP
+.BR libssh2_channel_setenv_ex(3)

docs/libssh2_channel_setenv_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_setenv_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_setenv_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_setenv_ex - set an environment variable on the channel

docs/libssh2_channel_shell.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_shell 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_shell(arguments)
+int libssh2_channel_shell(LIBSSH2_CHANNEL *channel);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_process_startup(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_process_startup(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_process_startup(3)\fP
+.BR libssh2_channel_process_startup(3)

docs/libssh2_channel_subsystem.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_subsystem 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_subsystem(arguments)
+int libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *subsystem);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_process_startup(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_process_startup(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_process_startup(3)\fP
+.BR libssh2_channel_process_startup(3)

docs/libssh2_channel_wait_closed.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_wait_closed.3,v 1.2 2007/11/29 10:04:16 bagder Exp $
-.\"
 .TH libssh2_channel_wait_closed 3 "29 Nov 2007" "libssh2 0.19" "libssh2 manual"
 .SH NAME
 libssh2_channel_wait_closed - wait for the remote to close the channel

docs/libssh2_channel_wait_eof.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_wait_eof.3,v 1.5 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_wait_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_wait_eof - wait for the remote to reply to an EOF request

docs/libssh2_channel_window_read.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_window_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_read_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_window_read(arguments)
+unsigned long libssh2_channel_window_read(LIBSSH2_CHANNEL *channel);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_window_read_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_window_read_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_window_read_ex(3)\fP
+.BR libssh2_channel_window_read_ex(3)

docs/libssh2_channel_window_read_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_window_read_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_window_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_window_read_ex - Check the status of the read window

docs/libssh2_channel_window_write.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_window_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_write_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_window_write(arguments)
+unsigend long libssh2_channel_window_write(LIBSSH2_CHANNEL *channel);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_window_write_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_window_write_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_window_write_ex(3)\fP
+.BR libssh2_channel_window_write_ex(3)

docs/libssh2_channel_window_write_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_window_write_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_window_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_window_write_ex - Check the status of the write window

docs/libssh2_channel_write.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP
@@ -7,8 +5,8 @@ libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP
 .nf
 #include <libssh2.h>
 
-#define libssh2_channel_write(channel, buf, buflen) \\
-  libssh2_channel_write_ex((channel), 0, (buf), (buflen))
+ssize_t libssh2_channel_write(LIBSSH2_CHANNEL *channel, const char *buf, size_t buflen);
+
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
 underlying function \fIlibssh2_channel_write_ex(3)\fP.
@@ -17,4 +15,4 @@ See \fIlibssh2_channel_write_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_write_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_write_ex(3)\fP
+.BR libssh2_channel_write_ex(3)

docs/libssh2_channel_write_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_write_ex.3,v 1.6 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_write_ex - write data to a channel stream blocking

docs/libssh2_channel_write_stderr.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_write_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex(3)\fP
@@ -7,8 +5,8 @@ libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex
 .nf
 #include <libssh2.h>
 
-#define libssh2_channel_write_stderr(channel, buf, buflen)  \\
-  libssh2_channel_write_ex((channel), SSH_EXTENDED_DATA_STDERR, (buf), (buflen))
+ssize_t libssh2_channel_write_stderr(LIBSSH2_CHANNEL *channel, const char *buf, size_t buflen);
+
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
 underlying function \fIlibssh2_channel_write_ex(3)\fP.
@@ -17,4 +15,4 @@ See \fIlibssh2_channel_write_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_write_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_write_ex(3)\fP
+.BR libssh2_channel_write_ex(3)

docs/libssh2_channel_x11_req.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_x11_req 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_channel_x11_req(arguments)
+int libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_channel_x11_req_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_channel_x11_req_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_channel_x11_req_ex(3)\fP
+.BR libssh2_channel_x11_req_ex(3)

docs/libssh2_channel_x11_req_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_x11_req_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_x11_req_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_x11_req_ex - request an X11 forwarding channel

docs/libssh2_free_host_entry.3

@@ -1,14 +0,0 @@
-.\" $Id: libssh2_free_host_entry.3,v 1.1 2009/03/16 15:00:45 bagder Exp $
-.\"
-.TH libssh2_free_host_entry 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
-.SH NAME
-libssh2_free_host_entry - TODO
-.SH SYNOPSIS
-
-.SH DESCRIPTION
-
-.SH RETURN VALUE
-
-.SH ERRORS
-
-.SH SEE ALSO

docs/libssh2_host_entry_match.3

@@ -1,14 +0,0 @@
-.\" $Id: libssh2_host_entry_match.3,v 1.1 2009/03/16 15:00:45 bagder Exp $
-.\"
-.TH libssh2_host_entry_match 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
-.SH NAME
-libssh2_host_entry_match - TODO
-.SH SYNOPSIS
-
-.SH DESCRIPTION
-
-.SH RETURN VALUE
-
-.SH ERRORS
-
-.SH SEE ALSO

docs/libssh2_hostkey_hash.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_hostkey_hash.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_hostkey_hash 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_hostkey_hash - return a hash of the remote host's key

docs/libssh2_keepalive_config.3

@@ -0,0 +1,27 @@
+.TH libssh2_keepalive_config 3 "12 Apr 2011" "libssh2 1.2.5" "libssh2 manual"
+.SH NAME
+libssh2_keepalive_config - short function description
+.SH SYNOPSIS
+#include <libssh2.h>
+.nf
+
+void libssh2_keepalive_config(LIBSSH2_SESSION *session,
+                              int want_reply,
+                              unsigned interval);
+.fi
+.SH DESCRIPTION
+Set how often keepalive messages should be sent. \fBwant_reply\fP indicates
+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
+default) to disable keepalives.  To avoid some busy-loop corner-cases, if you
+specify an interval of 1 it will be treated as 2.
+
+Note that non-blocking applications are responsible for sending the keepalive
+messages using \fBlibssh2_keepalive_send(3)\fP.
+.SH RETURN VALUE
+Nothing
+.SH AVAILABILITY
+Added in libssh2 1.2.5
+.SH SEE ALSO
+.BR libssh2_keepalive_send(3)
+

docs/libssh2_keepalive_send.3

@@ -0,0 +1,18 @@
+.TH libssh2_keepalive_send 3 "13 Apr 2011" "libssh2 1.2.5" "libssh2 manual"
+.SH NAME
+libssh2_keepalive_send - short function description
+.SH SYNOPSIS
+#include <libssh2.h>
+.nf
+
+int libssh2_keepalive_send(LIBSSH2_SESSION *session,
+                           int *seconds_to_next);
+.SH DESCRIPTION
+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.
+.SH RETURN VALUE
+Returns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors.
+.SH AVAILABILITY
+Added in libssh2 1.2.5
+.SH SEE ALSO
+.BR libssh2_keepalive_config(3)

docs/libssh2_new_host_entry.3

@@ -1,14 +0,0 @@
-.\" $Id: libssh2_new_host_entry.3,v 1.1 2009/03/16 15:00:45 bagder Exp $
-.\"
-.TH libssh2_new_host_entry 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
-.SH NAME
-libssh2_new_host_entry - TODO
-.SH SYNOPSIS
-
-.SH DESCRIPTION
-
-.SH RETURN VALUE
-
-.SH ERRORS
-
-.SH SEE ALSO

docs/libssh2_poll.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_poll.3,v 1.4 2009/04/14 21:38:36 bagder Exp $
-.\"
 .TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_poll - poll for activity on a socket, channel or listener

docs/libssh2_poll_channel_read.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_poll_channel_read.3,v 1.3 2009/04/14 21:38:36 bagder Exp $
-.\"
 .TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_poll_channel_read - check if data is available

docs/libssh2_publickey_add.3

@@ -1,12 +1,13 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_publickey_add 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_publickey_add(arguments)
+int libssh2_publickey_add(LIBSSH2_PUBLICKEY *pkey,
+			  const unsigned char *name,
+                          const unsigned char *blob, unsigned long blob_len, char overwrite,
+                          unsigned long num_attrs, const libssh2_publickey_attribute attrs[]);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +17,4 @@ See \fIlibssh2_publickey_add_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_publickey_add_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_publickey_add_ex(3)\fP
+.BR libssh2_publickey_add_ex(3)

docs/libssh2_publickey_add_ex.3

@@ -1,14 +1,25 @@
-.\" $Id: libssh2_publickey_add_ex.3,v 1.1 2009/03/16 15:00:45 bagder Exp $
-.\"
 .TH libssh2_publickey_add_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
-libssh2_publickey_add_ex - TODO
+libssh2_publickey_add_ex - Add a public key entry
 .SH SYNOPSIS
+#include <libssh2.h>
+
+int
+libssh2_publickey_add_ex(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name,
+                         unsigned long name_len, const unsigned char *blob,
+                         unsigned long blob_len, char overwrite,
+                         unsigned long num_attrs,
+                         const libssh2_publickey_attribute attrs[])
 
 .SH DESCRIPTION
-
+TBD
 .SH RETURN VALUE
-
+Returns 0 on success, negative on failure.
 .SH ERRORS
-
+LIBSSH2_ERROR_BAD_USE
+LIBSSH2_ERROR_ALLOC,
+LIBSSH2_ERROR_EAGAIN
+LIBSSH2_ERROR_SOCKET_SEND,
+LIBSSH2_ERROR_SOCKET_TIMEOUT,
+LIBSSH2_ERROR_PUBLICKEY_PROTOCOL,
 .SH SEE ALSO

docs/libssh2_publickey_init.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_publickey_init.3,v 1.1 2009/03/16 15:00:45 bagder Exp $
-.\"
 .TH libssh2_publickey_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_publickey_init - TODO

docs/libssh2_publickey_list_fetch.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_publickey_list_fetch.3,v 1.1 2009/03/16 15:00:45 bagder Exp $
-.\"
 .TH libssh2_publickey_list_fetch 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_publickey_list_fetch - TODO

docs/libssh2_publickey_list_free.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_publickey_list_free.3,v 1.1 2009/03/16 15:00:45 bagder Exp $
-.\"
 .TH libssh2_publickey_list_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_publickey_list_free - TODO

docs/libssh2_publickey_remove.3

@@ -1,12 +1,12 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_publickey_remove 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_publickey_remove(arguments)
+int libssh2_publickey_remove(LIBSSH2_PUBLICKEY *pkey,
+			     const unsigned char *name, unsigned long name_len,
+			     const unsigned char *blob, unsigned long blob_len);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +16,4 @@ See \fIlibssh2_publickey_remove_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_publickey_remove_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_publickey_remove_ex(3)\fP
+.BR libssh2_publickey_remove_ex(3)

docs/libssh2_publickey_remove_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_publickey_remove_ex.3,v 1.1 2009/03/16 15:00:45 bagder Exp $
-.\"
 .TH libssh2_publickey_list_remove_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_publickey_list_remove_ex - TODO

docs/libssh2_publickey_shutdown.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_publickey_shutdown.3,v 1.1 2009/03/16 15:00:45 bagder Exp $
-.\"
 .TH libssh2_publickey_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_publickey_shutdown - TODO

docs/libssh2_scp_recv.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_scp_recv.3,v 1.3 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_scp_recv 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_scp_recv - request a remote file via SCP

docs/libssh2_scp_send.3

@@ -1,12 +1,11 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_scp_send 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_scp_send(arguments)
+LIBSSH2_CHANNEL *
+libssh2_scp_send(LIBSSH2_SESSION *session, const char *path, int mode, size_t size);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +15,4 @@ See \fIlibssh2_scp_send_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_scp_send_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_scp_send_ex(3)\fP
+.BR libssh2_scp_send_ex(3)

docs/libssh2_scp_send64.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_scp_send_ex.3,v 1.3 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_scp_send64 3 "17 Apr 2010" "libssh2 1.2.6" "libssh2 manual"
 .SH NAME
 libssh2_scp_send64 - Send a file via SCP

docs/libssh2_scp_send_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_scp_send_ex.3,v 1.3 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_scp_send_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_scp_send_ex - Send a file via SCP

docs/libssh2_session_abstract.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_abstract.3,v 1.2 2008/07/03 10:58:53 bagder Exp $
-.\"
 .TH libssh2_session_abstract 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_abstract - return a pointer to a session's abstract pointer

docs/libssh2_session_banner_get.3

@@ -0,0 +1,21 @@
+.TH libssh2_session_banner_get 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual"
+.SH NAME
+libssh2_session_banner_get - get the remote banner
+.SH SYNOPSIS
+#include <libssh2.h>
+
+const char *libssh2_session_banner_get(oLIBSSH2_SESSION *session);
+.SH DESCRIPTION
+Once the session has been setup and \fIlibssh2_session_handshake(3)\fP has
+completed successfully, this function can be used to get the server id from
+the banner each server presents.
+.SH RETURN VALUE
+A pointer to a string or NULL if something failed. The data pointed to will be
+allocated and associated to the session handle and will be freed by libssh2
+when \fIlibssh2_session_free(3)\fP is used.
+.SH AVAILABILITY
+Added in 1.4.0
+.SH SEE ALSO
+.BR libssh2_session_banner_set(3),
+.BR libssh2_session_handshake(3),
+.BR libssh2_session_free(3)

docs/libssh2_session_banner_set.3

@@ -0,0 +1,32 @@
+.TH libssh2_session_banner_set 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual"
+.SH NAME
+libssh2_session_banner_set - set the SSH prococol banner for the local client
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIbanner\fP - A pointer to a zero-terminated string holding the user defined
+banner
+
+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
+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.
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+.SH AVAILABILITY
+Added in 1.4.0.
+
+Before 1.4.0 this function was known as libssh2_banner_set(3)
+.SH SEE ALSO
+.BR libssh2_session_handshake(3),
+.BR libssh2_session_banner_get(3)

docs/libssh2_session_block_directions.3

@@ -1,8 +1,6 @@
-.\" $Id: libssh2_session_block_directions.3,v 1.3 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_session_block_directions 3 "1 Oct 2008" "libssh2 1.0" "libssh2 manual"
 .SH NAME
-libssh2_session_block_directions - get directions that socket should wait for before calling libssh2 function again
+libssh2_session_block_directions - get directions to wait for
 .SH SYNOPSIS
 #include <libssh2.h>
 
@@ -26,6 +24,6 @@ LIBSSH2_SESSION_BLOCK_OUTBOUND: Outbound direction blocked.
 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
 should contain the session socket in readfds set.  Correspondingly in case of
-\fBLIBSSH2_SESSION_BLOCK_INBOUND\fP writefds set should contain the socket.
+\fBLIBSSH2_SESSION_BLOCK_OUTBOUND\fP writefds set should contain the socket.
 .SH AVAILABILITY
 Added in 1.0

docs/libssh2_session_callback_set.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_callback_set.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_session_callback_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_callback_set - set a callback function
@@ -33,6 +31,12 @@ Called when a mismatched MAC has been detected in the transport layer. If the
 function returns 0, the packet will be accepted nonetheless.
 .IP LIBSSH2_CALLBACK_X11
 Called when an X11 connection has been accepted
+.IP LIBSSH2_CALLBACK_SEND
+Called when libssh2 wants to send some data on the connection.
+Can be set to a custom function to handle I/O your own way.
+.IP LIBSSH2_CALLBACK_RECV
+Called when libssh2 wants to receive some data from the connection.
+Can be set to a custom function to handle I/O your own way.
 .SH RETURN VALUE
 Pointer to previous callback handler. Returns NULL if no prior callback
 handler was set or the callback type was unknown.

docs/libssh2_session_disconnect.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_session_disconnect 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_session_disconnect - convenience macro for \fIlibssh2_session_disconnect_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_session_disconnect(arguments)
+int libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_session_disconnect_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_session_disconnect_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_session_disconnect_ex(3)\fP
+.BR libssh2_session_disconnect_ex(3)

docs/libssh2_session_disconnect_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_disconnect_ex.3,v 1.5 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_session_disconnect_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_disconnect_ex - terminate transport layer

docs/libssh2_session_flag.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_flag.3,v 1.2 2009/03/23 13:17:49 bagder Exp $
-.\"
 .TH libssh2_session_flag 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_flag - TODO

docs/libssh2_session_free.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_free.3,v 1.5 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_free - frees resources associated with a session instance

docs/libssh2_session_get_blocking.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_get_blocking.3,v 1.2 2009/03/23 13:20:48 bagder Exp $
-.\"
 .TH libssh2_session_get_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_get_blocking - TODO

docs/libssh2_session_get_timeout.3

@@ -0,0 +1,19 @@
+.TH libssh2_session_get_timeout 3 "4 May 2011" "libssh2 1.2.9" "libssh2 manual"
+.SH NAME
+libssh2_session_get_timeout - get the timeout for blocking functions
+.SH SYNOPSIS
+#include <libssh2.h>
+.nf
+long libssh2_session_get_timeout(LIBSSH2_SESSION *session);
+.SH DESCRIPTION
+Returns the \fBtimeout\fP (in milliseconds) for how long a blocking the
+libssh2 function calls may wait until they consider the situation an error and
+return LIBSSH2_ERROR_TIMEOUT.
+
+By default libssh2 has no timeout (zero) for blocking functions.
+.SH RETURN VALUE
+The value of the timeout setting.
+.SH AVAILABILITY
+Added in 1.2.9
+.SH SEE ALSO
+.BR libssh2_session_set_timeout(3)

docs/libssh2_session_handshake.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_handshake.3,v 1.7 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_session_handshake 3 "7 Oct 2010" "libssh2 1.2.8" "libssh2 manual"
 .SH NAME
 libssh2_session_handshake - perform the SSH handshake

docs/libssh2_session_hostkey.3

@@ -1,5 +1,3 @@
-.\" $Id: session_hostkey.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_session_hostkey 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_hostkey - get the remote key

docs/libssh2_session_init.3

@@ -1,12 +1,11 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_session_init 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_session_init - convenience macro for \fIlibssh2_session_init_ex(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_session_init(arguments)
+LIBSSH2_SESSION *
+libssh2_session_init(void);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +15,4 @@ See \fIlibssh2_session_init_ex(3)\fP
 .SH ERRORS
 See \fIlibssh2_session_init_ex(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_session_init_ex(3)\fP
+.BR libssh2_session_init_ex(3)

docs/libssh2_session_init_ex.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_init_ex.3,v 1.1 2009/03/16 14:40:37 bagder Exp $
-.\"
 .TH libssh2_session_init_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_init_ex - initializes an SSH session object
@@ -41,4 +39,4 @@ starting up an SSH session with a remote server.
 Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on errors.
 .SH SEE ALSO
 .BR libssh2_session_free(3)
-.BR libssh2_session_startup(3)
+.BR libssh2_session_handshake(3)

docs/libssh2_session_last_errno.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_last_errno.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_session_last_errno 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_last_errno - get the most recent error number

docs/libssh2_session_last_error.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_last_error.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_session_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_last_error - get the most recent error

docs/libssh2_session_method_pref.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_method_pref.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_session_method_pref 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_method_pref - set preferred key exchange method
@@ -22,7 +20,7 @@ ignored and not sent to the remote host during protocol negotiation.
 
 Set preferred methods to be negotiated. These 
 preferrences must be set prior to calling 
-.BR libssh2_session_startup(3)
+.BR libssh2_session_handshake(3)
 as they are used during the protocol initiation phase.
 
 .SH RETURN VALUE
@@ -39,4 +37,4 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
 
 .SH SEE ALSO
 .BR libssh2_session_init_ex(3)
-.BR libssh2_session_startup(3)
+.BR libssh2_session_handshake(3)

docs/libssh2_session_methods.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_methods.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_session_methods 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_methods - return the currently active algorithms

docs/libssh2_session_set_blocking.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_set_blocking.3,v 1.3 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_session_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_set_blocking - set or clear blocking mode on session

docs/libssh2_session_set_timeout.3

@@ -0,0 +1,20 @@
+.TH libssh2_session_set_timeout 3 "4 May 2011" "libssh2 1.2.9" "libssh2 manual"
+.SH NAME
+libssh2_session_set_timeout - set timeout for blocking functions
+.SH SYNOPSIS
+#include <libssh2.h>
+.nf
+void libssh2_session_set_timeout(LIBSSH2_SESSION *session, long timeout);
+.SH DESCRIPTION
+Set the \fBtimeout\fP in milliseconds for how long a blocking the libssh2
+function calls may wait until they consider the situation an error and return
+LIBSSH2_ERROR_TIMEOUT.
+
+By default or if you set the timeout to zero, libssh2 has no timeout for
+blocking functions.
+.SH RETURN VALUE
+Nothing
+.SH AVAILABILITY
+Added in 1.2.9
+.SH SEE ALSO
+.BR libssh2_session_get_timeout(3)

docs/libssh2_session_startup.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_session_startup.3,v 1.7 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_startup - begin transport layer

docs/libssh2_session_supported_algs.3

@@ -0,0 +1,74 @@
+.TH libssh2_session_supported_algs 3 "23 Oct 2011" "libssh2 1.4.0" "libssh2 manual"
+.SH NAME
+libssh2_session_supported_algs - get list of supported algorithms
+.SH SYNOPSIS
+.nf
+#include <libssh2.h>
+
+int libssh2_session_supported_algs(LIBSSH2_SESSION* session,
+                                   int method_type,
+                                   const char*** algs);
+.SH DESCRIPTION
+\fIsession\fP - An instance of initialized LIBSSH2_SESSION (the function will
+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
+pointer that will point to an array af returned algorithms
+
+Get a list of supported algorithms for the given \fImethod_type\fP. The
+method_type parameter is equivalent to method_type in
+\fIlibssh2_session_method_pref(3)\fP. If successful, the function will
+allocate the appropriate amount of memory. When not needed anymore, it must be
+deallocated by calling \fIlibssh2_free(3)\fP. When this function is
+unsuccessful, this must not be done.
+
+In order to get a list of all supported compression algorithms,
+libssh2_session_flag(session, LIBSSH2_FLAG_COMPRESS, 1) must be called before
+calling this function, otherwise only "none" will be returned.
+
+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
+terminated.
+.SH EXAMPLE
+.nf
+#include "libssh2.h"
+
+const char **algorithms;
+int rc, i;
+LIBSSH2_SESSION *session;
+
+/* initilize session */
+session = libssh2_session_init();
+rc = libssh2_session_supported_algs(session,
+                                    LIBSSH2_METHOD_CRYPT_CS,
+                                    &algorithms);
+if (rc>0) {
+    /* the call succeeded, do sth. with the list of algorithms
+       (e.g. list them)... */
+    printf("Supported symmetric algorithms:\n");
+    for ( i=0; i<rc; i++ )
+        printf("\t%s\n", algorithms[i]);
+
+    /* ... and free the allocated memory when not needed anymore */
+    libssh2_free(session, algorithms);
+}
+else {
+    /* call failed, error handling */
+}
+.SH RETURN VALUE
+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)
+is returned.  0 should never be returned.
+.SH ERRORS
+\fILIBSSH2_ERROR_BAD_USE\fP - Invalid address of algs.
+
+\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP -  Unknown method type.
+
+\fILIBSSH2_ERROR_INVAL\fP - Internal error (normally should not occur).
+
+\fILIBSSH2_ERROR_ALLOC\fP - Allocation of memory failed.
+.SH AVAILABILITY
+Added in 1.4.0
+.SH SEE ALSO
+.BR libssh2_session_methods(3),
+.BR libssh2_session_method_pref(3)
+.BR libssh2_free(3)

docs/libssh2_sftp_close.3

@@ -1,12 +1,10 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_sftp_close 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_sftp_close - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls
 .SH SYNOPSIS
 #include <libssh2.h>
 
-libssh2_sftp_close(arguments)
+int libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle);
 
 .SH DESCRIPTION
 This is a macro defined in a public libssh2 header file that is using the
@@ -16,4 +14,4 @@ See \fIlibssh2_sftp_close_handle(3)\fP
 .SH ERRORS
 See \fIlibssh2_sftp_close_handle(3)\fP
 .SH SEE ALSO
-.BR \fIlibssh2_sftp_close_handle(3)\fP
+.BR libssh2_sftp_close_handle(3)

docs/libssh2_sftp_close_handle.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_sftp_close_handle.3,v 1.3 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_sftp_close_handle 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_sftp_close_handle - close filehandle