Prepare for `MR` macro migration. Rewrite man page cross references in normally filled, adjusted text outside of tbl(1) tables to use man(7) macros instead of troff(1) font selection escape sequences. $ cat fix-man-page-refs-not-in-tbl-tables.sed # Rewrite man page cross references in normally filled, adjusted text # outside of tbl(1) tables to use man(7) macros instead of troff(1) font # selection escape sequences. /^\.\\"/b # Case: # \fBgetgid\fP(2) and \fBgetegid\fP(2). s/^\\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\) \(.*\)/.BR \1 \2\ \3/ # Case: # Old versions of \fBxterm\fP(1), for example, from X11R5, s/ \\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\)\([^ ]\+\) \(.*\)$/\ .BR \1 \2\3\ \4/ # Case: # and \fBgetegid\fP(2). s/ \\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\)\([^ ]\+\)$/\ .BR \1 \2\3/ # Case: # is a variant of \fBadjtimex\fP(2) that uses \fIstruct timeval32\fP, s/ \\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\) /\ .BR \1 \2\ / # Case: # use \fBpthread_mutexattr_settype\fP(3) s/ \\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\)$/\ .BR \1 \2/ # Case: # \fBpthread_condattr_init\fP(3), s/\\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\)\([^ ]\+\)/.BR \1 \2\3/ Signed-off-by: "G. Branden Robinson" <g.branden.robinson@xxxxxxxxx> --- man/man2/syscalls.2 | 16 ++++++-- man/man3/pthread_cond_init.3 | 15 ++++--- man/man3/pthread_condattr_init.3 | 5 ++- man/man3/pthread_mutex_init.3 | 10 +++-- man/man3/pthread_mutexattr_setkind_np.3 | 10 +++-- man/man3/uselocale.3 | 5 ++- man/man4/console_codes.4 | 54 ++++++++++++++++++------- man/man5/core.5 | 3 +- 8 files changed, 81 insertions(+), 37 deletions(-) diff --git a/man/man2/syscalls.2 b/man/man2/syscalls.2 index 76c3e1ae3..64699c1c7 100644 --- a/man/man2/syscalls.2 +++ b/man/man2/syscalls.2 @@ -2116,21 +2116,29 @@ .SS "Architecture-specific details: Alpha" returns a pair of GID and effective GID via registers \fBr0\fP and \fBr20\fP; it is provided instead of -\fBgetgid\fP(2) and \fBgetegid\fP(2). +.BR getgid (2) +and +.BR getegid (2). .TP .BR getxpid (2) returns a pair of PID and parent PID via registers \fBr0\fP and \fBr20\fP; it is provided instead of -\fBgetpid\fP(2) and \fBgetppid\fP(2). +.BR getpid (2) +and +.BR getppid (2). .TP .BR old_adjtimex (2) -is a variant of \fBadjtimex\fP(2) that uses \fIstruct timeval32\fP, +is a variant of +.BR adjtimex (2) +that uses \fIstruct timeval32\fP, for compatibility with OSF/1. .TP .BR getxuid (2) returns a pair of GID and effective GID via registers \fBr0\fP and \fBr20\fP; it is provided instead of -\fBgetuid\fP(2) and \fBgeteuid\fP(2). +.BR getuid (2) +and +.BR geteuid (2). .TP .BR sethae (2) is used for configuring the Host Address Extension register on diff --git a/man/man3/pthread_cond_init.3 b/man/man3/pthread_cond_init.3 index 42e7eacd1..4e35bc6a5 100644 --- a/man/man3/pthread_cond_init.3 +++ b/man/man3/pthread_cond_init.3 @@ -98,7 +98,10 @@ .SH DESCRIPTION the mutex \fImutex\fP is re-acquired and \fBpthread_cond_timedwait\fP returns the error \fBETIMEDOUT\fP. The \fIabstime\fP parameter specifies an absolute time, -with the same origin as \fBtime\fP(2) and \fBgettimeofday\fP(2): +with the same origin as +.BR time (2) +and +.BR gettimeofday (2): an \fIabstime\fP of 0 corresponds to 00:00:00 GMT, January 1, 1970. .P @@ -168,11 +171,11 @@ .SH ERRORS . . .SH "SEE ALSO" -\fBpthread_condattr_init\fP(3), -\fBpthread_mutex_lock\fP(3), -\fBpthread_mutex_unlock\fP(3), -\fBgettimeofday\fP(2), -\fBnanosleep\fP(2). +.BR pthread_condattr_init (3), +.BR pthread_mutex_lock (3), +.BR pthread_mutex_unlock (3), +.BR gettimeofday (2), +.BR nanosleep (2). . . .SH EXAMPLE diff --git a/man/man3/pthread_condattr_init.3 b/man/man3/pthread_condattr_init.3 index 0f7c60d4d..df266efe1 100644 --- a/man/man3/pthread_condattr_init.3 +++ b/man/man3/pthread_condattr_init.3 @@ -23,7 +23,8 @@ .SH SYNOPSIS .SH DESCRIPTION Condition attributes can be specified at condition creation time, by passing a condition attribute object -as second argument to \fBpthread_cond_init\fP(3). +as second argument to +.BR pthread_cond_init (3). Passing \fBNULL\fP is equivalent to passing a condition attribute object with all attributes set to their default values. @@ -45,4 +46,4 @@ .SH "RETURN VALUE" . . .SH "SEE ALSO" -\fBpthread_cond_init\fP(3). +.BR pthread_cond_init (3). diff --git a/man/man3/pthread_mutex_init.3 b/man/man3/pthread_mutex_init.3 index 1c743ce97..224a990a5 100644 --- a/man/man3/pthread_mutex_init.3 +++ b/man/man3/pthread_mutex_init.3 @@ -60,7 +60,9 @@ .SH DESCRIPTION The kind of a mutex determines whether it can be locked again by a thread that already owns it. The default kind is ``fast''. -See \fBpthread_mutexattr_init\fP(3) for more information on mutex attributes. +See +.BR pthread_mutexattr_init (3) +for more information on mutex attributes. .P Variables of type \fBpthread_mutex_t\fP can also be initialized statically, using the constants @@ -207,9 +209,9 @@ .SH ERRORS . . .SH "SEE ALSO" -\fBpthread_mutexattr_init\fP(3), -\fBpthread_mutexattr_setkind_np\fP(3), -\fBpthread_cancel\fP(3). +.BR pthread_mutexattr_init (3), +.BR pthread_mutexattr_setkind_np (3), +.BR pthread_cancel (3). . . .SH EXAMPLE diff --git a/man/man3/pthread_mutexattr_setkind_np.3 b/man/man3/pthread_mutexattr_setkind_np.3 index 11a24e83f..9b5399da0 100644 --- a/man/man3/pthread_mutexattr_setkind_np.3 +++ b/man/man3/pthread_mutexattr_setkind_np.3 @@ -25,8 +25,10 @@ .SH SYNOPSIS . .SH DESCRIPTION These functions are deprecated, -use \fBpthread_mutexattr_settype\fP(3) -and \fBpthread_mutexattr_gettype\fP(3) +use +.BR pthread_mutexattr_settype (3) +and +.BR pthread_mutexattr_gettype (3) instead. . . @@ -51,5 +53,5 @@ .SH ERRORS . . .SH "SEE ALSO" -\fBpthread_mutexattr_settype\fP(3), -\fBpthread_mutexattr_gettype\fP(3). +.BR pthread_mutexattr_settype (3), +.BR pthread_mutexattr_gettype (3). diff --git a/man/man3/uselocale.3 b/man/man3/uselocale.3 index 7ef33ca25..315d9d255 100644 --- a/man/man3/uselocale.3 +++ b/man/man3/uselocale.3 @@ -42,7 +42,10 @@ .SH DESCRIPTION .I newloc argument can have one of the following values: .TP -A handle returned by a call to \fBnewlocale\fP(3) or \fBduplocale\fP(3) +A handle returned by a call to +.BR newlocale (3) +or +.BR duplocale (3) The calling thread's current locale is set to the specified locale. .TP The special locale object handle \fBLC_GLOBAL_LOCALE\fP diff --git a/man/man4/console_codes.4 b/man/man4/console_codes.4 index a12d21660..3d86df444 100644 --- a/man/man4/console_codes.4 +++ b/man/man4/console_codes.4 @@ -580,7 +580,8 @@ .SS Mouse tracking daemon. .P The mouse tracking escape sequences generated by -\fBxterm\fP(1) encode numeric parameters in a single character as +.BR xterm (1) +encode numeric parameters in a single character as \fIvalue\fP+040. For example, \[aq]!\[aq] is 1. The screen coordinate system is 1-based. @@ -588,7 +589,9 @@ .SS Mouse tracking The X10 compatibility mode sends an escape sequence on button press encoding the location and the mouse button pressed. It is enabled by sending ESC [ ? 9 h and disabled with ESC [ ? 9 l. -On button press, \fBxterm\fP(1) sends +On button press, +.BR xterm (1) +sends ESC [ M \fIbxy\fP (6 characters). Here \fIb\fP is button\-1, and \fIx\fP and \fIy\fP are the x and y coordinates of the mouse @@ -600,7 +603,9 @@ .SS Mouse tracking Modifier information is also sent. It is enabled by sending ESC [ ? 1000 h and disabled with ESC [ ? 1000 l. -On button press or release, \fBxterm\fP(1) sends ESC [ M +On button press or release, +.BR xterm (1) +sends ESC [ M \fIbxy\fP. The low two bits of \fIb\fP encode button information: 0=MB1 pressed, 1=MB2 pressed, 2=MB3 pressed, 3=release. @@ -674,14 +679,18 @@ .SS Comparisons with other terminals the DEC special character and line drawing set, UK, and US-ASCII, respectively. .P -The user can configure \fBxterm\fP(1) to respond to VT220-specific +The user can configure +.BR xterm (1) +to respond to VT220-specific control sequences, and it will identify itself as a VT52, VT100, and up depending on the way it is configured and initialized. .P It accepts ESC ] (OSC) for the setting of certain resources. In addition to the ECMA-48 string terminator (ST), -\fBxterm\fP(1) accepts a BEL to terminate an OSC string. -These are a few of the OSC control sequences recognized by \fBxterm\fP(1): +.BR xterm (1) +accepts a BEL to terminate an OSC string. +These are a few of the OSC control sequences recognized by +.BR xterm (1): .TS l l. ESC ] 0 ; \fItxt\fP ST T{ @@ -730,7 +739,9 @@ .SS Comparisons with other terminals .P .B CSI Sequences .P -Old versions of \fBxterm\fP(1), for example, from X11R5, +Old versions of +.BR xterm (1), +for example, from X11R5, interpret the blink SGR as a bold SGR. Later versions which implemented ANSI colors, for example, XFree86 3.1.2A in 1995, improved this by allowing @@ -741,13 +752,17 @@ .SS Comparisons with other terminals the X11R6.8 release, which incorporated XFree86 xterm. All ECMA-48 CSI sequences recognized by Linux are also recognized by .IR xterm , -however \fBxterm\fP(1) implements several ECMA-48 and DEC control sequences +however +.BR xterm (1) +implements several ECMA-48 and DEC control sequences not recognized by Linux. .P -The \fBxterm\fP(1) +The +.BR xterm (1) program recognizes all of the DEC Private Mode sequences listed above, but none of the Linux private-mode sequences. -For discussion of \fBxterm\fP(1)'s +For discussion of +.BR xterm (1)'s own private-mode sequences, refer to the \fIXterm Control Sequences\fP document by @@ -773,7 +788,9 @@ .SS Comparisons with other terminals .RE .P demonstrates many of these control sequences. -The \fBxterm\fP(1) source distribution also contains sample +The +.BR xterm (1) +source distribution also contains sample scripts which exercise other features. .SH NOTES ESC 8 (DECRC) is not able to restore the character set changed with @@ -796,15 +813,22 @@ .SH BUGS In particular, those ending with ] do not use a standard terminating character. The OSC (set palette) sequence is a greater problem, -since \fBxterm\fP(1) may interpret this as a control sequence +since +.BR xterm (1) +may interpret this as a control sequence which requires a string terminator (ST). -Unlike the \fBsetterm\fP(1) sequences which will be ignored (since +Unlike the +.BR setterm (1) +sequences which will be ignored (since they are invalid control sequences), the palette sequence will make -\fBxterm\fP(1) appear to hang (though pressing the return-key +.BR xterm (1) +appear to hang (though pressing the return-key will fix that). To accommodate applications which have been hardcoded to use Linux control sequences, -set the \fBxterm\fP(1) resource \fBbrokenLinuxOSC\fP to true. +set the +.BR xterm (1) +resource \fBbrokenLinuxOSC\fP to true. .P An older version of this document implied that Linux recognizes the ECMA-48 control sequence for invisible text. diff --git a/man/man5/core.5 b/man/man5/core.5 index 7f074ea14..011e94e47 100644 --- a/man/man5/core.5 +++ b/man/man5/core.5 @@ -178,7 +178,8 @@ .SS Naming of core dump files Numeric real GID of dumped process. .TP %h -Hostname (same as \fInodename\fP returned by \fBuname\fP(2)). +Hostname (same as \fInodename\fP returned by +.BR uname (2)). .TP %i TID of thread that triggered core dump, -- 2.30.2
Attachment:
signature.asc
Description: PGP signature