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 / MinGW 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 into\r
  69    the `unix' subdirectory, run `./configure' and then `make'. Or you\r
  70    can do the same in the top-level directory (we provide a little\r
  71    wrapper that invokes configure one level down), which is more like\r
  72    a normal Unix source archive but doesn't do so well at keeping the\r
  73    per-platform stuff in each platform's subdirectory; it's up to you.\r
  74 \r
  75    Note that Unix PuTTY has mostly only been tested on Linux so far;\r
  76    portability problems such as BSD-style ptys or different header file\r
  77    requirements are expected.\r
  78 \r
  79  - unix/Makefile.gtk and unix/Makefile.ux are for non-autoconfigured\r
  80    builds. These makefiles expect you to change into the `unix'\r
  81    subdirectory, then run `make -f Makefile.gtk' or `make -f\r
  82    Makefile.ux' respectively. Makefile.gtk builds all the programs but\r
  83    relies on Gtk, whereas Makefile.ux builds only the command-line\r
  84    utilities and has no Gtk dependence.\r
  85 \r
  86  - For the graphical utilities, Gtk+-1.2 and Gtk+-2.0 should both be\r
  87    supported. If you have both installed, you can manually specify\r
  88    which one you want by giving the option '--with-gtk=1' or\r
  89    '--with-gtk=2' to the configure script. (2 is the default, of\r
  90    course.) In the absence of either, the configure script will\r
  91    automatically construct a Makefile which builds only the\r
  92    command-line utilities; you can manually create this condition by\r
  93    giving configure the option '--without-gtk'.\r
  94 \r
  95  - pterm would like to be setuid or setgid, as appropriate, to permit\r
  96    it to write records of user logins to /var/run/utmp and\r
  97    /var/log/wtmp. (Of course it will not use this privilege for\r
  98    anything else, and in particular it will drop all privileges before\r
  99    starting up complex subsystems like GTK.) By default the makefile\r
 100    will not attempt to add privileges to the pterm executable at 'make\r
 101    install' time, but you can ask it to do so by running configure\r
 102    with the option '--enable-setuid=USER' or '--enable-setgid=GROUP'.\r
 103 \r
 104  - The Unix Makefiles have an `install' target. Note that by default\r
 105    it tries to install `man' pages; if you have fetched the source via\r
 106    Subversion then you will need to have built these using Halibut\r
 107    first - see below.\r
 108 \r
 109  - It's also possible to build the Windows version of PuTTY to run\r
 110    on Unix by using Winelib.  To do this, change to the `windows'\r
 111    directory and run `make -f Makefile.cyg CC=winegcc RC=wrc'.\r
 112 \r
 113 All of the Makefiles are generated automatically from the file\r
 114 `Recipe' by the Perl script `mkfiles.pl' (except for the Unix one,\r
 115 which is generated by the `configure' script; mkfiles.pl only\r
 116 generates the input to automake). Additions and corrections to Recipe,\r
 117 mkfiles.pl and/or configure.ac are much more useful than additions and\r
 118 corrections to the actual Makefiles, Makefile.am or Makefile.in.\r
 119 \r
 120 The Unix `configure' script and its various requirements are generated\r
 121 by the shell script `mkauto.sh', which requires GNU Autoconf, GNU\r
 122 Automake, and Gtk; if you've got the source from Subversion rather\r
 123 than using one of our source snapshots, you'll need to run this\r
 124 yourself. The input file to Automake is generated by mkfiles.pl along\r
 125 with all the rest of the makefiles, so you will need to run mkfiles.pl\r
 126 and then mkauto.sh.\r
 127 \r
 128 Documentation (in various formats including Windows Help and Unix\r
 129 `man' pages) is built from the Halibut (`.but') files in the `doc'\r
 130 subdirectory using `doc/Makefile'. If you aren't using one of our\r
 131 source snapshots, you'll need to do this yourself. Halibut can be\r
 132 found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.\r
 133 \r
 134 The PuTTY home web site is\r
 135 \r
 136     http://www.chiark.greenend.org.uk/~sgtatham/putty/\r
 137 \r
 138 If you want to send bug reports or feature requests, please read the\r
 139 Feedback section of the web site before doing so. Sending one-line\r
 140 reports saying `it doesn't work' will waste your time as much as\r
 141 ours.\r
 142 \r
 143 See the file LICENCE for the licence conditions.\r