Skip to content

Commit

Permalink
tmac: rename IM (italic manual) to MR (manual reference)
Browse files Browse the repository at this point in the history
Suggested by G. Brandon Robinson.
  • Loading branch information
rsc committed Aug 16, 2020
1 parent 9843fc0 commit d32deab
Show file tree
Hide file tree
Showing 286 changed files with 1,591 additions and 1,588 deletions.
148 changes: 74 additions & 74 deletions man/man1/0intro.1
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ they expect the
environment variable
to contain the name of the root of the tree.
See
.IM install (1)
.MR install (1)
for details about installation.
.PP
Many of the familiar Unix commands,
for example
.IM cat (1) ,
.IM ls (1) ,
.MR cat (1) ,
.MR ls (1) ,
and
.IM wc (1) ,
.MR wc (1) ,
are present, but in their Plan 9 forms:
.I cat
takes no options,
Expand All @@ -50,44 +50,44 @@ and
.I wc
counts UTF characters.
In some cases, the differences are quite noticeable:
.IM grep (1)
.MR grep (1)
and
.IM sed (1)
.MR sed (1)
expect Plan 9 regular expressions
(see
.IM regexp (7) ),
.MR regexp (7) ),
which are closest to what Unix calls extended regular expressions.
Because of these differences, it is not recommended to put
.B $PLAN9/bin
before the usual system
.B bin
directories in your search path.
Instead, put it at the end of your path and use the
.IM 9 (1)
.MR 9 (1)
script when you want to invoke the Plan 9 version of a
traditional Unix command.
.PP
Occasionally the Plan 9 programs have been
changed to adapt to Unix.
.IM Mk (1)
.MR Mk (1)
now allows mkfiles to choose their own shell,
and
.IM rc (1)
.MR rc (1)
has a
.I ulimit
builtin and manages
.BR $PATH .
.PP
Many of the graphical programs from Plan 9 are present,
including
.IM sam (1)
.MR sam (1)
and
.IM acme (1) .
.MR acme (1) .
An X11 window manager
.IM rio (1)
.MR rio (1)
mimics Plan 9's window system, with command windows
implemented by the external program
.IM 9term (1) .
.MR 9term (1) .
Following the style of X Windows, these programs run in new
windows rather than the one in which they are invoked.
They all take a
Expand All @@ -101,10 +101,10 @@ The argument is one of
\fIxmin\fL,\fIymin\fL,\fIxmax\fL,\fIymax\fR.
.PP
The
.IM plumber (4)
.MR plumber (4)
helps to connect the various Plan 9 programs together,
and fittings like
.IM web (1)
.MR web (1)
connect it to external programs such as web browsers;
one can click on a URL in
.I acme
Expand All @@ -119,17 +119,17 @@ with file servers by reading and writing files.
This cannot be done directly on Unix.
Instead the servers listen for 9P connections on Unix domain sockets;
clients connect to these sockets and speak 9P directly using the
.IM 9pclient (3)
.MR 9pclient (3)
library.
.IM Intro (4)
.MR Intro (4)
tells more of the story.
The effect is not as clean as on Plan 9, but it gets the job done
and still provides a uniform and easy-to-understand mechanism.
The
.IM 9p (1)
.MR 9p (1)
client can be used in shell scripts or by hand to carry out
simple interactions with servers.
.IM Netfiles (1)
.MR Netfiles (1)
is an experimental client for acme.
.SS External databases
Some programs rely on large databases that would be
Expand All @@ -146,7 +146,7 @@ The shell scripts
and
.I 9l
(see
.IM 9c (1) )
.MR 9c (1) )
provide a simple interface to the underlying system compiler and linker,
similar to the
.I 2c
Expand All @@ -165,22 +165,22 @@ so that no
options are needed.
.PP
The only way to write multithreaded programs is to use the
.IM thread (3)
.MR thread (3)
library.
.IM Rfork (3)
.MR Rfork (3)
exists but is not as capable as on Plan 9.
There are many unfortunate by necessary preprocessor
diversions to make Plan 9 and Unix libraries coexist.
See
.IM intro (3)
.MR intro (3)
for details.
.PP
The debuggers
.IM acid (1)
.MR acid (1)
and
.IM db (1)
.MR db (1)
and the debugging library
.IM mach (3)
.MR mach (3)
are works in progress.
They are platform-independent, so that x86 Linux core dumps
can be inspected on PowerPC Mac OS X machines,
Expand All @@ -203,22 +203,22 @@ but that it is the extent to which they have been developed and exercised.
.SS Porting programs
The vast majority of the familiar Plan 9 programs
have been ported, including the Unicode-aware
.IM troff (1) .
.MR troff (1) .
.PP
Of the more recent additions to Plan 9,
.IM factotum (4) ,
.IM secstore (1) ,
.MR factotum (4) ,
.MR secstore (1) ,
and
.IM secstored (1) ,
.IM vac (1) ,
.IM vacfs (4) ,
.MR secstored (1) ,
.MR vac (1) ,
.MR vacfs (4) ,
and
.IM venti (8)
.MR venti (8)
are all ported.
.PP
A backup system providing a dump file system built atop Venti
is in progress; see
.IM vbackup (8) .
.MR vbackup (8) .
.SS Porting to new systems
Porting the tree to new operating systems or architectures
should be straightforward, as system-specific code has been
Expand All @@ -240,9 +240,9 @@ need to write any system specific code at all.
.PP
There are other smaller system dependencies,
such as the terminal handling code in
.IM 9term (1)
.MR 9term (1)
and the implementation of
.IM getcallerpc (3) ,
.MR getcallerpc (3) ,
but these are usually simple and are not on the critical
path for getting the system up and running.
.SH SEE ALSO
Expand All @@ -255,7 +255,7 @@ The manual pages are in a Unix style tree, with names like
instead of Plan 9's simpler
.BR $PLAN9/man/1/cat ,
so that the Unix
.IM man (1)
.MR man (1)
utility can handle it.
Some systems, for example Debian Linux,
deduce the man page locations from the search path, so that
Expand Down Expand Up @@ -300,52 +300,52 @@ describes the Plan 9 file protocol 9P.
These pages describe parts of the system
that are new or different from Plan 9 from Bell Labs:
.IP
.IM 9 (1) ,
.IM 9c (1) ,
.IM 9p (1) ,
.IM 9term (1) ,
.MR 9 (1) ,
.MR 9c (1) ,
.MR 9p (1) ,
.MR 9term (1) ,
.I acidtypes
in
.IM acid (1) ,
.IM dial (1) ,
.IM git (1) ,
.IM label (1) ,
.MR acid (1) ,
.MR dial (1) ,
.MR git (1) ,
.MR label (1) ,
the
.B MKSHELL
variable in
.IM mk (1) ,
.IM namespace (1) ,
.IM netfiles (1) ,
.IM page (1) ,
.IM psfonts (1) ,
.IM rio (1) ,
.IM web (1) ,
.IM wintext (1)
.MR mk (1) ,
.MR namespace (1) ,
.MR netfiles (1) ,
.MR page (1) ,
.MR psfonts (1) ,
.MR rio (1) ,
.MR web (1) ,
.MR wintext (1)
.IP
.IM intro (3) ,
.IM 9pclient (3) ,
.MR intro (3) ,
.MR 9pclient (3) ,
the
.B unix
network in
.IM dial (3) ,
.IM exits (3) ,
.IM get9root (3) ,
.IM getns (3) ,
.IM notify (3) ,
.IM post9pservice (3) ,
.IM rfork (3) ,
.IM searchpath (3) ,
.IM sendfd (3) ,
.IM udpread (3) ,
.IM venti (3) ,
.IM wait (3) ,
.IM wctl (3)
.MR dial (3) ,
.MR exits (3) ,
.MR get9root (3) ,
.MR getns (3) ,
.MR notify (3) ,
.MR post9pservice (3) ,
.MR rfork (3) ,
.MR searchpath (3) ,
.MR sendfd (3) ,
.MR udpread (3) ,
.MR venti (3) ,
.MR wait (3) ,
.MR wctl (3)
.IP
.IM intro (4) ,
.IM 9pserve (4) ,
.IM import (4) ,
.MR intro (4) ,
.MR 9pserve (4) ,
.MR import (4) ,
.IP
.IM vbackup (8)
.MR vbackup (8)
.IP
.IR openfd (9p)
.SH DIAGNOSTICS
Expand All @@ -356,4 +356,4 @@ exit with string statuses. In fact, exiting with an empty status
corresponds to exiting with status 0,
and exiting with any non-empty string corresponds to exiting with status 1.
See
.IM exits (3) .
.MR exits (3) .
14 changes: 7 additions & 7 deletions man/man1/9.1
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
.B .
.B 9
(from
.IM sh (1) )
.MR sh (1) )
.PP
.B 9.rc
.I cmd
Expand All @@ -24,7 +24,7 @@
.B .
.B 9.rc
(from
.IM rc (1) )
.MR rc (1) )
.PP
.B u
.I cmd
Expand All @@ -36,7 +36,7 @@
.B .
.B u
(from
.IM sh (1) )
.MR sh (1) )
.PP
.B u.rc
.I cmd
Expand All @@ -48,7 +48,7 @@
.B .
.B u.rc
(from
.IM rc (1) )
.MR rc (1) )
.SH DESCRIPTION
Because Plan 9 supplies commands with the same name as but different
behavior than many basic Unix system commands
Expand Down Expand Up @@ -86,7 +86,7 @@ in order to make the current shell start running in the Plan 9 environment.
is the same as
.I 9
but written for use by the shell
.IM rc (1) .
.MR rc (1) .
.PP
.I U
and
Expand All @@ -106,7 +106,7 @@ $ 9 grep '[α-ζ]' /etc/passwd
.EE
.PP
Start an
.IM rc (1)
.MR rc (1)
with the Plan 9 commands in the path before the system commands,
and then run the Unix
.IR ls :
Expand All @@ -124,7 +124,7 @@ $ 9 rc
.br
.B \*9/bin/u.rc
.SH SEE ALSO
.IM intro (1)
.MR intro (1)
.SH BUGS
Some shell configurations
(notably, oh-my-zsh)
Expand Down
2 changes: 1 addition & 1 deletion man/man1/9c.1
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ With
.BR t ,
give a long listing of all information about the files,
somewhat like a listing by
.IM ls (1) ,
.MR ls (1) ,
showing
.br
.ns
Expand Down
Loading

0 comments on commit d32deab

Please sign in to comment.