tmac: rename IM (italic manual) to MR (manual reference)

Suggested by G. Brandon Robinson.
This commit is contained in:
Russ Cox 2020-08-15 20:07:38 -04:00
parent 9843fc0d82
commit d32deab17b
286 changed files with 1591 additions and 1588 deletions

View file

@ -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
.IM open (2)
.MR 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
.IM 9pclient (3)
.MR 9pclient (3)
library to connect and interact directly with particular 9P servers.
The
.IM 9p (1)
.MR 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
.IM 9pserve (4) ,
.MR 9pserve (4) ,
typically via
.IM post9pservice (3) .
.MR 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
.IM namespace (1)
.MR 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
.IM 9pclient (3) )
.MR 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.

View file

@ -19,7 +19,7 @@ tool allows an arbitrary
on a remote
.I system,
with the capability of running the Plan 9
.IM exportfs (4)
.MR 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
.IM exportfs (4)
.MR 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
.IM auth (2) ).
.MR auth (2) ).
.TP
.B -p
Push the
.IM aan (8)
.MR 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
.IM srv (4) ,
.IM aan (8) ,
.IM listen1 (8) ,
.MR srv (4) ,
.MR aan (8) ,
.MR listen1 (8) ,
.B cs
in
.IM ndb (7)
.MR ndb (7)
.SH BUGS
Encryption is not implemented.

View file

@ -50,7 +50,7 @@ and clunks any outstanding fids belonging to the client.
.PP
.I 9pserve
is typically not invoked directly; use
.IM post9pservice (3)
.MR post9pservice (3)
instead.
.PP
The options are:
@ -73,7 +73,7 @@ rewrite all attach messages to use
and
.IR afid ;
used to implement
.IM srv (4) 's
.MR 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
.IM intro (4) ,
.MR intro (4) ,
.IR intro (9p),
.IM 9pfuse (4)
.MR 9pfuse (4)
.SH SOURCE
.B \*9/src/cmd/9pserve.c

View file

@ -15,7 +15,7 @@ acme \- control files for text windows
\&... ]
.SH DESCRIPTION
The text window system
.IM acme (1)
.MR 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,7 +28,7 @@ When a command is run under
a directory holding these files is posted as the 9P service
.B acme
(using
.IM 9pserve (4) ).
.MR 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
@ -47,7 +47,7 @@ Other files are unique to
is a subdirectory used by
.B win
(see
.IM acme (1) )
.MR acme (1) )
as a mount point for the
.I acme
files associated with the window in which
@ -436,5 +436,5 @@ except that reads stop at the end address.
.SH SOURCE
.B \*9/src/cmd/acme
.SH SEE ALSO
.IM rio (1) ,
.IM acme (1)
.MR rio (1) ,
.MR acme (1)

View file

@ -127,7 +127,7 @@ RSA encryption and signatures, used by SSH and TLS.
passwords in the clear.
.TP
.B vnc
.IM vnc (1) 's
.MR 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
.IM authsrv (3) ),
.MR authsrv (3) ),
prompting for anything it needs.
It will never subsequently prompt for a
key that it doesn't have.
@ -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
.IM auth (3)
.MR auth (3)
library calls.
.PP
The factotum owner can use any key stored by factotum.
@ -305,7 +305,7 @@ such as
and
.B auth_challenge
(see
.IM auth (3) )
.MR 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
.IB attribute = value
@ -367,7 +367,7 @@ turned on by the
option.
.PP
By default when factotum starts it looks for a
.IM secstore (1)
.MR secstore (1)
account on $auth for the user and, if one exists,
prompts for a secstore password in order to fetch
the file
@ -385,7 +385,7 @@ sets a public/private keypair for ssh authentication,
generated by
.B ssh_genkey
(see
.IM ssh (1) ).
.MR ssh (1) ).
.PD
.SS "Confirming key use
.PP
@ -481,11 +481,11 @@ RPC's) until done
if successful, reading back an
.I AuthInfo
structure (see
.IM authsrv (3) ).
.MR authsrv (3) ).
.PP
The RPC protocol is normally embodied by one of the
routines in
.IM auth (3) .
.MR 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
.IM auth (3) )
.MR auth (3) )
can be retrieved with an
.B authinfo
RPC
@ -703,7 +703,7 @@ and
are intended to be proxied via
.I auth_proxy
(see
.IM auth (3) ).
.MR 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
.IM vnc (1) ;
.MR vnc (1) ;
valid roles are
.B client
and
@ -840,7 +840,7 @@ a string: a space-separated quoted user name and password
that can be parsed with
.I tokenize
(see
.IM getfields (3) ).
.MR getfields (3) ).
Conventionally, client keys have distinguishing attributes
like
.B service
@ -905,7 +905,7 @@ and
.BR !dk
specifying the private half of the key;
see
.IM rsa (3) .
.MR rsa (3) .
Conventionally,
.I rsa
keys also have
@ -972,7 +972,7 @@ attributes.
If the key is to be used for signing, it must also have a
.B !secret
attribute; see
.IM dsa (3) .
.MR dsa (3) .
Conventionally,
.I dsa
keys
@ -1019,4 +1019,4 @@ The response is a hexadecimal string of length 32.
.SH SOURCE
.B \*9/src/cmd/auth/factotum
.SH SEE ALSO
.IM ssh-agent (1)
.MR ssh-agent (1)

