| 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 CVS, |
| 6 | you'll have to generate the Makefiles yourself -- see below.) |
| 7 | |
| 8 | For building on Windows: |
| 9 | |
| 10 | - Makefile.vc is for command-line builds on MS Visual C++ systems. |
| 11 | Type `nmake -f Makefile.vc' to build all the PuTTY binaries. |
| 12 | |
| 13 | (We've also had one report of success building with the |
| 14 | OpenWatcom compiler -- www.openwatcom.org -- using Makefile.vc |
| 15 | with `wmake -ms -f makefile.vc' and NO_MULTIMON, although we |
| 16 | haven't tried this ourselves.) |
| 17 | |
| 18 | - Inside the MSVC subdirectory are MS Visual Studio project files |
| 19 | for doing GUI-based builds of the various PuTTY utilities. These |
| 20 | have been tested on Visual Studio 6. |
| 21 | |
| 22 | You should be able to build each PuTTY utility by loading the |
| 23 | corresponding .dsp file in Visual Studio. For example, |
| 24 | MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp |
| 25 | builds Plink, and so on. |
| 26 | |
| 27 | - Makefile.bor is for the Borland C compiler. Type `make -f |
| 28 | Makefile.bor' to build all the PuTTY binaries. |
| 29 | |
| 30 | - Makefile.cyg is for Cygwin / mingw32 installations. Type `make -f |
| 31 | Makefile.cyg' to build all the PuTTY binaries. Note that by |
| 32 | default the Pageant WinNT security features and the multiple |
| 33 | monitor support are excluded from the Cygwin build, since at the |
| 34 | time of writing Cygwin doesn't include the necessary headers. |
| 35 | |
| 36 | - Makefile.lcc is for lcc-win32. Type `make -f Makefile.lcc'. (You |
| 37 | will probably need to specify COMPAT=-DNO_MULTIMON.) |
| 38 | |
| 39 | For building on Unix: |
| 40 | |
| 41 | - unix/Makefile.gtk is for Unix and GTK. If you don't have GTK, you |
| 42 | should still be able to build the command-line utilities (PSCP, |
| 43 | PSFTP, Plink, PuTTYgen) using this makefile. The makefile expects |
| 44 | you to change into the `unix' subdirectory, then run `make -f |
| 45 | Makefile.gtk'. Note that Unix PuTTY has mostly only been tested |
| 46 | on Linux so far; portability problems such as BSD-style ptys or |
| 47 | different header file requirements are expected. |
| 48 | |
| 49 | For the graphical utilities, Gtk+-1.2 is required. Gtk+-2.0 is not |
| 50 | yet supported. |
| 51 | |
| 52 | There is an `install' target; note that by default it tries to |
| 53 | install `man' pages, which need to be built using Halibut first -- |
| 54 | see below. |
| 55 | |
| 56 | All of the Makefiles are generated automatically from the file |
| 57 | `Recipe' by the Perl script `mkfiles.pl'. Additions and corrections |
| 58 | to Recipe and the mkfiles.pl are much more useful than additions and |
| 59 | corrections to the alternative Makefiles themselves. |
| 60 | |
| 61 | Documentation (in various formats including Windows Help and Unix |
| 62 | `man' pages) is to be built from the Halibut (`.but') files in the |
| 63 | `doc' subdirectory using `doc/Makefile'. Halibut can be found at |
| 64 | <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>. |
| 65 | |
| 66 | The PuTTY home web site is |
| 67 | |
| 68 | http://www.chiark.greenend.org.uk/~sgtatham/putty/ |
| 69 | |
| 70 | If you want to send bug reports or feature requests, please read the |
| 71 | Feedback section of the web site before doing so. Sending one-line |
| 72 | reports saying `it doesn't work' will waste your time as much as |
| 73 | ours. |
| 74 | |
| 75 | See the file LICENCE for the licence conditions. |