OSDN Git Service

Remove SFTP support to release 1.98f.
[ffftp/ffftp.git] / contrib / putty / DOC / PLINK.BUT
diff --git a/contrib/putty/DOC/PLINK.BUT b/contrib/putty/DOC/PLINK.BUT
deleted file mode 100644 (file)
index bd0104b..0000000
+++ /dev/null
@@ -1,296 +0,0 @@
-\define{versionidplink} \versionid $Id: plink.but 9366 2011-12-10 12:08:09Z simon $\r
-\r
-\C{plink} Using the command-line connection tool \i{Plink}\r
-\r
-\i{Plink} (PuTTY Link) is a command-line connection tool similar to\r
-UNIX \c{ssh}. It is mostly used for \i{automated operations}, such as\r
-making CVS access a repository on a remote server.\r
-\r
-Plink is probably not what you want if you want to run an\r
-\i{interactive session} in a console window.\r
-\r
-\H{plink-starting} Starting Plink\r
-\r
-Plink is a command line application. This means that you cannot just\r
-double-click on its icon to run it and instead you have to bring up\r
-a \i{console window}. In Windows 95, 98, and ME, this is called an\r
-\q{MS-DOS Prompt}, and in Windows NT, 2000, and XP, it is called a\r
-\q{Command Prompt}. It should be available from the Programs section\r
-of your Start Menu.\r
-\r
-In order to use Plink, the file \c{plink.exe} will need either to be\r
-on your \i{\c{PATH}} or in your current directory. To add the\r
-directory containing Plink to your \c{PATH} environment variable,\r
-type into the console window:\r
-\r
-\c set PATH=C:\path\to\putty\directory;%PATH%\r
-\r
-This will only work for the lifetime of that particular console\r
-window.  To set your \c{PATH} more permanently on Windows NT, 2000,\r
-and XP, use the Environment tab of the System Control Panel.  On\r
-Windows 95, 98, and ME, you will need to edit your \i\c{AUTOEXEC.BAT}\r
-to include a \c{set} command like the one above.\r
-\r
-\H{plink-usage} Using Plink\r
-\r
-This section describes the basics of how to use Plink for\r
-interactive logins and for automated processes.\r
-\r
-Once you've got a console window to type into, you can just type\r
-\c{plink} on its own to bring up a usage message.  This tells you the\r
-version of Plink you're using, and gives you a brief summary of how to\r
-use Plink:\r
-\r
-\c Z:\sysosd>plink\r
-\c PuTTY Link: command-line connection utility\r
-\c Release 0.62\r
-\c Usage: plink [options] [user@]host [command]\r
-\c        ("host" can also be a PuTTY saved session name)\r
-\c Options:\r
-\c   -V        print version information and exit\r
-\c   -pgpfp    print PGP key fingerprints and exit\r
-\c   -v        show verbose messages\r
-\c   -load sessname  Load settings from saved session\r
-\c   -ssh -telnet -rlogin -raw -serial\r
-\c             force use of a particular protocol\r
-\c   -P port   connect to specified port\r
-\c   -l user   connect with specified username\r
-\c   -batch    disable all interactive prompts\r
-\c The following options only apply to SSH connections:\r
-\c   -pw passw login with specified password\r
-\c   -D [listen-IP:]listen-port\r
-\c             Dynamic SOCKS-based port forwarding\r
-\c   -L [listen-IP:]listen-port:host:port\r
-\c             Forward local port to remote address\r
-\c   -R [listen-IP:]listen-port:host:port\r
-\c             Forward remote port to local address\r
-\c   -X -x     enable / disable X11 forwarding\r
-\c   -A -a     enable / disable agent forwarding\r
-\c   -t -T     enable / disable pty allocation\r
-\c   -1 -2     force use of particular protocol version\r
-\c   -4 -6     force use of IPv4 or IPv6\r
-\c   -C        enable compression\r
-\c   -i key    private key file for authentication\r
-\c   -noagent  disable use of Pageant\r
-\c   -agent    enable use of Pageant\r
-\c   -m file   read remote command(s) from file\r
-\c   -s        remote command is an SSH subsystem (SSH-2 only)\r
-\c   -N        don't start a shell/command (SSH-2 only)\r
-\c   -nc host:port\r
-\c             open tunnel in place of session (SSH-2 only)\r
-\c   -sercfg configuration-string (e.g. 19200,8,n,1,X)\r
-\c             Specify the serial configuration (serial only)\r
-\r
-Once this works, you are ready to use Plink.\r
-\r
-\S{plink-usage-interactive} Using Plink for interactive logins\r
-\r
-To make a simple interactive connection to a remote server, just\r
-type \c{plink} and then the host name:\r
-\r
-\c Z:\sysosd>plink login.example.com\r
-\c\r
-\c Debian GNU/Linux 2.2 flunky.example.com\r
-\c flunky login:\r
-\r
-You should then be able to log in as normal and run a session. The\r
-output sent by the server will be written straight to your command\r
-prompt window, which will most likely not interpret terminal \i{control\r
-codes} in the way the server expects it to. So if you run any\r
-full-screen applications, for example, you can expect to see strange\r
-characters appearing in your window. Interactive connections like\r
-this are not the main point of Plink.\r
-\r
-In order to connect with a different protocol, you can give the\r
-command line options \c{-ssh}, \c{-telnet}, \c{-rlogin} or \c{-raw}.\r
-To make an SSH connection, for example:\r
-\r
-\c Z:\sysosd>plink -ssh login.example.com\r
-\c login as:\r
-\r
-If you have already set up a PuTTY saved session, then instead of\r
-supplying a host name, you can give the saved session name. This\r
-allows you to use public-key authentication, specify a user name,\r
-and use most of the other features of PuTTY:\r
-\r
-\c Z:\sysosd>plink my-ssh-session\r
-\c Sent username "fred"\r
-\c Authenticating with public key "fred@winbox"\r
-\c Last login: Thu Dec  6 19:25:33 2001 from :0.0\r
-\c fred@flunky:~$\r
-\r
-(You can also use the \c{-load} command-line option to load a saved\r
-session; see \k{using-cmdline-load}. If you use \c{-load}, the saved\r
-session exists, and it specifies a hostname, you cannot also specify a\r
-\c{host} or \c{user@host} argument - it will be treated as part of the\r
-remote command.)\r
-\r
-\S{plink-usage-batch} Using Plink for automated connections\r
-\r
-More typically Plink is used with the SSH protocol, to enable you to\r
-talk directly to a program running on the server. To do this you\r
-have to ensure Plink is \e{using} the SSH protocol. You can do this\r
-in several ways:\r
-\r
-\b Use the \c{-ssh} option as described in\r
-\k{plink-usage-interactive}.\r
-\r
-\b Set up a PuTTY saved session that describes the server you are\r
-connecting to, and that also specifies the protocol as SSH.\r
-\r
-\b Set the Windows environment variable \i\c{PLINK_PROTOCOL} to the\r
-word \c{ssh}.\r
-\r
-Usually Plink is not invoked directly by a user, but run\r
-automatically by another process. Therefore you typically do not\r
-want Plink to prompt you for a user name or a password.\r
-\r
-Next, you are likely to need to avoid the various interactive\r
-prompts Plink can produce. You might be prompted to verify the host\r
-key of the server you're connecting to, to enter a user name, or to\r
-enter a password.\r
-\r
-To avoid being prompted for the server host key when using Plink for\r
-an automated connection, you should first make a \e{manual}\r
-connection (using either of PuTTY or Plink) to the same server,\r
-verify the host key (see \k{gs-hostkey} for more information), and\r
-select Yes to add the host key to the Registry. After that, Plink\r
-commands connecting to that server should not give a host key prompt\r
-unless the host key changes.\r
-\r
-To avoid being prompted for a user name, you can:\r
-\r
-\b Use the \c{-l} option to specify a user name on the command line.\r
-For example, \c{plink login.example.com -l fred}.\r
-\r
-\b Set up a PuTTY saved session that describes the server you are\r
-connecting to, and that also specifies the username to log in as\r
-(see \k{config-username}).\r
-\r
-To avoid being prompted for a password, you should almost certainly\r
-set up \i{public-key authentication}. (See \k{pubkey} for a general\r
-introduction to public-key authentication.) Again, you can do this\r
-in two ways:\r
-\r
-\b Set up a PuTTY saved session that describes the server you are\r
-connecting to, and that also specifies a private key file (see\r
-\k{config-ssh-privkey}). For this to work without prompting, your\r
-private key will need to have no passphrase.\r
-\r
-\b Store the private key in Pageant. See \k{pageant} for further\r
-information.\r
-\r
-Once you have done all this, you should be able to run a remote\r
-command on the SSH server machine and have it execute automatically\r
-with no prompting:\r
-\r
-\c Z:\sysosd>plink login.example.com -l fred echo hello, world\r
-\c hello, world\r
-\c\r
-\c Z:\sysosd>\r
-\r
-Or, if you have set up a saved session with all the connection\r
-details:\r
-\r
-\c Z:\sysosd>plink mysession echo hello, world\r
-\c hello, world\r
-\c\r
-\c Z:\sysosd>\r
-\r
-Then you can set up other programs to run this Plink command and\r
-talk to it as if it were a process on the server machine.\r
-\r
-\S{plink-options} Plink command line options\r
-\r
-Plink accepts all the general command line options supported by the\r
-PuTTY tools. See \k{using-general-opts} for a description of these\r
-options.\r
-\r
-Plink also supports some of its own options. The following sections\r
-describe Plink's specific command-line options.\r
-\r
-\S2{plink-option-batch} \I{-batch-plink}\c{-batch}: disable all\r
-interactive prompts\r
-\r
-If you use the \c{-batch} option, Plink will never give an\r
-interactive prompt while establishing the connection. If the\r
-server's host key is invalid, for example (see \k{gs-hostkey}), then\r
-the connection will simply be abandoned instead of asking you what\r
-to do next.\r
-\r
-This may help Plink's behaviour when it is used in automated\r
-scripts: using \c{-batch}, if something goes wrong at connection\r
-time, the batch job will fail rather than hang.\r
-\r
-\S2{plink-option-s} \I{-s-plink}\c{-s}: remote command is SSH subsystem\r
-\r
-If you specify the \c{-s} option, Plink passes the specified command\r
-as the name of an SSH \q{\i{subsystem}} rather than an ordinary command\r
-line.\r
-\r
-(This option is only meaningful with the SSH-2 protocol.)\r
-\r
-\H{plink-batch} Using Plink in \i{batch files} and \i{scripts}\r
-\r
-Once you have set up Plink to be able to log in to a remote server\r
-without any interactive prompting (see \k{plink-usage-batch}), you\r
-can use it for lots of scripting and batch purposes. For example, to\r
-start a backup on a remote machine, you might use a command like:\r
-\r
-\c plink root@myserver /etc/backups/do-backup.sh\r
-\r
-Or perhaps you want to fetch all system log lines relating to a\r
-particular web area:\r
-\r
-\c plink mysession grep /~fred/ /var/log/httpd/access.log > fredlog\r
-\r
-Any non-interactive command you could usefully run on the server\r
-command line, you can run in a batch file using Plink in this way.\r
-\r
-\H{plink-cvs} Using Plink with \i{CVS}\r
-\r
-To use Plink with CVS, you need to set the environment variable\r
-\i\c{CVS_RSH} to point to Plink:\r
-\r
-\c set CVS_RSH=\path\to\plink.exe\r
-\r
-You also need to arrange to be able to connect to a remote host\r
-without any interactive prompts, as described in\r
-\k{plink-usage-batch}.\r
-\r
-You should then be able to run CVS as follows:\r
-\r
-\c cvs -d :ext:user@sessionname:/path/to/repository co module\r
-\r
-If you specified a username in your saved session, you don't even\r
-need to specify the \q{user} part of this, and you can just say:\r
-\r
-\c cvs -d :ext:sessionname:/path/to/repository co module\r
-\r
-\H{plink-wincvs} Using Plink with \i{WinCVS}\r
-\r
-Plink can also be used with WinCVS.  Firstly, arrange for Plink to be\r
-able to connect to a remote host non-interactively, as described in\r
-\k{plink-usage-batch}.\r
-\r
-Then, in WinCVS, bring up the \q{Preferences} dialogue box from the\r
-\e{Admin} menu, and switch to the \q{Ports} tab. Tick the box there\r
-labelled \q{Check for an alternate \cw{rsh} name} and in the text\r
-entry field to the right enter the full path to \c{plink.exe}.\r
-Select \q{OK} on the \q{Preferences} dialogue box.\r
-\r
-Next, select \q{Command Line} from the WinCVS \q{Admin} menu, and type \r
-a CVS command as in \k{plink-cvs}, for example:\r
-\r
-\c cvs -d :ext:user@hostname:/path/to/repository co module\r
-\r
-or (if you're using a saved session):\r
-\r
-\c cvs -d :ext:user@sessionname:/path/to/repository co module\r
-\r
-Select the folder you want to check out to with the \q{Change Folder}\r
-button, and click \q{OK} to check out your module.  Once you've got\r
-modules checked out, WinCVS will happily invoke plink from the GUI for\r
-CVS operations.\r
-\r
-\# \H{plink-whatelse} Using Plink with... ?\r