putty/README

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