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    Last time we checked, PuTTY built with vanilla VC7, or VC6 with
  21    an up-to-date Platform SDK. (It might still be possible to build
  22    with vanilla VC6, but you'll certainly have to remove some
  23    functionality with directives such as NO_IPV6.)
  24
  25    (We've also had reports 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. Version 1.3 is reported to work.)
  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 / MinGW installations. Type
  44    `make -f Makefile.cyg' while in the `windows' subdirectory to
  45    build all the PuTTY binaries.
  46
  47    You'll probably need quite a recent version of the w32api package.
  48    Note that by default the multiple monitor and HTML Help support are
  49    excluded from the Cygwin build, since at the time of writing Cygwin
  50    doesn't include the necessary headers.
  51
  52  - windows/Makefile.lcc is for lcc-win32. Type `make -f
  53    Makefile.lcc' while in the `windows' subdirectory. (You will
  54    probably need to specify COMPAT=-DNO_MULTIMON.)
  55
  56  - Inside the windows/DEVCPP subdirectory are Dev-C++ project
  57    files for doing GUI-based builds of the various PuTTY utilities.
  58
  59 The PuTTY team actively use Makefile.vc (with VC7) and Makefile.cyg
  60 (with mingw32), so we'll probably notice problems with those
  61 toolchains fairly quickly. Please report any problems with the other
  62 toolchains mentioned above.
  63
  64 For building on Unix:
  65
  66  - unix/configure is for Unix and GTK. If you don't have GTK, you
  67    should still be able to build the command-line utilities (PSCP,
  68    PSFTP, Plink, PuTTYgen) using this script. To use it, change into
  69    the `unix' subdirectory, run `./configure' and then `make'. Or you
  70    can do the same in the top-level directory (we provide a little
  71    wrapper that invokes configure one level down), which is more like
  72    a normal Unix source archive but doesn't do so well at keeping the
  73    per-platform stuff in each platform's subdirectory; it's up to you.
  74
  75    Note that Unix PuTTY has mostly only been tested on Linux so far;
  76    portability problems such as BSD-style ptys or different header file
  77    requirements are expected.
  78
  79  - unix/Makefile.gtk and unix/Makefile.ux are for non-autoconfigured
  80    builds. These makefiles expect you to change into the `unix'
  81    subdirectory, then run `make -f Makefile.gtk' or `make -f
  82    Makefile.ux' respectively. Makefile.gtk builds all the programs but
  83    relies on Gtk, whereas Makefile.ux builds only the command-line
  84    utilities and has no Gtk dependence.
  85
  86  - For the graphical utilities, any of Gtk+-1.2, Gtk+-2.0, and Gtk+-3.0
  87    should be supported. If you have more than one installed, you can
  88    manually specify which one you want by giving the option
  89    '--with-gtk=N' to the configure script where N is 1, 2, or 3.
  90    (The default is the newest available, of course.) In the absence
  91    of any Gtk version, the configure script will automatically
  92    construct a Makefile which builds only the command-line utilities;
  93    you can manually create this condition by giving configure the
  94    option '--without-gtk'.
  95
  96  - pterm would like to be setuid or setgid, as appropriate, to permit
  97    it to write records of user logins to /var/run/utmp and
  98    /var/log/wtmp. (Of course it will not use this privilege for
  99    anything else, and in particular it will drop all privileges before
 100    starting up complex subsystems like GTK.) By default the makefile
 101    will not attempt to add privileges to the pterm executable at 'make
 102    install' time, but you can ask it to do so by running configure
 103    with the option '--enable-setuid=USER' or '--enable-setgid=GROUP'.
 104
 105  - The Unix Makefiles have an `install' target. Note that by default
 106    it tries to install `man' pages; if you have fetched the source via
 107    Git then you will need to have built these using Halibut
 108    first - see below.
 109
 110  - It's also possible to build the Windows version of PuTTY to run
 111    on Unix by using Winelib.  To do this, change to the `windows'
 112    directory and run `make -f Makefile.cyg CC=winegcc RC=wrc'.
 113
 114 All of the Makefiles are generated automatically from the file
 115 `Recipe' by the Perl script `mkfiles.pl' (except for the Unix one,
 116 which is generated by the `configure' script; mkfiles.pl only
 117 generates the input to automake). Additions and corrections to Recipe,
 118 mkfiles.pl and/or configure.ac are much more useful than additions and
 119 corrections to the actual Makefiles, Makefile.am or Makefile.in.
 120
 121 The Unix `configure' script and its various requirements are generated
 122 by the shell script `mkauto.sh', which requires GNU Autoconf, GNU
 123 Automake, and Gtk; if you've got the source from Git rather
 124 than using one of our source snapshots, you'll need to run this
 125 yourself. The input file to Automake is generated by mkfiles.pl along
 126 with all the rest of the makefiles, so you will need to run mkfiles.pl
 127 and then mkauto.sh.
 128
 129 Documentation (in various formats including Windows Help and Unix
 130 `man' pages) is built from the Halibut (`.but') files in the `doc'
 131 subdirectory using `doc/Makefile'. If you aren't using one of our
 132 source snapshots, you'll need to do this yourself. Halibut can be
 133 found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.
 134
 135 The PuTTY home web site is
 136
 137     http://www.chiark.greenend.org.uk/~sgtatham/putty/
 138
 139 If you want to send bug reports or feature requests, please read the
 140 Feedback section of the web site before doing so. Sending one-line
 141 reports saying `it doesn't work' will waste your time as much as
 142 ours.
 143
 144 See the file LICENCE for the licence conditions.