| | 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 is possible to build with |
| | 22 | vanilla VC6, but you'll have to remove some functionality with |
| | 23 | 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 and Makefile.cyg, so we'll |
| | 60 | probably notice problems with those toolchains fairly quickly. Please |
| | 61 | report any problems with the other toolchains mentioned above. |
| | 62 | |
| | 63 | For building on Unix: |
| | 64 | |
| | 65 | - unix/configure is for Unix and GTK. If you don't have GTK, you |
| | 66 | should still be able to build the command-line utilities (PSCP, |
| | 67 | PSFTP, Plink, PuTTYgen) using this script. To use it, change |
| | 68 | into the `unix' subdirectory, run `./configure' and then `make'. |
| | 69 | |
| | 70 | Note that Unix PuTTY has mostly only been tested on Linux so far; |
| | 71 | portability problems such as BSD-style ptys or different header file |
| | 72 | requirements are expected. |
| | 73 | |
| | 74 | - unix/Makefile.gtk is for non-autoconfigured builds. This makefile |
| | 75 | expects you to change into the `unix' subdirectory, then run `make |
| | 76 | -f Makefile.gtk'. |
| | 77 | |
| | 78 | - For the graphical utilities, Gtk+-1.2 is required. Gtk+-2.0 is not |
| | 79 | yet supported. |
| | 80 | |
| | 81 | - Both Unix Makefiles have an `install' target. Note that by default |
| | 82 | it tries to install `man' pages, which you may need to have built |
| | 83 | using Halibut first -- see below. |
| | 84 | |
| | 85 | All of the Makefiles are generated automatically from the file |
| | 86 | `Recipe' by the Perl script `mkfiles.pl'. Additions and corrections |
| | 87 | to Recipe and the mkfiles.pl are much more useful than additions and |
| | 88 | corrections to the alternative Makefiles themselves. |
| | 89 | |
| | 90 | The Unix `configure' script and its various requirements are generated |
| | 91 | by the shell script `mkauto.sh', which requires GNU Autoconf, GNU |
| | 92 | Automake, and Gtk; if you've got the source from Subversion rather |
| | 93 | than using one of our source snapshots, you'll need to run this |
| | 94 | yourself. |
| | 95 | |
| | 96 | Documentation (in various formats including Windows Help and Unix |
| | 97 | `man' pages) is built from the Halibut (`.but') files in the `doc' |
| | 98 | subdirectory using `doc/Makefile'. If you aren't using one of our |
| | 99 | source snapshots, you'll need to do this yourself. Halibut can be |
| | 100 | found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>. |
| | 101 | |
| | 102 | The PuTTY home web site is |
| | 103 | |
| | 104 | http://www.chiark.greenend.org.uk/~sgtatham/putty/ |
| | 105 | |
| | 106 | If you want to send bug reports or feature requests, please read the |
| | 107 | Feedback section of the web site before doing so. Sending one-line |
| | 108 | reports saying `it doesn't work' will waste your time as much as |
| | 109 | ours. |
| | 110 | |
| | 111 | See the file LICENCE for the licence conditions. |
~mdw / sgt / putty / blame_incremental