1
0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-01-09 17:38:00 +00:00
Go to file
Simon Tatham b7174344e6 README: clarify that you need to run vcvars32 first.
The source-code README file claims that you can start by just running
'cmake .'. But on Windows, that's not literally true. cmake will
expect to find a compiler on your path, and if it doesn't, will fail
to configure.

I'd always taken this for granted, assuming that anyone who was
reading this README and trying to compile PuTTY was already familiar
with how Windows compiler toolchains work, and only needed the part of
the instructions that were specific to PuTTY.

But of course there's no reason that should be true. PuTTY's primary
target audience, even from before it was called PuTTY, has been Unix
expats: people who like to do nearly everything on Unix but for some
reason have a Windows machine in front of them. Such a person might
very well be familiar with _Unix_ compilation, where the C compiler is
installed in /usr/bin and on your PATH already. And then if they want
to try to tweak PuTTY, that will be the first time they have to engage
with a Windows compiler!

So we do need to at least _say_ that the user needs to start by
running vcvars32.bat or one of its friends. Even if we don't give full
details of where to find it (because I've known it to change now and
then), we at least need to remind people to go and look for it.
2024-06-29 12:19:35 +01:00
charset sbcsgen.pl: handle \r\n line endings. 2022-09-01 20:43:23 +01:00
cmake Merge 0.81 branch. 2024-04-15 19:42:50 +01:00
contrib authplugin-example.py: Flush stderr. 2023-04-19 14:18:58 +01:00
crypto Merge 0.81 branch. 2024-04-15 19:42:50 +01:00
doc Link from PGP keys appendix/page to checksum FAQ. 2024-04-17 23:44:13 +01:00
icons New script to draw the icons as SVG. 2022-03-18 12:55:01 +00:00
keygen Add some missing #includes. 2022-09-03 11:59:12 +01:00
otherbackends Pass the calling Socket to plug_log. 2024-06-29 12:00:12 +01:00
proxy Centralise stub plug/socket functions. 2024-06-29 12:19:35 +01:00
ssh Centralise stub plug/socket functions. 2024-06-29 12:19:35 +01:00
stubs Centralise stub plug/socket functions. 2024-06-29 12:19:35 +01:00
terminal Stop ignoring the Unicode tag character range. 2024-05-24 22:25:56 +01:00
test Stop ignoring the Unicode tag character range. 2024-05-24 22:25:56 +01:00
unicode Function to check a UTF-8 string for unknown characters. 2022-11-11 08:49:05 +00:00
unix Centralise stub plug/socket functions. 2024-06-29 12:19:35 +01:00
utils Log outgoing address + port numbers in the Event Log. 2024-06-29 12:18:28 +01:00
windows Centralise stub plug/socket functions. 2024-06-29 12:19:35 +01:00
.gitignore Add .gitignore rules for in-tree builds. 2021-04-19 18:26:56 +01:00
aqsync.c Build outgoing SSH agent requests in a strbuf. 2018-05-25 14:36:16 +01:00
be_list.c Merge be_*.c into one ifdef-controlled module. 2021-11-26 17:58:55 +00:00
Buildscr Merge 0.81 branch. 2024-04-15 19:42:50 +01:00
Buildscr.cv Replace mkfiles.pl with a CMake build system. 2021-04-17 13:53:02 +01:00
callback.c Add lots of missing 'static' keywords. 2020-01-29 06:44:18 +00:00
cgtest.c Richer data type for interactive prompt results. 2021-12-28 18:08:31 +00:00
CHECKLST.txt Post-0.81 checklist updates. 2024-04-19 19:35:20 +01:00
clicons.c Change vtable defs to use C99 designated initialisers. 2020-03-10 21:06:29 +00:00
CMakeLists.txt CMakeLists.txt: explicitly ask for C99. 2023-11-18 09:09:55 +00:00
cmdgen.c cmdgen: Fix docs and usage messages. 2022-10-20 23:55:19 +01:00
cmdline.c term_get_userpass_input: support the prompts->utf8 flag. 2023-03-04 14:06:04 +00:00
conf-enums.h Add ability to specify custom load and save separately. 2023-09-22 16:23:37 +01:00
conf.h conf.h: improve comments for a couple of options. 2023-09-22 17:12:28 +01:00
config.c Merge SSH cert UI tweak from 'pre-0.79'. 2023-07-19 17:18:26 +01:00
console.c Merge tag '0.80'. 2023-12-18 14:47:48 +00:00
console.h Mention the host name in host-key prompts. 2021-09-16 14:33:59 +01:00
defs.h Rename SocketPeerInfo to SocketEndpointInfo. 2024-06-29 11:49:32 +01:00
dialog.c dialog.c: give ctrl->fileselect.filter an opaque type. 2023-05-29 15:41:50 +01:00
dialog.h dialog.c: give ctrl->fileselect.filter an opaque type. 2023-05-29 15:41:50 +01:00
errsock.c Centralise stub plug/socket functions. 2024-06-29 12:19:35 +01:00
import.c Rename 'ret' variables passed from allocation to return. 2022-09-14 16:10:29 +01:00
LATEST.VER Update version number for 0.81 release. 2024-04-06 10:42:59 +01:00
ldisc.c ldisc: fix unwanted double-action of ^U. 2023-04-19 14:28:36 +01:00
LICENCE It's a new year. 2024-04-06 10:42:52 +01:00
licence.pl Separate the functions of licence.pl. 2021-04-17 13:52:27 +01:00
logging.c Merge log file name tweaks from 'pre-0.79'. 2023-07-16 16:38:56 +01:00
marshal.h Make encode_utf8() output to a BinarySink. 2022-11-09 19:02:32 +00:00
misc.h New utility function: decode_utf8_to_wide_string. 2023-05-29 15:08:49 +01:00
mksrcarc.sh Updates to mksrcarc.sh. 2022-09-01 20:43:23 +01:00
mkunxarc.sh Integrate the 'doc' subdir into the CMake system. 2021-05-03 17:01:55 +01:00
mpint.h Utility function mp_resize. 2022-04-15 17:46:06 +01:00
network.h Centralise stub plug/socket functions. 2024-06-29 12:19:35 +01:00
pageant.c Rename SocketPeerInfo to SocketEndpointInfo. 2024-06-29 11:49:32 +01:00
pageant.h winpgnt: menu options to delete/reencrypt everything. 2021-04-04 10:02:24 +01:00
pinger.c Whitespace rationalisation of entire code base. 2019-09-08 20:29:21 +01:00
pscp.c Handle the -batch option centrally in cmdline.c. 2022-11-26 10:31:18 +00:00
psftp.c Merge PSFTP multiple-connections fixes from 'pre-0.79'. 2023-06-07 07:29:39 +01:00
psftp.h Remove FLAG_VERBOSE. 2020-01-30 06:40:21 +00:00
psftpcommon.c Move the SSH implementation into its own subdirectory. 2021-04-22 18:09:13 +01:00
psocks.c Pass the calling Socket to plug_log. 2024-06-29 12:00:12 +01:00
psocks.h Remove a couple of double-typedefs. 2023-11-18 09:09:55 +00:00
putty.h Support Unicode flag glyphs in terminal.c (works in GTK). 2024-05-06 13:36:40 +01:00
puttymem.h Update source file names in comments and docs. 2022-01-22 15:51:31 +00:00
README README: clarify that you need to run vcvars32 first. 2024-06-29 12:19:35 +01:00
release.pl Remove FTP from release machinery. 2022-09-12 09:34:01 +01:00
settings.c settings.c: missing 'const' in gppfont(). 2023-11-18 09:11:33 +00:00
sign.sh GPG key rollover. 2023-07-31 20:01:24 +01:00
specials.h Move SessionSpecial definitions into their own header. 2023-03-04 13:05:20 +00:00
ssh.h Rename SocketPeerInfo to SocketEndpointInfo. 2024-06-29 11:49:32 +01:00
sshcr.h Formatting: fix a few mis-spaced assignments. 2022-12-28 15:28:36 +00:00
sshkeygen.h Side-channel-safe rewrite of the Miller-Rabin test. 2021-08-27 18:04:49 +01:00
sshpubk.c Remove a pointless allocation. 2023-04-19 14:18:58 +01:00
sshrand.c Remove dependency of sshrand.c on SHA-512. 2020-09-13 09:11:31 +01:00
storage.h New Seat method, seat_nonfatal(). 2022-09-13 11:26:57 +01:00
timing.c Whitespace rationalisation of entire code base. 2019-09-08 20:29:21 +01:00
tree234.h Formatting: remove spurious spaces in 'type * var'. 2022-08-03 20:48:46 +01:00
version.h Replace mkfiles.pl with a CMake build system. 2021-04-17 13:53:02 +01:00
x11disp.c Move the SSH implementation into its own subdirectory. 2021-04-22 18:09:13 +01:00

PuTTY source code README
========================

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

PuTTY is built using CMake <https://cmake.org/>. To compile in the
simplest way (on any of Linux, Windows or Mac), the general method is
to run these commands in the source directory:

  cmake .
  cmake --build .

These commands will expect to find a usable compile toolchain on your
path. So if you're building on Windows with MSVC, you'll need to make
sure that the MSVC compiler (cl.exe) is on your path, by running one
of the 'vcvars32.bat' setup scripts provided with the tools. Then the
cmake commands above should work.

To install in the simplest way on Linux or Mac:

  cmake --build . --target install

On Unix, 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.) The cmake install step
doesn't attempt to add these privileges, so if you want user login
recording to work, you should manually ch{own,grp} and chmod the
pterm binary yourself after installation. If you don't do this,
pterm will still work, but not update the user login databases.

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

The PuTTY home web site is

    https://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.