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/man8/fossilcons.8 | 18 +++++++++--------- man/man8/getflags.8 | 10 +++++----- man/man8/listen1.8 | 8 +++----- man/man8/mkfs.8 | 8 ++++---- man/man8/vbackup.8 | 12 ++++++------ man/man8/venti-backup.8 | 4 ++-- man/man8/venti-fmt.8 | 12 ++++++------ man/man8/venti.8 | 20 ++++++++++---------- 8 files changed, 45 insertions(+), 47 deletions(-) (limited to 'man/man8') diff --git a/man/man8/fossilcons.8 b/man/man8/fossilcons.8 index b59b6b6a..49a42e09 100644 --- a/man/man8/fossilcons.8 +++ b/man/man8/fossilcons.8 @@ -340,7 +340,7 @@ con /srv/fscons .SH DESCRIPTION These are configuration and maintenance commands executed at the console of a -.IR fossil (4) +.IM fossil (4) file server. The commands are split into three groups above: file server configuration, @@ -372,11 +372,11 @@ a file in any file system served by .I 9p executes a 9P transaction; the arguments are in the same format used by -.IR 9pcon (8). +.IM 9pcon (8) . .PP .I Bind behaves similarly to -.IR bind (1). +.IM bind (1) . It is useful when fossil is started without devices it needs configured into its namespace. @@ -389,7 +389,7 @@ standard error. .PP .I Echo behaves identically to -.IR echo (1), +.IM echo (1) , writing to the console. .PP .I Listen @@ -492,7 +492,7 @@ the string used to represent this user in the 9P protocol .TP .I leader the group's leader (see Plan 9's -.IR stat (5) +.IM stat (5) for a description of the special privileges held by a group leader) .TP .I members @@ -821,7 +821,7 @@ removing a non-empty directory. A subsequent .I flchk (see -.IR fossil (4)) +.IM fossil (4) ) will identify the abandoned storage so it can be reclaimed with .I bfree commands. @@ -1013,7 +1013,7 @@ takes a temporary snapshot of the current file system, recording it in .BI /snapshot/ yyyy / mmdd / hhmm \fR, as described in -.IR fossil (4). +.IM fossil (4) . The .B -a flag causes @@ -1021,7 +1021,7 @@ flag causes to take an archival snapshot, recording it in .BI /archive/ yyyy / mmdd \fR, also described in -.IR fossil (4). +.IM fossil (4) . By default the snapshot is taken of .BR /active , the root of the active file system. @@ -1132,7 +1132,7 @@ writes dirty blocks in memory to the disk. .PP .I Vac prints the Venti score for a -.IR vac (1) +.IM vac (1) archive containing the tree rooted at .IR dir , diff --git a/man/man8/getflags.8 b/man/man8/getflags.8 index 86c295b9..02c774f5 100644 --- a/man/man8/getflags.8 +++ b/man/man8/getflags.8 @@ -16,7 +16,7 @@ not take arguments, or a letter followed by the space-separated names of its arguments. .I Getflags prints an -.IR rc (1) +.IM rc (1) script on standard output which initializes the environment variable .BI $flag x @@ -51,15 +51,15 @@ and .BR $0 , the program name (see -.IR rc (1)). +.IM rc (1) ). If run under -.IR sh (1), +.IM sh (1) , which does not set .BR $0 , the program name must be given explicitly on the command line. .SH EXAMPLE Parse the arguments for Plan 9's -.IR leak (1): +.IM leak (1) : .IP .EX flagfmt='b,s,f binary,r res,x width' @@ -74,4 +74,4 @@ if(! ifs=() eval `{getflags $*} || ~ $#* 0){ .br .B \*9/src/cmd/usage.c .SH SEE ALSO -.IR arg (3) +.IM arg (3) diff --git a/man/man8/listen1.8 b/man/man8/listen1.8 index 534766bf..2de33f1f 100644 --- a/man/man8/listen1.8 +++ b/man/man8/listen1.8 @@ -17,9 +17,7 @@ listen1 \- listen for calls on a network device .I Listen1 is a lightweight listener intended for personal use, modeled from Inferno's -.\" write out this way so automatic programs -.\" don't try to make it into a real man page reference. -\fIlisten\fR(1). +.IR listen (1). It announces on .IR address , @@ -28,7 +26,7 @@ running .I args... for each incoming connection; the network directory is passed in the environment -as +as .BR $net . The .B -v @@ -36,4 +34,4 @@ flag causes verbose logging on standard output. .SH SOURCE .B \*9/src/cmd/listen1.c .SH "SEE ALSO" -.IR dial (3) +.IM dial (3) diff --git a/man/man8/mkfs.8 b/man/man8/mkfs.8 index 2eaba6c1..fb4fa2e6 100644 --- a/man/man8/mkfs.8 +++ b/man/man8/mkfs.8 @@ -34,7 +34,7 @@ copies files from the file tree to a .B kfs file system (see -.IR kfs (4)). +.IM kfs (4) ). The kfs service is mounted on .I root (default @@ -47,7 +47,7 @@ The .I proto files are read (see -.IR proto (2) +.IM proto (2) for their format) and any files specified in them that are out of date are copied to .BR /n/kfs . @@ -183,5 +183,5 @@ disk/mkext -u -d /n/newfs < arch .br .B \*9/src/cmd/disk/mkext.c .SH "SEE ALSO" -.IR prep (8), -.IR tar (1) +.IM prep (8) , +.IM tar (1) diff --git a/man/man8/vbackup.8 b/man/man8/vbackup.8 index 26ab9178..e212435e 100644 --- a/man/man8/vbackup.8 +++ b/man/man8/vbackup.8 @@ -70,7 +70,7 @@ back up Unix file systems to Venti .SH DESCRIPTION These programs back up and restore standard Unix file system images stored in -.IR venti (8). +.IM venti (8) . Images stored in .I venti are named by @@ -102,7 +102,7 @@ The argument .I disk should be a disk or disk partition device that would be appropriate to pass to -.IR mount (8). +.IM mount (8) . .PP The optional argument .I score @@ -135,7 +135,7 @@ The default is the name returned by .I sysname (see -.IR getuser (3)). +.IM getuser (3) ). The default .I mtpt is the place where @@ -149,7 +149,7 @@ command. The default is the name returned by .I sysname (see -.IR getuser (3)). +.IM getuser (3) ). .TP .B -n No-op mode: do not write any blocks to the server @@ -207,7 +207,7 @@ to zero unused blocks instead. .PP .I Vftp presents an -.IR ftp (1)-like +.IM ftp (1) -like interface to a physical or backed-up disk image. It is used mainly for debugging. Type @@ -228,7 +228,7 @@ must be run by the user Because .I address is passed to the host OS kernel rather than interpreted by -.IR dial (3), +.IM dial (3) , it must be only an IP address, not a full dial address. .PP .I Vnfs diff --git a/man/man8/venti-backup.8 b/man/man8/venti-backup.8 index 10614a50..88bad8f3 100644 --- a/man/man8/venti-backup.8 +++ b/man/man8/venti-backup.8 @@ -104,8 +104,8 @@ for a version that does this. .SH SOURCE .B \*9/src/cmd/venti/srv .SH SEE ALSO -.IR venti (7), -.IR venti (8) +.IM venti (7) , +.IM venti (8) .SH BUGS .I Wrarena can't read a pipe or network connection containing an arena; diff --git a/man/man8/venti-fmt.8 b/man/man8/venti-fmt.8 index 7c44754f..19679ca0 100644 --- a/man/man8/venti-fmt.8 +++ b/man/man8/venti-fmt.8 @@ -99,9 +99,9 @@ syncindex \- prepare and maintain a venti server These commands aid in the setup, maintenance, and debugging of venti servers. See -.IR venti (7) +.IM venti (7) for an overview of the venti system and -.IR venti (8) +.IM venti (8) for an overview of the data structures used by the venti server. .PP Note that the units for the various sizes in the following @@ -195,7 +195,7 @@ formats the given .I file as a Bloom filter (see -.IR venti (7)). +.IM venti (7) ). The options are: .TF "\fL-s\fI size" .PD @@ -264,7 +264,7 @@ overflow. The total size of the index should be about 2% to 10% of the total size of the arenas, but the exact percentage depends both on the index block size and the compressed size of blocks stored. See the discussion in -.IR venti (8) +.IM venti (8) for more. .PP .I Fmtindex @@ -401,8 +401,8 @@ Increase the verbosity of output. .SH SOURCE .B \*9/src/cmd/venti/srv .SH SEE ALSO -.IR venti (7), -.IR venti (8) +.IM venti (7) , +.IM venti (8) .SH BUGS .I Buildindex should allow an individual index section to be rebuilt. diff --git a/man/man8/venti.8 b/man/man8/venti.8 index 4fd40df6..d6c26903 100644 --- a/man/man8/venti.8 +++ b/man/man8/venti.8 @@ -40,7 +40,7 @@ venti \- archival storage server .I Venti is a SHA1-addressed archival storage server. See -.IR venti (7) +.IM venti (7) for a full introduction to the system. This page documents the structure and operation of the server. .PP @@ -138,7 +138,7 @@ less than 10 are not very useful; greater than 24 are probably a waste of memory. .I Fmtbloom (see -.IR venti-fmt (8)) +.IM venti-fmt (8) ) can be given either .I nhash or @@ -220,7 +220,7 @@ The venti server announces two network services, one .BR venti , 17034) serving the venti protocol as described in -.IR venti (7), +.IM venti (7) , and one serving HTTP (conventionally TCP port .BR http , @@ -333,7 +333,7 @@ with or .I fmtisect (see -.IR venti-fmt (8)). +.IM venti-fmt (8) ). In particular, only the configuration needs to be changed if a component is moved to a different file. .PP @@ -506,11 +506,11 @@ Start the server and check the storage statistics: .SH SOURCE .B \*9/src/cmd/venti/srv .SH "SEE ALSO" -.IR venti (1), -.IR venti (3), -.IR venti (7), -.IR venti-backup (8) -.IR venti-fmt (8) +.IM venti (1) , +.IM venti (3) , +.IM venti (7) , +.IM venti-backup (8) +.IM venti-fmt (8) .br Sean Quinlan and Sean Dorward, ``Venti: a new approach to archival storage'', @@ -523,7 +523,7 @@ Venti should not require the user to decide how to partition its memory usage. .PP Users of shells other than -.IR rc (1) +.IM rc (1) will not be able to use the program names shown. One solution is to define .B "V=$PLAN9/bin/venti" -- cgit v1.2.3 From d32deab17bfffa5bffc5fab3e6577558e40888c5 Mon Sep 17 00:00:00 2001 From: Russ Cox Date: Sat, 15 Aug 2020 20:07:38 -0400 Subject: tmac: rename IM (italic manual) to MR (manual reference) Suggested by G. Brandon Robinson. --- man/man8/fossilcons.8 | 18 +++++++++--------- man/man8/getflags.8 | 10 +++++----- man/man8/listen1.8 | 2 +- man/man8/mkfs.8 | 8 ++++---- man/man8/vbackup.8 | 12 ++++++------ man/man8/venti-backup.8 | 4 ++-- man/man8/venti-fmt.8 | 12 ++++++------ man/man8/venti.8 | 20 ++++++++++---------- 8 files changed, 43 insertions(+), 43 deletions(-) (limited to 'man/man8') diff --git a/man/man8/fossilcons.8 b/man/man8/fossilcons.8 index 49a42e09..8ad9d4be 100644 --- a/man/man8/fossilcons.8 +++ b/man/man8/fossilcons.8 @@ -340,7 +340,7 @@ con /srv/fscons .SH DESCRIPTION These are configuration and maintenance commands executed at the console of a -.IM fossil (4) +.MR fossil (4) file server. The commands are split into three groups above: file server configuration, @@ -372,11 +372,11 @@ a file in any file system served by .I 9p executes a 9P transaction; the arguments are in the same format used by -.IM 9pcon (8) . +.MR 9pcon (8) . .PP .I Bind behaves similarly to -.IM bind (1) . +.MR bind (1) . It is useful when fossil is started without devices it needs configured into its namespace. @@ -389,7 +389,7 @@ standard error. .PP .I Echo behaves identically to -.IM echo (1) , +.MR echo (1) , writing to the console. .PP .I Listen @@ -492,7 +492,7 @@ the string used to represent this user in the 9P protocol .TP .I leader the group's leader (see Plan 9's -.IM stat (5) +.MR stat (5) for a description of the special privileges held by a group leader) .TP .I members @@ -821,7 +821,7 @@ removing a non-empty directory. A subsequent .I flchk (see -.IM fossil (4) ) +.MR fossil (4) ) will identify the abandoned storage so it can be reclaimed with .I bfree commands. @@ -1013,7 +1013,7 @@ takes a temporary snapshot of the current file system, recording it in .BI /snapshot/ yyyy / mmdd / hhmm \fR, as described in -.IM fossil (4) . +.MR fossil (4) . The .B -a flag causes @@ -1021,7 +1021,7 @@ flag causes to take an archival snapshot, recording it in .BI /archive/ yyyy / mmdd \fR, also described in -.IM fossil (4) . +.MR fossil (4) . By default the snapshot is taken of .BR /active , the root of the active file system. @@ -1132,7 +1132,7 @@ writes dirty blocks in memory to the disk. .PP .I Vac prints the Venti score for a -.IM vac (1) +.MR vac (1) archive containing the tree rooted at .IR dir , diff --git a/man/man8/getflags.8 b/man/man8/getflags.8 index 02c774f5..776a17aa 100644 --- a/man/man8/getflags.8 +++ b/man/man8/getflags.8 @@ -16,7 +16,7 @@ not take arguments, or a letter followed by the space-separated names of its arguments. .I Getflags prints an -.IM rc (1) +.MR rc (1) script on standard output which initializes the environment variable .BI $flag x @@ -51,15 +51,15 @@ and .BR $0 , the program name (see -.IM rc (1) ). +.MR rc (1) ). If run under -.IM sh (1) , +.MR sh (1) , which does not set .BR $0 , the program name must be given explicitly on the command line. .SH EXAMPLE Parse the arguments for Plan 9's -.IM leak (1) : +.MR leak (1) : .IP .EX flagfmt='b,s,f binary,r res,x width' @@ -74,4 +74,4 @@ if(! ifs=() eval `{getflags $*} || ~ $#* 0){ .br .B \*9/src/cmd/usage.c .SH SEE ALSO -.IM arg (3) +.MR arg (3) diff --git a/man/man8/listen1.8 b/man/man8/listen1.8 index 2de33f1f..98f560f3 100644 --- a/man/man8/listen1.8 +++ b/man/man8/listen1.8 @@ -34,4 +34,4 @@ flag causes verbose logging on standard output. .SH SOURCE .B \*9/src/cmd/listen1.c .SH "SEE ALSO" -.IM dial (3) +.MR dial (3) diff --git a/man/man8/mkfs.8 b/man/man8/mkfs.8 index fb4fa2e6..073e55b2 100644 --- a/man/man8/mkfs.8 +++ b/man/man8/mkfs.8 @@ -34,7 +34,7 @@ copies files from the file tree to a .B kfs file system (see -.IM kfs (4) ). +.MR kfs (4) ). The kfs service is mounted on .I root (default @@ -47,7 +47,7 @@ The .I proto files are read (see -.IM proto (2) +.MR proto (2) for their format) and any files specified in them that are out of date are copied to .BR /n/kfs . @@ -183,5 +183,5 @@ disk/mkext -u -d /n/newfs < arch .br .B \*9/src/cmd/disk/mkext.c .SH "SEE ALSO" -.IM prep (8) , -.IM tar (1) +.MR prep (8) , +.MR tar (1) diff --git a/man/man8/vbackup.8 b/man/man8/vbackup.8 index e212435e..fa201f40 100644 --- a/man/man8/vbackup.8 +++ b/man/man8/vbackup.8 @@ -70,7 +70,7 @@ back up Unix file systems to Venti .SH DESCRIPTION These programs back up and restore standard Unix file system images stored in -.IM venti (8) . +.MR venti (8) . Images stored in .I venti are named by @@ -102,7 +102,7 @@ The argument .I disk should be a disk or disk partition device that would be appropriate to pass to -.IM mount (8) . +.MR mount (8) . .PP The optional argument .I score @@ -135,7 +135,7 @@ The default is the name returned by .I sysname (see -.IM getuser (3) ). +.MR getuser (3) ). The default .I mtpt is the place where @@ -149,7 +149,7 @@ command. The default is the name returned by .I sysname (see -.IM getuser (3) ). +.MR getuser (3) ). .TP .B -n No-op mode: do not write any blocks to the server @@ -207,7 +207,7 @@ to zero unused blocks instead. .PP .I Vftp presents an -.IM ftp (1) -like +.MR ftp (1) -like interface to a physical or backed-up disk image. It is used mainly for debugging. Type @@ -228,7 +228,7 @@ must be run by the user Because .I address is passed to the host OS kernel rather than interpreted by -.IM dial (3) , +.MR dial (3) , it must be only an IP address, not a full dial address. .PP .I Vnfs diff --git a/man/man8/venti-backup.8 b/man/man8/venti-backup.8 index 88bad8f3..131514c6 100644 --- a/man/man8/venti-backup.8 +++ b/man/man8/venti-backup.8 @@ -104,8 +104,8 @@ for a version that does this. .SH SOURCE .B \*9/src/cmd/venti/srv .SH SEE ALSO -.IM venti (7) , -.IM venti (8) +.MR venti (7) , +.MR venti (8) .SH BUGS .I Wrarena can't read a pipe or network connection containing an arena; diff --git a/man/man8/venti-fmt.8 b/man/man8/venti-fmt.8 index 19679ca0..39906862 100644 --- a/man/man8/venti-fmt.8 +++ b/man/man8/venti-fmt.8 @@ -99,9 +99,9 @@ syncindex \- prepare and maintain a venti server These commands aid in the setup, maintenance, and debugging of venti servers. See -.IM venti (7) +.MR venti (7) for an overview of the venti system and -.IM venti (8) +.MR venti (8) for an overview of the data structures used by the venti server. .PP Note that the units for the various sizes in the following @@ -195,7 +195,7 @@ formats the given .I file as a Bloom filter (see -.IM venti (7) ). +.MR venti (7) ). The options are: .TF "\fL-s\fI size" .PD @@ -264,7 +264,7 @@ overflow. The total size of the index should be about 2% to 10% of the total size of the arenas, but the exact percentage depends both on the index block size and the compressed size of blocks stored. See the discussion in -.IM venti (8) +.MR venti (8) for more. .PP .I Fmtindex @@ -401,8 +401,8 @@ Increase the verbosity of output. .SH SOURCE .B \*9/src/cmd/venti/srv .SH SEE ALSO -.IM venti (7) , -.IM venti (8) +.MR venti (7) , +.MR venti (8) .SH BUGS .I Buildindex should allow an individual index section to be rebuilt. diff --git a/man/man8/venti.8 b/man/man8/venti.8 index d6c26903..6a6d53e0 100644 --- a/man/man8/venti.8 +++ b/man/man8/venti.8 @@ -40,7 +40,7 @@ venti \- archival storage server .I Venti is a SHA1-addressed archival storage server. See -.IM venti (7) +.MR venti (7) for a full introduction to the system. This page documents the structure and operation of the server. .PP @@ -138,7 +138,7 @@ less than 10 are not very useful; greater than 24 are probably a waste of memory. .I Fmtbloom (see -.IM venti-fmt (8) ) +.MR venti-fmt (8) ) can be given either .I nhash or @@ -220,7 +220,7 @@ The venti server announces two network services, one .BR venti , 17034) serving the venti protocol as described in -.IM venti (7) , +.MR venti (7) , and one serving HTTP (conventionally TCP port .BR http , @@ -333,7 +333,7 @@ with or .I fmtisect (see -.IM venti-fmt (8) ). +.MR venti-fmt (8) ). In particular, only the configuration needs to be changed if a component is moved to a different file. .PP @@ -506,11 +506,11 @@ Start the server and check the storage statistics: .SH SOURCE .B \*9/src/cmd/venti/srv .SH "SEE ALSO" -.IM venti (1) , -.IM venti (3) , -.IM venti (7) , -.IM venti-backup (8) -.IM venti-fmt (8) +.MR venti (1) , +.MR venti (3) , +.MR venti (7) , +.MR venti-backup (8) +.MR venti-fmt (8) .br Sean Quinlan and Sean Dorward, ``Venti: a new approach to archival storage'', @@ -523,7 +523,7 @@ Venti should not require the user to decide how to partition its memory usage. .PP Users of shells other than -.IM rc (1) +.MR rc (1) will not be able to use the program names shown. One solution is to define .B "V=$PLAN9/bin/venti" -- cgit v1.2.3