Copyright 1997, 1998 Tadayoshi Kohno (kohno@cs.colorado.edu)
All Rights Reserved.
See the LICENSE file.


-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING

This program is still in development.  There may be bugs.

WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-


This program uses cryptogaphic software written by Eric Young
(eay@cryptsoft.com).  The package in reference is SSLeay and its
associated libraries (ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL).
The current version of libSSH uses SSLeay-0.8.1.

This library is based off SSH protocol version 1.5 developed by
Tatu Ylonen and published in draft-ylonen-ssh-protocol-00.txt
and dated 15 November 1995.  It's a wonderful protocol and has
gained incredible popularity.  libSSH and its derivitive WinSSH
started as attempts to provide freely available SSH clients for
Windows 95/NT machines.  Hopefully this "platform-independant" library
will find its way into other programs as well.

Additional information about libSSH and WinSSH is available at
http://ugrad-www.cs.colorado.edu/~kohno/projects/ssh.html or
http://csel.cs.colorado.edu/~kohno/projects/ssh.html


1: How to install libSSH
	
	1.0 Preliminaries (all systems)
		SSLeay must first be built and installed.  It is
		available at ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL


	1.1 Unix Systems
		Make sure the proper OS is defined in the Makefile
		and the  IFLAGS and LFLAGS variables are set to
		the location of the SSLeay include file and libraries

		Make sure INSTALLTOP is set to the top of where you
		would like to install libSSH (libssh.a will go to
		$(INSTALLTOP)/lib, ...)
		
		Next type "make".

		"make install" will install libssh.a and the header
		files.  If you don't actually want to install libSSH
		but just built it for use with a specific application,
		you can point that application to look for libraries
		and include files in the libssh source directory.

		If you have problems, you might take a look at
		ssh_types.h.  Chances are there's a type problem
		(for example, some SunOS systems don't define a
		uint16_t while others do).  If your
		system is not one of the ones listed, you may need
		to scrounge around the system include files looking
		for a uint16_t type or something to typedef to it.

		Please see the PORTING section of the DOCUMENTATION file


	1.2 Windows 95/NT Systems
		Please see the WINDOWS.txt file.

		Also, please take a look at the PORTING section of the
		DOCUMENTATION file.

2: How to use libSSH and other info

	This information is available in the DOCUMENTATION file

3: Bugs/todo list

	Please see the BUGS_TODO file.

