nhyatt/putty-source
1
0
Fork 0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-04-01 19:20:13 -05:00
Code Issues Projects Releases Wiki Activity

Docs: improve -share/-noshare docs.

Browse Source 
These options apply to many PuTTY tools, not just Plink; the indexing
was wonky; and -noshare wasn't documented at all.
This commit is contained in:
Jacob Nevins 2025-02-11 20:38:49 +00:00
parent 267f077fcc
commit ee72268b8f
3 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/index.but
View File

@ -262,6 +262,8 @@ saved sessions from
\IM{-i} \c{-i} command-line option
\IM{-pgpfp} \c{-pgpfp} command-line option
\IM{-sercfg} \c{-sercfg} command-line option
\IM{\-share} \c{\-share} command-line option
\IM{\-noshare} \c{\-noshare} command-line option
\IM{removing registry entries} removing registry entries
\IM{removing registry entries} registry entries, removing

22
doc/plink.but
View File

@ -255,28 +255,6 @@ line.
(This option is only meaningful with the SSH-2 protocol.)
\S2{plink-option-share} \I{-share-plink}\c{-share}:
Test and try to share an existing connection.
This option tries to detect if an existing connection can be shared
(See \k{config-ssh-sharing} for more information about SSH connection
sharing.) and reuses that connection.
A Plink invocation of the form:
\c plink -share <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). If no \q{upstream}
viable session is found and \c{-share} is specified, this connection
will be become the \q{upstream} connection for subsequent connection
sharing tries.
(This option is only meaningful with the SSH-2 protocol.)
\S2{plink-option-shareexists} \I{-shareexists-plink}\c{-shareexists}:
test for connection-sharing upstream

20
doc/using.but
View File

@ -1137,6 +1137,26 @@ described there are understood in the argument string, literal
backslashes must be doubled (if you want \c{\\} in your command, you
must put \c{\\\\} on the command line).
\S2{using-cmdline-share-noshare} \i\c{\-share}, \i\c{\-noshare}:
enable/disable connection sharing
These options control whether SSH connection sharing is attempted.
See \k{config-ssh-sharing} for more information about SSH connection
sharing. These options are equivalent to the \q{Share SSH connections
if possible} checkbox in the GUI configuration.
With \c{\-share}, a PuTTY tool will check to see if there's an
existing \q{upstream} for this host. If there is, then the new session
will connect via that upstream. If there isn't, the new session will
\e{become} an upstream for future connections (unless \c{\-share}
has been given as an option to the file transfer tools, PSCP and PSFTP,
which never act as upstreams).
With \c{\-noshare}, this connection will not participate in connection
sharing (either as an upstream or a downstream).
(This option is only meaningful with the SSH-2 protocol.)
\S2{using-cmdline-restrict-acl} \i\c{-restrict-acl}: restrict the
\i{Windows process ACL}