mirror of git://git.tartarus.org/simon/putty.git, used for client testing
Перейти к файлу
Simon Tatham 1620aef7c6 MSI installer: offer to display the README file after install.
This is a thing that the Inno Setup installer did, and that I didn't
get round to replicating when I rushed out the initial MSI in a hurry.

I've checked that this doesn't prevent unattended installation by
administrators: running 'msiexec /q /i putty-whatever.msi' as
administrator still installs silently after this change, without
popping up the README unexpectedly on anyone's desktop as a side
effect.

(I _think_ - but I'm still a long way from an MSI expert - that that's
because /q turns off the whole UI part of the MSI system, and the
loading of README is actually triggered by the transition away from
the final UI dialog box, which we now never visit in the first place.)
2016-04-02 08:26:26 +01:00
charset Rework versioning system to not depend on Subversion. 2014-09-24 10:33:13 +00:00
contrib Support Ed25519 in kh2reg.py. 2016-03-25 09:58:40 +00:00
doc More modern examples of ports we don't have. 2016-03-28 19:18:46 +01:00
icons Make an OS X icon for pterm as well as PuTTY. 2016-03-23 22:02:46 +00:00
testdata Add a file of extra bignum tests. 2016-03-30 08:45:21 +01:00
unix Extend ACL-restriction to all Windows tools. 2016-04-02 08:00:07 +01:00
windows MSI installer: offer to display the README file after install. 2016-04-02 08:26:26 +01:00
.gitignore cmdgen: rescue test suite from bit rot. 2016-03-30 08:34:14 +01:00
Buildscr MSI installer: offer to display the README file after install. 2016-04-02 08:26:26 +01:00
Buildscr.cv Rework versioning system to not depend on Subversion. 2014-09-24 10:33:13 +00:00
CHECKLST.txt Autogenerate licence text in doc subdir from LICENCE. 2016-02-29 19:59:35 +00:00
LATEST.VER Update version number for 0.67 release. 2016-02-29 19:59:59 +00:00
LICENCE It's a new year. 2016-02-29 19:59:37 +00:00
README Remove the warning about Unix PuTTY being Linux-specific. 2016-03-27 20:25:59 +01:00
Recipe Extend ACL-restriction to all Windows tools. 2016-04-02 08:00:07 +01:00
be_all.c Rationalise access to, and content of, backends[] array. 2007-06-30 21:56:44 +00:00
be_all_s.c Rationalise access to, and content of, backends[] array. 2007-06-30 21:56:44 +00:00
be_misc.c Option to log proxy setup diagnostics to the terminal. 2015-11-22 15:12:10 +00:00
be_none.c Fix bug in which the SSH-only tools (pscp, psftp) did not honour a 2011-07-27 18:43:16 +00:00
be_nos_s.c Rationalise access to, and content of, backends[] array. 2007-06-30 21:56:44 +00:00
be_nossh.c Rationalise access to, and content of, backends[] array. 2007-06-30 21:56:44 +00:00
be_ssh.c Fix bug in which the SSH-only tools (pscp, psftp) did not honour a 2011-07-27 18:43:16 +00:00
callback.c Oops! Remove a tight-looping diagnostic. 2013-09-15 14:40:46 +00:00
cgtest.c cmdgen: rescue test suite from bit rot. 2016-03-30 08:34:14 +01:00
cmdgen.c Warn about short RSA/DSA keys in PuTTYgen. 2016-04-02 08:26:21 +01:00
cmdline.c Rationalise and document log options somewhat. 2016-02-29 19:59:32 +00:00
conf.c Giant const-correctness patch of doom! 2015-05-15 12:47:44 +01:00
config.c Configurable preference list for SSH host key types. 2016-03-25 16:32:17 +00:00
configure.ac Create OS X application bundles for PuTTY and pterm. 2016-03-23 22:22:48 +00:00
cproxy.c Avoid -Wmisleading-indentation warnings with GCC 6. 2016-02-29 19:59:36 +00:00
dialog.c Giant const-correctness patch of doom! 2015-05-15 12:47:44 +01:00
dialog.h Completely remove the privdata mechanism in dialog.h. 2015-06-20 09:39:14 +01:00
errsock.c Log identifying information for the other end of connections. 2015-06-20 12:47:02 +01:00
fuzzterm.c fuzzterm: record characters being displayed. 2015-10-28 22:08:59 +00:00
import.c Fix potential segfaults in reading OpenSSH's ASN.1 key format. 2016-02-29 19:59:32 +00:00
int64.c Further correction: on reflection, after examining all the call 2008-09-16 22:56:08 +00:00
int64.h Some extra int64 functions. 2006-08-05 13:48:53 +00:00
ldisc.c Giant const-correctness patch of doom! 2015-05-15 12:47:44 +01:00
ldisc.h Post-release destabilisation! Completely remove the struct type 2011-07-14 18:52:21 +00:00
ldiscucs.c Giant const-correctness patch of doom! 2015-05-15 12:47:44 +01:00
licence.pl Autogenerate licence text in doc subdir from LICENCE. 2016-02-29 19:59:35 +00:00
logging.c Merge tag '0.66' 2015-11-07 09:54:05 +00:00
minibidi.c Rework versioning system to not depend on Subversion. 2014-09-24 10:33:13 +00:00
misc.c Fix an out-of-bounds read in fgetline(). 2016-02-29 19:59:32 +00:00
misc.h Merge branch 'pre-0.67' 2016-02-29 19:59:59 +00:00
miscucs.c New centralised helper function dup_mb_to_wc(). 2015-10-17 17:30:16 +01:00
mkauto.sh Move the Unix configure script up to the top level. 2014-02-22 18:01:32 +00:00
mkfiles.pl Make Makefile.gtk default to GTK 3. 2016-03-25 09:11:01 +00:00
mksrcarc.sh New script to generate OS X icon files. 2015-09-06 10:12:15 +01:00
mkunxarc.sh Turn mkunxarc.sh back into an ordinary sh script. 2014-10-01 20:52:16 +00:00
network.h Option to log proxy setup diagnostics to the terminal. 2015-11-22 15:12:10 +00:00
nocproxy.c Malcolm Smith's patch to support CHAP (digest-based) authentication 2004-08-30 13:11:17 +00:00
nogss.c Rewrite gprefs() in settings.c so that its input mapping includes 2011-06-25 17:37:31 +00:00
noprint.c A few small changes to make the PuTTY source base more usable as a 2005-12-09 20:04:19 +00:00
noshare.c Fix the prototype of the stub function in noshare.c. 2014-04-22 17:53:50 +00:00
noterm.c Make calling term_nopaste() a cross-platform feature. 2013-08-17 16:06:40 +00:00
notiming.c Two related changes to timing code: 2012-09-18 21:42:48 +00:00
pageant.c Log identifying information for the other end of connections. 2015-05-18 14:03:10 +01:00
pageant.h Unix Pageant: support -D, to delete all keys. 2015-05-12 14:56:39 +01:00
pgssapi.c Patch from Alejandro Sedeno, somewhat modified by me, which 2010-05-19 18:22:17 +00:00
pgssapi.h Patch from Alejandro Sedeno, somewhat modified by me, which 2010-05-19 18:22:17 +00:00
pinger.c Fix a potential time-wraparound issue in pinger.c. 2016-04-02 07:51:24 +01:00
portfwd.c Tell the truth about DNS lookups in the Event Log. 2015-11-22 15:10:59 +00:00
pproxy.c Fix signature of platform_new_connection. 2015-08-15 13:54:55 +01:00
proxy.c Avoid -Wmisleading-indentation warnings with GCC 6. 2016-02-29 19:59:36 +00:00
proxy.h Giant const-correctness patch of doom! 2015-05-15 12:47:44 +01:00
pscp.c Extend ACL-restriction to all Windows tools. 2016-04-02 08:00:07 +01:00
psftp.c Extend ACL-restriction to all Windows tools. 2016-04-02 08:00:07 +01:00
psftp.h Extend ACL-restriction to all Windows tools. 2016-04-02 08:00:07 +01:00
putty.h Fix a potential time-wraparound issue in pinger.c. 2016-04-02 07:51:24 +01:00
puttymem.h Rework the new type-check in sresize so that it doesn't cause a 2012-07-19 04:29:50 +00:00
puttyps.h Delete the old 'macosx' directory completely. 2016-03-25 09:06:03 +00:00
raw.c Option to log proxy setup diagnostics to the terminal. 2015-11-22 15:12:10 +00:00
release.pl Further release automation. 2016-02-29 19:59:33 +00:00
resource.h Initial checkin: beta 0.43 1999-01-08 13:02:13 +00:00
rlogin.c Option to log proxy setup diagnostics to the terminal. 2015-11-22 15:12:10 +00:00
sercfg.c Post-release destabilisation! Completely remove the struct type 2011-07-14 18:52:21 +00:00
settings.c Decide on a position for ChaCha20-Poly1305. 2016-03-27 20:07:53 +01:00
sftp.c Giant const-correctness patch of doom! 2015-05-15 12:47:44 +01:00
sftp.h Giant const-correctness patch of doom! 2015-05-15 12:47:44 +01:00
sign.sh New Windows installer system, using WiX to build an MSI. 2016-03-09 20:55:38 +00:00
ssh.c Special host key warning when a better key exists. 2016-03-27 18:20:37 +01:00
ssh.h Polish up the PuTTYgen user interface for ECC key types. 2016-03-25 08:22:13 +00:00
sshaes.c Split ssh2_cipher's keylen field into two. 2015-09-10 08:11:26 +01:00
ssharcf.c Split ssh2_cipher's keylen field into two. 2015-09-10 08:11:26 +01:00
sshbcrypt.c Implementation of OpenSSH's bcrypt. 2015-04-27 20:48:29 +01:00
sshblowf.c Split ssh2_cipher's keylen field into two. 2015-09-10 08:11:26 +01:00
sshblowf.h Implementation of OpenSSH's bcrypt. 2015-04-27 20:48:29 +01:00
sshbn.c bignum_set_bit: Don't abort if asked to clear an inaccessible bit 2016-02-29 19:59:31 +00:00
sshbn.h Add a case to sshbn.h for 64-bit Visual Studio. 2015-12-16 14:21:09 +00:00
sshccp.c Relegate BignumDblInt to an implementation detail of sshbn.h. 2015-12-16 14:13:21 +00:00
sshcrc.c Fix a 64-bit-cleanness error in sshcrc's generator. 2016-02-29 19:59:36 +00:00
sshcrcda.c Unify GET_32BIT()/PUT_32BIT() et al from numerous source files into misc.h. 2005-04-12 20:04:56 +00:00
sshdes.c Split ssh2_cipher's keylen field into two. 2015-09-10 08:11:26 +01:00
sshdh.c Provide an 'extra' pointer in ssh_signkey and ssh_kex. 2015-05-15 10:12:08 +01:00
sshdss.c Provide an 'extra' pointer in ssh_signkey and ssh_kex. 2015-05-15 10:12:08 +01:00
sshdssg.c Generate keys more carefully, so that when the user asks for an n-bit 2012-03-04 00:24:49 +00:00
sshecc.c Polish up the PuTTYgen user interface for ECC key types. 2016-03-25 08:22:13 +00:00
sshecdsag.c Clean up elliptic curve selection and naming. 2015-05-15 10:15:35 +01:00
sshgss.h Post-release destabilisation! Completely remove the struct type 2011-07-14 18:52:21 +00:00
sshgssc.c Patch from Alejandro Sedeno, somewhat modified by me, which 2010-05-19 18:22:17 +00:00
sshgssc.h Patch from Alejandro Sedeno, somewhat modified by me, which 2010-05-19 18:22:17 +00:00
sshmd5.c Add a key-length field to 'struct ssh_mac'. 2015-08-21 23:41:05 +01:00
sshnogss.c Post-release destabilisation! Completely remove the struct type 2011-07-14 18:52:21 +00:00
sshprime.c Generate keys more carefully, so that when the user asks for an n-bit 2012-03-04 00:24:49 +00:00
sshpubk.c Fix a few memory leaks. 2015-06-20 09:31:55 +01:00
sshrand.c Add FUZZING build option that disables the random number generator. 2015-10-28 22:08:58 +00:00
sshrsa.c Merge tag '0.66' 2015-11-07 09:54:05 +00:00
sshrsag.c Make modinv able to return NULL if its inputs are not coprime, and 2013-08-04 19:34:07 +00:00
sshsh256.c Add a key-length field to 'struct ssh_mac'. 2015-08-21 23:41:05 +01:00
sshsh512.c Add copy and free methods to 'struct ssh_hash'. 2015-08-21 23:40:36 +01:00
sshsha.c Add a key-length field to 'struct ssh_mac'. 2015-08-21 23:41:05 +01:00
sshshare.c Remove an accidentally committed diagnostic. 2015-09-25 12:45:08 +01:00
sshzlib.c Close file descriptor in test main(). 2015-08-15 13:54:55 +01:00
storage.h Turn 'Filename' into a dynamically allocated type with no arbitrary 2011-10-02 11:01:57 +00:00
telnet.c Option to log proxy setup diagnostics to the terminal. 2015-11-22 15:12:10 +00:00
terminal.c Merge tag '0.66' 2015-11-07 09:54:05 +00:00
terminal.h More robust control sequence parameter handling. 2015-10-28 22:08:19 +00:00
testback.c New Plink operating mode: 'plink -shareexists'. 2015-09-25 12:11:27 +01:00
testbn.c Report the bignum word size in testbn. 2015-12-16 18:45:33 +00:00
time.c Comment explaining location in top-level directory. 2005-02-07 15:23:45 +00:00
timing.c Fix a potential time-wraparound issue in pinger.c. 2016-04-02 07:51:24 +01:00
tree234.c Fixes for the tree234 unit test: break its dependencies on half of the 2013-07-11 17:24:32 +00:00
tree234.h Run entire source base through GNU indent to tidy up the varying 2001-05-06 14:35:20 +00:00
version.c Rework versioning system to not depend on Subversion. 2014-09-24 10:33:13 +00:00
version.h Rework versioning system to not depend on Subversion. 2014-09-24 10:33:13 +00:00
wcwidth.c Fix another type mismatch introduced by r9409. 2012-03-05 18:40:36 +00:00
wildcard.c Add a missing null pointer check in wc_unescape, to bring it in line 2013-07-14 10:46:17 +00:00
x11fwd.c Tell the truth about DNS lookups in the Event Log. 2015-11-22 15:10:59 +00:00

