<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=US-ASCII"> <title>PuTTY User Manual</title> <link rel="index" href="IndexPage.html"> <link rel="next" href="Chapter1.html"> </head> <body> <p>Previous | Contents | <a href="IndexPage.html">Index</a> | <a href="Chapter1.html">Next</a></p> <h1>PuTTY User Manual</h1> <p> 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. </p> <p> <em>Note to Unix users:</em> this manual currently primarily documents the Windows versions of the PuTTY utilities. Some options are therefore mentioned that are absent from the <a name="i0"></a>Unix version; the Unix version has features not described here; and the <a name="i1"></a><code>pterm</code> and command-line <code>puttygen</code> utilities are not described at all. The only Unix-specific documentation that currently exists is the <a name="i2"></a>man pages. </p> <p> This manual is copyright 2001-2013 Simon Tatham. All rights reserved. You may distribute this documentation under the MIT licence. See <a href="AppendixC.html#licence">appendix C</a> for the licence text in full. </p> <ul> <li><a href="Chapter1.html#intro">Chapter 1: Introduction to PuTTY</a> <ul> <li><a href="Chapter1.html#you-what">1.1 What are SSH, Telnet and Rlogin?</a></li> <li><a href="Chapter1.html#which-one">1.2 How do SSH, Telnet and Rlogin differ?</a></li> </ul></li> <li><a href="Chapter2.html#gs">Chapter 2: Getting started with PuTTY</a> <ul> <li><a href="Chapter2.html#gs-insecure">2.1 Starting a session</a></li> <li><a href="Chapter2.html#gs-hostkey">2.2 Verifying the host key (SSH only)</a></li> <li><a href="Chapter2.html#gs-login">2.3 Logging in</a></li> <li><a href="Chapter2.html#gs-session">2.4 After logging in</a></li> <li><a href="Chapter2.html#gs-logout">2.5 Logging out</a></li> </ul></li> <li><a href="Chapter3.html#using">Chapter 3: Using PuTTY</a> <ul> <li><a href="Chapter3.html#using-session">3.1 During your session</a></li> <li><a href="Chapter3.html#using-logging">3.2 Creating a log file of your session</a></li> <li><a href="Chapter3.html#using-translation">3.3 Altering your character set configuration</a></li> <li><a href="Chapter3.html#using-x-forwarding">3.4 Using X11 forwarding in SSH</a></li> <li><a href="Chapter3.html#using-port-forwarding">3.5 Using port forwarding in SSH</a></li> <li><a href="Chapter3.html#using-rawprot">3.6 Making raw TCP connections</a></li> <li><a href="Chapter3.html#using-serial">3.7 Connecting to a local serial line</a></li> <li><a href="Chapter3.html#using-cmdline">3.8 The PuTTY command line</a></li> </ul></li> <li><a href="Chapter4.html#config">Chapter 4: Configuring PuTTY</a> <ul> <li><a href="Chapter4.html#config-session">4.1 The Session panel</a></li> <li><a href="Chapter4.html#config-logging">4.2 The Logging panel</a></li> <li><a href="Chapter4.html#config-terminal">4.3 The Terminal panel</a></li> <li><a href="Chapter4.html#config-keyboard">4.4 The Keyboard panel</a></li> <li><a href="Chapter4.html#config-bell">4.5 The Bell panel</a></li> <li><a href="Chapter4.html#config-features">4.6 The Features panel</a></li> <li><a href="Chapter4.html#config-window">4.7 The Window panel</a></li> <li><a href="Chapter4.html#config-appearance">4.8 The Appearance panel</a></li> <li><a href="Chapter4.html#config-behaviour">4.9 The Behaviour panel</a></li> <li><a href="Chapter4.html#config-translation">4.10 The Translation panel</a></li> <li><a href="Chapter4.html#config-selection">4.11 The Selection panel</a></li> <li><a href="Chapter4.html#config-colours">4.12 The Colours panel</a></li> <li><a href="Chapter4.html#config-connection">4.13 The Connection panel</a></li> <li><a href="Chapter4.html#config-data">4.14 The Data panel</a></li> <li><a href="Chapter4.html#config-proxy">4.15 The Proxy panel</a></li> <li><a href="Chapter4.html#config-telnet">4.16 The Telnet panel</a></li> <li><a href="Chapter4.html#config-rlogin">4.17 The Rlogin panel</a></li> <li><a href="Chapter4.html#config-ssh">4.18 The SSH panel</a></li> <li><a href="Chapter4.html#config-ssh-kex">4.19 The Kex panel</a></li> <li><a href="Chapter4.html#config-ssh-auth">4.20 The Auth panel</a></li> <li><a href="Chapter4.html#config-ssh-auth-gssapi">4.21 The GSSAPI panel</a></li> <li><a href="Chapter4.html#config-ssh-tty">4.22 The TTY panel</a></li> <li><a href="Chapter4.html#config-ssh-x11">4.23 The X11 panel</a></li> <li><a href="Chapter4.html#config-ssh-portfwd">4.24 The Tunnels panel</a></li> <li><a href="Chapter4.html#config-ssh-bugs">4.25 The Bugs panel</a></li> <li><a href="Chapter4.html#config-serial">4.26 The Serial panel</a></li> <li><a href="Chapter4.html#config-file">4.27 Storing configuration in a file</a></li> </ul></li> <li><a href="Chapter5.html#pscp">Chapter 5: Using PSCP to transfer files securely</a> <ul> <li><a href="Chapter5.html#pscp-starting">5.1 Starting PSCP</a></li> <li><a href="Chapter5.html#pscp-usage">5.2 PSCP Usage</a></li> </ul></li> <li><a href="Chapter6.html#psftp">Chapter 6: Using PSFTP to transfer files securely</a> <ul> <li><a href="Chapter6.html#psftp-starting">6.1 Starting PSFTP</a></li> <li><a href="Chapter6.html#psftp-commands">6.2 Running PSFTP</a></li> <li><a href="Chapter6.html#psftp-pubkey">6.3 Using public key authentication with PSFTP</a></li> </ul></li> <li><a href="Chapter7.html#plink">Chapter 7: Using the command-line connection tool Plink</a> <ul> <li><a href="Chapter7.html#plink-starting">7.1 Starting Plink</a></li> <li><a href="Chapter7.html#plink-usage">7.2 Using Plink</a></li> <li><a href="Chapter7.html#plink-batch">7.3 Using Plink in batch files and scripts</a></li> <li><a href="Chapter7.html#plink-cvs">7.4 Using Plink with CVS</a></li> <li><a href="Chapter7.html#plink-wincvs">7.5 Using Plink with WinCVS</a></li> </ul></li> <li><a href="Chapter8.html#pubkey">Chapter 8: Using public keys for SSH authentication</a> <ul> <li><a href="Chapter8.html#pubkey-intro">8.1 Public key authentication - an introduction</a></li> <li><a href="Chapter8.html#pubkey-puttygen">8.2 Using PuTTYgen, the PuTTY key generator</a></li> <li><a href="Chapter8.html#pubkey-gettingready">8.3 Getting ready for public key authentication</a></li> </ul></li> <li><a href="Chapter9.html#pageant">Chapter 9: Using Pageant for authentication</a> <ul> <li><a href="Chapter9.html#pageant-start">9.1 Getting started with Pageant</a></li> <li><a href="Chapter9.html#pageant-mainwin">9.2 The Pageant main window</a></li> <li><a href="Chapter9.html#pageant-cmdline">9.3 The Pageant command line</a></li> <li><a href="Chapter9.html#pageant-forward">9.4 Using agent forwarding</a></li> <li><a href="Chapter9.html#pageant-security">9.5 Security considerations</a></li> </ul></li> <li><a href="Chapter10.html#errors">Chapter 10: Common error messages</a> <ul> <li><a href="Chapter10.html#errors-hostkey-absent">10.1 ‘The server's host key is not cached in the registry’</a></li> <li><a href="Chapter10.html#errors-hostkey-wrong">10.2 ‘WARNING - POTENTIAL SECURITY BREACH!’</a></li> <li><a href="Chapter10.html#errors-cipher-warning">10.3 ‘The first cipher supported by the server is ... below the configured warning threshold’</a></li> <li><a href="Chapter10.html#errors-toomanyauth">10.4 ‘Server sent disconnect message type 2 (protocol error): "Too many authentication failures for root"’</a></li> <li><a href="Chapter10.html#errors-memory">10.5 ‘Out of memory’</a></li> <li><a href="Chapter10.html#errors-internal">10.6 ‘Internal error’, ‘Internal fault’, ‘Assertion failed’</a></li> <li><a href="Chapter10.html#errors-cant-load-key">10.7 ‘Unable to use this private key file’, ‘Couldn't load private key’, ‘Key is of wrong type’</a></li> <li><a href="Chapter10.html#errors-refused">10.8 ‘Server refused our public key’ or ‘Key refused’</a></li> <li><a href="Chapter10.html#errors-access-denied">10.9 ‘Access denied’, ‘Authentication refused’</a></li> <li><a href="Chapter10.html#errors-no-auth">10.10 ‘No supported authentication methods available’</a></li> <li><a href="Chapter10.html#errors-crc">10.11 ‘Incorrect CRC received on packet’ or ‘Incorrect MAC received on packet’</a></li> <li><a href="Chapter10.html#errors-garbled">10.12 ‘Incoming packet was garbled on decryption’</a></li> <li><a href="Chapter10.html#errors-x11-proxy">10.13 ‘PuTTY X11 proxy: <em>various errors</em>’</a></li> <li><a href="Chapter10.html#errors-connaborted">10.14 ‘Network error: Software caused connection abort’</a></li> <li><a href="Chapter10.html#errors-connreset">10.15 ‘Network error: Connection reset by peer’</a></li> <li><a href="Chapter10.html#errors-connrefused">10.16 ‘Network error: Connection refused’</a></li> <li><a href="Chapter10.html#errors-conntimedout">10.17 ‘Network error: Connection timed out’</a></li> </ul></li> <li><a href="AppendixA.html#faq">Appendix A: PuTTY FAQ</a> <ul> <li><a href="AppendixA.html#faq-intro">A.1 Introduction</a></li> <li><a href="AppendixA.html#faq-support">A.2 Features supported in PuTTY</a></li> <li><a href="AppendixA.html#faq-ports">A.3 Ports to other operating systems</a></li> <li><a href="AppendixA.html#faq-embedding">A.4 Embedding PuTTY in other programs</a></li> <li><a href="AppendixA.html#faq-details">A.5 Details of PuTTY's operation</a></li> <li><a href="AppendixA.html#faq-howto">A.6 HOWTO questions</a></li> <li><a href="AppendixA.html#faq-trouble">A.7 Troubleshooting</a></li> <li><a href="AppendixA.html#faq-secure">A.8 Security questions</a></li> <li><a href="AppendixA.html#faq-admin">A.9 Administrative questions</a></li> <li><a href="AppendixA.html#faq-misc">A.10 Miscellaneous questions</a></li> </ul></li> <li><a href="AppendixB.html#feedback">Appendix B: Feedback and bug reporting</a> <ul> <li><a href="AppendixB.html#feedback-general">B.1 General guidelines</a></li> <li><a href="AppendixB.html#feedback-bugs">B.2 Reporting bugs</a></li> <li><a href="AppendixB.html#feedback-features">B.3 Requesting extra features</a></li> <li><a href="AppendixB.html#feedback-feature-priority">B.4 Requesting features that have already been requested</a></li> <li><a href="AppendixB.html#feedback-support">B.5 Support requests</a></li> <li><a href="AppendixB.html#feedback-webadmin">B.6 Web server administration</a></li> <li><a href="AppendixB.html#feedback-permission">B.7 Asking permission for things</a></li> <li><a href="AppendixB.html#feedback-mirrors">B.8 Mirroring the PuTTY web site</a></li> <li><a href="AppendixB.html#feedback-compliments">B.9 Praise and compliments</a></li> <li><a href="AppendixB.html#feedback-address">B.10 E-mail address</a></li> </ul></li> <li><a href="AppendixC.html#licence">Appendix C: PuTTY Licence</a></li> <li><a href="AppendixD.html#udp">Appendix D: PuTTY hacking guide</a> <ul> <li><a href="AppendixD.html#udp-portability">D.1 Cross-OS portability</a></li> <li><a href="AppendixD.html#udp-multi-backend">D.2 Multiple backends treated equally</a></li> <li><a href="AppendixD.html#udp-globals">D.3 Multiple sessions per process on some platforms</a></li> <li><a href="AppendixD.html#udp-pure-c">D.4 C, not C++</a></li> <li><a href="AppendixD.html#udp-security">D.5 Security-conscious coding</a></li> <li><a href="AppendixD.html#udp-multi-compiler">D.6 Independence of specific compiler</a></li> <li><a href="AppendixD.html#udp-small">D.7 Small code size</a></li> <li><a href="AppendixD.html#udp-single-threaded">D.8 Single-threaded code</a></li> <li><a href="AppendixD.html#udp-keystrokes">D.9 Keystrokes sent to the server wherever possible</a></li> <li><a href="AppendixD.html#udp-640x480">D.10 640×480 friendliness in configuration panels</a></li> <li><a href="AppendixD.html#udp-makefiles-auto">D.11 Automatically generated <code>Makefile</code>s</a></li> <li><a href="AppendixD.html#udp-ssh-coroutines">D.12 Coroutines in <code>ssh.c</code></a></li> <li><a href="AppendixD.html#udp-compile-once">D.13 Single compilation of each source file</a></li> <li><a href="AppendixD.html#udp-perfection">D.14 Do as we say, not as we do</a></li> </ul></li> <li><a href="AppendixE.html#pgpkeys">Appendix E: PuTTY download keys and signatures</a> <ul> <li><a href="AppendixE.html#pgpkeys-pubkey">E.1 Public keys</a></li> <li><a href="AppendixE.html#pgpkeys-security">E.2 Security details</a></li> </ul></li> <li><a href="AppendixF.html#sshnames">Appendix F: SSH-2 names specified for PuTTY</a> <ul> <li><a href="AppendixF.html#sshnames-channel">F.1 Connection protocol channel request names</a></li> <li><a href="AppendixF.html#sshnames-kex">F.2 Key exchange method names</a></li> <li><a href="AppendixF.html#sshnames-encrypt">F.3 Encryption algorithm names</a></li> </ul></li> <li><a href="IndexPage.html#Index">Index</a></li> </ul> <hr><p>If you want to provide feedback on this manual or on the PuTTY tools themselves, see the <a href="http://www.chiark.greenend.org.uk/~sgtatham/putty/feedback.html">Feedback page</a>.</p><address></address></body> </html>
