release 1.1

until _after_ we're done as otherwise we might not get called again properly
to clean the entire thing since the close state is checked in
libssh2_channel_free

.cvsusers

@@ -1,5 +1,5 @@
 jas4711:Simon Josefsson <simon@josefsson.org>
-bagder:Daniel Stenberg <daniel@haxx.se>
+bagder:Daniel Stenberg
 sarag:Sara Golemon <pollita@libssh2.org>
 gusarov:Mikhail Gusarov <dottedmag@dottedmag.net>
 wez:Wez Furlong
@@ -7,3 +7,5 @@ edink:Edink Kadribasic
 jehousley: James Housley
 gknauf: Guenter Knauf
 dfandrich: Dan Fandrich
+yangtse: Yang Tse
+thomaspu: Paul Thomas

AUTHORS

@@ -1,9 +1,15 @@
 * Sara Golemon: Author / Project Manager
 
-* Simon Josefsson: libgcrypt support
+* Daniel Stenberg: Co-maintainer
 
-* Daniel Stenberg: Nonblocking fixes, Build Improvements, and Daily snapshot artist
+* James Housleys: Nonblocking conversion
+
+* Simon Josefsson: libgcrypt support
 
 * Mikhail Gusarov: Keyboard Interactive Authentication
 
 * Wez Furlong & Edink Kadribasic: Windows Port
+
+* Dan Fandrich: bug fixes, cleanups
+
+* Guenter Knauf: win32 work and more

HACKING

@@ -0,0 +1,32 @@
+
+libssh2 source code style guide:
+
+ - 4 level indent
+ - spaces-only (no tabs)
+ - open braces on the if/for line:
+
+     if (banana) {
+         go_nuts();
+     }
+
+ - write both braces on the else line:
+
+     if (banana) {
+         go_nuts();
+     } else {
+         stay_calm();
+     }
+
+ - use braces even for single-statement blocks
+ 
+ - keep source lines shorter than 80 columns
+
+------------
+
+ Older libssh2 code that still hasn't quite transitioned to the above
+ mentioned style, used a different style:
+
+ - indented with tabs (only)
+
+ - no line length limits
+

Makefile.am

@@ -5,10 +5,55 @@ include_HEADERS =			\
 	include/libssh2_publickey.h	\
 	include/libssh2_sftp.h
 
-EXTRA_DIST = win32 buildconf
+NETWAREFILES =  nw/keepscreen.c \
+ nw/Makefile \
+ nw/Makefile.netware \
+ nw/nwlib.c \
+ nw/test/Makefile.netware
+
+WIN32FILES = win32/libssh2_dll.dsp win32/libssh2.dsw win32/Makefile.win32      \
+win32/config.mk win32/Makefile win32/test/Makefile.win32 win32/libssh2_lib.dsp \
+win32/libssh2_config.h win32/tests.dsp win32/rules.mk
+
+EXTRA_DIST = $(WIN32FILES) buildconf $(NETWAREFILES) get_ver.awk HACKING \
+ maketgz NMakefile TODO
 
 ACLOCAL_AMFLAGS = -I m4
 
 .PHONY: ChangeLog
 ChangeLog:
-	cvs2cl --utc --fsf --FSF --usermap .cvsusers -I ChangeLog -I .cvs
+	if test -f .cvsusers; then \
+	  cvs2cl --utc --fsf --FSF --usermap .cvsusers -I ChangeLog -I .cvs; \
+	fi
+
+dist-hook:
+	rm -rf $(top_builddir)/tests/log
+	find $(distdir) -name "*.dist" -exec rm {} \;
+	(distit=`find $(srcdir) -name "*.dist"`; \
+	for file in $$distit; do \
+	  strip=`echo $$file | sed -e s/^$(srcdir)// -e s/\.dist//`; \
+	  cp $$file $(distdir)$$strip; \
+	done)
+
+# Code Coverage
+
+init-coverage:
+	make clean
+	lcov --directory . --zerocounters
+
+COVERAGE_CCOPTS ?= "-g --coverage"
+COVERAGE_OUT ?= docs/coverage
+
+build-coverage:
+	make CFLAGS=$(COVERAGE_CCOPTS) check
+	mkdir -p $(COVERAGE_OUT)
+	lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
+		--capture
+
+gen-coverage:
+	genhtml --output-directory $(COVERAGE_OUT) \
+		$(COVERAGE_OUT)/$(PACKAGE).info \
+		--highlight --frames --legend \
+		--title "$(PACKAGE_NAME)"
+
+coverage: init-coverage build-coverage gen-coverage

NEWS

