]> asedeno.scripts.mit.edu Git - PuTTY.git/blobdiff - doc/man-putt.but
Document -proxycmd in help and man pages.
[PuTTY.git] / doc / man-putt.but
index 1dc1ab6ea2bba33237f2155cb7dc3a77ec3504f6..df7b9e1fec116100b2d4bcb7c28d24bf99714b28 100644 (file)
@@ -30,6 +30,7 @@ Sorry.)
 \dt \cw{\-fn} \e{font-name}
 
 \dd Specify the font to use for normal text displayed in the terminal.
+For example, \cw{\-fn\_fixed}, \cw{\-fn\_"Monospace\_12"}.
 
 \dt \cw{\-fb} \e{font-name}
 
@@ -37,7 +38,7 @@ Sorry.)
 If the \cw{BoldAsColour} resource is set to 1 (the default), bold
 text will be displayed in different colours instead of a different
 font, so this option will be ignored. If \cw{BoldAsColour} is set to
-0 and you do not specify a bold font, \cw{putty} will overprint the
+0 or 2 and you do not specify a bold font, \cw{putty} will overprint the
 normal font to make it look bolder.
 
 \dt \cw{\-fw} \e{font-name}
@@ -49,7 +50,7 @@ Chinese, Japanese and Korean text) displayed in the terminal.
 
 \dd Specify the font to use for bold double-width characters
 (typically Chinese, Japanese and Korean text). Like \cw{-fb}, this
-will be ignored unless the \cw{BoldAsColour} resource is set to 0.
+will be ignored unless the \cw{BoldAsColour} resource is set to 0 or 2.
 
 \dt \cw{\-geometry} \e{geometry}
 
@@ -73,12 +74,12 @@ terminal.
 \dt \cw{\-bfg} \e{colour}
 
 \dd Specify the foreground colour to use for bold text, if the
-\cw{BoldAsColour} resource is set to 1 (the default).
+\cw{BoldAsColour} resource is set to 1 (the default) or 2.
 
 \dt \cw{\-bbg} \e{colour}
 
 \dd Specify the foreground colour to use for bold reverse-video
-text, if the \cw{BoldAsColour} resource is set to 1 (the default).
+text, if the \cw{BoldAsColour} resource is set to 1 (the default) or 2.
 (This colour is best thought of as the bold version of the
 background colour; so it only appears when text is displayed \e{in}
 the background colour.)
@@ -108,11 +109,24 @@ changed under control of the server.)
 to specify it explicitly if you have changed the default using the
 \cw{ScrollBar} resource.
 
-\dt \cw{\-log} \e{filename}
+\dt \cw{\-log} \e{logfile}, \cw{\-sessionlog} \e{logfile}
 
 \dd This option makes \cw{putty} log all the terminal output to a file
 as well as displaying it in the terminal.
 
+\dt \cw{\-sshlog} \e{logfile}
+
+\dt \cw{\-sshrawlog} \e{logfile}
+
+\dd For SSH connections, these options make \cw{putty} log protocol
+details to a file. (Some of these may be sensitive, although by default
+an effort is made to suppress obvious passwords.)
+
+\lcont{
+\cw{\-sshlog} logs decoded SSH packets and other events (those that
+\cw{\-v} would print). \cw{\-sshrawlog} additionally logs the raw
+encrypted packet data.
+}
 
 \dt \cw{\-cs} \e{charset}
 
@@ -160,10 +174,31 @@ in verifying new files released by the PuTTY team.
 straight from the command line without having to go through the
 configuration box first.
 
-\dt \cw{\-ssh}, \cw{\-telnet}, \cw{\-rlogin}, \cw{\-raw}
+\dt \cw{\-ssh}, \cw{\-telnet}, \cw{\-rlogin}, \cw{\-raw}, \cw{\-serial}
 
 \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.
@@ -217,11 +252,64 @@ pseudo-terminal at the server end.
 
 \dd Select SSH protocol version 1 or 2.
 
+\dt \cw{-4}, \cw{-6}
+
+\dd Force use of IPv4 or IPv6 for network connections.
+
 \dt \cw{\-i} \e{keyfile}
 
-\dd Specify a private key file to use for authentication. For SSH-2
-keys, this key file must be in PuTTY's format, not OpenSSH's or
-anyone else's.
+\dd Private key file for user authentication. For SSH-2 keys, this key
+file must be in PuTTY's PPK format, not OpenSSH's format or anyone
+else's.
+
+\lcont{ If you are using an authentication agent, you can also specify
+a \e{public} key here (in RFC 4716 or OpenSSH format), to identify
+which of the agent's keys to use. }
+
+\dt \cw{\-noagent}
+
+\dd Don't try to use an authentication agent for local authentication.
+(This doesn't affect agent forwarding.)
+
+\dt \cw{\-agent}
+
+\dd Allow use of an authentication agent. (This option is only necessary
+to override a setting in a saved session.)
+
+\dt \cw{\-hostkey} \e{key}
+
+\dd Specify an acceptable host public key. This option may be specified
+multiple times; each key can be either a fingerprint (\cw{99:aa:bb:...}) or
+a base64-encoded blob in OpenSSH's one-line format.
+
+\lcont{ Specifying this option overrides automated host key
+management; \e{only} the key(s) specified on the command-line will be
+accepted (unless a saved session also overrides host keys, in which
+case those will be added to), and the host key cache will not be
+written. }
+
+\dt \cw{\-sercfg} \e{configuration-string}
+
+\dd Specify the configuration parameters for the serial port, in
+\cw{-serial} mode. \e{configuration-string} should be a
+comma-separated list of configuration parameters as follows:
+
+\lcont{
+
+\b Any single digit from 5 to 9 sets the number of data bits.
+
+\b \cq{1}, \cq{1.5} or \cq{2} sets the number of stop bits.
+
+\b Any other numeric string is interpreted as a baud rate.
+
+\b A single lower-case letter specifies the parity: \cq{n} for none,
+\cq{o} for odd, \cq{e} for even, \cq{m} for mark and \cq{s} for space.
+
+\b A single upper-case letter specifies the flow control: \cq{N} for
+none, \cq{X} for XON/XOFF, \cq{R} for RTS/CTS and \cq{D} for
+DSR/DTR.
+
+}
 
 \S{putty-manpage-saved-sessions} SAVED SESSIONS