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 0ba0e845e33e798104aa67a43e902611c24ce789..a46e6a19617d3d5b781cb33831fc54bb0de1b0c0 100644 (file)
--- 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 91dd8ba5214c7704beccb80531a5497f51c5b901..05e5a23cbab2faebb0e381862f16b25ab4e90cd2 100644 (file)
--- 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 12aa81f25750217360fbf89aca57898891fe0c5e..80d86ecf6f3b3148d228e820096fa450caf5e7d8 100644 (file)
--- 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 3abb505f16d17d14b9056c3ab2bc7666d5a6fe61..a3b794059f7a7681b2f99434cb56118ad30002f5 100644 (file)
--- 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 1b28ffdf29983711c84383e0804cc6abddc8df8d..df7b9e1fec116100b2d4bcb7c28d24bf99714b28 100644 (file)
--- 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 bc3ad1e5f2ab9ae39b3c38c39c5e70a5c9af6117..dd8d4f0ccb064ad574c1258b965c529c0f1af78a 100644 (file)
--- 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 126c2ad64d75d0f8a2964e832c314354091b4ffe..dd3beb0c03f97e74ddbb6edb2a583baff139f770 100644 (file)
--- 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 3b22741e2965c153e72f15a603633bb2708ec20f..09309a79f4d47dfe5946353b2bc5ed90efb6d22d 100644 (file)
--- 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 bf55ea73e93b875ebf262edcdad1b913869b3c93..97b5c50bb070c575bf80f87616498d42c4f7c443 100644 (file)
--- 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 c54cc24cad77c843bda233398fb231a48547652c..7c9c42aaa46375581baefea00a83571e1bd60349 100644 (file)
--- 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");