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 For building on Windows:
  10
  11  - Makefile.vc is for command-line builds on MS Visual C++ systems.
  12    Type `nmake -f Makefile.vc' to build all the PuTTY binaries.
  13
  14    (We've also had one report of success building with the
  15    OpenWatcom compiler -- www.openwatcom.org -- using Makefile.vc
  16    with `wmake -ms -f makefile.vc' and NO_MULTIMON, although we
  17    haven't tried this ourselves.)
  18
  19  - Inside the MSVC subdirectory are MS Visual Studio project files
  20    for doing GUI-based builds of the various PuTTY utilities. These
  21    have been tested on Visual Studio 6.
  22
  23    You should be able to build each PuTTY utility by loading the
  24    corresponding .dsp file in Visual Studio. For example,
  25    MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp
  26    builds Plink, and so on.
  27
  28  - Makefile.bor is for the Borland C compiler. Type `make -f
  29    Makefile.bor' to build all the PuTTY binaries.
  30
  31  - Makefile.cyg is for Cygwin / mingw32 installations. Type `make -f
  32    Makefile.cyg' to build all the PuTTY binaries. Note that by
  33    default the Pageant WinNT security features and the multiple
  34    monitor support are excluded from the Cygwin build, since at the
  35    time of writing Cygwin doesn't include the necessary headers.
  36
  37  - Makefile.lcc is for lcc-win32. Type `make -f Makefile.lcc'. (You
  38    will probably need to specify COMPAT=-DNO_MULTIMON.)
  39
  40 For building on Unix:
  41
  42  - unix/Makefile.gtk is for Unix and GTK. If you don't have GTK, you
  43    should still be able to build the command-line utilities (PSCP,
  44    PSFTP, Plink, PuTTYgen) using this makefile. The makefile expects
  45    you to change into the `unix' subdirectory, then run `make -f
  46    Makefile.gtk'. Note that Unix PuTTY has mostly only been tested
  47    on Linux so far; portability problems such as BSD-style ptys or
  48    different header file requirements are expected.
  49
  50    For the graphical utilities, Gtk+-1.2 is required. Gtk+-2.0 is not
  51    yet supported.
  52
  53    There is an `install' target; note that by default it tries to
  54    install `man' pages, which need to be built using Halibut first --
  55    see below.
  56
  57 All of the Makefiles are generated automatically from the file
  58 `Recipe' by the Perl script `mkfiles.pl'. Additions and corrections
  59 to Recipe and the mkfiles.pl are much more useful than additions and
  60 corrections to the alternative Makefiles themselves.
  61
  62 Documentation (in various formats including Windows Help and Unix
  63 `man' pages) is to be built from the Halibut (`.but') files in the
  64 `doc' subdirectory using `doc/Makefile'. Halibut can be found at
  65 <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.
  66
  67 The PuTTY home web site is
  68
  69     http://www.chiark.greenend.org.uk/~sgtatham/putty/
  70
  71 If you want to send bug reports or feature requests, please read the
  72 Feedback section of the web site before doing so. Sending one-line
  73 reports saying `it doesn't work' will waste your time as much as
  74 ours.
  75
  76 See the file LICENCE for the licence conditions.