README

   1 This is the README for the source archive of PuTTY, a free Win32
   2 and Unix Telnet and SSH client.
   3
   4 If you want to rebuild PuTTY from source, we provide a variety of
   5 Makefiles and equivalents. (If you have fetched the source from
   6 Subversion, you'll have to generate the Makefiles yourself -- see
   7 below.)
   8
   9 There are various compile-time directives that you can use to
  10 disable or modify certain features; it may be necessary to do this
  11 in some environments. They are documented in `Recipe', and in
  12 comments in many of the generated Makefiles.
  13
  14 For building on Windows:
  15
  16  - windows/Makefile.vc is for command-line builds on MS Visual C++
  17    systems. Change into the `windows' subdirectory and type `nmake
  18    -f Makefile.vc' to build all the PuTTY binaries.
  19
  20    Last time we checked, PuTTY built with vanilla VC7, or VC6 with
  21    an up-to-date Platform SDK. (It is possible to build with
  22    vanilla VC6, but you'll have to remove some functionality with
  23    directives such as NO_IPV6.)
  24
  25    (We've also had one report of success building with the
  26    OpenWatcom compiler -- www.openwatcom.org -- using Makefile.vc
  27    with `wmake -ms -f makefile.vc' and NO_MULTIMON, although we
  28    haven't tried this ourselves.)
  29
  30  - Inside the windows/MSVC subdirectory are MS Visual Studio project
  31    files for doing GUI-based builds of the various PuTTY utilities.
  32    These have been tested on Visual Studio 6.
  33
  34    You should be able to build each PuTTY utility by loading the
  35    corresponding .dsp file in Visual Studio. For example,
  36    MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp
  37    builds Plink, and so on.
  38
  39  - windows/Makefile.bor is for the Borland C compiler. Type `make -f
  40    Makefile.bor' while in the `windows' subdirectory to build all
  41    the PuTTY binaries.
  42
  43  - windows/Makefile.cyg is for Cygwin / mingw32 installations. Type
  44    `make -f Makefile.cyg' while in the `windows' subdirectory to
  45    build all the PuTTY binaries. Note that by default the multiple
  46    monitor support is excluded from the Cygwin build, since at the
  47    time of writing Cygwin doesn't include the necessary headers.
  48
  49  - windows/Makefile.lcc is for lcc-win32. Type `make -f
  50    Makefile.lcc' while in the `windows' subdirectory. (You will
  51    probably need to specify COMPAT=-DNO_MULTIMON.)
  52
  53  - Inside the windows/DEVCPP subdirectory are Dev-C++ project
  54    files for doing GUI-based builds of the various PuTTY utilities.
  55
  56 For building on Unix:
  57
  58  - unix/configure is for Unix and GTK. If you don't have GTK, you
  59    should still be able to build the command-line utilities (PSCP,
  60    PSFTP, Plink, PuTTYgen) using this script. To use it, change
  61    into the `unix' subdirectory, run `./configure' and then `make'.
  62
  63    Note that Unix PuTTY has mostly only been tested on Linux so far;
  64    portability problems such as BSD-style ptys or different header file
  65    requirements are expected.
  66
  67  - unix/Makefile.gtk is for non-autoconfigured builds. This makefile
  68    expects you to change into the `unix' subdirectory, then run `make
  69    -f Makefile.gtk'.
  70
  71  - For the graphical utilities, Gtk+-1.2 is required. Gtk+-2.0 is not
  72    yet supported.
  73
  74  - Both Unix Makefiles have an `install' target. Note that by default
  75    it tries to install `man' pages, which you may need to have built
  76    using Halibut first -- see below.
  77
  78 All of the Makefiles are generated automatically from the file
  79 `Recipe' by the Perl script `mkfiles.pl'. Additions and corrections
  80 to Recipe and the mkfiles.pl are much more useful than additions and
  81 corrections to the alternative Makefiles themselves.
  82
  83 The Unix `configure' script and its various requirements are generated
  84 by the shell script `mkauto.sh', which requires GNU Autoconf, GNU
  85 Automake, and Gtk; if you've got the source from Subversion rather
  86 than using one of our source snapshots, you'll need to run this
  87 yourself.
  88
  89 Documentation (in various formats including Windows Help and Unix
  90 `man' pages) is built from the Halibut (`.but') files in the `doc'
  91 subdirectory using `doc/Makefile'. If you aren't using one of our
  92 source snapshots, you'll need to do this yourself. Halibut can be
  93 found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.
  94
  95 The PuTTY home web site is
  96
  97     http://www.chiark.greenend.org.uk/~sgtatham/putty/
  98
  99 If you want to send bug reports or feature requests, please read the
 100 Feedback section of the web site before doing so. Sending one-line
 101 reports saying `it doesn't work' will waste your time as much as
 102 ours.
 103
 104 See the file LICENCE for the licence conditions.