RELEASE-NOTES: fixed for 1.4.3

The function returns NULL also if the hash algorithm is not available.

AUTHORS

@@ -6,31 +6,57 @@
 Adam Gobiowski
 Alexander Holyapin
 Alexander Lamaison
+Alfred Gebert
 Ben Kibbey
 Bjorn Stenborg
 Carlo Bramini
+Cristian Rodríguez
+Daiki Ueno
 Dan Casey
 Dan Fandrich
 Daniel Stenberg
+Dave Hayden
+Dave McCaldon
 David J Sullivan
 David Robins
+Dmitry Smirnov
+Douglas Masterson
 Edink Kadribasic
 Erik Brossler
 Francois Dupoux
+Gellule Xg
+Grubsky Grigory
 Guenter Knauf
 Heiner Steven
+Henrik Nordstrom
 James Housleys
+Jasmeet Bagga
 Jean-Louis Charton
+Jernej Kovacic
+Joey Degges
+John Little
+Jose Baars
 Jussi Mononen
+Kamil Dudka
+Lars Nordin
 Mark McPherson
+Mark Smith
 Markus Moeller
+Matt Lilley
+Matthew Booth
+Maxime Larocque
 Mike Protts
 Mikhail Gusarov
 Neil Gierman
 Olivier Hervieu
+Paul Howarth
+Paul Querna
 Paul Veldkamp
+Peter Krempa
 Peter O'Gorman
 Peter Stuge
+Pierre Joye
+Rafael Kitover
 Romain Bondue
 Sara Golemon
 Satish Mittal
@@ -38,10 +64,16 @@ Sean Peterson
 Selcuk Gueney
 Simon Hart
 Simon Josefsson
+Sofian Brabez
 Steven Ayre
+Steven Dake
 Steven Van Ingelgem
+TJ Saunders
+Tommy Lindgren
 Tor Arntsen
 Vincent Jaulin
+Vincent Torri
 Vlad Grachov
 Wez Furlong
 Yang Tse
+Zl Liu

Makefile.am

@@ -1,6 +1,9 @@
 AUTOMAKE_OPTIONS = foreign nostdinc
 
-SUBDIRS = src example tests docs
+SUBDIRS = src tests docs
+if BUILD_EXAMPLES
+SUBDIRS += example
+endif
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = libssh2.pc
@@ -11,10 +14,9 @@ include_HEADERS =			\
 	include/libssh2_sftp.h
 
 NETWAREFILES =  nw/keepscreen.c \
- nw/Makefile \
- nw/Makefile.netware \
 	nw/nwlib.c \
- nw/test/Makefile.netware
+	nw/GNUmakefile \
+	nw/test/GNUmakefile
 
 DSP = win32/libssh2.dsp
 VCPROJ = win32/libssh2.vcproj
@@ -25,15 +27,13 @@ VMSFILES = vms/libssh2_make_example.dcl vms/libssh2_make_help.dcl	\
 vms/libssh2_make_kit.dcl vms/libssh2_make_lib.dcl vms/man2help.c	\
 vms/readme.vms vms/libssh2_config.h
 
-
+WIN32FILES = win32/GNUmakefile win32/test/GNUmakefile		\
-WIN32FILES = win32/Makefile.win32 win32/libssh2.dsw     \
+win32/libssh2_config.h win32/config.mk win32/rules.mk		\
-win32/config.mk win32/Makefile win32/test/Makefile.win32 \
+win32/Makefile.Watcom win32/libssh2.dsw win32/tests.dsp $(DSP)	\
-win32/libssh2_config.h win32/tests.dsp win32/rules.mk $(DSP) \
+win32/msvcproj.head win32/msvcproj.foot win32/libssh2.rc
-win32/msvcproj.head win32/msvcproj.foot win32/libssh2.rc \
-win32/Makefile.Watcom
 
 EXTRA_DIST = $(WIN32FILES) buildconf $(NETWAREFILES) get_ver.awk HACKING \
- maketgz NMakefile TODO RELEASE-NOTES libssh2.pc.in $(VMSFILES)
+ maketgz NMakefile TODO RELEASE-NOTES libssh2.pc.in $(VMSFILES) config.rpath
 
 ACLOCAL_AMFLAGS = -I m4
 

NMakefile

@@ -1,19 +1,28 @@
 !include "win32/config.mk"
 
+!include "Makefile.inc"
+
+OBJECTS=$(CSOURCES:.c=.obj)
+
 # SUBDIRS=src example
 SUBDIRS=src
 
-all-sub:
+all-sub: win32\objects.mk
 	-for %D in ($(SUBDIRS)) do $(MAKE) /nologo /f %D/NMakefile BUILD=$(BUILD) SUBDIR=%D all-sub
 
 clean: 