README

This is the README for the source archive of PuTTY, a free Win32
and Unix Telnet and SSH client.

If you want to rebuild PuTTY from source, we provide a variety of
Makefiles and equivalents. (If you have fetched the source from
Git, you'll have to generate the Makefiles yourself -- see
below.)

There are various compile-time directives that you can use to
disable or modify certain features; it may be necessary to do this
in some environments. They are documented in `Recipe', and in
comments in many of the generated Makefiles.

For building on Windows:

 - windows/Makefile.vc is for command-line builds on MS Visual C++
   systems. Change into the `windows' subdirectory and type `nmake
   -f Makefile.vc' to build all the PuTTY binaries.

   As of 2016, we successfully compiled PuTTY with both Visual Studio
   7 (2003) and Visual Studio 14 (2015), so our guess is that it will
   probably build with versions in between those as well.

 - Inside the windows/MSVC subdirectory are MS Visual Studio project
   files for doing GUI-based builds of the various PuTTY utilities.
   These have been tested on Visual Studio 7 and 10.

   You should be able to build each PuTTY utility by loading the
   corresponding .dsp file in Visual Studio. For example,
   MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp
   builds Plink, and so on.

 - windows/Makefile.bor is for the Borland C compiler. Type `make -f
   Makefile.bor' while in the `windows' subdirectory to build all
   the PuTTY binaries.

 - windows/Makefile.cyg is for Cygwin / MinGW installations. Type
   `make -f Makefile.cyg' while in the `windows' subdirectory to
   build all the PuTTY binaries.

   You'll probably need quite a recent version of the w32api package.
   Note that by default the multiple monitor and HTML Help support are
   excluded from the Cygwin build, since at the time of writing Cygwin
   doesn't include the necessary headers.

 - windows/Makefile.lcc is for lcc-win32. Type `make -f
   Makefile.lcc' while in the `windows' subdirectory. (You will
   probably need to specify COMPAT=-DNO_MULTIMON.)

 - Inside the windows/DEVCPP subdirectory are Dev-C++ project
   files for doing GUI-based builds of the various PuTTY utilities.

