1.2.1 preparations

I went over the commit log and added what I believe is all notable
changes and bugfixes since the 1.2 release

.cvsignore

@@ -1,9 +0,0 @@
-*.lib
-*.pdb
-*.dll
-*.exe
-*.obj
-.*.swp
-Debug
-Release
-*.exp

.gitignore

@@ -0,0 +1,33 @@
+.deps
+.libs
+*.lib
+*.pdb
+*.dll
+*.exe
+*.obj
+.*.swp
+Debug
+Release
+*.exp
+Makefile
+Makefile.in
+aclocal.m4
+autom4te.cache
+config.guess
+config.log
+config.status
+config.sub
+configure
+depcomp
+libtool
+ltmain.sh
+missing
+ssh2_sample
+libssh2-*.tar.gz
+INSTALL
+install-sh
+*.o
+*.lo
+*.la
+mkinstalldirs
+tags

AUTHORS

@@ -0,0 +1,47 @@
+ libssh2 is the result of many friendly people. This list is an attempt to
+ mention all contributors. If we've missed anyone, tell us!
+
+ This list of names is a-z sorted.
+
+Adam Gobiowski
+Alexander Holyapin
+Alexander Lamaison
+Ben Kibbey
+Bjorn Stenborg
+Carlo Bramini
+Dan Casey
+Dan Fandrich
+Daniel Stenberg
+David J Sullivan
+David Robins
+Edink Kadribasic
+Erik Brossler
+Francois Dupoux
+Guenter Knauf
+Heiner Steven
+James Housleys
+Jean-Louis Charton
+Jussi Mononen
+Mark McPherson
+Markus Moeller
+Mike Protts
+Mikhail Gusarov
+Neil Gierman
+Olivier Hervieu
+Paul Veldkamp
+Peter O'Gorman
+Peter Stuge
+Romain Bondue
+Sara Golemon
+Satish Mittal
+Sean Peterson
+Selcuk Gueney
+Simon Hart
+Simon Josefsson
+Steven Ayre
+Steven Van Ingelgem
+Tor Arntsen
+Vincent Jaulin
+Vlad Grachov
+Wez Furlong
+Yang Tse

COPYING

