nhyatt/putty-source
1
0
Fork 0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-05-28 07:14:48 -05:00
Code Issues Projects Releases Wiki Activity

Index the complete PuTTY manual.

Browse Source 
This was a bit rushed, and could doubtless be improved.
Also fix a couple of things I noted on the way, including:
 - "pscp -ls" wasn't documented
 - Windows XP wasn't mentioned enough

[originally from svn r5593]
This commit is contained in:
Jacob Nevins 2005-04-05 18:01:32 +00:00
parent 96e9a65e99
commit 0e82598a35
16 changed files with 1454 additions and 716 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/blurb.but
View File

@ -22,10 +22,11 @@ Plink, Pageant and PuTTYgen.
\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

782
doc/config.but
View File

File diff suppressed because it is too large Load Diff

26
doc/errors.but
View File

@ -1,6 +1,6 @@
\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
@ -30,7 +30,7 @@ asking the machine's administrator.
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.
@ -61,7 +61,7 @@ See \k{gs-hostkey} for more information on host keys.
\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.
@ -74,14 +74,14 @@ this, let us know and we'll move it up our priority list.
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
@ -90,7 +90,7 @@ increasing \c{MaxAuthTries} in \c{sshd_config}. Neither of these is a
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
@ -110,17 +110,17 @@ memory} error.
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
@ -193,7 +193,7 @@ the various strategies we use for camouflaging passwords in transit.
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
@ -286,7 +286,7 @@ For example, you might see it if your SSH server crashes, and
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.
@ -317,7 +317,7 @@ Check that you have correctly entered the host name or IP address of
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

107
doc/faq.but
View File

@ -1,6 +1,6 @@
\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.
@ -27,8 +27,8 @@ else.
\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:
@ -63,7 +63,7 @@ files into PuTTY's format.
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.
@ -99,7 +99,7 @@ like a DOS box?
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.
@ -123,7 +123,7 @@ authentication, which is more flexible and more secure. See
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.
@ -157,7 +157,7 @@ of host key checking: the right key will be accepted and the wrong
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
@ -179,7 +179,7 @@ have time, and we don't have motivation. The code is available if
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.
@ -223,7 +223,7 @@ or any other port of PuTTY, they were mistaken. We don't.
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.
@ -231,11 +231,11 @@ 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;
@ -274,7 +274,7 @@ brought up to release quality.
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}
@ -282,7 +282,7 @@ hard to port it to do so, because of Windows 3.1's vile memory
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,
@ -291,7 +291,7 @@ the last time we tried this it didn't work very well.
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:
@ -354,15 +354,15 @@ This is what CVS for Windows does, for example.
\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
@ -372,7 +372,7 @@ to say something else; \c{vt220} might help if you have trouble.
\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
@ -394,8 +394,8 @@ On Unix, PuTTY stores all of this data in a directory \cw{~/.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
@ -426,12 +426,12 @@ you can type during those sessions. But the PuTTY maintainer team
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}},
@ -450,7 +450,7 @@ Use the command line \c{putty -ssh host.name}. Alternatively, create
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
@ -493,8 +493,8 @@ terminate.
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
@ -555,7 +555,7 @@ workaround by going to the SSH panel and ticking the box labelled
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.
@ -566,7 +566,7 @@ This happens because PSCP was expecting to see data from the server
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)
@ -576,7 +576,7 @@ This is not actually a PuTTY problem. If PSCP fails in this way,
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.
@ -594,8 +594,8 @@ Clicking on \q{ANSI Green} won't turn your session green; it will
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
@ -610,7 +610,7 @@ the
\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
@ -633,9 +633,9 @@ server instead); but it doesn't necessarily mean you've actually run
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.
@ -664,7 +664,7 @@ is a much simpler 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}.)
@ -677,7 +677,7 @@ immediately.
\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
@ -693,10 +693,10 @@ In version 0.54, the behaviour has changed - changes to these
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.
@ -713,7 +713,8 @@ cause a \e{loss} of robustness against network dropouts. See
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
@ -764,8 +765,8 @@ to be empty (see \k{config-answerback}); but writing binary files to
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.
@ -825,7 +826,7 @@ page} on the PuTTY website (also provided as \k{feedback} in the
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
@ -870,12 +871,12 @@ key in the wrong format isn't optimal.
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).
@ -893,7 +894,7 @@ necessary.
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
@ -918,12 +919,12 @@ The reason why this only started to be a problem in 0.54 is because
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
@ -949,7 +950,7 @@ PSFTP:
\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
@ -1002,7 +1003,7 @@ be tampered with, so it would be better to carry PuTTY with you on a
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
@ -1015,7 +1016,7 @@ If PuTTY was installed from the installer package, it will also
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
@ -1191,7 +1192,7 @@ setup.
\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

14
doc/feedback.but
View File