The PuTTY team actively use Makefile.vc (with VC7) and Makefile.cyg
(with mingw32), so we'll probably notice problems with those
toolchains fairly quickly. Please report any problems with the other
toolchains mentioned above.

For building on Unix:

 - unix/configure is for Unix and GTK. If you don't have GTK, you
   should still be able to build the command-line utilities (PSCP,
   PSFTP, Plink, PuTTYgen) using this script. To use it, change into
   the `unix' subdirectory, run `./configure' and then `make'. Or you
   can do the same in the top-level directory (we provide a little
   wrapper that invokes configure one level down), which is more like
   a normal Unix source archive but doesn't do so well at keeping the
   per-platform stuff in each platform's subdirectory; it's up to you.

 - unix/Makefile.gtk and unix/Makefile.ux are for non-autoconfigured
   builds. These makefiles expect you to change into the `unix'
   subdirectory, then run `make -f Makefile.gtk' or `make -f
   Makefile.ux' respectively. Makefile.gtk builds all the programs but
   relies on Gtk, whereas Makefile.ux builds only the command-line
   utilities and has no Gtk dependence.

 - For the graphical utilities, any of Gtk+-1.2, Gtk+-2.0, and Gtk+-3.0
   should be supported. If you have more than one installed, you can
   manually specify which one you want by giving the option
   '--with-gtk=N' to the configure script where N is 1, 2, or 3.
   (The default is the newest available, of course.) In the absence
   of any Gtk version, the configure script will automatically
   construct a Makefile which builds only the command-line utilities;
   you can manually create this condition by giving configure the
   option '--without-gtk'.

 - pterm would like to be setuid or setgid, as appropriate, to permit
   it to write records of user logins to /var/run/utmp and
   /var/log/wtmp. (Of course it will not use this privilege for
   anything else, and in particular it will drop all privileges before
   starting up complex subsystems like GTK.) By default the makefile
   will not attempt to add privileges to the pterm executable at 'make
   install' time, but you can ask it to do so by running configure
   with the option '--enable-setuid=USER' or '--enable-setgid=GROUP'.

 - The Unix Makefiles have an `install' target. Note that by default
   it tries to install `man' pages; if you have fetched the source via
   Git then you will need to have built these using Halibut
   first - see below.

 - It's also possible to build the Windows version of PuTTY to run
   on Unix by using Winelib.  To do this, change to the `windows'
   directory and run `make -f Makefile.cyg CC=winegcc RC=wrc'.

