-\versionid $Id: config.but,v 1.12 2001/11/25 16:57:45 simon Exp $
+\versionid $Id: config.but,v 1.13 2001/11/25 17:32:39 simon Exp $
\C{config} Configuring 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
-session, by selecting \e{Change Settings} from the window menu.
+session, by selecting \q{Change Settings} from the window menu.
\H{config-session} The Session panel
connection by host name}, contains the details that need to be
filled in before PuTTY can open a session at all.
-\b The \e{Host Name} box is where you type the name, or the IP
+\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 \e{Protocol} radio buttons let you choose what type of
+\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
summary of the differences between SSH, Telnet and rlogin.)
-\b The \e{Port} box lets you specify which port number on the server
+\b The \q{Port} box lets you specify which 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 \e{Port} box.
+will almost certainly need to fill in the \q{Port} box.
\S{config-saving} Loading and storing saved sessions
\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
-click. Then press the \e{Save} button.
+click. Then press the \q{Save} button.
Note that PuTTY does not allow you to save a host name into the
Default Settings entry. This ensures that when PuTTY is started up,
\b To save a session: first go through the rest of the configuration
box setting up all the options you want. Then come back to the
-Session panel. Enter a name for the saved session in the \e{Saved
+Session panel. Enter a name for the saved session in the \q{Saved
Sessions} input box. (The server name is often a good choice for a
-saved session name.) Then press the \e{Save} button. Your saved
+saved session name.) Then press the \q{Save} button. Your saved
session name should now appear in the list box.
\b To reload a saved session: single-click to select the session
-name in the list box, and then press the \e{Load} button. Your saved
+name in the list box, and then press the \q{Load} button. Your saved
settings should all appear in the configuration panel.
\b To modify a saved session: first load it as described above. Then
make the changes you want. Come back to the Session panel,
single-click to select the session name in the list box, and press
-the \e{Save} button. The new settings will be saved over the top of
+the \q{Save} button. The new settings will be saved over the top of
the old ones.
\b To start a saved session immediately: double-click on the session
name in the list box.
\b To delete a saved session: single-click to select the session
-name in the list box, and then press the \e{Delete} button.
+name in the list box, and then press the \q{Delete} button.
Each saved session is independent of the Default Settings
configuration. If you change your preferences and update Default
Auto wrap mode can be turned on and off by control sequences sent by
the server. This configuration option only controls the \e{default}
-state. If you modify this option in mid-session using \e{Change
+state. If you modify this option in mid-session using \q{Change
Settings}, you will need to reset the terminal \#{ FIXME } before
the change takes effect.
DEC Origin Mode can be turned on and off by control sequences sent by
the server. This configuration option only controls the \e{default}
-state. If you modify this option in mid-session using \e{Change
+state. If you modify this option in mid-session using \q{Change
Settings}, you will need to reset the terminal \#{ FIXME } before
the change takes effect.
\S{config-winsize} Setting the size of the PuTTY window
-The \e{Rows} and \e{Columns} boxes let you set the PuTTY window to a
+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.
-\versionid $Id: gs.but,v 1.4 2001/11/25 16:57:45 simon Exp $
+\versionid $Id: gs.but,v 1.5 2001/11/25 17:32:39 simon Exp $
\C{gs} Getting started with PuTTY
To start the simplest kind of session, all you need to do is to
enter a few basic parameters.
-In the \e{Host Name} box, enter the Internet host name of the server
+In the \q{Host Name} box, enter the Internet host name of the server
you want to connect to. You should have been told this by the
provider of your login account.
-Now select a login protocol to use, from the \e{Protocol} buttons.
+Now select a login protocol to use, from the \q{Protocol} buttons.
For a login session, you should select Telnet, Rlogin or SSH. See
\k{which-one} for a description of the differences between the three
protocols, and advice on which one to use. The fourth protocol,
\e{Raw}, is not used for interactive login sessions; you would
usually use this for debugging other Internet services.
-When you change the selected protocol, the number in the \e{Port}
+When you change the selected protocol, the number in the \q{Port}
box will change. This is normal: it happens because the various
login services are usually provided on different network ports by
the server machine. Most servers will use the standard port numbers,
administrator should have told you which one. (For example, many
MUDs run Telnet service on a port other than 23.)
-Once you have filled in the \e{Host Name}, \e{Protocol}, and
-possibly \e{Port} settings, you are ready to connect. Press the
-\e{Open} button at the bottom of the dialog box, and PuTTY will
+Once you have filled in the \q{Host Name}, \q{Protocol}, and
+possibly \q{Port} settings, you are ready to connect. Press the
+\q{Open} button at the bottom of the dialog box, and PuTTY will
begin trying to connect you to the server.
\H{gs-hostkey} Verifying the Host Key (SSHÂ only)
-\versionid $Id: pageant.but,v 1.4 2001/11/25 16:57:45 simon Exp $
+\versionid $Id: pageant.but,v 1.5 2001/11/25 17:32:39 simon Exp $
\C{pageant} Using Pageant for authentication
hat into the System tray. It will then sit and do nothing.
If you click the Pageant icon with the right mouse button, you will
-see a menu. Select \e{View Keys} from this menu. The Pageant main
+see a menu. Select \q{View Keys} from this menu. The Pageant main
window will appear. (You can also bring this window up by
double-clicking on the Pageant icon.)
Pageant is holding. When you start Pageant, it has no keys, so the
list box will be empty.
-To add a key to Pageant, press the \e{Add Key} button. Pageant will
+To add a key to Pageant, press the \q{Add Key} button. Pageant will
bring up a file dialog, labelled \q{Select Private Key File}. Find
-your private key file in this dialog, and press \e{Open}.
+your private key file in this dialog, and press \q{Open}.
Pageant will now load the private key. If the key is protected by a
passphrase, Pageant will ask you to type the passphrase. When the
passphrase again.
When you want to shut down Pageant, click the right button on the
-Pageant icon in the System tray, and select \e{Exit} from the menu.
+Pageant icon in the System tray, and select \q{Exit} from the menu.
Closing the Pageant main window does \e{not} shut down Pageant.
\H{pageant-forward} Using agent forwarding
-\versionid $Id: plink.but,v 1.10 2001/11/25 16:57:45 simon Exp $
+\versionid $Id: plink.but,v 1.11 2001/11/25 17:32:39 simon Exp $
\C{plink} Using the command-line connection tool Plink
able to connect to a remote host without a password. \k{plink-cvs}
has instructions on this.
-In WinCVS, bring up the \e{Preferences} dialogue box from the
-\e{Admin} menu, and switch to the \e{Ports} tab. Tick the box there
-labelled \e{Check for an alternate rsh name} and in the text entry
+In WinCVS, bring up the \q{Preferences} dialogue box from the
+\e{Admin} menu, and switch to the \q{Ports} tab. Tick the box there
+labelled \q{Check for an alternate rsh name} and in the text entry
field to the right enter the full path to \c{plink.exe}. Select
-\e{OK} on the \e{Preferences} dialogue box.
+\q{OK} on the \q{Preferences} dialogue box.
-Next, select \e{Command Line} from the WinCVS \e{Admin} menu, and type
+Next, select \q{Command Line} from the WinCVS \q{Admin} menu, and type
a CVS command as in \k{plink-cvs}, for example:
\c cvs -d :ext:user@hostname:/path/to/repository co module
-Select the folder you want to check out to with the \e{Change Folder}
-button, and click \e{OK} to check out your module. Once you've got
+Select the folder you want to check out to with the \q{Change Folder}
+button, and click \q{OK} to check out your module. Once you've got
modules checked out, WinCVS will happily invoke plink from the GUI for
CVS operations.
-\versionid $Id: pubkey.but,v 1.9 2001/11/25 17:14:00 simon Exp $
+\versionid $Id: pubkey.but,v 1.10 2001/11/25 17:32:39 simon Exp $
\# FIXME: passphrases, examples (e.g what does a key for pasting into
\# authorized_keys look like?), index entries, links.
RSA keys.
When you run PuTTYgen you will see a window where you have two
-choices: \e{Generate} new public/private key pair or \e{Load} an
-existing private key.
+choices: \q{Generate}, to generate a new public/private key pair, or
+\q{Load} to load in an existing private key.
\S{pubkey-puttygen-generate} Generate a new key
Before generating a new key you have to choose the strength of the
encryption, and the type of the key (see \k{pubkey-types}). With
-\e{Parameters} you define the strength of the key. The default of
+\q{Parameters} you define the strength of the key. The default of
1024 should be OK for most users.
-Pressing the \e{Generate} button starts the process of generating a
+Pressing the \q{Generate} button starts the process of generating a
new key pair. You then have to move the mouse over the blank area in
order to generate random data for the algorithm. Continue until the
progress bar is complete.
As soon as enough random data is available the key is generated. This
may take a little while, especially on slow machines. Once the key is
-generated, its details appear in the \e{Key} part of the PuTTYgen
+generated, its details appear in the \q{Key} part of the PuTTYgen
window.
-Now you can change the \e{Key comment} to something more meaningful
-than the default (which is based on the current date). e.g. add the
-name of the host you will use it for. When using multiple keys a
-meaningful comment may help you remember which passphrase to use! You
-should always enter a \e{Key passphrase} and \e{Confirm passphrase} to
-protect your keys.
+Now you can change the \q{Key comment} field to something more
+meaningful than the default (which is based on the current date).
+e.g. add the name of the host you will use it for. When using
+multiple keys a meaningful comment may help you remember which
+passphrase to use! You should always enter a passphrase in the
+\q{Key passphrase} and \q{Confirm passphrase} fields, to protect
+your keys.
(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
cuts down the possibilities a lot and you should use a longer one as
a result.)
-Finally save the key by pressing the \e{Save} button. Do not close the
+Finally save the key by pressing the \q{Save} button. Do not close the
window but proceed with step \k{pubkey-gettingready}, otherwise you
-will have to \e{Load} the private key again as described below.
+will have to load the private key again (as described below).
\S{pubkey-puttygen-load} Load and modify a key
PuTTYgen does not store the public key in a file by default. If you
-have to distribute the public key you can press the \e{Load} button,
+have to distribute the public key you can press the \q{Load} button,
select the private key file, and PuTTYgen will give you the public key
again. You can also change the comment and passphrase for your
-private key this way. Just modify the values and \e{Save} the key.
+private key this way. Just modify the values and save the key.
\S{pubkey-gettingready} Getting ready for public key authentication
into the \c{.ssh} directory and open the file \c{authorized_keys}
with your favorite 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 \e{Public key for pasting into
+window, select all of the text in the \q{Public key for pasting into
authorized_keys file} box, and copy it to the clipboard
(\c{Ctrl+C}). Then, switch back to the PuTTY window and insert the
data into the open file, making sure it ends up all on one line.
From now on you should be able to use the private key for
authentication to this host. Either select the private key in
-PuTTY's \e{Connection}, \e{SSH} panel: \e{Private key file for
+PuTTY's \q{Connection}, \q{SSH} panel: \q{Private key file for
authentication} dialog or use it with Pageant as described in
\k{pageant}.
~mdw / sgt / putty / commitdiff