1 This is the README for the source archive of PuTTY, a free Win32
2 and Unix Telnet and SSH client.
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
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.
14 For building on Windows:
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.
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.)
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.)
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.
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.
39 - windows/Makefile.bor is for the Borland C compiler. Type `make -f
40 Makefile.bor' while in the `windows' subdirectory to build all
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.
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.
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.)
56 - Inside the windows/DEVCPP subdirectory are Dev-C++ project
57 files for doing GUI-based builds of the various PuTTY utilities.
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.
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
69 into the `unix' subdirectory, run `./configure' and then `make'.
71 Note that Unix PuTTY has mostly only been tested on Linux so far;
72 portability problems such as BSD-style ptys or different header file
73 requirements are expected.
75 - unix/Makefile.gtk and unix/Makefile.ux are for non-autoconfigured
76 builds. These makefiles expect you to change into the `unix'
77 subdirectory, then run `make -f Makefile.gtk' or `make -f
78 Makefile.ux' respectively. Makefile.gtk builds all the programs but
79 relies on Gtk, whereas Makefile.ux builds only the command-line
80 utilities and has no Gtk dependence.
82 - For the graphical utilities, Gtk+-1.2 and Gtk+-2.0 should both be
83 supported. In the absence of either, the configure script will
84 automatically construct a Makefile which builds only the
85 command-line utilities.
87 - pterm would like to be setuid or setgid, as appropriate, to permit
88 it to write records of user logins to /var/run/utmp and
89 /var/log/wtmp. (Of course it will not use this privilege for
90 anything else, and in particular it will drop all privileges before
91 starting up complex subsystems like GTK.) By default the makefile
92 will not attempt to add privileges to the pterm executable at 'make
93 install' time, but you can ask it to do so by running configure
94 with the option '--enable-setuid=USER' or '--enable-setgid=GROUP'.
96 - The Unix Makefiles have an `install' target. Note that by default
97 it tries to install `man' pages; if you have fetched the source via
98 Subversion then you will need to have built these using Halibut
101 All of the Makefiles are generated automatically from the file
102 `Recipe' by the Perl script `mkfiles.pl' (except for the Unix one,
103 which is generated by the `configure' script; mkfiles.pl only
104 generates the input to automake). Additions and corrections to Recipe,
105 mkfiles.pl and/or configure.ac are much more useful than additions and
106 corrections to the actual Makefiles, Makefile.am or Makefile.in.
108 The Unix `configure' script and its various requirements are generated
109 by the shell script `mkauto.sh', which requires GNU Autoconf, GNU
110 Automake, and Gtk; if you've got the source from Subversion rather
111 than using one of our source snapshots, you'll need to run this
112 yourself. The input file to Automake is generated by mkfiles.pl along
113 with all the rest of the makefiles, so you will need to run mkfiles.pl
116 Documentation (in various formats including Windows Help and Unix
117 `man' pages) is built from the Halibut (`.but') files in the `doc'
118 subdirectory using `doc/Makefile'. If you aren't using one of our
119 source snapshots, you'll need to do this yourself. Halibut can be
120 found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.
122 The PuTTY home web site is
124 http://www.chiark.greenend.org.uk/~sgtatham/putty/
126 If you want to send bug reports or feature requests, please read the
127 Feedback section of the web site before doing so. Sending one-line
128 reports saying `it doesn't work' will waste your time as much as
131 See the file LICENCE for the licence conditions.
~mdw / sgt / putty / blob