From 22fab7837660fe2cf6ee08b10bd6696cc2653024 Mon Sep 17 00:00:00 2001 From: Simon Tatham Date: Sun, 22 Aug 2021 12:19:01 +0100 Subject: [PATCH] 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. --- doc/man-pageant.but | 8 ++++---- doc/man-plink.but | 6 +++--- doc/man-pscp.but | 6 +++--- doc/man-psftp.but | 6 +++--- doc/man-psocks.but | 8 ++++---- doc/man-psusan.but | 2 +- doc/man-pterm.but | 2 +- doc/man-putty.but | 2 +- doc/man-puttytel.but | 2 +- 9 files changed, 21 insertions(+), 21 deletions(-) diff --git a/doc/man-pageant.but b/doc/man-pageant.but index 358f3a08..3f407a47 100644 --- a/doc/man-pageant.but +++ b/doc/man-pageant.but @@ -41,7 +41,7 @@ extract their public half. The agent protocol used by \c{pageant} is compatible with the PuTTY 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. 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} -\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 may be useful if you prefer Pageant's GUI prompt style, which 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{ -\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) and, if successful, prints the passphrase on standard output and returns a zero exit status. Typically you would use the environment diff --git a/doc/man-plink.but b/doc/man-plink.but index 26e65f71..ea555abf 100644 --- a/doc/man-plink.but +++ b/doc/man-plink.but @@ -59,9 +59,9 @@ to aid in verifying new files released by the PuTTY team. \dt \cw{-ssh-connection} \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, -most likely with an absolute path to a Unix-domain socket in place -of \e{host}. +only likely to be useful when connecting to a \cw{psusan}(\e{1}) +server, most likely with an absolute path to a Unix-domain socket in +place of \e{host}. \dt \cw{\-proxycmd} \e{command} diff --git a/doc/man-pscp.but b/doc/man-pscp.but index 60ce4f5e..402b9eef 100644 --- a/doc/man-pscp.but +++ b/doc/man-pscp.but @@ -118,9 +118,9 @@ commands such as \q{\c{w}}). \dt \cw{-ssh-connection} \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, -most likely with an absolute path to a Unix-domain socket in place -of \e{host}. +only likely to be useful when connecting to a \cw{psusan}(\e{1}) +server, most likely with an absolute path to a Unix-domain socket in +place of \e{host}. \dt \cw{-ssh} diff --git a/doc/man-psftp.but b/doc/man-psftp.but index 52617291..4e92e48b 100644 --- a/doc/man-psftp.but +++ b/doc/man-psftp.but @@ -106,9 +106,9 @@ commands such as \q{\c{w}}). \dt \cw{-ssh-connection} \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, -most likely with an absolute path to a Unix-domain socket in place -of \e{host}. +only likely to be useful when connecting to a \cw{psusan}(\e{1}) +server, most likely with an absolute path to a Unix-domain socket in +place of \e{host}. \dt \cw{-ssh} diff --git a/doc/man-psocks.but b/doc/man-psocks.but index a9792e44..eb075a6e 100644 --- a/doc/man-psocks.but +++ b/doc/man-psocks.but @@ -18,8 +18,8 @@ IPv4 and IPv6 connections. It does not support requiring authentication of its clients. \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 -be used for network protocol debugging, as it can record all the +\cw{putty}(\e{1}) to implement a reverse dynamic SSH tunnel. It can +also be used for network protocol debugging, as it can record all the traffic passing through it in various ways. 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 -In combination with the \e{plink(1)} SSH client, to set up a reverse -dynamic SSH tunnel, in which the remote listening port 1080 on +In combination with the \cw{plink}(\e{1}) SSH client, to set up a +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 local network: diff --git a/doc/man-psusan.but b/doc/man-psusan.but index 7877b3c8..a9c8baab 100644 --- a/doc/man-psusan.but +++ b/doc/man-psusan.but @@ -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. 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 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 diff --git a/doc/man-pterm.but b/doc/man-pterm.but index fec97f11..d3d1d96a 100644 --- a/doc/man-pterm.but +++ b/doc/man-pterm.but @@ -76,7 +76,7 @@ will be ignored unless the \cw{BoldAsColour} resource is set to 0 or 2. \dt \cw{\-geometry} \e{geometry} \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. \dt \cw{\-sl} \e{lines} diff --git a/doc/man-putty.but b/doc/man-putty.but index 858ec0b0..a85b4505 100644 --- a/doc/man-putty.but +++ b/doc/man-putty.but @@ -55,7 +55,7 @@ will be ignored unless the \cw{BoldAsColour} resource is set to 0 or 2. \dt \cw{\-geometry} \e{geometry} \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. \dt \cw{\-sl} \e{lines} diff --git a/doc/man-puttytel.but b/doc/man-puttytel.but index bf852ddb..075eeea7 100644 --- a/doc/man-puttytel.but +++ b/doc/man-puttytel.but @@ -56,7 +56,7 @@ will be ignored unless the \cw{BoldAsColour} resource is set to 0 or 2. \dt \cw{\-geometry} \e{geometry} \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. \dt \cw{\-sl} \e{lines}