\e{Note to Unix users:} this manual currently primarily documents the
Windows versions of the PuTTY utilities. Some options are therefore
-mentioned that are absent from the Unix version; the Unix version has
-features not described here; and the \cw{pterm} and command-line
+mentioned that are absent from the \i{Unix version}; the Unix version has
+features not described here; and the \i\cw{pterm} and command-line
\cw{puttygen} utilities are not described at all. The only
-Unix-specific documentation that currently exists is the man pages.
+Unix-specific documentation that currently exists is the
+\I{man pages for PuTTY tools}man pages.
\copyright This manual is copyright 2001-2005 Simon Tatham. All
rights reserved. You may distribute this documentation under the MIT
\C{config} Configuring PuTTY
-This chapter describes all the configuration options in PuTTY.
+This chapter describes all the \i{configuration options} in PuTTY.
PuTTY is configured using the control panel that comes up before you
start a session. Some options can also be changed in the middle of a
to specify in order to open a session at all, and also allows you to
save your settings to be reloaded later.
-\S{config-hostname} The host name section
+\S{config-hostname} The \i{host name} section
\cfg{winhelp-topic}{session.hostname}
connection by host name}, contains the details that need to be
filled in before PuTTY can open a session at all.
-\b The \q{Host Name} box is where you type the name, or the IP
-address, of the server you want to connect to.
+\b The \q{Host Name} box is where you type the name, or the \i{IP
+address}, of the server you want to connect to.
\b The \q{Protocol} radio buttons let you choose what type of
-connection you want to make: a raw connection, a Telnet connection, an
-rlogin connection or an SSH connection. (See \k{which-one} for a
+connection you want to make: a \I{raw TCP connections}raw
+connection, a \i{Telnet} connection, an \i{Rlogin} connection
+or an \i{SSH} connection. (See \k{which-one} for a
summary of the differences between SSH, Telnet and rlogin, and
\k{using-rawprot} for an explanation of \q{raw} connections.)
-\b The \q{Port} box lets you specify which port number on the server
+\b The \q{Port} box lets you specify which \i{port number} on the server
to connect to. If you select Telnet, Rlogin, or SSH, this box will
be filled in automatically to the usual value, and you will only
need to change it if you have an unusual server. If you select Raw
mode, you will almost certainly need to fill in the \q{Port} box.
-\S{config-saving} Loading and storing saved sessions
+\S{config-saving} \ii{Loading and storing saved sessions}
\cfg{winhelp-topic}{session.saved}
\b To save your default settings: first set up the settings the way
you want them saved. Then come back to the Session panel. Select the
-\q{Default Settings} entry in the saved sessions list, with a single
+\q{\i{Default Settings}} entry in the saved sessions list, with a single
click. Then press the \q{Save} button.
\lcont{
configuration. If you change your preferences and update Default
Settings, you must also update every saved session separately.
-Saved sessions are stored in the Registry, at the location
+Saved sessions are stored in the \i{Registry}, at the location
\c HKEY_CURRENT_USER\Software\SimonTatham\PuTTY\Sessions
If you need to store them in a file, you could try the method
described in \k{config-file}.
-\S{config-closeonexit} \q{Close Window on Exit}
+\S{config-closeonexit} \q{\ii{Close Window} on Exit}
\cfg{winhelp-topic}{session.coe}
Finally in the Session panel, there is an option labelled \q{Close
-Window on Exit}. This controls whether the PuTTY session window
+Window on Exit}. This controls whether the PuTTY \i{terminal window}
disappears as soon as the session inside it terminates. If you are
likely to want to copy and paste text out of the session after it
has terminated, or restart the session, you should arrange for this
\cfg{winhelp-topic}{logging.main}
-The Logging configuration panel allows you to save log files of your
+The Logging configuration panel allows you to save \i{log file}s of your
PuTTY sessions, for debugging, analysis or future reference.
The main option is a radio-button set that specifies whether PuTTY
else can replay the session later in slow motion and watch to see
what went wrong.
-\b \q{Log SSH packet data}. In this mode (which is only used by SSH
+\b \q{\i{Log SSH packet data}}. In this mode (which is only used by SSH
connections), the SSH message packets sent over the encrypted
connection are written to the log file. You might need this to debug
a network-level problem, or more likely to send to the PuTTY authors
automatic behaviour, but to ask the user every time the problem
comes up.
-\S{config-logflush} \q{Flush log file frequently}
+\S{config-logflush} \I{log file, flushing}\q{Flush log file frequently}
\cfg{winhelp-topic}{logging.flush}
(although it will of course be flushed when it is closed, for instance
at the end of a session).
-\S{config-logssh} Options specific to SSH packet logging
+\S{config-logssh} Options specific to \i{SSH packet log}ging
These options only apply if SSH packet data is being logged.
\H{config-terminal} The Terminal panel
The Terminal configuration panel allows you to control the behaviour
-of PuTTY's terminal emulation.
+of PuTTY's \i{terminal emulation}.
\S{config-autowrap} \q{Auto wrap mode initially on}
\cfg{winhelp-topic}{terminal.autowrap}
-Auto wrap mode controls what happens when text printed in a PuTTY
+\ii{Auto wrap mode} controls what happens when text printed in a PuTTY
window reaches the right-hand edge of the window.
With auto wrap mode on, if a long line of text reaches the
find the screen scrolling up when it looks as if it shouldn't, you
could try turning this option off.
-Auto wrap mode can be turned on and off by control sequences sent by
+Auto wrap mode can be turned on and off by \i{control sequence}s sent by
the server. This configuration option controls the \e{default}
state, which will be restored when you reset the terminal (see
\k{reset-terminal}). However, if you modify this option in
\cfg{winhelp-topic}{terminal.decom}
-DEC Origin Mode is a minor option which controls how PuTTY
-interprets cursor-position control sequences sent by the server.
+\i{DEC Origin Mode} is a minor option which controls how PuTTY
+interprets cursor-position \i{control sequence}s sent by the server.
-The server can send a control sequence that restricts the scrolling
-region of the display. For example, in an editor, the server might
+The server can send a control sequence that restricts the \i{scrolling
+region} of the display. For example, in an editor, the server might
reserve a line at the top of the screen and a line at the bottom,
and might send a control sequence that causes scrolling operations
to affect only the remaining lines.
-With DEC Origin Mode on, cursor coordinates are counted from the top
+With DEC Origin Mode on, \i{cursor coordinates} are counted from the top
of the scrolling region. With it turned off, cursor coordinates are
counted from the top of the whole screen regardless of the scrolling
region.
\cfg{winhelp-topic}{terminal.lfhascr}
-Most servers send two control characters, CR and LF, to start a new
-line of the screen. The CR character makes the cursor return to the
+Most servers send two control characters, \i{CR} and \i{LF}, to start a
+\i{new line} of the screen. The CR character makes the cursor return to the
left-hand side of the screen. The LF character makes the cursor move
one line down (and might make the screen scroll).
Some servers only send LF, and expect the terminal to move the
cursor over to the left automatically. If you come across a server
-that does this, you will see a stepped effect on the screen, like
-this:
+that does this, you will see a \I{stair-stepping}stepped effect on the
+screen, like this:
\c First line of text
\c Second line
\c Second line
\c Third line
-\S{config-erase} \q{Use background colour to erase screen}
+\S{config-erase} \q{Use \i{background colour} to erase screen}
\cfg{winhelp-topic}{terminal.bce}
Not all terminals agree on what colour to turn the screen when the
-server sends a \q{clear screen} sequence. Some terminals believe the
+server sends a \q{\i{clear screen}} sequence. Some terminals believe the
screen should always be cleared to the \e{default} background
colour. Others believe the screen should be cleared to whatever the
server has selected as a background colour.
default background colour. With this option enabled, it is done in
the \e{current} background colour.
-Background-colour erase can be turned on and off by control
-sequences sent by the server. This configuration option controls the
+Background-colour erase can be turned on and off by \i{control
+sequences} sent by the server. This configuration option controls the
\e{default} state, which will be restored when you reset the
terminal (see \k{reset-terminal}). However, if you modify this
option in mid-session using \q{Change Settings}, it will take effect
immediately.
-\S{config-blink} \q{Enable blinking text}
+\S{config-blink} \q{Enable \i{blinking text}}
\cfg{winhelp-topic}{terminal.blink}
off completely.
When blinking text is disabled and the server attempts to make some
-text blink, PuTTY will instead display the text with a bolded
-background colour.
+text blink, PuTTY will instead display the text with a \I{background
+colour, bright}bolded background colour.
-Blinking text can be turned on and off by control sequences sent by
+Blinking text can be turned on and off by \i{control sequence}s sent by
the server. This configuration option controls the \e{default}
state, which will be restored when you reset the terminal (see
\k{reset-terminal}). However, if you modify this option in
mid-session using \q{Change Settings}, it will take effect
immediately.
-\S{config-answerback} \q{Answerback to ^E}
+\S{config-answerback} \q{\ii{Answerback} to ^E}
\cfg{winhelp-topic}{terminal.answerback}
This option controls what PuTTY will send back to the server if the
-server sends it the ^E enquiry character. Normally it just sends
+server sends it the ^E \i{enquiry character}. Normally it just sends
the string \q{PuTTY}.
If you accidentally write the contents of a binary file to your
You can include control characters in the answerback string using
\c{^C} notation. (Use \c{^~} to get a literal \c{^}.)
-\S{config-localecho} \q{Local echo}
+\S{config-localecho} \q{\ii{Local echo}}
\cfg{winhelp-topic}{terminal.localecho}
With local echo disabled, characters you type into the PuTTY window
are not echoed in the window \e{by PuTTY}. They are simply sent to
-the server. (The \e{server} might choose to echo them back to you;
-this can't be controlled from the PuTTY control panel.)
+the server. (The \e{server} might choose to \I{remote echo}echo them
+back to you; this can't be controlled from the PuTTY control panel.)
Some types of session need local echo, and many do not. In its
default mode, PuTTY will automatically attempt to deduce whether or
echo to be turned on, or force it to be turned off, instead of
relying on the automatic detection.
-\S{config-localedit} \q{Local line editing}
+\S{config-localedit} \q{\ii{Local line editing}}
\cfg{winhelp-topic}{terminal.localedit}
server will never see the mistake.
Since it is hard to edit a line locally without being able to see
-it, local line editing is mostly used in conjunction with local echo
+it, local line editing is mostly used in conjunction with \i{local echo}
(\k{config-localecho}). This makes it ideal for use in raw mode
-\#{FIXME} or when connecting to MUDs or talkers. (Although some more
+\#{FIXME} or when connecting to \i{MUD}s or \i{talker}s. (Although some more
advanced MUDs do occasionally turn local line editing on and turn
local echo off, in order to accept a password from the user.)
local line editing to be turned on, or force it to be turned off,
instead of relying on the automatic detection.
-\S{config-printing} Remote-controlled printing
+\S{config-printing} \ii{Remote-controlled printing}
\cfg{winhelp-topic}{terminal.printing}
\H{config-keyboard} The Keyboard panel
The Keyboard configuration panel allows you to control the behaviour
-of the keyboard in PuTTY.
+of the \i{keyboard} in PuTTY.
-\S{config-backspace} Changing the action of the Backspace key
+\S{config-backspace} Changing the action of the \ii{Backspace key}
\cfg{winhelp-topic}{keyboard.backspace}
Some terminals believe that the Backspace key should send the same
-thing to the server as Control-H (ASCII code 8). Other terminals
+thing to the server as \i{Control-H} (ASCII code 8). Other terminals
believe that the Backspace key should send ASCII code 127 (usually
-known as Control-?) so that it can be distinguished from Control-H.
+known as \i{Control-?}) so that it can be distinguished from Control-H.
This option allows you to choose which code PuTTY generates when you
press Backspace.
If you are connecting to a Unix system, you will probably find that
-the Unix \c{stty} command lets you configure which the server
+the Unix \i\c{stty} command lets you configure which the server
expects to see, so you might not need to change which one PuTTY
generates. On other systems, the server's expectation might be fixed
and you might have no choice but to configure PuTTY.
(Typing \i{Shift-Backspace} will cause PuTTY to send whichever code
isn't configured here as the default.)
-\S{config-homeend} Changing the action of the Home and End keys
+\S{config-homeend} Changing the action of the \I{Home and End keys}
\cfg{winhelp-topic}{keyboard.homeend}
-The Unix terminal emulator \c{rxvt} disagrees with the rest of the
+The Unix terminal emulator \i\c{rxvt} disagrees with the rest of the
world about what character sequences should be sent to the server by
the Home and End keys.
-\c{xterm}, and other terminals, send \c{ESC [1~} for the Home key,
+\i\c{xterm}, and other terminals, send \c{ESC [1~} for the Home key,
and \c{ESC [4~} for the End key. \c{rxvt} sends \c{ESC [H} for the
Home key and \c{ESC [Ow} for the End key.
If you find an application on which the Home and End keys aren't
working, you could try switching this option to see if it helps.
-\S{config-funkeys} Changing the action of the function keys and keypad
+\S{config-funkeys} Changing the action of the \i{function keys} and
+\i{keypad}
\cfg{winhelp-topic}{keyboard.funkeys}
\b In Linux mode, F6 to F12 behave just like the default mode, but
F1 to F5 generate \c{ESC [[A} through to \c{ESC [[E}. This mimics the
-Linux virtual console.
+\i{Linux virtual console}.
-\b In Xterm R6 mode, F5 to F12 behave like the default mode, but F1
+\b In \I{xterm}Xterm R6 mode, F5 to F12 behave like the default mode, but F1
to F4 generate \c{ESC OP} through to \c{ESC OS}, which are the
sequences produced by the top row of the \e{keypad} on Digital's
terminals.
-\b In VT400 mode, all the function keys behave like the default
+\b In \i{VT400} mode, all the function keys behave like the default
mode, but the actual top row of the numeric keypad generates \c{ESC
OP} through to \c{ESC OS}.
-\b In VT100+ mode, the function keys generate \c{ESC OP} through to
+\b In \i{VT100+} mode, the function keys generate \c{ESC OP} through to
\c{ESC O[}
-\b In SCO mode, the function keys F1 to F12 generate \c{ESC [M}
+\b In \i{SCO} mode, the function keys F1 to F12 generate \c{ESC [M}
through to \c{ESC [X}. Together with shift, they generate \c{ESC [Y}
through to \c{ESC [j}. With control they generate \c{ESC [k} through
to \c{ESC [v}, and with shift and control together they generate
If you don't know what any of this means, you probably don't need to
fiddle with it.
-\S{config-appcursor} Controlling Application Cursor Keys mode
+\S{config-appcursor} Controlling \i{Application Cursor Keys} mode
\cfg{winhelp-topic}{keyboard.appcursor}
the \q{Features} configuration panel; see
\k{config-features-application}.
-\S{config-appkeypad} Controlling Application Keypad mode
+\S{config-appkeypad} Controlling \i{Application Keypad} mode
\cfg{winhelp-topic}{keyboard.appkeypad}
behaviour of the numeric keypad.
In normal mode, the keypad behaves like a normal Windows keypad:
-with NumLock on, the number keys generate numbers, and with NumLock
+with \i{NumLock} on, the number keys generate numbers, and with NumLock
off they act like the arrow keys and Home, End etc.
In application mode, all the keypad keys send special control
\q{Features} configuration panel; see
\k{config-features-application}.
-\S{config-nethack} Using NetHack keypad mode
+\S{config-nethack} Using \i{NetHack keypad mode}
\cfg{winhelp-topic}{keyboard.nethack}
to keep moving you in the same direction until you encounter
something interesting.
-For some reason, this feature only works properly when Num Lock is
+For some reason, this feature only works properly when \i{Num Lock} is
on. We don't know why.
-\S{config-compose} Enabling a DEC-like Compose key
+\S{config-compose} Enabling a DEC-like \ii{Compose key}
\cfg{winhelp-topic}{keyboard.compose}
DEC terminals have a Compose key, which provides an easy-to-remember
-way of typing accented characters. You press Compose and then type
+way of typing \i{accented characters}. You press Compose and then type
two more characters. The two characters are \q{combined} to produce
an accented character. The choices of character are designed to be
easy to remember; for example, composing \q{e} and \q{`} produces
the \q{\u00e8{e-grave}} character.
-If your keyboard has a Windows Application key, it acts as a Compose
-key in PuTTY. Alternatively, if you enable the \q{AltGr acts as
+If your keyboard has a Windows \i{Application key}, it acts as a Compose
+key in PuTTY. Alternatively, if you enable the \q{\i{AltGr} acts as
Compose key} option, the AltGr key will become a Compose key.
-\S{config-ctrlalt} \q{Control-Alt is different from AltGr}
+\S{config-ctrlalt} \q{Control-Alt is different from \i{AltGr}}
\cfg{winhelp-topic}{keyboard.ctrlalt}
\H{config-bell} The Bell panel
-The Bell panel controls the terminal bell feature: the server's
+The Bell panel controls the \i{terminal bell} feature: the server's
ability to cause PuTTY to beep at you.
In the default configuration, when the server sends the character
-with ASCII code 7 (Control-G), PuTTY will play the Windows Default
-Beep sound. This is not always what you want the terminal bell
+with ASCII code 7 (Control-G), PuTTY will play the \i{Windows Default
+Beep} sound. This is not always what you want the terminal bell
feature to do; the Bell panel allows you to configure alternative
actions.
This control allows you to select various different actions to occur
on a terminal bell:
-\b Selecting \q{None} disables the bell completely. In this mode,
-the server can send as many Control-G characters as it likes and
-nothing at all will happen.
+\b Selecting \q{None} \I{terminal bell, disabling}disables the bell
+completely. In this mode, the server can send as many Control-G
+characters as it likes and nothing at all will happen.
\b \q{Make default system alert sound} is the default setting. It
causes the Windows \q{Default Beep} sound to be played. To change
what this sound is, or to test it if nothing seems to be happening,
use the Sound configurer in the Windows Control Panel.
-\b \q{Visual bell} is a silent alternative to a beeping computer. In
+\b \q{\ii{Visual bell}} is a silent alternative to a beeping computer. In
this mode, when the server sends a Control-G, the whole PuTTY window
will flash white for a fraction of a second.
-\b \q{Beep using the PC speaker} is self-explanatory.
+\b \q{Beep using the \i{PC speaker}} is self-explanatory.
-\b \q{Play a custom sound file} allows you to specify a particular
+\b \q{Play a custom \i{sound file}} allows you to specify a particular
sound file to be used by PuTTY alone, or even by a particular
individual PuTTY session. This allows you to distinguish your PuTTY
beeps from any other beeps on the system. If you select this option,
you will also need to enter the name of your sound file in the edit
control \q{Custom sound file to play as a bell}.
-\S{config-belltaskbar} \q{Taskbar/caption indication on bell}
+\S{config-belltaskbar} \q{\ii{Taskbar}/\I{window caption}caption
+indication on bell}
\cfg{winhelp-topic}{bell.taskbar}
\q{Flashing} is even more eye-catching: the Taskbar entry will
continuously flash on and off until you select the window.
-\S{config-bellovl} \q{Control the bell overload behaviour}
+\S{config-bellovl} \q{Control the \i{bell overload} behaviour}
\cfg{winhelp-topic}{bell.overload}
beeping, PuTTY includes a bell overload management feature. In the
default configuration, receiving more than five bell characters in a
two-second period will cause the overload feature to activate. Once
-the overload feature is active, further bells will have no effect at
-all, so the rest of your binary file will be sent to the screen in
-silence. After a period of five seconds during which no further
-bells are received, the overload feature will turn itself off again
-and bells will be re-enabled.
+the overload feature is active, further bells will \I{terminal bell,
+disabling} have no effect at all, so the rest of your binary file
+will be sent to the screen in silence. After a period of five seconds
+during which no further bells are received, the overload feature will
+turn itself off again and bells will be re-enabled.
If you want this feature completely disabled, you can turn it off
using the checkbox \q{Bell is temporarily disabled when over-used}.
\H{config-features} The Features panel
-PuTTY's terminal emulation is very highly featured, and can do a lot
+PuTTY's \i{terminal emulation} is very highly featured, and can do a lot
of things under remote server control. Some of these features can
cause problems due to buggy or strangely configured server
applications.
\cfg{winhelp-topic}{features.application}
-Application keypad mode (see \k{config-appkeypad}) and application
+\I{Application Keypad}Application keypad mode (see
+\k{config-appkeypad}) and \I{Application Cursor Keys}application
cursor keys mode (see \k{config-appcursor}) alter the behaviour of
the keypad and cursor keys. Some applications enable these modes but
then do not deal correctly with the modified keys. You can force
these modes to be permanently disabled no matter what the server
tries to do.
-\S{config-features-mouse} Disabling \cw{xterm}-style mouse reporting
+\S{config-features-mouse} Disabling \cw{xterm}-style \i{mouse reporting}
\cfg{winhelp-topic}{features.mouse}
-PuTTY allows the server to send control codes that let it take over
-the mouse and use it for purposes other than copy and paste.
+PuTTY allows the server to send \i{control codes} that let it take over
+the mouse and use it for purposes other than \i{copy and paste}.
Applications which use this feature include the text-mode web
-browser \c{links}, the Usenet newsreader \c{trn} version 4, and the
-file manager \c{mc} (Midnight Commander).
+browser \i\c{links}, the Usenet newsreader \i\c{trn} version 4, and the
+file manager \i\c{mc} (Midnight Commander).
If you find this feature inconvenient, you can disable it using the
\q{Disable xterm-style mouse reporting} control. With this box
while you select and paste, unless you have deliberately turned this
feature off (see \k{config-mouseshift}).
-\S{config-features-resize} Disabling remote terminal resizing
+\S{config-features-resize} Disabling remote \i{terminal resizing}
\cfg{winhelp-topic}{features.resize}
this unexpectedly or inconveniently, you can tell PuTTY not to
respond to those server commands.
-\S{config-features-altscreen} Disabling switching to the alternate screen
+\S{config-features-altscreen} Disabling switching to the \i{alternate screen}
\cfg{winhelp-topic}{features.altscreen}
run in the same screen as the rest of your terminal activity, you
can disable the alternate screen feature completely.
-\S{config-features-retitle} Disabling remote window title changing
+\S{config-features-retitle} Disabling remote \i{window title} changing
\cfg{winhelp-topic}{features.retitle}
unexpectedly or inconveniently, you can tell PuTTY not to respond to
those server commands.
-\S{config-features-qtitle} Disabling remote window title querying
+\S{config-features-qtitle} Disabling remote \i{window title} querying
\cfg{winhelp-topic}{features.qtitle}
applications to find out the local window title. This feature is
disabled by default, but you can turn it on if you really want it.
-NOTE that this feature is a \e{potential security hazard}. If a
+NOTE that this feature is a \e{potential \i{security hazard}}. If a
malicious application can write data to your terminal (for example,
if you merely \c{cat} a file owned by someone else on the server
machine), it can change your window title (unless you have disabled
recommend you do not turn it on unless you \e{really} know what you
are doing.
-\S{config-features-dbackspace} Disabling destructive backspace
+\S{config-features-dbackspace} Disabling \i{destructive backspace}
\cfg{winhelp-topic}{features.dbackspace}
configure character 127 to perform a normal backspace (without
deleting a character) instead.
-\S{config-features-charset} Disabling remote character set
+\S{config-features-charset} Disabling remote \i{character set}
configuration
\cfg{winhelp-topic}{features.charset}
PuTTY has the ability to change its character set configuration in
response to commands from the server. Some programs send these
-commands unexpectedly or inconveniently. In particular, BitchX (an
+commands unexpectedly or inconveniently. In particular, \I{BitchX} (an
IRC client) seems to have a habit of reconfiguring the character set
to something other than the user intended.
expect them to, particularly if you're running BitchX, you could try
disabling the remote character set configuration commands.
-\S{config-features-shaping} Disabling Arabic text shaping
+\S{config-features-shaping} Disabling \i{Arabic text shaping}
\cfg{winhelp-topic}{features.arabicshaping}
PuTTY supports shaping of Arabic text, which means that if your
-server sends text written in the basic Unicode Arabic alphabet then
+server sends text written in the basic \i{Unicode} Arabic alphabet then
it will convert it to the correct display forms before printing it
on the screen.
to happen (especially if you are not an Arabic speaker and you
unexpectedly find yourself dealing with Arabic text files in
applications which are not Arabic-aware), you might find that the
-display becomes corrupted. By ticking this box, you can disable
+\i{display becomes corrupted}. By ticking this box, you can disable
Arabic text shaping so that PuTTY displays precisely the characters
it is told to display.
You may also find you need to disable bidirectional text display;
see \k{config-features-bidi}.
-\S{config-features-bidi} Disabling bidirectional text display
+\S{config-features-bidi} Disabling \i{bidirectional text} display
\cfg{winhelp-topic}{features.bidi}
PuTTY supports bidirectional text display, which means that if your
server sends text written in a language which is usually displayed
-from right to left (such as Arabic or Hebrew) then PuTTY will
+from right to left (such as \i{Arabic} or \i{Hebrew}) then PuTTY will
automatically flip it round so that it is displayed in the right
direction on the screen.
to happen (especially if you are not an Arabic speaker and you
unexpectedly find yourself dealing with Arabic text files in
applications which are not Arabic-aware), you might find that the
-display becomes corrupted. By ticking this box, you can disable
+\i{display becomes corrupted}. By ticking this box, you can disable
bidirectional text display, so that PuTTY displays text from left to
right in all situations.
\H{config-window} The Window panel
The Window configuration panel allows you to control aspects of the
-PuTTY window.
+\i{PuTTY window}.
-\S{config-winsize} Setting the size of the PuTTY window
+\S{config-winsize} Setting the \I{window size}size of the PuTTY window
\cfg{winhelp-topic}{window.size}
-The \q{Rows} and \q{Columns} boxes let you set the PuTTY window to a
-precise size. Of course you can also drag the window to a new size
-while a session is running.
+The \q{\ii{Rows}} and \q{\ii{Columns}} boxes let you set the PuTTY
+window to a precise size. Of course you can also \I{window resizing}drag
+the window to a new size while a session is running.
\S{config-winsizelock} What to do when the window is resized
\cfg{winhelp-topic}{window.resize}
These options allow you to control what happens when the user tries
-to resize the PuTTY window using its window furniture.
+to \I{window resizing}resize the PuTTY window using its window furniture.
There are four options here:
change. (This is the default.)
\b \q{Change the size of the font}: the number of rows and columns in
-the terminal will stay the same, and the font size will change.
+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 maximised (or restored), when the font size will change.
+is \i{maximise}d (or restored), when the font size will change.
\b \q{Forbid resizing completely}: the terminal will refuse to be
resized at all.
-\S{config-scrollback} Controlling scrollback
+\S{config-scrollback} Controlling \i{scrollback}
\cfg{winhelp-topic}{window.scrollback}
The \q{Lines of scrollback} box lets you configure how many lines of
text PuTTY keeps. The \q{Display scrollbar} options allow you to
-hide the scrollbar (although you can still view the scrollback using
+hide the \i{scrollbar} (although you can still view the scrollback using
the keyboard as described in \k{using-scrollback}). You can separately
-configure whether the scrollbar is shown in full-screen mode and in
+configure whether the scrollbar is shown in \i{full-screen} mode and in
normal modes.
If you are viewing part of the scrollback when the server sends more
clears the screen, so that your scrollback will contain a better
record of what was on your screen in the past.
-If the application switches to the alternate screen (see
+If the application switches to the \i{alternate screen} (see
\k{config-features-altscreen} for more about this), then the
contents of the primary screen will be visible in the scrollback
until the application switches back again.
\H{config-appearance} The Appearance panel
The Appearance configuration panel allows you to control aspects of
-the appearance of PuTTY's window.
+the appearance of \I{PuTTY window}PuTTY's window.
-\S{config-cursor} Controlling the appearance of the cursor
+\S{config-cursor} Controlling the appearance of the \i{cursor}
\cfg{winhelp-topic}{appearance.cursor}
empty box when the window loses focus; an underline or a vertical
line becomes dotted.
-The \q{Cursor blinks} option makes the cursor blink on and off. This
+The \q{\ii{Cursor blinks}} option makes the cursor blink on and off. This
works in any of the cursor modes.
-\S{config-font} Controlling the font used in the terminal window
+\S{config-font} Controlling the \i{font} used in the terminal window
\cfg{winhelp-topic}{appearance.font}
-This option allows you to choose what font, in what size, the PuTTY
-terminal window uses to display the text in the session. You will be
-offered a choice from all the fixed-width fonts installed on the
-system. (VT100-style terminal handling can only deal with fixed-
-width fonts.)
+This option allows you to choose what font, in what \I{font size}size,
+the PuTTY terminal window uses to display the text in the session. You
+will be offered a choice from all the fixed-width fonts installed on the
+system. (VT100-style terminal handling can only deal with fixed-width
+fonts.)
-\S{config-mouseptr} \q{Hide mouse pointer when typing in window}
+\S{config-mouseptr} \q{Hide \i{mouse pointer} when typing in window}
\cfg{winhelp-topic}{appearance.hidemouse}
This option is disabled by default, so the mouse pointer remains
visible at all times.
-\S{config-winborder} Controlling the window border
+\S{config-winborder} Controlling the \i{window border}
\cfg{winhelp-topic}{appearance.border}
\H{config-behaviour} The Behaviour panel
The Behaviour configuration panel allows you to control aspects of
-the behaviour of PuTTY's window.
+the behaviour of \I{PuTTY window}PuTTY's window.
-\S{config-title} Controlling the window title
+\S{config-title} Controlling the \i{window title}
\cfg{winhelp-topic}{appearance.title}
The \q{Window title} edit box allows you to set the title of the
-PuTTY window. By default the window title will contain the host name
+PuTTY window. By default the window title will contain the \i{host name}
followed by \q{PuTTY}, for example \c{server1.example.com - PuTTY}.
If you want a different window title, this is where to set it.
-PuTTY allows the server to send \c{xterm} control sequences which
+PuTTY allows the server to send \c{xterm} \i{control sequence}s which
modify the title of the window in mid-session (unless this is disabled -
see \k{config-features-retitle}); the title string set here
is therefore only the \e{initial} window title.
-As well as the \e{window} title, there is also an
-\c{xterm} sequence to modify the title of the window's \e{icon}.
+As well as the \e{window} title, there is also an \c{xterm}
+sequence to modify the \I{icon title}title of the window's \e{icon}.
This makes sense in a windowing system where the window becomes an
icon when minimised, such as Windows 3.1 or most X Window System
setups; but in the Windows 95-like user interface it isn't as
By default, PuTTY only uses the server-supplied \e{window} title, and
ignores the icon title entirely. If for some reason you want to see
both titles, check the box marked \q{Separate window and icon titles}.
-If you do this, PuTTY's window title and Taskbar caption will
-change into the server-supplied icon title if you minimise the PuTTY
+If you do this, PuTTY's window title and Taskbar \I{window caption}caption will
+change into the server-supplied icon title if you \i{minimise} the PuTTY
window, and change back to the server-supplied window title if you
restore it. (If the server has not bothered to supply a window or
icon title, none of this will happen.)
-\S{config-warnonclose} \q{Warn before closing window}
+\S{config-warnonclose} \q{Warn before \i{closing window}}
\cfg{winhelp-topic}{behaviour.closewarn}
-If you press the Close button in a PuTTY window that contains a
+If you press the \i{Close button} in a PuTTY window that contains a
running session, PuTTY will put up a warning window asking if you
really meant to close the window. A window whose session has already
terminated can always be closed without a warning.
If you want to be able to close a window quickly, you can disable
the \q{Warn before closing window} option.
-\S{config-altf4} \q{Window closes on ALT-F4}
+\S{config-altf4} \q{Window closes on \i{ALT-F4}}
\cfg{winhelp-topic}{behaviour.altf4}
-By default, pressing ALT-F4 causes the window to close (or a warning
-box to appear; see \k{config-warnonclose}). If you disable the
-\q{Window closes on ALT-F4} option, then pressing ALT-F4 will simply
-send a key sequence to the server.
+By default, pressing ALT-F4 causes the \I{closing window}window to
+close (or a warning box to appear; see \k{config-warnonclose}). If you
+disable the \q{Window closes on ALT-F4} option, then pressing ALT-F4
+will simply send a key sequence to the server.
-\S{config-altspace} \q{System menu appears on ALT-Space}
+\S{config-altspace} \q{\ii{System menu} appears on \i{ALT-Space}}
\cfg{winhelp-topic}{behaviour.altspace}
disabled, then pressing ALT-Space will just send \c{ESC SPACE} to
the server.
-Some accessibility programs for Windows may need this option
+Some \i{accessibility} programs for Windows may need this option
enabling to be able to control PuTTY's window successfully. For
-instance, Dragon NaturallySpeaking requires it both to open the
+instance, \i{Dragon NaturallySpeaking} requires it both to open the
system menu via voice, and to close, minimise, maximise and restore
the window.
-\S{config-altonly} \q{System menu appears on Alt alone}
+\S{config-altonly} \q{\ii{System menu} appears on \i{Alt} alone}
\cfg{winhelp-topic}{behaviour.altonly}
corner. If it is disabled, then pressing and releasing ALT will have
no effect.
-\S{config-alwaysontop} \q{Ensure window is always on top}
+\S{config-alwaysontop} \q{Ensure window is \i{always on top}}
\cfg{winhelp-topic}{behaviour.alwaysontop}
If this option is enabled, the PuTTY window will stay on top of all
other windows.
-\S{config-fullscreen} \q{Full screen on Alt-Enter}
+\S{config-fullscreen} \q{\ii{Full screen} on Alt-Enter}
\cfg{winhelp-topic}{behaviour.altenter}
PuTTY window to become full-screen. Pressing Alt-Enter again will
restore the previous window size.
-The full-screen feature is also available from the System menu, even
+The full-screen feature is also available from the \ii{System menu}, even
when it is configured not to be available on the Alt-Enter key. See
\k{using-fullscreen}.
\H{config-translation} The Translation panel
The Translation configuration panel allows you to control the
-translation between the character set understood by the server and
+translation between the \i{character set} understood by the server and
the character set understood by PuTTY.
\S{config-charset} Controlling character set translation
There are a lot of character sets to choose from. The \q{Received
data assumed to be in which character set} option lets you select
one. By default PuTTY will attempt to choose a character set that is
-right for your locale as reported by Windows; if it gets it wrong,
+right for your \i{locale} as reported by Windows; if it gets it wrong,
you can select a different one using this control.
A few notable character sets are:
-\b The ISO-8859 series are all standard character sets that include
+\b The \i{ISO-8859} series are all standard character sets that include
various accented characters appropriate for different sets of
languages.
-\b The Win125x series are defined by Microsoft, for similar
+\b The \i{Win125x} series are defined by Microsoft, for similar
purposes. In particular Win1252 is almost equivalent to ISO-8859-1,
but contains a few extra characters such as matched quotes and the
Euro symbol.
\b If you want the old IBM PC character set with block graphics and
-line-drawing characters, you can select \q{CP437}.
+line-drawing characters, you can select \q{\i{CP437}}.
-\b PuTTY also supports Unicode mode, in which the data coming from
-the server is interpreted as being in the UTF-8 encoding of Unicode.
+\b PuTTY also supports \i{Unicode} mode, in which the data coming from
+the server is interpreted as being in the \i{UTF-8} encoding of Unicode.
If you select \q{UTF-8} as a character set you can use this mode.
Not all server-side applications will support it.
-If you need support for a numeric code page which is not listed in
+If you need support for a numeric \i{code page} which is not listed in
the drop-down list, such as code page 866, then you can try entering
-its name manually (\c{CP866} for example) in the list box. If the
+its name manually (\c{\i{CP866}} for example) in the list box. If the
underlying version of Windows has the appropriate translation table
installed, PuTTY will use it.
-\S{config-cjk-ambig-wide} \q{Treat CJK ambiguous characters as wide}
+\S{config-cjk-ambig-wide} \q{Treat \i{CJK} ambiguous characters as wide}
\cfg{winhelp-topic}{translation.cjkambigwide}
There are \I{East Asian Ambiguous characters}some Unicode characters
-whose width is not well-defined. In most contexts, such characters
-should be treated as single-width for the purposes of wrapping and so
-on; however, in some CJK contexts, they are better treated as
-double-width for historical reasons, and some server-side applications
-may expect them to be displayed as such. Setting this option will
-cause PuTTY to take the double-width interpretation.
+whose \I{character width}width is not well-defined. In most contexts, such
+characters should be treated as single-width for the purposes of \I{wrapping,
+terminal}wrapping and so on; however, in some CJK contexts, they are better
+treated as double-width for historical reasons, and some server-side
+applications may expect them to be displayed as such. Setting this option
+will cause PuTTY to take the double-width interpretation.
If you use legacy CJK applications, and you find your lines are
wrapping in the wrong places, or you are having other display
problems, you might want to play with this setting.
-This option only has any effect in UTF-8 mode (see \k{config-charset}).
+This option only has any effect in \i{UTF-8} mode (see \k{config-charset}).
-\S{config-cyr} \q{Caps Lock acts as Cyrillic switch}
+\S{config-cyr} \q{\i{Caps Lock} acts as \i{Cyrillic} switch}
\cfg{winhelp-topic}{translation.cyrillic}
This feature allows you to switch between a US/UK keyboard layout
and a Cyrillic keyboard layout by using the Caps Lock key, if you
-need to type (for example) Russian and English side by side in the
+need to type (for example) \i{Russian} and English side by side in the
same document.
Currently this feature is not expected to work properly if your
native keyboard layout is not US or UK.
-\S{config-linedraw} Controlling display of line drawing characters
+\S{config-linedraw} Controlling display of \i{line-drawing characters}
\cfg{winhelp-topic}{translation.linedraw}
-VT100-series terminals allow the server to send control sequences that
+VT100-series terminals allow the server to send \i{control sequence}s that
shift temporarily into a separate character set for drawing simple
lines and boxes. However, there are a variety of ways in which PuTTY
can attempt to find appropriate characters, and the right one to use
-depends on the locally configured font. In general you should probably
+depends on the locally configured \i{font}. In general you should probably
try lots of options until you find one that your particular font
supports.
\b \q{Use Unicode line drawing code points} tries to use the box
-characters that are present in Unicode. For good Unicode-supporting
+characters that are present in \i{Unicode}. For good Unicode-supporting
fonts this is probably the most reliable and functional option.
\b \q{Poor man's line drawing} assumes that the font \e{cannot}
\b \q{Use font in OEM mode only} is more reliable than that, but can
miss out other characters from the main character set.
-\S{config-linedrawpaste} Controlling copy and paste of line drawing
+\S{config-linedrawpaste} Controlling \i{copy and paste} of line drawing
characters
\cfg{winhelp-topic}{selection.linedraw}
By default, when you copy and paste a piece of the PuTTY screen that
contains VT100 line and box drawing characters, PuTTY will paste
-them in the form they appear on the screen: either Unicode line
+them in the form they appear on the screen: either \i{Unicode} line
drawing code points, or the \q{poor man's} line-drawing characters
\c{+}, \c{-} and \c{|}. The checkbox \q{Copy and paste VT100 line
drawing chars as lqqqk} disables this feature, so line-drawing
-characters will be pasted as the ASCII characters that were printed
+characters will be pasted as the \i{ASCII} characters that were printed
to produce them. This will typically mean they come out mostly as
\c{q} and \c{x}, with a scattering of \c{jklmntuvw} at the corners.
This might be useful if you were trying to recreate the same box
\H{config-selection} The Selection panel
-The Selection panel allows you to control the way copy and paste
+The Selection panel allows you to control the way \i{copy and paste}
work in the PuTTY window.
-\S{config-rtfpaste} Pasting in Rich Text Format
+\S{config-rtfpaste} Pasting in \i{Rich Text Format}
\cfg{winhelp-topic}{selection.rtf}
PuTTY will write formatting information to the clipboard as well as
the actual text you copy. Currently the only effect of this will be
that if you paste into (say) a word processor, the text will appear
-in the word processor in the same font PuTTY was using to display
+in the word processor in the same \i{font} PuTTY was using to display
it. In future it is likely that other formatting information (bold,
underline, colours) will be copied as well.
PuTTY's copy and paste mechanism is by default modelled on the Unix
\c{xterm} application. The X Window System uses a three-button mouse,
-and the convention is that the left button selects, the right button
-extends an existing selection, and the middle button pastes.
+and the convention is that the \i{left button} \I{selecting text}selects,
+the \i{right button} extends an existing selection, and the
+\i{middle button} pastes.
Windows often only has two mouse buttons, so in PuTTY's default
configuration (\q{Compromise}), the \e{right} button pastes, and the
-\e{middle} button (if you have one) extends a selection.
+\e{middle} button (if you have one) \I{adjusting a selection}extends
+a selection.
-If you have a three-button mouse and you are already used to the
+If you have a \i{three-button mouse} and you are already used to the
\c{xterm} arrangement, you can select it using the \q{Action of
mouse buttons} control.
Alternatively, with the \q{Windows} option selected, the middle
-button extends, and the right button brings up a context menu (on
+button extends, and the right button brings up a \i{context menu} (on
which one of the options is \q{Paste}). (This context menu is always
available by holding down Ctrl and right-clicking, regardless of the
setting of this option.)
\cfg{winhelp-topic}{selection.shiftdrag}
-PuTTY allows the server to send control codes that let it take over
-the mouse and use it for purposes other than copy and paste.
+PuTTY allows the server to send \i{control codes} that let it
+\I{mouse reporting}take over the mouse and use it for purposes other
+than \i{copy and paste}.
Applications which use this feature include the text-mode web
browser \c{links}, the Usenet newsreader \c{trn} version 4, and the
file manager \c{mc} (Midnight Commander).
Normally, you have to hold down Alt while dragging the mouse to
select a rectangular block. Using the \q{Default selection mode}
-control, you can set rectangular selection as the default, and then
+control, you can set \i{rectangular selection} as the default, and then
you have to hold down Alt to get the \e{normal} behaviour.
-\S{config-charclasses} Configuring word-by-word selection
+\S{config-charclasses} Configuring \i{word-by-word selection}
\cfg{winhelp-topic}{selection.charclasses}
PuTTY will select a word at a time in the terminal window if you
-double-click to begin the drag. This panel allows you to control
+\i{double-click} to begin the drag. This panel allows you to control
precisely what is considered to be a word.
Each character is given a \e{class}, which is a small number
assignment of characters to classes, you can modify the word-by-word
selection behaviour.
-In the default configuration, the character classes are:
+In the default configuration, the \i{character classes} are:
-\b Class 0 contains white space and control characters.
+\b Class 0 contains \i{white space} and control characters.
-\b Class 1 contains most punctuation.
+\b Class 1 contains most \i{punctuation}.
\b Class 2 contains letters, numbers and a few pieces of punctuation
(the double quote, minus sign, period, forward slash and
This mechanism currently only covers ASCII characters, because it
isn't feasible to expand the list to cover the whole of Unicode.
-Character class definitions can be modified by control sequences
+Character class definitions can be modified by \i{control sequence}s
sent by the server. This configuration option controls the
\e{default} state, which will be restored when you reset the
terminal (see \k{reset-terminal}). However, if you modify this
\H{config-colours} The Colours panel
-The Colours panel allows you to control PuTTY's use of colour.
+The Colours panel allows you to control PuTTY's use of \i{colour}.
-\S{config-ansicolour} \q{Allow terminal to specify ANSI colours}
+\S{config-ansicolour} \q{Allow terminal to specify \i{ANSI colours}}
\cfg{winhelp-topic}{colours.ansi}
This option is enabled by default. If it is disabled, PuTTY will
-ignore any control sequences sent by the server to request coloured
+ignore any \i{control sequence}s sent by the server to request coloured
text.
If you have a particularly garish application, you might want to
turn this option off and make PuTTY only use the default foreground
and background colours.
-\S{config-xtermcolour} \q{Allow terminal to use xterm 256-colour mode}
+\S{config-xtermcolour} \q{Allow terminal to use xterm \i{256-colour mode}}
\cfg{winhelp-topic}{colours.xterm256}
If you have an application which is supposed to use 256-colour mode
and it isn't working, you may find you need to tell your server that
your terminal supports 256 colours. On Unix, you do this by ensuring
-that the setting of \cw{TERM} describes a 256-colour-capable
+that the setting of \i\cw{TERM} describes a 256-colour-capable
terminal. You can check this using a command such as \c{infocmp}:
\c $ infocmp | grep colors
\cfg{winhelp-topic}{colours.bold}
-When the server sends a control sequence indicating that some text
-should be displayed in bold, PuTTY can handle this two ways. It can
-either change the font for a bold version, or use the same font in a
+When the server sends a \i{control sequence} indicating that some text
+should be displayed in \i{bold}, PuTTY can handle this two ways. It can
+either change the \i{font} for a bold version, or use the same font in a
brighter colour. This control lets you choose which.
By default the box is checked, so non-bold text is displayed in
will be displayed in the same colour, and instead the font will
change to indicate the difference.
-\S{config-logpalette} \q{Attempt to use logical palettes}
+\S{config-logpalette} \q{Attempt to use \i{logical palettes}}
\cfg{winhelp-topic}{colours.logpal}
Logical palettes are a mechanism by which a Windows application
-running on an 8-bit colour display can select precisely the colours
+running on an \i{8-bit colour} display can select precisely the colours
it wants instead of going with the Windows standard defaults.
If you are not getting the colours you ask for on an 8-bit display,
you can try enabling this option. However, be warned that it's never
worked very well.
-\S{config-syscolour} \q{Use system colours}
+\S{config-syscolour} \q{Use \i{system colours}}
\cfg{winhelp-topic}{colours.system}
Enabling this option will cause PuTTY to ignore the configured colours
-for \q{Default Background/Foreground} and \q{Cursor Colour/Text} (see
+for \I{default background}\I{default foreground}\q{Default
+Background/Foreground} and \I{cursor colour}\q{Cursor Colour/Text} (see
\k{config-colourcfg}), instead going with the system-wide defaults.
-Note that non-bold and bold text will be the same colour if this
+Note that non-bold and \i{bold text} will be the same colour if this
option is enabled. You might want to change to indicating bold text
by font changes (see \k{config-boldcolour}).
-\S{config-colourcfg} Adjusting the colours in the terminal window
+\S{config-colourcfg} Adjusting the colours in the \i{terminal window}
\cfg{winhelp-topic}{colours.config}
The main colour control allows you to specify exactly what colours
things should be displayed in. To modify one of the PuTTY colours,
-use the list box to select which colour you want to modify. The RGB
-values for that colour will appear on the right-hand side of the
+use the list box to select which colour you want to modify. The \i{RGB
+values} for that colour will appear on the right-hand side of the
list box. Now, if you press the \q{Modify} button, you will be
presented with a colour selector, in which you can choose a new
colour to go in place of the old one.
-PuTTY allows you to set the cursor colour, the default foreground
-and background, and the precise shades of all the ANSI configurable
-colours (black, red, green, yellow, blue, magenta, cyan, and white).
-You can also modify the precise shades used for the bold versions of
-these colours; these are used to display bold text if you have
-selected \q{Bolded text is a different colour}, and can also be used
-if the server asks specifically to use them. (Note that \q{Default
+PuTTY allows you to set the \i{cursor colour}, the \i{default foreground}
+and \I{default background}background, and the precise shades of all the
+\I{ANSI colours}ANSI configurable colours (black, red, green, yellow, blue,
+magenta, cyan, and white). You can also modify the precise shades used for
+the \i{bold} versions of these colours; these are used to display bold text
+if you have selected \q{Bolded text is a different colour}, and can also be
+used if the server asks specifically to use them. (Note that \q{Default
Bold Background} is \e{not} the background colour used for bold text;
it is only used if the server specifically asks for a bold
background.)
\H{config-connection} The Connection panel
The Connection panel allows you to configure options that apply to
-more than one type of connection.
+more than one type of \i{connection}.
-\S{config-keepalive} Using keepalives to prevent disconnection
+\S{config-keepalive} Using \i{keepalives} to prevent disconnection
\cfg{winhelp-topic}{connection.keepalive}
\q{Connection reset by peer}) after they have been idle for a while,
you might want to try using this option.
-Some network routers and firewalls need to keep track of all
+Some network \i{routers} and \i{firewalls} need to keep track of all
connections through them. Usually, these firewalls will assume a
connection is dead if no data is transferred in either direction
after a certain time interval. This can cause PuTTY sessions to be
The keepalive option (\q{Seconds between keepalives}) allows you to
configure PuTTY to send data through the session at regular
intervals, in a way that does not disrupt the actual terminal
-session. If you find your firewall is cutting idle connections off,
+session. If you find your firewall is cutting \i{idle connections} off,
you can try entering a non-zero value in this field. The value is
measured in seconds; so, for example, if your firewall cuts
connections off after ten minutes then you might want to enter 300
Note that keepalives are not always helpful. They help if you have a
firewall which drops your connection after an idle period; but if
-the network between you and the server suffers from breaks in
-connectivity then keepalives can actually make things worse. If a
+the network between you and the server suffers from \i{breaks in
+connectivity} then keepalives can actually make things worse. If a
session is idle, and connectivity is temporarily lost between the
endpoints, but the connectivity is restored before either side tries
to send anything, then there will be no problem - neither endpoint
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
+Note that if you are using \i{SSH-1} and the server has a bug that makes
it unable to deal with SSH-1 ignore messages (see
\k{config-ssh-bug-ignore1}), enabling keepalives will have no effect.
-\S{config-nodelay} \q{Disable Nagle's algorithm}
+\S{config-nodelay} \q{Disable \i{Nagle's algorithm}}
\cfg{winhelp-topic}{connection.nodelay}
Nagle's algorithm is a detail of TCP/IP implementations that tries
to minimise the number of small data packets sent down a network
-connection. With Nagle's algorithm enabled, PuTTY's bandwidth usage
+connection. With Nagle's algorithm enabled, PuTTY's \i{bandwidth} usage
will be slightly more efficient; with it disabled, you may find you
get a faster response to your keystrokes when connecting to some
types of server.
-The Nagle algorithm is disabled by default for interactive connections.
+The Nagle algorithm is disabled by default for \i{interactive connections}.
-\S{config-tcp-keepalives} \q{Enable TCP keepalives}
+\S{config-tcp-keepalives} \q{Enable \i{TCP keepalives}}
\cfg{winhelp-topic}{connection.tcpkeepalive}
it may send out more in quick succession and terminate the connection
if no response is received.
-TCP keepalives may be more useful for ensuring that half-open connections
+TCP keepalives may be more useful for ensuring that \i{half-open connections}
are terminated than for keeping a connection alive.
TCP keepalives are disabled by default.
-\S{config-address-family} \q{Internet protocol}
+\S{config-address-family} \I{Internet protocol version}\q{Internet protocol}
\cfg{winhelp-topic}{connection.ipversion}
This option allows the user to select between the old and new
-Internet protocols and addressing schemes (IPv4 and IPv6). The
+Internet protocols and addressing schemes (\i{IPv4} and \i{IPv6}). The
default setting is \q{Auto}, which means PuTTY will do something
sensible and try to guess which protocol you wanted. (If you specify
-a literal Internet address, it will use whichever protocol that
-address implies. If you provide a hostname, it will see what kinds
+a literal \i{Internet address}, it will use whichever protocol that
+address implies. If you provide a \i{hostname}, it will see what kinds
of address exist for that hostname; it will use IPv6 if there is an
IPv6 address available, and fall back to IPv4 if not.)
Options which apply to only one protocol appear on that protocol's
configuration panels.
-\S{config-username} \q{Auto-login username}
+\S{config-username} \q{\ii{Auto-login username}}
\cfg{winhelp-topic}{connection.username}
In this box you can type that user name.
-\S{config-termtype} \q{Terminal-type string}
+\S{config-termtype} \q{\ii{Terminal-type} string}
\cfg{winhelp-topic}{connection.termtype}
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 control sequences to each one, the server will need
+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
down the connection describing the terminal.
-PuTTY attempts to emulate the Unix \c{xterm} program, and by default
+PuTTY attempts to emulate the Unix \i\c{xterm} program, and by default
it reflects this by sending \c{xterm} as a terminal-type string. If
you find this is not doing what you want - perhaps the remote
system reports \q{Unknown terminal type} - you could try setting
-this to something different, such as \c{vt220}.
+this to something different, such as \i\c{vt220}.
If you're not sure whether a problem is due to the terminal type
setting or not, you probably need to consult the manual for your
application or your server.
-\S{config-termspeed} \q{Terminal speeds}
+\S{config-termspeed} \q{\ii{Terminal speed}s}
\cfg{winhelp-topic}{connection.termspeed}
which is always \q{as fast as possible}; it is just a hint that is
sometimes used by server software to modify its behaviour. For
instance, if a slow speed is indicated, the server may switch to a
-less bandwidth-hungry display mode.
+less \i{bandwidth}-hungry display mode.
The value is usually meaningless in a network environment, but
PuTTY lets you configure it, in case you find the server is reacting
This option has no effect on Raw connections.
-\S{config-environ} Setting environment variables on the server
+\S{config-environ} Setting \i{environment variables} on the server
\cfg{winhelp-topic}{telnet.environ}
whole mechanism.
Version 2 of the SSH protocol also provides a similar mechanism,
-which is easier to implement without security flaws. Newer SSH-2
+which is easier to implement without security flaws. Newer \i{SSH-2}
servers are more likely to support it than older ones.
This configuration data is not used in the SSH-1, rlogin or raw
\cfg{winhelp-topic}{proxy.main}
-The Proxy panel allows you to configure PuTTY to use various types
+The \ii{Proxy} panel allows you to configure PuTTY to use various types
of proxy in order to make its network connections. The settings in
this panel affect the primary network connection forming your PuTTY
-session, but also any extra connections made as a result of SSH port
-forwarding (see \k{using-port-forwarding}).
+session, but also any extra connections made as a result of SSH \i{port
+forwarding} (see \k{using-port-forwarding}).
\S{config-proxy-type} Setting the proxy type
setting is \q{None}; in this mode no proxy is used for any
connection.
-\b Selecting \q{HTTP} allows you to proxy your connections through a
-web server supporting the HTTP \cw{CONNECT} command, as documented
+\b Selecting \I{HTTP proxy}\q{HTTP} allows you to proxy your connections
+through a web server supporting the HTTP \cw{CONNECT} command, as documented
in \W{http://www.ietf.org/rfc/rfc2817.txt}{RFC 2817}.
\b Selecting \q{SOCKS 4} or \q{SOCKS 5} allows you to proxy your
-connections through a SOCKS server.
+connections through a \i{SOCKS server}.
\b Many firewalls implement a less formal type of proxy in which a
user can make a Telnet connection directly to the firewall machine
and enter a command such as \c{connect myhost.com 22} to connect
-through to an external host. Selecting \q{Telnet} allows you to tell
-PuTTY to use this type of proxy.
+through to an external host. Selecting \I{Telnet proxy}\q{Telnet}
+allows you to tell PuTTY to use this type of proxy.
\S{config-proxy-exclude} Excluding parts of the network from proxying
This excludes both of the above ranges at once.
-Connections to the local host (the host name \c{localhost}, and any
-loopback IP address) are never proxied, even if the proxy exclude
+Connections to the local host (the host name \i\c{localhost}, and any
+\i{loopback IP address}) are never proxied, even if the proxy exclude
list does not explicitly contain them. It is very unlikely that this
behaviour would ever cause problems, but if it does you can change
it by enabling \q{Consider proxying local host connections}.
-Note that if you are doing DNS at the proxy (see
+Note that if you are doing \I{proxy DNS}DNS at the proxy (see
\k{config-proxy-dns}), you should make sure that your proxy
exclusion settings do not depend on knowing the IP address of a
host. If the name is passed on to the proxy without PuTTY looking it
up, it will never know the IP address and cannot check it against
your list.
-\S{config-proxy-dns} Name resolution when using a proxy
+\S{config-proxy-dns} \I{proxy DNS}\ii{Name resolution} when using a proxy
\cfg{winhelp-topic}{proxy.dns}
If you are using a proxy to access a private network, it can make a
-difference whether DNS name resolution is performed by PuTTY itself
+difference whether \i{DNS} name resolution is performed by PuTTY itself
(on the client machine) or performed by the proxy.
The \q{Do DNS name lookup at proxy end} configuration option allows
all SOCKS 4 servers provide this extension. If you enable proxy DNS
and your SOCKS 4 server cannot deal with it, this might be why.
-\S{config-proxy-auth} Username and password
+\S{config-proxy-auth} \I{proxy username}Username and \I{proxy password}password
\cfg{winhelp-topic}{proxy.auth}
-If your proxy requires authentication, you can enter a username and
-a password in the \q{Username} and \q{Password} boxes.
+If your proxy requires \I{proxy authentication}authentication, you can
+enter a username and a password in the \q{Username} and \q{Password} boxes.
-Note that if you save your session, the proxy password will be
-saved in plain text, so anyone who can access your PuTTY
+\I{security hazard}Note that if you save your session, the proxy
+password will be saved in plain text, so anyone who can access your PuTTY
configuration data will be able to discover it.
Authentication is not fully supported for all forms of proxy:
\b With SOCKS 5, authentication is via \i{CHAP} if the proxy
supports it (this is not supported in \i{PuTTYtel}); otherwise the
-password is sent to the proxy in plain text.
+password is sent to the proxy in \I{plaintext password}plain text.
\b With HTTP proxying, the only currently supported authentication
-method is \q{basic}, where the password is sent to the proxy in plain
-text.
+method is \I{HTTP basic}\q{basic}, where the password is sent to the proxy
+in \I{plaintext password}plain text.
}
\cfg{winhelp-topic}{proxy.command}
-If you are using the Telnet proxy type, the usual command required
+If you are using the \i{Telnet proxy} type, the usual command required
by the firewall's Telnet server is \c{connect}, followed by a host
name and a port number. If your proxy needs a different command,
you can enter an alternative here.
tokens in the Telnet command, then the \q{Username} and \q{Password}
configuration fields will be ignored.
-\H{config-telnet} The Telnet panel
+\H{config-telnet} The \i{Telnet} panel
The Telnet panel allows you to configure options that only apply to
Telnet sessions.
\cfg{winhelp-topic}{telnet.oldenviron}
-The original Telnet mechanism for passing environment variables was
+The original Telnet mechanism for passing \i{environment variables} was
badly specified. At the time the standard (RFC 1408) was written,
BSD telnet implementations were already supporting the feature, and
the intention of the standard was to describe the behaviour the BSD
Sadly there was a typing error in the standard when it was issued,
and two vital function codes were specified the wrong way round. BSD
implementations did not change, and the standard was not corrected.
-Therefore, it's possible you might find either BSD or RFC-compliant
+Therefore, it's possible you might find either \i{BSD} or \i{RFC}-compliant
implementations out there. This switch allows you to choose which
one PuTTY claims to be.
The problem was solved by issuing a second standard, defining a new
-Telnet mechanism called \cw{NEW_ENVIRON}, which behaved exactly like
-the original \cw{OLD_ENVIRON} but was not encumbered by existing
+Telnet mechanism called \i\cw{NEW_ENVIRON}, which behaved exactly like
+the original \i\cw{OLD_ENVIRON} but was not encumbered by existing
implementations. Most Telnet servers now support this, and it's
unambiguous. This feature should only be needed if you have trouble
passing environment variables to quite an old server.
-\S{config-ptelnet} Passive and active Telnet negotiation modes
+\S{config-ptelnet} Passive and active \i{Telnet negotiation} modes
\cfg{winhelp-topic}{telnet.passive}
PuTTY can use two different strategies for negotiation:
-\b In \e{active} mode, PuTTY starts to send negotiations as soon as
-the connection is opened.
+\b In \I{active Telnet negotiation}\e{active} mode, PuTTY starts to send
+negotiations as soon as the connection is opened.
-\b In \e{passive} mode, PuTTY will wait to negotiate until it sees a
-negotiation from the server.
+\b In \I{passive Telnet negotiation}\e{passive} mode, PuTTY will wait to
+negotiate until it sees a negotiation from the server.
The obvious disadvantage of passive mode is that if the server is
also operating in a passive mode, then negotiation will never begin
at all. For this reason PuTTY defaults to active mode.
However, sometimes passive mode is required in order to successfully
-get through certain types of firewall and Telnet proxy server. If
-you have confusing trouble with a firewall, you could try enabling
+get through certain types of firewall and \i{Telnet proxy} server. If
+you have confusing trouble with a \i{firewall}, you could try enabling
passive mode to see if it helps.
-\S{config-telnetkey} \q{Keyboard sends Telnet special commands}
+\S{config-telnetkey} \q{Keyboard sends \i{Telnet special commands}}
\cfg{winhelp-topic}{telnet.specialkeys}
You probably shouldn't enable this
unless you know what you're doing.
-\S{config-telnetnl} \q{Return key sends Telnet New Line instead of ^M}
+\S{config-telnetnl} \q{Return key sends \i{Telnet New Line} instead of ^M}
\cfg{winhelp-topic}{telnet.newline}
Unlike most other remote login protocols, the Telnet protocol has a
-special \q{new line} code that is not the same as the usual line
+special \q{\i{new line}} code that is not the same as the usual line
endings of Control-M or Control-J. By default, PuTTY sends the
Telnet New Line code when you press Return, instead of sending
Control-M as it does in most other protocols.
\H{config-rlogin} The Rlogin panel
-The Rlogin panel allows you to configure options that only apply to
+The \i{Rlogin} panel allows you to configure options that only apply to
Rlogin sessions.
-\S{config-rlogin-localuser} \q{Local username}
+\S{config-rlogin-localuser} \I{local username in Rlogin}\q{Local username}
\cfg{winhelp-topic}{rlogin.localuser}
Rlogin allows an automated (password-free) form of login by means of
-a file called \c{.rhosts} on the server. You put a line in your
+a file called \i\c{.rhosts} on the server. You put a line in your
\c{.rhosts} file saying something like \c{jbloggs@pc1.example.com},
and then when you make an Rlogin connection the client transmits the
username of the user running the Rlogin client. The server checks
the username and hostname against \c{.rhosts}, and if they match it
-does not ask for a password.
+\I{passwordless login}does not ask for a password.
This only works because Unix systems contain a safeguard to stop a
user from pretending to be another user in an Rlogin connection.
-Rlogin connections have to come from port numbers below 1024, and
-Unix systems prohibit this to unprivileged processes; so when the
+Rlogin connections have to come from \I{privileged port}port numbers below
+1024, and Unix systems prohibit this to unprivileged processes; so when the
server sees a connection from a low-numbered port, it assumes the
client end of the connection is held by a privileged (and therefore
trusted) process, so it believes the claim of who the user is.
\c{.rhosts} mechanism is completely useless for securely
distinguishing several different users on a Windows machine. If you
have a \c{.rhosts} entry pointing at a Windows PC, you should assume
-that \e{anyone} using that PC can spoof your username in an Rlogin
-connection and access your account on the server.
+that \e{anyone} using that PC can \i{spoof} your username in
+an Rlogin connection and access your account on the server.
The \q{Local username} control allows you to specify what user name
-PuTTY should claim you have, in case it doesn't match your Windows
-user name (or in case you didn't bother to set up a Windows user
+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-ssh} The SSH panel
-The SSH panel allows you to configure options that only apply to
+The \i{SSH} panel allows you to configure options that only apply to
SSH sessions.
\S{config-command} Executing a specific command on the server
In SSH, you don't have to run a general shell session on the server.
Instead, you can choose to run a single specific command (such as a
mail user agent, for example). If you want to do this, enter the
-command in the \q{Remote command} box.
+command in the \q{\ii{Remote command}} box.
-\S{config-ssh-pty} \q{Don't allocate a pseudo-terminal}
+\S{config-ssh-pty} \I{pseudo-terminal allocation}\q{Don't allocate
+a pseudo-terminal}
\cfg{winhelp-topic}{ssh.nopty}
-When connecting to a Unix system, most interactive shell sessions
-are run in a \e{pseudo-terminal}, which allows the Unix system to
-pretend it's talking to a real physical terminal device but allows
-the SSH server to catch all the data coming from that fake device
-and send it back to the client.
+When connecting to a \i{Unix} system, most \I{interactive
+connections}interactive shell sessions are run in a \e{pseudo-terminal},
+which allows the Unix system to pretend it's talking to a real physical
+terminal device but allows the SSH server to catch all the data coming
+from that fake device and send it back to the client.
Occasionally you might find you have a need to run a session \e{not}
in a pseudo-terminal. In PuTTY, this is generally only useful for
very specialist purposes; although in Plink (see \k{plink}) it is
the usual way of working.
-\S{config-ssh-noshell} \q{Don't start a shell or command at all}
+\S{config-ssh-noshell} \q{Don't start a \I{remote shell}shell or
+\I{remote command}command at all}
\cfg{winhelp-topic}{ssh.noshell}
If you tick this box, PuTTY will not attempt to run a shell or
command after connecting to the remote server. You might want to use
-this option if you are only using the SSH connection for port
-forwarding, and your user account on the server does not have the
+this option if you are only using the SSH connection for \i{port
+forwarding}, and your user account on the server does not have the
ability to run a shell.
-This feature is only available in SSH protocol version 2 (since the
+This feature is only available in \i{SSH protocol version 2} (since the
version 1 protocol assumes you will always want to run a shell).
This feature can also be enabled using the \c{-N} command-line
will be by pressing Control-C or sending a kill signal from another
program.
-\S{config-ssh-comp} \q{Enable compression}
+\S{config-ssh-comp} \q{Enable \i{compression}}
\cfg{winhelp-topic}{ssh.compress}
the server is compressed before sending, and decompressed at the
client end. Likewise, data sent by PuTTY to the server is compressed
first and the server decompresses it at the other end. This can help
-make the most of a low-bandwidth connection.
+make the most of a low-\i{bandwidth} connection.
-\S{config-ssh-prot} \q{Preferred SSH protocol version}
+\S{config-ssh-prot} \q{Preferred \i{SSH protocol version}}
\cfg{winhelp-topic}{ssh.protocol}
-This allows you to select whether you would like to use SSH protocol
-version 1 or version 2. \#{FIXME: say something about this elsewhere?}
+This allows you to select whether you would like to use \i{SSH protocol
+version 1} or \I{SSH-2}version 2. \#{FIXME: say something about this elsewhere?}
PuTTY will attempt to use protocol 1 if the server you connect to
does not offer protocol 2, and vice versa.
if the server you connect to offers the SSH protocol version you
have specified.
-\S{config-ssh-encryption} Encryption algorithm selection
+\S{config-ssh-encryption} \ii{Encryption} algorithm selection
\cfg{winhelp-topic}{ssh.ciphers}
-PuTTY supports a variety of different encryption algorithms, and
+PuTTY supports a variety of different \i{encryption algorithm}s, and
allows you to choose which one you prefer to use. You can do this by
dragging the algorithms up and down in the list box (or moving them
using the Up and Down buttons) to specify a preference order. When
PuTTY currently supports the following algorithms:
-\b AES (Rijndael) - 256, 192, or 128-bit CBC (SSH-2 only)
+\b \i{AES} (Rijndael) - 256, 192, or 128-bit CBC (SSH-2 only)
-\b Blowfish - 128-bit CBC
+\b \i{Blowfish} - 128-bit CBC
-\b Triple-DES - 168-bit CBC
+\b \ii{Triple-DES} - 168-bit CBC
-\b Single-DES - 56-bit CBC (see below for SSH-2)
+\b \ii{Single-DES} - 56-bit CBC (see below for SSH-2)
If the algorithm PuTTY finds is below the \q{warn below here} line,
you will see a warning box when you make the connection:
\# FIXME: This whole section is draft. Feel free to revise.
-The Kex panel (short for \q{key exchange}) allows you to configure
+The Kex panel (short for \q{\i{key exchange}}) allows you to configure
options related to SSH-2 key exchange.
Key exchange occurs at the start of an SSH connection (and
-occasionally thereafter); it establishes a shared secret that is used
+occasionally thereafter); it establishes a \i{shared secret} that is used
as the basis for all of SSH's security features. It is therefore very
important for the security of the connection that the key exchange is
secure.
This entire panel is only relevant to SSH protocol version 2; none of
these settings affect SSH-1 at all.
-\S{config-ssh-kex-order} Key exchange algorithm selection
+\S{config-ssh-kex-order} \ii{Key exchange algorithm} selection
\cfg{winhelp-topic}{ssh.kex.order}
to choose which one you prefer to use; configuration is similar to
cipher selection (see \k{config-ssh-encryption}).
-PuTTY currently supports the following varieties of Diffie-Hellman key
-exchange:
+PuTTY currently supports the following varieties of \i{Diffie-Hellman key
+exchange}:
\b \q{Group 14}: a well-known 2048-bit group.
client or server machines, and may be the only method supported by
older server software.
-\b \q{Group exchange}: with this method, instead of using a fixed
+\b \q{\ii{Group exchange}}: with this method, instead of using a fixed
group, PuTTY requests that the server suggest a group to use for key
exchange; the server can avoid groups known to be weak, and possibly
invent new ones over time, without any changes required to PuTTY's
line, you will see a warning box when you make the connection, similar
to that for cipher selection (see \k{config-ssh-encryption}).
-\S{config-ssh-kex-rekey} Repeat key exchange
+\S{config-ssh-kex-rekey} \ii{Repeat key exchange}
\cfg{winhelp-topic}{ssh.kex.repeat}
specification recommends a timeout of at most 60 minutes.
You might have a need to disable time-based rekeys completely for the same
-reasons that keepalives aren't always helpful. If you anticipate
+reasons that \i{keepalives} aren't always helpful. If you anticipate
suffering a network dropout of several hours in the middle of an SSH
connection, but were not actually planning to send \e{data} down
that connection during those hours, then an attempted rekey in the
middle of the dropout will probably cause the connection to be
abandoned, whereas if rekeys are disabled then the connection should
-in principle survive (in the absence of interfering firewalls). See
+in principle survive (in the absence of interfering \i{firewalls}). See
\k{config-keepalive} for more discussion of these issues; for these
purposes, rekeys have much the same properties as keepalives.
(Except that rekeys have cryptographic value in themselves, so you
}
-Disabling data-based rekeys entirely is a bad idea. The integrity,
-and to a lesser extent, confidentiality of the SSH-2 protocol depend
+Disabling data-based rekeys entirely is a bad idea. The \i{integrity},
+and to a lesser extent, \i{confidentiality} of the SSH-2 protocol depend
in part on rekeys occuring before a 32-bit packet sequence number
wraps around. Unlike time-based rekeys, data-based rekeys won't occur
when the SSH connection is idle, so they shouldn't cause the same
\H{config-ssh-auth} The Auth panel
-The Auth panel allows you to configure authentication options for
+The Auth panel allows you to configure \i{authentication} options for
SSH sessions.
-\S{config-ssh-tis} \q{Attempt TIS or CryptoCard authentication}
+\S{config-ssh-tis} \q{Attempt \I{TIS authentication}TIS or
+\i{CryptoCard authentication}}
\cfg{winhelp-topic}{ssh.auth.tis}
-TIS and CryptoCard authentication are simple challenge/response
-forms of authentication available in SSH protocol version 1 only.
-You might use them if you were using S/Key one-time passwords, for
-example, or if you had a physical security token that generated
-responses to authentication challenges.
+TIS and CryptoCard authentication are simple \I{challenge/response
+authentication}challenge/response forms of authentication available in
+SSH protocol version 1 only. You might use them if you were using \i{S/Key}
+\i{one-time passwords}, for example, or if you had a physical \i{security
+token} that generated responses to authentication challenges.
With this switch enabled, PuTTY will attempt these forms of
authentication if the server is willing to try them. You will be
administrator about precisely what form these challenges and
responses take.
-\S{config-ssh-ki} \q{Attempt keyboard-interactive authentication}
+\S{config-ssh-ki} \q{Attempt \i{keyboard-interactive authentication}}
\cfg{winhelp-topic}{ssh.auth.ki}
The SSH-2 equivalent of TIS authentication is called
\q{keyboard-interactive}. It is a flexible authentication method
using an arbitrary sequence of requests and responses; so it is not
-only useful for challenge/response mechanisms such as S/Key, but it
-can also be used for (for example) asking the user for a new
-password when the old one has expired.
+only useful for \I{challenge/response authentication}challenge/response
+mechanisms such as \i{S/Key}, but it can also be used for (for example)
+asking the user for a \I{password expiry}new password when the old one
+has expired.
PuTTY leaves this option enabled by default, but supplies a switch
to turn it off in case you should have trouble with it.
-\S{config-ssh-agentfwd} \q{Allow agent forwarding}
+\S{config-ssh-agentfwd} \q{Allow \i{agent forwarding}}
\cfg{winhelp-topic}{ssh.auth.agentfwd}
This option allows the SSH server to open forwarded connections back
-to your local copy of Pageant. If you are not running Pageant, this
+to your local copy of \i{Pageant}. If you are not running Pageant, this
option will do nothing.
See \k{pageant} for general information on Pageant, and
there is a security risk involved with enabling this option; see
\k{pageant-security} for details.
-\S{config-ssh-changeuser} \q{Allow attempted changes of username in SSH-2}
+\S{config-ssh-changeuser} \q{Allow attempted \i{changes of username} in SSH-2}
\cfg{winhelp-topic}{ssh.auth.changeuser}
The SSH-2 protocol \e{does} allow changes of username, in principle,
but does not make it mandatory for SSH-2 servers to accept them. In
-particular, OpenSSH does not accept a change of username; once you
+particular, \i{OpenSSH} does not accept a change of username; once you
have sent one username, it will reject attempts to try to
authenticate as another user. (Depending on the version of OpenSSH,
it may quietly return failure for all login attempts, or it may send
your server can cope with it, you can enable the \q{Allow attempted
changes of username} option to modify PuTTY's behaviour.
-\S{config-ssh-privkey} \q{Private key file for authentication}
+\S{config-ssh-privkey} \q{\ii{Private key} file for authentication}
\cfg{winhelp-topic}{ssh.auth.privkey}
This box is where you enter the name of your private key file if you
-are using public key authentication. See \k{pubkey} for information
+are using \i{public key authentication}. See \k{pubkey} for information
about public key authentication in SSH.
-This key must be in PuTTY's native format (\c{*.PPK}). If you have a
+This key must be in PuTTY's native format (\c{*.\i{PPK}}). If you have a
private key in another format that you want to use with PuTTY, see
\k{puttygen-conversions}.
\cfg{winhelp-topic}{ssh.tunnels.x11}
-The X11 panel allows you to configure forwarding of X11 over an
+The X11 panel allows you to configure \i{forwarding of X11} over an
SSH connection.
If your server lets you run X Window System applications, X11
See \k{using-x-forwarding} for more information about X11
forwarding.
-\S{config-ssh-x11auth} Remote X11 authentication
+\S{config-ssh-x11auth} Remote \i{X11 authentication}
\cfg{winhelp-topic}{ssh.tunnels.x11auth}
data is invented, and checked, by PuTTY.
The usual authorisation method used for this is called
-\cw{MIT-MAGIC-COOKIE-1}. This is a simple password-style protocol:
+\i\cw{MIT-MAGIC-COOKIE-1}. This is a simple password-style protocol:
the X client sends some cookie data to the server, and the server
checks that it matches the real cookie. The cookie data is sent over
an unencrypted X11 connection; so if you allow a client on a third
machine to access the virtual X server, then the cookie will be sent
in the clear.
-PuTTY offers the alternative protocol \cw{XDM-AUTHORIZATION-1}. This
+PuTTY offers the alternative protocol \i\cw{XDM-AUTHORIZATION-1}. This
is a cryptographically authenticated protocol: the data sent by the
X client is different every time, and it depends on the IP address
and port of the client's end of the connection and is also stamped
PuTTY's default is \cw{MIT-MAGIC-COOKIE-1}. If you change it, you
should be sure you know what you're doing.
-\H{config-ssh-portfwd} The Tunnels panel
+\H{config-ssh-portfwd} \I{port forwarding}The Tunnels panel
\cfg{winhelp-topic}{ssh.tunnels.portfwd}
The Tunnels panel allows you to configure tunnelling of arbitrary
connection types through an SSH connection.
-Port forwarding allows you to tunnel other types of network
-connection down an SSH session. See \k{using-port-forwarding} for a
+Port forwarding allows you to tunnel other types of \i{network
+connection} down an SSH session. See \k{using-port-forwarding} for a
general discussion of port forwarding and how it works.
The port forwarding section in the Tunnels panel shows a list of all
To add a port forwarding:
\b Set one of the \q{Local} or \q{Remote} radio buttons, depending
-on whether you want to forward a local port to a remote destination
-(\q{Local}) or forward a remote port to a local destination
-(\q{Remote}). Alternatively, select \q{Dynamic} if you want PuTTY to
-provide a local SOCKS 4/4A/5 proxy on a local port.
+on whether you want to \I{local port forwarding}forward a local port
+to a remote destination (\q{Local}) or \I{remote port forwarding}forward
+a remote port to a local destination (\q{Remote}). Alternatively,
+select \q{Dynamic} if you want PuTTY to \I{dynamic port forwarding}provide
+a local SOCKS 4/4A/5 proxy on a local port.
-\b Enter a source port number into the \q{Source port} box. For
+\b Enter a source \i{port number} into the \q{Source port} box. For
local forwardings, PuTTY will listen on this port of your PC. For
remote forwardings, your SSH server will listen on this port of the
remote machine. Note that most servers will not allow you to listen
-on port numbers less than 1024.
+on \I{privileged port}port numbers less than 1024.
\b If you have selected \q{Local} or \q{Remote} (this step is not
needed with \q{Dynamic}), enter a hostname and port number separated
To remove a port forwarding, simply select its details in the list
box, and click the \q{Remove} button.
-In the \q{Source port} box, you can also optionally enter an IP
-address to listen on, by specifying (for instance) \c{127.0.0.5:79}.
+In the \q{Source port} box, you can also optionally enter an \I{listen
+address}IP address to listen on, by specifying (for instance)
+\c{127.0.0.5:79}.
See \k{using-port-forwarding} for more information on how this
works and its restrictions.
-In place of port numbers, you can enter service names, if they are
+In place of port numbers, you can enter \i{service names}, if they are
known to the local system. For instance, in the \q{Destination} box,
you could enter \c{popserver.example.com:pop3}.
stop listening on a remote port.
\b The SSH-2 protocol does contain such a mechanism, but not all SSH
-servers support it. (In particular, OpenSSH does not support it in
+servers support it. (In particular, \i{OpenSSH} does not support it in
any version earlier than 3.9.)
If you ask to delete a remote port forwarding and PuTTY cannot make
\cfg{winhelp-topic}{ssh.tunnels.portfwd.localhost}
The source port for a forwarded connection usually does not accept
-connections from any machine except the SSH client or server machine
-itself (for local and remote forwardings respectively). There are
-controls in the Tunnels panel to change this:
+connections from any machine except the \I{localhost}SSH client or
+server machine itself (for local and remote forwardings respectively).
+There are controls in the Tunnels panel to change this:
\b The \q{Local ports accept connections from other hosts} option
allows you to set up local-to-remote port forwardings in such a way
remote-to-local port forwardings (so that machines other than the
SSH server machine can connect to the forwarded port.) Note that
this feature is only available in the SSH-2 protocol, and not all
-SSH-2 servers support it (OpenSSH 3.0 does not, for example).
+SSH-2 servers support it (\i{OpenSSH} 3.0 does not, for example).
-\S{config-ssh-portfwd-address-family} Selecting Internet protocol
-version for forwarded ports
+\S{config-ssh-portfwd-address-family} Selecting \i{Internet protocol
+version} for forwarded ports
\cfg{winhelp-topic}{ssh.tunnels.portfwd.ipversion}
-This switch allows you to select a specific Internet protocol (IPv4
-or IPv6) for the local end of a forwarded port. By default, it is
+This switch allows you to select a specific Internet protocol (\i{IPv4}
+or \i{IPv6}) for the local end of a forwarded port. By default, it is
set on \q{Auto}, which means that:
\b for a local-to-remote port forwarding, PuTTY will listen for
Note that some operating systems may listen for incoming connections
in IPv4 even if you specifically asked for IPv6, because their IPv4
-and IPv6 protocol stacks are linked together. Apparently Linux does
+and IPv6 protocol stacks are linked together. Apparently \i{Linux} does
this, and Windows does not. So if you're running PuTTY on Windows
and you tick \q{IPv6} for a local or dynamic port forwarding, it
will \e{only} be usable by connecting to it using IPv6; whereas if
ticking \q{Auto} should always give you a port which you can connect
to using either protocol.
-\H{config-ssh-bugs} The Bugs panel
+\H{config-ssh-bugs} \I{SSH server bugs}The Bugs panel
Not all SSH servers work properly. Various existing servers have
bugs in them, which can make it impossible for a client to talk to
\b \q{Auto}: PuTTY will use the server's version number announcement
to try to guess whether or not the server has the bug.
-\S{config-ssh-bug-ignore1} \q{Chokes on SSH-1 ignore messages}
+\S{config-ssh-bug-ignore1} \q{Chokes on SSH-1 \i{ignore message}s}
\cfg{winhelp-topic}{ssh.bugs.ignore1}
This is an SSH-1-specific bug. No known SSH-2 server fails to deal
with SSH-2 ignore messages.
-\S{config-ssh-bug-plainpw1} \q{Refuses all SSH-1 password camouflage}
+\S{config-ssh-bug-plainpw1} \q{Refuses all SSH-1 \i{password camouflage}}
\cfg{winhelp-topic}{ssh.bugs.plainpw1}
This is an SSH-1-specific bug. SSH-2 is secure against this type of
attack.
-\S{config-ssh-bug-rsa1} \q{Chokes on SSH-1 RSA authentication}
+\S{config-ssh-bug-rsa1} \q{Chokes on SSH-1 \i{RSA} authentication}
\cfg{winhelp-topic}{ssh.bugs.rsa1}
Some SSH-1 servers cannot deal with RSA authentication messages at
-all. If Pageant is running and contains any SSH-1 keys, PuTTY will
+all. If \i{Pageant} is running and contains any SSH-1 keys, PuTTY will
normally automatically try RSA authentication before falling back to
passwords, so these servers will crash when they see the RSA attempt.
\cfg{winhelp-topic}{ssh.bugs.hmac2}
Versions 2.3.0 and below of the SSH server software from
-\cw{ssh.com} compute the keys for their HMAC message authentication
-codes incorrectly. A typical symptom of this problem is that PuTTY
+\cw{ssh.com} compute the keys for their \i{HMAC} \i{message authentication
+code}s incorrectly. A typical symptom of this problem is that PuTTY
dies unexpectedly at the beginning of the session, saying
\q{Incorrect MAC received on packet}.
This is an SSH-2-specific bug.
-\S{config-ssh-bug-derivekey2} \q{Miscomputes SSH-2 encryption keys}
+\S{config-ssh-bug-derivekey2} \q{Miscomputes SSH-2 \i{encryption} keys}
\cfg{winhelp-topic}{ssh.bugs.derivekey2}
-Versions below 2.0.11 of the SSH server software from \cw{ssh.com}
+Versions below 2.0.11 of the SSH server software from \i\cw{ssh.com}
compute the keys for the session encryption incorrectly. This
problem can cause various error messages, such as \q{Incoming packet
was garbled on decryption}, or possibly even \q{Out of memory}.
This is an SSH-2-specific bug.
-\S{config-ssh-bug-sig} \q{Requires padding on SSH-2 RSA signatures}
+\S{config-ssh-bug-sig} \q{Requires padding on SSH-2 \i{RSA} \i{signatures}}
\cfg{winhelp-topic}{ssh.bugs.rsapad2}
-Versions below 3.3 of OpenSSH require SSH-2 RSA signatures to be
+Versions below 3.3 of \i{OpenSSH} require SSH-2 RSA signatures to be
padded with zero bytes to the same length as the RSA key modulus.
The SSH-2 draft specification says that an unpadded signature MUST be
accepted, so this is a bug. A typical symptom of this problem is
This is an SSH-2-specific bug.
-\S{config-ssh-bug-pksessid2} \q{Misuses the session ID in SSH-2 PK auth}
+\S{config-ssh-bug-pksessid2} \q{Misuses the \i{session ID} in SSH-2 PK auth}
\cfg{winhelp-topic}{ssh.bugs.pksessid2}
-Versions below 2.3 of OpenSSH require SSH-2 public-key authentication
+Versions below 2.3 of \i{OpenSSH} require SSH-2 \i{public-key authentication}
to be done slightly differently: the data to be signed by the client
contains the session ID formatted in a different way. If public-key
authentication mysteriously does not work but the Event Log (see
\cfg{winhelp-topic}{ssh.bugs.rekey2}
-Some SSH servers cannot cope with repeat key exchange at
+Some SSH servers cannot cope with \i{repeat key exchange} at
all, and will ignore attempts by the client to start one. Since
PuTTY pauses the session while performing a repeat key exchange, the
effect of this would be to cause the session to hang after an hour
This is an SSH-2-specific bug.
-\H{config-file} Storing configuration in a file
+\H{config-file} \ii{Storing configuration in a file}
PuTTY does not currently support storing its configuration in a file
-instead of the Registry. However, you can work around this with a
-couple of batch files.
+instead of the \i{Registry}. However, you can work around this with a
+couple of \i{batch file}s.
You will need a file called (say) \c{PUTTY.BAT} which imports the
contents of a file into the Registry, then runs PuTTY, exports the
\define{versioniderrors} \versionid $Id$
-\C{errors} Common error messages
+\C{errors} Common \i{error messages}
This chapter lists a number of common error messages which PuTTY and
its associated tools can produce, and explains what they mean in
If you see this message and you know that your installation of PuTTY
\e{has} connected to the same server before, it may have been
recently upgraded to SSH protocol version 2. SSH protocols 1 and 2
-use separate host keys, so when you first use SSH-2 with a server
+use separate host keys, so when you first use \i{SSH-2} with a server
you have only used SSH-1 with before, you will see this message
again. You should verify the correctness of the key as before.
\H{errors-portfwd-space} \q{Out of space for port forwardings}
PuTTY has a fixed-size buffer which it uses to store the details of
-all port forwardings you have set up in an SSH session. If you
+all \i{port forwardings} you have set up in an SSH session. If you
specify too many port forwardings on the PuTTY or Plink command line
and this buffer becomes full, you will see this error message.
This occurs when the SSH server does not offer any ciphers which you
have configured PuTTY to consider strong enough. By default, PuTTY
-puts up this warning only for single-DES encryption.
+puts up this warning only for \ii{single-DES} encryption.
See \k{config-ssh-encryption} for more information on this message.
\H{errors-toomanyauth} \q{Server sent disconnect message type 2
(SSH_DISCONNECT_PROTOCOL_ERROR): "Too many authentication failures for root"}
-This message is produced by an OpenSSH (or Sun SSH) server if it
+This message is produced by an \i{OpenSSH} (or \i{Sun SSH}) server if it
receives more failed authentication attempts than it is willing to
tolerate. This can easily happen if you are using Pageant and have a
large number of keys loaded into it. This can be worked around on the
really satisfactory solution, and we hope to provide a better one in a
future version of PuTTY.
-\H{errors-memory} \q{Out of memory}
+\H{errors-memory} \q{\ii{Out of memory}}
This occurs when PuTTY tries to allocate more memory than the system
can give it. This \e{may} happen for genuine reasons: if the
This can happen in SSH-2, if PuTTY and the server have not enabled
encryption in the same way (see \k{faq-outofmem} in the FAQ). Some
-versions of OpenSSH have a known problem with this: see
+versions of \i{OpenSSH} have a known problem with this: see
\k{faq-openssh-bad-openssl}.
-This can also happen in PSCP or PSFTP, if your login scripts on the
+This can also happen in PSCP or PSFTP, if your \i{login scripts} on the
server generate output: the client program will be expecting an SFTP
message starting with a length, and if it receives some text from
your login scripts instead it will try to interpret them as a
message length. See \k{faq-outofmem2} for details of this.
-\H{errors-internal} \q{Internal error}, \q{Internal fault},
-\q{Assertion failed}
+\H{errors-internal} \q{\ii{Internal error}}, \q{\ii{Internal fault}},
+\q{\ii{Assertion failed}}
Any error beginning with the word \q{Internal} should \e{never}
occur. If it does, there is a bug in PuTTY by definition; please see
Upgrade your server, or use the workarounds described in
\k{config-ssh-bug-ignore1} and possibly \k{config-ssh-bug-plainpw1}.
-\H{errors-crc} \q{Incorrect CRC received on packet} or \q{Incorrect
+\H{errors-crc} \q{Incorrect \i{CRC} received on packet} or \q{Incorrect
MAC received on packet}
This error occurs when PuTTY decrypts an SSH packet and its checksum
manages to reboot fully before you next attempt to send data to it.
However, the most common reason to see this message is if you are
-connecting through a firewall or a NAT router which has timed the
+connecting through a \i{firewall} or a \i{NAT router} which has timed the
connection out. See \k{faq-idleout} in the FAQ for more details. You
may be able to improve the situation by using keepalives; see
\k{config-keepalive} for details on this.
your server machine. If that fails, consult the administrator of
your server.
-Unix also generates this error when it tries to send data down a
+\i{Unix} also generates this error when it tries to send data down a
connection and contact with the server has been completely lost
during a connection. (There is a delay of minutes before Unix gives
up on receiving a reply from the server.) This can occur if you type
\define{versionidfaq} \versionid $Id$
-\A{faq} PuTTY FAQ
+\A{faq} PuTTY \i{FAQ}
This FAQ is published on the PuTTY web site, and also provided as an
appendix in the manual.
\H{faq-support} Features supported in PuTTY
-In general, if you want to know if PuTTY supports a particular
-feature, you should look for it on the
+\I{supported features}In general, if you want to know if PuTTY supports
+a particular feature, you should look for it on the
\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}{PuTTY web site}.
In particular:
Yes. SSH-1 support has always been available in PuTTY.
-\S{faq-localecho}{Question} Does PuTTY support local echo?
+\S{faq-localecho}{Question} Does PuTTY support \i{local echo}?
Yes. Version 0.52 has proper support for local echo.
Yes; this is a new feature in version 0.52.
\S{faq-password-remember}{Question} Does PuTTY have the ability to
-remember my password so I don't have to type it every time?
+\i{remember my password} so I don't have to type it every time?
No, it doesn't.
authentication.
\S{faq-hostkeys}{Question} Is there an option to turn off the
-annoying host key prompts?
+\I{verifying the host key}annoying host key prompts?
No, there isn't. And there won't be. Even if you write it yourself
and send us the patch, we won't accept it.
ones will not. Adding an option to turn host key checking off
completely is the wrong solution and we will not do it.
-If you have host keys available in the common \c{known_hosts} format,
+If you have host keys available in the common \i\c{known_hosts} format,
we have a script called
\W{http://www.tartarus.org/~simon-anonsvn/viewcvs.cgi/putty/contrib/kh2reg.py?view=markup}\c{kh2reg.py}
to convert them to a Windows .REG file, which can be installed ahead of
anyone else wants to try it.
\S{faq-pscp-ascii}{Question} Can PSCP or PSFTP transfer files in
-ASCII mode?
+\i{ASCII} mode?
Unfortunately not.
There are some third-party ports to various platforms, mentioned
on the Links page of our website.
-\S{faq-unix}{Question} Is there a port to Unix?
+\S{faq-unix}{Question} \I{Unix version}Is there a port to Unix?
As of 0.54, there are Unix ports of most of the traditional PuTTY
tools, and also one entirely new application.
If you look at the source release, you should find a \c{unix}
subdirectory containing \c{Makefile.gtk}, which should build you Unix
ports of Plink, PuTTY itself, PuTTYgen, PSCP, PSFTP, and also
-\c{pterm} - an \cw{xterm}-type program which supports the same
+\i\c{pterm} - an \cw{xterm}-type program which supports the same
terminal emulation as PuTTY. We do not yet have a Unix port of
Pageant.
-If you don't have Gtk, you should still be able to build the
+If you don't have \i{Gtk}, you should still be able to build the
command-line tools.
Note that Unix PuTTY has mostly only been tested on Linux so far;
There's also a third-party port at
\W{http://pocketputty.duxy.net/}\c{http://pocketputty.duxy.net/}.
-\S{faq-win31}{Question} Is there a port to Windows 3.1?
+\S{faq-win31}{Question} Is there a port to \i{Windows 3.1}?
PuTTY is a 32-bit application from the ground up, so it won't run on
Windows 3.1 as a native 16-bit program; and it would be \e{very}
allocation mechanisms.
However, it is possible in theory to compile the existing PuTTY
-source in such a way that it will run under Win32s (an extension to
+source in such a way that it will run under \i{Win32s} (an extension to
Windows 3.1 to let you run 32-bit programs). In order to do this
you'll need the right kind of C compiler - modern versions of Visual
C at least have stopped being backwards compatible to Win32s. Also,
If you're interested in running PuTTY under Windows 3.1, help and
testing in this area would be very welcome!
-\S{faq-mac-port}{Question} Will there be a port to the Mac?
+\S{faq-mac-port}{Question} Will there be a port to the \I{Mac OS}Mac?
There are several answers to this question:
\H{faq-details} Details of PuTTY's operation
-\S{faq-term}{Question} What terminal type does PuTTY use?
+\S{faq-term}{Question} What \i{terminal type} does PuTTY use?
For most purposes, PuTTY can be considered to be an \cw{xterm}
terminal.
-PuTTY also supports some terminal control sequences not supported by
+PuTTY also supports some terminal \i{control sequences} not supported by
the real \cw{xterm}: notably the Linux console sequences that
reconfigure the colour palette, and the title bar control sequences
-used by \cw{DECterm} (which are different from the \cw{xterm} ones;
+used by \i\cw{DECterm} (which are different from the \cw{xterm} ones;
PuTTY supports both).
By default, PuTTY announces its terminal type to the server as
\S{faq-settings}{Question} Where does PuTTY store its data?
On Windows, PuTTY stores most of its data (saved sessions, SSH host
-keys) in the Registry. The precise location is
+keys) in the \i{Registry}. The precise location is
\c HKEY_CURRENT_USER\Software\SimonTatham\PuTTY
\H{faq-howto} HOWTO questions
-\S{faq-commands}{Question} What commands can I type into my PuTTY
-terminal window?
+\S{faq-commands}{Question} \I{commands on the server}What commands
+can I type into my PuTTY terminal window?
This is not a question you should be asking \e{us}. You need to read
the manuals, or ask the administrator, of \e{the computer you have
does not administer any server you are likely to be connecting to,
and cannot help you with questions of this type.
-\S{faq-startmax}{Question} How can I make PuTTY start up maximised?
+\S{faq-startmax}{Question} How can I make PuTTY start up \i{maximise}d?
Create a Windows shortcut to start PuTTY from, and set it as \q{Run
Maximized}.
-\S{faq-startsess}{Question} How can I create a Windows shortcut to
+\S{faq-startsess}{Question} How can I create a \i{Windows shortcut} to
start a particular saved session directly?
To run a PuTTY session saved under the name \q{\cw{mysession}},
a saved session that specifies the SSH protocol, and start the saved
session as shown in \k{faq-startsess}.
-\S{faq-cutpaste}{Question} How do I copy and paste between PuTTY and
+\S{faq-cutpaste}{Question} How do I \i{copy and paste} between PuTTY and
other Windows applications?
Copy and paste works similarly to the X Window System. You use the
To use PSCP properly, run it from a Command Prompt window. See
\k{pscp} in the documentation for more details.
-\S{faq-pscp-spaces}{Question} How do I use PSCP to copy a file whose
-name has spaces in?
+\S{faq-pscp-spaces}{Question} \I{spaces in filenames}How do I use
+PSCP to copy a file whose name has spaces in?
If PSCP is using the traditional SCP protocol, this is confusing. If
you're specifying a file at the local end, you just use one set of
this with 0.52 as well, if a buggy server exists that PuTTY doesn't
know about.
-In this context MAC stands for Message Authentication Code. It's a
+In this context MAC stands for \ii{Message Authentication Code}. It's a
cryptographic term, and it has nothing at all to do with Ethernet
MAC (Media Access Control) addresses.
that was part of the PSCP protocol exchange, and instead it saw data
that it couldn't make any sense of at all.
-This almost always happens because the startup scripts in your
+This almost always happens because the \i{startup scripts} in your
account on the server machine are generating output. This is
impossible for PSCP, or any other SCP client, to work around. You
should never use startup files (\c{.bashrc}, \c{.cshrc} and so on)
then all other SCP clients are likely to fail in exactly the same
way. The problem is at the server end.
-\S{faq-colours}{Question} I clicked on a colour in the Colours
+\S{faq-colours}{Question} I clicked on a colour in the \ii{Colours}
panel, and the colour didn't change in my terminal.
That isn't how you're supposed to use the Colours panel.
only allow you to adjust the \e{shade} of green used when PuTTY is
instructed by the server to display green text.
-\S{faq-winsock2}{Question} Plink on Windows 95 says it can't find
-\cw{WS2_32.DLL}.
+\S{faq-winsock2}{Question} Plink on \i{Windows 95} says it can't find
+\i\cw{WS2_32.DLL}.
Plink requires the extended Windows network library, WinSock version
2. This is installed as standard on Windows 98 and above, and on
\c wuadmintools/s_wunetworkingtools/w95sockets2/
\S{faq-outofmem}{Question} After trying to establish an SSH-2
-connection, PuTTY says \q{Out of memory} and dies.
+connection, PuTTY says \q{\ii{Out of memory}} and dies.
If this happens just while the connection is starting up, this often
indicates that for some reason the client and server have failed to
out of memory.
\S{faq-outofmem2}{Question} When attempting a file transfer, either
-PSCP or PSFTP says \q{Out of memory} and dies.
+PSCP or PSFTP says \q{\ii{Out of memory}} and dies.
-This is almost always caused by your login scripts on the server
+This is almost always caused by your \i{login scripts} on the server
generating output. PSCP or PSFTP will receive that output when they
were expecting to see the start of a file transfer protocol, and
they will attempt to interpret the output as file-transfer protocol.
\S{faq-bce}{Question} When I run full-colour applications, I see
areas of black space where colour ought to be, or vice versa.
-You almost certainly need to change the \q{Use background colour to
+You almost certainly need to change the \q{Use \i{background colour} to
erase screen} setting in the Terminal panel. If there is too much
black space (the commoner situation), you should enable it, while if
there is too much colour, you should disable it. (See \k{config-erase}.)
\S{faq-resetterm}{Question} When I change some terminal settings,
nothing happens.
-Some of the terminal options (notably Auto Wrap and
+Some of the terminal options (notably \ii{Auto Wrap} and
background-colour screen erase) actually represent the \e{default}
setting, rather than the currently active setting. The server can
send sequences that modify these options in mid-session, but when
settings take effect immediately.
\S{faq-idleout}{Question} My PuTTY sessions unexpectedly close after
-they are idle for a while.
+they are \I{idle connections}idle for a while.
-Some types of firewall, and almost any router doing Network Address
-Translation (NAT, also known as IP masquerading), will forget about
+Some types of \i{firewall}, and almost any router doing Network Address
+Translation (\i{NAT}, also known as IP masquerading), will forget about
a connection through them if the connection does nothing for too
long. This will cause the connection to be rudely cut off when
contact is resumed.
this.
\S{faq-timeout}{Question} PuTTY's network connections time out too
-quickly when network connectivity is temporarily lost.
+quickly when \I{breaks in connectivity}network connectivity is
+temporarily lost.
This is a Windows problem, not a PuTTY problem. The timeout value
can't be set on per application or per session basis. To increase
your terminal is likely to cause various other unpleasant behaviour,
so this is only a small remedy.
-\S{faq-wintitle}{Question} When I \cw{cat} a binary file, my window
-title changes to a nonsense string.
+\S{faq-wintitle}{Question} When I \cw{cat} a binary file, my \i{window
+title} changes to a nonsense string.
Don't do that, then.
manual), and follow the guidelines contained in that.
\S{faq-openssh-bad-openssl}{Question} Since my SSH server was upgraded
-to OpenSSH 3.1p1/3.4p1, I can no longer connect with PuTTY.
+to \i{OpenSSH} 3.1p1/3.4p1, I can no longer connect with PuTTY.
There is a known problem when OpenSSH has been built against an
incorrect version of OpenSSL; the quick workaround is to configure
To connect using SSH-2 to a server that supports both versions, you
need to change the configuration from the default (see \k{faq-ssh2}).
-\S{faq-rh8-utf8}{Question} When I'm connected to a Red Hat Linux 8.0
+\S{faq-rh8-utf8}{Question} When I'm connected to a \i{Red Hat Linux} 8.0
system, some characters don't display properly.
A common complaint is that hyphens in man pages show up as a-acute.
-With release 8.0, Red Hat appear to have made UTF-8 the default
+With release 8.0, Red Hat appear to have made \i{UTF-8} the default
character set. There appears to be no way for terminal emulators such
as PuTTY to know this (as far as we know, the appropriate escape
sequence to switch into UTF-8 mode isn't sent).
scrollback has stopped working when I run \c{screen}.
PuTTY's terminal emulator has always had the policy that when the
-\q{alternate screen} is in use, nothing is added to the scrollback.
+\q{\i{alternate screen}} is in use, nothing is added to the scrollback.
This is because the usual sorts of programs which use the alternate
screen are things like text editors, which tend to scroll back and
forth in the same document a lot; so (a) they would fill up the
the alternate screen, and previous versions of PuTTY did not support
this sequence.
-\S{faq-alternate-localhost}{Question} Since I upgraded Windows XP
+\S{faq-alternate-localhost}{Question} Since I upgraded \i{Windows XP}
to Service Pack 2, I can't use addresses like \cw{127.0.0.2}.
-Some people who ask PuTTY to listen on localhost addresses other
-than \cw{127.0.0.1} to forward services such as SMB and Windows
-Terminal Services have found that doing so no longer works since
+Some people who ask PuTTY to listen on \i{localhost} addresses other
+than \cw{127.0.0.1} to forward services such as \i{SMB} and \i{Windows
+Terminal Services} have found that doing so no longer works since
they upgraded to WinXP SP2.
This is apparently an issue with SP2 that is acknowledged by Microsoft
\c /dir1/dir2filename.ext: no such file or directory
This is not a bug in PSFTP. There is a known bug in some versions of
-portable OpenSSH
+portable \i{OpenSSH}
(\W{http://bugzilla.mindrot.org/show_bug.cgi?id=697}{bug 697}) that
causes these symptoms; it appears to have been introduced around
3.7.x. It manifests only on certain platforms (AIX is what has been
floppy).
\S{faq-cleanup}{Question} What does PuTTY leave on a system? How can
-I clean up after it?
+I \i{clean up} after it?
PuTTY will leave some Registry entries, and a random seed file, on
the PC (see \k{faq-settings}). If you are using PuTTY on a public
appear in \q{Add/Remove Programs}. Uninstallation does not currently
remove the above-mentioned registry entries and file.
-\S{faq-dsa}{Question} How come PuTTY now supports DSA, when the
+\S{faq-dsa}{Question} How come PuTTY now supports \i{DSA}, when the
website used to say how insecure it was?
DSA has a major weakness \e{if badly implemented}: it relies on a
\H{faq-misc} Miscellaneous questions
-\S{faq-openssh}{Question} Is PuTTY a port of OpenSSH, or based on
+\S{faq-openssh}{Question} Is PuTTY a port of \i{OpenSSH}, or based on
OpenSSH?
No, it isn't. PuTTY is almost completely composed of code written
\define{versionidfeedback} \versionid $Id$
-\A{feedback} Feedback and bug reporting
+\A{feedback} \ii{Feedback} and \i{bug reporting}
This is a guide to providing feedback to the PuTTY development team.
It is provided as both a web page on the PuTTY site, and an appendix
(\k{feedback-support}) are probably better sent to newsgroups, or
passed to a local expert if possible.
-The PuTTY contact email address is a private mailing list containing
+The PuTTY contact email address is a private \i{mailing list} containing
four or five core developers. Don't be put off by it being a mailing
list: if you need to send confidential data as part of a bug report,
you can trust the people on the list to respect that confidence.
\b Check the
\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/changes.html}{Change
Log} on the PuTTY website, and see if we have already fixed the bug
-in the development snapshots.
+in the \i{development snapshots}.
\b Check the
\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/faq.html}{FAQ}
report a bug to us, it is useful if you include some general
information:
-\b Tell us what version of PuTTY you are running. To find this out,
+\b Tell us what \i{version of PuTTY} you are running. To find this out,
use the \q{About PuTTY} option from the System menu. Please \e{do
not} just tell us \q{I'm running the latest version}; e-mail can be
delayed and it may not be obvious which version was the latest at
have done, and exactly what it did do.
\b If you think you can, you're welcome to try to fix the problem
-yourself. A patch to the code which fixes a bug is an excellent
+yourself. A \i{patch} to the code which fixes a bug is an excellent
addition to a bug report. However, a patch is never a \e{substitute}
for a good bug report; if your patch is wrong or inappropriate, and
you haven't supplied us with full information about the actual bug,
way to get a feature implemented quickly, if it's a big one that we
don't have time to do ourselves.
-\H{feedback-support} Support requests
+\H{feedback-support} \ii{Support requests}
If you're trying to make PuTTY do something for you and it isn't
working, but you're not sure whether it's a bug or not, then
\H{feedback-webadmin} Web server administration
-If the PuTTY web site is down (Connection Timed Out), please don't
+If the PuTTY \i{web site} is down (Connection Timed Out), please don't
bother mailing us to tell us about it. Most of us read our e-mail on
the same machines that host the web site, so if those machines are
down then we will notice \e{before} we read our e-mail. So there's
\H{gs-insecure} \ii{Starting a session}
-When you start PuTTY, you will see a dialog box. This dialog box
+When you start PuTTY, you will see a \i{dialog box}. This dialog box
allows you to control everything PuTTY can do. See \k{config} for
details of all the things you can control.
To start the simplest kind of session, all you need to do is to
enter a few basic parameters.
-In the \q{Host Name} box, enter the Internet host name of the server
+In the \q{Host Name} box, enter the Internet \i{host name} of the server
you want to connect to. You should have been told this by the
provider of your login account.
\q{Open} button at the bottom of the dialog box, and PuTTY will
begin trying to connect you to the server.
-\H{gs-hostkey} \i{Verifying the host key} (SSH only)
+\H{gs-hostkey} \ii{Verifying the host key} (SSH only)
If you are not using the \i{SSH} protocol, you can skip this
section.
Internet), you should check with your system administrator, perhaps
by telephone or in person. (Some modern servers have more than one
host key. If the system administrator sends you more than one
-fingerprint, you should make sure the one PuTTY shows you is on the
-list, but it doesn't matter which one it is.)
+\I{host key fingerprint}fingerprint, you should make sure the one
+PuTTY shows you is on the list, but it doesn't matter which one it is.)
\# FIXME: this is all very fine but of course in practice the world
doesn't work that way. Ask the team if they have any good ideas for
After you log in to the server, what happens next is up to the
server! Most servers will print some sort of login message and then
-present a \i{prompt}, at which you can type commands which the
+present a \i{prompt}, at which you can type
+\I{commands on the server}commands which the
server will carry out. Some servers will offer you on-line help;
others might not. If you are in doubt about what to do next, consult
your system administrator.
+\IM{Unix version} Unix version of PuTTY tools
+\IM{Unix version} Linux version of PuTTY tools
+
+\IM{Unix} Unix
+\IM{Unix} Linux
+
+\IM{Command Prompt}{command prompt window}{MS-DOS Prompt}{console window} Command Prompt
+\IM{Command Prompt}{command prompt window}{MS-DOS Prompt}{console window} MS-DOS Prompt
+\IM{Command Prompt}{command prompt window}{MS-DOS Prompt}{console window} console window
+
+\IM{spoof}{spoofed}{spoofing} spoofing
+
\IM{verifying the host key} verifying the host key
\IM{verifying the host key} host key, verifying
\IM{trusting host keys} trusting host keys
\IM{trusting host keys} host keys, trusting
+\IM{host key fingerprint} fingerprint, of SSH host key
+\IM{host key fingerprint} host key fingerprint (SSH)
+\IM{host key fingerprint} SSH host key fingerprint
+
\IM{starting a session} starting a session
\IM{starting a session} session, starting
+\IM{commands on the server}{remote command} commands on the server
+\IM{commands on the server}{remote command} remote commands
+\IM{commands on the server}{remote command} server, commands on
+
\IM{mistyping a password} mistyping a password
\IM{mistyping a password} password, mistyping
-\IM{different usernames} different usernames
-\IM{different usernames} changing usernames
-\IM{different usernames} usernames, different
+\IM{different usernames}{changes of username} different user names
+\IM{different usernames}{changes of username} changing user names
+\IM{different usernames}{changes of username} user names, different
+\IM{different usernames}{changes of username} login names, different
+\IM{different usernames}{changes of username} account names, different
\IM{differences between SSH, Telnet and Rlogin} differences between
SSH, Telnet and Rlogin
\IM{differences between SSH, Telnet and Rlogin} selecting a protocol
\IM{differences between SSH, Telnet and Rlogin} choosing a protocol
+\IM{MUD}{MUDs} MUDs
+
+\IM{talker}{talker systems} talker systems
+
+\IM{security hazard}{security risk} security hazard
+
+\IM{SSH-1}{SSH protocol version 1} SSH-1
+\IM{SSH-2}{SSH protocol version 2} SSH-2
+
+\IM{terminal window}{PuTTY window} terminal window
+\IM{terminal window}{PuTTY window} PuTTY terminal window
+\IM{terminal window}{PuTTY window} window, terminal
+
\IM{copy and paste} copy and paste
\IM{copy and paste} cut and paste
\IM{copy and paste} paste, copy and
+\IM{three-button mouse} three-button mouse
+\IM{three-button mouse} mouse, three-button
+
+\IM{left mouse button}{left button} left mouse button
+\IM{middle mouse button}{middle button} middle mouse button
+\IM{right mouse button}{right button} right mouse button
+
+\IM{selecting words}{word-by-word selection} selecting whole words
+\IM{selecting words}{word-by-word selection} words, selecting
+
+\IM{selecting lines} selecting whole lines
+\IM{selecting lines} lines, selecting
+
\IM{rectangular selection} rectangular selection
\IM{rectangular selection} selection, rectangular
\IM{adjusting a selection} adjusting a selection
+\IM{adjusting a selection} extending a selection
\IM{adjusting a selection} selection, adjusting
+\IM{right mouse button, with Ctrl} right mouse button, with Ctrl
+\IM{right mouse button, with Ctrl} Ctrl, with right mouse button
+
+\IM{system menu} system menu
+\IM{system menu} window menu
+
+\IM{context menu} context menu
+\IM{context menu} right mouse button menu
+
+\IM{Telnet special commands} Telnet special commands
+\IM{Telnet special commands} special commands, in Telnet
+
+\IM{SSH special commands} SSH special commands
+\IM{SSH special commands} special commands, in SSH
+
+\IM{Repeat key exchange, SSH special command} Repeat key exchange, SSH special command
+\IM{Repeat key exchange, SSH special command} key exchange, forcing repeat
+\IM{Repeat key exchange, SSH special command} SSH key exchange, forcing repeat
+
+\IM{accented characters} accented characters
+\IM{accented characters} characters, accented
+
+\IM{line-drawing characters} line-drawing characters
+\IM{line-drawing characters} box-drawing characters
+\IM{line-drawing characters} characters, line-drawing
+\IM{line-drawing characters} ANSI graphics
+
\IM{port forwarding}{port forwardings} port forwarding in SSH
\IM{port forwarding}{port forwardings} SSH port forwarding
\IM{port forwarding}{port forwardings} forwarding ports in SSH
\IM{port forwarding}{port forwardings} tunnelling using SSH
\IM{port forwarding}{port forwardings} SSH tunnelling
+\IM{local port forwarding} local-to-remote port forwarding
+\IM{remote port forwarding} remote-to-local port forwarding
+
+\IM{dynamic port forwarding} dynamic port forwarding
+\IM{dynamic port forwarding} SOCKS port forwarding
+
\IM{debugging Internet protocols} debugging Internet protocols
\IM{debugging Internet protocols} Internet protocols, debugging
\IM{debugging Internet protocols} protocols, debugging
+\IM{Internet protocol version} Internet Protocol version
+\IM{Internet protocol version} version, of Internet Protocol
+
\IM{raw TCP connections} raw TCP connections
\IM{raw TCP connections} TCP connections, raw
\IM{command-line arguments} options, command-line
\IM{command-line arguments} switches, command-line
+\IM{Windows shortcut} Windows shortcut
+\IM{Windows shortcut} shortcut, Windows
+
\IM{telnet URLs} Telnet URLs
\IM{telnet URLs} URLs, Telnet
\IM{saved sessions, loading from command line} command line, loading
saved sessions from
+\IM{putty @sessionname} \c{putty @sessionname}
+\IM{putty @sessionname} \c{@sessionname} command-line argument
+
\IM{protocol selection} protocol selection
\IM{protocol selection} selecting a protocol
\IM{protocol selection} choosing a protocol
-\IM{login name} login name
-\IM{login name} user name
+\IM{login name}{username} login name
+\IM{login name}{username} user name
+\IM{login name}{username} account name
+
+\IM{reading commands from a file} reading commands from a file
+\IM{reading commands from a file} commands, reading from a file
\IM{agent forwarding} agent forwarding
+\IM{agent forwarding} authentication agent forwarding
\IM{agent forwarding} SSH agent forwarding
\IM{agent forwarding} forwarding, SSH agent
-\IM{X11 forwarding} X11 forwarding
-\IM{X11 forwarding} SSH X11 forwarding
-\IM{X11 forwarding} forwarding, X11
+\IM{X11 forwarding}{forwarding of X11} X11 forwarding
+\IM{X11 forwarding}{forwarding of X11} SSH X11 forwarding
+\IM{X11 forwarding}{forwarding of X11} forwarding, of X11
+
+\IM{X11 authentication} X11 authentication
+\IM{X11 authentication} authentication, X11
\IM{pseudo-terminal allocation} pseudo-terminal allocation
\IM{pseudo-terminal allocation} pty allocation
\IM{removing registry entries} registry entries, removing
\IM{random seed file} random seed file
-\IM{random seed file} \c{putty.rnd}
+\IM{random seed file} \c{putty.rnd} (random seed file)
+
+\IM{putty.rnd} \c{putty.rnd} (random seed file)
\IM{suppressing remote shell} remote shell, suppressing
\IM{suppressing remote shell} shell, remote, suppressing
+
+\IM{SSH protocol version} SSH protocol version
+\IM{SSH protocol version} protocol version, SSH
+\IM{SSH protocol version} version, of SSH protocol
+
+\IM{PPK} \cw{PPK} file
+\IM{PPK} private key file, PuTTY
+
+\IM{PGP key fingerprint} PGP key fingerprint
+\IM{PGP key fingerprint} fingerprint, of PGP key
+
+\IM{verifying new versions} verifying new versions of PuTTY
+\IM{verifying new versions} new version, verifying
+\IM{verifying new versions} upgraded version, verifying
+
+\IM{connection}{network connection} network connection
+\IM{connection}{network connection} connection, network
+
+\IM{host name}{hostname} host name
+\IM{host name}{hostname} DNS name
+\IM{host name}{hostname} server name
+
+\IM{IP address}{Internet address} IP address
+\IM{IP address}{Internet address} address, IP
+
+\IM{localhost} \c{localhost}
+
+\IM{loopback IP address}{loopback address} loopback IP address
+\IM{loopback IP address}{loopback address} IP address, loopback
+
+\IM{listen address} listen address
+\IM{listen address} bind address
+
+\IM{DNS} DNS
+\IM{DNS} Domain Name System
+
+\IM{name resolution} name resolution
+\IM{name resolution} DNS resolution
+\IM{name resolution} host name resolution
+\IM{name resolution} server name resolution
+
+\IM{loading and storing saved sessions} sessions, loading and storing
+\IM{loading and storing saved sessions} settings, loading and storing
+\IM{loading and storing saved sessions} saving settings
+\IM{loading and storing saved sessions} storing settings
+\IM{loading and storing saved sessions} loading settings
+
+\IM{Default Settings} Default Settings
+\IM{Default Settings} settings, default
+
+\IM{Registry} Registry (Windows)
+\IM{Registry} Windows Registry
+
+\IM{inactive window} inactive window
+\IM{inactive window} window, inactive
+\IM{inactive window} terminal window, inactive
+
+\IM{Log SSH packet data} SSH packet log
+\IM{Log SSH packet data} packet log, SSH
+
+\IM{auto wrap mode}{auto wrap} auto wrap mode
+\IM{auto wrap mode}{auto wrap} wrapping, automatic
+\IM{auto wrap mode}{auto wrap} line wrapping, automatic
+
+\IM{control sequence}{control codes} control sequences
+\IM{control sequence}{control codes} terminal control sequences
+\IM{control sequence}{control codes} escape sequences
+
+\IM{cursor coordinates} cursor coordinates
+\IM{cursor coordinates} coordinates, cursor
+
+\IM{CR} CR (Carriage Return)
+\IM{CR} Carriage Return
+
+\IM{LF} LF (Line Feed)
+\IM{LF} Line Feed
+
+\IM{clear screen} clear screen
+\IM{clear screen} erase screen
+\IM{clear screen} screen, clearing
+
+\IM{blinking text} blinking text
+\IM{blinking text} flashing text
+
+\IM{answerback} answerback string
+
+\IM{local echo} local echo
+\IM{local echo} echo, local
+
+\IM{remote echo} remote echo
+\IM{remote echo} echo, remote
+
+\IM{local line editing} local line editing
+\IM{local line editing} line editing, local
+
+\IM{remote-controlled printing} ANSI printing
+\IM{remote-controlled printing} remote-controlled printing
+\IM{remote-controlled printing} printing, remote-controlled
+
+\IM{Home and End keys} Home key
+\IM{Home and End keys} End key
+
+\IM{keypad} keypad, numeric
+\IM{keypad} numeric keypad
+
+\IM{Application Cursor Keys} Application Cursor Keys
+\IM{Application Cursor Keys} cursor keys, \q{Application} mode
+
+\IM{Application Keypad} Application Keypad
+\IM{Application Keypad} keypad, \q{Application} mode
+\IM{Application Keypad} numeric keypad, \q{Application} mode
+
+\IM{Num Lock}{NumLock} Num Lock
+
+\IM{NetHack keypad mode} NetHack keypad mode
+\IM{NetHack keypad mode} keypad, NetHack mode
+
+\IM{compose key} Compose key
+\IM{compose key} DEC Compose key
+
+\IM{terminal bell} terminal bell
+\IM{terminal bell} bell, terminal
+\IM{terminal bell} beep, terminal
+\IM{terminal bell} feep
+
+\IM{Windows Default Beep} Windows Default Beep sound
+\IM{Windows Default Beep} Default Beep sound, Windows
+
+\IM{terminal bell, disabling} terminal bell, disabling
+\IM{terminal bell, disabling} bell, disabling
+
+\IM{visual bell} visual bell
+\IM{visual bell} bell, visual
+
+\IM{PC speaker} PC speaker
+\IM{PC speaker} beep, with PC speaker
+
+\IM{sound file} sound file
+\IM{sound file} \cw{WAV} file
+
+\IM{bell overload} bell overload mode
+\IM{bell overload} terminal bell overload mode
+
+\IM{mouse reporting} mouse reporting
+\IM{mouse reporting} \c{xterm} mouse reporting
+
+\IM{links} \c{links} (web browser)
+
+\IM{mc} \c{mc}
+\IM{mc} Midnight Commander
+
+\IM{terminal resizing}{window resizing} terminal resizing
+\IM{terminal resizing}{window resizing} window resizing
+\IM{terminal resizing}{window resizing} resizing, terminal
+
+\IM{destructive backspace} destructive backspace
+\IM{destructive backspace} non-destructive backspace
+\IM{destructive backspace} backspace, destructive
+
+\IM{Arabic text shaping} Arabic text shaping
+\IM{Arabic text shaping} shaping, of Arabic text
+
+\IM{Unicode} Unicode
+\IM{Unicode} ISO-10646 (Unicode)
+
+\IM{ASCII} ASCII
+\IM{ASCII} US-ASCII
+
+\IM{bidirectional text} bidirectional text
+\IM{bidirectional text} right-to-left text
+
+\IM{display becomes corrupted} display corruption
+\IM{display becomes corrupted} corruption, of display
+
+\IM{rows} rows, in terminal window
+\IM{columns} columns, in terminal window
+
+\IM{window size} window size
+\IM{window size} size, of window
+
+\IM{font size} font size
+\IM{font size} size, of font
+
+\IM{full screen}{full-screen} full-screen mode
+
+\IM{cursor blinks} blinking cursor
+\IM{cursor blinks} flashing cursor
+\IM{cursor blinks} cursor, blinking
+
+\IM{font} font
+\IM{font} typeface
+
+\IM{minimise} minimise window
+\IM{minimise} window, minimising
+
+\IM{maximise} maximise window
+\IM{maximise} window, maximising
+
+\IM{closing window}{close window} closing window
+\IM{closing window}{close window} window, closing
+
+\IM{Dragon NaturallySpeaking} Dragon NaturallySpeaking
+\IM{Dragon NaturallySpeaking} NaturallySpeaking
+
+\IM{AltGr} \q{AltGr} key
+\IM{Alt} \q{Alt} key
+
+\IM{CJK} CJK
+\IM{CJK} Chinese
+\IM{CJK} Japanese
+\IM{CJK} Korean
+
+\IM{East Asian Ambiguous characters} East Asian Ambiguous characters
+\IM{East Asian Ambiguous characters} CJK ambiguous characters
+
+\IM{character width} character width
+\IM{character width} single-width character
+\IM{character width} double-width character
+
+\IM{Rich Text Format} Rich Text Format
+\IM{Rich Text Format} RTF
+
+\IM{bold}{bold text} bold text
+
+\IM{colour}{colours} colour
+
+\IM{8-bit colour} 8-bit colour
+\IM{8-bit colour} colour, 8-bit
+
+\IM{system colours} system colours
+\IM{system colours} colours, system
+
+\IM{ANSI colours} ANSI colours
+\IM{ANSI colours} colours, ANSI
+
+\IM{cursor colour} cursor colour
+\IM{cursor colour} colour, of cursor
+
+\IM{default background} background colour, default
+\IM{default background} colour, background, default
+
+\IM{default foreground} foreground colour, default
+\IM{default foreground} colour, foreground, default
+
+\IM{TERM} \cw{TERM} environment variable
+
+\IM{logical palettes} logical palettes
+\IM{logical palettes} palettes, logical
+
+\IM{breaks in connectivity} connectivity, breaks in
+\IM{breaks in connectivity} intermittent connectivity
+
+\IM{idle connections} idle connections
+\IM{idle connections} timeout, of connections
+\IM{idle connections} connections, idle
+
+\IM{interactive connections}{interactive session} interactive connections
+\IM{interactive connections}{interactive session} connections, interactive
+
+\IM{keepalives} keepalives, application
+
+\IM{Nagle's algorithm} Nagle's algorithm
+\IM{Nagle's algorithm} \cw{TCP_NODELAY}
+
+\IM{TCP keepalives} TCP keepalives
+\IM{TCP keepalives} keepalives, TCP
+\IM{TCP keepalives} \cw{SO_KEEPALIVE}
+
+\IM{half-open connections} half-open connections
+\IM{half-open connections} connections, half-open
+
+\IM{auto-login username} user name, for auto-login
+\IM{auto-login username} login name, for auto-login
+\IM{auto-login username} account name, for auto-login
+
+\IM{terminal emulation}{terminal-type} terminal emulation
+\IM{terminal emulation}{terminal-type} emulation, terminal
+
+\IM{terminal speed} terminal speed
+\IM{terminal speed} speed, terminal
+\IM{terminal speed} baud rate, of terminal
+
+\IM{environment variables} environment variables
+\IM{environment variables} variables, environment
+
+\IM{proxy} proxy server
+\IM{proxy} server, proxy
+
+\IM{HTTP proxy} HTTP proxy
+\IM{HTTP proxy} proxy, HTTP
+\IM{HTTP proxy} server, HTTP
+\IM{HTTP proxy} \cw{CONNECT} proxy (HTTP)
+
+\IM{SOCKS server} SOCKS proxy
+\IM{SOCKS server} server, SOCKS
+\IM{SOCKS server} proxy, SOCKS
+
+\IM{Telnet proxy} Telnet proxy
+\IM{Telnet proxy} TCP proxy
+\IM{Telnet proxy} ad-hoc proxy
+\IM{Telnet proxy} proxy, Telnet
+
+\IM{proxy DNS} proxy DNS
+\IM{proxy DNS} DNS, with proxy
+\IM{proxy DNS} name resolution, with proxy
+\IM{proxy DNS} host name resolution, with proxy
+\IM{proxy DNS} server name resolution, with proxy
+
+\IM{proxy username} proxy user name
+\IM{proxy username} user name, for proxy
+\IM{proxy username} login name, for proxy
+\IM{proxy username} account name, for proxy
+
+\IM{proxy password} proxy password
+\IM{proxy password} password, for proxy
+
+\IM{proxy authentication} proxy authentication
+\IM{proxy authentication} authentication, to proxy
+
+\IM{HTTP basic} HTTP \q{basic} authentication
+\IM{HTTP basic} \q{basic} authentication (HTTP)
+
+\IM{plaintext password} plain text password
+\IM{plaintext password} password, plain text
+
+\IM{Telnet negotiation} Telnet option negotiation
+\IM{Telnet negotiation} option negotiation, Telnet
+\IM{Telnet negotiation} negotiation, of Telnet options
+
+\IM{firewall}{firewalls} firewalls
+
+\IM{NAT router}{NAT} NAT routers
+\IM{NAT router}{NAT} routers, NAT
+\IM{NAT router}{NAT} Network Address Translation
+\IM{NAT router}{NAT} IP masquerading
+
+\IM{Telnet New Line} Telnet New Line
+\IM{Telnet New Line} new line, in Telnet
+
+\IM{.rhosts} \c{.rhosts} file
+\IM{.rhosts} \q{rhosts} file
+
+\IM{passwordless login} passwordless login
+\IM{passwordless login} login, passwordless
+
+\IM{Windows user name} local user name, in Windows
+\IM{Windows user name} user name, local, in Windows
+\IM{Windows user name} login name, local, in Windows
+\IM{Windows user name} account name, local, in Windows
+
+\IM{local username in Rlogin} local user name, in Rlogin
+\IM{local username in Rlogin} user name, local, in Rlogin
+\IM{local username in Rlogin} login name, local, in Rlogin
+\IM{local username in Rlogin} account name, local, in Rlogin
+
+\IM{privileged port} privileged port
+\IM{privileged port} low-numbered port
+\IM{privileged port} port, privileged
+
+\IM{remote shell} shell, remote
+\IM{remote shell} remote shell
+
+\IM{encryption}{encrypted}{encrypt} encryption
+
+\IM{encryption algorithm} encryption algorithm
+\IM{encryption algorithm} cipher algorithm
+\IM{encryption algorithm} symmetric-key algorithm
+\IM{encryption algorithm} algorithm, encryption
+
+\IM{AES} AES
+\IM{AES} Advanced Encryption Standard
+\IM{AES} Rijndael
+
+\IM{triple-DES} triple-DES
+
+\IM{single-DES} single-DES
+\IM{single-DES} DES
+
+\IM{key exchange} key exchange
+\IM{key exchange} kex
+
+\IM{shared secret} shared secret
+\IM{shared secret} secret, shared
+
+\IM{key exchange algorithm} key exchange algorithm
+\IM{key exchange algorithm} algorithm, key exchange
+
+\IM{Diffie-Hellman key exchange} Diffie-Hellman key exchange
+\IM{Diffie-Hellman key exchange} key exchange, Diffie-Hellman
+
+\IM{group exchange} Diffie-Hellman group exchange
+\IM{group exchange} group exchange, Diffie-Hellman
+
+\IM{repeat key exchange} repeat key exchange
+\IM{repeat key exchange} key exchange, repeat
+
+\IM{challenge/response authentication} challenge/response authentication
+\IM{challenge/response authentication} authentication, challenge/response
+
+\IM{security token} security token
+\IM{security token} token, security
+
+\IM{one-time passwords} one-time passwords
+\IM{one-time passwords} password, one-time
+
+\IM{keyboard-interactive authentication} keyboard-interactive authentication
+\IM{keyboard-interactive authentication} authentication, keyboard-interactive
+
+\IM{password expiry} password expiry
+\IM{password expiry} expiry, of passwords
+
+\IM{public key authentication}{public-key authentication} public key authentication
+\IM{public key authentication}{public-key authentication} RSA authentication
+\IM{public key authentication}{public-key authentication} DSA authentication
+\IM{public key authentication}{public-key authentication} authentication, public key
+
+\IM{MIT-MAGIC-COOKIE-1} \cw{MIT-MAGIC-COOKIE-1}
+\IM{MIT-MAGIC-COOKIE-1} magic cookie
+\IM{MIT-MAGIC-COOKIE-1} cookie, magic
+
+\IM{SSH server bugs} SSH server bugs
+\IM{SSH server bugs} bugs, in SSH servers
+
+\IM{ignore message} SSH \q{ignore} messages
+\IM{ignore message} \q{ignore} messages, in SSH
+
+\IM{message authentication code} message authentication code
+\IM{message authentication code} MAC (message authentication code)
+
+\IM{signatures} signature
+\IM{signatures} digital signature
+
+\IM{storing configuration in a file} storing settings in a file
+\IM{storing configuration in a file} saving settings in a file
+\IM{storing configuration in a file} loading settings from a file
+
+\IM{transferring files} transferring files
+\IM{transferring files} files, transferring
+
+\IM{receiving files}{download a file} receiving files
+\IM{receiving files}{download a file} files, receiving
+\IM{receiving files}{download a file} downloading files
+
+\IM{sending files}{upload a file} sending files
+\IM{sending files}{upload a file} files, sending
+\IM{sending files}{upload a file} uploading files
+
+\IM{listing files} listing files
+\IM{listing files} files, listing
+
+\IM{wildcard}{wildcards} wildcards
+\IM{wildcard}{wildcards} glob (wildcard)
+
+\IM{PATH} \c{PATH} environment variable
+
+\IM{SFTP} SFTP
+\IM{SFTP} SSH file transfer protocol
+
+\IM{-unsafe} \c{-unsafe} PSCP command-line option
+\IM{-ls-PSCP} \c{-ls} PSCP command-line option
+\IM{-p-PSCP} \c{-p} PSCP command-line option
+\IM{-q-PSCP} \c{-q} PSCP command-line option
+\IM{-r-PSCP} \c{-r} PSCP command-line option
+\IM{-batch-PSCP} \c{-batch} PSCP command-line option
+\IM{-sftp} \c{-sftp} PSCP command-line option
+\IM{-scp} \c{-scp} PSCP command-line option
+
+\IM{return value} return value
+\IM{return value} exit value
+
+\IM{-b-PSFTP} \c{-b} PSFTP command-line option
+\IM{-bc-PSFTP} \c{-bc} PSFTP command-line option
+\IM{-be-PSFTP} \c{-be} PSFTP command-line option
+\IM{-batch-PSFTP} \c{-batch} PSFTP command-line option
+
+\IM{spaces in filenames} spaces in filenames
+\IM{spaces in filenames} filenames containing spaces
+
+\IM{working directory} working directory
+\IM{working directory} current working directory
+
+\IM{resuming file transfers} resuming file transfers
+\IM{resuming file transfers} files, resuming transfer of
+
+\IM{changing permissions on files} changing permissions on files
+\IM{changing permissions on files} permissions on files, changing
+\IM{changing permissions on files} files, changing permissions on
+\IM{changing permissions on files} modes of files, changing
+\IM{changing permissions on files} access to files, changing
+
+\IM{deleting files} deleting files
+\IM{deleting files} files, deleting
+\IM{deleting files} removing files
+
+\IM{create a directory} creating directories
+\IM{create a directory} directories, creating
+
+\IM{remove a directory} removing directories
+\IM{remove a directory} directories, removing
+\IM{remove a directory} deleting directories
+
+\IM{rename remote files} renaming files
+\IM{rename remote files} files, renaming and moving
+\IM{rename remote files} moving files
+
+\IM{local Windows command} local Windows command
+\IM{local Windows command} Windows command
+
+\IM{PLINK_PROTOCOL} \c{PLINK_PROTOCOL} environment variable
+
+\IM{-batch-plink} \c{-batch} Plink command-line option
+\IM{-s-plink} \c{-s} Plink command-line option
+
+\IM{subsystem} subsystem, SSH
+\IM{subsystem} SSH subsystem
+
+\IM{batch file}{batch files} batch files
+
+\IM{CVS_RSH} \c{CVS_RSH} environment variable
+
+\IM{DSA} DSA
+\IM{DSA} Digital Signature Standard
+
+\IM{public-key algorithm} public-key algorithm
+\IM{public-key algorithm} asymmetric key algorithm
+\IM{public-key algorithm} algorithm, public-key
+
+\IM{generating keys} generating key pairs
+\IM{generating keys} creating key pairs
+\IM{generating keys} key pairs, generating
+\IM{generating keys} public keys, generating
+\IM{generating keys} private keys, generating
+
+\IM{authorized_keys file}{authorized_keys} \cw{authorized_keys} file
+
+\IM{key fingerprint} fingerprint, of SSH authentication key
+\IM{key fingerprint} public key fingerprint (SSH)
+\IM{key fingerprint} SSH public key fingerprint
+
+\IM{SSH-2 public key format} SSH-2 public key file format
+\IM{SSH-2 public key format} public key file, SSH-2
+
+\IM{OpenSSH private key format} OpenSSH private key file format
+\IM{OpenSSH private key format} private key file, OpenSSH
+
+\IM{ssh.com private key format} \cw{ssh.com} private key file format
+\IM{ssh.com private key format} private key file, \cw{ssh.com}
+
+\IM{importing keys} importing private keys
+\IM{importing keys} loading private keys
+
+\IM{export private keys} exporting private keys
+\IM{export private keys} saving private keys
+
+\IM{.ssh} \c{.ssh} directory
+
+\IM{.ssh2} \c{.ssh2} directory
+
+\IM{authentication agent} authentication agent
+\IM{authentication agent} agent, authentication
+
+\IM{-c-pageant} \c{-c} Pageant command-line option
+
+\IM{FAQ} FAQ
+\IM{FAQ} Frequently Asked Questions
+
+\IM{supported features} supported features
+\IM{supported features} features, supported
+
+\IM{remember my password} storing passwords
+\IM{remember my password} password, storing
+
+\IM{login scripts}{startup scripts} login scripts
+\IM{login scripts}{startup scripts} startup scripts
+
+\IM{WS2_32.DLL} \cw{WS2_32.DLL}
+\IM{WS2_32.DLL} WinSock version 2
+
+\IM{Red Hat Linux} Red Hat Linux
+\IM{Red Hat Linux} Linux, Red Hat
+
+\IM{SMB} SMB
+\IM{SMB} Windows file sharing
+
+\IM{clean up} clean up after PuTTY
+\IM{clean up} uninstalling
+
+\IM{version of PuTTY} version, of PuTTY
+
+\IM{PGP signatures} PGP signatures, of PuTTY binaries
+\IM{PGP signatures} signatures, of PuTTY binaries
network.
Multi-user operating systems, such as Unix and VMS, usually present
-a command-line interface to the user, much like the \q{\i{Command
+a \i{command-line interface} to the user, much like the \q{\i{Command
Prompt}} or \q{\i{MS-DOS Prompt}} in Windows. The system prints a
prompt, and you type commands which the system will obey.
These protocols can also be used for other types of keyboard-based
interactive session. In particular, there are a lot of bulletin
-boards, talker systems and MUDs (Multi-User Dungeons) which support
+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 or Rlogin if:
able to access from somewhere else
\b your Internet Service Provider provides you with a login account
-on a web server. (This might also be known as a \i\e{shell account}.
+on a \i{web server}. (This might also be known as a \i\e{shell account}.
A \e{shell} is the program that runs on the server and interprets
your commands for you.)
-\b you want to use a bulletin board system, talker or MUD which can
+\b you want to use a \i{bulletin board system}, talker or MUD which can
be accessed using Telnet.
You probably do \e{not} want to use SSH, Telnet or Rlogin if:
connection against eavesdropping, hijacking and other attacks. Telnet
and Rlogin are both older protocols offering minimal security.
-\b SSH and Rlogin both allow you to log in to the server without
-having to type a password. (Rlogin's method of doing this is
+\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
insecure, and can allow an attacker to access your account on the
server. SSH's method is much more secure, and typically breaking the
security requires the attacker to have gained access to your actual
\define{versionidlicence} \versionid $Id$
-\A{licence} PuTTY Licence
+\A{licence} PuTTY \ii{Licence}
-PuTTY is copyright 1997-2005 Simon Tatham.
+PuTTY is \i{copyright} 1997-2005 Simon Tatham.
Portions copyright Robert de Bath, Joris van Rantwijk, Delian
Delchev, Andreas Schultz, Jeroen Massar, Wez Furlong, Nicolas Barry,
\define{versionidpageant} \versionid $Id$
-\C{pageant} Using Pageant for authentication
+\C{pageant} Using \i{Pageant} for authentication
\cfg{winhelp-topic}{pageant.general}
-Pageant is an SSH authentication agent. It holds your private keys
-in memory, already decoded, so that you can use them often without
-needing to type a passphrase.
+Pageant is an SSH \i{authentication agent}. It holds your \i{private key}s
+in memory, already decoded, so that you can use them often
+\I{passwordless login}without needing to type a \i{passphrase}.
\H{pageant-start} Getting started with Pageant
-Before you run Pageant, you need to have a private key in \c{*.PPK}
+Before you run Pageant, you need to have a private key in \c{*.\i{PPK}}
format. See \k{pubkey} to find out how to generate and use one.
When you run Pageant, it will put an icon of a computer wearing a
-hat into the System tray. It will then sit and do nothing, until you
+hat into the \ii{System tray}. It will then sit and do nothing, until you
load a private key into it.
If you click the Pageant icon with the right mouse button, you will
\b The size (in bits) of the key.
-\b The fingerprint for the public key. This should be the same
-fingerprint given by PuTTYgen, and (hopefully) also the same
-fingerprint shown by remote utilities such as \c{ssh-keygen} when
+\b The \I{key fingerprint}fingerprint for the public key. This should be
+the same fingerprint given by PuTTYgen, and (hopefully) also the same
+fingerprint shown by remote utilities such as \i\c{ssh-keygen} when
applied to your \c{authorized_keys} file.
\b The comment attached to the key.
\H{pageant-cmdline} The Pageant command line
Pageant can be made to do things automatically when it starts up, by
-specifying instructions on its command line. If you're starting
-Pageant from the Windows GUI, you can arrange this by editing the
-properties of the Windows shortcut that it was started from.
+\I{command-line arguments}specifying instructions on its command line.
+If you're starting Pageant from the Windows GUI, you can arrange this
+by editing the properties of the \i{Windows shortcut} that it was
+started from.
\S{pageant-cmdline-loadkey} Making Pageant automatically load keys
on startup
Plink, or whatever) will then be able to use the keys Pageant has
loaded.
-You do this by specifying the \c{-c} option followed by the command,
-like this:
+You do this by specifying the \I{-c-pageant}\c{-c} option followed
+by the command, like this:
\c C:\PuTTY\pageant.exe d:\main.ppk -c C:\PuTTY\putty.exe
-\H{pageant-forward} Using agent forwarding
+\H{pageant-forward} Using \i{agent forwarding}
Agent forwarding is a mechanism that allows applications on your SSH
server machine to talk to the agent on your client machine.
Note that at present, agent forwarding in SSH-2 is only available
-when your SSH server is OpenSSH. The \cw{ssh.com} server uses a
+when your SSH server is \i{OpenSSH}. The \i\cw{ssh.com} server uses a
different agent protocol, which PuTTY does not yet support.
To enable agent forwarding, first start Pageant. Then set up a PuTTY
In addition, if you have a private key on one of the SSH servers,
you can send it all the way back to Pageant using the local
-\c{ssh-add} command:
+\i\c{ssh-add} command:
\c unixbox:~$ ssh-add ~/.ssh/id_rsa
\c Need passphrase for /home/fred/.ssh/id_rsa
\H{pageant-security} Security considerations
-Using Pageant for public-key authentication gives you the
+\I{security risk}Using Pageant for public-key authentication gives you the
convenience of being able to open multiple SSH sessions without
having to type a passphrase every time, but also gives you the
security benefit of never storing a decrypted private key on disk.
for two reasons:
\b Windows unfortunately provides no way to protect pieces of memory
-from being written to the system swap file. So if Pageant is holding
+from being written to the system \i{swap file}. So if Pageant is holding
your private keys for a long period of time, it's possible that
decrypted private key data may be written to the system swap file,
and an attacker who gained access to your hard disk later on might
\cfg{winhelp-topic}{pgpfingerprints}
-We create \i{PGP signatures} for all the PuTTY
+\I{verifying new versions}We create \i{PGP signatures} for all the PuTTY
files distributed from our web site, so that users can be confident
that the files have not been tampered with. Here we identify
our public keys, and explain our signature policy so you can have an
\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/keys/snapshot-rsa.asc}{Snapshot key}
\lcont{
-Master Key: 1024-bit; fingerprint:
+Master Key: 1024-bit; \I{PGP key fingerprint}fingerprint:
\cw{8F\_15\_97\_DA\_25\_30\_AB\_0D\_\_88\_D1\_92\_54\_11\_CF\_0C\_4C}
}
\define{versionidplink} \versionid $Id$
-\C{plink} Using the command-line connection tool Plink
+\C{plink} Using the command-line connection tool \i{Plink}
\i{Plink} (PuTTY Link) is a command-line connection tool similar to
-UNIX \c{ssh}. It is mostly used for automated operations, such as
+UNIX \c{ssh}. It is mostly used for \i{automated operations}, such as
making CVS access a repository on a remote server.
Plink is probably not what you want if you want to run an
-interactive session in a console window.
+\i{interactive session} in a console window.
\H{plink-starting} Starting Plink
Plink is a command line application. This means that you cannot just
double-click on its icon to run it and instead you have to bring up
a \i{console window}. In Windows 95, 98, and ME, this is called an
-\q{MS-DOS Prompt}, and in Windows NT and 2000 it is called a
+\q{MS-DOS Prompt}, and in Windows NT, 2000, and XP, it is called a
\q{Command Prompt}. It should be available from the Programs section
of your Start Menu.
\c set PATH=C:\path\to\putty\directory;%PATH%
This will only work for the lifetime of that particular console
-window. To set your \c{PATH} more permanently on Windows NT, use the
-Environment tab of the System Control Panel. On Windows 95, 98, and
-ME, you will need to edit your \c{AUTOEXEC.BAT} to include a \c{set}
-command like the one above.
+window. To set your \c{PATH} more permanently on Windows NT, 2000,
+and XP, use the Environment tab of the System Control Panel. On
+Windows 95, 98, and ME, you will need to edit your \i\c{AUTOEXEC.BAT}
+to include a \c{set} command like the one above.
\H{plink-usage} Using Plink
You should then be able to log in as normal and run a session. The
output sent by the server will be written straight to your command
-prompt window, which will most likely not interpret terminal control
-codes in the way the server expects it to. So if you run any
+prompt window, which will most likely not interpret terminal \i{control
+codes} in the way the server expects it to. So if you run any
full-screen applications, for example, you can expect to see strange
characters appearing in your window. Interactive connections like
this are not the main point of Plink.
\b Set up a PuTTY saved session that describes the server you are
connecting to, and that also specifies the protocol as SSH.
-\b Set the Windows environment variable \c{PLINK_PROTOCOL} to the
+\b Set the Windows environment variable \i\c{PLINK_PROTOCOL} to the
word \c{ssh}.
Usually Plink is not invoked directly by a user, but run
(see \k{config-username}).
To avoid being prompted for a password, you should almost certainly
-set up public-key authentication. (See \k{pubkey} for a general
+set up \i{public-key authentication}. (See \k{pubkey} for a general
introduction to public-key authentication.) Again, you can do this
in two ways:
Plink also supports some of its own options. The following sections
describe Plink's specific command-line options.
-\S2{plink-option-batch} \c{-batch}: disable all interactive prompts
+\S2{plink-option-batch} \I{-batch-plink}\c{-batch}: disable all
+interactive prompts
If you use the \c{-batch} option, Plink will never give an
interactive prompt while establishing the connection. If the
scripts: using \c{-batch}, if something goes wrong at connection
time, the batch job will fail rather than hang.
-\S2{plink-option-s} \c{-s}: remote command is SSH subsystem
+\S2{plink-option-s} \I{-s-plink}\c{-s}: remote command is SSH subsystem
If you specify the \c{-s} option, Plink passes the specified command
-as the name of an SSH \q{subsystem} rather than an ordinary command
+as the name of an SSH \q{\i{subsystem}} rather than an ordinary command
line.
(This option is only meaningful with the SSH-2 protocol.)
\H{plink-cvs} Using Plink with \i{CVS}
To use Plink with CVS, you need to set the environment variable
-\c{CVS_RSH} to point to Plink:
+\i\c{CVS_RSH} to point to Plink:
\c set CVS_RSH=\path\to\plink.exe
\#FIXME: Need examples
-\C{pscp} Using PSCP to transfer files securely
+\C{pscp} Using \i{PSCP} to transfer files securely
-\i{PSCP}, the PuTTY Secure Copy client, is a tool for transferring files
+\i{PSCP}, the PuTTY Secure Copy client, is a tool for \i{transferring files}
securely between computers using an SSH connection.
If you have an SSH-2 server, you might prefer PSFTP (see \k{psftp})
PSCP is a command line application. This means that you cannot just
double-click on its icon to run it and instead you have to bring up a
\i{console window}. With Windows 95, 98, and ME, this is called an
-\q{MS-DOS Prompt} and with Windows NT and 2000 it is called a
+\q{MS-DOS Prompt} and with Windows NT, 2000, and XP, it is called a
\q{Command Prompt}. It should be available from the Programs section
-of your Start Menu.
+of your \i{Start Menu}.
To start PSCP it will need either to be on your \i{\c{PATH}} or in your
current directory. To add the directory containing PSCP to your
\c set PATH=C:\path\to\putty\directory;%PATH%
This will only work for the lifetime of that particular console
-window. To set your \c{PATH} more permanently on Windows NT, use the
-Environment tab of the System Control Panel. On Windows 95, 98, and
-ME, you will need to edit your \c{AUTOEXEC.BAT} to include a \c{set}
-command like the one above.
+window. To set your \c{PATH} more permanently on Windows NT, 2000,
+and XP, use the Environment tab of the System Control Panel. On
+Windows 95, 98, and ME, you will need to edit your \i\c{AUTOEXEC.BAT}
+to include a \c{set} command like the one above.
\H{pscp-usage} PSCP Usage
\S{pscp-usage-basics} The basics
-To receive (a) file(s) from a remote server:
+To \I{receiving files}receive (a) file(s) from a remote server:
\c pscp [options] [user@]host:source target
\c pscp fred@example.com:/etc/hosts c:\temp\example-hosts.txt
-To send (a) file(s) to a remote server:
+To \I{sending files}send (a) file(s) to a remote server:
\c pscp [options] source [source...] [user@]host:target
\c pscp c:\documents\foo.txt fred@example.com:/tmp/foo
-You can use wildcards to transfer multiple files in either
+You can use \i{wildcards} to transfer multiple files in either
direction, like this:
\c pscp c:\documents\*.doc fred@example.com:docfiles
upgrading to SSH-2 or using the \cq{-unsafe} option. Renaming of
this file has been disallowed}.
-This is due to a fundamental insecurity in the old-style SCP
-protocol: the client sends the wildcard string (\c{*.c}) to the
+This is due to a \I{security risk}fundamental insecurity in the old-style
+\i{SCP protocol}: the client sends the wildcard string (\c{*.c}) to the
server, and the server sends back a sequence of file names that
match the wildcard pattern. However, there is nothing to stop the
server sending back a \e{different} pattern and writing over one of
cannot reliably verify that the filenames sent back match the
pattern.
-PSCP will attempt to use the newer SFTP protocol (part of SSH-2)
+PSCP will attempt to use the newer \i{SFTP} protocol (part of SSH-2)
where possible, which does not suffer from this security flaw. If
you are talking to an SSH-2 server which supports SFTP, you will
never see this warning. (You can force use of the SFTP protocol,
if available, with \c{-sftp} - see \k{pscp-usage-options-backend}.)
If you really need to use a server-side wildcard with an SSH-1
-server, you can use the \c{-unsafe} command line option with PSCP:
+server, you can use the \i\c{-unsafe} command line option with PSCP:
\c pscp -unsafe fred@example.com:source/*.c c:\source
\S2{pscp-usage-basics-user} \c{user}
-The login name on the remote server. If this is omitted, and \c{host}
+The \i{login name} on the remote server. If this is omitted, and \c{host}
is a PuTTY saved session, PSCP will use any username specified by that
saved session. Otherwise, PSCP will attempt to use the local Windows
username.
-\S2{pscp-usage-basics-host} \c{host}
+\S2{pscp-usage-basics-host} \I{hostname}\c{host}
The name of the remote server, or the name of an existing PuTTY saved
session. In the latter case, the session's settings for hostname, port
\S2{pscp-usage-basics-source} \c{source}
-One or more source files. \i{Wildcards} are allowed. The syntax of
+One or more source files. \ii{Wildcards} are allowed. The syntax of
wildcards depends on the system to which they apply, so if you are
copying \e{from} a Windows system \e{to} a UNIX system, you should use
Windows wildcard syntax (e.g. \c{*.*}), but if you are copying \e{from}
If the source is a remote server and you do not specify a full
pathname (in UNIX, a pathname beginning with a \c{/} (slash)
character), what you specify as a source will be interpreted relative
-to your home directory on the remote server.
+to your \i{home directory} on the remote server.
\S2{pscp-usage-basics-target} \c{target}
These are the command line options that PSCP accepts.
-\S2{pscp-usage-options-p}\c{-p} preserve file attributes
+\S2{pscp-usage-options-ls}\I{-ls-PSCP}\c{-ls} \I{listing files}list remote files
+
+If the \c{-ls} option is given, no files are transferred; instead,
+remote files are listed. Only a hostname specification and
+optional remote file specification need be given. For example:
+
+\c pscp -ls fred@example.com:dir1
+
+The SCP protocol does not contain within itself a means of listing
+files. If SCP is in use, this option therefore assumes that the
+server responds appropriately to the command \c{ls\_-la}; therefore,
+it may not work with all servers.
+
+If SFTP is in use, this option should work with all servers.
+
+\S2{pscp-usage-options-p}\I{-p-PSCP}\c{-p} \i{preserve file attributes}
By default, files copied with PSCP are \i{timestamp}ed with the date and
time they were copied. The \c{-p} option preserves the original
timestamp on copied files.
-\S2{pscp-usage-options-q}\c{-q} quiet, don't show \i{statistics}
+\S2{pscp-usage-options-q}\I{-q-PSCP}\c{-q} quiet, don't show \i{statistics}
By default, PSCP displays a meter displaying the progress of the
current transfer:
transferred. The \c{-q} option to PSCP suppresses the printing of
these statistics.
-\S2{pscp-usage-options-r}\c{-r} copies directories \i{recursive}ly
+\S2{pscp-usage-options-r}\I{-r-PSCP}\c{-r} copies directories \i{recursive}ly
By default, PSCP will only copy files. Any directories you specify to
copy will be skipped, as will their contents. The \c{-r} option tells
their contents. This allows you to use PSCP to transfer whole
directory structures between machines.
-\S2{pscp-usage-options-batch}\c{-batch} avoid interactive prompts
+\S2{pscp-usage-options-batch}\I{-batch-PSCP}\c{-batch} avoid interactive prompts
If you use the \c{-batch} option, PSCP will never give an
interactive prompt while establishing the connection. If the
scripts: using \c{-batch}, if something goes wrong at connection
time, the batch job will fail rather than hang.
-\S2{pscp-usage-options-backend}\c{-sftp}, \c{-scp} force use of
+\S2{pscp-usage-options-backend}\i\c{-sftp}, \i\c{-scp} force use of
particular protocol
As mentioned in \k{pscp-usage-basics}, there are two different file
transfer protocols in use with SSH. Despite its name, PSCP (like many
other ostensible \cw{scp} clients) can use either of these protocols.
-The older SCP protocol does not have a written specification and
-leaves a lot of detail to the server platform. Wildcards are expanded
+The older \i{SCP protocol} does not have a written specification and
+leaves a lot of detail to the server platform. \ii{Wildcards} are expanded
on the server. The simple design means that any wildcard specification
supported by the server platform (such as brace expansion) can be
used, but also leads to interoperability issues such as with filename
quoting (for instance, where filenames contain spaces), and also the
security issue described in \k{pscp-usage-basics}.
-The newer SFTP protocol, which is usually associated with SSH-2
+The newer \i{SFTP} protocol, which is usually associated with SSH-2
servers, is specified in a more platform independent way, and leaves
issues such as wildcard syntax up to the client. (PuTTY's SFTP
wildcard syntax is described in \k{psftp-wildcards}.) This makes it
When this option is specified, PSCP looks harder for an SFTP server,
which may allow use of SFTP with SSH-1 depending on server setup.
-\S{pscp-retval} Return value
+\S{pscp-retval} \ii{Return value}
-PSCP returns an \cw{ERRORLEVEL} of zero (success) only if the files
-were correctly transferred. You can test for this in a batch file,
+PSCP returns an \i\cw{ERRORLEVEL} of zero (success) only if the files
+were correctly transferred. You can test for this in a \i{batch file},
using code such as this:
\c pscp file*.* user@hostname:
\c if errorlevel 1 echo There was an error
-\S{pscp-pubkey} Using public key authentication with PSCP
+\S{pscp-pubkey} Using \i{public key authentication} with PSCP
Like PuTTY, PSCP can authenticate using a public key instead of a
password. There are three ways you can do this.
\define{versionidpsftp} \versionid $Id$
-\C{psftp} Using PSFTP to transfer files securely
+\C{psftp} Using \i{PSFTP} to transfer files securely
-\i{PSFTP}, the PuTTY SFTP client, is a tool for transferring files
+\i{PSFTP}, the PuTTY SFTP client, is a tool for \i{transferring files}
securely between computers using an SSH connection.
PSFTP differs from PSCP in the following ways:
\b PSCP should work on virtually every SSH server. PSFTP uses the
-new SFTP protocol, which is a feature of SSH-2 only. (PSCP will also
+new \i{SFTP} protocol, which is a feature of SSH-2 only. (PSCP will also
use this protocol if it can, but there is an SSH-1 equivalent it can
fall back to if it cannot.)
\b PSFTP allows you to run an interactive file transfer session,
-much like the Windows \c{ftp} program. You can list the contents of
+much like the Windows \i\c{ftp} program. You can list the contents of
directories, browse around the file system, issue multiple \c{get}
and \c{put} commands, and eventually log out. By contrast, PSCP is
designed to do a single file transfer operation and immediately
PSFTP also supports some of its own options. The following sections
describe PSFTP's specific command-line options.
-\S{psftp-option-b} \c{-b}: specify a file containing batch commands
+\S{psftp-option-b} \I{-b-PSFTP}\c{-b}: specify a file containing batch commands
In normal operation, PSFTP is an interactive program which displays
a command line and accepts commands from the keyboard.
If you need to do automated tasks with PSFTP, you would probably
-prefer to specify a set of commands in advance and have them
-executed automatically. The \c{-b} option allows you to do this. You
-use it with a file name containing batch commands. For example, you
-might create a file called \c{myscript.scr} containing lines like
-this:
+prefer to \I{batch scripts in PSFTP}specify a set of commands in
+advance and have them executed automatically. The \c{-b} option
+allows you to do this. You use it with a file name containing batch
+commands. For example, you might create a file called \c{myscript.scr}
+containing lines like this:
\c cd /home/ftp/users/jeff
\c del jam-old.tar.gz
if any command fails to complete successfully. To change this
behaviour, you can add the \c{-be} option (\k{psftp-option-be}).
-\S{psftp-option-bc} \c{-bc}: display batch commands as they are run
+\S{psftp-option-bc} \I{-bc-PSFTP}\c{-bc}: display batch commands as they are run
The \c{-bc} option alters what PSFTP displays while processing a
batch script specified with \c{-b}. With the \c{-bc} option, PSFTP
\c drwxrwsr-x 2 fred fred 1024 Mar 13 2000 trn
\c psftp> quit
-\S{psftp-option-be} \c{-be}: continue batch processing on errors
+\S{psftp-option-be} \I{-be-PSFTP}\c{-be}: continue batch processing on errors
When running a batch file, this additional option causes PSFTP to
continue processing even if a command fails to complete successfully.
You might want this to happen if you wanted to delete a file and
didn't care if it was already not present, for example.
-\S{psftp-usage-options-batch}\c{-batch}: avoid interactive prompts
+\S{psftp-usage-options-batch} \I{-batch-PSFTP}\c{-batch}: avoid
+interactive prompts
If you use the \c{-batch} option, PSFTP will never give an
interactive prompt while establishing the connection. If the
prompt. You can now type commands to perform file-transfer
functions. This section lists all the available commands.
-\S{psftp-quoting} General quoting rules for PSFTP commands
+\S{psftp-quoting} \I{quoting, in PSFTP}General quoting rules for PSFTP commands
Most PSFTP commands are considered by the PSFTP command interpreter
as a sequence of words, separated by spaces. For example, the
\c{ren} (the command name), \c{oldfilename} (the name of the file to
be renamed), and \c{newfilename} (the new name to give the file).
-Sometimes you will need to specify file names that \e{contain}
-spaces. In order to do this, you can surround the file name with
-double quotes. This works equally well for local file names and
-remote file names:
+Sometimes you will need to specify \I{spaces in filenames}file names
+that \e{contain} spaces. In order to do this, you can surround
+the file name with double quotes. This works equally well for
+local file names and remote file names:
\c psftp> get "spacey file name.txt" "save it under this name.txt"
\S{psftp-wildcards} Wildcards in PSFTP
-Several commands in PSFTP support \q{wildcards} to select multiple
+Several commands in PSFTP support \q{\i{wildcards}} to select multiple
files.
For \e{local} file specifications (such as the first argument to
where PSFTP on Unix would need \c{*}.
For \e{remote} file specifications (such as the first argument to
-\c{get}), PSFTP uses a standard wildcard syntax (similar to POSIX
+\c{get}), PSFTP uses a standard wildcard syntax (similar to \i{POSIX}
wildcards):
\b \c{*} matches any sequence of characters (including a zero-length
command.
\S{psftp-cmd-cd} The \c{cd} and \c{pwd} commands: changing the
-remote working directory
+remote \i{working directory}
PSFTP maintains a notion of your \q{working directory} on the
server. This is the default directory that other commands will
To display your current remote working directory, type \c{pwd}.
\S{psftp-cmd-lcd} The \c{lcd} and \c{lpwd} commands: changing the
-local working directory
+local \i{working directory}
As well as having a working directory on the remote server, PSFTP
also has a working directory on your local machine (just like any
\S{psftp-cmd-get} The \c{get} command: fetch a file from the server
-To download a file from the server and store it on your local PC,
+To \i{download a file} from the server and store it on your local PC,
you use the \c{get} command.
In its simplest form, you just use this with a file name:
This will fetch the file on the server called \c{myfile.dat}, but
will save it to your local machine under the name \c{newname.dat}.
-To fetch an entire directory recursively, you can use the \c{-r}
+To fetch an entire directory \i{recursive}ly, you can use the \c{-r}
option:
\c get -r mydir
\S{psftp-cmd-put} The \c{put} command: send a file to the server
-To upload a file to the server from your local PC, you use the
+To \i{upload a file} to the server from your local PC, you use the
\c{put} command.
In its simplest form, you just use this with a file name:
This will send the local file called \c{myfile.dat}, but will store
it on the server under the name \c{newname.dat}.
-To send an entire directory recursively, you can use the \c{-r}
+To send an entire directory \i{recursive}ly, you can use the \c{-r}
option:
\c put -r mydir
Every argument to \c{mget} is treated as the name of a file to fetch
(unlike \c{get}, which will interpret at most one argument like
that, and a second argument will be treated as an alternative name
-under which to store the retrieved file), or a wildcard expression
+under which to store the retrieved file), or a \i{wildcard} expression
matching more than one file.
The \c{-r} and \c{--} options from \c{get} are also available with
\c{mput} is similar to \c{put}, with the same differences.
\S{psftp-cmd-regetput} The \c{reget} and \c{reput} commands:
-resuming file transfers
+\i{resuming file transfers}
If a file transfer fails half way through, and you end up with half
the file stored on your disk, you can resume the file transfer using
corrupted files. In particular, the \c{-r} option will not pick up
changes to files or directories already transferred in full.
-\S{psftp-cmd-dir} The \c{dir} command: list remote files
+\S{psftp-cmd-dir} The \c{dir} command: \I{listing files}list remote files
To list the files in your remote working directory, just type
\c{dir}.
\S{psftp-cmd-chmod} The \c{chmod} command: change permissions on
remote files
-PSFTP allows you to modify the file permissions on files and
+\I{changing permissions on files}PSFTP
+allows you to modify the file permissions on files and
directories on the server. You do this using the \c{chmod} command,
which works very much like the Unix \c{chmod} command.
\b A \c{+} or \c{-} sign, indicating whether permissions are to be
added or removed.
-\b The actual permissions being added or removed. These can be \c{r}
-(permission to read the file), \c{w} (permission to write to the
-file), and \c{x} (permission to execute the file, or in the case of
-a directory, permission to access files within the directory).
+\b The actual permissions being added or removed. These can be
+\I{read permission}\c{r} (permission to read the file),
+\I{write permission}\c{w} (permission to write to the file), and
+\I{execute permission}\c{x} (permission to execute the file, or in
+the case of a directory, permission to access files within the
+directory).
So the above examples would do:
all files and directories starting with \q{public}.
In addition to all this, there are a few extra special cases for
-Unix systems. On non-Unix systems these are unlikely to be useful:
+\i{Unix} systems. On non-Unix systems these are unlikely to be useful:
\b You can specify \c{u+s} and \c{u-s} to add or remove the Unix
-set-user-ID bit. This is typically only useful for special purposes;
+\i{set-user-ID bit}. This is typically only useful for special purposes;
refer to your Unix documentation if you're not sure about it.
\b You can specify \c{g+s} and \c{g-s} to add or remove the Unix
-set-group-ID bit. On a file, this works similarly to the set-user-ID
+\i{set-group-ID bit}. On a file, this works similarly to the set-user-ID
bit (see your Unix documentation again); on a directory it ensures
that files created in the directory are accessible by members of the
group that owns the directory.
\b You can specify \c{+t} and \c{-t} to add or remove the Unix
-\q{sticky bit}. When applied to a directory, this means that the
+\q{\i{sticky bit}}. When applied to a directory, this means that the
owner of a file in that directory can delete the file (whereas
normally only the owner of the \e{directory} would be allowed to).
\S{psftp-cmd-del} The \c{del} command: delete remote files
-To delete a file on the server, type \c{del} and then the filename
-or filenames:
+To \I{deleting files}delete a file on the server, type \c{del} and
+then the filename or filenames:
\c del oldfile.dat
\c del file1.txt file2.txt
\S{psftp-cmd-mkdir} The \c{mkdir} command: create remote directories
-To create a directory on the server, type \c{mkdir} and then the
+To \i{create a directory} on the server, type \c{mkdir} and then the
directory name:
\c mkdir newstuff
\S{psftp-cmd-rmdir} The \c{rmdir} command: remove remote directories
-To remove a directory on the server, type \c{rmdir} and then the
+To \i{remove a directory} on the server, type \c{rmdir} and then the
directory name or names:
\c rmdir oldstuff
directory has anything in it, so you will need to delete the
contents first.
-\S{psftp-cmd-mv} The \c{mv} command: move and rename remote files
+\S{psftp-cmd-mv} The \c{mv} command: move and \i{rename remote files}
To rename a single file on the server, type \c{mv}, then the current
file name, and then the new file name:
The \c{rename} and \c{ren} commands work exactly the same way as
\c{mv}.
-\S{psftp-cmd-pling} The \c{!} command: run a local Windows command
+\S{psftp-cmd-pling} The \c{!} command: run a \i{local Windows command}
You can run local Windows commands using the \c{!} command. This is
the only PSFTP command that is not subject to the command quoting
using the Windows \c{ren} command to rename files on your local PC.
-\H{psftp-pubkey} Using public key authentication with PSFTP
+\H{psftp-pubkey} Using \i{public key authentication} with PSFTP
Like PuTTY, PSFTP can authenticate using a public key instead of a
password. There are three ways you can do this.
\C{pubkey} Using public keys for SSH authentication
-\H{pubkey-intro} Public key authentication - an introduction
+\H{pubkey-intro} \ii{Public key authentication} - an introduction
Public key authentication is an alternative means of identifying
yourself to a login server, instead of typing a password. It is more
claim to be by proving that you know the correct password. The only
way to prove you know the password is to tell the server what you
think the password is. This means that if the server has been
-hacked, or \e{spoofed} (see \k{gs-hostkey}), an attacker can learn
+hacked, or \i\e{spoofed} (see \k{gs-hostkey}), an attacker can learn
your password.
-Public key authentication solves this problem. You generate a \e{key
-pair}, consisting of a public key (which everybody is allowed to
-know) and a private key (which you keep secret and do not give to
-anybody). The private key is able to generate \e{signatures}.
+Public key authentication solves this problem. You generate a \i\e{key
+pair}, consisting of a \i{public key} (which everybody is allowed to
+know) and a \i{private key} (which you keep secret and do not give to
+anybody). The private key is able to generate \i\e{signatures}.
A signature created using your private key cannot be forged by
anybody who does not have that key; but anybody who has your public
key can verify that a particular signature is genuine.
unprotected on your own computer, then anybody who gains access to
\e{that} will be able to generate signatures as if they were you. So
they will be able to log in to your server under your account. For
-this reason, your private key is usually \e{encrypted} when it is
-stored on your local machine, using a passphrase of your choice. In
+this reason, your private key is usually \i\e{encrypted} when it is
+stored on your local machine, using a \i{passphrase} of your choice. In
order to generate a signature, PuTTY must decrypt the key, so you
have to type your passphrase.
This can make public-key authentication less convenient than
password authentication: every time you log in to the server,
instead of typing a short password, you have to type a longer
-passphrase. One solution to this is to use an \e{authentication
+passphrase. One solution to this is to use an \i\e{authentication
agent}, a separate program which holds decrypted private keys and
generates signatures on request. PuTTY's authentication agent is
-called Pageant. When you begin a Windows session, you start Pageant
+called \i{Pageant}. When you begin a Windows session, you start Pageant
and load your private key into it (typing your passphrase once). For
the rest of your session, you can start PuTTY any number of times
and Pageant will automatically generate signatures without you
disk. Many people feel this is a good compromise between security
and convenience. See \k{pageant} for further details.
-There is more than one public-key algorithm available. The most
-common is RSA, but others exist, notably DSA (otherwise known as
+There is more than one \i{public-key algorithm} available. The most
+common is \i{RSA}, but others exist, notably \i{DSA} (otherwise known as
DSS), the USA's federal Digital Signature Standard. The key types
supported by PuTTY are described in \k{puttygen-keytype}.
-\H{pubkey-puttygen} Using PuTTYgen, the PuTTY key generator
+\H{pubkey-puttygen} Using \i{PuTTYgen}, the PuTTY key generator
\cfg{winhelp-topic}{puttygen.general}
-PuTTYgen is a key generator. It generates pairs of public and private
-keys to be used with PuTTY, PSCP, and Plink, as well as the PuTTY
-authentication agent, Pageant (see \k{pageant}). PuTTYgen generates
-RSA and DSA keys.
+PuTTYgen is a key generator. It \I{generating keys}generates pairs of
+public and private keys to be used with PuTTY, PSCP, and Plink, as well
+as the PuTTY authentication agent, Pageant (see \k{pageant}). PuTTYgen
+generates RSA and DSA keys.
When you run PuTTYgen you will see a window where you have two
choices: \q{Generate}, to generate a new public/private key pair, or
which type of key you need. PuTTYgen currently supports three types
of key:
-\b An RSA key for use with the SSH-1 protocol.
+\b An \i{RSA} key for use with the SSH-1 protocol.
\b An RSA key for use with the SSH-2 protocol.
-\b A DSA key for use with the SSH-2 protocol.
+\b A \i{DSA} key for use with the SSH-2 protocol.
The SSH-1 protocol only supports RSA keys; if you will be connecting
using the SSH-1 protocol, you must select the first key type or your
The SSH-2 protocol supports more than one key type. The two types
supported by PuTTY are RSA and DSA.
-The PuTTY developers \e{strongly} recommend you use RSA. DSA has an
-intrinsic weakness which makes it very easy to create a signature
-which contains enough information to give away the \e{private} key!
+The PuTTY developers \e{strongly} recommend you use RSA.
+\I{security risk}\i{DSA} has an intrinsic weakness which makes it very
+easy to create a signature which contains enough information to give
+away the \e{private} key!
This would allow an attacker to pretend to be you for any number of
future sessions. PuTTY's implementation has taken very careful
precautions to avoid this weakness, but we cannot be 100% certain we
When the key generation is complete, a new set of controls will
appear in the window to indicate this.
-\S{puttygen-fingerprint} The \q{Key fingerprint} box
+\S{puttygen-fingerprint} The \q{\ii{Key fingerprint}} box
\cfg{winhelp-topic}{puttygen.fingerprint}
change the comment later, you can load the private key back into
PuTTYgen, change the comment, and save it again.
-\S{puttygen-passphrase} Setting a passphrase for your key
+\S{puttygen-passphrase} Setting a \i{passphrase} for your key
\cfg{winhelp-topic}{puttygen.passphrase}
The \q{Key passphrase} and \q{Confirm passphrase} boxes allow you to
choose a passphrase for your key. The passphrase will be used to
-encrypt the key on disk, so you will not be able to use the key
+\i{encrypt} the key on disk, so you will not be able to use the key
without first entering the passphrase.
When you save the key, PuTTY will check that the \q{Key passphrase}
unencrypted. You should \e{not} do this without good reason; if you
do, your private key file on disk will be all an attacker needs to
gain access to any machine configured to accept that key. If you
-want to be able to log in without having to type a passphrase every
-time, you should consider using Pageant (\k{pageant}) so that your
-decrypted key is only held in memory rather than on disk.
+want to be able to \i{passwordless login}log in without having to
+type a passphrase every time, you should consider using Pageant
+(\k{pageant}) so that your decrypted key is only held in memory
+rather than on disk.
Under special circumstances you may genuinely \e{need} to use a key
with no passphrase; for example, if you need to run an automated
Choosing a good passphrase is difficult. Just as you shouldn't use a
dictionary word as a password because it's easy for an attacker to
run through a whole dictionary, you should not use a song lyric,
-quotation or other well-known sentence as a passphrase. DiceWare
+quotation or other well-known sentence as a passphrase. \i{DiceWare}
(\W{http://www.diceware.com/}\cw{www.diceware.com}) recommends using
at least five words each generated randomly by rolling five dice,
which gives over 2^64 possible passphrases and is probably not a bad
box asking you where to save the file. Select a directory, type in a
file name, and press \q{Save}.
-This file is in PuTTY's native format (\c{*.PPK}); it is the one you
+This file is in PuTTY's native format (\c{*.\i{PPK}}); it is the one you
will need to tell PuTTY to use for authentication (see
\k{config-ssh-privkey}) or tell Pageant to load (see
\k{pageant-mainwin-addkey}).
\cfg{winhelp-topic}{puttygen.savepub}
-The SSH-2 protocol drafts specify a standard format for storing
-public keys on disk. Some SSH servers (such as \cw{ssh.com}'s)
-require a public key in this format in order to accept
+The SSH-2 protocol drafts specify a \I{SSH-2 public key format}standard
+format for storing public keys on disk. Some SSH servers (such as
+\i\cw{ssh.com}'s) require a public key in this format in order to accept
authentication with the corresponding private key. (Others, such as
OpenSSH, use a different format; see \k{puttygen-pastekey}.)
for pasting} box. This is the only existing standard for SSH-1
public keys.
-\S{puttygen-pastekey} \q{Public key for pasting into authorized_keys
-file}
+\S{puttygen-pastekey} \q{Public key for pasting into \i{authorized_keys
+file}}
\cfg{winhelp-topic}{puttygen.pastekey}
All SSH-1 servers require your public key to be given to it in a
one-line format before it will accept authentication with your
-private key. The OpenSSH server also requires this for SSH-2.
+private key. The \i{OpenSSH} server also requires this for SSH-2.
The \q{Public key for pasting into authorized_keys file} gives the
public-key data in the correct one-line format. Typically you will
SSH-1 private key using OpenSSH or \cw{ssh.com}'s client, you can use
it with PuTTY, and vice versa.
-However, SSH-2 private keys have no standard format. OpenSSH and
-\cw{ssh.com} have different formats, and PuTTY's is different again.
+However, SSH-2 private keys have no standard format. \I{OpenSSH private
+key format}OpenSSH and \I{ssh.com private key format}\cw{ssh.com} have
+different formats, and PuTTY's is different again.
So a key generated with one client cannot immediately be used with
another.
-Using the \q{Import} command from the \q{Conversions} menu, PuTTYgen
-can load SSH-2 private keys in OpenSSH's format and \cw{ssh.com}'s
-format. Once you have loaded one of these key types, you can then
-save it back out as a PuTTY-format key (\c{*.PPK}) so that you can use
-it with the PuTTY suite. The passphrase will be unchanged by this
+Using the \I{importing keys}\q{Import} command from the \q{Conversions}
+menu, PuTTYgen can load SSH-2 private keys in OpenSSH's format and
+\cw{ssh.com}'s format. Once you have loaded one of these key types, you
+can then save it back out as a PuTTY-format key (\c{*.\i{PPK}}) so that
+you can use it with the PuTTY suite. The passphrase will be unchanged by this
process (unless you deliberately change it). You may want to change
the key comment before you save the key, since OpenSSH's SSH-2 key
format contains no space for a comment and \cw{ssh.com}'s default
comment format is long and verbose.
-PuTTYgen can also export private keys in OpenSSH format and in
+PuTTYgen can also \i{export private keys} in OpenSSH format and in
\cw{ssh.com} format. To do so, select one of the \q{Export} options
from the \q{Conversions} menu. Exporting a key works exactly like
saving it (see \k{puttygen-savepriv}) - you need to have typed your
accept your public key for authentication:
\b If your server is using the SSH-1 protocol, you should change
-into the \c{.ssh} directory and open the file \c{authorized_keys}
+into the \i\c{.ssh} directory and open the file \i\c{authorized_keys}
with your favourite editor. (You may have to create this file if
this is the first key you have put in it). Then switch to the
PuTTYgen window, select all of the text in the \q{Public key for
PuTTY window and insert the data into the open file, making sure it
ends up all on one line. Save the file.
-\b If your server is OpenSSH and is using the SSH-2 protocol, you
+\b If your server is \i{OpenSSH} and is using the SSH-2 protocol, you
should follow the same instructions, except that in earlier versions
of OpenSSH 2 the file might be called \c{authorized_keys2}. (In
modern versions the same \c{authorized_keys} file is used for both
SSH-1 and SSH-2 keys.)
-\b If your server is \cw{ssh.com}'s product and is using SSH-2, you
+\b If your server is \i\cw{ssh.com}'s product and is using SSH-2, you
need to save a \e{public} key file from PuTTYgen (see
-\k{puttygen-savepub}), and copy that into the \c{.ssh2} directory on
+\k{puttygen-savepub}), and copy that into the \i\c{.ssh2} directory on
the server. Then you should go into that \c{.ssh2} directory, and edit
(or create) a file called \c{authorization}. In this file you should
put a line like \c{Key mykey.pub}, with \c{mykey.pub} replaced by the
PuTTY's copy and paste works entirely with the \i{mouse}. In order
to copy text to the clipboard, you just click the \i{left mouse
-button} in the terminal window, and drag to \I{selecting text}select
+button} in the \i{terminal window}, and drag to \I{selecting text}select
text. When you let go of the button, the text is \e{automatically}
copied to the clipboard. You do not need to press Ctrl-C or
Ctrl-Ins; in fact, if you do press Ctrl-C, PuTTY will send a Ctrl-C
cause a process to be interrupted.
Pasting is done using the right button (or the middle mouse button,
-if you have a three-button mouse and have set it up; see
+if you have a \i{three-button mouse} and have set it up; see
\k{config-mouse}). (Pressing \i{Shift-Ins}, or selecting \q{Paste}
-from the Ctrl+right-click context menu, have the same effect.) When
+from the \I{right mouse button, with Ctrl}Ctrl+right-click
+\i{context menu}, have the same effect.) When
you click the \i{right mouse button}, PuTTY will read whatever is in
the Windows clipboard and paste it into your session, \e{exactly} as
if it had been typed at the keyboard. (Therefore, be careful of
spaces added by the editor add up to too many spaces and ruin the
formatting. There is nothing PuTTY can do about this.)
-If you \i{double-click} the left mouse button, PuTTY will select a
-whole word. If you double-click, hold down the second click, and
-drag the mouse, PuTTY will select a sequence of whole words. (You
-can adjust precisely what PuTTY considers to be part of a word; see
-\k{config-charclasses}.) If you \e{triple}-click, or
-\i{triple-click} and drag, then PuTTY will select a whole line or
-sequence of lines.
+If you \i{double-click} the left mouse button, PuTTY will
+\I{selecting words}select a whole word. If you double-click, hold
+down the second click, and drag the mouse, PuTTY will select a
+sequence of whole words. (You can adjust precisely what PuTTY
+considers to be part of a word; see \k{config-charclasses}.)
+If you \e{triple}-click, or \i{triple-click} and drag, then
+PuTTY will \I{selecting lines}select a whole line or sequence of lines.
If you want to select a \I{rectangular selection}rectangular region
instead of selecting to the end of each line, you can do this by
instead.) Click the button on the screen, and you can pick up the
nearest end of the selection and drag it to somewhere else.
-It's possible for the server to ask to handle mouse clicks in the
-PuTTY window itself. If this happens, the mouse cursor will turn
-into an arrow, and using the mouse to copy and paste will only work if
-you hold down Shift. See \k{config-features-mouse} and
+It's possible for the server to ask to \I{mouse reporting}handle mouse
+clicks in the PuTTY window itself. If this happens, the \i{mouse pointer}
+will turn into an arrow, and using the mouse to copy and paste will only
+work if you hold down Shift. See \k{config-features-mouse} and
\k{config-mouseshift} for details of this feature and how to configure
it.
PuTTY keeps track of text that has scrolled up off the top of the
terminal. So if something appears on the screen that you want to
read, but it scrolls too fast and it's gone by the time you try to
-look for it, you can use the scrollbar on the right side of the
+look for it, you can use the \i{scrollbar} on the right side of the
window to look back up the session \i{history} and find it again.
As well as using the scrollbar, you can also page the scrollback up
preserved for you to look at. You can increase (or decrease) this
value using the configuration box; see \k{config-scrollback}.
-\S{using-sysmenu} The \i{System menu}
+\S{using-sysmenu} The \ii{System menu}
If you click the left mouse button on the icon in the top left
corner of PuTTY's terminal window, or click the right mouse button
the Windows standard options. These extra menu commands are
described below.
-(These options are also available in a context menu brought up
+(These options are also available in a \i{context menu} brought up
by holding Ctrl and clicking with the right mouse button anywhere
-in the PuTTY window.)
+in the \i{PuTTY window}.)
\S2{using-eventlog} The PuTTY \i{Event Log}
connection in addition to normal data. Their precise effect is usually
up to the server. Currently only Telnet and SSH have special commands.
-The following special commands are available in Telnet:
+The following \I{Telnet special commands}special commands are
+available in Telnet:
\b \I{Are You There, Telnet special command}Are You There
\b \I{End Of File, Telnet special command}End Of File
-In an SSH connection, the following special commands are available:
+In an SSH connection, the following \I{SSH special commands}special
+commands are available:
-\b \I{IGNORE message, SSH special command}\I{No-op, in SSH}IGNORE message
+\b \I{IGNORE message, SSH special command}\I{No-op, in SSH}\ii{IGNORE message}
\lcont{
Should have no effect.
\b \I{Repeat key exchange, SSH special command}Repeat key exchange
\lcont{
-Only available in SSH-2. Forces a repeat key exchange immediately (and
+Only available in SSH-2. Forces a \i{repeat key exchange} immediately (and
resets associated timers and counters). For more information about
repeat key exchanges, see \k{config-ssh-kex-rekey}.
}
PuTTY's memory.)
The \i{\q{Reset Terminal}} option causes a full reset of the
-terminal emulation. A VT-series terminal is a complex piece of
+\i{terminal emulation}. A VT-series terminal is a complex piece of
software and can easily get into a state where all the text printed
becomes unreadable. (This can happen, for example, if you
accidentally output a binary file to your terminal.) If this
disappear. (You can configure the scrollbar not to disappear in
full-screen mode if you want to keep it; see \k{config-scrollback}.)
-When you are in full-screen mode, you can still access the system
-menu if you click the left mouse button in the \e{extreme} top left
+When you are in full-screen mode, you can still access the \i{system
+menu} if you click the left mouse button in the \e{extreme} top left
corner of the screen.
\H{using-logging} Creating a \i{log file} of your \I{session
log}session
For some purposes you may find you want to log everything that
-appears on your screen. You can do this using the \i{\q{Logging}
-panel} in the configuration box.
+appears on your screen. You can do this using the \q{Logging}
+panel in the configuration box.
To begin a session log, select \q{Change Settings} from the system
menu and go to the Logging panel. Enter a log file name, and select
a logging mode. (You can log all session output including the
-terminal control sequences, or you can just log the printable text.
+terminal \i{control sequence}s, or you can just log the printable text.
It depends what you want the log for.) Click \q{Apply} and your log
will be started. Later on, you can go back to the Logging panel and
select \q{Logging turned off completely} to stop logging; then PuTTY
set}. There are a lot of different character sets available, so it's
entirely possible for this to happen.
-If you click \q{Change Settings} and look at the \i{\q{Translation}
-panel}, you should see a large number of character sets which you can
+If you click \q{Change Settings} and look at the \q{Translation}
+panel, you should see a large number of character sets which you can
select, and other related options. Now all you need is to find out
which of them you want! (See \k{config-translation} for more
information.)
You should then tick the \q{Enable X11 forwarding} box in the
Tunnels panel (see \k{config-ssh-x11}) before starting your SSH
-session. The \q{X display location} box is blank by default, which
+session. The \i{\q{X display location}} box is blank by default, which
means that PuTTY will try to use a sensible default such as \c{:0},
which is the usual display location where your X server will be
installed. If that needs changing, then change it.
If this works, you should then be able to run X applications in the
remote session and have them display their windows on your PC.
-Note that if your PC X server requires authentication to connect,
-then PuTTY cannot currently support it. If this is a problem for
+Note that if your PC X server requires \I{X11 authentication}authentication
+to connect, then PuTTY cannot currently support it. If this is a problem for
you, you should mail the PuTTY authors \#{FIXME} and give details
(see \k{feedback}).
\H{using-port-forwarding} Using \i{port forwarding} in SSH
-The SSH protocol has the ability to forward arbitrary network
-connections over your encrypted SSH connection, to avoid the network
+The SSH protocol has the ability to forward arbitrary \i{network
+connection}s over your encrypted SSH connection, to avoid the network
traffic being sent in clear. For example, you could use this to
-connect from your home computer to a POP-3 server on a remote
+connect from your home computer to a \i{POP-3} server on a remote
machine without your POP-3 password being visible to network
sniffers.
-In order to use port forwarding to connect from your local machine
-to a port on a remote server, you need to:
+In order to use port forwarding to \I{local port forwarding}connect
+from your local machine to a port on a remote server, you need to:
-\b Choose a port number on your local machine where PuTTY should
+\b Choose a \i{port number} on your local machine where PuTTY should
listen for incoming connections. There are likely to be plenty of
unused port numbers above 3000. (You can also use a local loopback
address here; see below for more details.)
forwarding will stop happening when your PuTTY session closes down.)
You can also forward ports in the other direction: arrange for a
-particular port number on the \e{server} machine to be forwarded
-back to your PC as a connection to a service on your PC or near it.
+particular port number on the \e{server} machine to be \I{remote
+port forwarding}forwarded back to your PC as a connection to a
+service on your PC or near it.
To do this, just select the \q{Remote} radio button instead of the
\q{Local} one. The \q{Source port} box will now specify a port
number on the \e{server} (note that most servers will not allow you
-to use port numbers under 1024 for this purpose).
+to use \I{privileged port}port numbers under 1024 for this purpose).
An alternative way to forward local connections to remote hosts is
-to use \I{dynamic port forwarding}dynamic \I{SOCKS} proxying. For
+to use \I{dynamic port forwarding}dynamic SOCKS proxying. For
this, you will need to select the \q{Dynamic} radio button instead
of \q{Local}, and then you should not enter anything into the
\q{Destination} box (it will be ignored). This will cause PuTTY to
details).
The source port for a forwarded connection usually does not accept
-connections from any machine except the SSH client or server machine
-itself (for local and remote forwardings respectively). There are
-controls in the Tunnels panel to change this:
+connections from any machine except the \I{localhost}SSH client or
+server machine itself (for local and remote forwardings respectively).
+There are controls in the Tunnels panel to change this:
\b The \q{Local ports accept connections from other hosts} option
allows you to set up local-to-remote port forwardings (including
remote-to-local port forwardings (so that machines other than the
SSH server machine can connect to the forwarded port.) Note that
this feature is only available in the SSH-2 protocol, and not all
-SSH-2 servers honour it (in OpenSSH, for example, it's usually
+SSH-2 servers honour it (in \i{OpenSSH}, for example, it's usually
disabled by default).
-You can also specify an \i{IP address} to listen on. Typically a
-Windows machine can be asked to listen on any single IP address in
-the \cw{127.*.*.*} range, and all of these are loopback addresses
-available only to the local machine. So if you forward (for example)
-\c{127.0.0.5:79} to a remote machine's \cw{finger} port, then you
-should be able to run commands such as \c{finger fred@127.0.0.5}.
+You can also specify an \i{IP address} to \I{listen address}listen
+on. Typically a Windows machine can be asked to listen on any single
+IP address in the \cw{127.*.*.*} range, and all of these are
+\i{loopback address}es available only to the local machine. So if
+you forward (for example) \c{127.0.0.5:79} to a remote machine's
+\i\cw{finger} port, then you should be able to run commands such as
+\c{finger fred@127.0.0.5}.
This can be useful if the program connecting to the forwarded port
doesn't allow you to change the port number it uses. This feature is
available for local-to-remote forwarded ports; SSH-1 is unable to
\c putty.exe [-ssh | -telnet | -rlogin | -raw] [user@]host
-If this syntax is used, settings are taken from the Default Settings
+If this syntax is used, settings are taken from the \i{Default Settings}
(see \k{config-saving}); \c{user} overrides these settings if
supplied. Also, you can specify a protocol, which will override the
default protocol (see \k{using-cmdline-protocol}).
You need double quotes around the session name if it contains spaces.
-If you want to create a Windows shortcut to start a PuTTY saved
+If you want to create a \i{Windows shortcut} to start a PuTTY saved
session, this is the option you should use: your shortcut should
call something like
command line. The command-line options work just like the ones in
Unix \c{ssh} programs.
-To forward a local port (say 5110) to a remote destination (say
-\cw{popserver.example.com} port 110), you can write something like
-one of these:
+To \I{local port forwarding}forward a local port (say 5110) to a
+remote destination (say \cw{popserver.example.com} port 110), you
+can write something like one of these:
\c putty -L 5110:popserver.example.com:110 -load mysession
\c plink mysession -L 5110:popserver.example.com:110
-To forward a remote port to a local destination, just use the \c{-R}
-option instead of \c{-L}:
+To forward a \I{remote port forwarding}remote port to a local
+destination, just use the \c{-R} option instead of \c{-L}:
\c putty -R 5023:mytelnetserver.myhouse.org:23 -load mysession
\c plink mysession -R 5023:mytelnetserver.myhouse.org:23
-To specify an IP address for the listening end of the tunnel,
-prepend it to the argument:
+To \I{listen address}specify an IP address for the listening end of the
+tunnel, prepend it to the argument:
\c plink -L 127.0.0.5:23:localhost:23 myhost
-To set up SOCKS-based dynamic port forwarding on a local port, use
-the \c{-D} option. For this one you only have to pass the port
-number:
+To set up \I{dynamic port forwarding}SOCKS-based dynamic port
+forwarding on a local port, use the \c{-D} option. For this one you
+only have to pass the port number:
\c putty -D 4096 -load mysession
These options are not available in the file transfer tools PSCP and
PSFTP.
-\S2{using-cmdline-m} \i\c{-m}: read a remote command or script from
-a file
+\S2{using-cmdline-m} \i\c{-m}: \I{reading commands from a file}read
+a remote command or script from a file
-The \i\c{-m} option performs a similar function to the \q{Remote
-command} box in the SSH panel of the PuTTY configuration box (see
+The \i\c{-m} option performs a similar function to the \q{\ii{Remote
+command}} box in the SSH panel of the PuTTY configuration box (see
\k{config-command}). However, the \c{-m} option expects to be given
a local file name, and it will read a command from that file. On
most Unix systems, you can even put multiple lines in this file and
\S2{using-cmdline-identity} \i\c{-i}: specify an SSH \i{private key}
The \c{-i} option allows you to specify the name of a private key
-file in \c{*.PPK} format which PuTTY will use to authenticate with the
+file in \c{*.\i{PPK}} format which PuTTY will use to authenticate with the
server. This option is only meaningful if you are using SSH.
For general information on \i{public-key authentication}, see
authentication} box in the Auth panel of the PuTTY configuration box
(see \k{config-ssh-privkey}).
-\S2{using-cmdline-pgpfp} \i\c{-pgpfp}: display PGP key fingerprints
+\S2{using-cmdline-pgpfp} \i\c{-pgpfp}: display \i{PGP key fingerprint}s
This option causes the PuTTY tools not to run as normal, but instead
to display the fingerprints of the PuTTY PGP Master Keys, in order to
-aid with verifying new versions. See \k{pgpkeys} for more information.
+aid with \i{verifying new versions}. See \k{pgpkeys} for more information.
projects / u / mdw / putty / commitdiff