@@ -1,4 +1,6 @@
-/* Copyright (c) 2004-2005, Sara Golemon <sarag@libssh2.org>
+/* Copyright (c) 2004-2007 Sara Golemon <sarag@libssh2.org>
+ * Copyright (c) 2006-2007 The Written Word, Inc.
+ * Copyright (c) 2009 Daniel Stenberg
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms,

HACKING

@@ -0,0 +1,12 @@
+
+libssh2 source code style guide:
+
+ - 4 level indent
+ - spaces-only (no tabs)
+ - open braces on the if/for line:
+
+     if (banana) {
+         go_nuts();
+     }
+
+ - keep source lines shorter than 80 columns

INSTALL

@@ -1,60 +0,0 @@
-Installing libssh2
-==================
-
- * Untar this tarball (which, if you're reading this, you've already done)
-
- * Run: ./configure (passing additional options as desired)
-
-	In addition the the standard set of ./configure options (e.g. --prefix)
-	there are five switches which you may wish to pay attention to:
-
-	* --with-openssl=[DIR]
-
-		libssh2 requires the OpenSSL library (http://www.openssl.org) for
-		cipher and hash method implementations.
-
-		./configure will attempt to locate OpenSSL in a number of default locations:
-			/usr/local/ssl /usr/local /usr /usr/local/openssl
-		If your installation of OpenSSL is in another location, specify it here.
-
-	* --with-zlib=[DIR]
-
-		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.
-
-	* --enable-crypt-none
-
-		The SSH2 Transport allows for unencrypted data transmission using the "none" cipher.
-		Because this is such a huge security hole, it is typically disabled on
-		SSH2 implementations and is diabled in libssh2 by default as well.
-
-		Enabling this option will allow for "none" as a negotiable method,
-		however it still requires that the method be advertized by the remote end
-		and that no more-prefferable methods are available.
-
-	* --enable-mac-none
-
-		The SSH2 Transport also allows implementations to forego a message authentication code.
-		While this is less of a security risk than using a "none" cipher, it is still not
-		recommended as disabling MAC hashes removes a layer of security.
-
-		Enabling this option will allow for "none" as a negotiable method,
-		however it still requires that the method be advertized by the remote end
-		and that no more-prefferable methods are available.
-
-	* --disable-gex-new
-
-		The diffie-hellman-group-exchange-sha1 (dh-gex) key exchange method originally defined
-		an exchange negotiation using packet type 30 to request a generation pair based
-		on a single target value.  Later refinement of dh-gex provided for range and target
-		values.  By default libssh2 will use the newer range method.
-
-		If you experience trouble connecting to an old SSH server using dh-gex,
-		try this option to fallback on the older more reliable method.
-
- * Run: make all install
-

Makefile.am

@@ -0,0 +1,129 @@
+AUTOMAKE_OPTIONS = foreign nostdinc
+
+SUBDIRS = src example tests docs
+
+pkgconfigdir = $(libdir)/pkgconfig
+pkgconfig_DATA = libssh2.pc
+
+include_HEADERS =			\
+	include/libssh2.h		\
+	include/libssh2_publickey.h	\
+	include/libssh2_sftp.h
+
+NETWAREFILES =  nw/keepscreen.c \
+ nw/Makefile \
+ nw/Makefile.netware \
+ nw/nwlib.c \
+ nw/test/Makefile.netware
+
+DSP = win32/libssh2.dsp
+VCPROJ = win32/libssh2.vcproj
+
+DISTCLEANFILES = $(DSP)
+
+WIN32FILES = win32/Makefile.win32 win32/libssh2.dsw     \
+win32/config.mk win32/Makefile win32/test/Makefile.win32 \
+win32/libssh2_config.h win32/tests.dsp win32/rules.mk $(DSP) \
+win32/msvcproj.head win32/msvcproj.foot
+
+EXTRA_DIST = $(WIN32FILES) buildconf $(NETWAREFILES) get_ver.awk HACKING \
+ maketgz NMakefile TODO RELEASE-NOTES libssh2.pc.in
+
+ACLOCAL_AMFLAGS = -I m4
+
+.PHONY: ChangeLog
+ChangeLog:
+	echo "see NEWS" > ./ChangeLog
+DISTCLEANFILES += ChangeLog
+
+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
+
+# DSP/VCPROJ generation adapted from libcurl
+# Makefile.inc provides the CSOURCES and HHEADERS defines
+include Makefile.inc
+
+WIN32SOURCES = $(CSOURCES)
+WIN32HEADERS = $(HHEADERS) libssh2_config.h
+
+DSPOUT = | awk '{printf("%s\r\n", $$0)}' >> $(DSP)
+VCPROJOUT = | awk '{printf("%s\r\n", $$0)}' >> $(VCPROJ)
+
+$(DSP): win32/msvcproj.head win32/msvcproj.foot Makefile.am
+	echo "creating $(DSP)"
+	@(cp $(srcdir)/win32/msvcproj.head $(DSP); \
+	echo "# Begin Group \"Source Files\"" $(DSPOUT); \
+        echo "" $(DSPOUT); \
+        echo "# PROP Default_Filter \"cpp;c;cxx\"" $(DSPOUT); \
+        win32_srcs='$(WIN32SOURCES)'; \
+        sorted_srcs=`for file in $$win32_srcs; do echo $$file; done | sort`; \
+        for file in $$sorted_srcs; do \
+	echo "# Begin Source File" $(DSPOUT); \
+	echo "" $(DSPOUT); \
+	echo "SOURCE=..\\src\\"$$file $(DSPOUT); \
+	echo "# End Source File" $(DSPOUT); \
+	done; \
+	echo "# End Group" $(DSPOUT); \
+	echo "# Begin Group \"Header Files\"" $(DSPOUT); \
+        echo "" $(DSPOUT); \
+        echo "# PROP Default_Filter \"h;hpp;hxx\"" $(DSPOUT); \
+        win32_hdrs='$(WIN32HEADERS)'; \
+        sorted_hdrs=`for file in $$win32_hdrs; do echo $$file; done | sort`; \
+        for file in $$sorted_hdrs; do \
+	echo "# Begin Source File" $(DSPOUT); \
+	echo "" $(DSPOUT); \
+	if [ "$$file" == "libssh2_config.h" ]; \
+	then \
+		echo "SOURCE=.\\"$$file $(DSPOUT); \
+	else \
+		echo "SOURCE=..\\src\\"$$file $(DSPOUT); \
+	fi; \
+	echo "# End Source File" $(DSPOUT); \
+	done; \
+	echo "# End Group" $(DSPOUT); \
+	cat $(srcdir)/win32/msvcproj.foot $(DSPOUT) )
+
+$(VCPROJ): win32/vc8proj.head win32/vc8proj.foot Makefile.am
+	echo "creating $(VCPROJ)"
+	@(cp $(srcdir)/vc8proj.head $(VCPROJ); \
+        win32_srcs='$(WIN32SOURCES)'; \
+        sorted_srcs=`for file in $$win32_srcs; do echo $$file; done | sort`; \
+        for file in $$sorted_srcs; do \
+	echo "<File RelativePath=\""..\src\$$file"\"></File>" $(VCPROJOUT); \
+	done; \
+	echo "</Filter><Filter	Name=\"Header Files\">" $(VCPROJOUT); \
+        win32_hdrs='$(WIN32HEADERS)'; \
+        sorted_hdrs=`for file in $$win32_hdrs; do echo $$file; done | sort`; \
+        for file in $$sorted_hdrs; do \
+	echo "<File RelativePath=\""..\src\$$file"\"></File>" $(VCPROJOUT); \
+	done; \
+	cat $(srcdir)/vc8proj.foot $(VCPROJOUT) )

Makefile.in

@@ -1,66 +0,0 @@
-subdirs = src/
-top_srcdir = @top_srcdir@
-prefix = @prefix@
-exec_prefix = @exec_prefix@
-libdir = @exec_prefix@/lib
-incldir = @prefix@/include
-distdir = @top_srcdir@/dist
-
-CC = @CC@
-CFLAGS = -c @CFLAGS@ -Iinclude/ -Wall -g
-LIBS = -lssh2 -Lsrc/
-INSTALL = @INSTALL@
-VERSION=@PACKAGE_VERSION@
-DISTLIB=libssh2-$(VERSION)
-
-all:
-	@for dir in ${subdirs}; do \
-		(cd $$dir && $(MAKE) all) \
-		|| case "$(MFLAGS)" in *k*) fail=yes;; *) exit 1;; esac; \
-	done && test -z "$$fail"
-	$(CC) -o ssh2_sample.o ssh2_sample.c $(CFLAGS)
-	$(CC) -o ssh2_sample ssh2_sample.o $(LIBS)
-install:
-	$(top_srcdir)/mkinstalldirs $(DESTDIR)$(incldir)
-	$(top_srcdir)/mkinstalldirs $(DESTDIR)$(libdir)
-	@for dir in ${subdirs}; do \
-		(cd $$dir && $(MAKE) install) \
-		|| case "$(MFLAGS)" in *k*) fail=yes;; *) exit 1;; esac; \
-	done && test -z "$$fail"
-	$(INSTALL) -m 644 include/libssh2.h $(DESTDIR)$(incldir)/
-	$(INSTALL) -m 644 include/libssh2_sftp.h $(DESTDIR)$(incldir)/
-	$(INSTALL) -m 644 include/libssh2_publickey.h $(DESTDIR)$(incldir)/
-clean:
-	@for dir in ${subdirs}; do \
-		(cd $$dir && $(MAKE) clean) \
-		|| case "$(MFLAGS)" in *k*) fail=yes;; *) exit 1;; esac; \
-	done && test -z "$$fail"
-	rm -f ssh2_sample.o ssh2_sample
-dist:
-	autoheader
-	autoconf
-	rm -f $(DISTLIB)
-	ln -s . $(DISTLIB)
-	tar -zcf $(DISTLIB).tar.gz \
-		$(DISTLIB)/configure $(DISTLIB)/Makefile.in $(DISTLIB)/ssh2_sample.c \
-		$(DISTLIB)/LICENSE $(DISTLIB)/README $(DISTLIB)/INSTALL \
-		$(DISTLIB)/mkinstalldirs $(DISTLIB)/install-sh $(DISTLIB)/config.sub $(DISTLIB)/config.guess \
-		$(DISTLIB)/src/*.c $(DISTLIB)/src/Makefile.in \
-		$(DISTLIB)/include/libssh2.h $(DISTLIB)/include/libssh2_priv.h $(DISTLIB)/include/libssh2_sftp.h \
-		$(DISTLIB)/include/libssh2_publickey.h $(DISTLIB)/include/libssh2_config.h.in \
-		$(DISTLIB)/win32/config.mk $(DISTLIB)/win32/libssh2_config.h $(DISTLIB)/win32/rules.mk \
-		$(DISTLIB)/win32/libssh2.dsp $(DISTLIB)/win32/libssh2.dsw $(DISTLIB)/win32/ssh2_sample.dsp
-	rm -f $(DISTLIB)
-dist_nmake:
-	autoheader
-	autoconf
-	rm -f $(DISTLIB)
-	ln -s . $(DISTLIB)
-	tar -zcf $(DISTLIB)-win32.tar.gz \
-		$(DISTLIB)/NMakefile $(DISTLIB)/ssh2_sample.c $(DISTLIB)/src/*.c \
-		$(DISTLIB)/LICENSE $(DISTLIB)/README $(DISTLIB)/TODO $(DISTLIB)/INSTALL \
-		$(DISTLIB)/include/libssh2.h $(DISTLIB)/include/libssh2_priv.h $(DISTLIB)/include/libssh2_sftp.h \
-		$(DISTLIB)/include/libssh2_publickey.h \
-		$(DISTLIB)/win32/config.mk $(DISTLIB)/win32/libssh2_config.h $(DISTLIB)/win32/rules.mk
-	rm -f $(DISTLIB)
-

Makefile.inc

@@ -0,0 +1,5 @@
+CSOURCES = channel.c comp.c crypt.c hostkey.c kex.c mac.c misc.c \
+ packet.c publickey.c scp.c session.c sftp.c userauth.c transport.c \
+ version.c knownhost.c openssl.c libgcrypt.c pem.c
+
+HHEADERS = libssh2_priv.h openssl.h libgcrypt.h transport.h channel.h comp.h mac.h misc.h

NEWS

@@ -0,0 +1,640 @@
+Version 1.2.1 (September 28, 2009)
+
+* This release includes the following changes:
+
+  o generate and install libssh2.pc
+
+  ... and the following bugfixes:
+
+  o proper return codes returned from several functions
+  o return EAGAIN internal cleanup
+  o added knownhost.c to windows makefiles
+  o pass private-key to OpenSSL as a filename with BIO_new_file().
+  o make libssh2_scp_send/recv do blocking mode correctly
+  o libssh2_channel_wait_closed() could hang
+  o libssh2_channel_read_ex() must return 0 when closed
+  o added gettimeofday() function for win32 for the debug trace outputs
+  o transport layer bug causing invalid -39 (LIBSSH2_ERROR_BAD_USE) errors
+  o scp examples now loop correctly over libssh2_channel_write()
+
+* (August 29 2009) Daniel Stenberg:
+
+ - I fixed all code to use the recently added dedicated linked list functions
+   instead of doing the same stuff spread out all over.
+
+ - I also fixed a few cases where local variables where used to keep memory
+   but was used to keep state for re-invokes due to non-blocking situations
+   which would lead to segfaults.
+
+Version 1.2 (August 10, 2009)
+-----------------------------
+
+* (August 02 2009) Alexander Lamaison:
+
+ - changed _libssh2_rsa_new_private and _libssh2_rsa_new_private so that they
+   no longer use the OpenSSL functions that take a FILE* argument.  Passing
+   CRT-created objects across a DLL boundary causes crashes on Windows of the
+   DLL and the client aren't linked to the exact same verison of the CRT. Now
+   we pass the keys as strings to avoid this issue.
+
+* (May 29 2009) Daniel Stenberg:
+
+ - Updated the knownhost API and there are now 9 functions, and all of them
+   have man pages. The libssh2.h now defines HAVE_LIBSSH2_KNOWNHOST_API to
+   ease things for applications to check for the correct release before trying
+   to use it.
+
+* (May 23 2009) Daniel Stenberg:
+
+ - Anonymous bug report #2795816 revealed that doing subsequent
+   libssh2_sftp_init() calls on the same session failed.
+
+* (May 20 2009) Daniel Stenberg:
+
+  - made libssh2_sftp_write() properly deal with huge/any sized input buffers.
+
+  - fixed libssh2_channel_write_ex() to return the correct return code, and
+    deal with sending off huge buffers better
+
+* (May 7 2009) Daniel Stenberg:
+
+  - linked list code. I got a bit tired of the fact that we don't have any
+    generic linked-list functions within libssh2 so I wrote up the first embryo
+    for one that I use for this new functionality. The plan would then be to
+    move all existing code that uses linked lists to use this new set.
+
+  - base64 encode. I had to add a base64 encoding function which was missing
+    in the code base so it helps to "bloat" my patch.
+
+  - The knownhost API is currently:
+
+    _init() - init a bundle of known hosts
+    _add()  - add a known host
+    _del()  - delete a known host
+    _free() - free an entire bundle of known hosts
+    _check() - check if a host+key is present in the bundle
+
+    The convenience function:
+
+    _parsefile() - reads a ~/.ssh/known_hosts file and add all entries to the
+                   given bundle
+
+   - there's no docs other than some comments in the code/headers yet
+
+  - the patch includes changes to example/simple/ssh2_exec.c that makes use of
+    a few of these functions. Using that I've verified that the functions in
+    fact can verify my localhost's key agains my ~/.ssh/known_hosts file
+
+* (Apr 30 2009) Daniel Stenberg:
+
+  Markus posted a bug report about a bad 0-return from libssh2_channel_read:
+  http://libssh2.haxx.se/mail/libssh2-devel-archive-2009-04/0076.shtml
+
+  And it was indeed a bad loop that terminated too early due to a receveived
+  close packet.
+
+* (Apr 14 2009) Daniel Stenberg:
+
+  libssh2_poll() and libssh2_poll_channel_read() are now considered and
+  documented deprecated and they will be removed at next soname bump. It also
+  saves us from fixing some rather quirky bugs in libssh2_poll()...
+
+
+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()
+   libssh2_channel_writenb_ex()
+   libssh2_sftp_readnb()
+   libssh2_sftp_writenb()
+
+  Size parameter changed from 'int' to 'unsigned int' in several
+  public APIs.
+
+  Added (a few) man pages in docs/. (Daniel Stenberg)
+
+  Maximum SSH packet size is now some 35000 bytes.
+
+  Private include files are now in src/ and only public headers are in
+  include/.  (Daniel Stenberg)
+
+  Automake and libtool are being used (increased portability). (Daniel
+  Stenberg)
+
+  Fixed OpenSSL detection using pkg-config. (Daniel Stenberg)
+
+  Simple self test added to tests/. (Simon Josefsson)
+
+  Libgcrypt can now be used instead of OpenSSL if you specify
+  --with-libgcrypt.  (Simon Josefsson)
+
+  Fixed a memory leak in the packet handling, and better handle out of
+  memory situations. (Dan Fandrich)
+
+  Made libssh2 build with OpenSSL 0.9.6. (Dan Fandrich)
+
+  Improved portability to Solaris related to -lsocket and
+  -lnsl. (Simon Josefsson)
+
+  Clean up of README, INSTALL, NEWS, added ChangeLog. (Simon
+  Josefsson)
+
+  Improve debugging code.  Avoids many #ifdef's.
+
+  Improved session closing to avoid potentially truncated files on
+  OpenSSH servers (Dan Fandrich)
+
+  Made some function parameters in the API const (Dan Fandrich)
+
+Version 0.14
+------------
+
+  Plug leaks in EVP cipher init/shutdown. (Selcuk Gueney)
+
+  Allow socket_fd == 0 in libssh2_session_startup(). (puudeli)
+
+  Swap ordering of packet_add/packet-inspection to avoid inspect after
+  free. (Selcuk)
+
+  Swap KEX_INIT ordering, send our KEX_INIT first.
+
+  Add check for oportunistic KEX_INIT packets.  Burn bad guess if necessary.
+
+  Fix OpenSSL detection using pkg-config. (Dan Casey)
+
+Version 0.13
+------------
+
+  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 `make install' target for MacOSX.
+
+  Add terminating NULL character to readlink()/realpath() results.
+
+  BugFix#1436593: Apply build options for HPUX targets.
+
+Version 0.12
+------------
+
+  Added support for publickey subsytem (not the same as publickey auth).
+
+  Fix x11_req.  Multiple packet_len issues and error handling logic.
+    (Thanks Simon Hart)
+
+  Fix generation of 'e' portion of Diffie-Hellman keyset.
+
+  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.
+
+  Fixed build with newer OpenSSL headers.
+
+  Added extern "C" declarations to libssh2_sftp.h for C++ compatability.
+
+Version 0.11
+------------
+
+  Added libssh2_chnnale_get_exit_status() -- Mikhail
+
+  Added libssh2_channel_wait_closed() -- Mikhail
+
+  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 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).
+
+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.
+
+  (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 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)
+
+  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)
+
+  Added tests for -lm and -lsocket and add them when necessary.
+
+  Added libssh2_channel_window_read_ex() and libssh2_channel_window_write_ex()
+  for examining the ssh transport windowing states.
+
+Version 0.8
+-----------
+
+  Fix potential segfault in compression/decompression.
+
+  Fix compatability with older versions of OpenSSL
+
+  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 libssh2_poll() to check status of sockets/channels/listeners.
+
+  Removed unnecessary inclusion of stdio.h (holdover from debugging)
+
+Version 0.7
+-----------
+
+  Added libssh2_userauth_hostbased_fromfile_ex() for authenticating from hostkey.
+
+  Added configure recognition for MacOSX (Darwin) (Thanks Gabe)
+
+  Fixed extended data identification in libssh2_channel_read().
+
+  Fixed window adjust code.  Hadn't acknowledged adjustments correctly.
+
+  Removed initial_window_size requirement for sending window adjust packet.
+
+
+Version 0.6
+-----------
+
+  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.
+
+  Fix zlib compression issue when internal buffer state misses partial sync.
+
+  Fix segfault when libssh2_session_methods() is called prior to
+  session_startup().
+
+  Fixed client to server channel windowing.  Pervent send queue overruns.
+
+  Swapped banner send/receive order (send first, then wait for response).
+
+Version 0.5
+-----------
+
+  *** BC Break ***
+  Reimplemented libssh2_session_methods() to match
+  libssh2_session_method_pref() style
+
+  Fixed libssh2_attr2bin() (effects any setstat style call).
+
+  Fixed authenticating with encrypted private key.
+
+  Fixed authenticating via ssh-dss public key.
+
+  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 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 MAC methods hmac-md5 and hmac-md5-96.
+
+Version 0.4
+-----------
+
+  Fixed crash when trying to free sftp_dirhandle data from a filehandle struct.
+
+  Fixed leak in sftp_open_ex(), handle->handle not freed in handle_close().
+
+  Fixed leak in sftp_symlink_ex(), result for READLINK and REALPATH not freed unless there was an error.
+
+  Added libssh2_banner_set(), specify an arbitrary banner to send on introduction.
+
+Version 0.3
+-----------
+
+  Fixed libssh2_channel_read_ex().  Packet loop initialized BEFORE transport polled for new packets (should have been after).
+
+  Fixed blocking issues in scp_send()/scp_recv().
+
+  Fixed degree of indirection in macerror callback.
+
+  Changed packet read mechanism to use a fixed buffer and avoid unnecessary alloc/free calls. (especially while non-block looping)
+
+  Added channel close callback.
+
+  Added SFTP support (Using its own header file: libssh2_sftp.h)
+
+Version 0.2
+-----------
+
+  Changed extended data ignorance mechanism:
+    libssh2_channel_ignore_extended_data() changed to libssh2_channel_handle_extended_data()
+    Macro introduced for backward compatability during beta phase.
+    *** THE LIBSSH2_CHANNEL_IGNORE_EXTENDED_DATA() MACRO WILL BE REMOVED PRIOR TO 1.0 RELEASE ***
+    libssh2_channel_handle_extended_data() may be passed one of three "ignore_mode" constants
+      LIBSSH2_CHANNEL_EXTENDED_DATA_NONE       Default behavior, queue ED packets and return them with read_ex
+      LIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE     Equivalent to libssh2_channel_ignore_extended_data()
+                                               IGNORE will implicitly flush the extended data stream(s)
+      LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE      Calls to channel_read() will check both the standard data stream
+                                               and the extended data stream(s) for the first available packet
+
+  Changed libssh2_session_disconnect_ex() to return an error code when alloc fails
+
+  Added libssh2_channel_flush_ex() and basic macros: ..._flush() ..._flush_stderr()
+    flush_ex accepts either the streamid (0 for standard data, 1 for stderr) or one of the two following constants:
+      LIBSSH2_CHANNEL_FLUSH_ALL                Flush all streams
+      LIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA      Flush all streams EXCEPT the standard data stream
+
+  Added libssh2_session_callback_set() for setting ignore/debug/disconnect/macerror callbacks
+
+  Added libssh2_session_method_pref() to selectively set methods and method preferences.
+
+  Added libssh2_session_methods() to determine what methods were negotiated.
+
+  Added libssh2_session_abstract() for retreiving &session->abstract
+
+  Added libssh2_session_last_error() for retreiving error codes/messages
+
+Version 0.1
+-----------
+
+  Initial Release:
+    KEX methods: diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1
+    Hostkey methods: ssh-rsa, ssh-dss
+    Cipher methods: aes256-cbc, rijndael-cbc@lysator.liu.se, aes192-cbc, aes128-cbc, blowfish-cbc, arcfour, cast128-cbc, 3des-cbc, none*
+    Compression methods: zlib, none
+    MAC methods: hmac-sha1, hmac-sha1-96, hmac-ripemd160, hmac-ripemd160@openssh.com none*
+    *Cipher/MAC "none" is disabled by default for security purposes,
+     Use --enable-crypt-none and/or --enable-mac-none with ./configure to enable

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

@@ -1,208 +1,97 @@
 libssh2 - SSH2 library
 ======================
 
-Version 0.12
-------------
+libssh2 is a library implementing the SSH2 protocol, available under
+the revised BSD license.
 
-  Added support for publickey subsytem (not the same as publickey auth).
+Web site: http://www.libssh2.org/
 
-  Fix x11_req.  Multiple packet_len issues and error handling logic.
-    (Thanks Simon Hart)
+Mailing list: http://cool.haxx.se/mailman/listinfo/libssh2-devel
 
-  Fix generation of 'e' portion of Diffie-Hellman keyset.
-	Use appropriate order for BN_rand() rather than fixed group1-specific value.
+Generic installation instructions are in INSTALL.  Some ./configure
+options deserve additional comments:
 
-  Re-fixed libssh2_sftp_rename_ex()
-    Transport had right packet_len, but sftp layer still had extra 4 bytes.
+	* --enable-crypt-none
 
-  Fixed build with newer OpenSSL headers.
+		The SSH2 Transport allows for unencrypted data
+		transmission using the "none" cipher.  Because this is
+		such a huge security hole, it is typically disabled on
+		SSH2 implementations and is disabled in libssh2 by
+		default as well.
 
-  Added extern "C" declarations to libssh2_sftp.h for C++ compatability.
+		Enabling this option will allow for "none" as a
+		negotiable method, however it still requires that the
+		method be advertized by the remote end and that no
+		more-preferable methods are available.
 
-Version 0.11
-------------
+	* --enable-mac-none
 
-  Added libssh2_chnnale_get_exit_status() -- Mikhail
+		The SSH2 Transport also allows implementations to
+		forego a message authentication code.  While this is
+		less of a security risk than using a "none" cipher, it
+		is still not recommended as disabling MAC hashes
+		removes a layer of security.
 
-  Added libssh2_channel_wait_closed() -- Mikhail
+		Enabling this option will allow for "none" as a
+		negotiable method, however it still requires that the
+		method be advertized by the remote end and that no
+		more-preferable methods are available.
 
-  Added libssh2_userauth_keyboard_interactive_ex() -- Mikhail
+	* --disable-gex-new
 
-  Added libssh2_channel_receive_window_adjust() to be able to increase the size of the receive window.
+		The diffie-hellman-group-exchange-sha1 (dh-gex) key
+		exchange method originally defined an exchange
+		negotiation using packet type 30 to request a
+		generation pair based on a single target value.  Later
+		refinement of dh-gex provided for range and target
+		values.  By default libssh2 will use the newer range
+		method.
 
-  Added queueing for small window_adjust packets to avoid unnecessary packet conversation.
+		If you experience trouble connecting to an old SSH
+		server using dh-gex, try this option to fallback on
+		the older more reliable method.
 
-  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).
+  	* --with-libgcrypt
+  	* --without-libgcrypt
+	* --with-libgcrypt-prefix=DIR
 
-Version 0.10
-------------
+		libssh2 can use the Libgcrypt library
+		(http://www.gnupg.org/) for cryptographic operations.
+		Either Libgcrypt or OpenSSL is required.
 
-  Added developer debugging hooks.  See --enable-debug-* options to ./configure
+		Configure will attempt to locate Libgcrypt
+		automatically.
 
-  Ignore extended data in the SFTP layer.  With no other mechanism to deal with that data it'd just fill up and get stuck.
+ 		If your installation of Libgcrypt is in another
+		location, specify it using --with-libgcrypt-prefix.
 
-  (Re)Fixed channel_write() to provide an opportunity for window space to become available again.
+	* --with-openssl
+	* --without-openssl
+	* --with-libssl-prefix=[DIR]
 
-  (Re)Fixed SFTP INIT to send the correct SFTP packet length.
+		libssh2 can use the OpenSSL library
+		(http://www.openssl.org) for cryptographic operations.
+		Either Libgcrypt or OpenSSL is required.
 
-  Fixed segfault when client and host can't agree on a hostkey/crypt/mac/comp method. (Thanks puudeli)
+		Configure will attempt to locate OpenSSL in the
+		default location.
 
-  Fixed major issue with sftp packet buffering mechanism.  Using wrong blocking semantics. (No puudeli, YOU the man)
+		If your installation of OpenSSL is in another
+		location, specify it using --with-libssl-prefix.
 
-  Reduced busy-looping of libssh2_sftp_packet_requirev.
+	* --with-libz
+	* --without-libz
+	* --with-libz-prefix=[DIR]
 
-Version 0.9
------------
+		If present, libssh2 will attempt to use the zlib
+		(http://www.zlib.org) for payload compression, however
+		zlib is not required.
 
-  Changed blocking_read to only block as much as necessary and not an arbitrary length of time. (Thanks Felix)
+		If your installation of Libz is in another location,
+		specify it using --with-libz-prefix.
 
-  Fixed SFTP INIT/VERSION to exclude request_id and send correct maximum version number.
+	* --enable-debug
 
-  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)
-
-  Added tests for -lm and -lsocket and add them when necessary.
-
-  Added libssh2_channel_window_read_ex() and libssh2_channel_window_write_ex()
-  for examining the ssh transport windowing states.
-
-Version 0.8
------------
-
-  Fix potential segfault in compression/decompression.
-
-  Fix compatability with older versions of OpenSSL
-
-  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 libssh2_poll() to check status of sockets/channels/listeners.
-
-  Removed unnecessary inclusion of stdio.h (holdover from debugging)
-
-Version 0.7
------------
-
-  Added libssh2_userauth_hostbased_fromfile_ex() for authenticating from hostkey.
-
-  Added configure recognition for MacOSX (Darwin) (Thanks Gabe)
-
-  Fixed extended data identification in libssh2_channel_read().
-
-  Fixed window adjust code.  Hadn't acknowledged adjustments correctly.
-
-  Removed initial_window_size requirement for sending window adjust packet.
-
-
-Version 0.6
------------
-
-  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.
-
-  Fix zlib compression issue when internal buffer state misses partial sync.
-
-  Fix segfault when libssh2_session_methods() is called prior to session_startup().
-
-  Fixed client to server channel windowing.  Pervent send queue overruns.
-
-  Swapped banner send/receive order (send first, then wait for response).
-
-Version 0.5
------------
-
-  *** BC Break ***
-  Reimplemented libssh2_session_methods() to match libssh2_session_method_pref() style
-
-  Fixed libssh2_attr2bin() (effects any setstat style call).
-
-  Fixed authenticating with encrypted private key.
-
-  Fixed authenticating via ssh-dss public key.
-
-  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 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 MAC methods hmac-md5 and hmac-md5-96.
-
-Version 0.4
------------
-
-  Fixed crash when trying to free sftp_dirhandle data from a filehandle struct.
-
-  Fixed leak in sftp_open_ex(), handle->handle not freed in handle_close().
-
-  Fixed leak in sftp_symlink_ex(), result for READLINK and REALPATH not freed unless there was an error.
-
-  Added libssh2_banner_set(), specify an arbitrary banner to send on introduction.
-
-Version 0.3
------------
-
-  Fixed libssh2_channel_read_ex().  Packet loop initialized BEFORE transport polled for new packets (should have been after).
-
-  Fixed blocking issues in scp_send()/scp_recv().
-
-  Fixed degree of indirection in macerror callback.
-
-  Changed packet read mechanism to use a fixed buffer and avoid unnecessary alloc/free calls. (especially while non-block looping)
-
-  Added channel close callback.
-
-  Added SFTP support (Using its own header file: libssh2_sftp.h)
-
-Version 0.2
------------
-
-  Changed extended data ignorance mechanism:
-    libssh2_channel_ignore_extended_data() changed to libssh2_channel_handle_extended_data()
-    Macro introduced for backward compatability during beta phase.
-    *** THE LIBSSH2_CHANNEL_IGNORE_EXTENDED_DATA() MACRO WILL BE REMOVED PRIOR TO 1.0 RELEASE ***
-    libssh2_channel_handle_extended_data() may be passed one of three "ignore_mode" constants
-      LIBSSH2_CHANNEL_EXTENDED_DATA_NONE       Default behavior, queue ED packets and return them with read_ex
-      LIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE     Equivalent to libssh2_channel_ignore_extended_data()
-                                               IGNORE will implicitly flush the extended data stream(s)
-      LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE      Calls to channel_read() will check both the standard data stream
-                                               and the extended data stream(s) for the first available packet
-
-  Changed libssh2_session_disconnect_ex() to return an error code when alloc fails
-
-  Added libssh2_channel_flush_ex() and basic macros: ..._flush() ..._flush_stderr()
-    flush_ex accepts either the streamid (0 for standard data, 1 for stderr) or one of the two following constants:
-      LIBSSH2_CHANNEL_FLUSH_ALL                Flush all streams
-      LIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA      Flush all streams EXCEPT the standard data stream
-
-  Added libssh2_session_callback_set() for setting ignore/debug/disconnect/macerror callbacks
-
-  Added libssh2_session_method_pref() to selectively set methods and method preferences.
-
-  Added libssh2_session_methods() to determine what methods were negotiated.
-
-  Added libssh2_session_abstract() for retreiving &session->abstract
-
-  Added libssh2_session_last_error() for retreiving error codes/messages
-
-Version 0.1
------------
-
-  Initial Release:
-    KEX methods: diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1
-    Hostkey methods: ssh-rsa, ssh-dss
-    Cipher methods: aes256-cbc, rijndael-cbc@lysator.liu.se, aes192-cbc, aes128-cbc, blowfish-cbc, arcfour, cast128-cbc, 3des-cbc, none*
-    Compression methods: zlib, none
-    MAC methods: hmac-sha1, hmac-sha1-96, hmac-ripemd160, hmac-ripemd160@openssh.com none*
-    *Cipher/MAC "none" is disabled by default for security purposes,
-     Use --enable-crypt-none and/or --enable-mac-none with ./configure to enable
+		Will make the build use more pedantic and strict compiler
+		options as well as enable the libssh2_trace() function (for
+		showing debug traces).

RELEASE-NOTES

@@ -0,0 +1,27 @@
+libssh2 1.2.1
+
+This release includes the following changes:
+
+ o generate and install libssh2.pc
+
+This release includes the following bugfixes:
+
+ o proper return codes returned from several functions
+ o return EAGAIN internal cleanup
+ o added knownhost.c to windows makefiles
+ o pass private-key to OpenSSL as a filename with BIO_new_file().
+ o make libssh2_scp_send/recv do blocking mode correctly
+ o libssh2_channel_wait_closed() could hang
+ o libssh2_channel_read_ex() must return 0 when closed
+ o added gettimeofday() function for win32 for the debug trace outputs
+ o transport layer bug causing invalid -39 (LIBSSH2_ERROR_BAD_USE) errors
+ o scp examples now loop correctly over libssh2_channel_write()
+
+This release would not have looked like this without help, code, reports and
+advice from friends like these:
+
+ Peter Stuge, Neil Gierman, Steven Van Ingelgem, Alexander Lamaison,
+ Guenter Knauf, Simon Josefsson
+ 
+
+        Thanks! (and sorry if I forgot to mention someone)

TODO

@@ -0,0 +1,42 @@
+Things TODO
+===========
+
+* make sure the windowing code adapts better to slow situations so that it
+  doesn't then use as much memory as today
+
+* Introduce a 'libssh2_socket_t' type for sockets in internal code
+
+* Provide a libssh2_scp_send() API for files larger than 4GB (32bit size)
+
+* Add more info to the man pages.
+
+* 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
+
+* Fix all compiler warnings (some can't be done without API changes)
+
+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.
+
+* fix the parts of the API where object pointers and function pointers are
+  mixed like libssh2_session_callback_set()
+
+* remove the following functions from the API/ABI
+
+  libssh2_base64_decode()
+  libssh2_session_flag()
+  libssh2_channel_handle_extended_data()
+  libssh2_channel_receive_window_adjust()
+  libssh2_poll()
+  libssh2_poll_channel_read()
+
+* Rename a few function:
+
+  libssh2_hostkey_hash => libssh2_session_hostkey_hash
+  libssh2_banner_set => libssh2_session_banner_set

acinclude.m4

@@ -0,0 +1,384 @@
+
+dnl **********************************************************************
+dnl CURL_DETECT_ICC ([ACTION-IF-YES])
+dnl
+dnl check if this is the Intel ICC compiler, and if so run the ACTION-IF-YES
+dnl sets the $ICC variable to "yes" or "no"
+dnl **********************************************************************
+AC_DEFUN([CURL_DETECT_ICC],
+[
+    ICC="no"
+    AC_MSG_CHECKING([for icc in use])
+    if test "$GCC" = "yes"; then
+       dnl check if this is icc acting as gcc in disguise
+       AC_EGREP_CPP([^__INTEL_COMPILER], [__INTEL_COMPILER],
+         dnl action if the text is found, this it has not been replaced by the
+         dnl cpp
+         ICC="no",
+         dnl the text was not found, it was replaced by the cpp
+         ICC="yes"
+         AC_MSG_RESULT([yes])
+         [$1]
+       )
+    fi
+    if test "$ICC" = "no"; then
+        # this is not ICC
+        AC_MSG_RESULT([no])
+    fi
+])
+
+dnl We create a function for detecting which compiler we use and then set as
+dnl pendantic compiler options as possible for that particular compiler. The
+dnl options are only used for debug-builds.
+
+AC_DEFUN([CURL_CC_DEBUG_OPTS],
+[
+    if test "z$ICC" = "z"; then
+      CURL_DETECT_ICC
+    fi
+
+    if test "$GCC" = "yes"; then
+
+       dnl figure out gcc version!
+       AC_MSG_CHECKING([gcc version])
+       gccver=`$CC -dumpversion`
+       num1=`echo $gccver | cut -d . -f1`
+       num2=`echo $gccver | cut -d . -f2`
+       gccnum=`(expr $num1 "*" 100 + $num2) 2>/dev/null`
+       AC_MSG_RESULT($gccver)
+
+       if test "$ICC" = "yes"; then
+         dnl this is icc, not gcc.
+
+         dnl ICC warnings we ignore:
+         dnl * 269 warns on our "%Od" printf formatters for curl_off_t output:
+         dnl   "invalid format string conversion"
+         dnl * 279 warns on static conditions in while expressions
+         dnl * 981 warns on "operands are evaluated in unspecified order"
+         dnl * 1418 "external definition with no prior declaration"
+         dnl * 1419 warns on "external declaration in primary source file"
+         dnl   which we know and do on purpose.
+
+         WARN="-wd279,269,981,1418,1419"
+
+         if test "$gccnum" -gt "600"; then
+            dnl icc 6.0 and older doesn't have the -Wall flag
+            WARN="-Wall $WARN"
+         fi
+       else dnl $ICC = yes
+         dnl this is a set of options we believe *ALL* gcc versions support:
+         WARN="-W -Wall -Wwrite-strings -pedantic -Wpointer-arith -Wnested-externs -Winline -Wmissing-prototypes"
+
+         dnl -Wcast-align is a bit too annoying on all gcc versions ;-)
+
+         if test "$gccnum" -ge "207"; then
+           dnl gcc 2.7 or later
+           WARN="$WARN -Wmissing-declarations"
+         fi
+
+         if test "$gccnum" -gt "295"; then
+           dnl only if the compiler is newer than 2.95 since we got lots of
+           dnl "`_POSIX_C_SOURCE' is not defined" in system headers with
+           dnl gcc 2.95.4 on FreeBSD 4.9!
+           WARN="$WARN -Wundef -Wno-long-long -Wsign-compare"
+         fi
+
+         if test "$gccnum" -ge "296"; then
+           dnl gcc 2.96 or later
+           WARN="$WARN -Wfloat-equal"
+         fi
+
+         if test "$gccnum" -gt "296"; then
+           dnl this option does not exist in 2.96
+           WARN="$WARN -Wno-format-nonliteral"
+         fi
+
+         dnl -Wunreachable-code seems totally unreliable on my gcc 3.3.2 on
+         dnl on i686-Linux as it gives us heaps with false positives.
+         dnl Also, on gcc 4.0.X it is totally unbearable and complains all
+         dnl over making it unusable for generic purposes. Let's not use it.
+
+         if test "$gccnum" -ge "303"; then
+           dnl gcc 3.3 and later
+           WARN="$WARN -Wendif-labels -Wstrict-prototypes"
+         fi
+
+         if test "$gccnum" -ge "304"; then
+           # try these on gcc 3.4
+           WARN="$WARN -Wdeclaration-after-statement"
+         fi
+
+         for flag in $CPPFLAGS; do
+           case "$flag" in
+            -I*)
+              dnl Include path, provide a -isystem option for the same dir
+              dnl to prevent warnings in those dirs. The -isystem was not very
+              dnl reliable on earlier gcc versions.
+              add=`echo $flag | sed 's/^-I/-isystem /g'`
+              WARN="$WARN $add"
+              ;;
+           esac
+         done
+
+       fi dnl $ICC = no
+
+       CFLAGS="$CFLAGS $WARN"
+
+      AC_MSG_NOTICE([Added this set of compiler options: $WARN])
+
+    else dnl $GCC = yes
+
+      AC_MSG_NOTICE([Added no extra compiler options])
+
+    fi dnl $GCC = yes
+
+    dnl strip off optimizer flags
+    NEWFLAGS=""
+    for flag in $CFLAGS; do
+      case "$flag" in
+      -O*)
+        dnl echo "cut off $flag"
+        ;;
+      *)
+        NEWFLAGS="$NEWFLAGS $flag"
+        ;;
+      esac
+    done
+    CFLAGS=$NEWFLAGS
+
+]) dnl end of AC_DEFUN()
+
+dnl CURL_CHECK_NONBLOCKING_SOCKET
+dnl -------------------------------------------------
+dnl Check for how to set a socket to non-blocking state. There seems to exist
+dnl four known different ways, with the one used almost everywhere being POSIX
+dnl and XPG3, while the other different ways for different systems (old BSD,
+dnl Windows and Amiga).
+dnl
+dnl There are two known platforms (AIX 3.x and SunOS 4.1.x) where the
+dnl O_NONBLOCK define is found but does not work. This condition is attempted
+dnl to get caught in this script by using an excessive number of #ifdefs...
+dnl
+AC_DEFUN([CURL_CHECK_NONBLOCKING_SOCKET],
+[
+  AC_MSG_CHECKING([non-blocking sockets style])
+
+  AC_TRY_COMPILE([
+/* headers for O_NONBLOCK test */
+#include <sys/types.h>
+#include <unistd.h>
+#include <fcntl.h>
+],[
+/* try to compile O_NONBLOCK */
+
+#if defined(sun) || defined(__sun__) || defined(__SUNPRO_C) || defined(__SUNPRO_CC)
+# if defined(__SVR4) || defined(__srv4__)
+#  define PLATFORM_SOLARIS
+# else
+#  define PLATFORM_SUNOS4
+# endif
+#endif
+#if (defined(_AIX) || defined(__xlC__)) && !defined(_AIX41)
+# define PLATFORM_AIX_V3
+#endif
+
+#if defined(PLATFORM_SUNOS4) || defined(PLATFORM_AIX_V3) || defined(__BEOS__)
+#error "O_NONBLOCK does not work on this platform"
+#endif
+  int socket;
+  int flags = fcntl(socket, F_SETFL, flags | O_NONBLOCK);
+],[
+dnl the O_NONBLOCK test was fine
+nonblock="O_NONBLOCK"
+AC_DEFINE(HAVE_O_NONBLOCK, 1, [use O_NONBLOCK for non-blocking sockets])
+],[
+dnl the code was bad, try a different program now, test 2
+
+  AC_TRY_COMPILE([
+/* headers for FIONBIO test */
+#include <unistd.h>
+#include <stropts.h>
+],[
+/* FIONBIO source test (old-style unix) */
+ int socket;
+ int flags = ioctl(socket, FIONBIO, &flags);
+],[
+dnl FIONBIO test was good
+nonblock="FIONBIO"
+AC_DEFINE(HAVE_FIONBIO, 1, [use FIONBIO for non-blocking sockets])
+],[
+dnl FIONBIO test was also bad
+dnl the code was bad, try a different program now, test 3
+
+  AC_TRY_COMPILE([
+/* headers for ioctlsocket test (Windows) */
+#undef inline
+#ifdef HAVE_WINDOWS_H
+#ifndef WIN32_LEAN_AND_MEAN
+#define WIN32_LEAN_AND_MEAN
+#endif
+#include <windows.h>
+#ifdef HAVE_WINSOCK2_H
+#include <winsock2.h>
+#else
+#ifdef HAVE_WINSOCK_H
+#include <winsock.h>
+#endif
+#endif
+#endif
+],[
+/* ioctlsocket source code */
+ SOCKET sd;
+ unsigned long flags = 0;
+ sd = socket(0, 0, 0);
+ ioctlsocket(sd, FIONBIO, &flags);
+],[
+dnl ioctlsocket test was good
+nonblock="ioctlsocket"
+AC_DEFINE(HAVE_IOCTLSOCKET, 1, [use ioctlsocket() for non-blocking sockets])
+],[
+dnl ioctlsocket didnt compile!, go to test 4
+
+  AC_TRY_LINK([
+/* headers for IoctlSocket test (Amiga?) */
+#include <sys/ioctl.h>
+],[
+/* IoctlSocket source code */
+ int socket;
+ int flags = IoctlSocket(socket, FIONBIO, (long)1);
+],[
+dnl ioctlsocket test was good
+nonblock="IoctlSocket"
+AC_DEFINE(HAVE_IOCTLSOCKET_CASE, 1, [use Ioctlsocket() for non-blocking sockets])
+],[
+dnl Ioctlsocket didnt compile, do test 5!
+  AC_TRY_COMPILE([
+/* headers for SO_NONBLOCK test (BeOS) */
+#include <socket.h>
+],[
+/* SO_NONBLOCK source code */
+ long b = 1;
+ int socket;
+ int flags = setsockopt(socket, SOL_SOCKET, SO_NONBLOCK, &b, sizeof(b));
+],[
+dnl the SO_NONBLOCK test was good
+nonblock="SO_NONBLOCK"
+AC_DEFINE(HAVE_SO_NONBLOCK, 1, [use SO_NONBLOCK for non-blocking sockets])
+],[
+dnl test 5 didnt compile!
+nonblock="nada"
+AC_DEFINE(HAVE_DISABLED_NONBLOCKING, 1, [disabled non-blocking sockets])
+])
+dnl end of fifth test
+
+])
+dnl end of forth test
+
+])
+dnl end of third test
+
+])
+dnl end of second test
+
+])
+dnl end of non-blocking try-compile test
+  AC_MSG_RESULT($nonblock)
+
+  if test "$nonblock" = "nada"; then
+    AC_MSG_WARN([non-block sockets disabled])
+  fi
+])
+
+dnl CURL_CHECK_NEED_REENTRANT_SYSTEM
+dnl -------------------------------------------------
+dnl Checks if the preprocessor _REENTRANT definition
+dnl must be unconditionally done for this platform.
+dnl Internal macro for CURL_CONFIGURE_REENTRANT.
+
+AC_DEFUN([CURL_CHECK_NEED_REENTRANT_SYSTEM], [
+  case $host in
+    *-*-solaris* | *-*-hpux*)
+      tmp_need_reentrant="yes"
+      ;;
+    *)
+      tmp_need_reentrant="no"
+      ;;
+  esac
+])
+
+
+dnl CURL_CONFIGURE_FROM_NOW_ON_WITH_REENTRANT
+dnl -------------------------------------------------
+dnl This macro ensures that configuration tests done
+dnl after this will execute with preprocessor symbol
+dnl _REENTRANT defined. This macro also ensures that
+dnl the generated config file defines NEED_REENTRANT
+dnl and that in turn setup.h will define _REENTRANT.
+dnl Internal macro for CURL_CONFIGURE_REENTRANT.
+
+AC_DEFUN([CURL_CONFIGURE_FROM_NOW_ON_WITH_REENTRANT], [
+AC_DEFINE(NEED_REENTRANT, 1,
+  [Define to 1 if _REENTRANT preprocessor symbol must be defined.])
+cat >>confdefs.h <<_EOF
+#ifndef _REENTRANT
+#  define _REENTRANT
+#endif
+_EOF
+])
+
+
+dnl CURL_CONFIGURE_REENTRANT
+dnl -------------------------------------------------
+dnl This first checks if the preprocessor _REENTRANT
+dnl symbol is already defined. If it isn't currently
+dnl defined a set of checks are performed to verify
+dnl if its definition is required to make visible to
+dnl the compiler a set of *_r functions. Finally, if
+dnl _REENTRANT is already defined or needed it takes
+dnl care of making adjustments necessary to ensure
+dnl that it is defined equally for further configure
+dnl tests and generated config file.
+
+AC_DEFUN([CURL_CONFIGURE_REENTRANT], [
+  AC_PREREQ([2.50])dnl
+  #
+  AC_MSG_CHECKING([if _REENTRANT is already defined])
+  AC_COMPILE_IFELSE([
+    AC_LANG_PROGRAM([[
+    ]],[[
+#ifdef _REENTRANT
+      int dummy=1;
+#else
+      force compilation error
+#endif
+    ]])
+  ],[
+    AC_MSG_RESULT([yes])
+    tmp_reentrant_initially_defined="yes"
+  ],[
+    AC_MSG_RESULT([no])
+    tmp_reentrant_initially_defined="no"
+  ])
+  #
+  if test "$tmp_reentrant_initially_defined" = "no"; then
+    AC_MSG_CHECKING([if _REENTRANT is actually needed])
+    CURL_CHECK_NEED_REENTRANT_SYSTEM
+
+    if test "$tmp_need_reentrant" = "yes"; then
+      AC_MSG_RESULT([yes])
+    else
+      AC_MSG_RESULT([no])
+    fi
+  fi
+  #
+  AC_MSG_CHECKING([if _REENTRANT is onwards defined])
+  if test "$tmp_reentrant_initially_defined" = "yes" ||
+    test "$tmp_need_reentrant" = "yes"; then
+    CURL_CONFIGURE_FROM_NOW_ON_WITH_REENTRANT
+    AC_MSG_RESULT([yes])
+  else
+    AC_MSG_RESULT([no])
+  fi
+  #
+])
+

