From 977b25a76ae8263e53fb4eb1abfc395769f23e3d Mon Sep 17 00:00:00 2001 From: Russ Cox Date: Thu, 13 Aug 2020 23:41:59 -0400 Subject: tmac: introduce real manual reference macro instead of overloading IR The overloading of IR emits magic \X'...' sequences that turn into HTML manual links. But not all such IR invocations should be manual links; those had to be written to avoid the IR macro before. Worse, the \X'...' ending the IR causes troff to emit only a single space after a period. Defining a new IM macro for manual references fixes both problems. Fixes #441. --- man/man4/0intro.4 | 14 +++++------ man/man4/9import.4 | 16 ++++++------ man/man4/9pserve.4 | 8 +++--- man/man4/acme.4 | 15 +++++------ man/man4/factotum.4 | 72 ++++++++++++++++++++++++++--------------------------- man/man4/fontsrv.4 | 12 ++++----- man/man4/fossil.4 | 34 ++++++++++++------------- man/man4/import.4 | 6 ++--- man/man4/plumber.4 | 18 +++++++------- man/man4/ramfs.4 | 6 ++--- man/man4/smugfs.4 | 6 ++--- man/man4/srv.4 | 10 ++++---- man/man4/tapefs.4 | 8 +++--- man/man4/vacfs.4 | 11 ++++---- 14 files changed, 119 insertions(+), 117 deletions(-) (limited to 'man/man4') diff --git a/man/man4/0intro.4 b/man/man4/0intro.4 index 1e4c81d2..598a03fb 100644 --- a/man/man4/0intro.4 +++ b/man/man4/0intro.4 @@ -15,7 +15,7 @@ In Plan 9, the kernel mount device \fImnt\fR(3) acts as a client to the 9P servers mounted in the current name space, translating system calls such as -.IR open (2) +.IM open (2) into 9P transactions such as .IR open (9p). The kernel also multiplexes the potentially many processes onto a single 9P conversation @@ -30,17 +30,17 @@ On Unix, 9P clients do not access servers via the traditional file system call interface. Only the Unix name space can be accessed that way. Instead, 9P clients use the -.IR 9pclient (3) +.IM 9pclient (3) library to connect and interact directly with particular 9P servers. The -.IR 9p (1) +.IM 9p (1) command-line client is useful for interactive use and in shell scripts. .PP To preserve the façade of a single 9P conversation with each server, 9P servers invoke -.IR 9pserve (4), +.IM 9pserve (4) , typically via -.IR post9pservice (3). +.IM post9pservice (3) . .I 9pserve announces a 9P service at a particular network address and multiplexes the clients that connect to @@ -58,7 +58,7 @@ Setting the .B $NAMESPACE environment variable overrides this default. The -.IR namespace (1) +.IM namespace (1) command prints the current name space directory. .PP Occasionally it is useful to be able to connect the input or output @@ -73,7 +73,7 @@ implementation of (see also .I fsopenfd in -.IR 9pclient (3)) +.IM 9pclient (3) ) returns the read or write end of a pipe; a helper process transfers data between the other end of the pipe and the 9P server. diff --git a/man/man4/9import.4 b/man/man4/9import.4 index e5b177cf..5bcafe52 100644 --- a/man/man4/9import.4 +++ b/man/man4/9import.4 @@ -19,7 +19,7 @@ tool allows an arbitrary on a remote .I system, with the capability of running the Plan 9 -.IR exportfs (4) +.IM exportfs (4) service, to be imported into the local name space. Usually @@ -31,7 +31,7 @@ A process is started on the remote machine, with authority of the user of .IR 9import , to perform work for the local machine using the -.IR exportfs (4) +.IM exportfs (4) service. The default port used is TCP 17007. If @@ -55,11 +55,11 @@ Use .I keypattern to select a key to authenticate to the remote side (see -.IR auth (2)). +.IM auth (2) ). .TP .B -p Push the -.IR aan (8) +.IM aan (8) filter onto the connection to protect against temporary network outages. .TP @@ -69,11 +69,11 @@ Post the connection's mountable file descriptor as .SH SOURCE .B \*9/src/cmd/9import.c .SH SEE ALSO -.IR srv (4), -.IR aan (8), -.IR listen1 (8), +.IM srv (4) , +.IM aan (8) , +.IM listen1 (8) , .B cs in -.IR ndb (7) +.IM ndb (7) .SH BUGS Encryption is not implemented. diff --git a/man/man4/9pserve.4 b/man/man4/9pserve.4 index cd34d931..7eaa975f 100644 --- a/man/man4/9pserve.4 +++ b/man/man4/9pserve.4 @@ -50,7 +50,7 @@ and clunks any outstanding fids belonging to the client. .PP .I 9pserve is typically not invoked directly; use -.IR post9pservice (3) +.IM post9pservice (3) instead. .PP The options are: @@ -73,7 +73,7 @@ rewrite all attach messages to use and .IR afid ; used to implement -.IR srv (4)'s +.IM srv (4) 's .B -a option .TP @@ -90,8 +90,8 @@ instead assume 9P2000 and a maximum message size of .IR msize .PD .SH "SEE ALSO -.IR intro (4), +.IM intro (4) , .IR intro (9p), -.IR 9pfuse (4) +.IM 9pfuse (4) .SH SOURCE .B \*9/src/cmd/9pserve.c diff --git a/man/man4/acme.4 b/man/man4/acme.4 index 5305253e..1ed287fb 100644 --- a/man/man4/acme.4 +++ b/man/man4/acme.4 @@ -15,7 +15,7 @@ acme \- control files for text windows \&... ] .SH DESCRIPTION The text window system -.IR acme (1) +.IM acme (1) serves a variety of files for reading, writing, and controlling windows. Some of them are virtual versions of system files for dealing @@ -28,12 +28,13 @@ When a command is run under a directory holding these files is posted as the 9P service .B acme (using -.IR 9pserve (4)). +.IM 9pserve (4) ). .PP Some of these files supply virtual versions of services available from the underlying environment, in particular the character terminal files in Plan 9's -\fIcons\fR(3). -(Unlike in Plan 9's \fIrio\fR(1), +.IR cons (3). +(Unlike in Plan 9's +.IR rio (1), each command under .I acme sees the same set of files; there is not a distinct @@ -46,7 +47,7 @@ Other files are unique to is a subdirectory used by .B win (see -.IR acme (1)) +.IM acme (1) ) as a mount point for the .I acme files associated with the window in which @@ -435,5 +436,5 @@ except that reads stop at the end address. .SH SOURCE .B \*9/src/cmd/acme .SH SEE ALSO -.IR rio (1), -.IR acme (1) +.IM rio (1) , +.IM acme (1) diff --git a/man/man4/factotum.4 b/man/man4/factotum.4 index 3a2d3d7c..453965df 100644 --- a/man/man4/factotum.4 +++ b/man/man4/factotum.4 @@ -10,7 +10,7 @@ factotum \- authentication agent ] [ .B -s .I srvname -] +] .\" [ .\" .B -m .\" .I mtpt @@ -79,7 +79,7 @@ same user id as it. For select protocols such as it can also act as a client for other processes provided its user id may speak for the other process' user id (see Plan 9's -\fIauthsrv\fR(6)). +.IR authsrv (6)). .I Factotum can act in the role of server for any process. .PP @@ -127,7 +127,7 @@ RSA encryption and signatures, used by SSH and TLS. passwords in the clear. .TP .B vnc -.IR vnc (1)'s +.IM vnc (1) 's challenge/response. .TP .B wep @@ -186,7 +186,7 @@ cpu server. On starting, it will attempt to get a key from NVRAM using .B readnvram (see -.IR authsrv (3)), +.IM authsrv (3) ), prompting for anything it needs. It will never subsequently prompt for a key that it doesn't have. @@ -227,7 +227,7 @@ the kernel at boot time. .PP A .I "key tuple -is a space delimited list of +is a space delimited list of .IB attribute = value pairs. An attribute whose name begins with an exclamation point .RB ( ! ) @@ -245,7 +245,7 @@ specific to each supported protocol. .PP All keys can have additional attibutes that act either as comments or as selectors to distinguish them in the -.IR auth (3) +.IM auth (3) library calls. .PP The factotum owner can use any key stored by factotum. @@ -305,9 +305,9 @@ such as and .B auth_challenge (see -.IR auth (3)) +.IM auth (3) ) to specify which key and protocol to use for an authentication. -Like a key tuple, a key template is also a list of +Like a key tuple, a key template is also a list of .IB attribute = value pairs. It must specify at least the protocol and enough @@ -367,7 +367,7 @@ turned on by the option. .PP By default when factotum starts it looks for a -.IR secstore (1) +.IM secstore (1) account on $auth for the user and, if one exists, prompts for a secstore password in order to fetch the file @@ -385,11 +385,11 @@ sets a public/private keypair for ssh authentication, generated by .B ssh_genkey (see -.IR ssh (1)). +.IM ssh (1) ). .PD .SS "Confirming key use .PP -The +The .B confirm file provides a connection from .I factotum @@ -397,7 +397,7 @@ to a confirmation server, normally the program .IR auth/fgui . Whenever a key with the .B confirm -attribute is used, +attribute is used, .I factotum requires confirmation of its use. If no process has .B confirm @@ -429,7 +429,7 @@ the same user id as .IR factotum . .SS "Prompting for keys .PP -The +The .B needkey file provides a connection from .I factotum @@ -481,11 +481,11 @@ RPC's) until done if successful, reading back an .I AuthInfo structure (see -.IR authsrv (3)). +.IM authsrv (3) ). .PP The RPC protocol is normally embodied by one of the routines in -.IR auth (3). +.IM auth (3) . We describe it here should anyone want to extend the library. .PP @@ -545,7 +545,7 @@ necessary authentication has succeeded, an .B AuthInfo structure (see -.IR auth (3)) +.IM auth (3) ) can be retrieved with an .B authinfo RPC @@ -621,7 +621,7 @@ is expected to be a long hexadecimal string. These are useful for manually debugging of binary protocols. .TP .B authinfo -retrieve the AuthInfo structure. +retrieve the AuthInfo structure. The possible replies are: .RS .TP @@ -661,7 +661,7 @@ with its own roles and required key attributes. and .I p9cr are used to authenticate to Plan 9 systems; -valid +valid .BR role s are .B client @@ -691,7 +691,7 @@ is a meta-protocol that negotiates a protocol .RB ( p9sk1 or .BR p9sk2 ) -and an authentication domain and then invokes the +and an authentication domain and then invokes the given protocol with a .B dom= attribute. @@ -703,7 +703,7 @@ and are intended to be proxied via .I auth_proxy (see -.IR auth (3)). +.IM auth (3) ). .\" The protocols follow .\" .IR p9any (7) .\" and @@ -736,7 +736,7 @@ before being sent over the network. .PP .I Vnc is the challenge-response protocol used by -.IR vnc (1); +.IM vnc (1) ; valid roles are .B client and @@ -746,7 +746,7 @@ The client protocol requires a key with attribute .BR !password . Conventionally, client keys also have -.B user +.B user and .B server attributes. @@ -763,7 +763,7 @@ except that the challenge and response are not textual. and .I cram are challenge-response protocols typically -used to authenticate +used to authenticate to mail servers. The client protocols require .B proto=apop @@ -774,7 +774,7 @@ keys with and .B !password attributes. -Conventionally, client keys also have +Conventionally, client keys also have .B server attributes. The server protocol requires a @@ -828,7 +828,7 @@ structure (defined in .PP .I Pass is a client-only protocol that hands out passwords -from +from .B proto=pass keys with .B user @@ -840,7 +840,7 @@ a string: a space-separated quoted user name and password that can be parsed with .I tokenize (see -.IR getfields (3)). +.IM getfields (3) ). Conventionally, client keys have distinguishing attributes like .B service @@ -860,7 +860,7 @@ keys with .BR !key2 , or .B !key3 -attributes. +attributes. The protocol with .I factotum is: @@ -873,7 +873,7 @@ opens the device's control file, sets the wireless secret using the key, and turns on encryption. If the key has an .B essid -attribute, +attribute, .I factotum uses it to set the wireless station ID. .PP @@ -891,7 +891,7 @@ uses keys with .B ek and -.B n +.B n attributes, large integers specifying the public half of the key. If a key is to be used for decryption or signing, @@ -905,13 +905,13 @@ and .BR !dk specifying the private half of the key; see -.IR rsa (3). +.IM rsa (3) . Conventionally, .I rsa keys also have .B service attributes specifying the context in which the key is used: -.B ssh +.B ssh (SSH version 1), .B ssh-rsa (SSH version 2), @@ -946,7 +946,7 @@ and The hash function must be known to .I factotum because the signature encodes the type of hash used. -The +The .B encrypt and .B verify @@ -972,11 +972,11 @@ attributes. If the key is to be used for signing, it must also have a .B !secret attribute; see -.IR dsa (3). +.IM dsa (3) . Conventionally, .I dsa keys -also have +also have .B service attributes specifying the context in which the key is used: .B ssh-dss @@ -992,7 +992,7 @@ Unlike .IR rsa , the .I dsa -protocol ignores the +protocol ignores the .B hash attribute; it always uses SHA1. .PP @@ -1019,4 +1019,4 @@ The response is a hexadecimal string of length 32. .SH SOURCE .B \*9/src/cmd/auth/factotum .SH SEE ALSO -.IR ssh-agent (1) +.IM ssh-agent (1) diff --git a/man/man4/fontsrv.4 b/man/man4/fontsrv.4 index 2ba7f2c1..a270b2f1 100644 --- a/man/man4/fontsrv.4 +++ b/man/man4/fontsrv.4 @@ -20,7 +20,7 @@ fontsrv \- file system access to host fonts presents the host window system's fonts in the standard Plan 9 format (see -.IR font (7)). +.IM font (7) ). It serves a virtual directory tree mounted at .I mtpt (if the @@ -72,14 +72,14 @@ representing 32-character Unicode ranges. .PP .I Openfont (see -.IR graphics (3)) +.IM graphics (3) ) recognizes font paths beginning with .B /mnt/font and implements them by invoking .IR fontsrv ; it need not be running already. See -.IR font (7) +.IM font (7) for a full discussion of font name syntaxes. .SH EXAMPLES List the fonts on the system: @@ -96,7 +96,7 @@ or: .EE .LP Run -.IR acme (1) +.IM acme (1) using the operating system's Monaco as the fixed-width font: .IP .EX @@ -104,7 +104,7 @@ using the operating system's Monaco as the fixed-width font: .EE .LP Run -.IR sam (1) +.IM sam (1) using the same font: .IP .EX @@ -113,7 +113,7 @@ using the same font: .SH SOURCE .B \*9/src/cmd/fontsrv .SH SEE ALSO -.IR font (7) +.IM font (7) .SH BUGS .PP Due to OS X restrictions, diff --git a/man/man4/fossil.4 b/man/man4/fossil.4 index 7c06f2f7..6072a39a 100644 --- a/man/man4/fossil.4 +++ b/man/man4/fossil.4 @@ -148,10 +148,10 @@ will be named The attach name used in .I mount (see -.IR bind (1), -.IR bind (2) +.IM bind (1) , +.IM bind (2) and -.IR attach (5)) +.IM attach (5) ) selects a file system to be served and optionally a subtree, in the format @@ -163,7 +163,7 @@ An empty attach name selects normally requires all users except .L none to provide authentication tickets on each -.IR attach (5). +.IM attach (5) . To keep just anyone from connecting, .L none is only allowed to attach after another user @@ -179,7 +179,7 @@ flag to or .B srv (see -.IR fossilcons (8)). +.IM fossilcons (8) ). .PP The groups called .B noworld @@ -207,7 +207,7 @@ readable by the world but writable only to the developers. starts a new instance of the fossil file server. It is configured mainly through console commands, documented in -.IR fossilcons (8). +.IM fossilcons (8) . .PP The options are: .TF "-c\fI cmd @@ -239,7 +239,7 @@ and which starts a file server console on .BI /srv/ cons \fR. See -.IR fossilcons (8) +.IM fossilcons (8) for more information. .TP .BI -f " file @@ -269,7 +269,7 @@ for inconsistencies. is deprecated in favor of the console .B check command (see -.IR fossilcons (8)). +.IM fossilcons (8) ). .I Flchk prints .I fossil @@ -375,7 +375,7 @@ system stored on Venti at The score should have been generated by .I fossil rather than by -.IR vac (1), +.IM vac (1) , so that the appropriate snapshot metadata is present. .PD .PP @@ -450,7 +450,7 @@ See the discussion of the and .B uname commands in -.IR fossilcons (8) +.IM fossilcons (8) for more about the user table. .ne 3 .PP @@ -488,13 +488,13 @@ command to prepare the script. .SH SOURCE .B \*9/src/cmd/fossil .SH SEE ALSO -.IR yesterday (1), -.IR fs (3), -.IR fs (4), -.IR srv (4), -.IR fossilcons (8), -.IR loadfossil (8), -.IR venti (8) +.IM yesterday (1) , +.IM fs (3) , +.IM fs (4) , +.IM srv (4) , +.IM fossilcons (8) , +.IM loadfossil (8) , +.IM venti (8) .SH BUGS It is possible that the disk format (but not the Venti format) will change in the future, to make the disk a full cache diff --git a/man/man4/import.4 b/man/man4/import.4 index 9dd81d72..7d67a449 100644 --- a/man/man4/import.4 +++ b/man/man4/import.4 @@ -48,7 +48,7 @@ the path have different meanings on the two systems.) connects to .I system using -.IR ssh (1). +.IM ssh (1) . It invokes .I import on the remote system to carry out the remote @@ -109,5 +109,5 @@ sam & .SH SOURCE .B \*9/src/cmd/import.c .SH SEE ALSO -.IR 9pserve (4), -.IR intro (4) +.IM 9pserve (4) , +.IM intro (4) diff --git a/man/man4/plumber.4 b/man/man4/plumber.4 index 88801eb4..a86f032a 100644 --- a/man/man4/plumber.4 +++ b/man/man4/plumber.4 @@ -14,17 +14,17 @@ plumber \- file system for interprocess messaging The .I plumber is a user-level file server that receives, examines, rewrites, and dispatches -.IR plumb (7) +.IM plumb (7) messages between programs. Its behavior is programmed by a .I plumbing file (default .BR $HOME/lib/plumbing ) in the format of -.IR plumb (7). +.IM plumb (7) . .PP Its services are posted via -.IR 9pserve (4) +.IM 9pserve (4) as .BR plumb , and consist of two @@ -39,14 +39,14 @@ for dispatching messages to applications. Programs use .B fswrite (see -.IR 9pclient (3)) +.IM 9pclient (3) ) to deliver messages to the .B send file, and .I fsread to receive them from the corresponding port. For example, -.IR sam (1)'s +.IM sam (1) 's .B plumb menu item or the .B B @@ -115,13 +115,13 @@ statements .TP .B plumb mount name for -.IR plumber (4). +.IM plumber (4) . .SH SOURCE .B \*9/src/cmd/plumb .SH "SEE ALSO" -.IR plumb (1), -.IR plumb (3), -.IR plumb (7) +.IM plumb (1) , +.IM plumb (3) , +.IM plumb (7) .\" .SH BUGS .\" .IR Plumber 's .\" file name space is fixed, so it is difficult to plumb diff --git a/man/man4/ramfs.4 b/man/man4/ramfs.4 index 25ae4bf6..20e72b38 100644 --- a/man/man4/ramfs.4 +++ b/man/man4/ramfs.4 @@ -21,7 +21,7 @@ By default posts its service as .B ramfs using -.IR 9pserve (4). +.IM 9pserve (4) . .PP The .B -S @@ -46,5 +46,5 @@ It can also be used to provide high-performance temporary files. .SH SOURCE .B \*9/src/cmd/ramfs.c .SH "SEE ALSO" -.IR 9p (3), -.IR 9pserve (4) +.IM 9p (3) , +.IM 9pserve (4) diff --git a/man/man4/smugfs.4 b/man/man4/smugfs.4 index 4fb8c7f0..fdea4e47 100644 --- a/man/man4/smugfs.4 +++ b/man/man4/smugfs.4 @@ -24,7 +24,7 @@ is a user-level file system that provides access to images stored on the SmugMug photo sharing service. It logs in after obtaining a password from -.IR factotum (4) +.IM factotum (4) using .B server=smugmug.com and @@ -32,7 +32,7 @@ and (if any) as key criteria (see -.IR auth (3)). +.IM auth (3) ). Then .I smugfs serves a virtual directory tree mounted at @@ -265,7 +265,7 @@ SmugMug, If multiple categories or albums have the same name, only one will be accessible via the file system interface. Renaming the accessible one via Unix's -.IR mv (1) +.IM mv (1) will resolve the problem. .PP Boolean values appear as diff --git a/man/man4/srv.4 b/man/man4/srv.4 index 856f88ff..469b2b4c 100644 --- a/man/man4/srv.4 +++ b/man/man4/srv.4 @@ -22,7 +22,7 @@ srv, 9fs \- start network file service dials the given address and initializes the connection to serve the 9P protocol. It then posts the resulting connection in the current name space (see -.IR intro (4)) +.IM intro (4) ) as .I srvname (default @@ -70,7 +70,7 @@ available as service .IR sources . .I 9fs is an -.IR rc (1) +.IM rc (1) script; examine it to see what local conventions apply. .SH EXAMPLES List the root directory on @@ -98,6 +98,6 @@ sudo mount -t 9p -o trans=unix,uname=$USER,dfltuid=`id -u`,dfltgid=`id -g` .br .B \*9/bin/9fs .SH "SEE ALSO -.IR dial (3), -.IR intro (4), -.IR netfiles (1) +.IM dial (3) , +.IM intro (4) , +.IM netfiles (1) diff --git a/man/man4/tapefs.4 b/man/man4/tapefs.4 index 3297e2a4..b8843173 100644 --- a/man/man4/tapefs.4 +++ b/man/man4/tapefs.4 @@ -91,7 +91,7 @@ Tenth Edition research Unix systems (4KB block size). .PP .I Zipfs interprets zip archives (see -.IR gzip (1)). +.IM gzip (1) ). .SH SOURCE .PP These commands are constructed in a highly stereotyped @@ -103,7 +103,7 @@ in .BR \*9/src/cmd/tapefs , which in turn derive substantially from -.IR ramfs (4). +.IM ramfs (4) . .SH "SEE ALSO -.IR intro (7), -.IR ramfs (4). +.IM intro (7) , +.IM ramfs (4) . diff --git a/man/man4/vacfs.4 b/man/man4/vacfs.4 index 143e782b..0c92ff60 100644 --- a/man/man4/vacfs.4 +++ b/man/man4/vacfs.4 @@ -26,7 +26,7 @@ vacfs \- a Venti-based file system .SH DESCRIPTION .I Vacfs interprets the file system created by -.IR vac (1) +.IM vac (1) so that it can be mounted into a Plan 9 file hierarchy. The data for the file system is stored on a Venti server with a root fingerprint specified in @@ -37,7 +37,7 @@ clients are not authenticated, and groups are assumed to contain a single member with the same name. These restrictions should eventually be removed. .PP -Options to +Options to .I vacfs are: .TP @@ -49,7 +49,7 @@ The network address of the Venti server. The default is taken from the environment variable .BR venti . If this variable does not exist, then the default is the -metaname +metaname .BR $venti . .\" which can be configured via .\" .IR ndb (6). @@ -81,5 +81,6 @@ The amount of memory, in bytes, allocated to the block cache. The default is 16M .SH SOURCE .B \*9/src/cmd/vac .SH "SEE ALSO" -.IR vac (1), -Plan 9's \fIventi\fR(8) +.IM vac (1) , +Plan 9's +.IR venti (8) -- cgit v1.2.3