1
0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-01-09 01:18:00 +00:00
Go to file
Simon Tatham ecfa6b2734 Don't print long usage messages on a command-line error.
In the course of debugging the command-line argument refactoring in
previous commits, I found I wasn't quite sure whether PSCP thought I'd
given it too many arguments, or too few, because it didn't print an
error message saying which: it just printed its giant usage message.

Over the last few years I've come to the belief that this is Just
Wrong anyway. Printing the whole of a giant help message should only
be done when the user asked for it: otherwise, print a short and
to-the-point error, and maybe _suggest_ how to get help, but scrolling
everything else off the user's screen is not a good response to a
typo. I wrote this thought up more fully last year:

https://www.chiark.greenend.org.uk/~sgtatham/quasiblog/stop-helping/

So, time to practise what I preach! The PuTTY tools now follow the
'Stop helping!' principle. You can get full help by saying --help.

Also, when we do print the help, we now exit(0) rather than exit(1),
because there's no reason to report failure: we successfully did what
the user asked us for.
2024-09-26 11:30:07 +01:00
charset sbcsgen.pl: handle \r\n line endings. 2022-09-01 20:43:23 +01:00
cmake Fix build failure on Debian bullseye from last commit. 2024-09-08 19:05:45 +01:00
contrib Suppress syntax warnings on Python 3.12. 2024-08-01 21:38:07 +01:00
crypto Pad RSA signature blobs if they're made with SHA-2. 2024-07-08 21:49:39 +01:00
doc Tweak wording in the Unix Pageant man page. 2024-09-23 10:39:37 +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 Rework Unicode conversion APIs to use a BinarySink. 2024-09-26 11:30:07 +01:00
test Change type of CONF_username to the new CONF_TYPE_STR_AMBI. 2024-09-26 11:30:07 +01:00
unicode Update all Unicode tables to Unicode 16.0.0. 2024-09-22 19:08:24 +01:00
unix Don't print long usage messages on a command-line error. 2024-09-26 11:30:07 +01:00
utils Add two new string types to the Conf system. 2024-09-26 11:30:07 +01:00
windows Don't print long usage messages on a command-line error. 2024-09-26 11:30:07 +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 Add two new string types to the Conf system. 2024-09-26 11:30:07 +01:00
cmdgen.c Don't print long usage messages on a command-line error. 2024-09-26 11:30:07 +01:00
cmdline.c Add and use cmdline_arg_to_filename(). 2024-09-26 11:30:07 +01:00
conf-enums.h Add ability to specify custom load and save separately. 2023-09-22 16:23:37 +01:00
conf.h Change type of CONF_username to the new CONF_TYPE_STR_AMBI. 2024-09-26 11:30:07 +01:00
config.c conf_editbox_handler: support the new string types. 2024-09-26 11:30:07 +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 New abstraction for command-line arguments. 2024-09-26 11:30:07 +01:00
dialog.c dialog.c: give ctrl->fileselect.filter an opaque type. 2023-05-29 15:41:50 +01:00
dialog.h Add UTF-8 versions of dlg_editbox_{get,set}. 2024-09-26 11:30:07 +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 Rework Unicode conversion APIs to use a BinarySink. 2024-09-26 11:30:07 +01:00
misc.h dup_mb_to_wc, dup_wc_to_mb: remove the 'flags' parameter. 2024-09-24 09:42:58 +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 Don't print long usage messages on a command-line error. 2024-09-26 11:30:07 +01:00
psftp.c Don't print long usage messages on a command-line error. 2024-09-26 11:30:07 +01:00
psftp.h New abstraction for command-line arguments. 2024-09-26 11:30:07 +01:00
psftpcommon.c Move the SSH implementation into its own subdirectory. 2021-04-22 18:09:13 +01:00
psocks.c New abstraction for command-line arguments. 2024-09-26 11:30:07 +01:00
psocks.h New abstraction for command-line arguments. 2024-09-26 11:30:07 +01:00
putty.h Add and use cmdline_arg_to_filename(). 2024-09-26 11:30:07 +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 Change type of CONF_username to the new CONF_TYPE_STR_AMBI. 2024-09-26 11:30:07 +01:00
sign.sh sign.sh: stop telling gpg to load the 'idea' extension. 2024-09-10 06:35:42 +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 Fix infinite loop on a truncated RFC4176 public key file. 2024-08-10 14:00:41 +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.