buildconf

@@ -0,0 +1,27 @@
+#!/bin/sh
+
+LIBTOOLIZE="libtoolize"
+
+if [ "x`which $LIBTOOLIZE`" == "x" ];
+then
+  LIBTOOLIZE="glibtoolize";
+fi
+
+if [ "x`which $LIBTOOLIZE`" == "x" ];
+then
+  echo "Neither libtoolize nor glibtoolize could be found!";
+  exit 1
+fi
+
+
+
+
+${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

config.rpath

@@ -0,0 +1,660 @@
+#! /bin/sh
+# Output a system dependent set of variables, describing how to set the
+# run time search path of shared libraries in an executable.
+#
+#   Copyright 1996-2006 Free Software Foundation, Inc.
+#   Taken from GNU libtool, 2001
+#   Originally by Gordon Matzigkeit <gord@gnu.ai.mit.edu>, 1996
+#
+#   This file is free software; the Free Software Foundation gives
+#   unlimited permission to copy and/or distribute it, with or without
+#   modifications, as long as this notice is preserved.
+#
+# The first argument passed to this file is the canonical host specification,
+#    CPU_TYPE-MANUFACTURER-OPERATING_SYSTEM
+# or
+#    CPU_TYPE-MANUFACTURER-KERNEL-OPERATING_SYSTEM
+# The environment variables CC, GCC, LDFLAGS, LD, with_gnu_ld
+# should be set by the caller.
+#
+# The set of defined variables is at the end of this script.
+
+# Known limitations:
+# - On IRIX 6.5 with CC="cc", the run time search patch must not be longer
+#   than 256 bytes, otherwise the compiler driver will dump core. The only
+#   known workaround is to choose shorter directory names for the build
+#   directory and/or the installation directory.
+
+# All known linkers require a `.a' archive for static linking (except MSVC,
+# which needs '.lib').
+libext=a
+shrext=.so
+
+host="$1"
+host_cpu=`echo "$host" | sed 's/^\([^-]*\)-\([^-]*\)-\(.*\)$/\1/'`
+host_vendor=`echo "$host" | sed 's/^\([^-]*\)-\([^-]*\)-\(.*\)$/\2/'`
+host_os=`echo "$host" | sed 's/^\([^-]*\)-\([^-]*\)-\(.*\)$/\3/'`
+
+# Code taken from libtool.m4's _LT_CC_BASENAME.
+
+for cc_temp in $CC""; do
+  case $cc_temp in
+    compile | *[\\/]compile | ccache | *[\\/]ccache ) ;;
+    distcc | *[\\/]distcc | purify | *[\\/]purify ) ;;
+    \-*) ;;
+    *) break;;
+  esac
+done
+cc_basename=`echo "$cc_temp" | sed -e 's%^.*/%%'`
+
+# Code taken from libtool.m4's AC_LIBTOOL_PROG_COMPILER_PIC.
+
+wl=
+if test "$GCC" = yes; then
+  wl='-Wl,'
+else
+  case "$host_os" in
+    aix*)
+      wl='-Wl,'
+      ;;
+    darwin*)
+      case $cc_basename in
+        xlc*)
+          wl='-Wl,'
+          ;;
+      esac
+      ;;
+    mingw* | pw32* | os2*)
+      ;;
+    hpux9* | hpux10* | hpux11*)
+      wl='-Wl,'
+      ;;
+    irix5* | irix6* | nonstopux*)
+      wl='-Wl,'
+      ;;
+    newsos6)
+      ;;
+    linux*)
+      case $cc_basename in
+        icc* | ecc*)
+          wl='-Wl,'
+          ;;
+        pgcc | pgf77 | pgf90)
+          wl='-Wl,'
+          ;;
+        ccc*)
+          wl='-Wl,'
+          ;;
+        como)
+          wl='-lopt='
+          ;;
+        *)
+          case `$CC -V 2>&1 | sed 5q` in
+            *Sun\ C*)
+              wl='-Wl,'
+              ;;
+          esac
+          ;;
+      esac
+      ;;
+    osf3* | osf4* | osf5*)
+      wl='-Wl,'
+      ;;
+    sco3.2v5*)
+      ;;
+    solaris*)
+      wl='-Wl,'
+      ;;
+    sunos4*)
+      wl='-Qoption ld '
+      ;;
+    sysv4 | sysv4.2uw2* | sysv4.3* | sysv5*)
+      wl='-Wl,'
+      ;;
+    sysv4*MP*)
+      ;;
+    unicos*)
+      wl='-Wl,'
+      ;;
+    uts4*)
+      ;;
+  esac
+fi
+
+# Code taken from libtool.m4's AC_LIBTOOL_PROG_LD_SHLIBS.
+
+hardcode_libdir_flag_spec=
+hardcode_libdir_separator=
+hardcode_direct=no
+hardcode_minus_L=no
+
+case "$host_os" in
+  cygwin* | mingw* | pw32*)
+    # FIXME: the MSVC++ port hasn't been tested in a loooong time
+    # When not using gcc, we currently assume that we are using
+    # Microsoft Visual C++.
+    if test "$GCC" != yes; then
+      with_gnu_ld=no
+    fi
+    ;;
+  interix*)
+    # we just hope/assume this is gcc and not c89 (= MSVC++)
+    with_gnu_ld=yes
+    ;;
+  openbsd*)
+    with_gnu_ld=no
+    ;;
+esac
+
+ld_shlibs=yes
+if test "$with_gnu_ld" = yes; then
+  # Set some defaults for GNU ld with shared library support. These
+  # are reset later if shared libraries are not supported. Putting them
+  # here allows them to be overridden if necessary.
+  # Unlike libtool, we use -rpath here, not --rpath, since the documented
+  # option of GNU ld is called -rpath, not --rpath.
+  hardcode_libdir_flag_spec='${wl}-rpath ${wl}$libdir'
+  case "$host_os" in
+    aix3* | aix4* | aix5*)
+      # On AIX/PPC, the GNU linker is very broken
+      if test "$host_cpu" != ia64; then
+        ld_shlibs=no
+      fi
+      ;;
+    amigaos*)
+      hardcode_libdir_flag_spec='-L$libdir'
+      hardcode_minus_L=yes
+      # Samuel A. Falvo II <kc5tja@dolphin.openprojects.net> reports
+      # that the semantics of dynamic libraries on AmigaOS, at least up
+      # to version 4, is to share data among multiple programs linked
+      # with the same dynamic library.  Since this doesn't match the
+      # behavior of shared libraries on other platforms, we cannot use
+      # them.
+      ld_shlibs=no
+      ;;
+    beos*)
+      if $LD --help 2>&1 | grep ': supported targets:.* elf' > /dev/null; then
+        :
+      else
+        ld_shlibs=no
+      fi
+      ;;
+    cygwin* | mingw* | pw32*)
+      # hardcode_libdir_flag_spec is actually meaningless, as there is
+      # no search path for DLLs.
+      hardcode_libdir_flag_spec='-L$libdir'
+      if $LD --help 2>&1 | grep 'auto-import' > /dev/null; then
+        :
+      else
+        ld_shlibs=no
+      fi
+      ;;
+    interix3*)
+      hardcode_direct=no
+      hardcode_libdir_flag_spec='${wl}-rpath,$libdir'
+      ;;
+    linux*)
+      if $LD --help 2>&1 | grep ': supported targets:.* elf' > /dev/null; then
+        :
+      else
+        ld_shlibs=no
+      fi
+      ;;
+    netbsd*)
+      ;;
+    solaris*)
+      if $LD -v 2>&1 | grep 'BFD 2\.8' > /dev/null; then
+        ld_shlibs=no
+      elif $LD --help 2>&1 | grep ': supported targets:.* elf' > /dev/null; then
+        :
+      else
+        ld_shlibs=no
+      fi
+      ;;
+    sysv5* | sco3.2v5* | sco5v6* | unixware* | OpenUNIX*)
+      case `$LD -v 2>&1` in
+        *\ [01].* | *\ 2.[0-9].* | *\ 2.1[0-5].*)
+          ld_shlibs=no
+          ;;
+        *)
+          if $LD --help 2>&1 | grep ': supported targets:.* elf' > /dev/null; then
+            hardcode_libdir_flag_spec='`test -z "$SCOABSPATH" && echo ${wl}-rpath,$libdir`'
+          else
+            ld_shlibs=no
+          fi
+          ;;
+      esac
+      ;;
+    sunos4*)
+      hardcode_direct=yes
+      ;;
+    *)
+      if $LD --help 2>&1 | grep ': supported targets:.* elf' > /dev/null; then
+        :
+      else
+        ld_shlibs=no
+      fi
+      ;;
+  esac
+  if test "$ld_shlibs" = no; then
+    hardcode_libdir_flag_spec=
+  fi
+else
+  case "$host_os" in
+    aix3*)
+      # Note: this linker hardcodes the directories in LIBPATH if there
+      # are no directories specified by -L.
+      hardcode_minus_L=yes
+      if test "$GCC" = yes; then
+        # Neither direct hardcoding nor static linking is supported with a
+        # broken collect2.
+        hardcode_direct=unsupported
+      fi
+      ;;
+    aix4* | aix5*)
+      if test "$host_cpu" = ia64; then
+        # On IA64, the linker does run time linking by default, so we don't
+        # have to do anything special.
+        aix_use_runtimelinking=no
+      else
+        aix_use_runtimelinking=no
+        # Test if we are trying to use run time linking or normal
+        # AIX style linking. If -brtl is somewhere in LDFLAGS, we
+        # need to do runtime linking.
+        case $host_os in aix4.[23]|aix4.[23].*|aix5*)
+          for ld_flag in $LDFLAGS; do
+            if (test $ld_flag = "-brtl" || test $ld_flag = "-Wl,-brtl"); then
+              aix_use_runtimelinking=yes
+              break
+            fi
+          done
+          ;;
+        esac
+      fi
+      hardcode_direct=yes
+      hardcode_libdir_separator=':'
+      if test "$GCC" = yes; then
+        case $host_os in aix4.[012]|aix4.[012].*)
+          collect2name=`${CC} -print-prog-name=collect2`
+          if test -f "$collect2name" && \
+            strings "$collect2name" | grep resolve_lib_name >/dev/null
+          then
+            # We have reworked collect2
+            hardcode_direct=yes
+          else
+            # We have old collect2
+            hardcode_direct=unsupported
+            hardcode_minus_L=yes
+            hardcode_libdir_flag_spec='-L$libdir'
+            hardcode_libdir_separator=
+          fi
+          ;;
+        esac
+      fi
+      # Begin _LT_AC_SYS_LIBPATH_AIX.
+      echo 'int main () { return 0; }' > conftest.c
+      ${CC} ${LDFLAGS} conftest.c -o conftest
+      aix_libpath=`dump -H conftest 2>/dev/null | sed -n -e '/Import File Strings/,/^$/ { /^0/ { s/^0  *\(.*\)$/\1/; p; }
+}'`
+      if test -z "$aix_libpath"; then
+        aix_libpath=`dump -HX64 conftest 2>/dev/null | sed -n -e '/Import File Strings/,/^$/ { /^0/ { s/^0  *\(.*\)$/\1/; p; }
+}'`
+      fi
+      if test -z "$aix_libpath"; then
+        aix_libpath="/usr/lib:/lib"
+      fi
+      rm -f conftest.c conftest
+      # End _LT_AC_SYS_LIBPATH_AIX.
+      if test "$aix_use_runtimelinking" = yes; then
+        hardcode_libdir_flag_spec='${wl}-blibpath:$libdir:'"$aix_libpath"
+      else
+        if test "$host_cpu" = ia64; then
+          hardcode_libdir_flag_spec='${wl}-R $libdir:/usr/lib:/lib'
+        else
+          hardcode_libdir_flag_spec='${wl}-blibpath:$libdir:'"$aix_libpath"
+        fi
+      fi
+      ;;
+    amigaos*)
+      hardcode_libdir_flag_spec='-L$libdir'
+      hardcode_minus_L=yes
+      # see comment about different semantics on the GNU ld section
+      ld_shlibs=no
+      ;;
+    bsdi[45]*)
+      ;;
+    cygwin* | mingw* | pw32*)
+      # When not using gcc, we currently assume that we are using
+      # Microsoft Visual C++.
+      # hardcode_libdir_flag_spec is actually meaningless, as there is
+      # no search path for DLLs.
+      hardcode_libdir_flag_spec=' '
+      libext=lib
+      ;;
+    darwin* | rhapsody*)
+      hardcode_direct=no
+      if test "$GCC" = yes ; then
+        :
+      else
+        case $cc_basename in
+          xlc*)
+            ;;
+          *)
+            ld_shlibs=no
+            ;;
+        esac
+      fi
+      ;;
+    dgux*)
+      hardcode_libdir_flag_spec='-L$libdir'
+      ;;
+    freebsd1*)
+      ld_shlibs=no
+      ;;
+    freebsd2.2*)
+      hardcode_libdir_flag_spec='-R$libdir'
+      hardcode_direct=yes
+      ;;
+    freebsd2*)
+      hardcode_direct=yes
+      hardcode_minus_L=yes
+      ;;
+    freebsd* | kfreebsd*-gnu | dragonfly*)
+      hardcode_libdir_flag_spec='-R$libdir'
+      hardcode_direct=yes
+      ;;
+    hpux9*)
+      hardcode_libdir_flag_spec='${wl}+b ${wl}$libdir'
+      hardcode_libdir_separator=:
+      hardcode_direct=yes
+      # hardcode_minus_L: Not really in the search PATH,
+      # but as the default location of the library.
+      hardcode_minus_L=yes
+      ;;
+    hpux10*)
+      if test "$with_gnu_ld" = no; then
+        hardcode_libdir_flag_spec='${wl}+b ${wl}$libdir'
+        hardcode_libdir_separator=:
+        hardcode_direct=yes
+        # hardcode_minus_L: Not really in the search PATH,
+        # but as the default location of the library.
+        hardcode_minus_L=yes
+      fi
+      ;;
+    hpux11*)
+      if test "$with_gnu_ld" = no; then
+        hardcode_libdir_flag_spec='${wl}+b ${wl}$libdir'
+        hardcode_libdir_separator=:
+        case $host_cpu in
+          hppa*64*|ia64*)
+            hardcode_direct=no
+            ;;
+          *)
+            hardcode_direct=yes
+            # hardcode_minus_L: Not really in the search PATH,
+            # but as the default location of the library.
+            hardcode_minus_L=yes
+            ;;
+        esac
+      fi
+      ;;
+    irix5* | irix6* | nonstopux*)
+      hardcode_libdir_flag_spec='${wl}-rpath ${wl}$libdir'
+      hardcode_libdir_separator=:
+      ;;
+    netbsd*)
+      hardcode_libdir_flag_spec='-R$libdir'
+      hardcode_direct=yes
+      ;;
+    newsos6)
+      hardcode_direct=yes
+      hardcode_libdir_flag_spec='${wl}-rpath ${wl}$libdir'
+      hardcode_libdir_separator=:
+      ;;
+    openbsd*)
+      hardcode_direct=yes
+      if test -z "`echo __ELF__ | $CC -E - | grep __ELF__`" || test "$host_os-$host_cpu" = "openbsd2.8-powerpc"; then
+        hardcode_libdir_flag_spec='${wl}-rpath,$libdir'
+      else
+        case "$host_os" in
+          openbsd[01].* | openbsd2.[0-7] | openbsd2.[0-7].*)
+            hardcode_libdir_flag_spec='-R$libdir'
+            ;;
+          *)
+            hardcode_libdir_flag_spec='${wl}-rpath,$libdir'
+            ;;
+        esac
+      fi
+      ;;
+    os2*)
+      hardcode_libdir_flag_spec='-L$libdir'
+      hardcode_minus_L=yes
+      ;;
+    osf3*)
+      hardcode_libdir_flag_spec='${wl}-rpath ${wl}$libdir'
+      hardcode_libdir_separator=:
+      ;;
+    osf4* | osf5*)
+      if test "$GCC" = yes; then
+        hardcode_libdir_flag_spec='${wl}-rpath ${wl}$libdir'
+      else
+        # Both cc and cxx compiler support -rpath directly
+        hardcode_libdir_flag_spec='-rpath $libdir'
+      fi
+      hardcode_libdir_separator=:
+      ;;
+    solaris*)
+      hardcode_libdir_flag_spec='-R$libdir'
+      ;;
+    sunos4*)
+      hardcode_libdir_flag_spec='-L$libdir'
+      hardcode_direct=yes
+      hardcode_minus_L=yes
+      ;;
+    sysv4)
+      case $host_vendor in
+        sni)
+          hardcode_direct=yes # is this really true???
+          ;;
+        siemens)
+          hardcode_direct=no
+          ;;
+        motorola)
+          hardcode_direct=no #Motorola manual says yes, but my tests say they lie
+          ;;
+      esac
+      ;;
+    sysv4.3*)
+      ;;
+    sysv4*MP*)
+      if test -d /usr/nec; then
+        ld_shlibs=yes
+      fi
+      ;;
+    sysv4*uw2* | sysv5OpenUNIX* | sysv5UnixWare7.[01].[10]* | unixware7*)
+      ;;
+    sysv5* | sco3.2v5* | sco5v6*)
+      hardcode_libdir_flag_spec='`test -z "$SCOABSPATH" && echo ${wl}-R,$libdir`'
+      hardcode_libdir_separator=':'
+      ;;
+    uts4*)
+      hardcode_libdir_flag_spec='-L$libdir'
+      ;;
+    *)
+      ld_shlibs=no
+      ;;
+  esac
+fi
+
+# Check dynamic linker characteristics
+# Code taken from libtool.m4's AC_LIBTOOL_SYS_DYNAMIC_LINKER.
+# Unlike libtool.m4, here we don't care about _all_ names of the library, but
+# only about the one the linker finds when passed -lNAME. This is the last
+# element of library_names_spec in libtool.m4, or possibly two of them if the
+# linker has special search rules.
+library_names_spec=      # the last element of library_names_spec in libtool.m4
+libname_spec='lib$name'
+case "$host_os" in
+  aix3*)
+    library_names_spec='$libname.a'
+    ;;
+  aix4* | aix5*)
+    library_names_spec='$libname$shrext'
+    ;;
+  amigaos*)
+    library_names_spec='$libname.a'
+    ;;
+  beos*)
+    library_names_spec='$libname$shrext'
+    ;;
+  bsdi[45]*)
+    library_names_spec='$libname$shrext'
+    ;;
+  cygwin* | mingw* | pw32*)
+    shrext=.dll
+    library_names_spec='$libname.dll.a $libname.lib'
+    ;;
+  darwin* | rhapsody*)
+    shrext=.dylib
+    library_names_spec='$libname$shrext'
+    ;;
+  dgux*)
+    library_names_spec='$libname$shrext'
+    ;;
+  freebsd1*)
+    ;;
+  kfreebsd*-gnu)
+    library_names_spec='$libname$shrext'
+    ;;
+  freebsd* | dragonfly*)
+    case "$host_os" in
+      freebsd[123]*)
+        library_names_spec='$libname$shrext$versuffix' ;;
+      *)
+        library_names_spec='$libname$shrext' ;;
+    esac
+    ;;
+  gnu*)
+    library_names_spec='$libname$shrext'
+    ;;
+  hpux9* | hpux10* | hpux11*)
+    case $host_cpu in
+      ia64*)
+        shrext=.so
+        ;;
+      hppa*64*)
+        shrext=.sl
+        ;;
+      *)
+        shrext=.sl
+        ;;
+    esac
+    library_names_spec='$libname$shrext'
+    ;;
+  interix3*)
+    library_names_spec='$libname$shrext'
+    ;;
+  irix5* | irix6* | nonstopux*)
+    library_names_spec='$libname$shrext'
+    case "$host_os" in
+      irix5* | nonstopux*)
+        libsuff= shlibsuff=
+        ;;
+      *)
+        case $LD in
+          *-32|*"-32 "|*-melf32bsmip|*"-melf32bsmip ") libsuff= shlibsuff= ;;
+          *-n32|*"-n32 "|*-melf32bmipn32|*"-melf32bmipn32 ") libsuff=32 shlibsuff=N32 ;;
+          *-64|*"-64 "|*-melf64bmip|*"-melf64bmip ") libsuff=64 shlibsuff=64 ;;
+          *) libsuff= shlibsuff= ;;
+        esac
+        ;;
+    esac
+    ;;
+  linux*oldld* | linux*aout* | linux*coff*)
+    ;;
+  linux*)
+    library_names_spec='$libname$shrext'
+    ;;
+  knetbsd*-gnu)
+    library_names_spec='$libname$shrext'
+    ;;
+  netbsd*)
+    library_names_spec='$libname$shrext'
+    ;;
+  newsos6)
+    library_names_spec='$libname$shrext'
+    ;;
+  nto-qnx*)
+    library_names_spec='$libname$shrext'
+    ;;
+  openbsd*)
+    library_names_spec='$libname$shrext$versuffix'
+    ;;
+  os2*)
+    libname_spec='$name'
+    shrext=.dll
+    library_names_spec='$libname.a'
+    ;;
+  osf3* | osf4* | osf5*)
+    library_names_spec='$libname$shrext'
+    ;;
+  solaris*)
+    library_names_spec='$libname$shrext'
+    ;;
+  sunos4*)
+    library_names_spec='$libname$shrext$versuffix'
+    ;;
+  sysv4 | sysv4.3*)
+    library_names_spec='$libname$shrext'
+    ;;
+  sysv4*MP*)
+    library_names_spec='$libname$shrext'
+    ;;
+  sysv5* | sco3.2v5* | sco5v6* | unixware* | OpenUNIX* | sysv4*uw2*)
+    library_names_spec='$libname$shrext'
+    ;;
+  uts4*)
+    library_names_spec='$libname$shrext'
+    ;;
+esac
+
+sed_quote_subst='s/\(["`$\\]\)/\\\1/g'
+escaped_wl=`echo "X$wl" | sed -e 's/^X//' -e "$sed_quote_subst"`
+shlibext=`echo "$shrext" | sed -e 's,^\.,,'`
+escaped_libname_spec=`echo "X$libname_spec" | sed -e 's/^X//' -e "$sed_quote_subst"`
+escaped_library_names_spec=`echo "X$library_names_spec" | sed -e 's/^X//' -e "$sed_quote_subst"`
+escaped_hardcode_libdir_flag_spec=`echo "X$hardcode_libdir_flag_spec" | sed -e 's/^X//' -e "$sed_quote_subst"`
+
+LC_ALL=C sed -e 's/^\([a-zA-Z0-9_]*\)=/acl_cv_\1=/' <<EOF
+
+# How to pass a linker flag through the compiler.
+wl="$escaped_wl"
+
+# Static library suffix (normally "a").
+libext="$libext"
+
+# Shared library suffix (normally "so").
+shlibext="$shlibext"
+
+# Format of library name prefix.
+libname_spec="$escaped_libname_spec"
+
+# Library names that the linker finds when passed -lNAME.
+library_names_spec="$escaped_library_names_spec"
+
+# Flag to hardcode \$libdir into a binary during linking.
+# This must work even if \$libdir does not exist.
+hardcode_libdir_flag_spec="$escaped_hardcode_libdir_flag_spec"
+
+# Whether we need a single -rpath flag with a separated argument.
+hardcode_libdir_separator="$hardcode_libdir_separator"
+
+# Set to yes if using DIR/libNAME.so during linking hardcodes DIR into the
+# resulting binary.
+hardcode_direct="$hardcode_direct"
+
+# Set to yes if using the -LDIR flag during linking hardcodes DIR into the
+# resulting binary.
+hardcode_minus_L="$hardcode_minus_L"
+
+EOF

