RELEASE-NOTES: synced with 6bd584d29 for 1.4.0

s/1.3.1/1.4.0
We're bumping the minor number
2012-01-31 23:23:04 +01:00 · 2012-01-31 23:22:30 +01:00 · 2012-01-31 23:07:21 +01:00 · 2012-01-31 23:05:03 +01:00 · 2012-01-27 11:03:31 +01:00 · 2011-12-19 23:18:46 +01:00
192 changed files with 787 additions and 741 deletions
--- a/1
+++ b/1
@@ -29,6 +29,7 @@ Mikhail Gusarov
 Neil Gierman
 Olivier Hervieu
 Paul Veldkamp
+Peter Krempa
 Peter O'Gorman
 Peter Stuge
 Romain Bondue
--- a/Makefile.am
+++ b/Makefile.am
@@ -25,11 +25,10 @@ VMSFILES = vms/libssh2_make_example.dcl vms/libssh2_make_help.dcl	\
 vms/libssh2_make_kit.dcl vms/libssh2_make_lib.dcl vms/man2help.c	\
 vms/readme.vms vms/libssh2_config.h

-
-WIN32FILES = win32/libssh2.dsw win32/config.mk win32/Makefile	\
-win32/libssh2_config.h win32/tests.dsp win32/rules.mk $(DSP)	\
-win32/msvcproj.head win32/msvcproj.foot win32/libssh2.rc	\
-win32/Makefile.Watcom
+WIN32FILES = win32/GNUmakefile win32/test/GNUmakefile		\
+win32/libssh2_config.h win32/config.mk win32/rules.mk		\
+win32/Makefile.Watcom win32/libssh2.dsw win32/tests.dsp $(DSP)	\
+win32/msvcproj.head win32/msvcproj.foot win32/libssh2.rc

 EXTRA_DIST = $(WIN32FILES) buildconf $(NETWAREFILES) get_ver.awk HACKING \
 maketgz NMakefile TODO RELEASE-NOTES libssh2.pc.in $(VMSFILES)
--- a/25
+++ b/25
@@ -1,19 +1,30 @@
-libssh2 1.3.0
+libssh2 1.4.0

 This release includes the following changes:

- o Added custom callbacks for performing low level socket I/O
+ o Added libssh2_session_supported_algs()
+ o Added libssh2_session_banner_get()
+ o Added libssh2_sftp_get_channel()
+ o libssh2.h: bump the default window size to 256K

 This release includes the following bugfixes:

- o sftp_read: advance offset correctly for buffered copies
- o libssh2_sftp_seek64: flush packetlist and buffered data
- o _libssh2_packet_add: adjust window size when truncating
- o sftp_read: a short read is not end of file
+ o sftp-seek: clear EOF flag
+ o userauth: Provide more informations if ssh pub key extraction fails
+ o ssh2_exec: skip error outputs for EAGAIN
+ o LIBSSH2_SFTP_PACKET_MAXLEN: increase to 80000
+ o knownhost_check(): Don't dereference ext if NULL is passed
+ o knownhost_add: Avoid dereferencing uninitialized memory on error path
+ o OpenSSL EVP: fix threaded use of structs
+ o _libssh2_channel_read: react on errors from receive_window_adjust
+ o sftp_read: cap the read ahead maximum amount
+ o _libssh2_channel_read: fix non-blocking window adjusting

 This release would not have looked like this without help, code, reports and
 advice from friends like these:

- Henrik Nordstrom, liuzl, Guenter Knauf
+ Gellule Xg, Jernej Kovacic, Peter Krempa, Vincent Torri, Kamil Dudka,
+ Peter Stuge, Guenter Knauf, John Engstrom, Alexander Lamaison,
+ Mikhail Gusarov
 
        Thanks! (and sorry if I forgot to mention someone)
--- a/11
+++ b/11
@@ -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:

