X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=blobdiff_plain;f=doc%2Fplink.but;h=553639e6e97cc8bf2d237f84db195491cb5801c1;hb=af1460d6e5044a3344aaacd15c91cfdcb58578e7;hp=36891c0148eb375d366b30feef4411dcb95afab5;hpb=10b8ddaf2edb80669f41be0b4943da1231a6cb61;p=PuTTY.git

diff --git a/doc/plink.but b/doc/plink.but
index 36891c01..553639e6 100644
--- 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,7 +40,7 @@ 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 Plink: command-line connection utility
 \c Release 0.XX
 \c Usage: plink [options] [user@]host [command]
 \c        ("host" can also be a PuTTY saved session name)
@@ -82,6 +80,8 @@ use Plink:
 \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.
 
@@ -232,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