configure.ac

@@ -0,0 +1,219 @@
+# AC_PREREQ(2.57)
+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.
+# Daniel's note: this should not be necessary and we need to work to
+# 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"
+    ;;
+	*darwin*)
+	CFLAGS="$CFLAGS -DLIBSSH2_DARWIN"
+	;;
+    *hpux*)
+    ;;
+    *)
+    ;;
+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"
+)
+
+dnl Our configure and build reentrant settings
+CURL_CONFIGURE_REENTRANT
+
+# Some systems (Solaris?) have socket() in -lsocket.
+AC_SEARCH_LIBS(socket, socket)
+
+# Solaris has inet_addr() in -lnsl.
+AC_SEARCH_LIBS(inet_addr, nsl)
+
+AC_SUBST(LIBS)
+
+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
+
+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
+if test "$ac_cv_libssl" != "yes" && test "$use_libgcrypt" != "no"; then
+  AC_LIB_HAVE_LINKFLAGS([gcrypt], [], [#include <gcrypt.h>])
+fi
+
+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 "$ac_cv_libgcrypt" = "yes")
+
+# 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
+fi
+
+#
+# Optional Settings
+#
+AC_ARG_ENABLE(crypt-none,
+  AC_HELP_STRING([--enable-crypt-none],[Permit "none" cipher -- NOT RECOMMENDED]),
+  [AC_DEFINE(LIBSSH2_CRYPT_NONE, 1, [Enable "none" cipher -- NOT RECOMMENDED])])
+
+AC_ARG_ENABLE(mac-none,
+  AC_HELP_STRING([--enable-mac-none],[Permit "none" MAC -- NOT RECOMMENDED]),
+  [AC_DEFINE(LIBSSH2_MAC_NONE, 1, [Enable "none" MAC -- NOT RECOMMENDED])])
+
+AC_ARG_ENABLE(gex-new,
+  AC_HELP_STRING([--disable-gex-new],[Disable "new" diffie-hellman-group-exchange-sha1 method]),
+  [GEX_NEW=$enableval])
+if test "$GEX_NEW" != "no"; then
+  AC_DEFINE(LIBSSH2_DH_GEX_NEW, 1, [Enable newer diffie-hellman-group-exchange-sha1 syntax])
+fi
+
+dnl ************************************************************
+dnl option to switch on compiler debug options
+dnl
+AC_MSG_CHECKING([whether to enable pedantic and debug compiler options])
+AC_ARG_ENABLE(debug,
+AC_HELP_STRING([--enable-debug],[Enable pedantic and debug options])
+AC_HELP_STRING([--disable-debug],[Disable debug options]),
+[ case "$enableval" in
+  no)
+       AC_MSG_RESULT(no)
+       ;;
+  *)   AC_MSG_RESULT(yes)
+
+    CPPFLAGS="$CPPFLAGS -DLIBSSH2DEBUG"
+    CFLAGS="$CFLAGS -g"
+
+    dnl set compiler "debug" options to become more picky, and remove
+    dnl optimize options from CFLAGS
+    CURL_CC_DEBUG_OPTS
+       ;;
+  esac
+ ],
+       AC_MSG_RESULT(no)
+)
+
+# Checks for header files.
+# AC_HEADER_STDC
+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])
+
+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
+AC_C_INLINE
+
+CURL_CHECK_NONBLOCKING_SOCKET
+
+AC_CONFIG_FILES([Makefile
+                 src/Makefile
+                 tests/Makefile
+                 example/Makefile
+                 example/simple/Makefile
+                 docs/Makefile
+                 libssh2.pc])
+AC_OUTPUT

