1
0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-01-09 17:38:00 +00:00

Tidy up formatting of manpage cross-references.

In most Halibut man pages I write, I have a standard convention of
referring to another man page by wrapping the page name in \cw and the
section number in \e, leaving the parentheses un-marked-up. Apparently
I forgot in this particular collection.
This commit is contained in:
Simon Tatham 2021-08-22 12:19:01 +01:00
parent 2cb38da6e9
commit 22fab78376
9 changed files with 21 additions and 21 deletions

View File

@ -41,7 +41,7 @@ extract their public half.
The agent protocol used by \c{pageant} is compatible with the PuTTY The agent protocol used by \c{pageant} is compatible with the PuTTY
tools and also with other implementations such as OpenSSH's SSH client tools and also with other implementations such as OpenSSH's SSH client
and \e{ssh-agent(1)}. Some \c{pageant} features are implemented with and \cw{ssh-agent}(\e{1}). Some \c{pageant} features are implemented with
protocol extensions, so will only work if \c{pageant} is on both ends. protocol extensions, so will only work if \c{pageant} is on both ends.
To run \c{pageant} as an agent, you must provide an option to tell it To run \c{pageant} as an agent, you must provide an option to tell it
@ -317,15 +317,15 @@ by the SSH agent protocol.
\dt \cw{--askpass} \e{prompt} \dt \cw{--askpass} \e{prompt}
\dd With this option, \c{pageant} acts as an \e{ssh-askpass(1)} \dd With this option, \c{pageant} acts as an \cw{ssh-askpass}(\e{1})
replacement, rather than performing any SSH agent functionality. This replacement, rather than performing any SSH agent functionality. This
may be useful if you prefer Pageant's GUI prompt style, which may be useful if you prefer Pageant's GUI prompt style, which
minimises information leakage about your passphrase length in its minimises information leakage about your passphrase length in its
visual feedback, compared to other \e{ssh-askpass(1)} implementations. visual feedback, compared to other \cw{ssh-askpass}(\e{1}) implementations.
\lcont{ \lcont{
\c{pageant --askpass} implements the standard \e{ssh-askpass(1)} \c{pageant --askpass} implements the standard \cw{ssh-askpass}(\e{1})
interface: it can be passed a prompt to display (as a single argument) interface: it can be passed a prompt to display (as a single argument)
and, if successful, prints the passphrase on standard output and and, if successful, prints the passphrase on standard output and
returns a zero exit status. Typically you would use the environment returns a zero exit status. Typically you would use the environment

View File

@ -59,9 +59,9 @@ to aid in verifying new files released by the PuTTY team.
\dt \cw{-ssh-connection} \dt \cw{-ssh-connection}
\dd Force use of the \q{bare \cw{ssh-connection}} protocol. This is \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, only likely to be useful when connecting to a \cw{psusan}(\e{1})
most likely with an absolute path to a Unix-domain socket in place server, most likely with an absolute path to a Unix-domain socket in
of \e{host}. place of \e{host}.
\dt \cw{\-proxycmd} \e{command} \dt \cw{\-proxycmd} \e{command}

View File

@ -118,9 +118,9 @@ commands such as \q{\c{w}}).
\dt \cw{-ssh-connection} \dt \cw{-ssh-connection}
\dd Force use of the \q{bare \cw{ssh-connection}} protocol. This is \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, only likely to be useful when connecting to a \cw{psusan}(\e{1})
most likely with an absolute path to a Unix-domain socket in place server, most likely with an absolute path to a Unix-domain socket in
of \e{host}. place of \e{host}.
\dt \cw{-ssh} \dt \cw{-ssh}

View File

@ -106,9 +106,9 @@ commands such as \q{\c{w}}).
\dt \cw{-ssh-connection} \dt \cw{-ssh-connection}
\dd Force use of the \q{bare \cw{ssh-connection}} protocol. This is \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, only likely to be useful when connecting to a \cw{psusan}(\e{1})
most likely with an absolute path to a Unix-domain socket in place server, most likely with an absolute path to a Unix-domain socket in
of \e{host}. place of \e{host}.
\dt \cw{-ssh} \dt \cw{-ssh}