All of the Makefiles are generated automatically from the file
`Recipe' by the Perl script `mkfiles.pl' (except for the Unix one,
which is generated by the `configure' script; mkfiles.pl only
generates the input to automake). Additions and corrections to Recipe,
mkfiles.pl and/or configure.ac are much more useful than additions and
corrections to the actual Makefiles, Makefile.am or Makefile.in.

The Unix `configure' script and its various requirements are generated
by the shell script `mkauto.sh', which requires GNU Autoconf, GNU
Automake, and Gtk; if you've got the source from Git rather
than using one of our source snapshots, you'll need to run this
yourself. The input file to Automake is generated by mkfiles.pl along
with all the rest of the makefiles, so you will need to run mkfiles.pl
and then mkauto.sh.

Documentation (in various formats including Windows Help and Unix
`man' pages) is built from the Halibut (`.but') files in the `doc'
subdirectory using `doc/Makefile'. If you aren't using one of our
source snapshots, you'll need to do this yourself. Halibut can be
found at <http://www.chiark.greenend.org.uk/~sgtatham/halibut/>.

The PuTTY home web site is

    http://www.chiark.greenend.org.uk/~sgtatham/putty/

If you want to send bug reports or feature requests, please read the
Feedback section of the web site before doing so. Sending one-line
reports saying `it doesn't work' will waste your time as much as
ours.

See the file LICENCE for the licence conditions.