-	-rmdir /s/q $(TARGET)
+	-rmdir 2>NUL /s/q $(TARGET)
 
-real-clean: clean
+real-clean vclean: clean
-	-del libssh2.dll
+	-del 2>NUL libssh2.dll
-	-del libssh2.exp
+	-del 2>NUL libssh2.exp
-	-del libssh2.ilk
+	-del 2>NUL libssh2.ilk
-	-del libssh2.lib
+	-del 2>NUL libssh2.lib
-	-del *.pdb
+	-del 2>NUL *.pdb
+	-del 2>NUL win32\objects.mk
 
+win32\objects.mk: Makefile.inc
+	@echo OBJECTS = \>$@
+	@for %O in ($(OBJECTS)) do @echo $$(INTDIR)\%O \>>$@
+	@echo $$(EOL)>>$@
 

RELEASE-NOTES

@@ -1,35 +1,28 @@
-libssh2 1.2.9
+libssh2 1.4.3
 
 This release includes the following changes:
 
- o Added libssh2_session_set_timeout() and libssh2_session_get_timeout()
+ o compression: add support for zlib@openssh.com
-   to make blocking calls get a timeout
 
 This release includes the following bugfixes:
 
- o configure and pkg-config: fix $VERSION
+ o sftp_read: return error if a too large package arrives
- o s/\.NF/.nf/ to fix wrong macro name caught by man --warnings
+ o libssh2_hostkey_hash.3: update the description of return value
- o keepalive: add first basic man pages
+ o Fixed MSVC NMakefile
- o sftp_write: flush the packetlist on error
+ o examples: use stderr for messages, stdout for data
- o sftp_write: clean offsets on error
+ o openssl: do not leak memory when handling errors
- o msvcproj: added libs and debug stuff
+ o improved handling of disabled MD5 algorithm in OpenSSL
- o SCP: fix incorrect error code
+ o known_hosts: Fail when parsing unknown keys in known_hosts file
- o session_startup: init state properly
+ o configure: gcrypt doesn't come with pkg-config support
- o sftp_write_sliding: send the complete file
+ o session_free: wrong variable used for keeping state
- o userauth_keyboard_interactive: skip code on zero length auth
+ o libssh2_userauth_publickey_fromfile_ex.3: mention publickey == NULL
- o _libssh2_wait_socket: fix timeouts for poll() uses
+ o comp_method_zlib_decomp: handle Z_BUF_ERROR when inflating
- o agent_list_identities: fix out of scope access
- o _libssh2_recv(): handle ENOENT error as EAGAIN
- o userauth_keyboard_interactive: fix buffer overflow
- o removed man pages for non-existing functions!
- o gettimeofday: fix name space pollution
- o _libssh2_channel_write: handle window_size == 0 better
 
 This release would not have looked like this without help, code, reports and
 advice from friends like these:
 
- Alfred Gebert, Dan Fandrich, Douglas Masterson, Guenter Knauf, Matt Lilley,
+ Guenter Knauf, Peter Stuge, TJ Saunders, Mike Abdullah, Maxime Larocque,
- Mikhail Gusarov, Peter Stuge, zl liu, Paul Howarth, Mark Smith, Bill Segall,
+ Dmitry Smirnov, Dave Hayden, Peter Krempa, Kamil Dudka
- Henrik Nordstr<74>m
  
         Thanks! (and sorry if I forgot to mention someone)
+

TODO

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

configure.ac

@@ -32,7 +32,7 @@ AB_INIT
 AC_CANONICAL_HOST
 case "$host" in
     *-mingw*)
-    CFLAGS="$CFLAGS -DLIBSSH2_WIN32 -DWINSOCK_VERSION=0x0200"
+    CFLAGS="$CFLAGS -DLIBSSH2_WIN32"
     LIBS="$LIBS -lws2_32"
     ;;
 	*-cygwin)
