Add an option to disable SSH-2 banners.
[u/mdw/putty] / doc / config.but
index 62aaaa6..daa20ed 100644 (file)
@@ -1030,7 +1030,9 @@ the terminal will stay the same, and the \i{font size} will change.
 
 \b \q{Change font size when maximised}: when the window is resized,
 the number of rows and columns will change, \e{except} when the window
-is \i{maximise}d (or restored), when the font size will change.
+is \i{maximise}d (or restored), when the font size will change. (In
+this mode, holding down the Alt key while resizing will also cause the
+font size to change.)
 
 \b \q{Forbid resizing completely}: the terminal will refuse to be
 resized at all.
@@ -1788,17 +1790,19 @@ it explicitly every time. (Some Telnet servers don't support this.)
 
 In this box you can type that user name.
 
-\S{config-username-from-env} \q{Use of system username}
+\S{config-username-from-env} Use of system username
 
 \cfg{winhelp-topic}{connection.usernamefromenv}
 
 When the previous box (\k{config-username}) is left blank, by default,
 PuTTY will prompt for a username at the time you make a connection.
 
-In some environments, such as large corporate networks with \i{single
-sign-on}, a more sensible default may be to use the name of the user
-logged in to the local operating system (if any). This control allows
-you to change the default behaviour.
+In some environments, such as the networks of large organisations
+implementing \i{single sign-on}, a more sensible default may be to use
+the name of the user logged in to the local operating system (if any);
+this is particularly likely to be useful with \i{GSSAPI} authentication
+(see \k{config-ssh-auth-gssapi}). This control allows you to change
+the default behaviour.
 
 The current system username is displayed in the dialog as a
 convenience. It is not saved in the configuration; if a saved session
@@ -2465,6 +2469,21 @@ unwanted username prompts, you could try checking this option.
 This option only affects SSH-2 connections. SSH-1 connections always
 require an authentication step.
 
+\S{config-ssh-banner} \q{Display pre-authentication banner}
+
+\cfg{winhelp-topic}{ssh.auth.banner}
+
+SSH-2 servers can provide a message for clients to display to the
+prospective user before the user logs in; this is sometimes known as a
+pre-authentication \q{\i{banner}}. Typically this is used to provide
+information about the server and legal notices.
+
+By default, PuTTY displays this message before prompting for a
+password or similar credentials (although, unfortunately, not before
+prompting for a login name, due to the nature of the protocol design).
+By unchecking this option, display of the banner can be suppressed
+entirely.
+
 \S{config-ssh-tryagent} \q{Attempt authentication using Pageant}
 
 \cfg{winhelp-topic}{ssh.auth.pageant}
@@ -2571,7 +2590,7 @@ If a key file is specified here, and \i{Pageant} is running (see
 that key, and ignore any other keys Pageant may have. If that fails,
 PuTTY will ask for a passphrase as normal.
 
-\H{config-ssh-auth-gssapi} The GSSAPI panel
+\H{config-ssh-auth-gssapi} The \i{GSSAPI} panel
 
 \cfg{winhelp-topic}{ssh.auth.gssapi}
 
@@ -2579,7 +2598,7 @@ The \q{GSSAPI} subpanel of the \q{Auth} panel controls the use of
 GSSAPI authentication. This is a mechanism which delegates the
 authentication exchange to a library elsewhere on the client
 machine, which in principle can authenticate in many different ways
-but in practice is usually used with the Kerberos single-sign-on
+but in practice is usually used with the \i{Kerberos} \i{single sign-on}
 protocol.
 
 GSSAPI is only available in the SSH-2 protocol.
@@ -2597,7 +2616,7 @@ delegation}
 
 \cfg{winhelp-topic}{ssh.auth.gssapi.delegation}
 
-GSSAPI credential delegation is a mechanism for passing on your
+\i{GSSAPI credential delegation} is a mechanism for passing on your
 Kerberos (or other) identity to the session on the SSH server. If
 you enable this option, then not only will PuTTY be able to log in
 automatically to a server that accepts your Kerberos credentials,