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

How to Install libSSH under Windows 95/NT:
	
	1: Getting and compiling SSLeay

	   The SSLeay library is responsible for all the cryptographic
	   routines used by libSSH.  It is available at
	   ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL .  This version of
	   libSSH has been tested with SSLeay-0.8.1

	   To compile SSLeay under Windows 95/NT, you will first
	   need to get Perl (www.perl.com).  Compiling Perl
	   under Windows 95 is unsupported, so you may want to
	   just get the binaries if you're not running NT.

	   The file MICROSOFT in the SSLeay distribution takes you
	   step-by-step through compiling SSLeay.  One additional
	   recommendation is that, if your paths are not initialized
	   to include various Visual C++ components, you may need
	   to run VCVARS32.BAT.  For me, that file is installed
	   as "C:/Program Files/DevStudio/vc/bin/VCVARS32.BAT".  It
	   may be somewhere else for you.

	   SSLeay's MICROSOFT file will then take you step-by-step
	   through compiling the libraries.  To summarize, this should
	   just be 
	   	perl Configure VC-WIN32
	   	nmake -f ms\ntdll.mak
	   You can also cd to the "ms" directory and run "test" once
	   the compilation completes.

	   The MICROSOFT file doesn't really deal with what to do
	   once you have built the libraries and programs.  Unless you
	   want to mess with the paths to compile libSSH, I suggest
	   you copy SSLeay's header files to wherever Visual C++
	   expects them.  You should also copy the .lib files
	   to Visual C++'s expected location.  Finally, SSLeay's DLLs
	   (.dll files) should be copied to your system's location.  
	   Of couse, you can really copy those files to wherever is 
	   most logical for your system's organization.  I am just 
	   recommending what is simple and has worked for me.  All the
	   files to copy should appear in the "out" subdirectory.  libSSH
	   does not need the programs that appear in the out
	   directory.



	2: Getting and compiling the ZLIB compression library

	   Documentation for ZLIB is available at
	   http://www.cdrom.com/pub/infozip/zlib/ .  You can also
	   get the source from ftp://ftp.cdrom.com/pub/infozip/zlib/ .
	   libSSH has been tested with zlib-1.1.2 .

	   The website http://www.winimage.com/zLibDll/ has information
	   about using ZLIB under Windows.  If you do not want to
	   compile zlib yourself, you can obtain a pre-built dll and
	   import library from this page (zlib112dll.zip).  You will
	   still need to get the source so libSSH can include the
	   zlib.h header file.

	   If you do decide to compile ZLIB rather than grab the
	   binaries, you may still benifit from patches/etc found
	   at the ZLIB DLL website listed above.


	   Once you have everything, put the header files (zlib.h
	   and zconf.h), zlib.dll, and zlib.lib in the same place that
	   you put the SSLeay headers, dlls, and libraries.  (Or, if
	   you know what you're doing, wherever you want).

	   I would suggest not using the zlib static libraries because,
	   internally, libSSH needs to define ZLIB_DLL before including
	   the zlib.h header file.  You can, of couse, mess with
	   this yourself if you would really like to use a static
	   version of the compression libraries.  Perhaps a fix can
	   be incorperated in future releases of libSSH.


	3: Compiling libSSH

	   The actual libSSH source is in the libssh subdirectory.

	   (Using the Makefile)
	   libSSH installation procedures have only been setup for use
	   with Microsoft Visual C++ (I use version 5.0).

	   First, take a look at the Makefile.VC and verify that things
	   will work on your system.  Hopefully everything will work
	   out-of-the-box.  The Makefile.VC file was actually generated
	   from the Visual C++ Developers Studio.

	   Run
		nmake -f Makefile.VC
	   from the MSDOS Command Prompt after "cd"ing into the directory
	   in which you extracted libSSH.  The resulting library should
	   appear in either the Release or the Debug directory.

	   Now install libSSH by copying the resulting library (libssh.lib)
	   to the desired location.  Also copy all the header files to
	   wherever you want them to go.  For me this ended up being
	   C:\Program Files\DevStudio\VC\lib and
	   C:\Program Files\DevStudio\VC\include, respectively.

	   (Creating a project)
	   Alternatively, you could throw all these files into a
	   "Win32 Static Library" project and build libssh that way [If you
	   do so, you may need to define SSH_USE_WINSOCK2 in the
	   Project Settings under C/C++ and Preprocessor definitions]

	4: Using libSSH

	   Once libSSH has been installed as per the above instructions,
	   you should be able to use libSSH in your applications by
	   #include'ing ssh.h and linking with libssh.lib.

	   You may wish to look at the sample Unix client in
	   the unix_ssh subdirectory (it is really old and will
	   be updated before the official release).  To get a feel
	   for how libSSH works, it might be a good idea to
	   read the DOCUMENTATION file.

	5: Problems?
	    If you encounter problems with building libSSH under
	    Windows 95/NT, please contact me or the libssh mailing list
	    (libssh@cs.colorado.edu).  I have tested the library in
	    my own SSH client on both Windows 95 and Windows NT, but
	    these minimal tests are in no ways exhaustive.

	    Also, if you can provide any additional information or
	    insight into how to build SSLeay, ZLIB, or libSSH that
	    you think might be useful for others, please let me
	    know and I will try to include the information in
	    future releases.