@@ -96,13 +96,17 @@ AC_ARG_WITH(libz,
 # Look for OpenSSL (default)
 if test "$use_openssl" != "no" && test "$use_libgcrypt" != "yes"; then
   AC_LIB_HAVE_LINKFLAGS([ssl], [crypto], [#include <openssl/ssl.h>])
+  LIBSREQUIRED=libssl,libcrypto
 fi
 
 # Look for libgcrypt
 if test "$ac_cv_libssl" != "yes" && test "$use_libgcrypt" != "no"; then
   AC_LIB_HAVE_LINKFLAGS([gcrypt], [], [#include <gcrypt.h>])
+  LIBS="$LIBS -lgcrypt"
 fi
 
+AC_SUBST(LIBSREQUIRED)
+
 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])
@@ -215,12 +219,29 @@ AC_HELP_STRING([--disable-hidden-symbols],[Leave all symbols with default visibi
        AC_MSG_RESULT(no)
 )
 
+# Build example applications?
+AC_MSG_CHECKING([whether to build example applications])
+AC_ARG_ENABLE([examples-build],
+AC_HELP_STRING([--enable-examples-build], [Build example applications (this is the default)])
+AC_HELP_STRING([--disable-examples-build], [Do not build example applications]),
+[case "$enableval" in
+  no | false)
+    build_examples='no'
+    ;;
+  *)
+    build_examples='yes'
+    ;;
+esac], [build_examples='yes'])
+AC_MSG_RESULT($build_examples)
+AM_CONDITIONAL([BUILD_EXAMPLES], [test "x$build_examples" != "xno"])
+
 # 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])
-AC_CHECK_HEADERS([sys/un.h])
+AC_CHECK_HEADERS([sys/un.h], [have_sys_un_h=yes], [have_sys_un_h=no])
+AM_CONDITIONAL([HAVE_SYS_UN_H], test "x$have_sys_un_h" = xyes)
 
 case $host in
   *-*-cygwin* | *-*-cegcc*)
@@ -299,6 +320,7 @@ AC_MSG_NOTICE([summary of build options:
   Library types:    Shared=${enable_shared}, Static=${enable_static}
   Crypto library:   openssl: ${ac_cv_libssl:-no} (AES-CTR: ${ac_cv_func_EVP_aes_128_ctr:-N/A}) libgcrypt: ${ac_cv_libgcrypt:-no}
   Debug build:      $enable_debug
+  Build examples:   $build_examples
   Path to sshd:     $ac_cv_path_SSHD (only for self-tests)
   libz compression: $ac_cv_libz
 ])

docs/BINDINGS

@@ -0,0 +1,29 @@
+
+Creative people have written bindings or interfaces for various environments
+and programming languages. Using one of these bindings allows you to take
+advantage of libssh2 directly from within your favourite language.
+
+The bindings listed below are not part of the libssh2 distribution archives,
+but must be downloaded and installed separately.
+
+Cocoa/Objective-C
+  https://github.com/karelia/libssh2_sftp-Cocoa-wrapper
+
+Haskell
+  FFI bindings - http://hackage.haskell.org/package/libssh2
+
+Perl
+  Net::SSH2 - http://search.cpan.org/~rkitover/Net-SSH2-0.45/lib/Net/SSH2.pm
+
+PHP
+  ssh2 - http://pecl.php.net/package/ssh2 
+
+Python
+  pylibssh2 - http://www.wallix.org/pylibssh2-project/
+
+Python-ctypes
+
+  PySsh2 - https://github.com/gellule/PySsh2
+
+Ruby
+  libssh2-ruby - https://github.com/mitchellh/libssh2-ruby

docs/Makefile.am

@@ -1,6 +1,6 @@
 # $Id: Makefile.am,v 1.37 2009/03/26 15:41:15 bagder Exp $
 
-EXTRA_DIST = template.3
+EXTRA_DIST = template.3 BINDINGS
 
 dist_man_MANS = \
 	libssh2_agent_connect.3 \
@@ -92,6 +92,8 @@ dist_man_MANS = \
 	libssh2_scp_send64.3 \
 	libssh2_scp_send_ex.3 \
 	libssh2_session_abstract.3 \
+	libssh2_session_banner_get.3 \
+	libssh2_session_banner_set.3 \
 	libssh2_session_block_directions.3 \
 	libssh2_session_callback_set.3 \
 	libssh2_session_disconnect.3 \
@@ -110,6 +112,7 @@ dist_man_MANS = \
 	libssh2_session_set_blocking.3 \
 	libssh2_session_set_timeout.3 \
 	libssh2_session_startup.3 \
+	libssh2_session_supported_algs.3 \
 	libssh2_sftp_close.3 \
 	libssh2_sftp_close_handle.3 \
 	libssh2_sftp_closedir.3 \
@@ -117,6 +120,7 @@ dist_man_MANS = \
 	libssh2_sftp_fstat.3 \
 	libssh2_sftp_fstat_ex.3 \
 	libssh2_sftp_fstatvfs.3 \
+	libssh2_sftp_get_channel.3 \
 	libssh2_sftp_init.3 \
 	libssh2_sftp_last_error.3 \
 	libssh2_sftp_lstat.3 \

docs/libssh2_banner_set.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_banner_set.3,v 1.3 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_banner_set - set the SSH prococol banner for the local client
@@ -10,6 +8,9 @@ int
 libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);
 
 .SH DESCRIPTION
