summaryrefslogtreecommitdiffstats
path: root/man/man3/plumb.3
diff options
context:
space:
mode:
authorDmitri Vereshchagin <dmitri.vereshchagin@gmail.com>2024-01-31 20:47:13 +0300
committerDan Cross <crossd@gmail.com>2025-07-27 09:58:50 -0400
commit10564b11755ff2d48d0f5073c46571e806fa6fb4 (patch)
tree229252742051d83558fff2352642d0f57ba66615 /man/man3/plumb.3
parent00446db7d8fdb3ea56fa104643b34823960f7be2 (diff)
downloadplan9port-10564b11755ff2d48d0f5073c46571e806fa6fb4.tar.gz
plan9port-10564b11755ff2d48d0f5073c46571e806fa6fb4.zip
tmac/tmac.an: define .MR in a groff compatible way
groff 1.23.0 added .MR to its -man macro package. The NEWS file states that the inclusion of the macro "was prompted by its introduction to Plan 9 from User Space's troff in August 2020." From d32deab it seems that the name for Plan 9 from User Space's implementation was suggested by groff maintainer G. Brandon Robinson. Not sure if the intention was to make these definitions compatible, but it would be nice if they were. Currently, Plan 9 from User Space's .MR expects its second argument to be parenthesized. groff's .MR does not. This results in extra parentheses appearing in manual references when viewing Plan 9 from User Space's manual pages on a system using groff.
Diffstat (limited to 'man/man3/plumb.3')
-rw-r--r--man/man3/plumb.324
1 files changed, 12 insertions, 12 deletions
diff --git a/man/man3/plumb.3 b/man/man3/plumb.3
index 409c40bc..217647fd 100644
--- a/man/man3/plumb.3
+++ b/man/man3/plumb.3
@@ -68,7 +68,7 @@ Plumbmsg* plumbrecvfid(CFid *fid)
int plumbsendtofid(CFid *fid, Plumbmsg *m)
.SH DESCRIPTION
These routines manipulate
-.MR plumb (7)
+.MR plumb 7
messages, transmitting them, receiving them, and
converting them between text and these data structures:
.IP
@@ -99,7 +99,7 @@ struct Plumbattr
opens the named plumb
.IR port ,
using
-.MR open (3)
+.MR open 3
mode
.IR omode .
If
@@ -108,11 +108,11 @@ begins with a slash, it is taken as a literal file name;
otherwise
.I plumbopen
searches for the location of the
-.MR plumber (4)
+.MR plumber 4
service and opens the port there.
.PP
For programs using the
-.MR event (3)
+.MR event 3
interface,
.I eplumb
registers, using the given
@@ -121,9 +121,9 @@ receipt of messages from the named
.IR port .
.PP
The library mounts the
-.MR plumber (4)
+.MR plumber 4
service on demand (using the
-.MR 9pclient (3) )
+.MR 9pclient 3 )
library and reuses the mount instance for future
calls to
.IR plumbopen .
@@ -157,7 +157,7 @@ to
frees all the data associated with the message
.IR m ,
all the components of which must therefore have been allocated with
-.MR malloc (3) .
+.MR malloc 3 .
.PP
.I Plumbrecv
returns the next message available on the file descriptor
@@ -259,7 +259,7 @@ The file descriptor returned by
is created with
.I fsopenfd
(see
-.MR 9pclient (3) ),
+.MR 9pclient 3 ),
which masks information about read and write errors.
This is acceptable for use in
.I plumbrecv
@@ -276,10 +276,10 @@ that preserves the exact error details.
.SH SOURCE
.B \*9/src/libplumb
.SH SEE ALSO
-.MR plumb (1) ,
-.MR event (3) ,
-.MR plumber (4) ,
-.MR plumb (7)
+.MR plumb 1 ,
+.MR event 3 ,
+.MR plumber 4 ,
+.MR plumb 7
.SH DIAGNOSTICS
When appropriate, including when a
.I plumbsend