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 Git, 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    As of 2017, we successfully compile PuTTY with both Visual Studio
  21    7 (2003) and Visual Studio 14 (2015), so our guess is that it will
  22    probably build with versions in between those as well.
  23
  24  - Inside the windows/MSVC subdirectory are MS Visual Studio project
  25    files for doing GUI-based builds of the various PuTTY utilities.
  26    These have been tested on Visual Studio 7 and 10.
  27
  28    You should be able to build each PuTTY utility by loading the
  29    corresponding .dsp file in Visual Studio. For example,
  30    MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp
  31    builds Plink, and so on.
  32
  33  - windows/Makefile.bor is for the Borland C compiler. Type `make -f
  34    Makefile.bor' while in the `windows' subdirectory to build all
  35    the PuTTY binaries.
  36
  37  - windows/Makefile.mgw is for MinGW / Cygwin installations. Type
  38    `make -f Makefile.mgw' while in the `windows' subdirectory to
  39    build all the PuTTY binaries.
  40
  41    MinGW and friends can lag behind other toolchains in their support
  42    for the Windows API. Compile-time levers are provided to exclude
  43    some features; the defaults are set appropriately for the
  44    'mingw-w64' cross-compiler provided with Ubuntu 14.04. If you are
  45    using an older toolchain, you may need to exclude more features;
  46    alternatively, you may find that upgrading to a recent version of
  47    the 'w32api' package helps.
  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 The PuTTY team actively use Makefile.vc (with VC7) and Makefile.mgw
  57 (with mingw32), so we'll probably notice problems with those
  58 toolchains fairly quickly. Please report any problems with the other
  59 toolchains mentioned above.
  60
  61 For building on Unix:
  62
  63  - unix/configure is for Unix and GTK. If you don't have GTK, you
  64    should still be able to build the command-line utilities (PSCP,
  65    PSFTP, Plink, PuTTYgen) using this script. To use it, change into
  66    the `unix' subdirectory, run `./configure' and then `make'. Or you
  67    can do the same in the top-level directory (we provide a little
  68    wrapper that invokes configure one level down), which is more like
  69    a normal Unix source archive but doesn't do so well at keeping the
  70    per-platform stuff in each platform's subdirectory; it's up to you.
  71
  72  - unix/Makefile.gtk and unix/Makefile.ux are for non-autoconfigured
  73    builds. These makefiles expect you to change into the `unix'
  74    subdirectory, then run `make -f Makefile.gtk' or `make -f
  75    Makefile.ux' respectively. Makefile.gtk builds all the programs but
  76    relies on Gtk, whereas Makefile.ux builds only the command-line
  77    utilities and has no Gtk dependence.
  78
  79  - For the graphical utilities, any of Gtk+-1.2, Gtk+-2.0, and Gtk+-3.0
  80    should be supported. If you have more than one installed, you can
  81    manually specify which one you want by giving the option
  82    '--with-gtk=N' to the configure script where N is 1, 2, or 3.
  83    (The default is the newest available, of course.) In the absence
  84    of any Gtk version, the configure script will automatically
  85    construct a Makefile which builds only the command-line utilities;
  86    you can manually create this condition by giving configure the
  87    option '--without-gtk'.
  88
  89  - pterm would like to be setuid or setgid, as appropriate, to permit
  90    it to write records of user logins to /var/run/utmp and
  91    /var/log/wtmp. (Of course it will not use this privilege for
  92    anything else, and in particular it will drop all privileges before
  93    starting up complex subsystems like GTK.) By default the makefile
  94    will not attempt to add privileges to the pterm executable at 'make
  95    install' time, but you can ask it to do so by running configure
  96    with the option '--enable-setuid=USER' or '--enable-setgid=GROUP'.
  97
  98  - The Unix Makefiles have an `install' target. Note that by default
  99    it tries to install `man' pages; if you have fetched the source via
 100    Git then you will need to have built these using Halibut
 101    first - see below.
 102
 103  - It's also possible to build the Windows version of PuTTY to run
 104    on Unix by using Winelib.  To do this, change to the `windows'
 105    directory and run `make -f Makefile.mgw CC=winegcc RC=wrc'.
 106
 107 All of the Makefiles are generated automatically from the file
 108 `Recipe' by the Perl script `mkfiles.pl' (except for the Unix one,
 109 which is generated by the `configure' script; mkfiles.pl only
 110 generates the input to automake). Additions and corrections to Recipe,
 111 mkfiles.pl and/or configure.ac are much more useful than additions and
 112 corrections to the actual Makefiles, Makefile.am or Makefile.in.
 113
 114 The Unix `configure' script and its various requirements are generated
 115 by the shell script `mkauto.sh', which requires GNU Autoconf, GNU
 116 Automake, and Gtk; if you've got the source from Git rather
 117 than using one of our source snapshots, you'll need to run this
 118 yourself. The input file to Automake is generated by mkfiles.pl along
 119 with all the rest of the makefiles, so you will need to run mkfiles.pl
 120 and then mkauto.sh.
 121
 122 Documentation (in various formats including Windows Help and Unix
 123 `man' pages) is built from the Halibut (`.but') files in the `doc'
 124 subdirectory using `doc/Makefile'. If you aren't using one of our
 125 source snapshots, you'll need to do this yourself. Halibut can be
 126 found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.
 127
 128 The PuTTY home web site is
 129
 130     http://www.chiark.greenend.org.uk/~sgtatham/putty/
 131
 132 If you want to send bug reports or feature requests, please read the
 133 Feedback section of the web site before doing so. Sending one-line
 134 reports saying `it doesn't work' will waste your time as much as
 135 ours.
 136
 137 See the file LICENCE for the licence conditions.