+This function is \fBDEPRECATED\fP. Use \fIlibssh2_session_banner_set(3)\fP
+instead!
+
 \fIsession\fP - Session instance as returned by 
 .BR libssh2_session_init_ex(3)
 
@@ -17,16 +18,15 @@ libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner);
 
 Set the banner that will be sent to the remote host when the SSH session is 
 started with 
-.BR libssh2_session_startup(3)
+.BR libssh2_session_handshake(3)
   This is optional; a banner corresponding to the protocol and libssh2 version will be sent by default.
-
 .SH RETURN VALUE
 Return 0 on success or negative on failure.  It returns
 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
-
+.SH AVAILABILITY
+Marked as deprecated since 1.4.0
 .SH ERRORS
 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
-
 .SH SEE ALSO
-.BR libssh2_session_startup(3)
+.BR libssh2_session_handshake(3)

docs/libssh2_base64_decode.3

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

docs/libssh2_channel_close.3

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

docs/libssh2_channel_direct_tcpip.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_direct_tcpip 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_tcpip_ex(3)\fP calls

docs/libssh2_channel_direct_tcpip_ex.3

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

docs/libssh2_channel_eof.3

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

docs/libssh2_channel_exec.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_exec 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls

docs/libssh2_channel_flush.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_flush 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls

docs/libssh2_channel_flush_ex.3

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

docs/libssh2_channel_flush_stderr.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_flush_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls

docs/libssh2_channel_forward_accept.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_channel_forward_accept.3,v 1.6 2009/03/16 23:25:14 bagder Exp $
-.\"
 .TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_channel_forward_accept - accept a queued connection

docs/libssh2_channel_forward_cancel.3

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

docs/libssh2_channel_forward_listen.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_forward_listen 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forward_listen_ex(3)\fP calls

docs/libssh2_channel_forward_listen_ex.3

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

docs/libssh2_channel_free.3

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

docs/libssh2_channel_get_exit_signal.3

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

docs/libssh2_channel_get_exit_status.3

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

docs/libssh2_channel_handle_extended_data.3

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

docs/libssh2_channel_handle_extended_data2.3

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

docs/libssh2_channel_ignore_extended_data.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_ignore_extended_data 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_handle_extended_data(3)\fP calls

docs/libssh2_channel_open_ex.3

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

docs/libssh2_channel_open_session.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_open_session 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex(3)\fP calls

docs/libssh2_channel_process_startup.3

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

docs/libssh2_channel_read.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls

docs/libssh2_channel_read_ex.3

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

docs/libssh2_channel_read_stderr.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_read_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls

docs/libssh2_channel_receive_window_adjust.3

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

docs/libssh2_channel_receive_window_adjust2.3

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

docs/libssh2_channel_request_pty.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_request_pty 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_pty_ex(3)\fP calls

docs/libssh2_channel_request_pty_ex.3

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

docs/libssh2_channel_request_pty_size.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_request_pty_size 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_request_pty_size_ex(3)\fP calls

docs/libssh2_channel_request_pty_size_ex.3

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

docs/libssh2_channel_send_eof.3

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

docs/libssh2_channel_set_blocking.3

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

docs/libssh2_channel_setenv.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_setenv 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\fP calls

docs/libssh2_channel_setenv_ex.3

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

docs/libssh2_channel_shell.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_shell 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls

docs/libssh2_channel_subsystem.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_subsystem 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls

docs/libssh2_channel_wait_closed.3

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

docs/libssh2_channel_wait_eof.3

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

docs/libssh2_channel_window_read.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_window_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_read_ex(3)\fP calls

docs/libssh2_channel_window_read_ex.3

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

docs/libssh2_channel_window_write.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_window_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_write_ex(3)\fP calls

docs/libssh2_channel_window_write_ex.3

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

docs/libssh2_channel_write.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP

docs/libssh2_channel_write_ex.3

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

docs/libssh2_channel_write_stderr.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_write_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex(3)\fP

docs/libssh2_channel_x11_req.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_channel_x11_req 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3)\fP calls

docs/libssh2_channel_x11_req_ex.3

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

docs/libssh2_hostkey_hash.3

@@ -1,5 +1,3 @@
-.\" $Id: libssh2_hostkey_hash.3,v 1.2 2009/03/17 10:34:27 bagder Exp $
-.\"
 .TH libssh2_hostkey_hash 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
 .SH NAME
 libssh2_hostkey_hash - return a hash of the remote host's key