@@ -1,5 +1,239 @@
-Version 
-------------
+Version 1.1 (April 2, 2009)
+---------------------------
+
+- (Mar 28 2009) Daniel Stenberg:
+
+  Jean-Louis Charton found a memory leak in
+  libssh2_userauth_hostbased_fromfile_ex()
+
+- (Mar 25 2009) Daniel Stenberg:
+
+   * Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed
+     and introduced a transport.h header.
+
+   * Fixed the blocking mode to only change behavior not the actual underlying
+     socket mode so we now always work with non-blocking sockets. This also
+     introduces a new rule of thumb in libssh2 code: we don't call the
+     external function calls internally. We use the internal (non-blocking)
+     ones!
+
+   * libssh2_channel_receive_window_adjust2 was added and
+     libssh2_channel_receive_window_adjust is now deprecated
+
+   * Introduced "local" header files with prototypes etc for different parts
+     instead of cramming everything into libssh2_priv.h. channel.h is the
+     first.
+
+- (Mar 19 2009) Daniel Stenberg: based on a patch by "E L" we now use errno
+  properly after recv() and send() calls (that internally are now known as
+  _libssh2_recv() and _libssh2_send()) so that the API and more works fine on
+  windows too!
+
+- (Mar 17 2009) Simon Josefsson:
+
+  Added a Libtool -export-symbols-regex flag to reduce the number of
+  exported symbols in shared libraries.  Reported by Mikhail Gusarov.
+
+- (Mar 16 2009) Daniel Stenberg:
+
+  I renamed a few man pages to match the exact name of the functions they
+  describe. I also added template versions for the 13 functions that
+  previously lacked man pages. While these don't contain any docs just yet, it
+  will now be easier to add the info as the foundation is there!
+
+- (Mar 15 2009) Daniel Stenberg:
+
+  * libssh2_channel_read_ex() was simplified and enhanced. It now adjusts the
+    window less frequent and uses much larger window that now allows MUCH
+    faster transfers.
+
+  * SCP send/recv now allow file names with whitespaces etc, thanks to a patch
+    by Heiner Steven
+
+- (Mar 13 2009) Daniel Stenberg: Cleanups, that do seem to have boosted SFTP
+  download performance up to 300% in some tests:
+
+  * cut off "_ex" from several internal function names
+
+  * corrected some log outputs
+
+  * simplified libssh2_channel_read_ex() and made it much faster in the process
+
+  * cut out {{{ and }}} comments that were incorrect anyway
+
+  * fixed sftp_packet_ask() to return the correct packet by using memcmp() and
+    not strncmp()
+
+  * fixed mkdir()'s wait for packet to use the correct request_id - it
+    semi-worked previously because strncmp() in sftp_packet_ask() made it
+    match far too easily.
+
+  * took away the polling functionality from sftp_packet_ask() since it wasn't
+    used
+
+- (Mar 7 2009) Olivier Hervieu pointed out a flaw in the
+  libssh2_channel_x11_req_ex() function that made it produce a crappy random
+  chunk of data. Peter Stuge improved the fix to not do out-of-boundary
+  writes. I (Daniel Stenberg) replaced the snprintf() with a plain sprintf()
+  since the size argument wasn't adding anything anyway.
+
+- (Feb 23 2009) Added libssh2_version()
+
+- (Feb 20 2009) libssh2_channel_direct_tcpip_ex() bug #1902169 fixed, which
+  caused it to fail when called a second time.
+
+- (Feb 12 2009) Romain Bondue extended Markus Moeller fix from Feb 8, based on
+  a previous (uncommitted) patch by Erik Brossler. It improves
+  libssh2_channel_write_ex in blocking situations when the socket is set non-
+  blocking.
+
+- (Feb 8 2009) Markus Moeller fixed a flaw in libssh2_channel_write_ex() that
+  would occur on EAGAIN situations.
+
+Version 1.0 (December 26 2008)
+------------------------------
+
+- (Dec 20 2008) Based on Alexander Lamaison's patch, there's now a new
+  function called libssh2_sftp_tell64() that returns the 64 bit file offset,
+  as the existing libssh2_sftp_tell() only returns a size_t.
+
+- (Dec 18 2008) Markus Moeller fixed the issue also reported by Alexander
+  Lamaison which caused SFTP reads with large buffers to fail.
+
+- Several flaws were fixed that prevented at least SFTP to work reliably
+
+- Vlad Grachov brought the new function called
+  libssh2_session_block_directions() which returns a bitmask for what
+  directions the connection blocks. It is to be used applications that use
+  non-blocking sockets and when a libssh2 function returns
+  LIBSSH2_ERROR_EAGAIN this function can be used to figure out in which
+  direction the socket would block and thus it can wait for the socket to
+  again be ready for communication in that direction before it calls libssh2
+  again.
+
+- Vincent Jaulin brought the new libssh2_channel_request_pty_size_ex()
+  function.
+
+- Carlo Bramini fixed the build for msys+mingw. Bug #1943976.
+
+- Neil Gierman provided improved Visual Studio 2008 code in bug #1946268
+
+- Bug #1862727 fixed libssh2_poll() to work on windows (by defining
+  HAVE_SELECT).
+
+- Based on bug #1815692, we introduce libssh2_sftp_seek64() that allows
+  seeking beyond the 2GB margin even on 32bit machines.
+
+- Based on a patch in bug #1878059 by Steven Ayre libssh2 now parses >2GB file
+  sizes when downloading SCP files.
+
+- Bug #2064371 pointed out that the SSH2 banner may not use dash
+  ('-'). Reported by Bjorn Stenborg.
+
+- Sean Peterson fixed a key re-exchange bug:
+  http://daniel.haxx.se/projects/libssh2/mail/libssh2-devel-archive-2008-06/0002.shtml
+
+- Mike Protts filed the bug report #1908724 that identified and fixed a problem
+  with SFTP stat on files >4GB in size. Previously it used 32bit math only.
+
+- Removed a stderr debug message that was accidentally left in (bug #1863153)
+
+- OpenSSL and libz detection changed to make cross-compiling to Mingw
+  work.  See README for parameters to use if the auto-detection does
+  not work for you.  From Simon Josefsson.
+
+- Simon Josefsson added a self-test that uses libssh2 to connect to a
+  local sshd (only enabled if if OpenSSH is installed).
+
+Version 0.18 (November 11 2007)
+-------------------------------
+
+- Various changes that improve non-blocking operations and prevent stalls.
+  Especially noticable on Windows since libssh2 just didn't work properly
+  non-blocking on Windows before.
+
+- Peter O'Gorman reported how a SCP transfer would hang for him, and it was
+  fairly easy reproducable. One bug was in the transport layer, ignoring to
+  read more data while there was data left even though it couldn't decrypt the
+  data that was left due to it being too little... The other bug was in the
+  channel layer, where the libssh2_channel_receive_window_adjust() function
+  missed to set the state variables at times and thus this function would
+  misbehave on repeated invokes.
+
+- Changed the signature of libssh2_channel_setenv_ex to add const to the
+  "varname" parameter (Dan Fandrich)
+
+- Satish Mittal and David J Sullivan fixed an infinit recv() loop in
+  libssh2_banner_receive()
+
+Version 0.17 (August 6 2007)
+----------------------------
+Changes since previous version include:
+
+   o Re-indented the source code with this GNU indent setup:
+
+      --braces-on-if-line
+      --braces-after-struct-decl-line
+      --space-after-cast
+      --line-length 79
+      --comment-line-length 79
+      --cuddle-else
+      --no-tabs
+      --tab-size 8
+      --indent-level 4
+      --no-space-after-for
+      --space-after-if
+      --space-after-while
+      --no-space-after-function-call-names
+
+Version 0.16 (August 6 2007)
+----------------------------
+Changes since previous version include:
+
+   o CRLF stripping fix for PEM reading
+   o libssh2_scp_recv() error message fix
+   o added HACKING as an initial attempt to describe our source code format
+   o new public defines in include/libssh2.h to allow applictions to figure out
+     version number etc
+   o new script (maketgz) to build releases with
+   o updated files for building with MSVC and mingw
+   o keyboard-interactive would always fail due to claimed memory problem
+   o a few minor memory leaks fixed
+   o libssh2_poll() no longer relies on C99 features
+   o AIX 4 and 5 now supports non-blocking sockets
+   o large file magic checks in configure
+   o LIBSSH2_APINO was removed from the public header file
+
+This release would not have been possible without these friendly contributors:
+
+   James Housley, Simon Josefsson, Dan Fandrich, Guenter Knauf and I too did
+   some poking. (Sorry if I forgot anyone I should've mentioned here.)
+
+Of course we would have nothing without the great work by Sara Golemon that 
+we're extending and building upon.
+
+Version 0.15 (June 15 2007)
+---------------------------
+  Added libssh2_sftp_readdir_ex() and updated LIBSSH2_APINO to
+  200706151200 (James Housley)
+
+  Converted all of the libssh2 code to be able to work in non-blocking
+  mode.  This included some public API changes, listed below (James Housley)
+    Changed function return values:
+     int libssh2_session_free()
+     int libssh2_publickey_shutdown()
+     ssize_t libssh2_channel_read_ex()
+     ssize_t libssh2_channel_write_ex()
+  
+    Added functions:
+     libssh2_session_last_errno(), libssh2_channel_handle_extended_data2(),
+     libssh2_channel_wait_closed(), libssh2_channel_wait_eof(),
+     libssh2_session_set_blocking()
+   
+    Removed functions:
+     libssh2_channel_readnb_ex(), libssh2_channel_writenb_ex(),
+     libssh2_sftp_readnb(), libssh2_sftp_writenb(),
+     libssh2_sftp_mkdirnb_ex()
 
   Added the following functions for non-blocking operations: (Daniel Stenberg)
    libssh2_channel_readnb_ex()
@@ -52,7 +286,8 @@ Version 0.14
 
   Allow socket_fd == 0 in libssh2_session_startup(). (puudeli)
 
-  Swap ordering of packet_add/packet-inspection to avoid inspect after free. (Selcuk)
+  Swap ordering of packet_add/packet-inspection to avoid inspect after
+  free. (Selcuk)
 
   Swap KEX_INIT ordering, send our KEX_INIT first.
 
@@ -63,9 +298,11 @@ Version 0.14
 Version 0.13
 ------------
 
-  Fixed channel not being marked closed when CHANNEL_CLOSE package cannot be sent. (David Robins)
+  Fixed channel not being marked closed when CHANNEL_CLOSE package cannot be
+  sent. (David Robins)
 
-  Fixed payload packet allocation bug when invalid packet length received. (David Robins)
+  Fixed payload packet allocation bug when invalid packet length
+  received. (David Robins)
 
   Fixed `make install' target for MacOSX.
 
@@ -82,10 +319,12 @@ Version 0.12
     (Thanks Simon Hart)
 
   Fix generation of 'e' portion of Diffie-Hellman keyset.
-	Use appropriate order for BN_rand() rather than fixed group1-specific value.
+
+  Use appropriate order for BN_rand() rather than fixed group1-specific value.
 
   Re-fixed libssh2_sftp_rename_ex()
-    Transport had right packet_len, but sftp layer still had extra 4 bytes.
+
+  Transport had right packet_len, but sftp layer still had extra 4 bytes.
 
   Fixed build with newer OpenSSL headers.
 
@@ -100,42 +339,52 @@ Version 0.11
 
   Added libssh2_userauth_keyboard_interactive_ex() -- Mikhail
 
-  Added libssh2_channel_receive_window_adjust() to be able to increase the size of the receive window.
+  Added libssh2_channel_receive_window_adjust() to be able to increase the
+  size of the receive window.
 
-  Added queueing for small window_adjust packets to avoid unnecessary packet conversation.
+  Added queueing for small window_adjust packets to avoid unnecessary packet
+  conversation.
 
-  Fixed libssh2_sftp_rename_ex() to only send flags parameter if version >= 5 negotiated
-	(not currently possible, but will be and might as well keep the API consistent).
+  Fixed libssh2_sftp_rename_ex() to only send flags parameter if version >= 5
+  negotiated (not currently possible, but will be and might as well keep the
+  API consistent).
 
 Version 0.10
 ------------
 
   Added developer debugging hooks.  See --enable-debug-* options to ./configure
 
-  Ignore extended data in the SFTP layer.  With no other mechanism to deal with that data it'd just fill up and get stuck.
+  Ignore extended data in the SFTP layer.  With no other mechanism to deal
+  with that data it'd just fill up and get stuck.
 
-  (Re)Fixed channel_write() to provide an opportunity for window space to become available again.
+  (Re)Fixed channel_write() to provide an opportunity for window space to
+  become available again.
 
   (Re)Fixed SFTP INIT to send the correct SFTP packet length.
 
-  Fixed segfault when client and host can't agree on a hostkey/crypt/mac/comp method. (Thanks puudeli)
+  Fixed segfault when client and host can't agree on a hostkey/crypt/mac/comp
+  method. (Thanks puudeli)
 
-  Fixed major issue with sftp packet buffering mechanism.  Using wrong blocking semantics. (No puudeli, YOU the man)
+  Fixed major issue with sftp packet buffering mechanism.  Using wrong
+  blocking semantics. (No puudeli, YOU the man)
 
   Reduced busy-looping of libssh2_sftp_packet_requirev.
 
 Version 0.9
 -----------
 
-  Changed blocking_read to only block as much as necessary and not an arbitrary length of time. (Thanks Felix)
+  Changed blocking_read to only block as much as necessary and not an
+  arbitrary length of time. (Thanks Felix)
 
-  Fixed SFTP INIT/VERSION to exclude request_id and send correct maximum version number.
+  Fixed SFTP INIT/VERSION to exclude request_id and send correct maximum
+  version number.
 
   Fixed SFTP to be properly BC with version 1 and 2 servers.
 
   Fixed libssh2_poll() to recognized closed sessions/channels.
 
-  Fixed libssh2_channel_write_ex() to fully block when set to blocking mode.  Return actual bytes written as well.  (Thanks deadem)
+  Fixed libssh2_channel_write_ex() to fully block when set to blocking mode.
+  Return actual bytes written as well.  (Thanks deadem)
 
   Added tests for -lm and -lsocket and add them when necessary.
 
@@ -149,9 +398,11 @@ Version 0.8
 
   Fix compatability with older versions of OpenSSL
 
-  Swapped order of none,zlib compression modes to prefer no compression by default.
+  Swapped order of none,zlib compression modes to prefer no compression by
+  default.
 
-  Added sys/uio.h for platforms (FBSD) which need it in order to define struct iovec.
+  Added sys/uio.h for platforms (FBSD) which need it in order to define struct
+  iovec.
 
   Added libssh2_poll() to check status of sockets/channels/listeners.
 
@@ -174,15 +425,18 @@ Version 0.7
 Version 0.6
 -----------
 
-  Added LIBSSH2_FLAG_SIGPIPE to enable/disable SIGPIPE generated by send()/recv() calls. Default off.
+  Added LIBSSH2_FLAG_SIGPIPE to enable/disable SIGPIPE generated by
+  send()/recv() calls. Default off.
 
   Added libssh2_session_flag() to set optional session flags.
 
-  Collapsed exchanging_keys/newkeys/authenticated flags into single state attribute.
+  Collapsed exchanging_keys/newkeys/authenticated flags into single state
+  attribute.
 
   Fix zlib compression issue when internal buffer state misses partial sync.
 
-  Fix segfault when libssh2_session_methods() is called prior to session_startup().
+  Fix segfault when libssh2_session_methods() is called prior to
+  session_startup().
 
   Fixed client to server channel windowing.  Pervent send queue overruns.
 
@@ -192,7 +446,8 @@ Version 0.5
 -----------
 
   *** BC Break ***
-  Reimplemented libssh2_session_methods() to match libssh2_session_method_pref() style
+  Reimplemented libssh2_session_methods() to match
+  libssh2_session_method_pref() style
 
   Fixed libssh2_attr2bin() (effects any setstat style call).
 
@@ -202,11 +457,14 @@ Version 0.5
 
   Fixed KEX_INIT cookie and packet padding to use actual random data
 
-  Added DESTDIR support to makefiles (Adam Go<47><6F>biowski -- I hope that character set translates right)
+  Added DESTDIR support to makefiles (Adam Go<47><6F>biowski -- I hope that
+  character set translates right)
 
-  Added libssh2_channel_forward_listen_ex(), libssh2_channel_forward_cancel(), and libssh2_channel_forward_accept().
+  Added libssh2_channel_forward_listen_ex(), libssh2_channel_forward_cancel(),
+  and libssh2_channel_forward_accept().
 
-  Added ./configure option '--disable-gex-new' to allow using the older group-exchange format
+  Added ./configure option '--disable-gex-new' to allow using the older
+  group-exchange format
 
   Added MAC methods hmac-md5 and hmac-md5-96.
 

NMakefile

@@ -1,16 +1,19 @@
 !include "win32/config.mk"
 
+# SUBDIRS=src example\simple
 SUBDIRS=src
 
-all: all-sub ssh2_sample.exe
-
-ssh2_sample.exe: ssh2_sample.c
-	$(CC) $(CFLAGS) -DWIN32 -o ssh2_sample.exe ssh2_sample.c libssh2$(SUFFIX).lib $(LIBS)
-
 all-sub:
 	-for %D in ($(SUBDIRS)) do $(MAKE) /nologo /f %D/NMakefile BUILD=$(BUILD) SUBDIR=%D all-sub
-	
+
 clean: 
-	rmdir /s/q $(TARGET)
+	-rmdir /s/q $(TARGET)
+
+real-clean: clean
+	-del libssh2.dll
+	-del libssh2.exp
+	-del libssh2.ilk
+	-del libssh2.lib
+	-del *.pdb
 
 

README

@@ -4,6 +4,10 @@ libssh2 - SSH2 library
 libssh2 is a library implementing the SSH2 protocol, available under
 the revised BSD license.
 
+Web site: http://www.libssh2.org/
+
+Mailing list: https://lists.sourceforge.net/lists/listinfo/libssh2-devel
+
 Generic installation instructions are in INSTALL.  Some ./configure
 options deserve additional comments:
 
@@ -48,49 +52,43 @@ options deserve additional comments:
 		the older more reliable method.
 
   	* --with-libgcrypt
+  	* --without-libgcrypt
 	* --with-libgcrypt-prefix=DIR
 
 		libssh2 can use the Libgcrypt library
 		(http://www.gnupg.org/) for cryptographic operations.
+		Either Libgcrypt or OpenSSL is required.
 
-		Configure will attempt to locate Libgcrypt in the
-		default location, but if you have installed it
-		somewhere else, use the --with-libgrypt-prefix=DIR
-		parameter.
+		Configure will attempt to locate Libgcrypt
+		automatically.
 
-	* --with-openssl=[DIR]
+ 		If your installation of Libgcrypt is in another
+		location, specify it using --with-libgcrypt-prefix.
+
+	* --with-openssl
+	* --without-openssl
+	* --with-libssl-prefix=[DIR]
 
 		libssh2 can use the OpenSSL library
 		(http://www.openssl.org) for cryptographic operations.
+		Either Libgcrypt or OpenSSL is required.
 
-		Configure will attempt to locate OpenSSL in a number
-		of default locations:
-
-			/usr/local/ssl
-			/usr/local
-			/usr
-			/usr/local/openssl
+		Configure will attempt to locate OpenSSL in the
+		default location.
 
 		If your installation of OpenSSL is in another
-		location, specify it here.
+		location, specify it using --with-libssl-prefix.
 
-	* --with-libz=[DIR]
+	* --with-libz
+	* --without-libz
+	* --with-libz-prefix=[DIR]
 
-		If present, libssh2 will attempt to use the zlib (http://www.zlib.org)
-		for payload compression, however zlib is not required.
+		If present, libssh2 will attempt to use the zlib
+		(http://www.zlib.org) for payload compression, however
+		zlib is not required.
 
-		Configure will attempt to location a zlib installation
-		in a number of default locations:
-
-			/usr/local
-			/usr
-			/usr/local/libz
-			/usr/libz
-			/usr/local/zlib
-			/usr/zlib
-
-		If your installation of zlib is in another location,
-		you may specify it here.
+		If your installation of Libz is in another location,
+		specify it using --with-libz-prefix.
 
 	* --enable-debug
 

TODO

@@ -0,0 +1,38 @@
+Things TODO
+===========
+
+* Add one of the missing man pages:
+
+  libssh2_channel_receive_window_adjust
+  libssh2_channel_request_pty_size_ex
+  libssh2_channel_window_read_ex
+  libssh2_channel_window_write_ex
+  libssh2_publickey_add_ex
+  libssh2_publickey_init
+  libssh2_publickey_list_fetch
+  libssh2_publickey_list_free
+  libssh2_publickey_remove_ex
+  libssh2_publickey_shutdown
+  libssh2_userauth_hostbased_fromfile_ex
+
+* Decrease the number of mallocs. Everywhere.
+
+* Use SO_NOSIGPIPE for Mac OS/BSD systems where MSG_NOSIGNAL doesn't exist/work
+
+* Extend the test suite to actually test lots of aspects of libssh2
+
+* libssh2_channel_receive_window_adjust() can return EAGAIN while documented
+  to return the window as an "unsigned long".
+
+At next SONAME bump
+===================
+
+* stop using #defined macros as part of the official API. The macros should
+  either be turned into real functions or discarded from the API.
+
+* remove the following functions from the API/ABI
+
+  libssh2_base64_decode()
+  libssh2_session_flag()
+  libssh2_channel_handle_extended_data()
+  libssh2_channel_receive_window_adjust()

acinclude.m4

@@ -178,7 +178,7 @@ AC_DEFUN([CURL_CHECK_NONBLOCKING_SOCKET],
 #  define PLATFORM_SUNOS4
 # endif
 #endif
-#if (defined(_AIX) || defined(__xlC__)) && !defined(_AIX4)
+#if (defined(_AIX) || defined(__xlC__)) && !defined(_AIX41)
 # define PLATFORM_AIX_V3
 #endif
 

buildconf

@@ -3,5 +3,9 @@
 ${LIBTOOLIZE:-libtoolize} --copy --automake --force
 ${ACLOCAL:-aclocal} -I m4 $ACLOCAL_FLAGS
 ${AUTOHEADER:-autoheader}
+# copy the private libssh2_config.h.in to the examples dir so that
+# it can be included without pointing the include path to the private
+# source dir
+cp src/libssh2_config.h.in example/simple/config.h.in
 ${AUTOCONF:-autoconf}
 ${AUTOMAKE:-automake} --add-missing --copy

configure.in

@@ -1,8 +1,27 @@
 # AC_PREREQ(2.57)
-AC_INIT(libssh2, 0.15, libssh2-devel@lists.sourceforge.net)
-AM_INIT_AUTOMAKE(libssh2, 0.15)
+AC_INIT(libssh2, [-], libssh2-devel@lists.sourceforge.net)
+AC_CONFIG_MACRO_DIR([m4])
 AC_CONFIG_SRCDIR([src])
 AC_CONFIG_HEADER([src/libssh2_config.h])
+AM_MAINTAINER_MODE
+
+dnl SED is needed by some of the tools
+AC_PATH_PROG( SED, sed, sed-was-not-found-by-configure,
+              $PATH:/usr/bin:/usr/local/bin)
+AC_SUBST(SED)
+
+if test "x$SED" = "xsed-was-not-found-by-configure"; then
+  AC_MSG_WARN([sed was not found, this may ruin your chances to build fine])
+fi
+
+dnl figure out the libssh2 version
+VERSION=`$SED -ne 's/^#define LIBSSH2_VERSION *"\(.*\)"/\1/p' ${srcdir}/include/libssh2.h`
+AM_INIT_AUTOMAKE(libssh2,$VERSION)
+AC_MSG_CHECKING([libssh2 version])
+AC_MSG_RESULT($VERSION)
+
+AB_VERSION=$VERSION
+
 AB_INIT
 
 # Check for the OS.
@@ -10,6 +29,10 @@ AB_INIT
 # get this removed.
 AC_CANONICAL_HOST
 case "$host" in
+    *-mingw*)
+    CFLAGS="$CFLAGS -DLIBSSH2_WIN32 -DWINSOCK_VERSION=0x0200"
+    LIBS="$LIBS -lws2_32"
+    ;;
 	*-cygwin)
 	CFLAGS="$CFLAGS -DLIBSSH2_WIN32"
     ;;
@@ -22,6 +45,11 @@ case "$host" in
     ;;
 esac
 
+AC_CHECK_TYPE(long long,
+   [AC_DEFINE(HAVE_LONGLONG, 1,
+      [Define to 1 if the compiler supports the 'long long' data type.])]
+   longlong="yes"
+)
 # Some systems (Solaris?) have socket() in -lsocket.
 AC_SEARCH_LIBS(socket, socket)
 
@@ -34,150 +62,57 @@ AC_PROG_CC
 AC_PROG_INSTALL
 AC_PROG_LN_S
 AC_PROG_MAKE_SET
+AC_PATH_PROGS(SSHD, [sshd], [],
+     [$PATH$PATH_SEPARATOR/usr/libexec$PATH_SEPARATOR]dnl
+     [/usr/sbin$PATH_SEPARATOR/usr/etc$PATH_SEPARATOR/etc])
+AM_CONDITIONAL(SSHD, test -n "$SSHD")
+AC_LIBTOOL_WIN32_DLL
 AC_PROG_LIBTOOL
 AC_C_BIGENDIAN
-if test -z "$PKG_CONFIG"; then
-  AC_PATH_PROG(PKG_CONFIG, pkg-config, no)
+
+dnl check for how to do large files
+AC_SYS_LARGEFILE
+
+# Configure parameters
+AC_ARG_WITH(libgcrypt,
+  AC_HELP_STRING([--with-libgcrypt],[Use Libgcrypt for crypto]),
+  use_libgcrypt=$withval,use_libgcrypt=auto)
+AC_ARG_WITH(openssl,
+  AC_HELP_STRING([--with-openssl],[Use OpenSSL for crypto]),
+  use_openssl=$withval,use_openssl=auto)
+AC_ARG_WITH(libz,
+  AC_HELP_STRING([--with-libz],[Use Libz for compression]),
+  use_libz=$withval,use_libz=auto)
+
+# Look for OpenSSL (default)
+if test "$use_openssl" != "no" && test "$use_libgcrypt" != "yes"; then
+  AC_LIB_HAVE_LINKFLAGS([ssl], [crypto], [#include <openssl/ssl.h>])
 fi
 
-# Look for libgcrypt.
-AC_ARG_WITH(libgcrypt,
-  AC_HELP_STRING([--with-libgcrypt],[Use libgcrypt for crypto]),
-  use_libgcrypt=$withval,use_libgcrypt=no)
-if test "$use_libgcrypt" != "no"; then
+# Look for libgcrypt
+if test "$ac_cv_libssl" != "yes" && test "$use_libgcrypt" != "no"; then
   AC_LIB_HAVE_LINKFLAGS([gcrypt], [], [#include <gcrypt.h>])
 fi
-if test "$ac_cv_libgcrypt" = yes; then
-  use_libgcrypt=yes
+
+if test "$ac_cv_libssl" != "yes" && test "$ac_cv_libgcrypt" != "yes"; then
+  AC_MSG_ERROR([cannot find OpenSSL or Libgcrypt,
+try --with-libssl-prefix=PATH or --with-libgcrypt-prefix=PATH])
+fi
+
+if test "$ac_cv_libgcrypt" = "yes"; then
   AC_DEFINE(LIBSSH2_LIBGCRYPT, 1, [Use libgcrypt])
 fi
-AM_CONDITIONAL(LIBGCRYPT, test "$use_libgcrypt" != "no")
+AM_CONDITIONAL(LIBGCRYPT, test "$ac_cv_libgcrypt" = "yes")
 
-# Need to define SHLIB_SUFFIX_NAME before checking for libcrypt and libz
-# $shrext_cmds (from libtool) can contain commands so it must be eval'd
-# Simon's note: replace the find-openssl/libz logic with Bruno's
-# AC_LIB_LINKFLAGS which is more portable and flexible.
-eval SHLIB_SUFFIX_NAME=\"$shrext_cmds\"
-AC_SUBST(SHLIB_SUFFIX_NAME)
-
-#
-# Look for OpenSSL
-#
-AC_ARG_WITH(openssl,
-  AC_HELP_STRING([--with-openssl=DIR],[Look for OpenSSL in PATH]),
-  [LIBSSH2_OPENSSL_DIR=$withval],[LIBSSH2_OPENSSL_DIR=yes])
-
-if test "$use_libgcrypt" = "no"; then
-
-if test "$LIBSSH2_OPENSSL_DIR" = "no" || test "$LIBSSH2_OPENSSL_DIR" = "yes"; then
-  unset LIBSSH2_OPENSSL_DIR
-fi
-
-found_openssl=no
-pkgcfg_openssl=no
-unset OPENSSL_INCDIR
-unset OPENSSL_INCLINE
-unset OPENSSL_LIBLINE
-
-AC_MSG_CHECKING([for OpenSSL])
-
-# Explicit path given, use it rather than pkg-config
-if test ! -z "$LIBSSH2_OPENSSL_DIR"; then
-  found_openssl=yes
-  OPENSSL_LIBLINE="-L$LIBSSH2_OPENSSL_DIR/lib -lcrypto"
-  OPENSSL_INCLINE="-I$LIBSSH2_OPENSSL_DIR/include"
-  OPENSSL_INCDIR=$LIBSSH2_OPENSSL_DIR/include
-  AC_MSG_RESULT([Using explicit path $LIBSSH2_OPENSSL_DIR])
-fi
-
-# If pkg-config is found try using it
-if test "$found_openssl" = "no" && test -x "$PKG_CONFIG" && $PKG_CONFIG --exists openssl; then
-  found_openssl=yes
-  pkgcfg_openssl=yes
-  OPENSSL_LIBLINE=`$PKG_CONFIG --libs openssl`
-  OPENSSL_INCLINE=`$PKG_CONFIG --cflags-only-I openssl`
-  AC_MSG_RESULT([Using paths from pkg-config])
-fi
-
-# Elsewise, search for OpenSSL wherever it might be
-if test "$found_openssl" = "no"; then
-  OPENSSL_SEARCH_PATH="/usr/local/ssl /usr/local /usr /usr/local/openssl"
-
-  for i in $OPENSSL_SEARCH_PATH; do
-    if test -r $i/include/openssl/evp.h; then
-      OPENSSL_INCLINE="-I$i/include"
-      OPENSSL_INCDIR=$i/include
-    fi
-    if test -r $i/include/openssl/hmac.h; then
-      OPENSSL_INCLINE="-I$i/include"
-      OPENSSL_INCDIR=$i/include
-    fi
-    if test -r $i/lib/libcrypto.a -o -r $i/lib/libcrypto$SHLIB_SUFFIX_NAME; then
-      OPENSSL_LIBLINE="-L$i/lib -lcrypto"
-    fi
-    test -n "$OPENSSL_INCLINE" && test -n "$OPENSSL_LIBLINE" && break
-  done
-
-  if test -z "$OPENSSL_INCLINE"; then
-    AC_MSG_ERROR([Cannot find OpenSSL's <evp.h> or <hmac.h>])
+# Look for Libz
+if test "$use_libz" != "no"; then
+  AC_LIB_HAVE_LINKFLAGS([z], [], [#include <zlib.h>])
+  if test "$ac_cv_libz" != yes; then
+    AC_MSG_NOTICE([Cannot find libz, disabling compression])
+    AC_MSG_NOTICE([Try --with-libz-prefix=PATH if you know you have it])
+  else
+    AC_DEFINE(LIBSSH2_HAVE_ZLIB, 1, [Compile in zlib support])
   fi
-
-  if test -z "$OPENSSL_LIBLINE"; then
-    AC_MSG_ERROR([Cannot find OpenSSL's libcrypto])
-  fi
-
-  AC_MSG_RESULT([$OPENSSL_INCLINE $OPENSSL_LIBLINE])
-fi
-
-#
-# Confirm required OpenSSL libs
-#
-if test ! "$pkgcfg_openssl" = "yes"; then
-  if test ! -r $OPENSSL_INCDIR/openssl/bn.h || test ! -r $OPENSSL_INCDIR/openssl/evp.h || \
-     test ! -r $OPENSSL_INCDIR/openssl/hmac.h || test ! -r $OPENSSL_INCDIR/openssl/pem.h || \
-     test ! -r $OPENSSL_INCDIR/openssl/sha.h; then
-       AC_MSG_ERROR([Missing one or more of <openssl/bn.h>, <openssl/evp.h>, <openssl/hmac.h>, <openssl/pem.h>, <openssl/sha.h>])
-  fi
-fi
-
-CFLAGS="$CFLAGS $OPENSSL_INCLINE"
-LDFLAGS="$LDFLAGS $OPENSSL_LIBLINE"
-
-fi
-
-#
-# zlib
-#
-AC_ARG_WITH(libz,
-  AC_HELP_STRING([--with-libz=PATH],[Look for libz in PATH]),
-  [LIBSSH2_LIBZ_DIR=$withval],[LIBSSH2_LIBZ_DIR="/usr/local /usr /usr/local/libz /usr/libz /usr/local/zlib /usr/zlib"])
-
-if test "$LIBSSH2_LIBZ_DIR" = "no" || test "$LIBSSH2_LIBZ_DIR" = "yes"; then
-  unset LIBSSH2_LIBZ_DIR
-fi
-
-unset LIBZ_INCDIR
-unset LIBZ_LIBDIR
-
-AC_MSG_CHECKING([for libz])
-
-for i in $LIBSSH2_LIBZ_DIR; do
-  if test -r $i/include/zlib.h; then
-    LIBZ_INCDIR=$i/include
-  fi
-  if test -r $i/lib/libz.a -o -r $i/lib/libz$SHLIB_SUFFIX_NAME; then
-    LIBZ_LIBDIR=$i/lib
-  fi
-  test -n "$LIBZ_INCDIR" && test -n "$LIBZ_LIBDIR" && break
-done
-
-if test -n "$LIBZ_INCDIR" && test -n "$LIBZ_LIBDIR"; then
-  AC_MSG_RESULT([Found in $LIBZ_INCDIR $LIBZ_LIBDIR])
-  CFLAGS="$CFLAGS -I$LIBZ_INCDIR"
-  LDFLAGS="$LDFLAGS -L$LIBZ_LIBDIR -lz"
-  AC_DEFINE(LIBSSH2_HAVE_ZLIB, 1, [Compile in zlib support])
-else
-  AC_MSG_RESULT([Cannot find libz's <zlib.h>])
 fi
 
 #
@@ -228,7 +163,41 @@ AC_HELP_STRING([--disable-debug],[Disable debug options]),
 AC_CHECK_HEADERS([errno.h fcntl.h stdio.h stdlib.h unistd.h sys/uio.h])
 AC_CHECK_HEADERS([sys/select.h sys/socket.h sys/ioctl.h sys/time.h])
 AC_CHECK_HEADERS([arpa/inet.h netinet/in.h])
-AC_CHECK_FUNCS(poll gettimeofday select)
+
+case $host in
+  *-*-cygwin* | *-*-cegcc*)
+    # These are POSIX-like systems using BSD-like sockets API.
+    ;;
+  *)
+    AC_CHECK_HEADERS([windows.h winsock2.h ws2tcpip.h])
+    ;;
+esac
+
+AC_CHECK_FUNCS(poll gettimeofday select strtoll)
+
+dnl Check for select() into ws2_32 for Msys/Mingw
+if test "$ac_cv_func_select" != "yes"; then
+  AC_MSG_CHECKING([for select in ws2_32])
+  AC_TRY_LINK([
+#ifdef HAVE_WINSOCK2_H
+#ifndef WIN32_LEAN_AND_MEAN
+#define WIN32_LEAN_AND_MEAN
+#endif
+#include <winsock2.h>
+#endif
+    ],[
+      select(0,(fd_set *)NULL,(fd_set *)NULL,(fd_set *)NULL,(struct timeval *)NULL);
+    ],[
+      AC_MSG_RESULT([yes])
+      HAVE_SELECT="1"
+      AC_DEFINE_UNQUOTED(HAVE_SELECT, 1,
+        [Define to 1 if you have the select function.])
+    ],[
+      AC_MSG_RESULT([no])
+  ])
+fi
+
+AC_FUNC_ALLOCA
 
 # Checks for typedefs, structures, and compiler characteristics.
 AC_C_CONST

docs/.cvsignore

@@ -1,2 +1,3 @@
 Makefile
 Makefile.in
+coverage

docs/Makefile.am

@@ -1,13 +1,88 @@
-# $Id: Makefile.am,v 1.5 2007/04/22 19:51:53 jehousley Exp $
+# $Id: Makefile.am,v 1.37 2009/03/26 15:41:15 bagder Exp $
 
 EXTRA_DIST = template.3
 
-dist_man_MANS = libssh2_channel_forward_accept.3			\
- libssh2_session_init.3 libssh2_channel_forward_listen_ex.3		\
- libssh2_session_startup.3 libssh2_channel_read_ex.3			\
- libssh2_sftp_init.3 libssh2_channel_readnb_ex.3			\
- libssh2_sftp_open_ex.3 libssh2_channel_set_blocking.3			\
- libssh2_session_free.3 libssh2_poll.3 libssh2_poll_channel_read.3	\
- libssh2_sftp_read.3 libssh2_sftp_readnb.3 libssh2_sftp_readdir.3	\
- libssh2_sftp_readdirnb.3 libssh2_sftp_mkdir_ex.3			\
- libssh2_sftp_mkdirnb_ex.3
+dist_man_MANS = \
+	libssh2_banner_set.3 \
+	libssh2_channel_close.3 \
+	libssh2_channel_direct_tcpip_ex.3 \
+	libssh2_channel_eof.3 \
+	libssh2_channel_flush_ex.3 \
+	libssh2_channel_forward_accept.3 \
+	libssh2_channel_forward_cancel.3 \
+	libssh2_channel_forward_listen_ex.3 \
+	libssh2_channel_free.3 \
+	libssh2_channel_get_exit_status.3 \
+	libssh2_channel_handle_extended_data.3 \
+	libssh2_channel_handle_extended_data2.3 \
+	libssh2_channel_open_ex.3 \
+	libssh2_channel_process_startup.3 \
+	libssh2_channel_read_ex.3 \
+	libssh2_channel_receive_window_adjust.3 \
+	libssh2_channel_receive_window_adjust2.3 \
+	libssh2_channel_request_pty_ex.3 \
+	libssh2_channel_send_eof.3 \
+	libssh2_channel_set_blocking.3 \
+	libssh2_channel_setenv_ex.3 \
+	libssh2_channel_wait_eof.3 \
+	libssh2_channel_wait_closed.3 \
+	libssh2_channel_window_read_ex.3 \
+	libssh2_channel_window_write_ex.3 \
+	libssh2_channel_write_ex.3 \
+	libssh2_channel_x11_req_ex.3 \
+	libssh2_hostkey_hash.3 \
+	libssh2_scp_recv.3 \
+	libssh2_scp_send_ex.3 \
+	libssh2_session_abstract.3 \
+	libssh2_session_block_directions.3 \
+	libssh2_session_callback_set.3 \
+	libssh2_session_free.3 \
+	libssh2_session_disconnect_ex.3 \
+	libssh2_session_init_ex.3 \
+	libssh2_session_last_errno.3 \
+	libssh2_session_last_error.3 \
+	libssh2_session_method_pref.3 \
+	libssh2_session_methods.3 \
+	libssh2_session_set_blocking.3 \
+	libssh2_session_startup.3 \
+	libssh2_poll.3 \
+	libssh2_poll_channel_read.3 \
+	libssh2_sftp_close_handle.3 \
+	libssh2_sftp_fstat_ex.3 \
+	libssh2_sftp_last_error.3 \
+	libssh2_sftp_init.3 \
+	libssh2_sftp_open_ex.3 \
+	libssh2_sftp_mkdir_ex.3 \
+	libssh2_sftp_read.3 \
+	libssh2_sftp_readdir_ex.3 \
+	libssh2_sftp_rename_ex.3 \
+	libssh2_sftp_rmdir_ex.3 \
+	libssh2_sftp_seek.3 \
+	libssh2_sftp_shutdown.3 \
+	libssh2_sftp_stat_ex.3 \
+	libssh2_sftp_symlink_ex.3 \
+	libssh2_sftp_tell.3 \
+	libssh2_sftp_tell64.3 \
+	libssh2_sftp_unlink_ex.3 \
+	libssh2_sftp_write.3 \
+	libssh2_userauth_authenticated.3 \
+	libssh2_userauth_keyboard_interactive_ex.3 \
+	libssh2_userauth_list.3 \
+	libssh2_userauth_password_ex.3 \
+	libssh2_userauth_publickey_fromfile_ex.3 \
+	libssh2_base64_decode.3 \
+	libssh2_trace.3 \
+	libssh2_version.3
+	libssh2_channel_request_pty_size_ex.3 \
+	libssh2_free_host_entry.3 \
+	libssh2_host_entry_match.3 \
+	libssh2_new_host_entry.3 \
+	libssh2_publickey_add_ex.3 \
+	libssh2_publickey_init.3 \
+	libssh2_publickey_list_fetch.3 \
+	libssh2_publickey_list_free.3 \
+	libssh2_publickey_remove_ex.3 \
+	libssh2_publickey_shutdown.3 \
+	libssh2_session_flag.3 \
+	libssh2_session_get_blocking.3 \
+	libssh2_userauth_hostbased_fromfile_ex.3

docs/libssh2_banner_set.3

@@ -0,0 +1,32 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_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 user defined banner
+
+Set the banner that will be sent to the remote host when the SSH session is 
+started with 
+.BR libssh2_session_startup(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 ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+.SH SEE ALSO
+.BR libssh2_session_startup(3)

docs/libssh2_base64_decode.3

@@ -0,0 +1,27 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest,
+                          unsigned int *dest_len, const char *src,
+                          unsigned int src_len);
+.SH DESCRIPTION
+This function is deemed DEPRECATED and will be removed from libssh2 in a
+future version. Don't 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
+to.
+
+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 appliction to free this data in a safe and
+reliable way!
+.SH RETURN VALUE
+0 if successful, \-1 if any error occurred.

docs/libssh2_channel_close.3

@@ -0,0 +1,31 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_close(LIBSSH2_CHANNEL *channel);
+
+.SH DESCRIPTION
+\fIchannel\fP - active channel stream to set closed status on.
+
+Close an active data channel. In practice this means sending an SSH_MSG_CLOSE 
+packet to the remote host which serves as instruction that no further data 
+will be sent to it. The remote host may still send data back until it sends 
+its own close message in response. To wait for the remote end to close its 
+connection as well, follow this command with 
+.BR libssh2_channel_wait_closed(3)
+
+.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 ERRORS
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+.SH SEE ALSO
+.BR libssh2_channel_open_ex(3)

docs/libssh2_channel_direct_tcpip_ex.3

@@ -0,0 +1,37 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+LIBSSH2_CHANNEL * 
+libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session, const char *host, int port, const char *shost, int sport);
+
+LIBSSH2_CHANNEL * 
+libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port);
+
+.SH DESCRIPTION
+/fIsession/fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+/fIhost/fP - Third party host to connect to using the SSH host as a proxy.
+
+/fIport/fP - Port on third party host to connect to.
+
+/fIshost/fP - Host to tell the SSH server the connection originated on.
+
+/fIsport/fP - Port to tell the SSH server the connection originated from.
+
+Tunnel a TCP/IP connection through the SSH transport via the remote host to 
+a third party. Communication from the client to the SSH server remains 
+encrypted, communication from the server to the 3rd party host travels 
+in cleartext.
+
+.SH RETURN VALUE
+Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)

docs/libssh2_channel_eof.3

@@ -0,0 +1,18 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_eof(LIBSSH2_CHANNEL *channel);
+.SH DESCRIPTION
+\fIchannel\fP - active channel stream to set closed status on.
+
+Check if the remote host has sent an EOF status for the selected stream.
+.SH RETURN VALUE
+Returns 1 if the remote host has sent EOF, otherwise 0.
+.SH SEE ALSO
+.BR libssh2_channel_close(3)

docs/libssh2_channel_flush_ex.3

@@ -0,0 +1,34 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_flush_ex(LIBSSH2_CHANNEL *channel, int streamid);
+
+int 
+libssh2_channel_flush(LIBSSH2_CHANNEL *channel);
+
+int 
+libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel);
+
+.SH DESCRIPTION
+\fIchannel\fP - Active channel stream to flush.
+
+\fIstreamid\fP - Specific substream number to flush. Groups of substreams may 
+be flushed by passing on of the following Constants.
+.br
+\fBLIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA\fP: Flush all extended data substreams
+.br
+\fBLIBSSH2_CHANNEL_FLUSH_ALL\fP: Flush all substreams
+
+Flush the read buffer for a given channel instance. Individual substreams may 
+be flushed by number or using one of the provided macros.
+
+.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.

docs/libssh2_channel_forward_accept.3

@@ -1,16 +1,21 @@
-.\" $Id: libssh2_channel_forward_accept.3,v 1.1 2006/12/21 14:09:12 bagder Exp $
+.\" $Id: libssh2_channel_forward_accept.3,v 1.6 2009/03/16 23:25:14 bagder Exp $
 .\"
-.TH libssh2_channel_forward_accept 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
+.TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_forward_accept - accept a queued connection
 .SH SYNOPSIS
-.B #include <libssh2.h>
+#include <libssh2.h>
+
+LIBSSH2_CHANNEL *
+libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener);
 
-.B LIBSSH2_CHANNEL * libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener);
 .SH DESCRIPTION
 \fIlistener\fP is a forwarding listener instance as returned by
-\fBlibssh2_channel_forward_listen(3)\fP.
+\fBlibssh2_channel_forward_listen_ex(3)\fP.
 .SH RETURN VALUE
 A newly allocated channel instance or NULL on failure.
-.SH "SEE ALSO"
-.BI libssh2_channel_forward_listen(3)
+.SH ERRORS
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for 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

@@ -0,0 +1,29 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener);
+
+.SH DESCRIPTION
+/fIlistener/fP - Forwarding listener instance as returned by 
+.BR libssh2_channel_forward_listen_ex(3)
+
+Instruct the remote host to stop listening for new connections on a previously requested host/port.
+
+.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 ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+.SH SEE ALSO
+.BR libssh2_channel_forward_listen_ex(3)

docs/libssh2_channel_forward_listen_ex.3

@@ -1,19 +1,17 @@
-.\" $Id: libssh2_channel_forward_listen_ex.3,v 1.2 2007/04/12 21:30:03 dfandrich Exp $
+.\" $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 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
+.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
 .SH SYNOPSIS
 #include <libssh2.h>
 
-LIBSSH2_LISTENER * libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session,
-                   char *host,
-                   int port,
-                   int *bound_port,
-                   int queue_maxsize);
+LIBSSH2_LISTENER * 
+libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session, char *host, int port, int *bound_port, int queue_maxsize);
+
+LIBSSH2_LISTENER * 
+libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port);
 
-LIBSSH2_LISTENER * libssh2_channel_forward_listen(LIBSSH2_SESSION *session,
-                   int port);
 .SH DESCRIPTION
 Instruct the remote SSH server to begin listening for inbound TCP/IP
 connections. New connections will be queued by the library until accepted by
@@ -36,5 +34,15 @@ rejecting further attempts.
 \fIlibssh2_channel_forward_listen(3)\fP is a macro.
 .SH RETURN VALUE
 A newly allocated LIBSSH2_LISTENER instance or NULL on failure.
-.SH "SEE ALSO"
-.BI libssh2_channel_forward_accept(3)
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on the socket.
+
+\fILIBSSH2_ERROR_REQUEST_DENIED\fP - The remote server refused the request.
+
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
+.SH SEE ALSO
+.BR libssh2_channel_forward_accept(3)

docs/libssh2_channel_free.3

@@ -0,0 +1,27 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_free(LIBSSH2_CHANNEL *channel);
+
+.SH DESCRIPTION
+\fIchannel\fP - Channel stream to free.
+
+Release all resources associated with a channel stream. If the channel has 
+not yet been closed with 
+.BR libssh2_channel_close(3)
+, it will be called automatically so that the remote end may know that it 
+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.
+
+.SH SEE ALSO
+.BR libssh2_channel_close(3)

docs/libssh2_channel_get_exit_status.3

@@ -0,0 +1,20 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel)
+
+.SH DESCRIPTION
+\fIchannel\fP - Closed channel stream to retreive exit status from.
+
+Returns the exit code raised by the process running on the remote host at 
+the other end of the named channel. Note that the exit status may not be 
+available if the remote end has not yet set its status to closed.
+
+.SH RETURN VALUE
+Returns 0 on failure, otherwise the \fIExit Status\fP reported by remote host

docs/libssh2_channel_handle_extended_data.3

@@ -0,0 +1,37 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+void 
+libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel, int ignore_mode);
+
+.SH DESCRIPTION
+This function is deprecated. Use the
+\fIlibssh2_channel_handle_extended_data2(3)\fP function instead!
+
+\fIchannel\fP - Active channel stream to change extended data handling on.
+
+\fIignore_mode\fP - One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants.
+.br
+\fBLIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL\fP: Queue extended data for eventual 
+reading
+.br
+\fBLIBSSH2_CHANNEL_EXTENDED_DATA_MERGE\fP: Treat extended data and ordinary
+data the same. Merge all substreams such that calls to
+\fIlibssh2_channel_read(3)\fP will pull from all substreams on a
+first-in/first-out basis.
+.br
+\fBLIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE\fP: Discard all extended data as it 
+arrives.
+
+Change how a channel deals with extended data packets. By default all extended
+data is queued until read by \fIlibssh2_channel_read_ex(3)\fP
+.SH RETURN VALUE
+None.
+.SH SEE ALSO
+.BR libssh2_channel_handle_extended_data2(3)
+.BR libssh2_channel_read_ex(3)

docs/libssh2_channel_handle_extended_data2.3

@@ -0,0 +1,37 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel, int ignore_mode);
+
+.SH DESCRIPTION
+\fIchannel\fP - Active channel stream to change extended data handling on.
+
+\fIignore_mode\fP - One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants.
+.br
+\fBLIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL\fP: Queue extended data for eventual 
+reading
+.br
+\fBLIBSSH2_CHANNEL_EXTENDED_DATA_MERGE\fP: Treat extended data and ordinary 
+data the same. Merge all substreams such that calls to 
+.BR libssh2_channel_read(3)
+will pull from all substreams on a first-in/first-out basis.
+.br
+\fBLIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE\fP: Discard all extended data as it 
+arrives.
+
+Change how a channel deals with extended data packets. By default all 
+extended data is queued until read by 
+.BR libssh2_channel_read_ex(3)
+
+.SH RETURN VALUE
+Return 0 on success or LIBSSH2_ERROR_EAGAIN when it would otherwise block.
+
+.SH SEE ALSO
+.BR libssh2_channel_handle_extended_data(3)
+.BR libssh2_channel_read_ex(3)

docs/libssh2_channel_open_ex.3

@@ -0,0 +1,56 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+LIBSSH2_CHANNEL *
+libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type, unsigned int channel_type_len, unsigned int window_size, unsigned int packet_size, const char *message, unsigned int message_len);
+
+LIBSSH2_CHANNEL *
+libssh2_channel_open_session(session);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIchannel_type\fP - Channel type to open. Typically one of session, 
+direct-tcpip, or tcpip-forward. The SSH2 protocol allowed for additional 
+types including local, custom channel types.
+
+\fIchannel_type_len\fP - Length of channel_type
+
+\fIwindow_size\fP - Maximum amount of unacknowledged data remote host is 
+allowed to send before receiving an SSH_MSG_CHANNEL_WINDOW_ADJUST packet.
+
+\fIpacket_size\fP - Maximum number of bytes remote host is allowed to send 
+in a single SSH_MSG_CHANNEL_DATA or SSG_MSG_CHANNEL_EXTENDED_DATA packet.
+
+\fImessage\fP - Additional data as required by the selected channel_type.
+
+\fImessage_len\fP - Length of message parameter.
+
+Allocate a new channel for exchanging data with the server. This method is 
+typically called through its macroized form: 
+.BR libssh2_channel_open_session(3)
+or via 
+.BR libssh2_channel_direct_tcpip(3)
+or
+.BR libssh2_channel_forward_listen(3)
+
+.SH RETURN VALUE
+Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_CHANNEL_FAILURE\fP - 
+
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
+
+.SH SEE ALSO
+Add related functions

docs/libssh2_channel_process_startup.3

@@ -0,0 +1,46 @@
+.\" $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
+#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);
+
+.SH DESCRIPTION
+\fIchannel\fP - Active session channel instance.
+
+\fIrequest\fP - Type of process to startup. The SSH2 protocol currently 
+defines shell, exec, and subsystem as standard process services.
+
+\fIrequest_len\fP - Length of request parameter.
+
+\fImessage\fP - Request specific message data to include.
+
+\fImessage_len\fP - Length of message parameter.
+
+Initiate a request on a session type channel such as returned by 
+.BR libssh2_channel_open_ex(3)
+.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 ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - 
+.SH SEE ALSO
+.BR libssh2_channel_open_ex(3)

docs/libssh2_channel_read_ex.3

@@ -1,19 +1,20 @@
-.\" $Id: libssh2_channel_read_ex.3,v 1.5 2007/02/23 10:20:56 bagder Exp $
+.\" $Id: libssh2_channel_read_ex.3,v 1.10 2007/06/13 16:41:33 jehousley Exp $
 .\"
-.TH libssh2_channel_read_ex 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
+.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
 .SH SYNOPSIS
 #include <libssh2.h>
 
-int libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id,
-                            char *buf, size_t buflen);
+ssize_t
+libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id, char *buf, size_t buflen);
 
-int libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf,
-                         size_t buflen);
+ssize_t
+libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen);
+
+ssize_t
+libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen);
 
-int libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf,
-                                size_t buflen);
 .SH DESCRIPTION
 Attempt to read data from an active channel stream. All channel streams have
 one standard I/O substream (stream_id == 0), and may have up to 2^32 extended
@@ -31,6 +32,13 @@ currently defines a stream ID of 1 to be the stderr substream.
 \fIlibssh2_channel_read(3)\fP and \fIlibssh2_channel_read_stderr(3)\fP are
 macros.
 .SH RETURN VALUE
-Actual number of bytes read or negative on failure.
-.SH "SEE ALSO"
+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.
+.SH ERRORS
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed.
+
+.SH SEE ALSO
 .BR libssh2_poll_channel_read(3)

docs/libssh2_channel_readnb_ex.3

@@ -1,39 +0,0 @@
-.\" $Id: libssh2_channel_readnb_ex.3,v 1.2 2007/02/23 10:20:56 bagder Exp $
-.\"
-.TH libssh2_channel_read_ex 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
-.SH NAME
-libssh2_channel_read_ex - read data from a channel stream
-.SH SYNOPSIS
-#include <libssh2.h>
-
-int libssh2_channel_readnb_ex(LIBSSH2_CHANNEL *channel, int stream_id,
-                            char *buf, size_t buflen);
-
-int libssh2_channel_readnb(LIBSSH2_CHANNEL *channel, char *buf,
-                         size_t buflen);
-
-int libssh2_channel_readnb_stderr(LIBSSH2_CHANNEL *channel, char *buf,
-                                size_t buflen);
-.SH DESCRIPTION
-Attempt to read data from an active channel stream. All channel streams have
-one standard I/O substream (stream_id == 0), and may have up to 2^32 extended
-data streams as identified by the selected \fIstream_id\fP. The SSH2 protocol
-currently defines a stream ID of 1 to be the stderr substream.
-
-\fIchannel\fP - active channel stream to read from. 
-
-\fIstream_id\fP - substream ID number (e.g. 0 or SSH_EXTENDED_DATA_STDERR) 
-
-\fIbuf\fP - pointer to storage buffer to read data into
-
-\fIbuflen\fP - size of the buf storage
-
-\fIlibssh2_channel_read(3)\fP and \fIlibssh2_channel_read_stderr(3)\fP are
-macros.
-.SH RETURN VALUE
-Actual number of bytes read or negative on failure. It returns
-LIBSSH2CHANNEL_EAGAIN when it would otherwise block. While
-LIBSSH2CHANNEL_EAGAIN is a negative number, it isn't really a failure per se.
-.SH "SEE ALSO"
-.BR libssh2_poll_channel_read(3)
-

docs/libssh2_channel_receive_window_adjust.3

@@ -0,0 +1,31 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+unsigned long
+libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel,
+                                      unsigned long adjustment,
+                                      unsigned char force);
+
+.SH DESCRIPTION
+This function is deprecated in 1.1. Use
+\fIlibssh2_channel_receive_window_adjust2(3)\fP!
+
+Adjust the receive window for a channel by adjustment bytes. If the amount to
+be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the
+adjustment amount will be queued for a later packet.
+.SH RETURN VALUE
+Returns the new size of the receive window (as understood by remote end). Note
+that the window value sent over the wire is strictly 32bit, but this API is
+made to return a 'long' which may not be 32 bit on all platforms.
+.SH ERRORS
+In 1.0 and earlier, this function returns LIBSSH2_ERROR_EAGAIN for
+non-blocking channels where it would otherwise block. However, that is a
+negative number and this function only returns an unsigned value and this then
+leads to a very strange value being returned.
+.SH SEE ALSO
+.BR libssh2_channel_window_read_ex(3)

docs/libssh2_channel_receive_window_adjust2.3

@@ -0,0 +1,29 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int
+libssh2_channel_receive_window_adjust2(LIBSSH2_CHANNEL * channel,
+                                       unsigned long adjustment,
+                                       unsigned char force,
+                                       unsigned int *window);
+
+.SH DESCRIPTION
+Adjust the receive window for a channel by adjustment bytes. If the amount to
+be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the
+adjustment amount will be queued for a later packet.
+
+This function stores the new size of the receive window (as understood by
+remote end) in the variable 'window' points to.
+.SH RETURN VALUE
+Return 0 on success and a negative value on error. If used in non-blocking
+mode it will return LIBSSH2_ERROR_EAGAIN when it would otherwise block.
+.SH ERRORS
+.SH AVAILABILITY
+Added in libssh2 1.1 since the previous API has deficiencies.
+.SH SEE ALSO
+.BR libssh2_channel_window_read_ex(3)

docs/libssh2_channel_request_pty_ex.3

@@ -0,0 +1,49 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term, unsigned int term_len, const char *modes, unsigned int modes_len, int width, int height, int width_px, int height_px);
+
+int 
+libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, char *term);
+
+.SH DESCRIPTION
+\fIchannel\fP - Previously opened channel instance such as returned by 
+.BR libssh2_channel_open_ex(3)
+
+\fIterm\fP - Terminal emulation (e.g. vt102, ansi, etc...)
+
+\fIterm_len\fP - Length of term parameter
+
+\fImodes\fP - Terminal mode modifier values
+
+\fImodes_len\fP - Length of modes parameter.
+
+\fIwidth\fP - Width of pty in characters
+
+\fIheight\fP - Height of pty in characters
+
+\fIwidth_px\fP - Width of pty in pixels
+
+\fIheight_px\fP - Height of pty in pixels
+
+Request a PTY on an established channel. Note that this does not make sense 
+for all channel types and may be ignored by the server despite returning 
+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.
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - 
+.SH SEE ALSO
+.BR libssh2_channel_open_ex(3)

docs/libssh2_channel_request_pty_size_ex.3

@@ -0,0 +1,14 @@
+.\" $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
+.SH SYNOPSIS
+
+.SH DESCRIPTION
+
+.SH RETURN VALUE
+
+.SH ERRORS
+
+.SH SEE ALSO

docs/libssh2_channel_send_eof.3

@@ -0,0 +1,26 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel);
+
+.SH DESCRIPTION
+Tell the remote host that no further data will be sent on the specified 
+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.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+.SH SEE ALSO
+.BR libssh2_channel_wait_eof(3)
+.BR libssh2_channel_eof(3)

docs/libssh2_channel_set_blocking.3

@@ -1,23 +1,25 @@
-.\" $Id: libssh2_channel_set_blocking.3,v 1.1 2006/12/21 14:09:13 bagder Exp $
+.\" $Id: libssh2_channel_set_blocking.3,v 1.6 2009/03/26 15:41:16 bagder Exp $
 .\"
-.TH libssh2_channel_set_blocking 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
+.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
 .SH SYNOPSIS
 #include <libssh2.h>
 
-void libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking);
+void 
+libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking);
 .SH DESCRIPTION
-Set or clear blocking mode on the selected channel. If a read is performed on
-a channel with no data currently available, a blocking channel will wait for
-data to arrive and return what it receives. A non-blocking channel will return
-immediately with an empty buffer.
-
 \fIchannel\fP - channel stream to set or clean blocking status on.
 
 \fIblocking\fP - Set to a non-zero value to make the channel block, or zero to
 make it non-blocking.
+
+Currently this is just a short cut call to 
+.BR libssh2_session_set_blocking(3)
+and therefore will affect the session and all channels.
 .SH RETURN VALUE
 None
-.SH "SEE ALSO"
-.BI libssh2_channel_read_ex(3)
+.SH SEE ALSO
+.BR libssh2_session_set_blocking(3)
+.BR libssh2_channel_read_ex(3)
+.BR libssh2_channel_write_ex(3)

docs/libssh2_channel_setenv_ex.3

@@ -0,0 +1,43 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int
+libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, char *varname, unsigned int varname_len, const char *value, unsigned int value_len);
+
+int
+libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, char *varname, const char *value);
+
+.SH DESCRIPTION
+\fIchannel\fP - Previously opened channel instance such as returned by 
+.BR libssh2_channel_open_ex(3)
+
+\fIvarname\fP - Name of environment variable to set on the remote 
+channel instance.
+
+\fIvarname_len\fP - Length of passed varname parameter.
+
+\fIvalue\fP - Value to set varname to.
+
+\fIvalue_len\fP - Length of value parameter.
+
+Set an environment variable in the remote channel's process space. Note that
+this does not make sense for all channel types and may be ignored by the
+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.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - 
+.SH SEE ALSO
+.BR libssh2_channel_open_ex(3)

docs/libssh2_channel_wait_closed.3

@@ -0,0 +1,24 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel);
+
+.SH DESCRIPTION
+Enter a temporary blocking state until the remote host closes the named
+channel. Typically sent after \fIlibssh2_channel_close(3)\fP in order to
+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.
+.SH SEE ALSO
+.BR libssh2_channel_send_eof(3)
+.BR libssh2_channel_eof(3)
+.BR libssh2_channel_wait_eof(3)

docs/libssh2_channel_wait_eof.3

@@ -0,0 +1,21 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_channel_wait_eof(LIBSSH2_CHANNEL *channel);
+
+.SH DESCRIPTION
+Wait for the remote end to acknowledge an EOF request.
+
+.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 SEE ALSO
+.BR libssh2_channel_send_eof(3)
+.BR libssh2_channel_eof(3)

docs/libssh2_channel_window_read_ex.3

@@ -0,0 +1,26 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+unsigned long
+libssh2_channel_window_read_ex(LIBSSH2_CHANNEL *channel,
+                               unsigned long *read_avail,
+                               unsigned long *window_size_initial)
+.SH DESCRIPTION
+Check the status of the read window. Returns the number of bytes which the
+remote end may send without overflowing the window limit read_avail (if
+passed) will be populated with the number of bytes actually available to be
+read window_size_initial (if passed) will be populated with the
+window_size_initial as defined by the channel_open request
+.SH RETURN VALUE
+The number of bytes which the remote end may send without overflowing the
+window limit
+.SH ERRORS
+
+.SH SEE ALSO
+.BR libssh2_channel_receive_window_adjust(3),
+.BR libssh2_channel_window_write_ex(3)

docs/libssh2_channel_window_write_ex.3

@@ -0,0 +1,23 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+unsigned long
+libssh2_channel_window_write_ex(LIBSSH2_CHANNEL *channel,
+                                unsigned long *window_size_initial)
+.SH DESCRIPTION
+Check the status of the write window Returns the number of bytes which may be
+safely writen on the channel without blocking. 'window_size_initial' (if
+passed) will be populated with the size of the initial window as defined by
+the channel_open request
+.SH RETURN VALUE
+Number of bytes which may be safely writen on the channel without blocking.
+.SH ERRORS
+
+.SH SEE ALSO
+.BR libssh2_channel_window_read_ex(3),
+.BR libssh2_channel_receive_window_adjust(3)

docs/libssh2_channel_write_ex.3

@@ -1,19 +1,19 @@
-.\" $Id: libssh2_channel_write_ex.3,v 1.1 2007/02/23 10:20:56 bagder Exp $
+.\" $Id: libssh2_channel_write_ex.3,v 1.6 2009/03/16 23:25:14 bagder Exp $
 .\"
-.TH libssh2_channel_write_ex 3 "6 Feb 2007" "libssh2 0.15" "libssh2 manual"
+.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
 .SH SYNOPSIS
 #include <libssh2.h>
 
-int libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel, int stream_id,
-                             char *buf, size_t buflen);
+ssize_t
+libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel, int stream_id, char *buf, size_t buflen);
 
-int libssh2_channel_write(LIBSSH2_CHANNEL *channel, char *buf,
-                          size_t buflen);
+ssize_t
+libssh2_channel_write(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen);
 
-int libssh2_channel_write_stderr(LIBSSH2_CHANNEL *channel, char *buf,
-                                 size_t buflen);
+ssize_t
+libssh2_channel_write_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen);
 .SH DESCRIPTION
 Write data to a channel stream. All channel streams have one standard I/O
 substream (stream_id == 0), and may have up to 2^32 extended data streams as
@@ -32,6 +32,17 @@ defines a stream ID of 1 to be the stderr substream.
 macros.
 .SH RETURN VALUE
 Actual number of bytes written or negative on failure.
-.SH "SEE ALSO"
-.BR libssh2_channel_open_session(3)
-.BR libssh2_channel_read(3)
+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.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed.
+
+\fILIBSSH2_ERROR_CHANNEL_EOF_SENT\fP - The channel has been requested to be
+closed.
+.SH SEE ALSO
+.BR libssh2_channel_open_ex(3)
+.BR libssh2_channel_read_ex(3)

docs/libssh2_channel_x11_req_ex.3

@@ -0,0 +1,46 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int
+libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection, const char *auth_proto, const char *auth_cookie, int screen_number);
+
+int
+libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number);
+
+.SH DESCRIPTION
+\fIchannel\fP - Previously opened channel instance such as returned by 
+.BR libssh2_channel_open_ex(3)
+
+\fIsingle_connection\fP - non-zero to only forward a single connection.
+
+\fIauth_proto\fP - X11 authentication protocol to use
+
+\fIauth_cookie\fP - the cookie (hexadecimal encoded).
+
+\fIscreen_number\fP - the XLL screen to forward
+
+Request an X11 forwarding on \fIchannel\fP. To use X11 forwarding, 
+.BR libssh2_session_callback_set(3)
+must first be called to set \fBLIBSSH2_CALLBACK_X11\fP. This callback will be
+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.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - 
+
+.SH SEE ALSO
+.BR libssh2_channel_open_ex(3)
+.BR libssh2_session_callback_set(3)

docs/libssh2_free_host_entry.3

@@ -0,0 +1,14 @@
+.\" $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

@@ -0,0 +1,14 @@
+.\" $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

@@ -0,0 +1,27 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+const char *
+libssh2_hostkey_hash(LIBSSH2_SESSION *session, int hash_type);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIhash_type\fP - One of: \fBLIBSSH2_HOSTKEY_HASH_MD5\fP or 
+\fBLIBSSH2_HOSTKEY_HASH_SHA1\fP.
+
+Returns the computed digest of the remote system's hostkey. The length of 
+the returned string is hash_type specific (e.g. 16 bytes for MD5, 
+20 bytes for SHA1).
+.SH RETURN VALUE
+Computed hostkey hash value. or NULL if the session has not yet been started 
+up. (The hash consists of raw binary bytes, not hex digits, so is not 
+directly printable.)
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)

docs/libssh2_new_host_entry.3

@@ -0,0 +1,14 @@
+.\" $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,4 +1,4 @@
-.\" $Id: libssh2_poll.3,v 1.2 2007/04/12 21:30:03 dfandrich Exp $
+.\" $Id: libssh2_poll.3,v 1.3 2007/06/13 12:51:11 jehousley Exp $
 .\"
 .TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
 .SH NAME
@@ -15,5 +15,5 @@ to accommodate the disparate datatypes, POLLFD constants have been namespaced
 to avoid platform discrepancies, and revents has additional values defined.
 .SH "RETURN VALUE"
 Number of fds with interesting events.
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR libssh2_poll_channel_read(3)

docs/libssh2_poll_channel_read.3

@@ -1,4 +1,4 @@
-.\" $Id: libssh2_poll_channel_read.3,v 1.1 2007/02/23 10:20:56 bagder Exp $
+.\" $Id: libssh2_poll_channel_read.3,v 1.2 2007/06/13 12:51:11 jehousley Exp $
 .\"
 .TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
 .SH NAME
@@ -14,5 +14,5 @@ packets are available to be processed. For full polling support, use
 \fIlibssh2_poll(3)\fP.
 .SH RETURN VALUE
 Returns 1 when data is available and 0 otherwise.
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR libssh2_poll(3)

docs/libssh2_publickey_add_ex.3

@@ -0,0 +1,14 @@
+.\" $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
+.SH SYNOPSIS
+
+.SH DESCRIPTION
+
+.SH RETURN VALUE
+
+.SH ERRORS
+
+.SH SEE ALSO

docs/libssh2_publickey_init.3

@@ -0,0 +1,14 @@
+.\" $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
+.SH SYNOPSIS
+
+.SH DESCRIPTION
+
+.SH RETURN VALUE
+
+.SH ERRORS
+
+.SH SEE ALSO

docs/libssh2_publickey_list_fetch.3

@@ -0,0 +1,14 @@
+.\" $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
+.SH SYNOPSIS
+
+.SH DESCRIPTION
+
+.SH RETURN VALUE
+
+.SH ERRORS
+
+.SH SEE ALSO

docs/libssh2_publickey_list_free.3

@@ -0,0 +1,14 @@
+.\" $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
+.SH SYNOPSIS
+
+.SH DESCRIPTION
+
+.SH RETURN VALUE
+
+.SH ERRORS
+
+.SH SEE ALSO

docs/libssh2_publickey_remove_ex.3

@@ -0,0 +1,14 @@
+.\" $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
+.SH SYNOPSIS
+
+.SH DESCRIPTION
+
+.SH RETURN VALUE
+
+.SH ERRORS
+
+.SH SEE ALSO

docs/libssh2_publickey_shutdown.3

@@ -0,0 +1,14 @@
+.\" $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
+.SH SYNOPSIS
+
+.SH DESCRIPTION
+
+.SH RETURN VALUE
+
+.SH ERRORS
+
+.SH SEE ALSO

docs/libssh2_scp_recv.3

@@ -0,0 +1,33 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+LIBSSH2_CHANNEL *
+libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIpath\fP - Full path and filename of file to transfer
+
+\fIsb\fP - Populated with remote file's size, mode, mtime, and atime
+
+Request a file from the remote host via SCP.
+.SH RETURN VALUE
+Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SCP_PROTOCOL\fP - 
+
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would
+block.
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)
+.BR libssh2_channel_open_ex(3)
+

docs/libssh2_scp_send_ex.3

@@ -0,0 +1,42 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+LIBSSH2_CHANNEL *
+libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, size_t size, long mtime, long atime);
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIpath\fP - Full path and filename of file to transfer
+
+\fImode\fP - File access mode to create file with
+
+\fIsize\fP - Size of file being transmitted (Must be known 
+ahead of time precisely)
+
+\fImtime\fP - mtime to assign to file being created
+
+\fIatime\fP - atime to assign to file being created (Set this and 
+mtime to zero to instruct remote host to use current time).
+
+Send a file to the remote host via SCP.
+.SH RETURN VALUE
+Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SCP_PROTOCOL\fP - 
+
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would
+block.
+
+.SH SEE ALSO
+.BR libssh2_channel_open_ex(3)

docs/libssh2_session_abstract.3

@@ -0,0 +1,26 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+void **
+libssh2_session_abstract(LIBSSH2_SESSION *session);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+Return a pointer to where the abstract pointer provided to
+\fBlibssh2_session_init_ex(3)\fP is stored. By providing a doubly
+de-referenced pointer, the internal storage of the session instance may be
+modified in place.
+
+.SH RETURN VALUE
+A pointer to session internal storage whos contents point to previously 
+provided abstract data.
+
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)

docs/libssh2_session_block_directions.3

@@ -0,0 +1,31 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int
+libssh2_session_block_directions(LIBSSH2_SESSION *session);
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by \fBlibssh2_session_init_ex(3)\fP
+
+When any of libssh2 functions return \fBLIBSSH2_ERROR_EAGAIN\fP an application
+should wait for the socket to have data available for reading or
+writing. Depending on the return value of
+\fIlibssh2_session_block_directions(3)\fP an application should wait for read,
+write or both.
+.SH RETURN VALUE
+Returns the set of directions as a binary mask. Can be a combination of:
+
+LIBSSH2_SESSION_BLOCK_INBOUND: Inbound direction blocked.
+
+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.
+.SH AVAILABILITY
+Added in 1.0

docs/libssh2_session_callback_set.3

@@ -0,0 +1,30 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+void *
+libssh2_session_callback_set(LIBSSH2_SESSION *session, int cbtype, void *callback);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIcbtype\fP - Callback type. One of the types listed in Callback Types.
+
+\fIcallback\fP - Pointer to custom callback function. The prototype for 
+this function must match the associated callback declaration macro.
+
+Sets a custom callback handler for a previously initialized session 
+object. Callbacks are triggered by the receipt of special packets at 
+the Transport layer. To disable a callback, set it to NULL.
+
+.SH RETURN VALUE
+Pointer to previous callback handler. Returns NULL if no 
+prior callback handler was set.
+
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)

docs/libssh2_session_disconnect_ex.3

@@ -0,0 +1,40 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason, const char *description, const char *lang);
+
+int 
+libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIreason\fP - One of the Disconnect Reason constants.
+
+\fIdescription\fP - Human readable reason for disconnection.
+
+\fIlang\fP - Localization string describing the langauge/encoding of the description provided.
+
+Send a disconnect message to the remote host associated with \fIsession\fP, 
+along with a \fIreason\fP symbol and a verbose \fIdescription\fP.
+
+As a convenience, the macro 
+.BR libssh2_session_disconnect(3)
+is provided. It calls
+.BR libssh2_session_disconnect_ex(3)
+with \fIreason\fP set to SSH_DISCONNECT_BY_APPLICATION 
+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.
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)

docs/libssh2_session_flag.3

@@ -0,0 +1,15 @@
+.\" $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
+.SH SYNOPSIS
+int
+libssh2_session_flag(LIBSSH2_SESSION * session, int flag, int value);
+.SH DESCRIPTION
+This function has no purpose and no documented flags can be set nor read.
+.SH RETURN VALUE
+0
+.SH ERRORS
+Its mere existence is an error
+.SH SEE ALSO

docs/libssh2_session_free.3

@@ -1,17 +1,20 @@
-.\" $Id: libssh2_session_free.3,v 1.1 2006/12/21 14:09:13 bagder Exp $
+.\" $Id: libssh2_session_free.3,v 1.5 2009/03/16 23:25:14 bagder Exp $
 .\"
-.TH libssh2_session_free 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
+.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
 .SH SYNOPSIS
 #include <libssh2.h>
 
-void libssh2_session_free(LIBSSH2_SESSION *session);
+int 
+libssh2_session_free(LIBSSH2_SESSION *session);
 .SH DESCRIPTION
 Frees resources associated with a session instance. Typically called after
-\fIlibssh2_session_disconnect(3)\fP.
+.BR libssh2_session_disconnect_ex(3)
 .SH RETURN VALUE
-None
-.SH "SEE ALSO"
-.BI libssh2_session_init(3),
-.BI libssh2_session_disconnect(3)
+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 SEE ALSO
+.BR libssh2_session_init_ex(3)
+.BR libssh2_session_disconnect_ex(3)

docs/libssh2_session_get_blocking.3

@@ -0,0 +1,14 @@
+.\" $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
+.SH SYNOPSIS
+int libssh2_session_get_blocking(LIBSSH2_SESSION *session);
+.SH DESCRIPTION
+Returns 0 if the state of the session has previously be set to non-blocking
+and it returns 1 if the state was set to blocking.
+.SH RETURN VALUE
+See description.
+.SH SEE ALSO
+.BR libssh2_session_set_blocking(3)

docs/libssh2_session_init.3

@@ -1,29 +0,0 @@
-.\" $Id: libssh2_session_init.3,v 1.2 2007/04/12 21:30:03 dfandrich Exp $
-.\"
-.TH libssh2_session_init 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
-.SH NAME
-libssh2_session_init - initializes an SSH session object
-.SH SYNOPSIS
-#include <libssh2.h>
-
-LIBSSH2_SESSION *libssh2_session_init_ex(
-                 LIBSSH2_ALLOC_FUNC((*myalloc)),
-                 LIBSSH2_FREE_FUNC((*myfree)),
-                 LIBSSH2_REALLOC_FUNC((*myrealloc)),
-                 void *abstract);
-
-LIBSSH2_SESSION *libssh2_session_init(void);
-.SH DESCRIPTION
-Initializes an SSH session object. By default system memory allocators
-(malloc(), free(), realloc()) will be used for any dynamically allocated memory
-blocks. Alternate memory allocation functions may be specified using the
-extended version of this API call, and/or optional application specific data
-may be attached to the session object.
-
-This method must be called first, prior to configuring session options or
-starting up an SSH session with a remote server.
-.SH RETURN VALUE
-Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on errors.
-.SH "SEE ALSO"
-.BI libssh2_session_free(3),
-.BI libssh2_session_startup(3)

docs/libssh2_session_init_ex.3

@@ -0,0 +1,44 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+LIBSSH2_SESSION * 
+libssh2_session_init_ex(LIBSSH2_ALLOC_FUNC((*myalloc)), LIBSSH2_FREE_FUNC((*myfree)), LIBSSH2_REALLOC_FUNC((*myrealloc)), void *abstract);
+
+LIBSSH2_SESSION *
+libssh2_session_init(void);
+
+.SH DESCRIPTION
+\fImyalloc\fP - Custom allocator function. Refer to the section on Callbacks 
+for implementing an allocator callback. Pass a value of NULL to use the 
+default system allocator.
+
+\fImyfree\fP - Custom de-allocator function. Refer to the section on Callbacks 
+for implementing a deallocator callback. Pass a value of NULL to use the 
+default system deallocator.
+
+\fImyrealloc\fP - Custom re-allocator function. Refer to the section on 
+Callbacks for implementing a reallocator callback. Pass a value of NULL to 
+use the default system reallocator.
+
+\fIabstract\fP - Arbitrary pointer to application specific callback data. 
+This value will be passed to any callback function associated with the named 
+session instance.
+
+Initializes an SSH session object. By default system memory allocators
+(malloc(), free(), realloc()) will be used for any dynamically allocated memory
+blocks. Alternate memory allocation functions may be specified using the
+extended version of this API call, and/or optional application specific data
+may be attached to the session object.
+
+This method must be called first, prior to configuring session options or
+starting up an SSH session with a remote server.
+.SH RETURN VALUE
+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)

docs/libssh2_session_last_errno.3

@@ -0,0 +1,22 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int
+libssh2_session_last_errno(LIBSSH2_SESSION *session);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+Determine the most recent error condition.
+
+.SH RETURN VALUE
+Numeric error code corresponding to the the Error Code constants.
+
+.SH SEE ALSO
+.BR libssh2_session_last_error(3)

docs/libssh2_session_last_error.3

@@ -0,0 +1,33 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int
+libssh2_session_last_error(LIBSSH2_SESSION *session, char **errmsg, int *errmsg_len, int want_buf);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIerrmsg\fP - If not NULL, is populated by reference with the human 
+readable form of the most recent error message.
+
+\fIerrmsg_len\fP - If not NULL, is populated by reference with the length 
+of errmsg. (The string is NUL-terminated, so the length is only useful as 
+an optimization, to avoid calling strlen.)
+
+\fIwant_buf\fP - If set to a non-zero value, "ownership" of the errmsg 
+buffer will be given to the calling scope. If necessary, the errmsg buffer 
+will be duplicated.
+
+Determine the most recent error condition and its cause.
+
+.SH RETURN VALUE
+Numeric error code corresponding to the the Error Code constants.
+
+.SH SEE ALSO
+.BR libssh2_session_last_errno(3)

docs/libssh2_session_method_pref.3

@@ -0,0 +1,42 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_session_method_pref(LIBSSH2_SESSION *session, int method_type, const char *prefs);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fImethod_type\fP - One of the Method Type constants.
+
+\fIprefs\fP - Coma delimited list of preferred methods to use with 
+the most preferred listed first and the least preferred listed last. 
+If a method is listed which is not supported by libssh2 it will be 
+ignored and not sent to the remote host during protocol negotiation.
+
+Set preferred methods to be negotiated. These 
+preferrences must be set prior to calling 
+.BR libssh2_session_startup(3)
+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.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid.
+
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - The requested method is not supported.
+
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)
+.BR libssh2_session_startup(3)

docs/libssh2_session_methods.3

@@ -0,0 +1,29 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+const char *
+libssh2_session_methods(LIBSSH2_SESSION *session, int method_type);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fImethod_type\fP - One of the Method Type constants.
+
+Return the actual method negotiated for a particular transport parameter.
+
+.SH RETURN VALUE
+Negotiated method or NULL if the session has not yet been started.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid.
+
+\fILIBSSH2_ERROR_METHOD_NONE\fP - 
+
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)

docs/libssh2_session_set_blocking.3

@@ -0,0 +1,32 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+
+void 
+libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking);
+
+.SH DESCRIPTION
+\fIsession\fP - session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIblocking\fP - Set to a non-zero value to make the channel block, or zero to
+make it non-blocking.
+
+Set or clear blocking mode on the selected on the session.  This will
+instantly affect any channels associated with this session. If a read is
+performed on a session with no data currently available, a blocking session
+will wait for data to arrive and return what it receives.  A non-blocking
+session will return immediately with an empty buffer.  If a write is performed
+on a session with no room for more data, a blocking session will wait for
+room.  A non-blocking session will return immediately without writing
+anything.
+
+.SH RETURN VALUE
+None
+
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)

docs/libssh2_session_startup.3

@@ -1,16 +1,42 @@
-.\" $Id: libssh2_session_startup.3,v 1.2 2007/01/02 05:47:00 gusarov Exp $
+.\" $Id: libssh2_session_startup.3,v 1.7 2009/03/16 23:25:14 bagder Exp $
 .\"
-.TH libssh2_session_startup 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
+.TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_session_startup - begin transport layer
 .SH SYNOPSIS
 #include <libssh2.h>
 
-int libssh2_session_startup(LIBSSH2_SESSION *session, int socket);
+int 
+libssh2_session_startup(LIBSSH2_SESSION *session, int socket);
+
 .SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIsocket\fP - Connected socket descriptor. Typically a TCP connection 
+though the protocol allows for any reliable transport and the library will 
+attempt to use any berkeley socket.
+
 Begin transport layer protocol negotiation with the connected host.
 .SH RETURN VALUE
-0 on success, \-1 on failure
-.SH "SEE ALSO"
-.BI libssh2_session_free(3),
-.BI libssh2_session_init(3)
+Returns 0 on success, negative on failure.
+.SH ERRORS
+\fILIBSSH2_ERROR_SOCKET_NONE\fP - The socket is invalid.
+
+\fILIBSSH2_ERROR_BANNER_SEND\fP - Unable to send banner to remote host.
+
+\fILIBSSH2_ERROR_KEX_FAILURE\fP - >Encryption key exchange with the remote 
+host failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_DISCONNECT\fP - The socket was disconnected.
+
+\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on 
+the socket.
+
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
+
+.SH SEE ALSO
+.BR libssh2_session_free(3)
+.BR libssh2_session_init_ex(3)

docs/libssh2_sftp_close_handle.3

@@ -0,0 +1,49 @@
+.\" $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
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+int 
+libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle);
+
+int 
+libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle);
+
+int 
+libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle);
+
+.SH DESCRIPTION
+\fIhandle\fP - SFTP File Handle as returned by \fBlibssh2_sftp_open_ex(3)\fP
+or \fBlibssh2_sftp_opendir(3)\fP (which is a macro).
+
+Close an active LIBSSH2_SFTP_HANDLE. Because files and directories 
+share the same underlying storage mechanism these methods may be used 
+interchangably. It is recommended that 
+.BR libssh2_sftp_closedir()
+be used for files and that 
+.BR libssh2_sftp_closedir()
+be used for directories so that future changes in the library may cause
+minimal disruption. Both are macros for \fBlibssh2_sftp_close_handle\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.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to 
+be returned by the server.
+
+.SH SEE ALSO
+.BR libssh2_sftp_open_ex(3)

docs/libssh2_sftp_fstat_ex.3

@@ -0,0 +1,46 @@
+.\" $Id: libssh2_sftp_fstat_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
+.\"
+.TH libssh2_sftp_fstat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_fstat_ex - get or set attributes on a file handle
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+int 
+libssh2_sftp_fstat_ex(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs, int setstat)
+
+int 
+libssh2_sftp_fstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs)
+
+int 
+libssh2_sftp_fsetstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs)
+
+.SH DESCRIPTION
+\fIhandle\fP - SFTP File Handle as returned by 
+.BR libssh2_sftp_open_ex(3)
+
+\fIattrs\fP - Pointer to attribute structure to set file metadata 
+from or into depending on the value of setstat.
+
+\fIsetstat\fP - When non-zero, the file's metadata will be updated 
+with the data found in attrs according to the values of attrs->flags 
+and other relevant member attributes.
+
+Get or Set statbuf type data for a given LIBSSH2_SFTP_HANDLE instance.
+.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 ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to 
+be returned by the server.
+.SH SEE ALSO
+.BR libssh2_sftp_open_ex(3)

docs/libssh2_sftp_init.3

@@ -1,21 +1,41 @@
-.\" $Id: libssh2_sftp_init.3,v 1.2 2007/04/22 17:18:03 jehousley Exp $
+.\" $Id: libssh2_sftp_init.3,v 1.8 2009/03/16 23:25:14 bagder Exp $
 .\"
-.TH libssh2_sftp_init 3 "23 Jan 2007" "libssh2 0.15" "libssh2 manual"
+.TH libssh2_sftp_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
-libssh2_sftp_init - 
+libssh2_sftp_init - open SFTP channel for the given SSH session.
 .SH SYNOPSIS
 #include <libssh2.h>
 #include <libssh2_sftp.h>
 
-LIBSSH2_SFTP *libssh2_sftp_init(LIBSSH2_SESSION *session);
+LIBSSH2_SFTP *
+libssh2_sftp_init(LIBSSH2_SESSION *session);
+
 .SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
 Open a channel and initialize the SFTP subsystem. Although the SFTP subsystem
 operates over the same type of channel as those exported by the Channel API,
 the protocol itself implements its own unique binary packet protocol which
 must be managed with the libssh2_sftp_*() family of functions. When an SFTP
 session is complete, it must be destroyed using the
-\fIlibssh2_sftp_shutdown(3)\fP function.
+.BR libssh2_sftp_shutdown(3)
+function.
 .SH RETURN VALUE
 A pointer to the newly allocated SFTP instance or NULL on failure.
-.SH "SEE ALSO"
-.BI libssh2_sftp_shutdown(3), libssh2_sftp_open_ex(3)
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to be 
+returned by the server.
+
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would
+block.
+.SH SEE ALSO
+.BR libssh2_sftp_shutdown(3)
+.BR libssh2_sftp_open_ex(3)

docs/libssh2_sftp_last_error.3

@@ -0,0 +1,26 @@
+.\" $Id: libssh2_sftp_last_error.3,v 1.2 2008/12/15 18:48:09 bagder Exp $
+.\"
+.TH libssh2_sftp_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_last_error - return the last SFTP-specific error code
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+unsigned long 
+libssh2_sftp_last_error(LIBSSH2_SFTP *sftp);
+
+.SH DESCRIPTION
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
+
+Returns the last error code produced by the SFTP layer. Note that this only
+returns a sensible error code if libssh2 returned LIBSSH2_ERROR_SFTP_PROTOCOL
+in a previous call. Using \fBlibssh2_sftp_last_error(3)\fP without a
+preceeding SFTP protocol error, it will return an unspecified value.
+
+.SH RETURN VALUE
+Current error code state of the SFTP instance.
+
+.SH SEE ALSO
+.BR libssh2_sftp_init(3)

docs/libssh2_sftp_mkdir_ex.3

@@ -1,26 +1,42 @@
-.\" $Id: libssh2_sftp_mkdir_ex.3,v 1.1 2007/04/22 19:51:53 jehousley Exp $
+.\" $Id: libssh2_sftp_mkdir_ex.3,v 1.7 2009/03/16 23:25:14 bagder Exp $
 .\"
-.TH libssh2_sftp_mkdir_ex 3 "16 Apr 2007" "libssh2 0.15" "libssh2 manual"
+.TH libssh2_sftp_mkdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_sftp_mkdir_ex - create a directory on the remote file system
 .SH SYNOPSIS
 #include <libssh2.h>
 #include <libssh2_sftp.h>
 
-int libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, 
-                                   unsigned int path_len, long mode);
+int 
+libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, long mode);
 
+int 
+libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, const char *path, long mode);
 .SH DESCRIPTION
-\fIsftp\fP SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP.
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
 
-\fIpath\fP full path of the new directory to create. Note that the new 
+\fIpath\fP - full path of the new directory to create. Note that the new 
 directory's parents must all exist priot to making this call.
 
-\fIpath_len\fP length of the full path of the new directory to create.
+\fIpath_len\fP - length of the full path of the new directory to create.
 
-\fImode\fP directory creation mode (e.g. 0755).
+\fImode\fP - directory creation mode (e.g. 0755).
 
+Create a directory on the remote file system.
 .SH RETURN VALUE
-0 on success, or -1 on failure.
-.SH "SEE ALSO"
-.BR libssh2_sftp_opendir(3)
+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.
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to be 
+returned by the server.
+.SH SEE ALSO
+.BR libssh2_sftp_open_ex(3)

docs/libssh2_sftp_mkdirnb_ex.3

@@ -1,29 +0,0 @@
-.\" $Id: libssh2_sftp_mkdirnb_ex.3,v 1.1 2007/04/22 19:51:54 jehousley Exp $
-.\"
-.TH libssh2_sftp_mkdir_ex 3 "16 Apr 2007" "libssh2 0.15" "libssh2 manual"
-.SH NAME
-libssh2_sftp_mkdir_ex - create a directory on the remote file system in
-non-blocking mode
-.SH SYNOPSIS
-#include <libssh2.h>
-#include <libssh2_sftp.h>
-
-int libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, 
-                                   unsigned int path_len, long mode);
-
-.SH DESCRIPTION
-\fIsftp\fP SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP.
-
-\fIpath\fP full path of the new directory to create. Note that the new 
-directory's parents must all exist priot to making this call.
-
-\fIpath_len\fP length of the full path of the new directory to create.
-
-\fImode\fP directory creation mode (e.g. 0755).
-
-.SH RETURN VALUE
-0 on success, or -1 on failure.  It returns LIBSSH2CHANNEL_EAGAIN when 
-it would otherwise block. While LIBSSH2CHANNEL_EAGAIN is a negative 
-number, it isn't really a failure per se.
-.SH "SEE ALSO"
-.BR libssh2_sftp_opendir(3)

docs/libssh2_sftp_open_ex.3

@@ -1,23 +1,24 @@
-.\" $Id: libssh2_sftp_open_ex.3,v 1.3 2007/04/22 17:18:03 jehousley Exp $
+.\" $Id: libssh2_sftp_open_ex.3,v 1.10 2009/03/16 23:25:14 bagder Exp $
 .\"
-.TH libssh2_sftp_open_ex 3 "23 Jan 2007" "libssh2 0.15" "libssh2 manual"
+.TH libssh2_sftp_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
-libssh2_sftp_open - 
+libssh2_sftp_open - open filehandle for file on SFTP.
 .SH SYNOPSIS
 #include <libssh2.h>
 #include <libssh2_sftp.h>
 
-LIBSSH2_SFTP_HANDLE *libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp,
-                     char *filename, int filename_len,
-                     unsigned long flags, long mode, int open_type);
+LIBSSH2_SFTP_HANDLE *
+libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len, unsigned long flags, long mode, int open_type);
 
-LIBSSH2_SFTP_HANDLE *libssh2_sftp_open(LIBSSH2_SFTP *sftp,
-                     char *filename, unsigned long flags, long mode);
+LIBSSH2_SFTP_HANDLE *
+libssh2_sftp_open(LIBSSH2_SFTP *sftp, const char *filename, unsigned long flags, long mode);
+
+LIBSSH2_SFTP_HANDLE *
+libssh2_sftp_opendir(LIBSSH2_SFTP *sftp, const char *path);
 
-LIBSSH2_SFTP_HANDLE *libssh2_sftp_opendir(LIBSSH2_SFTP *sftp,
-                     char *path);
 .SH DESCRIPTION
-\fIsftp\fP - SFTP instance as returned by libssh2_sftp_init(). 
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
 
 \fIfilename\fP - Remote file/directory resource to open 
 
@@ -34,6 +35,19 @@ LIBSSH2_SFTP_OPENDIR (to open a directory).
 .SH RETURN VALUE
 A pointer to the newly created LIBSSH2_SFTP_HANDLE instance or NULL on
 failure.
-.SH "SEE ALSO"
-.BI libssh_sftp_close(3)
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to be 
+returned by the server.
+
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would
+block.
+.SH SEE ALSO
+.BR libssh2_sftp_close_handle(3)
 

docs/libssh2_sftp_read.3

@@ -1,27 +1,45 @@
-.\" $Id: libssh2_sftp_read.3,v 1.3 2007/04/22 17:18:03 jehousley Exp $
+.\" $Id: libssh2_sftp_read.3,v 1.10 2009/03/17 10:34:27 bagder Exp $
 .\"
-.TH libssh2_sftp_read 3 "6 Feb 2007" "libssh2 0.15" "libssh2 manual"
+.TH libssh2_sftp_read 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_sftp_read - read data from an SFTP handle
 .SH SYNOPSIS
 #include <libssh2.h>
 #include <libssh2_sftp.h>
 
-ssize_t libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle,
-                          char *buffer, size_t buffer_maxlen);
-.SH DESCRIPTION
-Reads a block of data from an LIBSSH2_SFTP_HANDLE. This method is modelled
-after the POSIX \Iread(3)\fP function and uses the same calling
-semantics. \fIlibssh2_sftp_read(3)\fP will attempt to read as much as possible
-however it may not fill all of buffer if the file pointer reaches the end or
-if further reads would cause the socket to block.
+ssize_t 
+libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen);
 
-\fIhandle\fP is the SFTP File Handle as returned by \fIlibssh2_sftp_open(3)\fP.
+.SH DESCRIPTION
+\fIhandle\fP is the SFTP File Handle as returned by 
+.BR libssh2_sftp_open_ex(3)
 
 \fIbuffer\fP is a pointer to a pre-allocated buffer of at least
+
 \fIbuffer_maxlen\fP bytes to read data into.
+
+Reads a block of data from an LIBSSH2_SFTP_HANDLE. This method is modelled
+after the POSIX 
+.BR read(2)
+function and uses the same calling semantics. 
+.BR libssh2_sftp_read(3)
+will attempt to read as much as possible however it may not fill all of buffer
+if the file pointer reaches the end or if further reads would cause the socket
+to block.
 .SH RETURN VALUE
-Number of bytes actually populated into buffer, or -1 on failure.
-.SH "SEE ALSO"
-.BR libssh2_sftp_open(3)
-.BR libssh2_sftp_readnb(3)
+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.
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
+received on the socket, or an SFTP operation caused an errorcode to be
+returned by the server.
+.SH SEE ALSO
+.BR libssh2_sftp_open_ex(3)
+.BR libssh2_sftp_read(3)

docs/libssh2_sftp_readdir.3

@@ -1,35 +0,0 @@
-.\" $Id: libssh2_sftp_readdir.3,v 1.3 2007/04/22 17:18:03 jehousley Exp $
-.\"
-.TH libssh2_sftp_readdir 3 "16 Apr 2007" "libssh2 0.15" "libssh2 manual"
-.SH NAME
-libssh2_sftp_readdir - read directory data from an SFTP handle
-.SH SYNOPSIS
-#include <libssh2.h>
-#include <libssh2_sftp.h>
-
-int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, 
-                         size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs);
-
-.SH DESCRIPTION
-Read a block of data from a LIBSSH2_SFTP_HANDLE. This method is modeled 
-after the POSIX \fIreaddir(3)\fP however, it uses a variable sized directory 
-entry (filename) buffer and returns statbuf type data in the same call.
-
-\fIhandle\fP is the SFTP File Handle as returned by 
-\fIlibssh2_sftp_diropen(3)\fP.
-
-\fIbuffer\fP is a pointer to a pre-allocated buffer of at least
-\fIbuffer_maxlen\fP bytes to read data into.
-
-\fIbuffer_maxlen\fP is the length of buffer in bytes. If the length of the 
-filename is longer than the space provided by buffer_maxlen it will be 
-truncated to fit.
-
-\fIattrs\fP is a pointer to LIBSSH2_SFTP_ATTRIBUTES storage to populate 
-statbuf style data into.
-
-.SH RETURN VALUE
-Number of bytes actually populated into buffer, or -1 on failure.
-.SH "SEE ALSO"
-.BR libssh2_sftp_opendir(3)
-.BR libssh2_sftp_readdirnb(3)

docs/libssh2_sftp_readdir_ex.3

@@ -0,0 +1,59 @@
+.\" $Id: libssh2_sftp_readdir_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $
+.\"
+.TH libssh2_sftp_readdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_readdir_ex - read directory data from an SFTP handle
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+int 
+libssh2_sftp_readdir_ex(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, char *longentry, size_t longentry_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs);
+
+int 
+libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs);
+
+.SH DESCRIPTION
+\fIhandle\fP - is the SFTP File Handle as returned by 
+.BR libssh2_sftp_open_ex(3)
+
+\fIbuffer\fP - is a pointer to a pre-allocated buffer of at least
+\fIbuffer_maxlen\fP bytes to read data into.
+
+\fIbuffer_maxlen\fP - is the length of buffer in bytes. If the length of the 
+filename is longer than the space provided by buffer_maxlen it will be 
+truncated to fit.
+
+\fIlongentry\fP - is a pointer to a pre-allocated buffer of at least
+\fIlongentry_maxlen\fP bytes to read data into.
+
+\fIlongentry_maxlen\fP - is the length of longentry in bytes. If the length 
+of the full directory entry is longer than the space provided by 
+longentry_maxlen it will be truncated to fit.
+
+\fIattrs\fP - is a pointer to LIBSSH2_SFTP_ATTRIBUTES storage to populate 
+statbuf style data into.
+
+Read a block of data from a LIBSSH2_SFTP_HANDLE. This method is modeled 
+after the POSIX 
+.BR readdir(2)
+however, it uses a variable sized directory entry (filename) buffer and 
+returns statbuf type data in the same call.
+
+.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.
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to be 
+returned by the server.
+.SH SEE ALSO
+.BR libssh2_sftp_open_ex(3),
+.BR libssh2_sftp_close_handle(3)

docs/libssh2_sftp_readdirnb.3

@@ -1,40 +0,0 @@
-.\" $Id: libssh2_sftp_readdirnb.3,v 1.3 2007/04/22 17:18:03 jehousley Exp $
-.\"
-.TH libssh2_sftp_readdir 3 "16 Apr 2007" "libssh2 0.15" "libssh2 manual"
-.SH NAME
-libssh2_sftp_readdirnb - read directory data from an SFTP handle non-blocking
-.SH SYNOPSIS
-#include <libssh2.h>
-#include <libssh2_sftp.h>
-
-int libssh2_sftp_readdirnb(LIBSSH2_SFTP_HANDLE *handle, char *buffer, 
-                         size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs);
-
-.SH DESCRIPTION
-Read a block of data from a LIBSSH2_SFTP_HANDLE non-blocking. This method is 
-modeled after the POSIX \fIreaddir(3)\fP however, it uses a variable sized 
-directory entry (filename) buffer and returns statbuf type data in the same 
-call.
-
-\fIhandle\fP is the SFTP File Handle as returned by 
-\fIlibssh2_sftp_diropen(3)\fP.
-
-\fIbuffer\fP is a pointer to a pre-allocated buffer of at least
-\fIbuffer_maxlen\fP bytes to read data into.
-
-\fIbuffer_maxlen\fP is the length of buffer in bytes. If the length of the 
-filename is longer than the space provided by buffer_maxlen it will be 
-truncated to fit.
-
-\fIattrs\fP is a pointer to LIBSSH2_SFTP_ATTRIBUTES storage to populate 
-statbuf style data into.
-
-.SH RETURN VALUE
-Number of bytes actually populated into buffer, or negative on failure.  It
-returns LIBSSH2CHANNEL_EAGAIN when it would otherwise block. While
-LIBSSH2CHANNEL_EAGAIN is a negative number, it isn't really a failure per se.
-
-
-.SH "SEE ALSO"
-.BR libssh2_sftp_opendir(3)
-.BR libssh2_sftp_readdirnb(3)

docs/libssh2_sftp_readnb.3

@@ -1,29 +0,0 @@
-.\" $Id: libssh2_sftp_readnb.3,v 1.3 2007/04/22 17:18:03 jehousley Exp $
-.\"
-.TH libssh2_sftp_read 3 "6 Feb 2007" "libssh2 0.15" "libssh2 manual"
-.SH NAME
-libssh2_sftp_readnb - read data from an SFTP handle non-blocking
-.SH SYNOPSIS
-#include <libssh2.h>
-#include <libssh2_sftp.h>
-
-ssize_t libssh2_sftp_readnb(LIBSSH2_SFTP_HANDLE *handle,
-                            char *buffer, size_t buffer_maxlen);
-.SH DESCRIPTION
-Reads a block of data from an LIBSSH2_SFTP_HANDLE non-blocking. This method is
-modelled after the POSIX \Iread(3)\fP function and uses the same calling
-semantics. \fIlibssh2_sftp_read(3)\fP will attempt to read as much as possible
-however it may not fill all of buffer if the file pointer reaches the end or
-if further reads would cause the socket to block.
-
-\fIhandle\fP is the SFTP File Handle as returned by \fIlibssh2_sftp_open(3)\fP.
-
-\fIbuffer\fP is a pointer to a pre-allocated buffer of at least
-\fIbuffer_maxlen\fP bytes to read data into.
-.SH RETURN VALUE
-Number of bytes actually populated into buffer, or negative on failure.  It
-returns LIBSSH2CHANNEL_EAGAIN when it would otherwise block. While
-LIBSSH2CHANNEL_EAGAIN is a negative number, it isn't really a failure per se.
-.SH "SEE ALSO"
-.BR libssh2_sftp_read(3)
-.BR libssh2_sftp_open(3)

docs/libssh2_sftp_rename_ex.3

@@ -0,0 +1,58 @@
+.\" $Id: libssh2_sftp_rename_ex.3,v 1.2 2008/12/23 12:34:17 bagder Exp $
+.\"
+.TH libssh2_sftp_rename_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_rename_ex - rename an SFTP file
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+int 
+libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, const char *source_filename, unsigned int source_filename_len, const char *dest_filename, unsigned int dest_filename_len, long flags);
+
+int 
+libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, const char *source_filename, const char *dest_filename);
+
+.SH DESCRIPTION
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
+
+\fIsourcefile\fP - Path and name of the existing filesystem entry
+
+\fIsourcefile_len\fP - Length of the path and name of the existing 
+filesystem entry
+
+\fIdestfile\fP - Path and name of the target filesystem entry
+
+\fIdestfile_len\fP - Length of the path and name of the target 
+filesystem entry
+
+\fIflags\fP - 
+Bitmask flags made up of LIBSSH2_SFTP_RENAME_* constants.
+
+Rename a filesystem object on the remote filesystem. The semantics of 
+this command typically include the ability to move a filsystem object 
+between folders and/or filesystem mounts. If the LIBSSH2_SFTP_RENAME_OVERWRITE 
+flag is not set and the destfile entry already exists, the operation 
+will fail. Use of the other two flags indicate a preference (but not a 
+requirement) for the remote end to perform an atomic rename operation 
+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.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to 
+be returned by the server.
+
+.SH SEE ALSO
+.BR libssh2_sftp_init(3)

docs/libssh2_sftp_rmdir_ex.3

@@ -0,0 +1,43 @@
+.\" $Id: libssh2_sftp_rmdir_ex.3,v 1.2 2008/12/23 12:34:17 bagder Exp $
+.\"
+.TH libssh2_sftp_rmdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_rmdir_ex - remove an SFTP directory
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+int 
+libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len);
+
+int 
+libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, const char *path);
+
+.SH DESCRIPTION
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
+
+\fIsourcefile\fP - Full path of the existing directory to remove.
+
+\fIsourcefile_len\fP - Length of the full path of the existing directory to remove. 
+
+Remove a directory from the remote file system.
+
+.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 ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to 
+be returned by the server.
+
+.SH SEE ALSO
+.BR libssh2_sftp_init(3)

docs/libssh2_sftp_seek.3

@@ -0,0 +1,30 @@
+.\" $Id: libssh2_sftp_seek.3,v 1.5 2009/03/17 10:34:27 bagder Exp $
+.\"
+.TH libssh2_sftp_seek 3 "22 Dec 2008" "libssh2 1.0" "libssh2 manual"
+.SH NAME
+libssh2_sftp_seek - set the read/write position indicator within a file
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+void 
+libssh2_sftp_seek(LIBSSH2_SFTP_HANDLE *handle, size_t offset);
+
+void 
+libssh2_sftp_seek64(LIBSSH2_SFTP_HANDLE *handle, libssh2_uint64_t offset);
+
+.SH DESCRIPTION
+\fIhandle\fP - SFTP File Handle as returned by 
+.BR libssh2_sftp_open_ex(3)
+
+\fIoffset\fP - Number of bytes from the beginning of file to seek to.
+
+Move the file handle's internal pointer to an arbitrary location. 
+Note that libssh2 implements file pointers as a localized concept to make 
+file access appear more POSIX like. No packets are exchanged with the server 
+during a seek operation. The localized file pointer is simply used as a 
+convenience offset during read/write operations.
+.SH AVAILABILITY
+libssh2_sftp_seek64(3) was added in 1.0
+.SH SEE ALSO
+.BR libssh2_sftp_open_ex(3)

docs/libssh2_sftp_shutdown.3

@@ -0,0 +1,26 @@
+.\" $Id: libssh2_sftp_shutdown.3,v 1.1 2007/06/14 16:33:38 jehousley Exp $
+.\"
+.TH libssh2_sftp_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_shutdown - shut down an SFTP session
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+int 
+libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp);
+
+.SH DESCRIPTION
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
+
+Destroys a previously initialized SFTP session and frees all resources 
+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.
+
+.SH SEE ALSO
+.BR libssh2_sftp_init(3)

docs/libssh2_sftp_stat_ex.3

@@ -0,0 +1,62 @@
+.\" $Id: libssh2_sftp_stat_ex.3,v 1.2 2008/12/23 12:34:17 bagder Exp $
+.\"
+.TH libssh2_sftp_stat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_stat_ex - get status about an SFTP file
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+int 
+libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, int stat_type, LIBSSH2_SFTP_ATTRIBUTES *attrs);
+
+int 
+libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs);
+
+int 
+libssh2_sftp_lstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs);
+
+int 
+libssh2_sftp_setstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs);
+
+.SH DESCRIPTION
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
+
+\fIpath\fP - Remote filesystem object to stat/lstat/setstat.
+
+\fIpath_len\fP - Lenght of the name of the remote filesystem object 
+to stat/lstat/setstat.
+
+\fIstat_type\fP - One of the three constants specifying the type of 
+stat operation to perform.
+
+\fIattrs\fP - Pointer to attribute structure to set file metadata 
+from or into depending on the value of stat_type.
+
+Get or Set statbuf type data on a remote filesystem object. When 
+getting statbuf data, 
+.BR libssh2_sftp_stat(3)
+will follow all symlinks, while 
+.BR libssh2_sftp_lstat(3)
+will return data about the object encountered, even if that object 
+happens to be a symlink.
+
+.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 ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to 
+be returned by the server.
+
+.SH SEE ALSO
+.BR libssh2_sftp_init(3)

docs/libssh2_sftp_symlink_ex.3

@@ -0,0 +1,70 @@
+.\" $Id: libssh2_sftp_symlink_ex.3,v 1.1 2007/06/14 16:33:38 jehousley Exp $
+.\"
+.TH libssh2_sftp_symlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_symlink_ex - read or set a symbolic link
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+int 
+libssh2_sftp_symlink_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, char *target, unsigned int target_len, int link_type);
+
+int 
+libssh2_sftp_symlink(LIBSSH2_SFTP *sftp, const char *path, char *target);
+
+int 
+libssh2_sftp_readlink(LIBSSH2_SFTP *sftp, const char *path, char *target, unsigned int target_len);
+
+int 
+libssh2_sftp_realpath(LIBSSH2_SFTP *sftp, const char *path, char *target, unsigned int target_len);
+
+.SH DESCRIPTION
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
+
+\fIpath\fP - Remote filesystem object to create a symlink from or resolve.
+
+\fIpath_len\fP - Length of the name of the remote filesystem object to 
+create a symlink from or resolve.
+
+\fItarget\fP - 
+.br
+\fBLIBSSH2_SFTP_SYMLINK\fP: Remote filesystem object to link to.
+.br
+\fBLIBSSH2_SFTP_READLINK\fP: Pre-allocated buffer to resolve symlink target into.
+.br
+\fBLIBSSH2_SFTP_REALPATH\fP: Pre-allocated buffer to resolve realpath target into.
+
+\fItarget_len\fP - Length of the name of the remote filesystem target object.
+
+\fIlink_type\fP - One of the three previously mentioned constants which 
+determines the resulting behavior of this function.
+
+.BR libssh2_sftp_symlink(3)
+: Create a symbolic link between two filesystem objects.
+.br
+.BR libssh2_sftp_readlink(3)
+: Resolve a symbolic link filesystem object to its next target.
+.br
+.BR libssh2_sftp_realpath(3)
+: Resolve a complex, relative, or symlinked filepath to its effective target.
+
+.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 ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to 
+be returned by the server.
+
+.SH SEE ALSO
+.BR libssh2_sftp_init(3)

docs/libssh2_sftp_tell.3

@@ -0,0 +1,22 @@
+.\" $Id: libssh2_sftp_tell.3,v 1.3 2009/03/17 10:34:27 bagder Exp $
+.\"
+.TH libssh2_sftp_tell 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_tell - get the current read/write position indicator for a file
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+size_t 
+libssh2_sftp_tell(LIBSSH2_SFTP_HANDLE *handle);
+
+.SH DESCRIPTION
+\fIhandle\fP - SFTP File Handle as returned by \fBlibssh2_sftp_open_ex(3)\fP.
+
+Returns the current offset of the file handle's internal pointer. Note that
+this is now deprecated. Use the newer \fBlibssh2_sftp_tell64(3)\fP instead!
+.SH RETURN VALUE
+Current offset from beginning of file in bytes.
+.SH SEE ALSO
+.BR libssh2_sftp_open_ex(3),
+.BR libssh2_sftp_tell64(3)

docs/libssh2_sftp_tell64.3

@@ -0,0 +1,23 @@
+.\" $Id: libssh2_sftp_tell64.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
+.\"
+.TH libssh2_sftp_tell64 3 "22 Dec 2008" "libssh2 1.0" "libssh2 manual"
+.SH NAME
+libssh2_sftp_tell64 - get the current read/write position indicator for a file
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+libssh2_uint64_t
+libssh2_sftp_tell64(LIBSSH2_SFTP_HANDLE *handle);
+
+.SH DESCRIPTION
+\fIhandle\fP - SFTP File Handle as returned by \fBlibssh2_sftp_open_ex(3)\fP
+
+Identify the current offset of the file handle's internal pointer.
+.SH RETURN VALUE
+Current offset from beginning of file in bytes.
+.SH AVAILABILITY
+Added in libssh2 1.0
+.SH SEE ALSO
+.BR libssh2_sftp_open_ex(3),
+.BR libssh2_sftp_tell(3)

docs/libssh2_sftp_unlink_ex.3

@@ -0,0 +1,44 @@
+.\" $Id: libssh2_sftp_unlink_ex.3,v 1.2 2008/12/23 12:34:17 bagder Exp $
+.\"
+.TH libssh2_sftp_unlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_unlink_ex - unlink an SFTP file
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+int 
+libssh2_sftp_unlink_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len);
+
+int 
+libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename);
+
+.SH DESCRIPTION
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
+
+\fIfilename\fP - Path and name of the existing filesystem entry
+
+\fIfilename_len\fP - Length of the path and name of the existing 
+filesystem entry
+
+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.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to 
+be returned by the server.
+
+.SH SEE ALSO
+.BR libssh2_sftp_init(3)

docs/libssh2_sftp_write.3

@@ -0,0 +1,41 @@
+.\" $Id: libssh2_sftp_write.3,v 1.3 2009/03/17 10:34:27 bagder Exp $
+.\"
+.TH libssh2_sftp_write 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_sftp_write - write SFTP data
+.SH SYNOPSIS
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+ssize_t 
+libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, const char *buffer, size_t count);
+
+.SH DESCRIPTION
+\fIhandle\fP - SFTP File Handle as returned by 
+.BR libssh2_sftp_open_ex(3)
+
+\fIbuffer\fP - Pre-initialized data buffer to write to the LIBSSH2_SFTP_HANDLE.
+
+\fIcount\fP - Number of bytes from buffer to write. Note that it may not 
+be possible to write all bytes as requested.
+
+Write a block of data to a LIBSSH2_SFTP_HANDLE. This method is modeled after the POSIX write() function and uses the same calling semantics.
+
+.SH RETURN VALUE
+Actual number of bytes written 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.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 
+
+\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was 
+received on the socket, or an SFTP operation caused an errorcode to 
+be returned by the server.
+
+.SH SEE ALSO
+.BR libssh2_sftp_open_ex(3)

docs/libssh2_trace.3

@@ -0,0 +1,35 @@
+.\" $Id: libssh2_trace.3,v 1.1 2008/12/26 07:46:45 bagder Exp $
+.\"
+.TH libssh2_trace 3 "26 Dec 2008" "libssh2 1.0" "libssh2 manual"
+.SH NAME
+libssh2_trace - enable debug info from inside libssh2
+.SH SYNOPSIS
+#include <libssh2.h>
+
+void libssh2_trace(int bitmask);
+
+.SH DESCRIPTION
+This is a function present in the library that can be used to get debug info
+from within libssh2 when it is running. Helpful when trying to trace or debug
+behaviors. This function has no effect unless libssh2 was built to support
+this option, and a typical "release build" might not.
+
+\fBbitmask\fP can be set to none, one or more of these bits:
+.RS
+.IP LIBSSH2_TRACE_TRANS
+Transport layer debugging
+.IP LIBSSH2_TRACE_KEX
+Key exchange debugging
+.IP LIBSSH2_TRACE_AUTH
+Authentication debugging
+.IP LIBSSH2_TRACE_CONN
+Connection layer debugging
+.IP LIBSSH2_TRACE_SCP
+SCP debugging
+.IP LIBSSH2_TRACE_SFTP
+SFTP debugging
+.IP LIBSSH2_TRACE_ERROR
+Error debugging
+.IP LIBSSH2_TRACE_PUBLICKEY
+Public Key debugging
+.RE

docs/libssh2_userauth_authenticated.3

@@ -0,0 +1,22 @@
+.\" $Id: libssh2_userauth_authenticated.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
+.\"
+.TH libssh2_userauth_authenticated 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_userauth_authenticated - return authentication status
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_userauth_authenticated(LIBSSH2_SESSION *session);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+Indicates whether or not the named session has been successfully authenticated.
+
+.SH RETURN VALUE
+Returns 1 if authenticated and 0 if not.
+
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)

docs/libssh2_userauth_hostbased_fromfile_ex.3

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

docs/libssh2_userauth_keyboard_interactive_ex.3

@@ -0,0 +1,43 @@
+.\" $Id: libssh2_userauth_keyboard_interactive_ex.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
+.\"
+.TH libssh2_userauth_keyboard_interactive_ex 3 "8 Mar 2008" "libssh2 0.19" "libssh2 manual"
+.SH NAME
+libssh2_userauth_keyboard_interactive_ex - authenticate a session using a challenge-response authentication
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int
+libssh2_userauth_keyboard_interactive_ex(LIBSSH2_SESSION *session, const char *username, unsigned int username_len, LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC(*response_callback));
+
+int
+libssh2_userauth_keyboard_interactive(LIBSSH2_SESSION *session, const char *username, LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC(*response_callback));
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIusername\fP - Name of user to attempt plain password authentication for.
+
+\fIusername_len\fP - Length of username parameter.
+
+\fIresponse_callback\fP - As authentication proceeds, host issues several (1 or more) challenges and requires responses. This callback will be called at this moment. Callback is responsible to obtain responses for the challenges, fill the provided data structure and then return control. Responses will be sent to the host. String values will be free(3)ed by the library.
+
+Attempts keyboard-interactive (challenge/response) authentication.
+
+Note that many SSH servers will always issue single "password" challenge,
+requesting actual password as response, but it is not required by the protocol,
+and various authentication schemes, such as smartcard authentication 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.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)

docs/libssh2_userauth_list.3

@@ -0,0 +1,43 @@
+.\" $Id: libssh2_userauth_list.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
+.\"
+.TH libssh2_userauth_list 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_userauth_list - list the authentication methods supported by a server
+.SH SYNOPSIS
+#include <libssh2.h>
+
+char *
+libssh2_userauth_list(LIBSSH2_SESSION *session, const char *username, unsigned int username_len);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIusername\fP - Username which will be used while authenticating. Note 
+that most server implementations do not permit attempting authentication 
+with different usernames between requests. Therefore this must be the 
+same username you will use on later userauth calls.
+
+\fIusername_len\fP - Length of username parameter.
+
+Send a \fBSSH_USERAUTH_NONE\fP request to the remote host. Unless the 
+remote host is configured to accept none as a viable authentication 
+scheme (unlikely), it will return \fBSSH_USERAUTH_FAILURE\fB along with a 
+listing of what authentication schemes it does support. In the unlikely 
+event that none authentication succeeds, this method with return NULL. This 
+case may be distinguished from faily by examining 
+.BR libssh2_userauth_authenticated(3)
+
+.SH RETURN VALUE
+On success a comma delimited list of supported authentication schemes.  This list is 
+internally managed by libssh2.  On failure ruturns NULL.
+
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+
+\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
+
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call
+
+.SH SEE ALSO
+.BR libssh2_session_init_ex(3)