From c84371c688847344ff9cdfe96b731f94f9ff0e2c Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Wed, 20 Jun 2007 21:53:34 +0000 Subject: [PATCH] Italics for header file references --- man2/ioctl_list.2 | 2 +- man2/mlock.2 | 6 +++--- man2/mmap.2 | 2 +- man2/modify_ldt.2 | 2 +- man2/mount.2 | 6 +++--- man2/msgctl.2 | 4 ++-- man2/msync.2 | 2 +- man2/poll.2 | 2 +- man2/ptrace.2 | 4 ++-- man2/sched_get_priority_max.2 | 2 +- man2/sched_rr_get_interval.2 | 2 +- man2/sched_setparam.2 | 2 +- man2/sched_setscheduler.2 | 2 +- man2/sched_yield.2 | 2 +- man2/semctl.2 | 8 ++++---- man2/shmctl.2 | 4 ++-- man2/signal.2 | 4 ++-- man2/statfs.2 | 4 ++-- man3/atoi.3 | 2 +- man3/clock_getres.3 | 2 +- man3/insque.3 | 6 +++--- man3/nl_langinfo.3 | 2 +- man3/posix_memalign.3 | 8 ++++---- man3/realpath.3 | 8 ++++---- man3/sigsetops.3 | 2 +- man3/stdin.3 | 2 +- man4/fd.4 | 4 ++-- man5/resolv.conf.5 | 6 +++--- man7/bootparam.7 | 2 +- man7/ip.7 | 2 +- 30 files changed, 53 insertions(+), 53 deletions(-) diff --git a/man2/ioctl_list.2 b/man2/ioctl_list.2 index 4e184a6a4d..5a5e520c8f 100644 --- a/man2/ioctl_list.2 +++ b/man2/ioctl_list.2 @@ -69,7 +69,7 @@ followed by an 8-bit type (collecting the ioctls in groups for a common purpose or a common driver), and an 8-bit serial number. .LP -The macros describing this structure live in +The macros describing this structure live in \fI\fP and are _IO(type,nr) and {_IOR,_IOW,_IOWR}(type,nr,size). They use sizeof(size) so that size is a misnomer here: this third parameter is a data type. diff --git a/man2/mlock.2 b/man2/mlock.2 index 43bc58b545..887878fa18 100644 --- a/man2/mlock.2 +++ b/man2/mlock.2 @@ -199,10 +199,10 @@ and .BR munlock () are available, .B _POSIX_MEMLOCK_RANGE -is defined in and the number of bytes in a page +is defined in \fI\fP and the number of bytes in a page can be determined from the constant .B PAGESIZE -(if defined) in or by calling +(if defined) in \fI\fP or by calling .IR sysconf(_SC_PAGESIZE) . On POSIX systems on which @@ -211,7 +211,7 @@ and .BR munlockall () are available, .B _POSIX_MEMLOCK -is defined in to a value greater than 0. (See also +is defined in \fI\fP to a value greater than 0. (See also .BR sysconf (3).) .\" POSIX.1-2001: It shall be defined to -1 or 0 or 200112L. .\" -1: unavailable, 0: ask using sysconf(). diff --git a/man2/mmap.2 b/man2/mmap.2 index 99825498af..aa7de5ad4d 100644 --- a/man2/mmap.2 +++ b/man2/mmap.2 @@ -432,7 +432,7 @@ and .BR munmap () are available, .B _POSIX_MAPPED_FILES -is defined in to a value greater than 0. (See also +is defined in \fI\fP to a value greater than 0. (See also .BR sysconf (3).) .\" POSIX.1-2001: It shall be defined to -1 or 0 or 200112L. .\" -1: unavailable, 0: ask using sysconf(). diff --git a/man2/modify_ldt.2 b/man2/modify_ldt.2 index 103787e07a..9fd24949dd 100644 --- a/man2/modify_ldt.2 +++ b/man2/modify_ldt.2 @@ -67,7 +67,7 @@ must equal the size of this structure. The .I user_desc -structure is defined in as: +structure is defined in \fI\fP as: .in +0.25i .nf diff --git a/man2/mount.2 b/man2/mount.2 index 8f853ff33d..c9d0e1f582 100644 --- a/man2/mount.2 +++ b/man2/mount.2 @@ -86,8 +86,8 @@ The argument may have the magic number 0xC0ED (\fBMS_MGC_VAL\fP) in the top 16 bits (this was required in kernel versions prior to 2.4, but is no longer required and ignored if specified), -and various mount flags (as defined in for libc4 and libc5 -and in for glibc2) in the low order 16 bits: +and various mount flags (as defined in \fI\fP for libc4 and libc5 +and in \fI\fP for glibc2) in the low order 16 bits: .\" FIXME 2.6.15 added flags for "shared sub-tree" functionality: .\" MS_UNBINDABLE, MS_PRIVATE, MS_SHARED, MS_SLAVE .\" These need to be documented on this page. @@ -400,7 +400,7 @@ leaving only \fIumount(dir)\fP (since now devices can be mounted in more than one place, so specifying the device does not suffice). .LP The original MS_SYNC flag was renamed MS_SYNCHRONOUS in 1.1.69 -when a different MS_SYNC was added to . +when a different MS_SYNC was added to \fI\fP. .LP Before Linux 2.4 an attempt to execute a set-user-ID or set-group-ID program on a filesystem mounted with diff --git a/man2/msgctl.2 b/man2/msgctl.2 index f759d0cd00..d04aaf54a6 100644 --- a/man2/msgctl.2 +++ b/man2/msgctl.2 @@ -57,7 +57,7 @@ on the message queue with identifier .PP The .I msqid_ds -data structure is defined in as follows: +data structure is defined in \fI\fP as follows: .nf .in +4n @@ -80,7 +80,7 @@ struct msqid_ds { .PP The .I ipc_perm -structure is defined in as follows +structure is defined in \fI\fP as follows (the highlighted fields are settable using .BR IPC_SET ): .PP diff --git a/man2/msync.2 b/man2/msync.2 index fa3c0d883e..f93fb1d68e 100644 --- a/man2/msync.2 +++ b/man2/msync.2 @@ -101,7 +101,7 @@ is available, both .B _POSIX_MAPPED_FILES and .B _POSIX_SYNCHRONIZED_IO -are defined in to a value greater than 0. +are defined in \fI\fP to a value greater than 0. (See also .BR sysconf (3).) .\" POSIX.1-2001: It shall be defined to -1 or 0 or 200112L. diff --git a/man2/poll.2 b/man2/poll.2 index 4d3934dc86..e41a837c21 100644 --- a/man2/poll.2 +++ b/man2/poll.2 @@ -114,7 +114,7 @@ The bits that may be set/returned in .I events and .I revents -are defined in : +are defined in \fI\fP: .RS .TP .B POLLIN diff --git a/man2/ptrace.2 b/man2/ptrace.2 index ea3c57e2ef..b00b15f4c2 100644 --- a/man2/ptrace.2 +++ b/man2/ptrace.2 @@ -121,7 +121,7 @@ Reads a word at offset in the child's .B USER area, which holds the registers and other information about the process -(see and ). +(see \fI\fP and ). The word is returned as the result of the .BR ptrace () call. @@ -153,7 +153,7 @@ area are disallowed. PTRACE_GETREGS, PTRACE_GETFPREGS Copies the child's general purpose or floating-point registers, respectively, to location \fIdata\fP in the parent. -See for information on +See \fI\fP for information on the format of this data. (\fIaddr\fP is ignored.) .TP PTRACE_GETSIGINFO (since Linux 2.3.99-pre6) diff --git a/man2/sched_get_priority_max.2 b/man2/sched_get_priority_max.2 index bed583e36f..72bf6fcc7d 100644 --- a/man2/sched_get_priority_max.2 +++ b/man2/sched_get_priority_max.2 @@ -83,7 +83,7 @@ and .BR sched_get_priority_min () are available define .I _POSIX_PRIORITY_SCHEDULING -in . +in \fI\fP. .SH "RETURN VALUE" On success, .BR sched_get_priority_max () diff --git a/man2/sched_rr_get_interval.2 b/man2/sched_rr_get_interval.2 index aee0d082a9..ca404e370a 100644 --- a/man2/sched_rr_get_interval.2 +++ b/man2/sched_rr_get_interval.2 @@ -64,7 +64,7 @@ POSIX systems on which .BR sched_rr_get_interval () is available define .I _POSIX_PRIORITY_SCHEDULING -in . +in \fI\fP. .SH "RETURN VALUE" On success, .BR sched_rr_get_interval () diff --git a/man2/sched_setparam.2 b/man2/sched_setparam.2 index c8d5a4ce61..50ecd530db 100644 --- a/man2/sched_setparam.2 +++ b/man2/sched_setparam.2 @@ -84,7 +84,7 @@ and .BR sched_getparam () are available define .I _POSIX_PRIORITY_SCHEDULING -in . +in \fI\fP. .SH "RETURN VALUE" On success, .BR sched_setparam () diff --git a/man2/sched_setscheduler.2 b/man2/sched_setscheduler.2 index 3452ede535..2f8f2899a8 100644 --- a/man2/sched_setscheduler.2 +++ b/man2/sched_setscheduler.2 @@ -293,7 +293,7 @@ and .BR sched_getscheduler () are available define .I _POSIX_PRIORITY_SCHEDULING -in . +in \fI\fP. .SH "RETURN VALUE" On success, .BR sched_setscheduler () diff --git a/man2/sched_yield.2 b/man2/sched_yield.2 index 130dba49a6..79c2428915 100644 --- a/man2/sched_yield.2 +++ b/man2/sched_yield.2 @@ -49,7 +49,7 @@ POSIX systems on which .BR sched_yield () is available define .I _POSIX_PRIORITY_SCHEDULING -in . +in \fI\fP. .SH "RETURN VALUE" On success, .BR sched_yield () diff --git a/man2/semctl.2 b/man2/semctl.2 index 42ec724404..1bf636e133 100644 --- a/man2/semctl.2 +++ b/man2/semctl.2 @@ -78,7 +78,7 @@ union semun { .PP The .I semid_ds -data structure is defined in as follows: +data structure is defined in \fI\fP as follows: .nf .in +4n @@ -93,7 +93,7 @@ struct semid_ds { .PP The .I ipc_perm -structure is defined in as follows +structure is defined in \fI\fP as follows (the highlighted fields are settable using .BR IPC_SET ): .PP @@ -479,12 +479,12 @@ a recompilation under glibc-2.1.91 or later should suffice. .PP In some earlier versions of glibc, the .I semun -union was defined in , but POSIX.1-2001 requires +union was defined in \fI\fP, but POSIX.1-2001 requires that the caller define this union. On versions of glibc where this union is \fInot\fP defined, the macro .B _SEM_SEMUN_UNDEFINED -is defined in . +is defined in \fI\fP. .PP The following system limit on semaphore sets affects a .BR semctl () diff --git a/man2/shmctl.2 b/man2/shmctl.2 index f2aebe0688..d5fd2b5253 100644 --- a/man2/shmctl.2 +++ b/man2/shmctl.2 @@ -60,7 +60,7 @@ on the shared memory segment whose identifier is given in The .I buf argument is a pointer to a \fIshmid_ds\fP structure, -defined in as follows: +defined in \fI\fP as follows: .PP .in +4n .nf @@ -80,7 +80,7 @@ struct shmid_ds { .PP The .I ipc_perm -structure is defined in as follows +structure is defined in \fI\fP as follows (the highlighted fields are settable using .BR IPC_SET ): .PP diff --git a/man2/signal.2 b/man2/signal.2 index 3b18415429..7a1a82e9f9 100644 --- a/man2/signal.2 +++ b/man2/signal.2 @@ -157,9 +157,9 @@ new instances of this signal from occurring during a call of the handler. The glibc2 library follows the BSD behavior. If one on a libc5 system includes -.B "" +.I instead of -.B "" +.I then .BR signal () is redefined as diff --git a/man2/statfs.2 b/man2/statfs.2 index 77d2675d7a..da9e45052c 100644 --- a/man2/statfs.2 +++ b/man2/statfs.2 @@ -190,8 +190,8 @@ and .BR fstatfs64 () to support this library call. -Some systems only have , other systems also have -, where the former includes the latter. +Some systems only have \fI\fP, other systems also have +\fI\fP, where the former includes the latter. So it seems including the former is the best choice. diff --git a/man3/atoi.3 b/man3/atoi.3 index 18592eaa68..5ad6bffdf7 100644 --- a/man3/atoi.3 +++ b/man3/atoi.3 @@ -87,7 +87,7 @@ The non-standard .BR atoq () function is not present in libc 4.6.27 or glibc 2, but is present in libc5 and libc 4.7 (though only as an -inline function in \fB\fP until libc 5.4.44). +inline function in \fI\fP until libc 5.4.44). The .BR atoll () function is present in glibc 2 since version 2.0.2, but diff --git a/man3/clock_getres.3 b/man3/clock_getres.3 index 227eb006a6..bd14447477 100644 --- a/man3/clock_getres.3 +++ b/man3/clock_getres.3 @@ -143,7 +143,7 @@ SUSv2, POSIX.1-2001. .SH AVAILABILITY On POSIX systems on which these functions are available, the symbol .B _POSIX_TIMERS -is defined in to a value greater than 0. +is defined in \fI\fP to a value greater than 0. The symbols .BR _POSIX_MONOTONIC_CLOCK , .BR _POSIX_CPUTIME , diff --git a/man3/insque.3 b/man3/insque.3 index e0bf00e8fb..3bfe01ba65 100644 --- a/man3/insque.3 +++ b/man3/insque.3 @@ -73,11 +73,11 @@ struct qelem { .RE This is still what you will get if _GNU_SOURCE is defined before -including . +including \fI\fP. The location of the prototypes for these functions differs among several versions of UNIX. The above is the POSIX version. -Some systems place them in . +Some systems place them in \fI\fP. Linux libc4,5 placed them -in . +in \fI\fP. diff --git a/man3/nl_langinfo.3 b/man3/nl_langinfo.3 index 8890467013..44d5c7a8a0 100644 --- a/man3/nl_langinfo.3 +++ b/man3/nl_langinfo.3 @@ -31,7 +31,7 @@ Individual and additional elements of the locale categories can be queried. .PP Examples for the locale elements that can be specified in \fIitem\fP -using the constants defined in are: +using the constants defined in \fI\fP are: .TP .BR CODESET \ (LC_CTYPE) Return a string with the name of the character encoding used in the diff --git a/man3/posix_memalign.3 b/man3/posix_memalign.3 index e091dfc282..1ee1082211 100644 --- a/man3/posix_memalign.3 +++ b/man3/posix_memalign.3 @@ -116,18 +116,18 @@ comes from POSIX.1d. .SS Headers Everybody agrees that .BR posix_memalign () -is declared in . +is declared in \fI\fP. In order to declare it, glibc needs _GNU_SOURCE defined, or _XOPEN_SOURCE defined to a value not less than 600. On some systems .BR memalign () -is declared in instead of . +is declared in \fI\fP instead of \fI\fP. According to SUSv2, .BR valloc () -is declared in . -Libc4,5 and glibc declare it in and perhaps also in +is declared in \fI\fP. +Libc4,5 and glibc declare it in \fI\fP and perhaps also in (namely, if _GNU_SOURCE is defined, or _BSD_SOURCE is defined, or, for glibc, if _XOPEN_SOURCE_EXTENDED is defined, or, equivalently, _XOPEN_SOURCE is defined to a value not less than 500). diff --git a/man3/realpath.3 b/man3/realpath.3 index 3c6ff611e0..1f3faa4c65 100644 --- a/man3/realpath.3 +++ b/man3/realpath.3 @@ -100,9 +100,9 @@ On Linux this function appeared in libc 4.5.21. 4.4BSD, POSIX.1-2001. In 4.4BSD and Solaris the limit on the pathname length is MAXPATHLEN -(found in ). +(found in \fI\fP). SUSv2 prescribes PATH_MAX and -NAME_MAX, as found in or provided by the +NAME_MAX, as found in \fI\fP or provided by the .BR pathconf (3) function. A typical source fragment would be @@ -127,8 +127,8 @@ Solaris may return a relative pathname when the argument is relative. The prototype of .BR realpath () -is given in in libc4 and libc5, -but in everywhere else. +is given in \fI\fP in libc4 and libc5, +but in \fI\fP everywhere else. .SH NOTES The glibc implementation of .BR realpath () diff --git a/man3/sigsetops.3 b/man3/sigsetops.3 index d75e2bd4e7..1ef102ed94 100644 --- a/man3/sigsetops.3 +++ b/man3/sigsetops.3 @@ -93,7 +93,7 @@ is not a valid signal. POSIX.1-2001. .SH NOTES .SS Glibc Notes -If the _GNU_SOURCE feature test macro is defined, then +If the _GNU_SOURCE feature test macro is defined, then \fI\fP exposes three other functions for manipulating signal sets. .TP diff --git a/man3/stdin.3 b/man3/stdin.3 index 377eff7a80..f6766e2fb5 100644 --- a/man3/stdin.3 +++ b/man3/stdin.3 @@ -61,7 +61,7 @@ and are 0, 1, and 2, respectively. The preprocessor symbols STDIN_FILENO, STDOUT_FILENO, and STDERR_FILENO are defined with these values in -. +\fI\fP. (Applying .Xr freopen 3 to one of these streams can change the file descriptor number diff --git a/man4/fd.4 b/man4/fd.4 index 932b3a09dd..83e1af82ca 100644 --- a/man4/fd.4 +++ b/man4/fd.4 @@ -185,8 +185,8 @@ resets the floppy controller under certain conditions. .IP \fBFDRAWCMD\fP sends a raw command to the floppy controller. .PP -For more precise information, consult also the and - include files, as well as the manual page for +For more precise information, consult also the \fI\fP and +\fI\fP include files, as well as the manual page for floppycontrol. .SH FILES /dev/fd* diff --git a/man5/resolv.conf.5 b/man5/resolv.conf.5 index 16adc5ccb0..5349da1b64 100644 --- a/man5/resolv.conf.5 +++ b/man5/resolv.conf.5 @@ -44,7 +44,7 @@ The different configuration options are: \fBnameserver\fP Name server IP address Internet address (in dot notation) of a name server that the resolver should query. -Up to MAXNS (currently 3, see ) name servers may be listed, +Up to MAXNS (currently 3, see \fI\fP) name servers may be listed, one per keyword. If there are multiple servers, the resolver library queries them in the order listed. @@ -146,13 +146,13 @@ sets the amount of time the resolver will wait for a response from a remote name server before retrying the query via a different name server. Measured in seconds, -the default is RES_TIMEOUT (currently 5, see ). +the default is RES_TIMEOUT (currently 5, see \fI\fP). .TP .BI attempts: n sets the number of times the resolver will send a query to its name servers before giving up and returning an error to the calling application. -The default is RES_DFLRETRY (currently 2, see ). +The default is RES_DFLRETRY (currently 2, see \fI\fP). .TP .B rotate sets RES_ROTATE in diff --git a/man7/bootparam.7 b/man7/bootparam.7 index aabfc19089..6ebf3ab64c 100644 --- a/man7/bootparam.7 +++ b/man7/bootparam.7 @@ -305,7 +305,7 @@ may be logged to disk. Messages with a priority above .I console_loglevel are also printed on the console. -(For these levels, see .) +(For these levels, see \fI\fP.) By default this variable is set to log anything more important than debug messages. This boot argument will cause the kernel to also diff --git a/man7/ip.7 b/man7/ip.7 index 9e84faa22b..19537c844c 100644 --- a/man7/ip.7 +++ b/man7/ip.7 @@ -368,7 +368,7 @@ and .I IP_TOS are ignored. .TP -.BR IP_RECVERR " (defined in )" +.BR IP_RECVERR " (defined in \fI\fP)" Enable extended reliable error message passing. When enabled on a datagram socket all generated errors will be queued in a per-socket error queue. -- 2.39.5