Previous | Contents | Index | Next

PuTTY User Manual

PuTTY is a free (MIT-licensed) Win32 Telnet and SSH client. This manual documents PuTTY, and its companion utilities PSCP, PSFTP, Plink, Pageant and PuTTYgen.

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 pterm and command-line puttygen utilities are not described at all. The only Unix-specific documentation that currently exists is the man pages.

This manual is copyright 2001-2004 Simon Tatham. All rights reserved. You may distribute this documentation under the MIT licence. See appendix C for the licence text in full.

• Chapter 1: Introduction to PuTTY
• 1.1 What are SSH, Telnet and Rlogin?
• 1.2 How do SSH, Telnet and Rlogin differ?
• Chapter 2: Getting started with PuTTY
• 2.1 Starting a session
• 2.2 Verifying the host key (SSH only)
• 2.3 Logging in
• 2.4 After logging in
• 2.5 Logging out
• Chapter 3: Using PuTTY
• 3.1 During your session
• 3.2 Creating a log file of your session
• 3.3 Altering your character set configuration
• 3.4 Using X11 forwarding in SSH
• 3.5 Using port forwarding in SSH
• 3.6 Making raw TCP connections
• 3.7 The PuTTY command line
• Chapter 4: Configuring PuTTY
• 4.1 The Session panel
• 4.2 The Logging panel
• 4.3 The Terminal panel
• 4.4 The Keyboard panel
• 4.5 The Bell panel
• 4.6 The Features panel
• 4.7 The Window panel
• 4.8 The Appearance panel
• 4.9 The Behaviour panel
• 4.10 The Translation panel
• 4.11 The Selection panel
• 4.12 The Colours panel
• 4.13 The Connection panel
• 4.14 The Proxy panel
• 4.15 The Telnet panel
• 4.16 The Rlogin panel
• 4.17 The SSH panel
• 4.18 The Auth panel
• 4.19 The Tunnels panel
• 4.20 The Bugs panel
• 4.21 Storing configuration in a file
• Chapter 5: Using PSCP to transfer files securely
• 5.1 Starting PSCP
• 5.2 PSCP Usage
• Chapter 6: Using PSFTP to transfer files securely
• 6.1 Starting PSFTP
• 6.2 Running PSFTP
• 6.3 Using public key authentication with PSFTP
• Chapter 7: Using the command-line connection tool Plink
• 7.1 Starting Plink
• 7.2 Using Plink
• 7.3 Using Plink in batch files and scripts
• 7.4 Using Plink with CVS
• 7.5 Using Plink with WinCVS
• Chapter 8: Using public keys for SSH authentication
• 8.1 Public key authentication - an introduction
• 8.2 Using PuTTYgen, the PuTTY key generator
• 8.3 Getting ready for public key authentication
• Chapter 9: Using Pageant for authentication
• 9.1 Getting started with Pageant
• 9.2 The Pageant main window
• 9.3 The Pageant command line
• 9.4 Using agent forwarding
• 9.5 Security considerations
• Chapter 10: Common error messages
• 10.1 ‘The server's host key is not cached in the registry’
• 10.2 ‘WARNING - POTENTIAL SECURITY BREACH!’
• 10.3 ‘Out of space for port forwardings’
• 10.4 ‘The first cipher supported by the server is ... below the configured warning threshold’
• 10.5 ‘Server sent disconnect message type 2 (SSH_DISCONNECT_PROTOCOL_ERROR): "Too many authentication failures for root"’
• 10.6 ‘Out of memory’
• 10.7 ‘Internal error’, ‘Internal fault’, ‘Assertion failed’
• 10.8 ‘Unable to use this private key file’, ‘Couldn't load private key’, ‘Key is of wrong type’
• 10.9 ‘Server refused our public key’ or ‘Key refused’
• 10.10 ‘Access denied’, ‘Authentication refused’
• 10.11 ‘Incorrect CRC received on packet’ or ‘Incorrect MAC received on packet’
• 10.12 ‘Incoming packet was garbled on decryption’
• 10.13 ‘PuTTY X11 proxy: various errors’
• 10.14 ‘Network error: Software caused connection abort’
• 10.15 ‘Network error: Connection reset by peer’
• 10.16 ‘Network error: Connection refused’
• 10.17 ‘Network error: Connection timed out’
• Appendix A: PuTTY FAQ
• A.1 Introduction
• A.2 Features supported in PuTTY
• A.3 Ports to other operating systems
• A.4 Embedding PuTTY in other programs
• A.5 Details of PuTTY's operation
• A.6 HOWTO questions
• A.7 Troubleshooting
• A.8 Security questions
• A.9 Administrative questions
• A.10 Miscellaneous questions
• Appendix B: Feedback and bug reporting
• B.1 General guidelines
• B.2 Reporting bugs
• B.3 Requesting extra features
• B.4 Requesting features that have already been requested
• B.5 Support requests
• B.6 Web server administration
• B.7 Asking permission for things
• B.8 Mirroring the PuTTY web site
• B.9 Praise and compliments
• B.10 E-mail address
• Appendix C: PuTTY Licence
• Index

If you want to provide feedback on this manual or on the PuTTY tools themselves, see the Feedback page.