On some systems (NetBSD 1.6 and Solaris 9, at least), GCC doesn't understand
[u/mdw/putty] / README
CommitLineData
6e9a74eb 1This is the README for the source archive of PuTTY, a free Win32
8fb63331 2and Unix Telnet and SSH client.
b9c299bb 3
58de2f3c 4If you want to rebuild PuTTY from source, we provide a variety of
4494be0a 5Makefiles and equivalents. (If you have fetched the source from
6Subversion, you'll have to generate the Makefiles yourself -- see
7below.)
b69755a7 8
9For building on Windows:
7603011f 10
6da41155 11 - windows/Makefile.vc is for command-line builds on MS Visual C++
12 systems. Change into the `windows' subdirectory and type `nmake
13 -f Makefile.vc' to build all the PuTTY binaries.
7603011f 14
62793edf 15 (We've also had one report of success building with the
16 OpenWatcom compiler -- www.openwatcom.org -- using Makefile.vc
17 with `wmake -ms -f makefile.vc' and NO_MULTIMON, although we
18 haven't tried this ourselves.)
19
6da41155 20 - Inside the windows/MSVC subdirectory are MS Visual Studio project
21 files for doing GUI-based builds of the various PuTTY utilities.
22 These have been tested on Visual Studio 6.
58de2f3c 23
24 You should be able to build each PuTTY utility by loading the
25 corresponding .dsp file in Visual Studio. For example,
26 MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp
27 builds Plink, and so on.
28
6da41155 29 - windows/Makefile.bor is for the Borland C compiler. Type `make -f
30 Makefile.bor' while in the `windows' subdirectory to build all
31 the PuTTY binaries.
7603011f 32
6da41155 33 - windows/Makefile.cyg is for Cygwin / mingw32 installations. Type
34 `make -f Makefile.cyg' while in the `windows' subdirectory to
35 build all the PuTTY binaries. Note that by default the multiple
36 monitor support is excluded from the Cygwin build, since at the
8fb63331 37 time of writing Cygwin doesn't include the necessary headers.
7603011f 38
6da41155 39 - windows/Makefile.lcc is for lcc-win32. Type `make -f
40 Makefile.lcc' while in the `windows' subdirectory. (You will
41 probably need to specify COMPAT=-DNO_MULTIMON.)
2c228de6 42
b69755a7 43For building on Unix:
44
45 - unix/Makefile.gtk is for Unix and GTK. If you don't have GTK, you
46 should still be able to build the command-line utilities (PSCP,
47 PSFTP, Plink, PuTTYgen) using this makefile. The makefile expects
48 you to change into the `unix' subdirectory, then run `make -f
49 Makefile.gtk'. Note that Unix PuTTY has mostly only been tested
50 on Linux so far; portability problems such as BSD-style ptys or
51 different header file requirements are expected.
52
8fb63331 53 For the graphical utilities, Gtk+-1.2 is required. Gtk+-2.0 is not
54 yet supported.
55
142a7757 56 There is an `install' target; note that by default it tries to
57 install `man' pages, which need to be built using Halibut first --
58 see below.
59
7603011f 60All of the Makefiles are generated automatically from the file
61`Recipe' by the Perl script `mkfiles.pl'. Additions and corrections
62to Recipe and the mkfiles.pl are much more useful than additions and
63corrections to the alternative Makefiles themselves.
3d541627 64
142a7757 65Documentation (in various formats including Windows Help and Unix
66`man' pages) is to be built from the Halibut (`.but') files in the
67`doc' subdirectory using `doc/Makefile'. Halibut can be found at
68<http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.
69
b9c299bb 70The PuTTY home web site is
71
df96b74b 72 http://www.chiark.greenend.org.uk/~sgtatham/putty/
b9c299bb 73
6e9a74eb 74If you want to send bug reports or feature requests, please read the
75Feedback section of the web site before doing so. Sending one-line
76reports saying `it doesn't work' will waste your time as much as
77ours.
b9c299bb 78
79See the file LICENCE for the licence conditions.