Make it clearer that the XP SP2 hotfix is described in the KB article.
[u/mdw/putty] / README
CommitLineData
6e9a74eb 1This is the README for the source archive of PuTTY, a free Win32
2Telnet and SSH client.
b9c299bb 3
58de2f3c 4If you want to rebuild PuTTY from source, we provide a variety of
142a7757 5Makefiles and equivalents. (If you have fetched the source from CVS,
6you'll have to generate the Makefiles yourself -- see below.)
b69755a7 7
8For building on Windows:
7603011f 9
58de2f3c 10 - Makefile.vc is for command-line builds on MS Visual C++ systems.
11 Type `nmake -f Makefile.vc' to build all the PuTTY binaries.
7603011f 12
62793edf 13 (We've also had one report of success building with the
14 OpenWatcom compiler -- www.openwatcom.org -- using Makefile.vc
15 with `wmake -ms -f makefile.vc' and NO_MULTIMON, although we
16 haven't tried this ourselves.)
17
58de2f3c 18 - Inside the MSVC subdirectory are MS Visual Studio project files
19 for doing GUI-based builds of the various PuTTY utilities. These
20 have been tested on Visual Studio 6.
21
22 You should be able to build each PuTTY utility by loading the
23 corresponding .dsp file in Visual Studio. For example,
24 MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp
25 builds Plink, and so on.
26
7603011f 27 - Makefile.bor is for the Borland C compiler. Type `make -f
28 Makefile.bor' to build all the PuTTY binaries.
29
30 - Makefile.cyg is for Cygwin / mingw32 installations. Type `make -f
31 Makefile.cyg' to build all the PuTTY binaries. Note that by
32 default the Pageant WinNT security features and the multiple
33 monitor support are excluded from the Cygwin build, since at the
34 time of writing this Cygwin doesn't include the necessary
35 headers.
36
2c228de6 37 - Makefile.lcc is for lcc-win32. Type `make -f Makefile.lcc'. (You
38 will probably need to specify COMPAT=-DNO_MULTIMON.)
39
b69755a7 40For 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
142a7757 50 There is an `install' target; note that by default it tries to
51 install `man' pages, which need to be built using Halibut first --
52 see below.
53
7603011f 54All of the Makefiles are generated automatically from the file
55`Recipe' by the Perl script `mkfiles.pl'. Additions and corrections
56to Recipe and the mkfiles.pl are much more useful than additions and
57corrections to the alternative Makefiles themselves.
3d541627 58
142a7757 59Documentation (in various formats including Windows Help and Unix
60`man' pages) is to be built from the Halibut (`.but') files in the
61`doc' subdirectory using `doc/Makefile'. Halibut can be found at
62<http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.
63
b9c299bb 64The PuTTY home web site is
65
df96b74b 66 http://www.chiark.greenend.org.uk/~sgtatham/putty/
b9c299bb 67
6e9a74eb 68If you want to send bug reports or feature requests, please read the
69Feedback section of the web site before doing so. Sending one-line
70reports saying `it doesn't work' will waste your time as much as
71ours.
b9c299bb 72
73See the file LICENCE for the licence conditions.