Random Unix puttygen improvements highlighted by a post to comp.security.ssh:
[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
21 the Platform SDK.
22
62793edf 23 (We've also had one report of success building with the
24 OpenWatcom compiler -- www.openwatcom.org -- using Makefile.vc
25 with `wmake -ms -f makefile.vc' and NO_MULTIMON, although we
26 haven't tried this ourselves.)
27
6da41155 28 - Inside the windows/MSVC subdirectory are MS Visual Studio project
29 files for doing GUI-based builds of the various PuTTY utilities.
30 These have been tested on Visual Studio 6.
58de2f3c 31
32 You should be able to build each PuTTY utility by loading the
33 corresponding .dsp file in Visual Studio. For example,
34 MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp
35 builds Plink, and so on.
36
6da41155 37 - windows/Makefile.bor is for the Borland C compiler. Type `make -f
38 Makefile.bor' while in the `windows' subdirectory to build all
39 the PuTTY binaries.
7603011f 40
6da41155 41 - windows/Makefile.cyg is for Cygwin / mingw32 installations. Type
42 `make -f Makefile.cyg' while in the `windows' subdirectory to
43 build all the PuTTY binaries. Note that by default the multiple
44 monitor support is excluded from the Cygwin build, since at the
8fb63331 45 time of writing Cygwin doesn't include the necessary headers.
7603011f 46
6da41155 47 - windows/Makefile.lcc is for lcc-win32. Type `make -f
48 Makefile.lcc' while in the `windows' subdirectory. (You will
49 probably need to specify COMPAT=-DNO_MULTIMON.)
2c228de6 50
985b6440 51 - Inside the windows/DEVCPP subdirectory are Dev-C++ project
52 files for doing GUI-based builds of the various PuTTY utilities.
53
b69755a7 54For building on Unix:
55
76d3a838 56 - unix/configure is for Unix and GTK. If you don't have GTK, you
b69755a7 57 should still be able to build the command-line utilities (PSCP,
76d3a838 58 PSFTP, Plink, PuTTYgen) using this script. To use it, change
59 into the `unix' subdirectory, run `./configure' and then `make'.
577abbb6 60
61 Note that Unix PuTTY has mostly only been tested on Linux so far;
62 portability problems such as BSD-style ptys or different header file
63 requirements are expected.
76d3a838 64
65 - unix/Makefile.gtk is for non-autoconfigured builds. This makefile
66 expects you to change into the `unix' subdirectory, then run `make
577abbb6 67 -f Makefile.gtk'.
b69755a7 68
577abbb6 69 - For the graphical utilities, Gtk+-1.2 is required. Gtk+-2.0 is not
8fb63331 70 yet supported.
71
577abbb6 72 - Both Unix Makefiles have an `install' target. Note that by default
73 it tries to install `man' pages, which you may need to have built
74 using Halibut first -- see below.
142a7757 75
7603011f 76All of the Makefiles are generated automatically from the file
77`Recipe' by the Perl script `mkfiles.pl'. Additions and corrections
78to Recipe and the mkfiles.pl are much more useful than additions and
577abbb6 79corrections to the alternative Makefiles themselves.
80
81The Unix `configure' script and its various requirements are generated
82by the shell script `mkauto.sh', which requires GNU Autoconf, GNU
83Automake, and Gtk; if you've got the source from Subversion rather
84than using one of our source snapshots, you'll need to run this
85yourself.
3d541627 86
142a7757 87Documentation (in various formats including Windows Help and Unix
577abbb6 88`man' pages) is built from the Halibut (`.but') files in the `doc'
89subdirectory using `doc/Makefile'. If you aren't using one of our
90source snapshots, you'll need to do this yourself. Halibut can be
91found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.
142a7757 92
b9c299bb 93The PuTTY home web site is
94
df96b74b 95 http://www.chiark.greenend.org.uk/~sgtatham/putty/
b9c299bb 96
6e9a74eb 97If you want to send bug reports or feature requests, please read the
98Feedback section of the web site before doing so. Sending one-line
99reports saying `it doesn't work' will waste your time as much as
100ours.
b9c299bb 101
102See the file LICENCE for the licence conditions.