View File

@ -18,8 +18,8 @@ IPv4 and IPv6 connections. It does not support requiring
authentication of its clients. authentication of its clients.
\cw{psocks} can be used together with an SSH client such as \cw{psocks} can be used together with an SSH client such as
\cw{putty(1)} to implement a reverse dynamic SSH tunnel. It can also \cw{putty}(\e{1}) to implement a reverse dynamic SSH tunnel. It can
be used for network protocol debugging, as it can record all the also be used for network protocol debugging, as it can record all the
traffic passing through it in various ways. traffic passing through it in various ways.
By default, \cw{psocks} listens to connections from localhost only, By default, \cw{psocks} listens to connections from localhost only,
@ -84,8 +84,8 @@ have the connection's traffic piped into it, similar to \cw{-f}.
\S{psocks-manpage-examples} EXAMPLES \S{psocks-manpage-examples} EXAMPLES
In combination with the \e{plink(1)} SSH client, to set up a reverse In combination with the \cw{plink}(\e{1}) SSH client, to set up a
dynamic SSH tunnel, in which the remote listening port 1080 on reverse dynamic SSH tunnel, in which the remote listening port 1080 on
remote host \cw{myhost} acts as a SOCKS server giving access to your remote host \cw{myhost} acts as a SOCKS server giving access to your
local network: local network:

View File

@ -200,7 +200,7 @@ And the setup script \cw{uml-psusan.sh} might look like this:
Now set up a PuTTY saved session as in the Docker example above. Now set up a PuTTY saved session as in the Docker example above.
Basically you'll want to use the above \cw{linux} command as the local Basically you'll want to use the above \cw{linux} command as the local
proxy command. However, it's worth wrapping it in \c{setsid}(\e{1}), proxy command. However, it's worth wrapping it in \cw{setsid}(\e{1}),
because when UML terminates, it kills its entire process group. So because when UML terminates, it kills its entire process group. So
it's better that PuTTY should not be part of that group, and should it's better that PuTTY should not be part of that group, and should
have the opportunity to shut down cleanly by itself. So probably you have the opportunity to shut down cleanly by itself. So probably you

View File

@ -76,7 +76,7 @@ will be ignored unless the \cw{BoldAsColour} resource is set to 0 or 2.
\dt \cw{\-geometry} \e{geometry} \dt \cw{\-geometry} \e{geometry}
\dd Specify the size of the terminal, in rows and columns of text. See \dd Specify the size of the terminal, in rows and columns of text. See
\e{X(7)} for more information on the syntax of geometry \cw{X}(\e{7}) for more information on the syntax of geometry
specifications. specifications.
\dt \cw{\-sl} \e{lines} \dt \cw{\-sl} \e{lines}

View File

@ -55,7 +55,7 @@ will be ignored unless the \cw{BoldAsColour} resource is set to 0 or 2.
\dt \cw{\-geometry} \e{geometry} \dt \cw{\-geometry} \e{geometry}
\dd Specify the size of the terminal, in rows and columns of text. \dd Specify the size of the terminal, in rows and columns of text.
See \e{X(7)} for more information on the syntax of geometry See \cw{X}(\e{7}) for more information on the syntax of geometry
specifications. specifications.
\dt \cw{\-sl} \e{lines} \dt \cw{\-sl} \e{lines}

View File

@ -56,7 +56,7 @@ will be ignored unless the \cw{BoldAsColour} resource is set to 0 or 2.
\dt \cw{\-geometry} \e{geometry} \dt \cw{\-geometry} \e{geometry}
\dd Specify the size of the terminal, in rows and columns of text. See \dd Specify the size of the terminal, in rows and columns of text. See
\e{X(7)} for more information on the syntax of geometry \cw{X}(\e{7}) for more information on the syntax of geometry
specifications. specifications.
\dt \cw{\-sl} \e{lines} \dt \cw{\-sl} \e{lines}