From: Jacob Nevins Date: Sat, 11 Feb 2017 23:03:46 +0000 (+0000) Subject: Document -proxycmd in help and man pages. X-Git-Tag: 0.68~34 X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=commitdiff_plain;h=b14c3443d30a768c718a950ae1e4725ecd7a5cfd;p=PuTTY.git Document -proxycmd in help and man pages. Also, in the main documentation, note the hazard that backslashes in the command argument must be doubled. --- diff --git a/doc/man-pl.but b/doc/man-pl.but index 0ba0e845..a46e6a19 100644 --- a/doc/man-pl.but +++ b/doc/man-pl.but @@ -56,6 +56,27 @@ to aid in verifying new files released by the PuTTY team. \dd Force serial mode. +\dt \cw{\-proxycmd} \e{command} + +\dd Instead of making a TCP connection, use \e{command} as a proxy; +network traffic will be redirected to the standard input and output +of \e{command}. \e{command} must be a single word, so is likely to +need quoting by the shell. + +\lcont{ +The special strings \cw{%host} and \cw{%port} in \e{command} will be +replaced by the hostname and port number you want to connect to; to get +a literal \c{%} sign, enter \c{%%}. + +Backslash escapes are also supported, such as sequences like \c{\\n} +being replaced by a literal newline; to get a literal backslash, +enter \c{\\\\}. (Further escaping may be required by the shell.) + +(See the main PuTTY manual for full details of the supported \cw{%}- +and backslash-delimited tokens, although most of them are probably not +very useful in this context.) +} + \dt \cw{-P} \e{port} \dd Connect to port \e{port}. diff --git a/doc/man-pscp.but b/doc/man-pscp.but index 91dd8ba5..05e5a23c 100644 --- a/doc/man-pscp.but +++ b/doc/man-pscp.but @@ -65,6 +65,27 @@ to aid in verifying new files released by the PuTTY team. \dd Connect to port \e{port}. +\dt \cw{\-proxycmd} \e{command} + +\dd Instead of making a TCP connection, use \e{command} as a proxy; +network traffic will be redirected to the standard input and output +of \e{command}. \e{command} must be a single word, so is likely to +need quoting by the shell. + +\lcont{ +The special strings \cw{%host} and \cw{%port} in \e{command} will be +replaced by the hostname and port number you want to connect to; to get +a literal \c{%} sign, enter \c{%%}. + +Backslash escapes are also supported, such as sequences like \c{\\n} +being replaced by a literal newline; to get a literal backslash, +enter \c{\\\\}. (Further escaping may be required by the shell.) + +(See the main PuTTY manual for full details of the supported \cw{%}- +and backslash-delimited tokens, although most of them are probably not +very useful in this context.) +} + \dt \cw{-l} \e{user} \dd Set remote username to \e{user}. diff --git a/doc/man-psft.but b/doc/man-psft.but index 12aa81f2..80d86ecf 100644 --- a/doc/man-psft.but +++ b/doc/man-psft.but @@ -53,6 +53,27 @@ to aid in verifying new files released by the PuTTY team. \dd Connect to port \e{port}. +\dt \cw{\-proxycmd} \e{command} + +\dd Instead of making a TCP connection, use \e{command} as a proxy; +network traffic will be redirected to the standard input and output +of \e{command}. \e{command} must be a single word, so is likely to +need quoting by the shell. + +\lcont{ +The special strings \cw{%host} and \cw{%port} in \e{command} will be +replaced by the hostname and port number you want to connect to; to get +a literal \c{%} sign, enter \c{%%}. + +Backslash escapes are also supported, such as sequences like \c{\\n} +being replaced by a literal newline; to get a literal backslash, +enter \c{\\\\}. (Further escaping may be required by the shell.) + +(See the main PuTTY manual for full details of the supported \cw{%}- +and backslash-delimited tokens, although most of them are probably not +very useful in this context.) +} + \dt \cw{-l} \e{user} \dd Set remote username to \e{user}. diff --git a/doc/man-ptel.but b/doc/man-ptel.but index 3abb505f..a3b79405 100644 --- a/doc/man-ptel.but +++ b/doc/man-ptel.but @@ -165,6 +165,27 @@ configuration box first. \dd Select the protocol \cw{puttytel} will use to make the connection. +\dt \cw{\-proxycmd} \e{command} + +\dd Instead of making a TCP connection, use \e{command} as a proxy; +network traffic will be redirected to the standard input and output +of \e{command}. \e{command} must be a single word, so is likely to +need quoting by the shell. + +\lcont{ +The special strings \cw{%host} and \cw{%port} in \e{command} will be +replaced by the hostname and port number you want to connect to; to get +a literal \c{%} sign, enter \c{%%}. + +Backslash escapes are also supported, such as sequences like \c{\\n} +being replaced by a literal newline; to get a literal backslash, +enter \c{\\\\}. (Further escaping may be required by the shell.) + +(See the main PuTTY manual for full details of the supported \cw{%}- +and backslash-delimited tokens, although most of them are probably not +very useful in this context.) +} + \dt \cw{\-l} \e{username} \dd Specify the username to use when logging in to the server. diff --git a/doc/man-putt.but b/doc/man-putt.but index 1b28ffdf..df7b9e1f 100644 --- a/doc/man-putt.but +++ b/doc/man-putt.but @@ -178,6 +178,27 @@ configuration box first. \dd Select the protocol \cw{putty} will use to make the connection. +\dt \cw{\-proxycmd} \e{command} + +\dd Instead of making a TCP connection, use \e{command} as a proxy; +network traffic will be redirected to the standard input and output +of \e{command}. \e{command} must be a single word, so is likely to +need quoting by the shell. + +\lcont{ +The special strings \cw{%host} and \cw{%port} in \e{command} will be +replaced by the hostname and port number you want to connect to; to get +a literal \c{%} sign, enter \c{%%}. + +Backslash escapes are also supported, such as sequences like \c{\\n} +being replaced by a literal newline; to get a literal backslash, +enter \c{\\\\}. (Further escaping may be required by the shell.) + +(See the main PuTTY manual for full details of the supported \cw{%}- +and backslash-delimited tokens, although most of them are probably not +very useful in this context.) +} + \dt \cw{\-l} \e{username} \dd Specify the username to use when logging in to the server. diff --git a/doc/using.but b/doc/using.but index bc3ad1e5..dd8d4f0c 100644 --- a/doc/using.but +++ b/doc/using.but @@ -1009,7 +1009,10 @@ on the local machine and using it as a proxy for the network connection. It expects a shell command string as an argument. See \k{config-proxy-type} for more information on this, and on other -proxy settings. +proxy settings. In particular, note that since the special sequences +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-restrict-acl} \i\c{-restrict-acl}: restrict the \i{Windows process ACL} diff --git a/pscp.c b/pscp.c index 126c2ad6..dd3beb0c 100644 --- a/pscp.c +++ b/pscp.c @@ -2244,6 +2244,8 @@ static void usage(void) printf(" -hostkey aa:bb:cc:...\n"); printf(" manually specify a host key (may be repeated)\n"); printf(" -batch disable all interactive prompts\n"); + printf(" -proxycmd command\n"); + printf(" use 'command' as local proxy\n"); printf(" -unsafe allow server-side wildcards (DANGEROUS)\n"); printf(" -sftp force use of SFTP protocol\n"); printf(" -scp force use of SCP protocol\n"); diff --git a/psftp.c b/psftp.c index 3b22741e..09309a79 100644 --- a/psftp.c +++ b/psftp.c @@ -2657,6 +2657,8 @@ static void usage(void) printf(" -hostkey aa:bb:cc:...\n"); printf(" manually specify a host key (may be repeated)\n"); printf(" -batch disable all interactive prompts\n"); + printf(" -proxycmd command\n"); + printf(" use 'command' as local proxy\n"); printf(" -sshlog file\n"); printf(" -sshrawlog file\n"); printf(" log protocol details to a file\n"); diff --git a/unix/uxplink.c b/unix/uxplink.c index bf55ea73..97b5c50b 100644 --- a/unix/uxplink.c +++ b/unix/uxplink.c @@ -558,6 +558,8 @@ static void usage(void) printf(" -P port connect to specified port\n"); printf(" -l user connect with specified username\n"); printf(" -batch disable all interactive prompts\n"); + printf(" -proxycmd command\n"); + printf(" use 'command' as local proxy\n"); printf(" -sercfg configuration-string (e.g. 19200,8,n,1,X)\n"); printf(" Specify the serial configuration (serial only)\n"); printf("The following options only apply to SSH connections:\n"); diff --git a/windows/winplink.c b/windows/winplink.c index c54cc24c..7c9c42aa 100644 --- a/windows/winplink.c +++ b/windows/winplink.c @@ -187,6 +187,8 @@ static void usage(void) printf(" -P port connect to specified port\n"); printf(" -l user connect with specified username\n"); printf(" -batch disable all interactive prompts\n"); + printf(" -proxycmd command\n"); + printf(" use 'command' as local proxy\n"); printf(" -sercfg configuration-string (e.g. 19200,8,n,1,X)\n"); printf(" Specify the serial configuration (serial only)\n"); printf("The following options only apply to SSH connections:\n");