Merge tag '0.66'

[PuTTY.git] / doc / plink.but

diff --git a/doc/plink.but b/doc/plink.but
index 850ac44b984148635b6127f4f55f708c3854330b..889d3b6acf6973c62e35f05883657fd544ebaeaf 100644 (file)
--- a/doc/plink.but
+++ b/doc/plink.but
@@ -1,10 +1,8 @@
-\define{versionidplink} \versionid $Id$
-
 \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 \i{automated operations}, such as
-making CVS access a repository on a remote server.
+\i{Plink} is a command-line connection tool similar to 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
 \i{interactive session} in a console window.
@@ -42,8 +40,8 @@ version of Plink you're using, and gives you a brief summary of how to
 use Plink:
 
 \c Z:\sysosd>plink
-\c PuTTY Link: command-line connection utility
-\c Release 0.XX
+\c Plink: command-line connection utility
+\c Release 0.66
 \c Usage: plink [options] [user@]host [command]
 \c        ("host" can also be a PuTTY saved session name)
 \c Options:
@@ -51,11 +49,13 @@ use Plink:
 \c   -pgpfp    print PGP key fingerprints and exit
 \c   -v        show verbose messages
 \c   -load sessname  Load settings from saved session
-\c   -ssh -telnet -rlogin -raw
+\c   -ssh -telnet -rlogin -raw -serial
 \c             force use of a particular protocol
 \c   -P port   connect to specified port
 \c   -l user   connect with specified username
 \c   -batch    disable all interactive prompts
+\c   -sercfg configuration-string (e.g. 19200,8,n,1,X)
+\c             Specify the serial configuration (serial only)
 \c The following options only apply to SSH connections:
 \c   -pw passw login with specified password
 \c   -D [listen-IP:]listen-port
@@ -70,12 +70,18 @@ use Plink:
 \c   -1 -2     force use of particular protocol version
 \c   -4 -6     force use of IPv4 or IPv6
 \c   -C        enable compression
-\c   -i key    private key file for authentication
+\c   -i key    private key file for user authentication
 \c   -noagent  disable use of Pageant
 \c   -agent    enable use of Pageant
+\c   -hostkey aa:bb:cc:...
+\c             manually specify a host key (may be repeated)
 \c   -m file   read remote command(s) from file
 \c   -s        remote command is an SSH subsystem (SSH-2 only)
 \c   -N        don't start a shell/command (SSH-2 only)
+\c   -nc host:port
+\c             open tunnel in place of session (SSH-2 only)
+\c   -shareexists
+\c             test whether a connection-sharing upstream exists
 
 Once this works, you are ready to use Plink.
 
@@ -226,6 +232,27 @@ line.
 
 (This option is only meaningful with the SSH-2 protocol.)
 
+\S2{plink-option-shareexists} \I{-shareexists-plink}\c{-shareexists}:
+test for connection-sharing upstream
+
+This option does not make a new connection; instead it allows testing
+for the presence of an existing connection that can be shared.
+(See \k{config-ssh-sharing} for more information about SSH connection
+sharing.)
+
+A Plink invocation of the form:
+
+\c plink -shareexists <session>
+\e                    iiiiiiiii
+
+will test whether there is currently a viable \q{upstream} for the
+session in question, which can be specified using any syntax you'd
+normally use with Plink to make an actual connection (a host/port
+number, a bare saved session name, \c{-load}, etc). It returns a
+zero exit status if a usable \q{upstream} exists, nonzero otherwise.
+
+(This option is only meaningful with the SSH-2 protocol.)
+
 \H{plink-batch} Using Plink in \i{batch files} and \i{scripts}
 
 Once you have set up Plink to be able to log in to a remote server