aboutsummaryrefslogtreecommitdiff
path: root/man/man3/plumb.3
diff options
context:
space:
mode:
authorRuss Cox <rsc@swtch.com>2020-08-13 23:41:59 -0400
committerRuss Cox <rsc@swtch.com>2020-08-13 23:43:43 -0400
commit977b25a76ae8263e53fb4eb1abfc395769f23e3d (patch)
treeb04cc1be9205fd85f588e9434642e8aed8a8a4fd /man/man3/plumb.3
parenta1c4307800c7f1ef9c5d71ba4c6c3642837e2877 (diff)
downloadplan9port-977b25a76ae8263e53fb4eb1abfc395769f23e3d.tar.gz
plan9port-977b25a76ae8263e53fb4eb1abfc395769f23e3d.tar.bz2
plan9port-977b25a76ae8263e53fb4eb1abfc395769f23e3d.zip
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.
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 fa78a2b5..28185a88 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
-.IR plumb (7)
+.IM 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
-.IR open (3)
+.IM 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
-.IR plumber (4)
+.IM plumber (4)
service and opens the port there.
.PP
For programs using the
-.IR event (3)
+.IM 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
-.IR plumber (4)
+.IM plumber (4)
service on demand (using the
-.IR 9pclient (3))
+.IM 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
-.IR malloc (3).
+.IM 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
-.IR 9pclient (3)),
+.IM 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
-.IR plumb (1),
-.IR event (3),
-.IR plumber (4),
-.IR plumb (7)
+.IM plumb (1) ,
+.IM event (3) ,
+.IM plumber (4) ,
+.IM plumb (7)
.SH DIAGNOSTICS
When appropriate, including when a
.I plumbsend