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