From a0a985957f1d979999a6f500291f54a58992180a Mon Sep 17 00:00:00 2001 From: Jacob Nevins Date: Mon, 19 Apr 2021 15:57:13 +0100 Subject: [PATCH] Document -ssh-connection (and -ssh) options. --- doc/man-plink.but | 7 +++++++ doc/man-pscp.but | 13 +++++++++++++ doc/man-psftp.but | 13 +++++++++++++ doc/plink.but | 2 +- doc/pscp.but | 4 +++- pscp.c | 2 ++ psftp.c | 2 ++ unix/uxplink.c | 2 +- windows/winplink.c | 2 +- 9 files changed, 43 insertions(+), 4 deletions(-) diff --git a/doc/man-plink.but b/doc/man-plink.but index e5744890..33386227 100644 --- a/doc/man-plink.but +++ b/doc/man-plink.but @@ -56,6 +56,13 @@ to aid in verifying new files released by the PuTTY team. \dd Force serial mode. +\dt \cw{-ssh-connection} + +\dd Force use of the \q{bare \cw{ssh-connection}} protocol. This is +only likely to be useful when connecting to a \e{psusan(1)} server, +most likely with an absolute path to a Unix-domain socket in place +of \e{host}. + \dt \cw{\-proxycmd} \e{command} \dd Instead of making a TCP connection, use \e{command} as a proxy; diff --git a/doc/man-pscp.but b/doc/man-pscp.but index 857a497e..b62e8cc2 100644 --- a/doc/man-pscp.but +++ b/doc/man-pscp.but @@ -115,6 +115,19 @@ commands such as \q{\c{w}}). \dd Force use of SSH protocol version 2. +\dt \cw{-ssh-connection} + +\dd Force use of the \q{bare \cw{ssh-connection}} protocol. This is +only likely to be useful when connecting to a \e{psusan(1)} server, +most likely with an absolute path to a Unix-domain socket in place +of \e{host}. + +\dt \cw{-ssh} + +\dd Force use of the SSH protocol. (This is usually not needed; it's +only likely to be useful if you need to override some other +configuration of the \q{bare \cw{ssh-connection}} protocol.) + \dt \cw{-4}, \cw{-6} \dd Force use of IPv4 or IPv6 for network connections. diff --git a/doc/man-psftp.but b/doc/man-psftp.but index 5611d290..19f820e3 100644 --- a/doc/man-psftp.but +++ b/doc/man-psftp.but @@ -103,6 +103,19 @@ commands such as \q{\c{w}}). \dd Force use of SSH protocol version 2. +\dt \cw{-ssh-connection} + +\dd Force use of the \q{bare \cw{ssh-connection}} protocol. This is +only likely to be useful when connecting to a \e{psusan(1)} server, +most likely with an absolute path to a Unix-domain socket in place +of \e{host}. + +\dt \cw{-ssh} + +\dd Force use of the SSH protocol. (This is usually not needed; it's +only likely to be useful if you need to override some other +configuration of the \q{bare \cw{ssh-connection}} protocol.) + \dt \cw{-4}, \cw{-6} \dd Force use of IPv4 or IPv6 for network connections. diff --git a/doc/plink.but b/doc/plink.but index 8f486e23..4ca7c91b 100644 --- a/doc/plink.but +++ b/doc/plink.but @@ -71,7 +71,7 @@ use Plink: \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 -1 -2 force use of particular SSH protocol version \c -4 -6 force use of IPv4 or IPv6 \c -C enable compression \c -i key private key file for user authentication diff --git a/doc/pscp.but b/doc/pscp.but index 6243938f..381a5864 100644 --- a/doc/pscp.but +++ b/doc/pscp.but @@ -55,6 +55,8 @@ use PSCP: \c -l user connect with specified username \c -pw passw login with specified password \c -1 -2 force use of particular SSH protocol version +\c -ssh -ssh-connection +\c force use of particular SSH protocol variant \c -4 -6 force use of IPv4 or IPv6 \c -C enable compression \c -i key private key file for user authentication @@ -255,7 +257,7 @@ scripts: using \c{-batch}, if something goes wrong at connection time, the batch job will fail rather than hang. \S2{pscp-usage-options-backend}\i\c{-sftp}, \i\c{-scp} force use of -particular protocol +particular file transfer protocol As mentioned in \k{pscp-usage-basics}, there are two different file transfer protocols in use with SSH. Despite its name, PSCP (like many diff --git a/pscp.c b/pscp.c index dc91b18e..0bfda92d 100644 --- a/pscp.c +++ b/pscp.c @@ -2196,6 +2196,8 @@ static void usage(void) printf(" -l user connect with specified username\n"); printf(" -pw passw login with specified password\n"); printf(" -1 -2 force use of particular SSH protocol version\n"); + printf(" -ssh -ssh-connection\n"); + printf(" force use of particular SSH protocol variant\n"); printf(" -4 -6 force use of IPv4 or IPv6\n"); printf(" -C enable compression\n"); printf(" -i key private key file for user authentication\n"); diff --git a/psftp.c b/psftp.c index 57a56eba..40cb73f5 100644 --- a/psftp.c +++ b/psftp.c @@ -2531,6 +2531,8 @@ static void usage(void) printf(" -P port connect to specified port\n"); printf(" -pw passw login with specified password\n"); printf(" -1 -2 force use of particular SSH protocol version\n"); + printf(" -ssh -ssh-connection\n"); + printf(" force use of particular SSH protocol variant\n"); printf(" -4 -6 force use of IPv4 or IPv6\n"); printf(" -C enable compression\n"); printf(" -i key private key file for user authentication\n"); diff --git a/unix/uxplink.c b/unix/uxplink.c index 443c970b..3e2a9b6b 100644 --- a/unix/uxplink.c +++ b/unix/uxplink.c @@ -521,7 +521,7 @@ static void usage(void) printf(" -X -x enable / disable X11 forwarding\n"); printf(" -A -a enable / disable agent forwarding\n"); printf(" -t -T enable / disable pty allocation\n"); - printf(" -1 -2 force use of particular protocol version\n"); + printf(" -1 -2 force use of particular SSH protocol version\n"); printf(" -4 -6 force use of IPv4 or IPv6\n"); printf(" -C enable compression\n"); printf(" -i key private key file for user authentication\n"); diff --git a/windows/winplink.c b/windows/winplink.c index da6c3de2..9bda0712 100644 --- a/windows/winplink.c +++ b/windows/winplink.c @@ -143,7 +143,7 @@ static void usage(void) printf(" -X -x enable / disable X11 forwarding\n"); printf(" -A -a enable / disable agent forwarding\n"); printf(" -t -T enable / disable pty allocation\n"); - printf(" -1 -2 force use of particular protocol version\n"); + printf(" -1 -2 force use of particular SSH protocol version\n"); printf(" -4 -6 force use of IPv4 or IPv6\n"); printf(" -C enable compression\n"); printf(" -i key private key file for user authentication\n");