]>
Commit | Line | Data |
---|---|---|
1c1af145 | 1 | This is the README for the source archive of PuTTY, a free Win32 |
2 | and Unix Telnet and SSH client. | |
3 | ||
4 | If you want to rebuild PuTTY from source, we provide a variety of | |
5 | Makefiles and equivalents. (If you have fetched the source from | |
6 | Subversion, you'll have to generate the Makefiles yourself -- see | |
7 | below.) | |
8 | ||
9 | There are various compile-time directives that you can use to | |
10 | disable or modify certain features; it may be necessary to do this | |
11 | in some environments. They are documented in `Recipe', and in | |
12 | comments in many of the generated Makefiles. | |
13 | ||
14 | For building on Windows: | |
15 | ||
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. | |
19 | ||
20 | Last time we checked, PuTTY built with vanilla VC7, or VC6 with | |
21 | an up-to-date Platform SDK. (It might still be possible to build | |
22 | with vanilla VC6, but you'll certainly have to remove some | |
23 | functionality with directives such as NO_IPV6.) | |
24 | ||
25 | (We've also had reports 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. Version 1.3 is reported to work.) | |
29 | ||
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. | |
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 | ||
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. | |
42 | ||
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. | |
46 | ||
47 | You'll probably need quite a recent version of the w32api package. | |
48 | Note that by default the multiple monitor and HTML Help support are | |
49 | excluded from the Cygwin build, since at the time of writing Cygwin | |
50 | doesn't include the necessary headers. | |
51 | ||
52 | - windows/Makefile.lcc is for lcc-win32. Type `make -f | |
53 | Makefile.lcc' while in the `windows' subdirectory. (You will | |
54 | probably need to specify COMPAT=-DNO_MULTIMON.) | |
55 | ||
56 | - Inside the windows/DEVCPP subdirectory are Dev-C++ project | |
57 | files for doing GUI-based builds of the various PuTTY utilities. | |
58 | ||
59 | The PuTTY team actively use Makefile.vc (with VC7) and Makefile.cyg | |
60 | (with mingw32), so we'll probably notice problems with those | |
61 | toolchains fairly quickly. Please report any problems with the other | |
62 | toolchains mentioned above. | |
63 | ||
64 | For building on Unix: | |
65 | ||
66 | - unix/configure is for Unix and GTK. If you don't have GTK, you | |
67 | should still be able to build the command-line utilities (PSCP, | |
68 | PSFTP, Plink, PuTTYgen) using this script. To use it, change | |
69 | into the `unix' subdirectory, run `./configure' and then `make'. | |
70 | ||
71 | Note that Unix PuTTY has mostly only been tested on Linux so far; | |
72 | portability problems such as BSD-style ptys or different header file | |
73 | requirements are expected. | |
74 | ||
75 | - unix/Makefile.gtk and unix/Makefile.ux are for non-autoconfigured | |
76 | builds. These makefiles expect you to change into the `unix' | |
77 | subdirectory, then run `make -f Makefile.gtk' or `make -f | |
78 | Makefile.ux' respectively. Makefile.gtk builds all the programs but | |
79 | relies on Gtk, whereas Makefile.ux builds only the command-line | |
80 | utilities and has no Gtk dependence. | |
81 | ||
82 | - For the graphical utilities, Gtk+-1.2 and Gtk+-2.0 should both be | |
83 | supported. | |
84 | ||
85 | - Both Unix Makefiles have an `install' target. Note that by default | |
86 | it tries to install `man' pages, which you may need to have built | |
87 | using Halibut first -- see below. | |
88 | ||
89 | All of the Makefiles are generated automatically from the file | |
90 | `Recipe' by the Perl script `mkfiles.pl'. Additions and corrections | |
91 | to Recipe and the mkfiles.pl are much more useful than additions and | |
92 | corrections to the alternative Makefiles themselves. | |
93 | ||
94 | The Unix `configure' script and its various requirements are generated | |
95 | by the shell script `mkauto.sh', which requires GNU Autoconf, GNU | |
96 | Automake, and Gtk; if you've got the source from Subversion rather | |
97 | than using one of our source snapshots, you'll need to run this | |
98 | yourself. | |
99 | ||
100 | Documentation (in various formats including Windows Help and Unix | |
101 | `man' pages) is built from the Halibut (`.but') files in the `doc' | |
102 | subdirectory using `doc/Makefile'. If you aren't using one of our | |
103 | source snapshots, you'll need to do this yourself. Halibut can be | |
104 | found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>. | |
105 | ||
106 | The PuTTY home web site is | |
107 | ||
108 | http://www.chiark.greenend.org.uk/~sgtatham/putty/ | |
109 | ||
110 | If you want to send bug reports or feature requests, please read the | |
111 | Feedback section of the web site before doing so. Sending one-line | |
112 | reports saying `it doesn't work' will waste your time as much as | |
113 | ours. | |
114 | ||
115 | See the file LICENCE for the licence conditions. |