@ -1,6 +1,6 @@
\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
@ -26,7 +26,7 @@ recommend you do so. In particular, support requests
(\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.
@ -119,7 +119,7 @@ will say so.)
\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}
@ -140,7 +140,7 @@ If none of those options solved your problem, and you still need to
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
@ -177,7 +177,7 @@ avoid this problem by telling us exactly what you think it should
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,
@ -277,7 +277,7 @@ high-quality software to the users comes first.)
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
@ -319,7 +319,7 @@ time to answer it.
\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

13
doc/gs.but
View File

@ -7,7 +7,7 @@ interactive login session using PuTTY.
\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.
@ -15,7 +15,7 @@ You don't usually need to change most of the configuration options.
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.
@ -41,7 +41,7 @@ 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} \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.
@ -98,8 +98,8 @@ If you are connecting across a hostile network (such as the
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
@ -131,7 +131,8 @@ password will probably be refused.
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.

710
doc/index.but
View File

@ -1,18 +1,40 @@
\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
@ -27,26 +49,89 @@ from SSH and Telnet
\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
@ -55,6 +140,9 @@ from SSH and Telnet
\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
@ -65,20 +153,31 @@ sessions from command line
\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
@ -115,7 +214,600 @@ saved sessions from
\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

12
doc/intro.but
View File

@ -15,7 +15,7 @@ logging in to a multi-user computer from another computer, over a
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.
@ -33,7 +33,7 @@ you.
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:
@ -42,11 +42,11 @@ 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:
@ -66,8 +66,8 @@ high-security protocol. It uses strong cryptography to protect your
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

4
doc/licence.but
View File

@ -1,8 +1,8 @@
\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,

39
doc/pageant.but
View File

@ -1,20 +1,20 @@
\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
@ -74,9 +74,9 @@ the SSH-2 protocol).
\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.
@ -118,9 +118,10 @@ or to keys you added remotely using agent forwarding (see
\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
@ -142,18 +143,18 @@ line. This program (perhaps a PuTTY, or a WinCVS making use of
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
@ -194,7 +195,7 @@ they're actually stored.
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
@ -207,7 +208,7 @@ available (not just the ones downstream of the place you added it).
\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.
@ -220,7 +221,7 @@ but still less secure than not storing them anywhere at all. This is
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

4
doc/pgpkeys.but
View File

@ -4,7 +4,7 @@
\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
@ -47,7 +47,7 @@ Therefore, we have six public keys in total:
\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}
}

33
doc/plink.but
View File

@ -1,20 +1,20 @@
\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.
@ -26,10 +26,10 @@ type into the console window:
\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
@ -89,8 +89,8 @@ type \c{plink} and then the host name:
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.
@ -132,7 +132,7 @@ in several ways:
\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
@ -162,7 +162,7 @@ connecting to, and that also specifies the username to log in as
(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:
@ -203,7 +203,8 @@ options.
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
@ -215,10 +216,10 @@ This may help Plink's behaviour when it is used in automated
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.)
@ -243,7 +244,7 @@ command line, you can run in a batch file using Plink in this way.
\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

77
doc/pscp.but
View File

@ -2,9 +2,9 @@
\#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})
@ -16,9 +16,9 @@ servers, however.
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
@ -27,10 +27,10 @@ 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
@ -70,7 +70,7 @@ familiar with that.)
\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
@ -79,7 +79,7 @@ user \c{fred} to the file \c{c:\\temp\\example-hosts.txt}, you would type:
\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
@ -89,7 +89,7 @@ type:
\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
@ -102,8 +102,8 @@ requested a file called \cq{*.c}. If this is a wildcard, consider
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
@ -113,14 +113,14 @@ the wildcard matching rules are decided by the server, the client
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
@ -137,12 +137,12 @@ trying to get out of that directory using pathnames including
\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
@ -150,7 +150,7 @@ number, cipher type and username will be used.
\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}
@ -160,7 +160,7 @@ syntax allowed by your UNIX shell (e.g. \c{*}).
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}
@ -190,13 +190,28 @@ describe PSCP's specific command-line options.
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:
@ -210,7 +225,7 @@ that the transfer will be complete, and percentage of the file so far
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
@ -218,7 +233,7 @@ PSCP to descend into any directories you specify, and to copy them and
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
@ -230,22 +245,22 @@ This may help PSCP's behaviour when it is used in automated
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
@ -261,16 +276,16 @@ The \c{-sftp} option forces PSCP to use the SFTP protocol or quit.
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.

94
doc/psftp.but
View File

