BUG_SSH2_DERIVEKEY is apparently only present in SSH 2.0.11 and

[u/mdw/putty] / doc / plink.but

diff --git a/doc/plink.but b/doc/plink.but
index a504639..6cc461e 100644 (file)
--- a/doc/plink.but
+++ b/doc/plink.but
@@ -1,4 +1,4 @@
-\versionid $Id: plink.but,v 1.12 2001/12/06 20:05:39 simon Exp $
+\versionid $Id: plink.but,v 1.17 2002/09/11 17:30:36 jacob Exp $

 
 \C{plink} Using the command-line connection tool Plink
 
 
 \C{plink} Using the command-line connection tool Plink
 


@@ -43,13 +43,28 @@ use Plink:
 
 \c Z:\sysosd>plink
 \c PuTTY Link: command-line connection utility
 
 \c Z:\sysosd>plink
 \c PuTTY Link: command-line connection utility

-\c Release 0.50
+\c Release 0.53

 \c Usage: plink [options] [user@]host [command]
 \c Usage: plink [options] [user@]host [command]

+\c        ("host" can also be a PuTTY saved session name)

 \c Options:
 \c   -v        show verbose messages
 \c Options:
 \c   -v        show verbose messages

-\c   -ssh      force use of ssh protocol
+\c   -load sessname  Load settings from saved session
+\c   -ssh -telnet -rlogin -raw
+\c             force use of a particular protocol (default SSH)

 \c   -P port   connect to specified port
 \c   -P port   connect to specified port

+\c   -l user   connect with specified username
+\c   -m file   read remote command(s) from file
+\c   -batch    disable all interactive prompts
+\c The following options only apply to SSH connections:

 \c   -pw passw login with specified password
 \c   -pw passw login with specified password

+\c   -L listen-port:host:port   Forward local port to remote address
+\c   -R listen-port:host:port   Forward remote port to local address
+\c   -X -x     enable / disable X11 forwarding
+\c   -A -a     enable / disable agent forwarding
+\c   -t -T     enable / disable pty allocation
+\c   -1 -2     force use of particular protocol version
+\c   -C        enable compression
+\c   -i key    private key file for authentication

 
 Once this works, you are ready to use Plink.
 
 
 Once this works, you are ready to use Plink.
 


@@ -151,95 +166,22 @@ details:
 Then you can set up other programs to run this Plink command and
 talk to it as if it were a process on the server machine.
 
 Then you can set up other programs to run this Plink command and
 talk to it as if it were a process on the server machine.
 

-\S{plink-usage-options} Options
+\S{plink-options} Plink command line options

 
 

-This section describes the command line options that Plink accepts.
+Plink accepts all the general command line options supported by the
+PuTTY tools. See \k{using-general-opts} for a description of these
+options.

 
 

-\S2{plink-usage-options-v}\c{-v} show verbose messages
+In addition to this, Plink accepts one other option: the \c{-batch}
+option. If you use the \c{-batch} option, Plink will never give an
+interactive prompt while establishing the connection. If the
+server's host key is invalid, for example (see \k{gs-hostkey}), then
+the connection will simply be abandoned instead of asking you what
+to do next.

 
 

-By default, Plink only displays any password prompts and the output of
-the remote command.  The \c{-v} option makes it print extra
-information about the connection being made, for example:
-
-\c Server version: SSH-1.5-OpenSSH-1.2.3
-\c We claim version: SSH-1.5-PuTTY
-\c Using SSH protocol version 1
-\c Received public keys
-\c Host key fingerprint is:
-\c       1023 e3:65:44:44:bd:b1:04:59:bc:e2:3d:a1:4d:09:ce:99
-\c Encrypted session key
-\c Using 3DES encryption
-\c Trying to enable encryption...
-\c Successfully started encryption
-\c Sent username "fred".
-\c Sent username "fred"
-\c fred@example.com's password:
-
-This information can be useful for diagnosing problems.
-
-\S2{plink-usage-options-ssh} Protocol selection options
-
-Plink is most useful when using the SSH protocol. However, it allows
-you to interface to all the protocols supported by PuTTY. You can
-specify the option \c{-ssh} on the command line to select the SSH
-protocol; you can also specify \c{-telnet}, \c{-rlogin} or \c{-raw}
-to select other protocols.
-
-\S2{plink-usage-options-P}\c{-P port} connect to specified port
-
-If your server machine is running its SSH service on a port other
-than the standard one, you can specify an alternative port number to
-connect to using the \c{-P} option, like this:
-
-\c plink -ssh login.example.com -P 5022
-
-\S2{plink-usage-options-pw}\c{-pw passw} login with specified password
-
-A simple way to automate a remote login is to supply your password
-on the Plink command line. This is \e{not recommended} for reasons
-of security. If you possibly can, we recommend you set up public-key
-authentication instead. See \k{pubkey} for details.
-
-\S2{plink-usage-options-user}\c{-l username} login with specified
-username
-
-As described in \k{plink-usage-batch}, you can specify the user name
-to log in as on the remote server using the \c{-l} option. For
-example, \c{plink login.example.com -l fred}.
-
-\S2{plink-usage-options-cmdfile} \c{-m filename} read command from a
-file
-
-If the command you want to run on the remote server is particularly
-large, you can read it from a file using the \c{-m} option, instead
-of putting it directly on Plink's command line. On most Unix
-systems, you can even put multiple lines in this file and execute
-more than one command in sequence, or a whole shell script.
-
-\S2{plink-usage-options-portfwd} \c{-L} and \c{-R} set up port
-forwarding
-
-Plink allows you to use port forwarding just as PuTTY does; if you
-have set up a PuTTY saved session that specifies port forwardings,
-and you connect to that session using Plink, then the same port
-forwardings will be set up.
-
-For convenience, Plink also offers the option to set up port
-forwarding on the 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:
-
-\c plink mysession -L 5110:popserver.example.com:110
-
-And to forward a remote port to a local destination, just use the
-\c{-R} option instead of \c{-L}:
-
-\c plink mysession -R 5023:mytelnetserver.myhouse.org:23
-
-For general information on port forwarding, see
-\k{using-port-forwarding}.
+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.

 
 \H{plink-batch} Using Plink in \i{batch files} and \i{scripts}
 
 
 \H{plink-batch} Using Plink in \i{batch files} and \i{scripts}
 


@@ -295,6 +237,10 @@ a CVS command as in \k{plink-cvs}, for example:
 
 \c cvs -d :ext:user@hostname:/path/to/repository co module
 
 
 \c cvs -d :ext:user@hostname:/path/to/repository co module
 

+or (if you're using a saved session):
+
+\c cvs -d :ext:user@sessionname:/path/to/repository co module
+

 Select the folder you want to check out to with the \q{Change Folder}
 button, and click \q{OK} to check out your module.  Once you've got
 modules checked out, WinCVS will happily invoke plink from the GUI for
 Select the folder you want to check out to with the \q{Change Folder}
 button, and click \q{OK} to check out your module.  Once you've got
 modules checked out, WinCVS will happily invoke plink from the GUI for