@@ -20,8 +18,9 @@ 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 
+Computed hostkey hash value, or NULL if the information is not available
-up. (The hash consists of raw binary bytes, not hex digits, so is not 
+(either the session has not yet been started up, or the requested hash
-directly printable.)
+algorithm was not available). The hash consists of raw binary bytes, not hex
+digits, so it is not directly printable.
 .SH SEE ALSO
 .BR libssh2_session_init_ex(3)

docs/libssh2_keepalive_send.3

@@ -1,5 +1,3 @@
-.\" $Id: keepalive_send.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_keepalive_send 3 "13 Apr 2011" "libssh2 1.2.5" "libssh2 manual"
 .SH NAME
 libssh2_keepalive_send - short function description

docs/libssh2_poll.3

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

docs/libssh2_poll_channel_read.3

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

docs/libssh2_publickey_add.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_publickey_add 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP calls

docs/libssh2_publickey_add_ex.3

@@ -1,5 +1,3 @@
-.\" $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 - Add a public key entry

docs/libssh2_publickey_init.3

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

docs/libssh2_publickey_list_fetch.3

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

docs/libssh2_publickey_list_free.3

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

docs/libssh2_publickey_remove.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_publickey_remove 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex(3)\fP calls

docs/libssh2_publickey_remove_ex.3

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

docs/libssh2_publickey_shutdown.3

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

docs/libssh2_scp_recv.3

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

docs/libssh2_scp_send.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_scp_send 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls

docs/libssh2_scp_send64.3

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

docs/libssh2_scp_send_ex.3

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

docs/libssh2_session_abstract.3

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

docs/libssh2_session_banner_get.3

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

docs/libssh2_session_banner_set.3

@@ -0,0 +1,32 @@
+.TH libssh2_session_banner_set 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual"
+.SH NAME
+libssh2_session_banner_set - set the SSH prococol banner for the local client
+.SH SYNOPSIS
+#include <libssh2.h>
+
+int 
+libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner);
+
+.SH DESCRIPTION
+\fIsession\fP - Session instance as returned by 
+.BR libssh2_session_init_ex(3)
+
+\fIbanner\fP - A pointer to a zero-terminated string holding the user defined
+banner
+
+Set the banner that will be sent to the remote host when the SSH session is
+started with \fIlibssh2_session_handshake(3)\fP This is optional; a banner
+corresponding to the protocol and libssh2 version will be sent by default.
+.SH RETURN VALUE
+Returns 0 on success or negative on failure.  It returns LIBSSH2_ERROR_EAGAIN
+when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative
+number, it isn't really a failure per se.
+.SH ERRORS
+\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
+.SH AVAILABILITY
+Added in 1.4.0.
+
+Before 1.4.0 this function was known as libssh2_banner_set(3)
+.SH SEE ALSO
+.BR libssh2_session_handshake(3),
+.BR libssh2_session_banner_get(3)

docs/libssh2_session_block_directions.3

@@ -1,5 +1,3 @@
-.\" $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 to wait for

docs/libssh2_session_callback_set.3

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

docs/libssh2_session_disconnect.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_session_disconnect 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_session_disconnect - convenience macro for \fIlibssh2_session_disconnect_ex(3)\fP calls

docs/libssh2_session_disconnect_ex.3

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

docs/libssh2_session_flag.3

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

docs/libssh2_session_free.3

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

docs/libssh2_session_get_blocking.3

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

docs/libssh2_session_handshake.3

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

docs/libssh2_session_hostkey.3

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

docs/libssh2_session_init.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_session_init 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_session_init - convenience macro for \fIlibssh2_session_init_ex(3)\fP calls

docs/libssh2_session_init_ex.3

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

docs/libssh2_session_last_errno.3

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

docs/libssh2_session_last_error.3

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

docs/libssh2_session_method_pref.3

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

docs/libssh2_session_methods.3

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

docs/libssh2_session_set_blocking.3

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

docs/libssh2_session_startup.3

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

docs/libssh2_session_supported_algs.3

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

docs/libssh2_sftp_close.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_sftp_close 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_sftp_close - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls

docs/libssh2_sftp_close_handle.3

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

docs/libssh2_sftp_closedir.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_sftp_closedir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_sftp_closedir - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls

docs/libssh2_sftp_fsetstat.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_sftp_fsetstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_sftp_fsetstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls

docs/libssh2_sftp_fstat.3

@@ -1,5 +1,3 @@
-.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
-.\"
 .TH libssh2_sftp_fstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
 .SH NAME
 libssh2_sftp_fstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls

docs/libssh2_sftp_fstat_ex.3

@@ -1,5 +1,3 @@
-.\" $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 an SFTP file handle