--- a/configure.ac
+++ b/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)
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -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 \
--- a/docs/libssh2_banner_set.3
+++ b/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)
--- a/docs/libssh2_base64_decode.3
+++ b/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
--- a/docs/libssh2_channel_close.3
+++ b/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
--- a/docs/libssh2_channel_direct_tcpip.3
+++ b/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
--- a/docs/libssh2_channel_direct_tcpip_ex.3
+++ b/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
--- a/docs/libssh2_channel_eof.3
+++ b/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
--- a/docs/libssh2_channel_exec.3
+++ b/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
--- a/docs/libssh2_channel_flush.3
+++ b/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
--- a/docs/libssh2_channel_flush_ex.3
+++ b/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
--- a/docs/libssh2_channel_flush_stderr.3
+++ b/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
--- a/docs/libssh2_channel_forward_accept.3
+++ b/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
--- a/docs/libssh2_channel_forward_cancel.3
+++ b/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
--- a/docs/libssh2_channel_forward_listen.3
+++ b/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
--- a/docs/libssh2_channel_forward_listen_ex.3
+++ b/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
--- a/docs/libssh2_channel_free.3
+++ b/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
--- a/docs/libssh2_channel_get_exit_signal.3
+++ b/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
--- a/docs/libssh2_channel_get_exit_status.3
+++ b/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
--- a/docs/libssh2_channel_handle_extended_data.3
+++ b/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
--- a/docs/libssh2_channel_handle_extended_data2.3
+++ b/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
--- a/docs/libssh2_channel_ignore_extended_data.3
+++ b/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
--- a/docs/libssh2_channel_open_ex.3
+++ b/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
--- a/docs/libssh2_channel_open_session.3
+++ b/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
--- a/docs/libssh2_channel_process_startup.3
+++ b/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
--- a/docs/libssh2_channel_read.3
+++ b/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
--- a/docs/libssh2_channel_read_ex.3
+++ b/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
--- a/docs/libssh2_channel_read_stderr.3
+++ b/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
--- a/docs/libssh2_channel_receive_window_adjust.3
+++ b/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
--- a/docs/libssh2_channel_receive_window_adjust2.3
+++ b/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
--- a/docs/libssh2_channel_request_pty.3
+++ b/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
--- a/docs/libssh2_channel_request_pty_ex.3
+++ b/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
--- a/docs/libssh2_channel_request_pty_size.3
+++ b/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
--- a/docs/libssh2_channel_request_pty_size_ex.3
+++ b/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
--- a/docs/libssh2_channel_send_eof.3
+++ b/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
--- a/docs/libssh2_channel_set_blocking.3
+++ b/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
--- a/docs/libssh2_channel_setenv.3
+++ b/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
--- a/docs/libssh2_channel_setenv_ex.3
+++ b/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
--- a/docs/libssh2_channel_shell.3
+++ b/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
--- a/docs/libssh2_channel_subsystem.3
+++ b/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
--- a/docs/libssh2_channel_wait_closed.3
+++ b/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
--- a/docs/libssh2_channel_wait_eof.3
+++ b/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
--- a/docs/libssh2_channel_window_read.3
+++ b/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
--- a/docs/libssh2_channel_window_read_ex.3
+++ b/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
--- a/docs/libssh2_channel_window_write.3
+++ b/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
--- a/docs/libssh2_channel_window_write_ex.3
+++ b/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
--- a/docs/libssh2_channel_write.3
+++ b/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
--- a/docs/libssh2_channel_write_ex.3
+++ b/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
--- a/docs/libssh2_channel_write_stderr.3
+++ b/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
--- a/docs/libssh2_channel_x11_req.3
+++ b/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
--- a/docs/libssh2_channel_x11_req_ex.3
+++ b/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
--- a/docs/libssh2_hostkey_hash.3
+++ b/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
--- a/docs/libssh2_keepalive_send.3
+++ b/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
--- a/docs/libssh2_poll.3
+++ b/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
--- a/docs/libssh2_poll_channel_read.3
+++ b/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
--- a/docs/libssh2_publickey_add.3
+++ b/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
--- a/docs/libssh2_publickey_add_ex.3
+++ b/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
--- a/docs/libssh2_publickey_init.3
+++ b/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
--- a/docs/libssh2_publickey_list_fetch.3
+++ b/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
--- a/docs/libssh2_publickey_list_free.3
+++ b/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
--- a/docs/libssh2_publickey_remove.3
+++ b/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
--- a/docs/libssh2_publickey_remove_ex.3
+++ b/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
--- a/docs/libssh2_publickey_shutdown.3
+++ b/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
--- a/docs/libssh2_scp_recv.3
+++ b/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
--- a/docs/libssh2_scp_send.3
+++ b/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
--- a/docs/libssh2_scp_send64.3
+++ b/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
--- a/docs/libssh2_scp_send_ex.3
+++ b/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
--- a/docs/libssh2_session_abstract.3
+++ b/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
--- a/docs/libssh2_session_banner_get.3
+++ b/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)
--- a/docs/libssh2_session_banner_set.3
+++ b/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)
--- a/docs/libssh2_session_block_directions.3
+++ b/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
--- a/docs/libssh2_session_callback_set.3
+++ b/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
--- a/docs/libssh2_session_disconnect.3
+++ b/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
--- a/docs/libssh2_session_disconnect_ex.3
+++ b/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
--- a/docs/libssh2_session_flag.3
+++ b/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
--- a/docs/libssh2_session_free.3
+++ b/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
--- a/docs/libssh2_session_get_blocking.3
+++ b/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
--- a/docs/libssh2_session_handshake.3
+++ b/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
--- a/docs/libssh2_session_hostkey.3
+++ b/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
--- a/docs/libssh2_session_init.3
+++ b/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
--- a/docs/libssh2_session_init_ex.3
+++ b/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)
--- a/docs/libssh2_session_last_errno.3
+++ b/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
--- a/docs/libssh2_session_last_error.3
+++ b/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
--- a/docs/libssh2_session_method_pref.3
+++ b/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)
--- a/docs/libssh2_session_methods.3
+++ b/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
--- a/docs/libssh2_session_set_blocking.3
+++ b/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
--- a/docs/libssh2_session_startup.3
+++ b/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
--- a/docs/libssh2_session_supported_algs.3
+++ b/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)
--- a/docs/libssh2_sftp_close.3
+++ b/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
--- a/docs/libssh2_sftp_close_handle.3
+++ b/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
--- a/docs/libssh2_sftp_closedir.3
+++ b/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
--- a/docs/libssh2_sftp_fsetstat.3
+++ b/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
--- a/docs/libssh2_sftp_fstat.3
+++ b/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
--- a/docs/libssh2_sftp_fstat_ex.3
+++ b/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
--- a/docs/libssh2_sftp_get_channel.3
+++ b/docs/libssh2_sftp_get_channel.3
@@ -0,0 +1,21 @@
+.TH libssh2_sftp_get_channel 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual"
+.SH NAME
+libssh2_sftp_get_channel - return the channel of sftp
+.SH SYNOPSIS
+.nf
+#include <libssh2.h>
+#include <libssh2_sftp.h>
+
+.fi
+LIBSSH2_CHANNEL *libssh2_sftp_get_channel(LIBSSH2_SFTP *sftp);
+.SH DESCRIPTION
+\fIsftp\fP - SFTP instance as returned by 
+.BR libssh2_sftp_init(3)
+
+Return the channel of the given sftp handle.
+.SH RETURN VALUE
+The channel of the SFTP instance or NULL if something was wrong.
+.SH AVAILABILITY
+Added in 1.4.0
+.SH SEE ALSO
+.BR libssh2_sftp_init(3)
--- a/docs/libssh2_sftp_init.3
+++ b/docs/libssh2_sftp_init.3
@@ -1,5 +1,3 @@
-.\" $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.
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
Daniel Stenberg	388920cf3c	RELEASE-NOTES: synced with `6bd584d29` for 1.4.0	2012-01-31 23:23:04 +01:00
Daniel Stenberg	6bd584d293	s/1.3.1/1.4.0 We're bumping the minor number	2012-01-31 23:22:30 +01:00
Jernej Kovacic	e68c895fc4	libssh2_session_supported_algs: fix compiler warning	2012-01-31 23:07:21 +01:00
Jernej Kovacic	511a972a95	session_supported_algs docs: added an example	2012-01-31 23:05:03 +01:00
Gellule Xg	3401b374c9	sftp-seek: clear EOF flag Set the EOF flag to False when calling seek64 to be able to get some data back on a following read	2012-01-27 11:03:31 +01:00
Peter Krempa	209de22299	userauth: Provide more informations if ssh pub key extraction fails If the function that extracts/computes the public key from a private key fails the errors it reports were masked by the function calling it. This patch modifies the key extraction function to return errors using _libssh_error() function. The error messages are tweaked to contain reference to the failed operaton in addition to the reason. * AUTHORS: - add my name * libgcrypt.c: _libssh2_pub_priv_keyfile(): - return a more verbose error using _libssh2_error() func. * openssl.c: - modify call graph of _libssh2_pub_priv_keyfile() to use _libssh2_error for error reporting(); * userauth.c: - tweak functions calling _libssh2_pub_priv_keyfile() not to shadow error messages	2011-12-19 23:18:46 +01:00
Daniel Stenberg	b8dd697796	TODO: remove issues we (sort of) did already	2011-12-09 14:21:36 +01:00
Daniel Stenberg	09139ef065	ssh2_exec: skip error outputs for EAGAIN Since the example uses non-blocking mode, it will just flood the output with this "nonsense" error.	2011-12-08 10:54:46 +01:00
Guenter Knauf	d903b81c64	Some NetWare makefile tweaks.	2011-11-30 17:52:06 +01:00
Daniel Stenberg	4f61824908	LIBSSH2_SFTP_PACKET_MAXLEN: increase to 80000 Some SFTP servers send SFTP packets larger than 40000. Since the limit is only present to avoid insane sizes anyway, we can easily bump it. The define was formerly in the public header libssh2_sftp.h but served no external purpose and was moved into the source dir. Bug: http://www.libssh2.org/mail/libssh2-devel-archive-2011-11/0004.shtml Reported by: Michael Harris	2011-11-18 23:36:52 +01:00
Peter Krempa	fed94fa85d	knownhost_check(): Don't dereference ext if NULL is passed Documentation for libssh2_knownhost_checkp() and related functions states that the last argument is filled with data if non-NULL. "knownhost 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." In this function ext is dereferenced even if set to NULL, causing segfault in applications not needing the extra data.	2011-11-18 16:11:19 +00:00
Peter Krempa	378311fe5b	knownhost_add: Avoid dereferencing uninitialized memory on error path. In function knownhost_add, memory is alocated for a new entry. If normal alocation is used, memory is not initialized to 0 right after, but a check is done to verify if correct key type is passed. This test is done BEFORE setting the memory to null, and on the error path function free_host() is called, that tries to dereference unititialized memory, resulting into a glibc abort(). * knownhost.c - knownhost_add(): - move typemask check before alloc	2011-11-11 21:52:46 +01:00
Daniel Stenberg	139278b79f	windows build: add define to avoid compiler warning A recent mingw compiler has started to complain on "#warning Please include winsock2.h before windows.h" unless the magic define is set first. Reported by: Vincent Torri Bug: http://www.libssh2.org/mail/libssh2-devel-archive-2011-10/0064.shtml	2011-11-01 22:45:49 +01:00
Vincent Torri	a0e13cc828	Correct Windows include file name case, simplifying cross-compilation When cross compiling to Windows, libssh2.h include Windows header files with upper case filenames : BaseTsd.h and WinSock2.h. These files have lowercase names with mingw-w64 (iirc, it's the same with mingw). And as on Windows, being lowercase or uppercase does not matter.	2011-10-31 11:32:52 +01:00
Jernej Kovacic	f4e5ca2f14	libssh2_session_supported_algs: added	2011-10-25 23:50:44 +02:00
Kamil Dudka	c0974e5ca3	example/sftp_RW_nonblock: do not ignore LIBSSH2_ERROR_EAGAIN Bug: https://bugzilla.redhat.com/745420	2011-10-24 22:22:57 +02:00
Peter Stuge	c292378327	example/ssh2_agent: Print host key fingerprint before authentication Also moves the comment about not being authenticated to before the agent authentication takes place, so that it better matches the code.	2011-10-05 16:55:58 +02:00
Daniel Stenberg	ee07785a1e	OpenSSL EVP: fix threaded use of structs Make sure we don't clear or reset static structs after first init so that they work fine even when used from multiple threads. Init the structs in the global init. Help and assistance by: John Engstrom Fixes #229 (again)	2011-09-29 22:42:16 +02:00
Daniel Stenberg	24afd0fc72	openssl: don't init static structs differently make_ctr_evp() is changed to take a struct pointer, and then each _libssh2_EVP_aes_[keylen]_ctr function is made to pass in their own static struct Reported by: John Engstrom Fixes #229	2011-09-28 22:26:47 +02:00
Guenter Knauf	abd00727ef	Removed obsolete include path.	2011-09-27 16:04:11 +02:00
Daniel Stenberg	4b77724b3b	read_state: clear the state variable better Set read_state back to idle before trying to send anything so that if the state somehow is wrongly set. Also, avoid such a case of confusion by resetting the read_state when an sftp handle is closed.	2011-09-21 16:16:27 +02:00
Daniel Stenberg	33865b8936	sftp_read: remove leftover fprintf Reported by: Alexander Lamaison	2011-09-17 00:20:14 +02:00
Daniel Stenberg	16dd675f4d	sftp.h: fix the #ifdef to prevent multiple inclusions	2011-09-16 22:08:55 +02:00
Daniel Stenberg	30e28817f2	sftp_read: use a state variable to avoid bad writes When a channel_write call has gotten an EAGAIN back, we try harder to continue the same write in the subsequent invoke.	2011-09-13 20:16:59 +02:00
Daniel Stenberg	03ca902075	window_size: explicit adjustments only Removed the automatic window_size adjustments from _libssh2_channel_read() and instead all channel readers must now make sure to enlarge the window sizes properly themselves. libssh2_channel_read_ex() - the public function, now grows the window size according to the requested buffer size. Applications can still opt to grow the window more on demand. Larger windows tend to give higher performance. sftp_read() now uses the read-ahead logic to figure out a window_size.	2011-09-13 11:21:23 +02:00
Daniel Stenberg	7d58994571	libssh2.h: bump the default window size to 256K	2011-09-13 11:21:23 +02:00
Daniel Stenberg	6d9d44a550	libssh2_userauth_keyboard_interactive.3: fix man warning It seemed to occur due to the excessive line length	2011-09-12 15:41:28 +02:00
Mikhail Gusarov	d343e3405a	Add missing .gitignore entries	2011-09-12 15:38:03 +02:00
Mikhail Gusarov	8d3709f57a	Add manpage syntax checker to 'check' target In virtually every libssh2 release Debian's lintian catches syntax errors in manpages. Prevent it by checking manpages as a part of testsuite.	2011-09-12 15:38:00 +02:00
Daniel Stenberg	d2dc600be7	libssh2_banner_set.3: fix nroff syntax mistake	2011-09-11 19:25:03 +02:00
Guenter Knauf	0f9e81c6f3	Use predefined resource compiler macro.	2011-09-10 16:53:47 +02:00
Guenter Knauf	46792a9fca	Added casts to silent compiler warnings.	2011-09-10 16:38:51 +02:00
Guenter Knauf	b5cd8fe120	Fixed uint64_t printf.	2011-09-10 16:29:29 +02:00
Guenter Knauf	8faefc0a8a	Fixed macro function signatures.	2011-09-10 15:57:46 +02:00
Guenter Knauf	f9afe854d3	NetWare makefile tweaks.	2011-09-10 15:31:25 +02:00
Guenter Knauf	26a9aca598	Removed unused var.	2011-09-10 15:24:08 +02:00
Guenter Knauf	bff91fe2a0	Added 2 samples not mentioned.	2011-09-10 15:20:06 +02:00
Guenter Knauf	e0e8d3b0b7	Dont build x11 sample with MinGW.	2011-09-10 15:09:38 +02:00
Guenter Knauf	52d24bc9d2	Fixed executable file description.	2011-09-10 14:51:35 +02:00
Guenter Knauf	e399a852b9	Removed unused var.	2011-09-10 14:48:06 +02:00
Guenter Knauf	3fb3ba571b	Kill stupid gcc 3.x uninitialized warning.	2011-09-10 14:22:08 +02:00
Guenter Knauf	1f2c1f9e09	Build all examples.	2011-09-10 14:21:05 +02:00
Guenter Knauf	c75ae587c0	More MinGW makefile tweaks. Renamed *.mingw makefiles to GNUmakefile since GNU make picks these up automatically, and therefore win32/Makefile removed.	2011-09-10 14:10:45 +02:00
Guenter Knauf	2e12cfaa23	Removed forgotten WINSOCK_VERSION defines.	2011-09-10 13:40:27 +02:00
Daniel Stenberg	7ed53e21fd	libssh2_session_startup(3) => libssh2_session_handshake(3) Propagate for the current function in docs and examples. libssh2_session_startup() is deprecated.	2011-09-09 23:17:04 +02:00
Daniel Stenberg	7229d989e7	libssh2_banner_set => libssh2_session_banner_get Marked the old function as deprecated. Added the new name in the correct name space with the same arguments and functionality.	2011-09-09 23:11:42 +02:00
Daniel Stenberg	f2c21f6f84	new function: libssh2_session_banner_get Returns the banner from the server handshake Fixes #226	2011-09-09 23:00:05 +02:00
Daniel Stenberg	a6ebc6f9fd	libssh2.h: bump version to 1.4.0 for new function(s)	2011-09-09 22:49:35 +02:00
Daniel Stenberg	87f79f177f	remove embedded CVS/svn tags	2011-09-09 16:12:04 +02:00
liuzl	30ac056cb0	API add:libssh2_sftp_get_channel Return the channel of sftp, then caller can control the channel's behavior. Signed-off-by: liuzl <xieepp@gmail.com>	2011-09-09 16:00:11 +02:00
Daniel Stenberg	c45de9176b	_libssh2_channel_read: react on errors from receive_window_adjust Previously the function would ignore all errors except for EAGAIN.	2011-09-09 10:30:43 +02:00
Daniel Stenberg	ff40c58743	sftp_read: extend and clarify the documentation	2011-09-08 23:02:58 +02:00
Daniel Stenberg	10b66cef08	sftp_read: cap the read ahead maximum amount Now we only go up to LIBSSH2_CHANNEL_WINDOW_DEFAULT30 bytes SFTP read ahead, which currently equals 64K30 == 1966080 bytes.	2011-09-08 22:47:38 +02:00
Daniel Stenberg	81bdcf61f3	_libssh2_channel_read: fix non-blocking window adjusting If EAGAIN is returned when adjusting the receive window, we must not read from the transport directly until we've finished the adjusting.	2011-09-08 14:25:25 +02:00
Guenter Knauf	50d451e307	Fix for systems which need sys/select.h.	2011-09-08 13:53:05 +02:00
Guenter Knauf	3f2b1dea5e	The files were not gone but renamed ...	2011-09-08 11:59:49 +02:00
Daniel Stenberg	7c9b84d1d1	sftp_read: added documenting comment Taken from some recent email conversations I added some descriptions of the logic in sftp_read() to aid readers.	2011-09-06 23:31:07 +02:00
Daniel Stenberg	1ba42ea847	1.3.1: start the work	2011-09-06 23:27:50 +02:00