Add some Unix blurb.
[sgt/putty] / README
1 This is the README for the source archive of PuTTY, a free Win32
2 Telnet and SSH client.
3
4 If you want to rebuild PuTTY from source, we provide a variety of
5 Makefiles and equivalents.
6
7 For building on Windows:
8
9 - Makefile.vc is for command-line builds on MS Visual C++ systems.
10 Type `nmake -f Makefile.vc' to build all the PuTTY binaries.
11
12 (We've also had one report of success building with the
13 OpenWatcom compiler -- www.openwatcom.org -- using Makefile.vc
14 with `wmake -ms -f makefile.vc' and NO_MULTIMON, although we
15 haven't tried this ourselves.)
16
17 - Inside the MSVC subdirectory are MS Visual Studio project files
18 for doing GUI-based builds of the various PuTTY utilities. These
19 have been tested on Visual Studio 6.
20
21 You should be able to build each PuTTY utility by loading the
22 corresponding .dsp file in Visual Studio. For example,
23 MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp
24 builds Plink, and so on.
25
26 - Makefile.bor is for the Borland C compiler. Type `make -f
27 Makefile.bor' to build all the PuTTY binaries.
28
29 - Makefile.cyg is for Cygwin / mingw32 installations. Type `make -f
30 Makefile.cyg' to build all the PuTTY binaries. Note that by
31 default the Pageant WinNT security features and the multiple
32 monitor support are excluded from the Cygwin build, since at the
33 time of writing this Cygwin doesn't include the necessary
34 headers.
35
36 - Makefile.lcc is for lcc-win32. Type `make -f Makefile.lcc'. (You
37 will probably need to specify COMPAT=-DNO_MULTIMON.)
38
39 For building on Unix:
40
41 - unix/Makefile.gtk is for Unix and GTK. If you don't have GTK, you
42 should still be able to build the command-line utilities (PSCP,
43 PSFTP, Plink, PuTTYgen) using this makefile. The makefile expects
44 you to change into the `unix' subdirectory, then run `make -f
45 Makefile.gtk'. Note that Unix PuTTY has mostly only been tested
46 on Linux so far; portability problems such as BSD-style ptys or
47 different header file requirements are expected.
48
49 All of the Makefiles are generated automatically from the file
50 `Recipe' by the Perl script `mkfiles.pl'. Additions and corrections
51 to Recipe and the mkfiles.pl are much more useful than additions and
52 corrections to the alternative Makefiles themselves.
53
54 The PuTTY home web site is
55
56 http://www.chiark.greenend.org.uk/~sgtatham/putty/
57
58 If you want to send bug reports or feature requests, please read the
59 Feedback section of the web site before doing so. Sending one-line
60 reports saying `it doesn't work' will waste your time as much as
61 ours.
62
63 See the file LICENCE for the licence conditions.