Document -proxycmd in help and man pages.

[PuTTY.git] / doc / man-putt.but

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.