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