From 557164b0432ec1d0c6a534a12aead545110c480d Mon Sep 17 00:00:00 2001 From: Jacob Nevins Date: Sun, 21 Feb 2021 16:01:05 +0000 Subject: [PATCH] Tweaks to SUPDUP documentation. Including noting that it can't be used with Plink, and better indexing. --- doc/config.but | 17 +++++++++-------- doc/errors.but | 4 ++-- doc/feedback.but | 2 +- doc/gs.but | 17 ++++++++--------- doc/index.but | 24 +++++++++++++----------- doc/intro.but | 22 +++++++++++----------- doc/man-putty.but | 4 ++-- doc/man-puttytel.but | 8 ++++---- doc/using.but | 7 ++++++- windows/putty.rc | 2 +- 10 files changed, 57 insertions(+), 50 deletions(-) diff --git a/doc/config.but b/doc/config.but index 58a5dc9a..cf14b89e 100644 --- a/doc/config.but +++ b/doc/config.but @@ -1683,8 +1683,8 @@ connection loss, or you might find they make it worse, depending on what \e{kind} of network problems you have between you and the server. -Keepalives are only supported in Telnet and SSH; the Rlogin and Raw -protocols offer no way of implementing them. (For an alternative, see +Keepalives are only supported in Telnet and SSH; the Rlogin, SUPDUP, and +Raw protocols offer no way of implementing them. (For an alternative, see \k{config-tcp-keepalives}.) Note that if you are using SSH-1 and the server has a bug that makes @@ -1713,7 +1713,7 @@ The idea of TCP keepalives is similar to application-level keepalives, and the same caveats apply. The main differences are: \b TCP keepalives are available on \e{all} connection types, including -Raw and Rlogin. +Raw, Rlogin, and SUPDUP. \b The interval between TCP keepalives is usually much longer, typically two hours; this is set by the operating system, and cannot @@ -1806,7 +1806,7 @@ configuration panels. \S{config-username} \q{\ii{Auto-login username}} -All three of the SSH, Telnet and Rlogin protocols allow you to +All three of the SSH, Telnet, and Rlogin protocols allow you to specify what user name you want to log in as, without having to type it explicitly every time. (Some Telnet servers don't support this.) @@ -1835,7 +1835,7 @@ Most servers you might connect to with PuTTY are designed to be connected to from lots of different types of terminal. In order to send the right \i{control sequence}s to each one, the server will need to know what type of terminal it is dealing with. Therefore, each of -the SSH, Telnet and Rlogin protocols allow a text string to be sent +the SSH, Telnet, and Rlogin protocols allow a text string to be sent down the connection describing the terminal. On a \i{Unix} server, this selects an entry from the \i\c{termcap} or \i\c{terminfo} database that tells applications what \i{control sequences} to send to the @@ -2219,10 +2219,11 @@ PuTTY should claim you have, in case it doesn't match your \i{Windows user name} (or in case you didn't bother to set up a Windows user name). -\H{config-supdup} The SUPDUP panel +\H{config-supdup} The \i{SUPDUP} panel -The \i{SUPDUP} panel allows you to configure options that only apply -to SUPDUP sessions. +The SUPDUP panel allows you to configure options that only apply +to SUPDUP sessions. See \k{using-supdup} for more about the SUPDUP +protocol. \S{supdup-location} \q{Location string} diff --git a/doc/errors.but b/doc/errors.but index ee88c002..36a42d94 100644 --- a/doc/errors.but +++ b/doc/errors.but @@ -332,8 +332,8 @@ your server was rejected by the server. Usually this happens because the server does not provide the service which PuTTY is trying to access. -Check that you are connecting with the correct protocol (SSH, Telnet -or Rlogin), and check that the port number is correct. If that +Check that you are connecting with the correct protocol (SSH, Telnet, +etc), and check that the port number is correct. If that fails, consult the administrator of your server. \H{errors-conntimedout} \q{Network error: Connection timed out} diff --git a/doc/feedback.but b/doc/feedback.but index 334282d3..b7aa9c87 100644 --- a/doc/feedback.but +++ b/doc/feedback.but @@ -158,7 +158,7 @@ for Arm, tell us, or we'll assume you're running on Windows for Intel as this is overwhelmingly the case.) \b Tell us what protocol you are connecting with: SSH, Telnet, -Rlogin, or Raw mode, or a serial connection. +Rlogin, SUPDUP, or Raw mode, or a serial connection. \b Tell us what kind of server you are connecting to; what OS, and if possible what SSH server (if you're using SSH). You can get some diff --git a/doc/gs.but b/doc/gs.but index fb33f3d7..f7f7b1a2 100644 --- a/doc/gs.but +++ b/doc/gs.but @@ -18,15 +18,14 @@ you want to connect to. You should have been told this by the provider of your login account. Now select a login \i{protocol} to use, from the \q{Connection type} -buttons. For a login session, you should select \i{Telnet}, -\i{Rlogin} or \i{SSH}. See \k{which-one} for a description of the -differences between the three protocols, and advice on which one to -use. The fourth protocol, \I{raw protocol}\e{Raw}, is not used for -interactive login sessions; you would usually use this for debugging -other Internet services (see \k{using-rawprot}). The fifth option, -\e{Serial}, is used for connecting to a local serial line, and works -somewhat differently: see \k{using-serial} for more information on -this. +buttons. For a login session, you should select \i{SSH}, \i{Telnet}, +\i{Rlogin}, or \i{SUPDUP}. See \k{which-one} for a description of the +differences between these protocols, and advice on which one to +use. The \I{raw protocol}\e{Raw} protocol is not used for interactive +login sessions; you would usually use this for debugging other Internet +services (see \k{using-rawprot}). The \e{Serial} option is used for +connecting to a local serial line, and works somewhat differently: +see \k{using-serial} for more information on this. When you change the selected protocol, the number in the \q{Port} box will change. This is normal: it happens because the various diff --git a/doc/index.but b/doc/index.but index 29acf109..b2d1134d 100644 --- a/doc/index.but +++ b/doc/index.but @@ -40,18 +40,20 @@ \IM{different usernames}{changes of username} login names, different \IM{different usernames}{changes of username} account names, different -\IM{differences between SSH, Telnet, Rlogin and SUPDUP} differences between -SSH, Telnet and Rlogin -\IM{differences between SSH, Telnet, Rlogin and SUPDUP} protocols, +\IM{differences between SSH, Telnet, Rlogin, and SUPDUP} differences between +SSH, Telnet, Rlogin, and SUPDUP +\IM{differences between SSH, Telnet, Rlogin, and SUPDUP} protocols, differences between -\IM{differences between SSH, Telnet, Rlogin and SUPDUP} SSH, differences -from Telnet and Rlogin -\IM{differences between SSH, Telnet, Rlogin and SUPDUP} Telnet, differences -from SSH and Rlogin -\IM{differences between SSH, Telnet, Rlogin and SUPDUP} Rlogin, differences -from SSH and Telnet -\IM{differences between SSH, Telnet, Rlogin and SUPDUP} selecting a protocol -\IM{differences between SSH, Telnet, Rlogin and SUPDUP} choosing a protocol +\IM{differences between SSH, Telnet, Rlogin, and SUPDUP} SSH, differences +from other protocols +\IM{differences between SSH, Telnet, Rlogin, and SUPDUP} Telnet, differences +from other protocols +\IM{differences between SSH, Telnet, Rlogin, and SUPDUP} Rlogin, differences +from other protocols +\IM{differences between SSH, Telnet, Rlogin, and SUPDUP} SUPDUP, differences +from other protocols +\IM{differences between SSH, Telnet, Rlogin, and SUPDUP} selecting a protocol +\IM{differences between SSH, Telnet, Rlogin, and SUPDUP} choosing a protocol \IM{MUD}{MUDs} MUDs diff --git a/doc/intro.but b/doc/intro.but index ad85ae49..05ec30ac 100644 --- a/doc/intro.but +++ b/doc/intro.but @@ -1,14 +1,14 @@ \C{intro} Introduction to PuTTY -PuTTY is a free SSH, Telnet, Rlogin and SUPDUP client for Windows +PuTTY is a free SSH, Telnet, Rlogin, and SUPDUP client for Windows systems. -\H{you-what} What are SSH, Telnet, Rlogin and SUPDUP? +\H{you-what} What are SSH, Telnet, Rlogin, and SUPDUP? -If you already know what SSH, Telnet, Rlogin and SUPDUP are, you can +If you already know what SSH, Telnet, Rlogin, and SUPDUP are, you can safely skip on to the next section. -SSH, Telnet, Rlogin and SUPDUP are four ways of doing the same thing: +SSH, Telnet, Rlogin, and SUPDUP are four ways of doing the same thing: logging in to a multi-user computer from another computer, over a network. @@ -22,7 +22,7 @@ at the same machine you are typing commands to. The commands, and responses, can be sent over a network, so you can sit at one computer and give commands to another one, or even to more than one. -SSH, Telnet, Rlogin and SUPDUP are \i\e{network protocols} that allow +SSH, Telnet, Rlogin, and SUPDUP are \i\e{network protocols} that allow you to do this. On the computer you sit at, you run a \i\e{client}, which makes a network connection to the other computer (the \i\e{server}). The network connection carries your keystrokes and @@ -34,7 +34,7 @@ interactive session. In particular, there are a lot of bulletin boards, \i{talker systems} and \i{MUDs} (Multi-User Dungeons) which support access using Telnet. There are even a few that support SSH. -You might want to use SSH, Telnet, Rlogin or SUPDUP if: +You might want to use SSH, Telnet, Rlogin, or SUPDUP if: \b you have an account on a Unix or VMS system which you want to be able to access from somewhere else @@ -54,15 +54,15 @@ ways of networking between themselves, and unless you are doing something fairly unusual, you will not need to use any of these remote login protocols. -\H{which-one} How do SSH, Telnet, Rlogin and SUPDUP differ? +\H{which-one} How do SSH, Telnet, Rlogin, and SUPDUP differ? This list summarises some of the \i{differences between SSH, Telnet, -Rlogin and SUPDUP}. +Rlogin, and SUPDUP}. \b SSH (which stands for \q{\i{secure shell}}) is a recently designed, high-security protocol. It uses strong cryptography to protect your connection against eavesdropping, hijacking and other attacks. Telnet, -Rlogin and SUPDUP are all older protocols offering minimal security. +Rlogin, and SUPDUP are all older protocols offering minimal security. \b SSH and Rlogin both allow you to \I{passwordless login}log in to the server without having to type a password. (Rlogin's method of doing this is @@ -82,5 +82,5 @@ doesn't support SSH, it might be worth trying to persuade the administrator to install it. If your client and server are both behind the same (good) firewall, -it is more likely to be safe to use Telnet or Rlogin, but we still -recommend you use SSH. +it is more likely to be safe to use Telnet, Rlogin, or SUPDUP, but we +still recommend you use SSH. diff --git a/doc/man-putty.but b/doc/man-putty.but index cd8174bc..02bba4ab 100644 --- a/doc/man-putty.but +++ b/doc/man-putty.but @@ -4,7 +4,7 @@ \S{putty-manpage-name} NAME -\cw{putty} - GUI SSH, Telnet, Rlogin and SUPDUP client for X +\cw{putty} - GUI SSH, Telnet, Rlogin, and SUPDUP client for X \S{putty-manpage-synopsis} SYNOPSIS @@ -13,7 +13,7 @@ \S{putty-manpage-description} DESCRIPTION -\cw{putty} is a graphical SSH, Telnet, Rlogin and SUPDUP client for +\cw{putty} is a graphical SSH, Telnet, Rlogin, and SUPDUP client for X. It is a direct port of the Windows SSH client of the same name. \S{putty-manpage-options} OPTIONS diff --git a/doc/man-puttytel.but b/doc/man-puttytel.but index 73b85ecc..765c330d 100644 --- a/doc/man-puttytel.but +++ b/doc/man-puttytel.but @@ -4,7 +4,7 @@ \S{puttytel-manpage-name} NAME -\cw{puttytel} \- GUI Telnet and Rlogin client for X +\cw{puttytel} \- GUI Telnet, Rlogin, and SUPDUP client for X \S{puttytel-manpage-synopsis} SYNOPSIS @@ -13,9 +13,9 @@ \S{puttytel-manpage-description} DESCRIPTION -\cw{puttytel} is a graphical Telnet and Rlogin client for X. It -is a direct port of the Windows Telnet and Rlogin client of the same -name, and a cut-down cryptography-free version of PuTTY. +\cw{puttytel} is a graphical Telnet, Rlogin, and SUPDUP client for X. It +is a direct port of the Windows Telnet, Rlogin, and SUPDUP client of the +same name, and a cut-down cryptography-free version of PuTTY. \S{puttytel-manpage-options} OPTIONS diff --git a/doc/using.but b/doc/using.but index 9161db35..577d4358 100644 --- a/doc/using.but +++ b/doc/using.but @@ -582,7 +582,7 @@ connection to notify the other that the connection is finished. Therefore, PuTTY in serial mode will remain connected until you close the window using the close button. -\H{using-supdup} Connecting using the SUPDUP protocol +\H{using-supdup} Connecting using the \i{SUPDUP} protocol PuTTY can use the SUPDUP protocol to connect to a server. SUPDUP is a login protocol used mainly by PDP-10 and Lisp machines during the @@ -595,6 +595,11 @@ To make a connection of this type, select \q{SUPDUP} from the set, more processing, scrolling), you can use the \q{SUPDUP} configuration panel (see \k{config-supdup}). +In SUPDUP, terminal emulation is more integrated with the network +protocol than in other protocols such as SSH. The SUPDUP protocol can +thus only be used with PuTTY proper, not with the command-line tool +Plink. + The SUPDUP protocol does not support changing the terminal dimensions, so this capability is disabled during a SUPDUP session. diff --git a/windows/putty.rc b/windows/putty.rc index 6d15fdbf..b7d7404c 100644 --- a/windows/putty.rc +++ b/windows/putty.rc @@ -1,7 +1,7 @@ #include "rcstuff.h" #define APPNAME "PuTTY" -#define APPDESC "SSH, Telnet, Rlogin and SUPDUDP client" +#define APPDESC "SSH, Telnet, Rlogin, and SUPDUDP client" #include "winhelp.rc2" #include "win_res.rc2"