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/man3/thread.3 | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'man/man3/thread.3') diff --git a/man/man3/thread.3 b/man/man3/thread.3 index 9088ae2e..41ac565f 100644 --- a/man/man3/thread.3 +++ b/man/man3/thread.3 @@ -267,10 +267,10 @@ in arbitrary ways and should synchronize their actions using .B qlocks (see -.IR lock (3)) +.IM lock (3) ) or channel communication. System calls such as -.IR read (3) +.IM read (3) block the entire proc; all threads in a proc block until the system call finishes. .PP @@ -364,7 +364,7 @@ are threaded analogues of and .I execl (see -.IR exec (3)); +.IM exec (3) ); on success, they replace the calling thread and invoke the external program, never returning. @@ -400,7 +400,7 @@ and .I threadexec will duplicate (see -.IR dup (3)) +.IM dup (3) ) the three file descriptors in .I fd onto standard input, output, and error for the external program @@ -443,14 +443,14 @@ stop the running of the program. returns a channel of pointers to .B Waitmsg structures (see -.IR wait (3)). +.IM wait (3) ). When an exec'ed process exits, a pointer to a .B Waitmsg is sent to this channel. These .B Waitmsg structures have been allocated with -.IR malloc (3) +.IM malloc (3) and should be freed after use. .PP A @@ -611,13 +611,13 @@ calls. .PP .I Chanprint formats its arguments in the manner of -.IR print (3) +.IM print (3) and sends the result to the channel .IR c. The string delivered by .I chanprint is allocated with -.IR malloc (3) +.IM malloc (3) and should be freed upon receipt. .PP Thread library functions do not return on failure; @@ -628,10 +628,10 @@ Threaded programs should use in place of .I atnotify (see -.IR notify (3)). +.IM notify (3) ). .PP It is safe to use -.IR sysfatal (3) +.IM sysfatal (3) in threaded programs. .I Sysfatal will print the error string and call @@ -673,7 +673,7 @@ To create new processes, use .SH FILES .B \*9/acid/thread contains useful -.IR acid (1) +.IM acid (1) functions for debugging threaded programs. .PP .B \*9/src/libthread/test @@ -681,8 +681,8 @@ contains some example programs. .SH SOURCE .B \*9/src/libthread .SH SEE ALSO -.IR intro (3), -.IR ioproc (3) +.IM intro (3) , +.IM ioproc (3) .SH BUGS To avoid name conflicts, .IR alt , @@ -707,7 +707,7 @@ and so on. is defined as a macro that expands to .IR threadyield . See -.IR intro (3). +.IM intro (3) . .PP Threadint, threadintgrp, -- 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/man3/thread.3 | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'man/man3/thread.3') diff --git a/man/man3/thread.3 b/man/man3/thread.3 index 41ac565f..6c6b4602 100644 --- a/man/man3/thread.3 +++ b/man/man3/thread.3 @@ -267,10 +267,10 @@ in arbitrary ways and should synchronize their actions using .B qlocks (see -.IM lock (3) ) +.MR lock (3) ) or channel communication. System calls such as -.IM read (3) +.MR read (3) block the entire proc; all threads in a proc block until the system call finishes. .PP @@ -364,7 +364,7 @@ are threaded analogues of and .I execl (see -.IM exec (3) ); +.MR exec (3) ); on success, they replace the calling thread and invoke the external program, never returning. @@ -400,7 +400,7 @@ and .I threadexec will duplicate (see -.IM dup (3) ) +.MR dup (3) ) the three file descriptors in .I fd onto standard input, output, and error for the external program @@ -443,14 +443,14 @@ stop the running of the program. returns a channel of pointers to .B Waitmsg structures (see -.IM wait (3) ). +.MR wait (3) ). When an exec'ed process exits, a pointer to a .B Waitmsg is sent to this channel. These .B Waitmsg structures have been allocated with -.IM malloc (3) +.MR malloc (3) and should be freed after use. .PP A @@ -611,13 +611,13 @@ calls. .PP .I Chanprint formats its arguments in the manner of -.IM print (3) +.MR print (3) and sends the result to the channel .IR c. The string delivered by .I chanprint is allocated with -.IM malloc (3) +.MR malloc (3) and should be freed upon receipt. .PP Thread library functions do not return on failure; @@ -628,10 +628,10 @@ Threaded programs should use in place of .I atnotify (see -.IM notify (3) ). +.MR notify (3) ). .PP It is safe to use -.IM sysfatal (3) +.MR sysfatal (3) in threaded programs. .I Sysfatal will print the error string and call @@ -673,7 +673,7 @@ To create new processes, use .SH FILES .B \*9/acid/thread contains useful -.IM acid (1) +.MR acid (1) functions for debugging threaded programs. .PP .B \*9/src/libthread/test @@ -681,8 +681,8 @@ contains some example programs. .SH SOURCE .B \*9/src/libthread .SH SEE ALSO -.IM intro (3) , -.IM ioproc (3) +.MR intro (3) , +.MR ioproc (3) .SH BUGS To avoid name conflicts, .IR alt , @@ -707,7 +707,7 @@ and so on. is defined as a macro that expands to .IR threadyield . See -.IM intro (3) . +.MR intro (3) . .PP Threadint, threadintgrp, -- cgit v1.2.3