@ -1,19 +1,19 @@
\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
@ -57,17 +57,17 @@ options. (The ones not supported by PSFTP are clearly marked.)
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
@ -84,7 +84,7 @@ When you run a batch script in this way, PSFTP will abort the script
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
@ -115,7 +115,7 @@ you might see this:
\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.
@ -123,7 +123,8 @@ 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
@ -141,7 +142,7 @@ Once you have started your PSFTP session, you will see a \c{psftp>}
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
@ -149,10 +150,10 @@ command \c{ren oldfilename newfilename} splits up into three words:
\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"
@ -177,7 +178,7 @@ it up into words at all. See \k{psftp-cmd-pling}.)
\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
@ -186,7 +187,7 @@ instance, PSFTP running on Windows might require the use of \c{*.*}
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
@ -258,7 +259,7 @@ If you type \c{help} with a command name - for example, \c{help get}
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
@ -274,7 +275,7 @@ in at the start of the connection).
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
@ -288,7 +289,7 @@ display your current local working directory, type \c{lpwd}.
\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:
@ -303,7 +304,7 @@ specify the local file name after the remote one:
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
@ -316,7 +317,7 @@ from interpreting anything as a switch after it. For example,
\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:
@ -331,7 +332,7 @@ specify the remote file name after the local one:
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
@ -357,7 +358,7 @@ file2.txt})
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
@ -366,7 +367,7 @@ 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
@ -388,7 +389,7 @@ changed in any way; if there have been changes, you may end up with
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}.
@ -410,7 +411,8 @@ The \c{ls} command works exactly the same way as \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.
@ -435,10 +437,12 @@ also be \c{a} (\q{all}) to affect everybody at once.
\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:
@ -451,27 +455,27 @@ adds write permission for the file owner.
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
@ -487,7 +491,7 @@ The \c{rm} command works exactly the same way as \c{del}.
\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
@ -498,7 +502,7 @@ You can specify multiple directories to create at once:
\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
@ -511,7 +515,7 @@ Most SFTP servers will probably refuse to remove a directory if the
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:
@ -534,7 +538,7 @@ directory:
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
@ -550,7 +554,7 @@ the way before downloading an updated version, you might type:
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.

99
doc/pubkey.but
View File

@ -2,7 +2,7 @@
\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
@ -12,13 +12,13 @@ In conventional password authentication, you prove you are who you
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.
@ -36,18 +36,18 @@ There is a problem with this: if your private key is stored
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
@ -56,19 +56,19 @@ shuts down, without ever having stored your decrypted private key on
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
@ -114,11 +114,11 @@ Before generating a key pair using PuTTYgen, you need to select
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
@ -127,9 +127,10 @@ key will be completely useless.
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
@ -190,7 +191,7 @@ take.
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}
@ -225,13 +226,13 @@ To alter the key comment, just type your comment text into the
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}
@ -242,9 +243,10 @@ If you leave the passphrase fields blank, the key will be saved
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
@ -259,7 +261,7 @@ do this (it will probably vary between servers).
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
@ -280,7 +282,7 @@ Press the \q{Save private key} button. PuTTYgen will put up a dialog
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}).
@ -289,9 +291,9 @@ will need to tell PuTTY to use for authentication (see
\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}.)
@ -310,14 +312,14 @@ will contain exactly the same text that appears in the \q{Public key
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
@ -357,22 +359,23 @@ disk. PuTTY uses this format as well; so if you have generated an
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
@ -390,7 +393,7 @@ password to login. Once logged in, you must configure the server to
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
@ -399,15 +402,15 @@ 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. 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

149
doc/using.but
View File

@ -25,7 +25,7 @@ processor or spreadsheet into your terminal session.
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
@ -33,9 +33,10 @@ character down your session to the server where it will probably
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
@ -44,13 +45,13 @@ you may find that the spaces pasted from the clipboard plus the
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
@ -66,10 +67,10 @@ middle mouse button to paste, then the right mouse button does this
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.
@ -78,7 +79,7 @@ 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
@ -90,7 +91,7 @@ By default the last 200 lines scrolled off the top are
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
@ -101,9 +102,9 @@ PuTTY's system menu contains extra program features in addition to
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}
@ -126,7 +127,8 @@ tokens, such as a \i{\q{break} signal}, that can be sent down a
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
@ -173,9 +175,10 @@ PuTTY can also be configured to send this when Ctrl-Z is typed; see
\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.
@ -184,7 +187,7 @@ 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}.
}
@ -257,7 +260,7 @@ the information; the text is not guaranteed not to still be in
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
@ -272,21 +275,21 @@ whole screen and its borders, title bar and scrollbar will
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
@ -303,8 +306,8 @@ the characters sent by the server according to the wrong \e{character
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.)
@ -325,7 +328,7 @@ does do.
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.
@ -348,8 +351,8 @@ point at display 10 or above on the SSH server machine itself:
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}).
@ -357,17 +360,17 @@ For more options relating to X11 forwarding, see \k{config-ssh-x11}.
\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.)
@ -400,15 +403,16 @@ server instead of \c{popserver.example.com:110}. (Of course, the
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
@ -419,9 +423,9 @@ setting up the Proxy control panel (see \k{config-proxy} for
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
@ -432,15 +436,16 @@ your client PC can connect to the forwarded port.
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
@ -498,7 +503,7 @@ To start a connection to a server called \c{host}:
\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}).
@ -544,7 +549,7 @@ need to make PuTTY start a session.
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
@ -604,27 +609,27 @@ As well as setting up port forwardings in the PuTTY configuration
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
@ -634,11 +639,11 @@ For general information on port forwarding, see
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
@ -773,7 +778,7 @@ the PuTTY configuration box (see \k{config-address-family}).
\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
@ -783,8 +788,8 @@ This option is equivalent to the \q{Private key file for
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.