View file

@ -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
.IM font (7) ).
.MR 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
.IM graphics (3) )
.MR graphics (3) )
recognizes font paths beginning with
.B /mnt/font
and implements them by invoking
.IR fontsrv ;
it need not be running already.
See
.IM font (7)
.MR 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
.IM acme (1)
.MR 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
.IM sam (1)
.MR 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
.IM font (7)
.MR font (7)
.SH BUGS
.PP
Due to OS X restrictions,

View file

@ -148,10 +148,10 @@ will be named
The attach name used in
.I mount
(see
.IM bind (1) ,
.IM bind (2)
.MR bind (1) ,
.MR bind (2)
and
.IM attach (5) )
.MR 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
.IM attach (5) .
.MR 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
.IM fossilcons (8) ).
.MR 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
.IM fossilcons (8) .
.MR 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
.IM fossilcons (8)
.MR 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
.IM fossilcons (8) ).
.MR 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
.IM vac (1) ,
.MR 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
.IM fossilcons (8)
.MR 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
.IM yesterday (1) ,
.IM fs (3) ,
.IM fs (4) ,
.IM srv (4) ,
.IM fossilcons (8) ,
.IM loadfossil (8) ,
.IM venti (8)
.MR yesterday (1) ,
.MR fs (3) ,
.MR fs (4) ,
.MR srv (4) ,
.MR fossilcons (8) ,
.MR loadfossil (8) ,
.MR 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

View file

@ -48,7 +48,7 @@ the path have different meanings on the two systems.)
connects to
.I system
using
.IM ssh (1) .
.MR 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
.IM 9pserve (4) ,
.IM intro (4)
.MR 9pserve (4) ,
.MR intro (4)

View file

@ -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
.IM plumb (7)
.MR plumb (7)
messages between programs.
Its behavior is programmed by a
.I plumbing
file (default
.BR $HOME/lib/plumbing )
in the format of
.IM plumb (7) .
.MR plumb (7) .
.PP
Its services are posted via
.IM 9pserve (4)
.MR 9pserve (4)
as
.BR plumb ,
and consist of two
@ -39,14 +39,14 @@ for dispatching messages to applications.
Programs use
.B fswrite
(see
.IM 9pclient (3) )
.MR 9pclient (3) )
to deliver messages to the
.B send
file, and
.I fsread
to receive them from the corresponding port.
For example,
.IM sam (1) 's
.MR sam (1) 's
.B plumb
menu item or the
.B B
@ -115,13 +115,13 @@ statements
.TP
.B plumb
mount name for
.IM plumber (4) .
.MR plumber (4) .
.SH SOURCE
.B \*9/src/cmd/plumb
.SH "SEE ALSO"
.IM plumb (1) ,
.IM plumb (3) ,
.IM plumb (7)
.MR plumb (1) ,
.MR plumb (3) ,
.MR plumb (7)
.\" .SH BUGS
.\" .IR Plumber 's
.\" file name space is fixed, so it is difficult to plumb

View file

@ -21,7 +21,7 @@ By default
posts its service as
.B ramfs
using
.IM 9pserve (4) .
.MR 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"
.IM 9p (3) ,
.IM 9pserve (4)
.MR 9p (3) ,
.MR 9pserve (4)

View file

@ -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
.IM factotum (4)
.MR factotum (4)
using
.B server=smugmug.com
and
@ -32,7 +32,7 @@ and
(if any)
as key criteria
(see
.IM auth (3) ).
.MR 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
.IM mv (1)
.MR mv (1)
will resolve the problem.
.PP
Boolean values appear as

View file

@ -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
.IM intro (4) )
.MR intro (4) )
as
.I srvname
(default
@ -70,7 +70,7 @@ available as service
.IR sources .
.I 9fs
is an
.IM rc (1)
.MR 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
.IM dial (3) ,
.IM intro (4) ,
.IM netfiles (1)
.MR dial (3) ,
.MR intro (4) ,
.MR netfiles (1)

View file

@ -91,7 +91,7 @@ Tenth Edition research Unix systems (4KB block size).
.PP
.I Zipfs
interprets zip archives (see
.IM gzip (1) ).
.MR 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
.IM ramfs (4) .
.MR ramfs (4) .
.SH "SEE ALSO
.IM intro (7) ,
.IM ramfs (4) .
.MR intro (7) ,
.MR ramfs (4) .

View file

@ -26,7 +26,7 @@ vacfs \- a Venti-based file system
.SH DESCRIPTION
.I Vacfs
interprets the file system created by
.IM vac (1)
.MR 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
@ -81,6 +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"
.IM vac (1) ,
.MR vac (1) ,
Plan 9's
.IR venti (8)