According to Frank Dijcks, this cast makes OpenWatcom happier.
[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
8ce999b9 9There are various compile-time directives that you can use to
10disable or modify certain features; it may be necessary to do this
11in some environments. They are documented in `Recipe', and in
12comments in many of the generated Makefiles.
13
b69755a7 14For building on Windows:
7603011f 15
6da41155 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.
7603011f 19
577abbb6 20 Last time we checked, PuTTY built with vanilla VC7, or VC6 with
89c2674b 21 an up-to-date Platform SDK. (It is possible to build with
22 vanilla VC6, but you'll have to remove some functionality with
23 directives such as NO_IPV6.)
577abbb6 24
62793edf 25 (We've also had one report 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.)
29
6da41155 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.
58de2f3c 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
6da41155 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.
7603011f 42
6da41155 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. Note that by default the multiple
46 monitor support is excluded from the Cygwin build, since at the
8fb63331 47 time of writing Cygwin doesn't include the necessary headers.
7603011f 48
6da41155 49 - windows/Makefile.lcc is for lcc-win32. Type `make -f
50 Makefile.lcc' while in the `windows' subdirectory. (You will
51 probably need to specify COMPAT=-DNO_MULTIMON.)
2c228de6 52
985b6440 53 - Inside the windows/DEVCPP subdirectory are Dev-C++ project
54 files for doing GUI-based builds of the various PuTTY utilities.
55
b69755a7 56For building on Unix:
57
76d3a838 58 - unix/configure is for Unix and GTK. If you don't have GTK, you
b69755a7 59 should still be able to build the command-line utilities (PSCP,
76d3a838 60 PSFTP, Plink, PuTTYgen) using this script. To use it, change
61 into the `unix' subdirectory, run `./configure' and then `make'.
577abbb6 62
63 Note that Unix PuTTY has mostly only been tested on Linux so far;
64 portability problems such as BSD-style ptys or different header file
65 requirements are expected.
76d3a838 66
67 - unix/Makefile.gtk is for non-autoconfigured builds. This makefile
68 expects you to change into the `unix' subdirectory, then run `make
577abbb6 69 -f Makefile.gtk'.
b69755a7 70
577abbb6 71 - For the graphical utilities, Gtk+-1.2 is required. Gtk+-2.0 is not
8fb63331 72 yet supported.
73
577abbb6 74 - Both Unix Makefiles have an `install' target. Note that by default
75 it tries to install `man' pages, which you may need to have built
76 using Halibut first -- see below.
142a7757 77
7603011f 78All of the Makefiles are generated automatically from the file
79`Recipe' by the Perl script `mkfiles.pl'. Additions and corrections
80to Recipe and the mkfiles.pl are much more useful than additions and
577abbb6 81corrections to the alternative Makefiles themselves.
82
83The Unix `configure' script and its various requirements are generated
84by the shell script `mkauto.sh', which requires GNU Autoconf, GNU
85Automake, and Gtk; if you've got the source from Subversion rather
86than using one of our source snapshots, you'll need to run this
87yourself.
3d541627 88
142a7757 89Documentation (in various formats including Windows Help and Unix
577abbb6 90`man' pages) is built from the Halibut (`.but') files in the `doc'
91subdirectory using `doc/Makefile'. If you aren't using one of our
92source snapshots, you'll need to do this yourself. Halibut can be
93found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.
142a7757 94
b9c299bb 95The PuTTY home web site is
96
df96b74b 97 http://www.chiark.greenend.org.uk/~sgtatham/putty/
b9c299bb 98
6e9a74eb 99If you want to send bug reports or feature requests, please read the
100Feedback section of the web site before doing so. Sending one-line
101reports saying `it doesn't work' will waste your time as much as
102ours.
b9c299bb 103
104See the file LICENCE for the licence conditions.