configure.in

@@ -1,224 +0,0 @@
-# AC_PREREQ(2.57)
-AC_INIT(libssh2,0.12,sarag@libssh2.org)
-AC_CONFIG_SRCDIR([src])
-AC_CONFIG_HEADER([include/libssh2_config.h])
-
-# Check for the OS.
-AC_CANONICAL_HOST
-case "$host" in
-	*-cygwin)
-	SHLIB_SUFFIX_NAME="dll"
-	SHLIB_LDFLAGS="-shared"
-	CFLAGS="$CFLAGS -DLIBSSH2_WIN32"
-    ;;
-	*darwin*)
-	SHLIB_SUFFIX_NAME="dylib"
-	SHLIB_LDFLAGS="-dynamiclib -flat_namespace"
-	CFLAGS="$CFLAGS -DLIBSSH2_DARWIN"
-	;;
-    *)
-    SHLIB_SUFFIX_NAME="so"
-    SHLIB_LDFLAGS="-shared"
-    ;;
-esac
-
-AC_CHECK_LIB(socket, socket, [
-SHLIB_LDFLAGS="$SHLIB_LDFLAGS -lsocket"
-LIBS="$LIBS -lsocket"
-])
-AC_CHECK_LIB(m, ceil, [ SHLIB_LDFLAGS="$SHLIB_LDFLAGS -lm" ])
-
-
-AC_SUBST(SHLIB_SUFFIX_NAME)
-AC_SUBST(SHLIB_LDFLAGS)
-AC_SUBST(LIBS)
-
-AC_PROG_CC
-AC_PROG_INSTALL
-AC_PROG_LN_S
-AC_PROG_MAKE_SET
-AC_PROG_RANLIB
-AC_C_BIGENDIAN
-if test -z "$PKG_CONFIG"; then
-  AC_PATH_PROG(PKG_CONFIG, pkg-config, no)
-fi
-
-#
-# 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 "$LIBSSH2_OPENSSL_DIR" = "no" || test "$LIBSSH2_OPENSSL_DIR" = "yes"; then
-  unset LIBSSH2_OPENSSL_DIR
-fi
-
-found_openssl=no
-unset OPENSSL_INCDIR
-unset OPENSSL_LIBDIR
-
-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_LIBDIR=$LIBSSH2_OPENSSL_DIR/lib
-  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
-  OPENSSL_LIBDIR=`$PKG_CONFIG --libs openssl`
-  OPENSSL_INCDIR=`$PKG_CONFIG --variable=includedir 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_INCDIR=$i/include
-    fi
-    if test -r $i/include/openssl/hmac.h; then
-      OPENSSL_INCDIR=$i/include
-    fi
-    if test -r $i/lib/libcrypto.a -o -r $i/lib/libcrypto.$SHLIB_SUFFIX_NAME; then
-      OPENSSL_LIBDIR=$i/lib
-    fi
-    test -n "$OPENSSL_INCDIR" && test -n "$OPENSSL_LIBDIR" && break
-  done
-
-  if test -z "$OPENSSL_INCDIR"; then
-    AC_MSG_ERROR([Cannot find OpenSSL's <evp.h> or <hmac.h>])
-  fi
-
-  if test -z "$OPENSSL_LIBDIR"; then
-    AC_MSG_ERROR([Cannot find OpenSSL's libcrypto])
-  fi
-
-  AC_MSG_RESULT([$OPENSSL_INCDIR $OPENSSL_LIBDIR])
-fi
-
-#
-# Confirm required OpenSSL libs
-#
-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
-
-CFLAGS="$CFLAGS -I$OPENSSL_INCDIR"
-LDFLAGS="$LDFLAGS -L$OPENSSL_LIBDIR -lcrypto"
-
-#
-# 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
-
-#
-# Optional Settings
-#
-AC_ARG_ENABLE(crypt-none,
-  AC_HELP_STRING([--enable-crypt-none],[Permit "none" cipher -- NOT RECOMMENDED]),
-  [AC_DEFINE(LIBSSH2_CRYPT_NONE, 1, [Enable "none" cipher -- NOT RECOMMENDED])])
-
-AC_ARG_ENABLE(mac-none,
-  AC_HELP_STRING([--enable-mac-none],[Permit "none" MAC -- NOT RECOMMENDED]),
-  [AC_DEFINE(LIBSSH2_MAC_NONE, 1, [Enable "none" MAC -- NOT RECOMMENDED])])
-
-AC_ARG_ENABLE(gex-new,
-  AC_HELP_STRING([--disable-gex-new],[Disable "new" diffie-hellman-group-exchange-sha1 method]),
-  [GEX_NEW=$enableval])
-if test "$GEX_NEW" != "no"; then
-  AC_DEFINE(LIBSSH2_DH_GEX_NEW, 1, [Enable newer diffie-hellman-group-exchange-sha1 syntax])
-fi
-
-#
-# Optional debugging -- Meant for developer maintenance only
-# When enabled, the relevant debugging information will be written on stderr
-#
-AC_ARG_ENABLE(debug-transport,
-	AC_HELP_STRING([--enable-debug-transport],[Output transport layer debugging info to stderr]),
-	[AC_DEFINE(LIBSSH2_DEBUG_TRANSPORT, 1, [Output transport layer debugging info to stderr])])
-AC_ARG_ENABLE(debug-kex,
-	AC_HELP_STRING([--enable-debug-kex],[Output Key Exchange debugging info to stderr]),
-	[AC_DEFINE(LIBSSH2_DEBUG_KEX, 1, [Output Key Exchange debugging info to stderr])])
-AC_ARG_ENABLE(debug-userauth,
-	AC_HELP_STRING([--enable-debug-userauth],[Output userauth debugging info to stderr]),
-	[AC_DEFINE(LIBSSH2_DEBUG_USERAUTH, 1, [Output userauth layer debugging info to stderr])])
-AC_ARG_ENABLE(debug-channel,
-	AC_HELP_STRING([--enable-debug-connection],[Output connection layer debugging info to stderr]),
-	[AC_DEFINE(LIBSSH2_DEBUG_CONNECTION, 1, [Output connection layer debugging info to stderr])])
-AC_ARG_ENABLE(debug-scp,
-	AC_HELP_STRING([--enable-debug-scp],[Output scp subsystem debugging info to stderr]),
-	[AC_DEFINE(LIBSSH2_DEBUG_SCP, 1, [Output scp subsystem debugging info to stderr])])
-AC_ARG_ENABLE(debug-sftp,
-	AC_HELP_STRING([--enable-debug-sftp],[Output sftp subsystem debugging info to stderr]),
-	[AC_DEFINE(LIBSSH2_DEBUG_SFTP, 1, [Output sftp subsystem debugging info to stderr])])
-AC_ARG_ENABLE(debug-publickey,
-	AC_HELP_STRING([--enable-debug-publickey],[Output publickey subsystem debugging info to stderr]),
-	[AC_DEFINE(LIBSSH2_DEBUG_PUBLICKEY, 1, [Output publickey subsystem debugging info to stderr])])
-AC_ARG_ENABLE(debug-errors,
-	AC_HELP_STRING([--enable-debug-errors],[Output failure events to stderr]),
-	[AC_DEFINE(LIBSSH2_DEBUG_ERRORS, 1, [Output failure events to stderr])])
-AC_ARG_ENABLE(debug-all,
-	AC_HELP_STRING([--enable-debug-all],[Output debugging info for all layers to stderr]),
-	[
-		AC_DEFINE(LIBSSH2_DEBUG_TRANSPORT, 1, [Output transport layer debugging info to stderr])
-		AC_DEFINE(LIBSSH2_DEBUG_KEX, 1, [Output Key Exchange debugging info to stderr])
-		AC_DEFINE(LIBSSH2_DEBUG_USERAUTH, 1, [Output userauth layer debugging info to stderr])
-		AC_DEFINE(LIBSSH2_DEBUG_CONNECTION, 1, [Output connection layer debugging info to stderr])
-		AC_DEFINE(LIBSSH2_DEBUG_SCP, 1, [Output scp subsystem debugging info to stderr])
-		AC_DEFINE(LIBSSH2_DEBUG_SFTP, 1, [Output sftp subsystem debugging info to stderr])
-		AC_DEFINE(LIBSSH2_DEBUG_PUBLICKEY, 1, [Output publickey subsystem debugging info to stderr])
-		AC_DEFINE(LIBSSH2_DEBUG_ERRORS, 1, [Output failure events to stderr])
-	])
-
-
-# Checks for header files.
-# AC_HEADER_STDC
-AC_CHECK_HEADERS([errno.h fcntl.h stdio.h stdlib.h unistd.h sys/uio.h sys/select.h])
-AC_CHECK_FUNCS(poll gettimeofday select)
-
-# Checks for typedefs, structures, and compiler characteristics.
-AC_C_CONST
-
-AC_CONFIG_FILES([Makefile
-                 src/Makefile])
-AC_OUTPUT

docs/.gitignore

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

docs/Makefile.am

@@ -0,0 +1,98 @@
+# $Id: Makefile.am,v 1.37 2009/03/26 15:41:15 bagder Exp $
+
+EXTRA_DIST = template.3
+
+dist_man_MANS = \
+	libssh2_banner_set.3 \
+	libssh2_base64_decode.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_request_pty_size_ex.3 \
+	libssh2_channel_send_eof.3 \
+	libssh2_channel_set_blocking.3 \
+	libssh2_channel_setenv_ex.3 \
+	libssh2_channel_wait_closed.3 \
+	libssh2_channel_wait_eof.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_free_host_entry.3 \
+	libssh2_host_entry_match.3 \
+	libssh2_hostkey_hash.3 \
+	libssh2_knownhost_add.3 \
+	libssh2_knownhost_check.3 \
+	libssh2_knownhost_del.3 \
+	libssh2_knownhost_get.3 \
+	libssh2_knownhost_init.3 \
+	libssh2_knownhost_readfile.3 \
+	libssh2_knownhost_readline.3 \
+	libssh2_knownhost_writefile.3 \
+	libssh2_knownhost_writeline.3 \
+	libssh2_new_host_entry.3 \
+	libssh2_poll.3 \
+	libssh2_poll_channel_read.3 \
+	libssh2_publickey_add_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_scp_recv.3 \
+	libssh2_scp_send_ex.3 \
+	libssh2_session_abstract.3 \
+	libssh2_session_block_directions.3 \
+	libssh2_session_callback_set.3 \
+	libssh2_session_disconnect_ex.3 \
+	libssh2_session_flag.3 \
+	libssh2_session_free.3 \
+	libssh2_session_get_blocking.3 \
+	libssh2_session_hostkey.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_sftp_close_handle.3 \
+	libssh2_sftp_fstat_ex.3 \
+	libssh2_sftp_init.3 \
+	libssh2_sftp_last_error.3 \
+	libssh2_sftp_mkdir_ex.3 \
+	libssh2_sftp_open_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_trace.3 \
+	libssh2_userauth_authenticated.3 \
+	libssh2_userauth_hostbased_fromfile_ex.3 \
+	libssh2_userauth_keyboard_interactive_ex.3 \
+	libssh2_userauth_list.3 \
+	libssh2_userauth_password_ex.3 \
+	libssh2_userauth_publickey_fromfile_ex.3 \
+	libssh2_version.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

@@ -0,0 +1,21 @@
+.\" $Id: libssh2_channel_forward_accept.3,v 1.6 2009/03/16 23:25:14 bagder Exp $
+.\"
+.TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_channel_forward_accept - accept a queued connection
+.SH SYNOPSIS
+#include <libssh2.h>
+
+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_ex(3)\fP.
+.SH RETURN VALUE
+A newly allocated channel instance or NULL on failure.
+.SH ERRORS
+\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call 
+would block.
+.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

@@ -0,0 +1,48 @@
+.\" $Id: libssh2_channel_forward_listen_ex.3,v 1.7 2007/06/13 16:41:33 jehousley Exp $
+.\"
+.TH libssh2_channel_forward_listen_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_channel_forward_listen_ex - listen to inbound connections
+.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(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
+\fIlibssh2_channel_forward_accept(3)\fP.
+
+\fIsession\fP - instance as returned by libssh2_session_init(). 
+
+\fIhost\fP - specific address to bind to on the remote host. Binding to
+0.0.0.0 (default when NULL is passed) will bind to all available addresses.
+
+\fIport\fP - port to bind to on the remote host. When 0 is passed, the remote
+host will select the first available dynamic port.
+
+\fIbound_port\fP - Populated with the actual port bound on the remote
+host. Useful when requesting dynamic port numbers.
+
+\fIqueue_maxsize\fP - Maximum number of pending connections to queue before
+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 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

@@ -0,0 +1,47 @@
+.\" $Id: libssh2_channel_read_ex.3,v 1.10 2007/06/13 16:41:33 jehousley Exp $
+.\"
+.TH libssh2_channel_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_channel_read_ex - read data from a channel stream
+.SH SYNOPSIS
+#include <libssh2.h>
+
+ssize_t
+libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id, 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);
+
+.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
+LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
+LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
+
+Note that a return value of zero (0) can in fact be a legitimate value and
+only signals that no payload data was read. It is not an error.
+.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_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

@@ -0,0 +1,25 @@
+.\" $Id: libssh2_channel_set_blocking.3,v 1.6 2009/03/26 15:41:16 bagder Exp $
+.\"
+.TH libssh2_channel_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_channel_set_blocking - set or clear blocking mode on channel
+.SH SYNOPSIS
+#include <libssh2.h>
+
+void 
+libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking);
+.SH DESCRIPTION
+\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
+.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

@@ -0,0 +1,48 @@
+.\" $Id: libssh2_channel_write_ex.3,v 1.6 2009/03/16 23:25:14 bagder Exp $
+.\"
+.TH libssh2_channel_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_channel_write_ex - write data to a channel stream blocking
+.SH SYNOPSIS
+#include <libssh2.h>
+
+ssize_t
+libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel, int stream_id, char *buf, size_t buflen);
+
+ssize_t
+libssh2_channel_write(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
+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 write to. 
+
+\fIstream_id\fP - substream ID number (e.g. 0 or SSH_EXTENDED_DATA_STDERR) 
+
+\fIbuf\fP - pointer to buffer to write
+
+\fIbuflen\fP - size of the data to write
+
+\fIlibssh2_channel_write(3)\fP and \fIlibssh2_channel_write_stderr(3)\fP are
+macros.
+.SH RETURN VALUE
+Actual number of bytes written or negative on failure.
+LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
+LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
+.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_knownhost_add.3

@@ -0,0 +1,58 @@
+
+.\" Copyright (c) 2009 by Daniel Stenberg
+.\"
+.TH libssh2_knownhost_add 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
+.SH NAME
+libssh2_knownhost_add - add a known host
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int libssh2_knownhost_add(LIBSSH2_KNOWNHOSTS *hosts,
+                          char *host, char *salt,
+                          char *key, size_t keylen,
+                          int typemask,
+                          struct libssh2_knownhost **store);
+.SH DESCRIPTION
+Adds a known host to the collection of known hosts identified by the 'hosts'
+handle.
+
+\fIhost\fP is a pointer the host name in plain text or hashed. If hashed, it
+must be provided base64 encoded. The host name can be the IP numerical address
+of the host or the full name.
+
+\fIsalt\P is a pointer to the salt used for the host hashing, if the host is
+provided hashed. If the host is provided in plain text, salt has no meaning.
+The salt has to be provided base64 encoded with a trailing zero byte.
+
+\fIkey\fP is a pointer to the key for the given host.
+
+\fIkeylen\fP is the total size in bytes of the key pointed to by the \fIkey\fP
+argument
+
+\fItypemask\fP is a bitmask that specifies format and info about the data
+passed to this function. Specificly, it details what format the host name is,
+what format the key is and what key type it is.
+
+The host name is given as one of the following types:
+LIBSSH2_KNOWNHOST_TYPE_PLAIN, LIBSSH2_KNOWNHOST_TYPE_SHA1 or
+LIBSSH2_KNOWNHOST_TYPE_CUSTOM.
+
+The key is encoded using one of the following encodings:
+LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64.
+
+The key is using one of these algorithms:
+LIBSSH2_KNOWNHOST_KEY_RSA1, LIBSSH2_KNOWNHOST_KEY_SSHRSA or
+LIBSSH2_KNOWNHOST_KEY_SSHDSS.
+
+\fIstore\fP should point to a pointer that gets filled in to point to the
+known host data after the addition. NULL can be passed if you don't care about
+this pointer.
+.SH RETURN VALUE
+Returns a regular libssh2 error code, where negative values are error codes
+and 0 indicates success.
+.SH AVAILABILITY
+Added in libssh2 1.2
+.SH SEE ALSO
+.BR libssh2_knownhost_init(3)
+.BR libssh2_knownhost_free(3)
+.BR libssh2_knownhost_check(3)

docs/libssh2_knownhost_check.3

@@ -0,0 +1,57 @@
+.\"
+.\" Copyright (c) 2009 by Daniel Stenberg
+.\"
+.TH libssh2_knownhost_check 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
+.SH NAME
+libssh2_knownhost_check - check a host+key against the list of known hosts
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int libssh2_knownhost_check(LIBSSH2_KNOWNHOSTS *hosts,
+                            char *host, char *key, size_t keylen,
+                            int typemask,
+                            struct libssh2_knownhost **knownhost);
+.SH DESCRIPTION
+Checks a host and its associated key against the collection of known hosts,
+and returns info back about the (partially) matched entry.
+
+\fIhost\fP is a pointer the host name in plain text. The host name can be the
+IP numerical address of the host or the full name.
+
+\fIkey\fP is a pointer to the key for the given host.
+
+\fIkeylen\fP is the total size in bytes of the key pointed to by the \fIkey\fP
+argument
+
+\fItypemask\fP is a bitmask that specifies format and info about the data
+passed to this function. Specificly, it details what format the host name is,
+what format the key is and what key type it is.
+
+The host name is given as one of the following types:
+LIBSSH2_KNOWNHOST_TYPE_PLAIN or LIBSSH2_KNOWNHOST_TYPE_CUSTOM.
+
+The key is encoded using one of the following encodings:
+LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64.
+
+\fIknownhost\fP if set to non-NULL, it must be a pointer to a 'struct
+libssh2_knownhost' pointer that gets filled in to point to info about a known
+host that matches or partially matches.
+.SH RETURN VALUE
+\fIlibssh2_knownhost_check(3)\fP returns info about how well the provided
+host + key pair matched one of the entries in the list of known hosts.
+
+LIBSSH2_KNOWNHOST_CHECK_FAILURE - something prevented the check to be made
+
+LIBSSH2_KNOWNHOST_CHECK_NOTFOUND - no host match was found
+
+LIBSSH2_KNOWNHOST_CHECK_MATCH - hosts and keys match.
+
+LIBSSH2_KNOWNHOST_CHECK_MISMATCH - host was found, but the keys didn't match!
+.SH AVAILABILITY
+Added in libssh2 1.2
+.SH EXAMPLE
+See the ssh2_exec.c example as provided in the tarball.
+.SH SEE ALSO
+.BR libssh2_knownhost_init(3)
+.BR libssh2_knownhost_free(3)
+.BR libssh2_knownhost_add(3)

docs/libssh2_knownhost_del.3

@@ -0,0 +1,26 @@
+.\"
+.\" Copyright (c) 2009 by Daniel Stenberg
+.\"
+.TH libssh2_knownhost_del 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
+.SH NAME
+libssh2_knownhost_del - delete a known host entry
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int libssh2_knownhost_del(LIBSSH2_KNOWNHOSTS *hosts,
+                          struct libssh2_knownhost *entry);
+.SH DESCRIPTION
+Delete a known host entry from the collection of known hosts.
+
+\fIentry\fP is a pointer to a struct that you can extract with
+\fIlibssh2_knownhost_check(3)\fP or \fIlibssh2_knownhost_get(3)\fP.
+.SH RETURN VALUE
+Returns a regular libssh2 error code, where negative values are error codes
+and 0 indicates success.
+.SH AVAILABILITY
+Added in libssh2 1.2
+.SH SEE ALSO
+.BR libssh2_knownhost_init(3)
+.BR libssh2_knownhost_free(3)
+.BR libssh2_knownhost_add(3)
+.BR libssh2_knownhost_check(3)

docs/libssh2_knownhost_get.3

@@ -0,0 +1,35 @@
+.\"
+.\" Copyright (c) 2009 by Daniel Stenberg
+.\"
+.TH libssh2_knownhost_get 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
+.SH NAME
+libssh2_knownhost_get - get a known host off the collection of known hosts
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int libssh2_knownhost_get(LIBSSH2_KNOWNHOSTS *hosts,
+                          struct libssh2_knownhost **store,
+                          struct libssh2_knownhost *prev):
+.SH DESCRIPTION
+\fIlibssh2_knownhost_get(3)\fP allows an application to iterate over all known
+hosts in the collection.
+
+\fIstore\fP should point to a pointer that gets filled in to point to the
+known host data.
+
+\fIprev\fP is a pointer to a previous 'struct libssh2_knownhost' as returned
+by a previous invoke of this function, or NULL to get the first entry in the
+internal collection.
+.SH RETURN VALUE
+Returns 0 if everything is fine and information about a host was stored in
+the \fIstore\fP struct.
+
+Returns 1 if it reached the end of hosts.
+
+Returns negative values for error
+.SH AVAILABILITY
+Added in libssh2 1.2
+.SH SEE ALSO
+.BR libssh2_knownhost_readfile(3)
+.BR libssh2_knownhost_writefile(3)
+.BR libssh2_knownhost_add(3)

docs/libssh2_knownhost_init.3

@@ -0,0 +1,22 @@
+.\"
+.\" Copyright (c) 2009 by Daniel Stenberg
+.\"
+.TH libssh2_knownhost_init 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
+.SH NAME
+libssh2_knownhost_init - init a collection of known hosts
+.SH SYNOPSIS
+#include <libssh2.h>
+
+LIBSSH2_KNOWNHOSTS *libssh2_knownhost_init(LIBSSH2_SESSION *session);
+.SH DESCRIPTION
+Init a collection of known hosts for this session. Returns the handle to an
+internal representation of a known host collection.
+.SH RETURN VALUE
+Returns a handle pointer or NULL if something went wrong. The returned handle
+is used as input to all other known host related functions libssh2 provides.
+.SH AVAILABILITY
+Added in libssh2 1.2
+.SH SEE ALSO
+.BR libssh2_knownhost_free(3)
+.BR libssh2_knownhost_add(3)
+.BR libssh2_knownhost_check(3)

docs/libssh2_knownhost_readfile.3

@@ -0,0 +1,29 @@
+.\"
+.\" Copyright (c) 2009 by Daniel Stenberg
+.\"
+.TH libssh2_knownhost_readfile 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
+.SH NAME
+libssh2_knownhost_readfile - parse a file of known hosts
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int libssh2_knownhost_readfile(LIBSSH2_KNOWNHOSTS *hosts,
+                               const char *filename, int type);
+.SH DESCRIPTION
+Reads a collection of known hosts from a specified file and adds them to the
+collection of known hosts.
+
+\fIfilename\fP specifies which file to read
+
+\fItype\fP specifies what file type it is, and
+\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported
+format. This file is normally found named ~/.ssh/known_hosts
+.SH RETURN VALUE
+Returns a regular libssh2 error code, where negative values are error codes
+and 0 indicates success.
+.SH AVAILABILITY
+Added in libssh2 1.2
+.SH SEE ALSO
+.BR libssh2_knownhost_init(3)
+.BR libssh2_knownhost_free(3)
+.BR libssh2_knownhost_check(3)

docs/libssh2_knownhost_readline.3

@@ -0,0 +1,30 @@
+.\"
+.\" Copyright (c) 2009 by Daniel Stenberg
+.\"
+.TH libssh2_knownhost_readline 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
+.SH NAME
+libssh2_knownhost_readline - read a known host line
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int libssh2_knownhost_readline(LIBSSH2_KNOWNHOSTS *hosts,
+                               const char *line, size_t len, int type):
+.SH DESCRIPTION
+Tell libssh2 to read a buffer as it if is a line from a known hosts file.
+
+\fIline\fP points to the start of the line
+
+\fIlen\fP is the length of the line in bytes
+
+\fItype\fP specifies what file type it is, and
+\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported
+format. This file is normally found named ~/.ssh/known_hosts
+.SH RETURN VALUE
+Returns a regular libssh2 error code, where negative values are error codes
+and 0 indicates success.
+.SH AVAILABILITY
+Added in libssh2 1.2
+.SH SEE ALSO
+.BR libssh2_knownhost_get(3)
+.BR libssh2_knownhost_writeline(3)
+.BR libssh2_knownhost_readfile(3)

docs/libssh2_knownhost_writefile.3

@@ -0,0 +1,29 @@
+.\"
+.\" Copyright (c) 2009 by Daniel Stenberg
+.\"
+.TH libssh2_knownhost_writefile 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
+.SH NAME
+libssh2_knownhost_writefile - write a collection of known hosts to a file
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int libssh2_knownhost_writefile(LIBSSH2_KNOWNHOSTS *hosts,
+                                const char *filename, int type);
+.SH DESCRIPTION
+Writes all the known hosts to the specified file using the specified file
+format.
+
+\fIfilename\fP specifies what filename to create
+
+\fItype\fP specifies what file type it is, and
+\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported
+format.
+.SH RETURN VALUE
+Returns a regular libssh2 error code, where negative values are error codes
+and 0 indicates success.
+.SH AVAILABILITY
+Added in libssh2 1.2
+.SH SEE ALSO
+.BR libssh2_knownhost_readfile(3)
+.BR libssh2_knownhost_add(3)
+

docs/libssh2_knownhost_writeline.3

@@ -0,0 +1,46 @@
+.\"
+.\" Copyright (c) 2009 by Daniel Stenberg
+.\"
+.TH libssh2_knownhost_writeline 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
+.SH NAME
+libssh2_knownhost_writeline - convert a known host to a line for storage
+.SH SYNOPSIS
+#include <libssh2.h>
+
+libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts,
+                            struct libssh2_knownhost *known,
+                            char *buffer, size_t buflen,
+                            size_t *outlen,
+                            int type);
+.SH DESCRIPTION
+Converts a single known host to a single line of output for storage, using
+the 'type' output format.
+
+\fIknown\fP identifies which particular known host
+
+\fIbuffer\fP points to an allocated buffer
+
+\fIbuflen\fP is the size of the \fIbuffer\fP. See RETURN VALUE about the size.
+
+\fIoutlen\fP must be a pointer to a size_t variable that will get the output
+length of the stored data chunk. The number does not included the trailing
+zero!
+
+\fItype\fP specifies what file type it is, and
+\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported
+format.
+.SH RETURN VALUE
+Returns a regular libssh2 error code, where negative values are error codes
+and 0 indicates success.
+
+If the provided buffer is deemed too small to fit the data libssh2 wants to
+store in it, LIBSSH2_ERROR_BUFFER_TOO_SMALL will be returned. The application
+is then adviced to call the function again with a larger buffer. The
+\fIoutlen\fP size will then hold the requested size.
+.SH AVAILABILITY
+Added in libssh2 1.2
+.SH SEE ALSO
+.BR libssh2_knownhost_get(3)
+.BR libssh2_knownhost_readline(3)
+.BR libssh2_knownhost_writefile(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

@@ -0,0 +1,21 @@
+.\" $Id: libssh2_poll.3,v 1.4 2009/04/14 21:38:36 bagder Exp $
+.\"
+.TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_poll - poll for activity on a socket, channel or listener
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);
+.SH DESCRIPTION
+This function is deprecated. Do note use.
+
+Poll for activity on a socket, channel, listener, or any combination of these
+three types. The calling semantics for this function generally match
+\fIpoll(2)\fP however the structure of fds is somewhat more complex in order
+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
+.BR libssh2_poll_channel_read(3)

docs/libssh2_poll_channel_read.3

@@ -0,0 +1,20 @@
+.\" $Id: libssh2_poll_channel_read.3,v 1.3 2009/04/14 21:38:36 bagder Exp $
+.\"
+.TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_poll_channel_read - check if data is available
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended);
+.SH DESCRIPTION
+This function is deprecated. Do note use.
+
+\fIlibssh2_poll_channel_read(3)\fP checks to see if data is available in the
+\fIchannel\fP's read buffer. No attempt is made with this method to see if
+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
+.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,34 @@
+.\" $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. That is the remote
+file name.
+
+\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,43 @@
+.\" $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 to. That is the remote
+file name.
+
+\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

@@ -0,0 +1,20 @@
+.\" $Id: libssh2_session_free.3,v 1.5 2009/03/16 23:25:14 bagder Exp $
+.\"
+.TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_session_free - frees resources associated with a session instance
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_session_free(LIBSSH2_SESSION *session);
+.SH DESCRIPTION
+Frees resources associated with a session instance. Typically called after
+.BR libssh2_session_disconnect_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 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_hostkey.3

@@ -0,0 +1,23 @@
+.\" $Id: session_hostkey.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
+.\"
+.TH libssh2_session_hostkey 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_session_hostkey - get the remote key
+.SH SYNOPSIS
+#include <libssh2.h>
+
+const char *libssh2_session_hostkey(LIBSSH2_SESSION *session,
+                                    size_t *len, int *type);
+.SH DESCRIPTION
+Returns a pointer to the current host key, the value \fIlen\fP points to will
+get the length of the key.
+
+The value \fItype\fP points to the type of hostkey which is one of:
+LIBSSH2_HOSTKEY_TYPE_RSA, LIBSSH2_HOSTKEY_TYPE_DSS, or
+LIBSSH2_HOSTKEY_TYPE_UNKNOWN.
+
+.SH RETURN VALUE
+A pointer, or NULL if something went wrong.
+.SH SEE ALSO
+.BR libssh2_knownhost_check(3)
+.BR libssh2_knownhost_add(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

@@ -0,0 +1,42 @@
+.\" $Id: libssh2_session_startup.3,v 1.7 2009/03/16 23:25:14 bagder Exp $
+.\"
+.TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+libssh2_session_startup - begin transport layer
+.SH SYNOPSIS
+#include <libssh2.h>
+
+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
+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,45 @@
+.\" $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. \fBlibssh2_sftp_close(3)\fP and \fBlibssh2_sftp_closedir(3)\fP
+are macros for \fBlibssh2_sftp_close_handle(3)\fP.
+
+.SH RETURN VALUE
+Return 0 on success or negative on failure.  It returns
+LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
+LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
+
+.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

@@ -0,0 +1,41 @@
+.\" $Id: libssh2_sftp_init.3,v 1.8 2009/03/16 23:25:14 bagder Exp $
+.\"
+.TH libssh2_sftp_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+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);
+
+.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
+.BR libssh2_sftp_shutdown(3)
+function.
+.SH RETURN VALUE
+A pointer to the newly allocated SFTP instance or NULL on failure.
+.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

@@ -0,0 +1,42 @@
+.\" $Id: libssh2_sftp_mkdir_ex.3,v 1.7 2009/03/16 23:25:14 bagder Exp $
+.\"
+.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(LIBSSH2_SFTP *sftp, const char *path, long mode);
+.SH DESCRIPTION
+\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 
+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).
+
+Create a directory on the remote file system.
+.SH RETURN VALUE
+Return 0 on success or negative on failure.
+LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
+LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
+.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_open_ex.3

@@ -0,0 +1,53 @@
+.\" $Id: libssh2_sftp_open_ex.3,v 1.10 2009/03/16 23:25:14 bagder Exp $
+.\"
+.TH libssh2_sftp_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
+.SH NAME
+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, const char *filename, unsigned int filename_len, unsigned long flags, long mode, int open_type);
+
+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);
+
+.SH DESCRIPTION
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
+
+\fIfilename\fP - Remote file/directory resource to open 
+
+\fIfilename_len\fP - Length of filename 
+
+\fIflags\fP - Any (reasonable) combination of the LIBSSH2_FXF_* constants
+corresponding fopen modes.
+
+\fImode\fP - POSIX file permissions to assign if the file is being newly
+created.
+
+\fIopen_type\fP - Either of LIBSSH2_SFTP_OPENFILE (to open a file) or
+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 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

@@ -0,0 +1,45 @@
+.\" $Id: libssh2_sftp_read.3,v 1.10 2009/03/17 10:34:27 bagder Exp $
+.\"
+.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
+\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 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_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_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)