From 8478ee027925a00caf4740df038241d8eaf43d9e Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Wed, 2 Nov 2005 13:55:25 +0000 Subject: [PATCH] Formatting fixes --- Changes | 11 +++ man2/epoll_ctl.2 | 2 +- man2/epoll_wait.2 | 2 +- man2/getdomainname.2 | 4 +- man2/getrlimit.2 | 2 +- man2/gettimeofday.2 | 20 +++-- man2/link.2 | 2 +- man2/mknod.2 | 4 +- man2/mmap.2 | 10 +-- man2/msgget.2 | 2 +- man2/nanosleep.2 | 3 +- man2/open.2 | 4 +- man2/pivot_root.2 | 6 +- man2/rmdir.2 | 2 +- man2/semop.2 | 5 +- man2/shmop.2 | 15 ++-- man2/sigwaitinfo.2 | 7 +- man2/statfs.2 | 6 +- man2/sysctl.2 | 2 +- man2/wait.2 | 3 +- man2/wait4.2 | 4 +- man3/cmsg.3 | 8 +- man3/confstr.3 | 7 +- man3/ctermid.3 | 5 +- man3/exec.3 | 15 ++-- man3/fflush.3 | 3 +- man3/fopen.3 | 5 +- man3/getaddrinfo.3 | 12 +-- man3/getcwd.3 | 11 +-- man3/getdate.3 | 8 +- man3/getipnodebyname.3 | 12 +-- man3/getline.3 | 4 +- man3/getopt.3 | 4 +- man3/getrpcent.3 | 4 +- man3/gets.3 | 3 +- man3/glob.3 | 6 +- man3/localeconv.3 | 2 +- man3/login.3 | 14 ++-- man3/malloc.3 | 21 ++---- man3/mempcpy.3 | 2 +- man3/popen.3 | 4 +- man3/posix_memalign.3 | 4 +- man3/printf.3 | 2 +- man3/re_comp.3 | 7 +- man3/rpc.3 | 2 +- man3/setbuf.3 | 3 +- man3/setlocale.3 | 12 +-- man3/strtod.3 | 3 +- man3/system.3 | 3 +- man3/ttyname.3 | 5 +- man4/console.4 | 4 +- man4/fd.4 | 2 +- man4/full.4 | 10 +-- man4/hd.4 | 4 +- man4/initrd.4 | 163 +++++++++++++++++++++-------------------- man4/pts.4 | 6 +- man4/random.4 | 22 +++--- man4/sd.4 | 4 +- man4/sk98lin.4 | 4 +- man4/st.4 | 12 +-- man4/tty.4 | 6 +- man4/tty_ioctl.4 | 4 +- man4/vcs.4 | 6 +- man5/acct.5 | 2 +- man5/group.5 | 2 +- man5/ipc.5 | 10 +-- man5/issue.5 | 2 +- man5/locale.5 | 2 +- man5/motd.5 | 2 +- man5/nologin.5 | 2 +- man5/nscd.conf.5 | 2 +- man5/nsswitch.conf.5 | 20 ++--- man5/passwd.5 | 2 +- man5/shells.5 | 4 +- man5/termcap.5 | 2 +- man5/tzfile.5 | 2 +- man7/LDP.7 | 8 +- man7/arp.7 | 6 +- man7/boot.7 | 2 +- man7/ddp.7 | 10 +-- man7/icmp.7 | 2 +- man7/ip.7 | 54 +++++++------- man7/ipv6.7 | 14 ++-- man7/locale.7 | 2 +- man7/packet.7 | 8 +- man7/raw.7 | 4 +- man7/rtnetlink.7 | 12 +-- man7/socket.7 | 10 +-- man7/tcp.7 | 4 +- man7/unix.7 | 6 +- man7/x25.7 | 2 +- man8/ld.so.8 | 18 ++--- man8/ldconfig.8 | 14 ++-- 93 files changed, 373 insertions(+), 411 deletions(-) diff --git a/Changes b/Changes index 50dfb2b01..6f2a16803 100644 --- a/Changes +++ b/Changes @@ -17,6 +17,17 @@ Global changes Typographical or grammatical errors have been corrected in several places. +Make all function and page cross references that were italicised bold +(which is how the majority of function and page cross references +were already done). + +Change instances of things like "NULL-terminated string" to +"null-terminated string" + +Pathnames, structures, and arguments that were bold were changed to italics + +Instances of the constant "NULL" that were bold-faced were made unformatted +(which is how most instances of "NULL" already were.) Changes to individual pages --------------------------- diff --git a/man2/epoll_ctl.2 b/man2/epoll_ctl.2 index f4e06210b..a0079503d 100644 --- a/man2/epoll_ctl.2 +++ b/man2/epoll_ctl.2 @@ -40,7 +40,7 @@ The describes the object linked to the file descriptor .IR fd . The -.B struct epoll_event +.I struct epoll_event is defined as : .sp .nf diff --git a/man2/epoll_wait.2 b/man2/epoll_wait.2 index 5bc472f7c..da2b6ea13 100644 --- a/man2/epoll_wait.2 +++ b/man2/epoll_wait.2 @@ -52,7 +52,7 @@ equal to zero makes .BR epoll_wait (2) to return immediately even if no events are available ( return code equal to zero ). The -.B struct epoll_event +.I struct epoll_event is defined as : .sp .nf diff --git a/man2/getdomainname.2 b/man2/getdomainname.2 index 52708bd74..7f819dc45 100644 --- a/man2/getdomainname.2 +++ b/man2/getdomainname.2 @@ -57,9 +57,7 @@ For .BR getdomainname () under libc: .I name -is -.B NULL -or +is NULL or .I name is longer than .I len diff --git a/man2/getrlimit.2 b/man2/getrlimit.2 index 2b335fee6..ff33cb740 100644 --- a/man2/getrlimit.2 +++ b/man2/getrlimit.2 @@ -76,7 +76,7 @@ and .BR setrlimit () get and set resource limits respectively. Each resource has an associated soft and hard limit, as defined by the -.B rlimit +.I rlimit structure (the .I rlim argument to both diff --git a/man2/gettimeofday.2 b/man2/gettimeofday.2 index da7d60509..4adf0994e 100644 --- a/man2/gettimeofday.2 +++ b/man2/gettimeofday.2 @@ -56,8 +56,9 @@ can get and set the time as well as a timezone. The .I tv argument is a -.B timeval -struct, as specified in : +.I struct timeval +(as specified in +.IR ): .sp .nf struct timeval { @@ -73,8 +74,7 @@ and gives the number of seconds and microseconds since the Epoch (see The .I tz argument is a -.B timezone -: +.IR "struct timezone" : .sp .nf struct timezone { @@ -151,8 +151,9 @@ is on local time, and that it has to be incremented by this amount to get UTC system time. No doubt it is a bad idea to use this feature. .PP -The following macros are defined to operate on a struct timeval : -.br +The following macros are defined to operate on a +.IR "struct timeval" : +.sp .nf #define timerisset(tvp)\\ .ti +8 @@ -213,9 +214,12 @@ and the defines for are (since glibc2.2.2) only available if .B _BSD_SOURCE is defined (either explicitly, or implicitly, by not defining -_POSIX_SOURCE or compiling with the \-ansi flag). +.B _POSIX_SOURCE +or compiling with the \-ansi flag). .LP -Traditionally, the fields of struct timeval were longs. +Traditionally, the fields of +.I struct timeval +were longs. .SH "CONFORMING TO" SVr4, 4.3BSD. POSIX 1003.1-2001 describes .BR gettimeofday () diff --git a/man2/link.2 b/man2/link.2 index dc61b6d7f..a889951d4 100644 --- a/man2/link.2 +++ b/man2/link.2 @@ -128,7 +128,7 @@ even if the same filesystem is mounted on both.) Hard links, as created by .BR link (), cannot span filesystems. Use -.B symlink +.BR symlink () if this is required. POSIX.1-2001 says that diff --git a/man2/mknod.2 b/man2/mknod.2 index bb9bdb6ed..5519df52b 100644 --- a/man2/mknod.2 +++ b/man2/mknod.2 @@ -161,9 +161,9 @@ is unspecified." Under Linux, this call cannot be used to create directories. One should make directories with -.BR mkdir , +.BR mkdir (2), and FIFOs with -.BR mkfifo . +.BR mkfifo (2). .\" Unix domain sockets with .BR socket " (and " bind ), There are many infelicities in the protocol underlying NFS. Some diff --git a/man2/mmap.2 b/man2/mmap.2 index 71a75e7e4..0b4b8e995 100644 --- a/man2/mmap.2 +++ b/man2/mmap.2 @@ -87,9 +87,9 @@ the process or are to be shared with other references. It has bits .B MAP_FIXED Do not select a different address than the one specified. If the memory region specified by -.B start +.I start and -.B len +.I len overlaps pages of any existing mapping(s), then the overlapped part of the existing mapping(s) will be discarded. If the specified address cannot be used, @@ -216,16 +216,16 @@ to these pages will generate SIGSEGV. It is not an error if the indicated range does not contain any mapped pages. For file-backed mappings, the -.B st_atime +.I st_atime field for the mapped file may be updated at any time between the .BR mmap () and the corresponding unmapping; the first reference to a mapped page will update the field if it has not been already. .LP The -.B st_ctime +.I st_ctime and -.B st_mtime +.I st_mtime field for a file mapped with PROT_WRITE and MAP_SHARED will be updated after a write to the mapped region, and before a subsequent .BR msync () diff --git a/man2/msgget.2 b/man2/msgget.2 index 14072b03b..6571fb1b6 100644 --- a/man2/msgget.2 +++ b/man2/msgget.2 @@ -157,7 +157,7 @@ capability. .TP .B EEXIST A message queue exists for -.B key +.I key and .I msgflg specified both diff --git a/man2/nanosleep.2 b/man2/nanosleep.2 index 1d06c3198..0f2ab59e4 100644 --- a/man2/nanosleep.2 +++ b/man2/nanosleep.2 @@ -46,8 +46,7 @@ remaining time into the structure pointed to by .IR rem unless .I rem -is -.BR NULL . +is NULL. The value of .I *rem can then be used to call diff --git a/man2/open.2 b/man2/open.2 index 4a2083d9c..f8dd88fbf 100644 --- a/man2/open.2 +++ b/man2/open.2 @@ -191,9 +191,9 @@ in which case the lock is also successful. .B O_LARGEFILE (LFS) Allow files whose sizes cannot be represented in an -.B off_t +.I off_t (but can be represented in an -.BR off64_t ) +.IR off64_t ) to be opened. .TP .B O_NOATIME diff --git a/man2/pivot_root.2 b/man2/pivot_root.2 index c72fd9bde..b0dfc32ac 100644 --- a/man2/pivot_root.2 +++ b/man2/pivot_root.2 @@ -59,7 +59,7 @@ They must be directories. the current root. .IP \- 3 \fIput_old\fP must be underneath \fInew_root\fP, i.e. adding a non-zero -number of \fB/..\fP to the string pointed to by \fIput_old\fP must yield +number of \fI/..\fP to the string pointed to by \fIput_old\fP must yield the same directory as \fInew_root\fP. .IP \- 3 No other file system may be mounted on \fIput_old\fP. @@ -71,8 +71,8 @@ If the current root is not a mount point (e.g. after \fBchroot(2)\fP or mount point of that file system is mounted on \fIput_old\fP. .SH NOTES \fInew_root\fP does not have to be a mount point. In this case, -\fB/proc/mounts\fP will show the mount point of the file system containing -\fInew_root\fP as root (\fB/\fP). +\fI/proc/mounts\fP will show the mount point of the file system containing +\fInew_root\fP as root (\fI/\fP). .SH "RETURN VALUE" On success, zero is returned. On error, \-1 is returned, and \fIerrno\fP is set appropriately. diff --git a/man2/rmdir.2 b/man2/rmdir.2 index 2c967fccc..8e1523124 100644 --- a/man2/rmdir.2 +++ b/man2/rmdir.2 @@ -89,7 +89,7 @@ is not, in fact, a directory. .B ENOTEMPTY .I pathname contains entries other than -.BR . " and " .. " ." +.IR . " and " .. " ." .TP .B EPERM The directory containing diff --git a/man2/semop.2 b/man2/semop.2 index d95574836..6d5c67b4e 100644 --- a/man2/semop.2 +++ b/man2/semop.2 @@ -71,7 +71,7 @@ elements in the array pointed to by .I sops specifies an operation to be performed on a single semaphore. The elements of this structure are of type -.BR "struct sembuf" , +.IR "struct sembuf" , containing the following members: .sp .in +4n @@ -296,8 +296,7 @@ set to is performed). If the .I timeout -parameter is -.BR NULL , +parameter isNULL, then .BR semtimedop () behaves exactly like diff --git a/man2/shmop.2 b/man2/shmop.2 index 6cca3d6d9..9fa92dae8 100644 --- a/man2/shmop.2 +++ b/man2/shmop.2 @@ -61,15 +61,13 @@ with one of the following criteria: .LP If .I shmaddr -is -.BR NULL , +is NULL, the system chooses a suitable (unused) address at which to attach the segment. .LP If .I shmaddr -isn't -.B NULL +isn't NULL and .B SHM_RND is specified in @@ -105,8 +103,7 @@ and continuing for the size of the segment. error would result if a mapping already exists in this address range.) In this case, .I shmaddr -must not be -.BR NULL . +must not be NULL. .PP The .BR brk (2) @@ -210,8 +207,7 @@ or .B SHM_REMAP was specified and .I shmaddr -was -.BR NULL . +was NULL. .TP .B ENOMEM Could not allocate memory for the descriptor or for the page tables. @@ -228,8 +224,7 @@ Using .BR shmat () with .I shmaddr -equal to -.B NULL +equal to NULL is the preferred, portable way of attaching a shared memory segment. Be aware that the shared memory segment attached in this way may be attached at different addresses in different processes. diff --git a/man2/sigwaitinfo.2 b/man2/sigwaitinfo.2 index 5a8f9c2ce..3d888a364 100644 --- a/man2/sigwaitinfo.2 +++ b/man2/sigwaitinfo.2 @@ -43,8 +43,7 @@ removes the delivered signal from the calling process's list of pending signals and returns the signal number as its function result. If the .I info -argument is not -.BR NULL , +argument is not NULL, then it returns a structure of type .I siginfo_t (see @@ -121,9 +120,7 @@ or .BR sigtimedwait ()) and does not establish handlers for these signals. .PP -POSIX leaves the meaning of a -.B NULL -value for the +POSIX leaves the meaning of a NULL value for the .I timeout argument of .BR sigtimedwait () diff --git a/man2/statfs.2 b/man2/statfs.2 index aa9a0364b..d2777f35a 100644 --- a/man2/statfs.2 +++ b/man2/statfs.2 @@ -184,7 +184,7 @@ was inspired by the 4.4BSD one Solaris, Irix and POSIX have a system call .BR statvfs (2) that returns a -.B "struct statvfs" +.I "struct statvfs" (defined in .IR "" ) containing an @@ -193,7 +193,7 @@ containing an Linux, SunOS, HPUX, 4.4BSD have a system call .BR statfs () that returns a -.B "struct statfs" +.I "struct statfs" (defined in .IR "" ) containing a @@ -202,7 +202,7 @@ containing a where .I fsid_t is defined as -.BR "struct { int val[2]; }" . +.IR "struct { int val[2]; }" . The same holds for FreeBSD, except that it uses the include file .IR "" . diff --git a/man2/sysctl.2 b/man2/sysctl.2 index 4e66bbaa6..a786c866f 100644 --- a/man2/sysctl.2 +++ b/man2/sysctl.2 @@ -60,7 +60,7 @@ struct __sysctl_args { .PP This call does a search in a tree structure, possibly resembling a directory tree under -.BR /proc/sys , +.IR /proc/sys , and if the requested item is found calls some appropriate routine to read or modify the value. diff --git a/man2/wait.2 b/man2/wait.2 index c88e97c7e..4a0aab533 100644 --- a/man2/wait.2 +++ b/man2/wait.2 @@ -161,8 +161,7 @@ signal (see .PP If .I status -is not -.BR NULL , +is not NULL, .BR wait () and .BR waitpid () diff --git a/man2/wait4.2 b/man2/wait4.2 index 5654d33e8..6e93a6ad1 100644 --- a/man2/wait4.2 +++ b/man2/wait4.2 @@ -99,9 +99,7 @@ for further details. .PP If .I rusage -is not -.BR NULL , -the +is not NULL, the .I struct rusage to which it points will be filled with accounting information about the child. diff --git a/man3/cmsg.3 b/man3/cmsg.3 index cbc4e7c7e..042586bb6 100644 --- a/man3/cmsg.3 +++ b/man3/cmsg.3 @@ -48,7 +48,7 @@ and received by calling See their manual pages for more information. .PP Ancillary data is a sequence of -.B struct cmsghdr +.I struct cmsghdr structures with appended data. This sequence should only be accessed using the macros described in this manual page and never directly. See the specific protocol man pages for the available control message types. @@ -68,10 +68,8 @@ data buffer associated with the passed returns the next valid .B cmsghdr after the passed -.B cmsghdr. -It returns -.B NULL -when there isn't enough space left in the buffer. +.B cmsghdr . +It returns NULL when there isn't enough space left in the buffer. .PP .BR CMSG_ALIGN (), given a length, returns it including the required alignment. This is a diff --git a/man3/confstr.3 b/man3/confstr.3 index 02b5328e6..d39cf12d6 100644 --- a/man3/confstr.3 +++ b/man3/confstr.3 @@ -64,9 +64,7 @@ be found. .PP If .I buf -is not -.BR NULL , -and +is not NULL and .I len is not zero, .BR confstr () @@ -84,8 +82,7 @@ If .I len is zero and .I buf -is -.BR NULL , +is NULL, .BR confstr () just returns the value as defined below. .SH "RETURN VALUE" diff --git a/man3/ctermid.3 b/man3/ctermid.3 index 48c27aebe..d24ee0762 100644 --- a/man3/ctermid.3 +++ b/man3/ctermid.3 @@ -36,8 +36,7 @@ returns a string which is the pathname for the current controlling terminal for process. If .I s -is -.BR NULL , +is NULL, a static buffer is used, otherwise .I s points to a buffer used to hold the terminal pathname. @@ -51,7 +50,7 @@ SVID, Issue 1; POSIX.1 .SH BUGS The path returned may not uniquely identify the controlling terminal; it may, for example, be -.BR /dev/tty . +.IR /dev/tty . .PP It is not assured that the program can open the terminal. .SH "SEE ALSO" diff --git a/man3/exec.3 b/man3/exec.3 index fcbc35511..2e4dd2a1a 100644 --- a/man3/exec.3 +++ b/man3/exec.3 @@ -85,8 +85,7 @@ strings that represent the argument list available to the executed program. The first argument, by convention, should point to the file name associated with the file being executed. The list of arguments .I must -be terminated by a -.B NULL +be terminated by a NULL pointer, and, since these are variadic functions, this pointer must be cast .BR "(char *) NULL" . .PP @@ -99,22 +98,18 @@ represent the argument list available to the new program. The first argument, by convention, should point to the file name associated with the file being executed. The array of pointers .I must -be terminated by a -.B NULL -pointer. +be terminated by a NULL pointer. .PP The .BR execle () function also specifies the environment of the executed process by following -the -.B NULL +the NULL pointer that terminates the list of arguments in the parameter list or the pointer to the argv array with an additional parameter. This additional parameter is an array of pointers to null-terminated strings and .I must -be terminated by a -.B NULL -pointer. The other functions take the environment for the new process +be terminated by a NULL pointer. +The other functions take the environment for the new process image from the external variable .I environ in the current process. diff --git a/man3/fflush.3 b/man3/fflush.3 index def5dcffb..4a3702855 100644 --- a/man3/fflush.3 +++ b/man3/fflush.3 @@ -57,8 +57,7 @@ is unaffected. .PP If the .I stream -argument is -.BR NULL , +argument is NULL, .BR fflush () flushes .I all diff --git a/man3/fopen.3 b/man3/fopen.3 index 0353176b9..7f0b89262 100644 --- a/man3/fopen.3 +++ b/man3/fopen.3 @@ -172,9 +172,8 @@ and .BR freopen () return a .I FILE -pointer. Otherwise, -.B NULL -is returned and the global variable +pointer. +Otherwise, NULL is returned and the global variable .I errno is set to indicate the error. .SH ERRORS diff --git a/man3/getaddrinfo.3 b/man3/getaddrinfo.3 index 0b87ff7ff..266b2a6f0 100644 --- a/man3/getaddrinfo.3 +++ b/man3/getaddrinfo.3 @@ -71,7 +71,7 @@ or to prepare a client or a server socket. .PP The -.B addrinfo +.I addrinfo structure used by this function contains the following members: .sp .nf @@ -91,13 +91,13 @@ structure used by this function contains the following members: sets .I res to point to a dynamically-allocated linked list of -.B addrinfo +.I addrinfo structures, linked by the .I ai_next member. There are several reasons why the linked list may have more than one -.B addrinfo +.I addrinfo structure, including: if the network host is multi-homed; or if the same service is available from multiple socket protocols (one @@ -132,7 +132,7 @@ A NULL .I hints specifies that any network address or protocol is acceptable. If this parameter is not NULL it points to an -.B addrinfo +.I addrinfo structure whose .IR ai_family , @@ -181,7 +181,7 @@ flag suppresses any potentially lengthy network host address lookups. The .BR getaddrinfo (3) function creates a linked list of -.B addrinfo +.I addrinfo structures, one for each network address subject to any restrictions imposed by the .I hints @@ -189,7 +189,7 @@ parameter. The .I ai_canonname field of the first of these -.B addrinfo +.I addrinfo structures is set to point to the official name of the host, if .I hints.ai_flags includes the diff --git a/man3/getcwd.3 b/man3/getcwd.3 index f29f03637..9d28b2ce3 100644 --- a/man3/getcwd.3 +++ b/man3/getcwd.3 @@ -49,9 +49,7 @@ which is of length .PP If the current absolute path name would require a buffer longer than .I size -elements, -.B NULL -is returned, and +elements, NULL is returned, and .I errno is set to .BR ERANGE ; @@ -70,9 +68,8 @@ allocates the buffer dynamically using .BR malloc () if .I buf -is -.B NULL -on call. In this case, the allocated buffer has the length +is NULL on call. +In this case, the allocated buffer has the length .I size unless .I size @@ -116,7 +113,7 @@ and may even be unlimited. For portability and security reasons, use of .BR getwd () is deprecated. .SH "RETURN VALUE" -.B NULL +NULL on failure with .I errno set accordingly, and diff --git a/man3/getdate.3 b/man3/getdate.3 index 977f8f0d3..09eff042c 100644 --- a/man3/getdate.3 +++ b/man3/getdate.3 @@ -95,13 +95,13 @@ If no date is given, but we know the hour, then that hour is taken to be the first such hour equal to or after the current hour. .SH "RETURN VALUE" When successful, this function returns a pointer to a -.BR "struct tm" . +.IR "struct tm" . Otherwise, it returns NULL and sets the global variable -.BR getdate_err . +.IR getdate_err . Changes to .I errno are unspecified. The following values for -.B getdate_err +.I getdate_err are defined: .TP 4n .B 1 @@ -131,7 +131,7 @@ Invalid input specification. Since .BR getdate () is not reentrant because of the use of -.B getdate_err +.I getdate_err and the static buffer to return the result in, glibc provides a thread-safe variant. The functionality is the same. The result is returned in the buffer pointed to by diff --git a/man3/getipnodebyname.3 b/man3/getipnodebyname.3 index da737ef85..c9e2d95ad 100644 --- a/man3/getipnodebyname.3 +++ b/man3/getipnodebyname.3 @@ -165,21 +165,21 @@ parameter specifies one of the following values: The .I addr parameter points to a -.B struct in_addr +.I struct in_addr and .I len must be set to -.BR "sizeof(struct in_addr)" . +.IR "sizeof(struct in_addr)" . .TP .B AF_INET6 The .I addr parameter points to a -.B struct in6_addr +.I struct in6_addr and .I len must be set to -.BR "sizeof(struct in6_addr)" . +.IR "sizeof(struct in6_addr)" . .SH "RETURN VALUE" A null pointer is returned if an error occurred, and .I error_num @@ -236,11 +236,11 @@ parameter was .TP .B h_length This field will be set to -.B sizeof(struct in_addr) +.I sizeof(struct in_addr) if .I h_addrtype is AF_INET, and to -.B sizeof(struct in6_addr) +.I sizeof(struct in6_addr) if .I h_addrtype is AF_INET6. diff --git a/man3/getline.3 b/man3/getline.3 index c226be9af..615192c0e 100644 --- a/man3/getline.3 +++ b/man3/getline.3 @@ -44,9 +44,7 @@ newline delimiter was found. .\" Answer: *n is ignored and a new buffer is allocated If .IR "*lineptr" -is -.BR "NULL" , -the +is NULL, then the .BR getline () routine will allocate a buffer for containing the line, which must be freed by the user program. diff --git a/man3/getopt.3 b/man3/getopt.3 index d5558dbd2..00794646c 100644 --- a/man3/getopt.3 +++ b/man3/getopt.3 @@ -154,9 +154,9 @@ or .PP .I longopts is a pointer to the first element of an array of -.B struct option +.I struct option declared in -.B +.I as .nf .sp diff --git a/man3/getrpcent.3 b/man3/getrpcent.3 index 8b446b6b7..ec1dc0ef6 100644 --- a/man3/getrpcent.3 +++ b/man3/getrpcent.3 @@ -35,7 +35,7 @@ each return a pointer to an object with the following structure containing the broken-out fields of a line in the rpc program number data base, -.BR /etc/rpc . +.IR /etc/rpc . .RS .LP .nf @@ -88,7 +88,7 @@ program number is found, or until end-of-file is encountered. .SH FILES .PD 0 .TP 20 -.B /etc/rpc +.I /etc/rpc .PD .SH "SEE ALSO" .BR rpc (5), diff --git a/man3/gets.3 b/man3/gets.3 index d297b6ad7..6fcfc12ce 100644 --- a/man3/gets.3 +++ b/man3/gets.3 @@ -124,8 +124,7 @@ and .BR fgets () return .I s -on success, and -.B NULL +on success, and NULL on error or when end of file occurs while no characters have been read. .PP .BR ungetc () diff --git a/man3/glob.3 b/man3/glob.3 index 9dbfa9e21..47ae1883b 100644 --- a/man3/glob.3 +++ b/man3/glob.3 @@ -148,8 +148,7 @@ which means that only directories are matched. .PP If .I errfunc -is not -.BR NULL , +is not NULL, it will be called in case of an error with the arguments .IR epath , a pointer to the path which failed, and @@ -175,8 +174,7 @@ Upon successful return, contains the number of matched pathnames and .I pglob->gl_pathv a pointer to the list of matched pathnames. The first pointer after -the last pathname is -.BR NULL . +the last pathname is NULL. .PP It is possible to call .BR glob () diff --git a/man3/localeconv.3 b/man3/localeconv.3 index 256104aa0..c31c5c665 100644 --- a/man3/localeconv.3 +++ b/man3/localeconv.3 @@ -34,7 +34,7 @@ localeconv \- get numeric formatting information The .BR localeconv () function returns a pointer to a -.B struct lconv +.I struct lconv for the current locale. This structure is defined in the header-file .B locale.h and contains all values associated with the locale categories diff --git a/man3/login.3 b/man3/login.3 index f74c758d4..7c0bb1145 100644 --- a/man3/login.3 +++ b/man3/login.3 @@ -91,15 +91,17 @@ to your compiler command line. Note that the member -.B ut_user -of struct utmp is called -.B ut_name +.I ut_user +of +.I struct utmp +is called +.I ut_name in BSD. Therefore, -.B ut_name +.I ut_name is defined as an alias for -.B ut_user +.I ut_user in -.IR utmp.h . +.IR . .SH FILES .TP .I /var/run/utmp diff --git a/man3/malloc.3 b/man3/malloc.3 index 3b8ff03bc..09c1ed43d 100644 --- a/man3/malloc.3 +++ b/man3/malloc.3 @@ -67,9 +67,7 @@ Otherwise, or if has already been called before, undefined behaviour occurs. If .I ptr -is -.BR NULL , -no operation is performed. +is NULL, no operation is performed. .PP .BR realloc () changes the size of the memory block pointed to by @@ -81,18 +79,14 @@ The contents will be unchanged to the minimum of the old and new sizes; newly allocated memory will be uninitialized. If .I ptr -is -.BR NULL , -the call is equivalent to +is NULL, the call is equivalent to .BR malloc(size) ; if size is equal to zero, the call is equivalent to .BI "free(" "ptr" ) . Unless .I ptr -is -.BR NULL , -it must have been returned by an earlier call to +is NULL, it must have been returned by an earlier call to .BR malloc (), .BR calloc () or @@ -106,9 +100,7 @@ For and .BR malloc (), the value returned is a pointer to the allocated memory, which is suitably -aligned for any kind of variable, or -.B NULL -if the request fails. +aligned for any kind of variable, or NULL if the request fails. .PP .BR free () returns no value. @@ -117,9 +109,8 @@ returns no value. returns a pointer to the newly allocated memory, which is suitably aligned for any kind of variable and may be different from .IR ptr , -or -.B NULL -if the request fails. If +or NULL if the request fails. +If .I size was equal to 0, either NULL or a pointer suitable to be passed to .BR free () diff --git a/man3/mempcpy.3 b/man3/mempcpy.3 index 212f10d43..7393dd3cf 100644 --- a/man3/mempcpy.3 +++ b/man3/mempcpy.3 @@ -30,7 +30,7 @@ function. It copies bytes from the object beginning at .I src into the object pointed to by -.I dest. +.IR dest . But instead of returning the value of .I dest it returns a pointer to the byte following the last written byte. diff --git a/man3/popen.3 b/man3/popen.3 index 64b58178a..78b251059 100644 --- a/man3/popen.3 +++ b/man3/popen.3 @@ -92,9 +92,7 @@ status of the command as returned by .SH "RETURN VALUE" The .BR popen () -function returns -.B NULL -if the +function returns NULL if the .BR fork (2) or .BR pipe (2) diff --git a/man3/posix_memalign.3 b/man3/posix_memalign.3 index 7c49bf65b..52e44c758 100644 --- a/man3/posix_memalign.3 +++ b/man3/posix_memalign.3 @@ -75,9 +75,7 @@ For all three routines, the memory is not zeroed. .BR memalign () and .BR valloc () -return the pointer to the allocated memory, or -.B NULL -if the request fails. +return the pointer to the allocated memory, or NULL if the request fails. .BR posix_memalign () returns zero on success, or one of the error values listed in the diff --git a/man3/printf.3 b/man3/printf.3 index 9ae5adda6..fddecc210 100644 --- a/man3/printf.3 +++ b/man3/printf.3 @@ -295,7 +295,7 @@ For decimal conversion .BR G ) the output is to be grouped with thousands' grouping characters if the locale information indicates any. Note that many versions of -.B gcc +.BR gcc (1) cannot parse this option and will issue a warning. SUSv2 does not include %'F. .PP diff --git a/man3/re_comp.3 b/man3/re_comp.3 index 60b5d0ca0..888190fb1 100644 --- a/man3/re_comp.3 +++ b/man3/re_comp.3 @@ -42,8 +42,7 @@ which is overwritten by subsequent use of .BR re_comp (). If .I regex -is -.BR NULL , +is NULL, no operation is performed and the pattern buffer's contents are not altered. @@ -54,9 +53,7 @@ matches the previously compiled .IR regex . .SH "RETURN VALUE" .BR re_comp () -returns -.B NULL -on successful compilation of +returns NULL on successful compilation of .I regex otherwise it returns a pointer to an appropriate error message. diff --git a/man3/rpc.3 b/man3/rpc.3 index 2ef694d0b..fc2cd88af 100644 --- a/man3/rpc.3 +++ b/man3/rpc.3 @@ -747,7 +747,7 @@ Stuff the machine's address into .IR *addr , without consulting the library routines that deal with -.BR /etc/hosts . +.IR /etc/hosts . The port number is always set to .BR htons(\s-1PMAPPORT\s0) . .br diff --git a/man3/setbuf.3 b/man3/setbuf.3 index d01284841..74ffb4521 100644 --- a/man3/setbuf.3 +++ b/man3/setbuf.3 @@ -105,8 +105,7 @@ argument should point to a buffer at least bytes long; this buffer will be used instead of the current buffer. If the argument .I buf -is -.BR NULL , +is NULL, only the mode is affected; a new buffer will be allocated on the next read or write operation. The .BR setvbuf () diff --git a/man3/setlocale.3 b/man3/setlocale.3 index a39f2fd42..881f63cd8 100644 --- a/man3/setlocale.3 +++ b/man3/setlocale.3 @@ -43,8 +43,7 @@ function is used to set or query the program's current locale. .PP If .I locale -is not -.BR NULL , +is not NULL, the program's current locale is modified according to the arguments. The argument .I category @@ -132,9 +131,7 @@ For a list of all supported locales, try "locale \-a", cf.\& .PP If .I locale -is -.BR NULL , -the current locale is only queried, not modified. +is NULL, the current locale is only queried, not modified. .PP On startup of the main program, the portable .B """C""" @@ -162,9 +159,8 @@ returns an opaque string that corresponds to the locale set. This string may be allocated in static storage. The string returned is such that a subsequent call with that string and its associated category will restore that part of the process's -locale. The return value is -.B NULL -if the request cannot be honored. +locale. +The return value is NULL if the request cannot be honored. .SH "CONFORMING TO" ANSI C, POSIX.1 .SH NOTES diff --git a/man3/strtod.3 b/man3/strtod.3 index f552326bf..0aba65157 100644 --- a/man3/strtod.3 +++ b/man3/strtod.3 @@ -111,8 +111,7 @@ These functions return the converted value, if any. If .I endptr -is not -.BR NULL , +is not NULL, a pointer to the character after the last character used in the conversion is stored in the location referenced by .IR endptr . diff --git a/man3/system.3 b/man3/system.3 index 043bb230a..f26df74df 100644 --- a/man3/system.3 +++ b/man3/system.3 @@ -67,8 +67,7 @@ a command that does .PP If the value of .I command -is -.BR NULL , +is NULL, .BR system () returns non-zero if the shell is available, and zero if not. .PP diff --git a/man3/ttyname.3 b/man3/ttyname.3 index af86d7de4..5d78d7c14 100644 --- a/man3/ttyname.3 +++ b/man3/ttyname.3 @@ -51,9 +51,8 @@ of length .SH "RETURN VALUE" The function .BR ttyname () -returns a pointer to a pathname on success. On error, -.B NULL -is returned, and +returns a pointer to a pathname on success. +On error, NULL is returned, and .I errno is set appropriately. The function diff --git a/man4/console.4 b/man4/console.4 index 49d071989..2d388c049 100644 --- a/man4/console.4 +++ b/man4/console.4 @@ -13,9 +13,9 @@ console \- console terminal and virtual consoles .SH DESCRIPTION A Linux system has up to 63 \fIvirtual consoles\fP (character devices with major number 4 and minor number 1 to 63), -usually called \fB/dev/tty\fP\fIn\fP with 1 \(<= \fIn\fP \(<= 63. +usually called \fI/dev/tty\fP\fIn\fP with 1 \(<= \fIn\fP \(<= 63. The current console is also addressed by -\fB/dev/console\fP or \fB/dev/tty0\fP, the character device with +\fI/dev/console\fP or \fI/dev/tty0\fP, the character device with major number 4 and minor number 0. The device files /dev/* are usually created using the script MAKEDEV, or using diff --git a/man4/fd.4 b/man4/fd.4 index c449cc84d..c26a1aad4 100644 --- a/man4/fd.4 +++ b/man4/fd.4 @@ -141,7 +141,7 @@ lost when the media is changed. sets the media information of a drive (geometry of disk in drive). The media information will not be lost when the media is changed. This will disable autodetection. In order to re-enable autodetection, you -have to issue an \fBFDCLRPRM\fP . +have to issue an \fBFDCLRPRM\fP. .IP \fBFDGETDRVTYP\fP returns the type of a drive (name parameter). For formats which work in several drive types, \fBFDGETDRVTYP\fP returns a name which is diff --git a/man4/full.4 b/man4/full.4 index 90b818ee2..511ec1f2f 100644 --- a/man4/full.4 +++ b/man4/full.4 @@ -27,16 +27,16 @@ .SH NAME full \- always full device .SH DESCRIPTION -File \fB/dev/full\fP has major device number 1 +File \fI/dev/full\fP has major device number 1 and minor device number 7. .LP -Writes to the \fB/dev/full\fP device will fail with an ENOSPC error. +Writes to the \fI/dev/full\fP device will fail with an ENOSPC error. -Reads from the \fB/dev/full\fP device will return \\0 characters. +Reads from the \fI/dev/full\fP device will return \\0 characters. -Seeks on \fB/dev/full\fP will always succeed. +Seeks on \fI/dev/full\fP will always succeed. .SH CONFIGURING -If your system does not have \fB/dev/full\fP created already, it +If your system does not have \fI/dev/full\fP created already, it can be created with the following commands: .nf diff --git a/man4/hd.4 b/man4/hd.4 index 5d200eca9..e2ca6e899 100644 --- a/man4/hd.4 +++ b/man4/hd.4 @@ -58,9 +58,9 @@ Both DOS-type partitioning and BSD-disklabel partitioning are supported. You can have at most 63 partitions on an IDE disk. .LP For example, -.B /dev/hda +.I /dev/hda refers to all of the first IDE drive in the system; and -.B /dev/hdb3 +.I /dev/hdb3 refers to the third DOS `primary' partition on the second one. .LP They are typically created by: diff --git a/man4/initrd.4 b/man4/initrd.4 index d4264b297..efaf3e096 100644 --- a/man4/initrd.4 +++ b/man4/initrd.4 @@ -39,20 +39,20 @@ initrd \- boot loader initialized RAM disk .\" .SH DESCRIPTION The special file -.B /dev/initrd +.I /dev/initrd is a read-only block device. Device -.B /dev/initrd +.I /dev/initrd is a RAM disk that is initialized (e.g. loaded) by the boot loader before the kernel is started. The kernel then can use the block device -.BR /dev/initrd "'s " +.IR /dev/initrd "'s " contents for a two phased system boot-up. .PP In the first boot-up phase, the kernel starts up and mounts an initial root file-system from the contents of -.B /dev/initrd +.I /dev/initrd (e.g. RAM disk initialized by the boot loader). In the second phase, additional drivers or other modules are loaded from the initial root device's contents. @@ -68,41 +68,42 @@ When booting up with .RS 0.2i .PP 1. The boot loader loads the kernel program and -.BR /dev/initrd "'s contents into memory." +.IR /dev/initrd "'s contents into memory." .PP -2. On kernel startup, the kernel uncompresses and copies the contents of the device -.B /dev/initrd +2. On kernel startup, +the kernel uncompresses and copies the contents of the device +.I /dev/initrd onto device -.B /dev/ram0 +.I /dev/ram0 and then frees the memory used by -.BR /dev/initrd "." +.IR /dev/initrd "." .PP 3. The kernel then read-write mounts device -.B /dev/ram0 +.I /dev/ram0 as the initial root file system. .PP 4. If the indicated normal root file system is also the initial root file-system (e.g. -.B /dev/ram0 +.I /dev/ram0 ) then the kernel skips to the last step for the usual boot sequence. .PP 5. If the executable file -.BR /linuxrc " is present in the initial root file-system, " /linuxrc +.IR /linuxrc " is present in the initial root file-system, " /linuxrc is executed with UID 0. (The file -.B /linuxrc +.I /linuxrc must have executable permission. The file -.B /linuxrc +.I /linuxrc can be any valid executable, including a shell script.) .PP 6. If -.B /linuxrc +.I /linuxrc is not executed or when -.B /linuxrc +.I /linuxrc terminates, the normal root file system is mounted. (If -.BR /linuxrc +.IR /linuxrc exits with any file-systems mounted on the initial root file-system, then the behavior of the kernel is .BR UNSPECIFIED "." @@ -111,21 +112,21 @@ See the section for the current kernel behavior.) .PP 7. If the normal root file has directory -.BR /initrd ", device" -.B /dev/ram0 +.IR /initrd ", device" +.I /dev/ram0 is moved from -.BR / " to " /initrd "." +.IR / " to " /initrd "." Otherwise if directory -.BR /initrd " does not exist device " /dev/ram0 " is unmounted." +.IR /initrd " does not exist device " /dev/ram0 " is unmounted." (When moved from -.BR / " to " /initrd ", " /dev/ram0 +.IR / " to " /initrd ", " /dev/ram0 is not unmounted and therefore processes can remain running from -.BR /dev/ram0 "." +.IR /dev/ram0 "." If directory -.BR /initrd +.IR /initrd does not exist on the normal root file-system and any processes remain running from -.BR /dev/ram0 " when " /linuxrc +.IR /dev/ram0 " when " /linuxrc exits, the behavior of the kernel is .BR UNSPECIFIED "." See the @@ -133,7 +134,8 @@ See the section for the current kernel behavior.) .PP 8. The usual boot sequence (e.g. invocation of -.BR /sbin/init ") is performed on the normal root file system." +.IR /sbin/init ) +is performed on the normal root file system. .\" .\" .\" @@ -143,27 +145,29 @@ The following boot loader options when used with .TP .BI initrd= "filename" Specifies the file to load as the contents of -.BR /dev/initrd "." +.IR /dev/initrd "." .RB "For " LOADLIN this is a command line option. .RB "For " LILO " you have to use this command in the -.BR LILO " configuration file " /etc/lilo.config "." +.BR LILO +configuration file +.IR /etc/lilo.config . The filename specified with this option will typically be a gzipped file-system image. .TP -.B noinitrd +.I noinitrd This boot time option disables the two phase boot-up operation. The kernel performs the usual boot sequence as if -.B /dev/initrd +.I /dev/initrd was not initialized. With this option, any contents of -.B /dev/initrd +.I /dev/initrd loaded into memory by the boot loader contents are preserved. This option permits the contents of -.B /dev/initrd +.I /dev/initrd to be any data and need not be limited to a file system image. However, device -.B /dev/initrd +.I /dev/initrd is read-only and can be read only one time after system startup. .TP .BI root= "device-name" @@ -182,7 +186,7 @@ device having a suitable root file-system. By default, the kernel's settings (e.g. set in the kernel file with -.B rdev +.BR rdev (8) or compiled into the kernel file), or the boot loader option setting is used for the normal root file systems. @@ -195,38 +199,38 @@ For more information on setting the root file system also see the .BR LILO " and " LOADLIN " documentation." .PP It is also possible for the -.BR /linuxrc +.IR /linuxrc executable to change the normal root device. For -.BR /linuxrc +.IR /linuxrc to change the normal root device, -.BR /proc " must be mounted." +.IR /proc " must be mounted." After mounting -.BR /proc ", " /linuxrc +.IR /proc ", " /linuxrc changes the normal root device by writing into the proc files -.BR /proc/sys/kernel/real-root-dev ", " -.BR /proc/sys/kernel/nfs-root-name ", and " -.BR /proc/sys/kernel/nfs-root-addrs "." +.IR /proc/sys/kernel/real-root-dev ", " +.IR /proc/sys/kernel/nfs-root-name ", and " +.IR /proc/sys/kernel/nfs-root-addrs "." For a physical root device, the root device is changed by having -.BR /linuxrc +.IR /linuxrc write the new root file system device number into -.BR /proc/sys/kernel/real-root-dev "." +.IR /proc/sys/kernel/real-root-dev "." For a NFS root file system, the root device is changed by having -.BR /linuxrc +.IR /linuxrc write the NFS setting into files -.BR /proc/sys/kernel/nfs-root-name " and " -.BR /proc/sys/kernel/nfs-root-addrs +.IR /proc/sys/kernel/nfs-root-name " and " +.IR /proc/sys/kernel/nfs-root-addrs and then writing 0xff (e.g. the pseudo-NFS-device number) into file -.BR /proc/sys/kernel/real-root-dev "." +.IR /proc/sys/kernel/real-root-dev "." For example, the following shell command line would change the normal root device to -.BR /dev/hdb1 : +.IR /dev/hdb1 : .nf echo 0x365 >/proc/sys/kernel/real-root-dev .fi For a NFS example, the following shell command lines would change the normal root device to the NFS directory -.BR /var/nfsroot +.IR /var/nfsroot on a local networked NFS server with IP number 193.8.232.7 for a system with IP number 193.8.232.7 and named 'idefix': .nf @@ -238,7 +242,7 @@ IP number 193.8.232.7 and named 'idefix': .BR Note : The use of -.BR /proc/sys/kernel/real-root-dev +.IR /proc/sys/kernel/real-root-dev to change the root file system is obsolete. See the kernel source file .I Documentation/initrd.txt @@ -261,11 +265,11 @@ A possible system installation scenario is as follows: .PP 1. The loader program boots from floppy or other media with a minimal kernel (e.g. support for -.BR /dev/ram ", " /dev/initrd ", and the ext2 file-system) and loads " -.BR /dev/initrd " with a gzipped version of the initial file-system. +.IR /dev/ram ", " /dev/initrd ", and the ext2 file-system) and loads " +.IR /dev/initrd " with a gzipped version of the initial file-system. .PP 2. The executable -.BR /linuxrc +.IR /linuxrc determines what is needed to (1) mount the normal root file-system (i.e. device type, device drivers, file system) and (2) the distribution media (e.g. CD-ROM, network, tape, ...). This can be @@ -273,19 +277,19 @@ done by asking the user, by auto-probing, or by using a hybrid approach. .PP 3. The executable -.BR /linuxrc +.IR /linuxrc loads the necessary modules from the initial root file-system. .PP 4. The executable -.BR /linuxrc +.IR /linuxrc creates and populates the root file system. (At this stage the normal root file system does not have to be a completed system yet.) .PP 5. The executable -.BR /linuxrc " sets " /proc/sys/kernel/real-root-dev, +.IR /linuxrc " sets " /proc/sys/kernel/real-root-dev, unmount -.BR /proc ", " +.IR /proc ", " the normal root file system and any other file systems it has mounted, and then terminates. .PP @@ -295,12 +299,12 @@ systems it has mounted, and then terminates. the boot loader can be installed. .PP 8. The boot loader is configured to load into -.BR /dev/initrd +.IR /dev/initrd a file system with the set of modules that was used to bring up the system. (e.g. Device -.BR /dev/ram0 +.IR /dev/ram0 can be modified, then unmounted, and finally, the image is written from -.BR /dev/ram0 +.IR /dev/ram0 to a file.) .PP 9. The system is now bootable and additional installation tasks can be @@ -308,7 +312,7 @@ performed. .RE .PP The key role of -.BR /dev/initrd +.IR /dev/initrd in the above is to re-use the configuration data during normal system operation without requiring initial kernel selection, a large generic kernel or, recompiling the kernel. @@ -321,15 +325,15 @@ information as small as possible. In this case, create a common file with all needed modules. Then, only the -.B /linuxrc +.I /linuxrc file or a file executed by -.B /linuxrc +.I /linuxrc would be different. .PP A third scenario is more convenient recovery disks. Because information like the location of the root file-system partition is not needed at boot time, the system loaded from -.B /dev/initrd +.I /dev/initrd can use a dialog and/or auto-detection followed by a possible sanity check. .PP @@ -339,27 +343,27 @@ for easy installation from the CD-ROM. The distribution can use .BR LOADLIN to directly load -.BR /dev/initrd +.IR /dev/initrd from CD-ROM without the need of any floppies. The distribution could also use a .BR LILO boot floppy and then bootstrap a bigger ram disk via -.BR /dev/initrd " from the CD-ROM." +.IR /dev/initrd " from the CD-ROM." .\" .\" .\" .SH CONFIGURATION The -.B /dev/initrd +.I /dev/initrd is a read-only block device assigned major number 1 and minor number 250. Typically -.B /dev/initrd +.I /dev/initrd is owned by -.B root.disk +.I root.disk with mode 0400 (read access by root only). If the Linux system does not have -.B /dev/initrd +.I /dev/initrd already created, it can be created with the following commands: .nf \fB @@ -371,9 +375,9 @@ Also, support for both "RAM disk" and "Initial RAM disk" (e.g. .BR CONFIG_BLK_DEV_RAM=y " and " CONFIG_BLK_DEV_INITRD=y ) support must be compiled directly into the Linux kernel to use -.BR /dev/initrd "." +.IR /dev/initrd "." When using -.BR /dev/initrd ", " +.IR /dev/initrd ", " the RAM disk driver cannot be loaded as a module. .\" .\" @@ -402,24 +406,25 @@ the LOADLIN documentation, the SYSLINUX documentation. .\" .SH NOTES 1. With the current kernel, any file systems that remain mounted when -.BR /dev/ram0 " is moved from " / " to " /initrd +.IR /dev/ram0 " is moved from " / " to " /initrd continue to be accessible. However, the -.BR /proc/mounts +.IR /proc/mounts entries are not updated. .PP 2. With the current kernel, if directory -.BR /initrd " does not exist, then " /dev/ram0 +.IR /initrd " does not exist, then " +.I /dev/ram0 will NOT be fully unmounted if -.BR /dev/ram0 +.IR /dev/ram0 is used by any process or has any file-system mounted on it. If -.BR /dev/ram0 " is NOT fully unmounted, " +.IR /dev/ram0 " is NOT fully unmounted, " then -.BR /dev/ram0 +.IR /dev/ram0 will remain in memory. .PP 3. Users of -.BR /dev/initrd +.IR /dev/initrd should not depend on the behavior give in the above notes. The behavior may change in future versions of the Linux kernel. .\" diff --git a/man4/pts.4 b/man4/pts.4 index 1d77ff68d..e58f7c7a9 100644 --- a/man4/pts.4 +++ b/man4/pts.4 @@ -7,15 +7,15 @@ .SH NAME ptmx and pts \- pseudo-terminal master and slave .SH DESCRIPTION -The file \fB/dev/ptmx\fP is a character file with major number 5 and +The file \fI/dev/ptmx\fP is a character file with major number 5 and minor number 2, usually of mode 0666 and owner.group of root.root. It is used to create a pseudo-terminal master and slave pair. .PP -When a process opens \fB/dev/ptmx\fP, it gets a file +When a process opens \fI/dev/ptmx\fP, it gets a file descriptor for a pseudo-terminal master (PTM), and a pseudo-terminal slave (PTS) device is created in the .I /dev/pts -directory. Each file descriptor obtained by opening \fB/dev/ptmx\fP +directory. Each file descriptor obtained by opening \fI/dev/ptmx\fP is an independent PTM with its own associated PTS, whose path can be found by passing the descriptor to .BR ptsname (3). diff --git a/man4/random.4 b/man4/random.4 index 9a78bc666..b02a56416 100644 --- a/man4/random.4 +++ b/man4/random.4 @@ -14,11 +14,11 @@ .SH NAME random, urandom \- kernel random number source devices .SH DESCRIPTION -The character special files \fB/dev/random\fP and -\fB/dev/urandom\fP (present since Linux 1.3.30) +The character special files \fI/dev/random\fP and +\fI/dev/urandom\fP (present since Linux 1.3.30) provide an interface to the kernel's random number generator. -File \fB/dev/random\fP has major device number 1 -and minor device number 8. File \fB/dev/urandom\fP +File \fI/dev/random\fP has major device number 1 +and minor device number 8. File \fI/dev/urandom\fP has major device number 1 and minor device number 9. .LP The random number generator gathers environmental noise @@ -27,25 +27,25 @@ The generator also keeps an estimate of the number of bits of noise in the entropy pool. From this entropy pool random numbers are created. .LP -When read, the \fB/dev/random\fP device will only return random bytes +When read, the \fI/dev/random\fP device will only return random bytes within the estimated number of bits of noise in the entropy -pool. \fB/dev/random\fP should be suitable for uses that need very +pool. \fI/dev/random\fP should be suitable for uses that need very high quality randomness such as one-time pad or key generation. -When the entropy pool is empty, reads from \fB/dev/random\fP will block +When the entropy pool is empty, reads from \fI/dev/random\fP will block until additional environmental noise is gathered. .LP -A read from the \fB/dev/urandom\fP device will not block +A read from the \fI/dev/urandom\fP device will not block waiting for more entropy. As a result, if there is not sufficient entropy in the entropy pool, the returned values are theoretically vulnerable to a cryptographic attack on the algorithms used by the driver. Knowledge of how to do this is not available in the current non-classified literature, but it is theoretically possible that such an attack may -exist. If this is a concern in your application, use \fB/dev/random\fP +exist. If this is a concern in your application, use \fI/dev/random\fP instead. .SH CONFIGURING If your system does not have -\fB/dev/random\fP and \fB/dev/urandom\fP created already, they +\fI/dev/random\fP and \fI/dev/urandom\fP created already, they can be created with the following commands: .nf @@ -96,7 +96,7 @@ run during the Linux system shutdown: The files in the directory .I /proc/sys/kernel/random (present since 2.3.16) provide an additional interface to the -.B /dev/random +.I /dev/random device. .LP The read-only file diff --git a/man4/sd.4 b/man4/sd.4 index a28b6c1ab..3d0fd3c26 100644 --- a/man4/sd.4 +++ b/man4/sd.4 @@ -55,10 +55,10 @@ partitions 1-4 are the DOS "primary" partitions partitions 5-8 are the DOS "extended" (or "logical") partitions For example, -.B /dev/sda +.I /dev/sda will have major 8, minor 0, and will refer to all of the first SCSI drive in the system; and -.B /dev/sdb3 +.I /dev/sdb3 will have major 8, minor 19, and will refer to the third DOS "primary" partition on the second SCSI drive in the system. diff --git a/man4/sk98lin.4 b/man4/sk98lin.4 index 5a271ca94..d16a23479 100644 --- a/man4/sk98lin.4 +++ b/man4/sk98lin.4 @@ -422,11 +422,11 @@ and are designed to operate in configurations where a network path between the ports on one adapter exists. Moreover, they are not designed to work where adapters are connected back-to-back. .SH FILES .TP -.B /proc/net/sk98lin/eth[x] +.I /proc/net/sk98lin/eth[x] .br The statistics file of a particular interface of an adapter card. It contains generic information about the adapter card plus a detailed summary of all transmit and receive counters. .TP -.B /usr/src/linux/Documentation/network/sk98lin.txt +.I /usr/src/linux/Documentation/network/sk98lin.txt .br This is the .IR README diff --git a/man4/st.4 b/man4/st.4 index 1c0ee7076..a1f69f770 100644 --- a/man4/st.4 +++ b/man4/st.4 @@ -142,12 +142,12 @@ compile-time constant (originally four). The driver contains an that can format a tape with either one or two partitions. .PP Device -.B /dev/tape +.I /dev/tape is usually created as a hard or soft link to the default tape device on the system. .PP Starting from kernel 2.6.2, the driver exports in the sysfs directory -.BR /sys/class/scsi_tape +.IR /sys/class/scsi_tape the attached devices and some parameters assigned to the devices. .SH "DATA TRANSFER" The driver supports operation in both fixed-block mode and @@ -202,11 +202,11 @@ driver are passed to the .B SCSI driver. The definitions below are from -.BR /usr/include/linux/mtio.h : +.IR /usr/include/linux/mtio.h : .SS "\s-1MTIOCTOP\s+1 \(em Perform a tape operation" .PP This request takes an argument of type -.BR "(struct mtop *)" . +.IR "(struct mtop *)" . Not all drives support all operations. The driver returns an EIO error if the drive rejects an operation. .PP @@ -537,7 +537,7 @@ the masked sense data byte. .SS "\s-1MTIOCGET\s+1 \(em Get status" .PP This request takes an argument of type -.BR "(struct mtget *)" . +.IR "(struct mtget *)" . .PP .nf /* structure for \s-1MTIOCGET\s+1 \- mag tape get status command */ @@ -637,7 +637,7 @@ This value is set to \-1 when the block number is unknown (e.g., after .SS "\s-1MTIOCPOS\s+1 \(em Get tape position" .PP This request takes an argument of type -.B "(struct mtpos *)" +.I "(struct mtpos *)" and reports the drive's notion of the current tape block number, which is not the same as .B mt_blkno diff --git a/man4/tty.4 b/man4/tty.4 index a06bdcfe4..575d69881 100644 --- a/man4/tty.4 +++ b/man4/tty.4 @@ -27,7 +27,7 @@ .SH NAME tty \- controlling terminal .SH DESCRIPTION -The file \fB/dev/tty\fP is a character file with major number 5 and +The file \fI/dev/tty\fP is a character file with major number 5 and minor number 0, usually of mode 0666 and owner.group root.tty. It is a synonym for the controlling terminal of a process, if any. .LP @@ -41,9 +41,9 @@ then SIGHUP and SIGCONT signals are sent to the foreground process group and all processes in the current session lose their controlling tty. .sp This \fBioctl\fP() call only works on file descriptors connected -to \fB/dev/tty\fP. It is used by daemon processes when they are invoked +to \fI/dev/tty\fP. It is used by daemon processes when they are invoked by a user at a terminal. -The process attempts to open \fB/dev/tty\fP. If the open succeeds, it +The process attempts to open \fI/dev/tty\fP. If the open succeeds, it detaches itself from the terminal by using \fBTIOCNOTTY\fP, while if the open fails, it is obviously not attached to a terminal and does not need to detach itself. diff --git a/man4/tty_ioctl.4 b/man4/tty_ioctl.4 index e35525838..4352d3a5a 100644 --- a/man4/tty_ioctl.4 +++ b/man4/tty_ioctl.4 @@ -54,9 +54,9 @@ set the current serial port settings. .LP The following four ioctls are just like TCGETS, TCSETS, TCSETSW, TCSETSF, except that they take a -.B "struct termio *" +.I "struct termio *" instead of a -.BR "struct termios *" . +.IR "struct termios *" . .TP .BI "TCGETA struct termio *" argp .TP diff --git a/man4/vcs.4 b/man4/vcs.4 index 462d9140a..99f8db388 100644 --- a/man4/vcs.4 +++ b/man4/vcs.4 @@ -27,14 +27,14 @@ .SH NAME vcs, vcsa \- virtual console memory .SH DESCRIPTION -\fB/dev/vcs0\fP is a character device with major number 7 and minor number +\fI/dev/vcs0\fP is a character device with major number 7 and minor number 0, usually of mode 0644 and owner root.tty. It refers to the memory of the currently displayed virtual console terminal. .LP -\fB/dev/vcs[1\-63]\fP are character devices for virtual console +\fI/dev/vcs[1\-63]\fP are character devices for virtual console terminals, they have major number 7 and minor number 1 to 63, usually -mode 0644 and owner root.tty. \fB/dev/vcsa[0\-63]\fP are the same, but +mode 0644 and owner root.tty. \fI/dev/vcsa[0\-63]\fP are the same, but including attributes, and prefixed with four bytes giving the screen dimensions and cursor position: \fIlines\fP, \fIcolumns\fP, \fIx\fP, \fIy\fP. (\fIx\fP = \fIy\fP = 0 at the top left corner of the screen.) diff --git a/man5/acct.5 b/man5/acct.5 index ae68b47d8..726a69f21 100644 --- a/man5/acct.5 +++ b/man5/acct.5 @@ -36,7 +36,7 @@ acct("/somewhere/accountingfile"); will start the process accounting. Each time a process terminates a record for this process is appended to the accounting file. The accounting structure -.B "struct acct" +.I "struct acct" is also described in the file .IR /usr/include/linux/acct.h . .SH "SEE ALSO" diff --git a/man5/group.5 b/man5/group.5 index 1356ddb12..2263c9f4a 100644 --- a/man5/group.5 +++ b/man5/group.5 @@ -25,7 +25,7 @@ .SH NAME group \- user group file .SH DESCRIPTION -\fB/etc/group\fP is an ASCII file which defines the groups to which users +\fI/etc/group\fP is an ASCII file which defines the groups to which users belong. There is one entry per line, and each line has the format: .sp .RS diff --git a/man5/ipc.5 b/man5/ipc.5 index 5ae475799..17de24735 100644 --- a/man5/ipc.5 +++ b/man5/ipc.5 @@ -46,7 +46,7 @@ In the following, the word means an instantiation of one among such mechanisms. .SS Resource Access Permissions For each resource, the system uses a common structure of type -.BR "struct ipc_perm" +.IR "struct ipc_perm" to store information needed in determining permissions to perform an ipc operation. The @@ -137,7 +137,7 @@ type variable. A message queue is uniquely identified by a positive integer .RI "(its " msqid ) and has an associated data structure of type -.BR "struct msqid_ds" , +.IR "struct msqid_ds" , defined in .IR , containing the following members: @@ -214,7 +214,7 @@ structure. A semaphore set is uniquely identified by a positive integer .RI "(its " semid ) and has an associated data structure of type -.BR "struct semid_ds" , +.IR "struct semid_ds" , defined in .IR , containing the following members: @@ -259,7 +259,7 @@ to .BR sem_nsems\-1 . .PP A semaphore is a data structure of type -.B "struct sem" +.I "struct sem" containing the following members: .sp .B @@ -298,7 +298,7 @@ to become zero. A shared memory segment is uniquely identified by a positive integer .RI "(its " shmid ) and has an associated data structure of type -.BR "struct shmid_ds" , +.IR "struct shmid_ds" , defined in .IR , containing the following members: diff --git a/man5/issue.5 b/man5/issue.5 index 27ca843a5..cbc4e31ef 100644 --- a/man5/issue.5 +++ b/man5/issue.5 @@ -26,7 +26,7 @@ .SH NAME issue \- pre-login message and identification file .SH DESCRIPTION -The file \fB/etc/issue\fP is a text file which contains a message or +The file \fI/etc/issue\fP is a text file which contains a message or system identification to be printed before the login prompt. It may contain various \fB@\fP\fIchar\fP and \fB\e\fP\fIchar\fP sequences, if supported by diff --git a/man5/locale.5 b/man5/locale.5 index f583e9e86..3dc9e9778 100644 --- a/man5/locale.5 +++ b/man5/locale.5 @@ -280,7 +280,7 @@ and is terminated with the keyword .PP For more details see the sources in -.B /usr/lib/nls/src +.I /usr/lib/nls/src notably the examples .BR POSIX , .B Example diff --git a/man5/motd.5 b/man5/motd.5 index 904b0258b..31de11b89 100644 --- a/man5/motd.5 +++ b/man5/motd.5 @@ -26,7 +26,7 @@ .SH NAME motd \- message of the day .SH DESCRIPTION -The contents of \fB/etc/motd\fP are displayed by +The contents of \fI/etc/motd\fP are displayed by .BR login (1) after a successful login but just before it executes the login shell. diff --git a/man5/nologin.5 b/man5/nologin.5 index 5fb01379a..02490a41b 100644 --- a/man5/nologin.5 +++ b/man5/nologin.5 @@ -26,7 +26,7 @@ .SH NAME nologin \- prevent non-root users from logging into the system .SH DESCRIPTION -If the file \fB/etc/nologin\fP exists, +If the file \fI/etc/nologin\fP exists, .BR login (1) will allow access only to root. Other users will be shown the contents of this file and their logins will be refused. diff --git a/man5/nscd.conf.5 b/man5/nscd.conf.5 index d7c103e55..39a4ebf1f 100644 --- a/man5/nscd.conf.5 +++ b/man5/nscd.conf.5 @@ -22,7 +22,7 @@ /etc/nscd.conf \- name service cache daemon configuration file .SH DESCRIPTION The file -.B /etc/nscd.conf +.I /etc/nscd.conf is read from .BR nscd (8) at startup. Each line specifies either an attribute and a value, or an diff --git a/man5/nsswitch.conf.5 b/man5/nsswitch.conf.5 index e3557d41c..583342241 100644 --- a/man5/nsswitch.conf.5 +++ b/man5/nsswitch.conf.5 @@ -38,7 +38,7 @@ contain a cleaner solution of this problem. It is designed after a method used by Sun Microsystems in the C library of Solaris 2. We follow their name and call this scheme "Name Service Switch" (NSS). The sources for the "databases" and their lookup order are specified in the -.B /etc/nsswitch.conf +.I /etc/nsswitch.conf file. .LP The following databases are available in the NSS: @@ -98,9 +98,9 @@ Shadow user passwords, used by .BR getspnam (3). .LP An example -.B /etc/nsswitch.conf +.I /etc/nsswitch.conf (namely, the default used when -.B /etc/nsswitch.conf +.I /etc/nsswitch.conf is missing): .sp 1n .PD 0 @@ -202,20 +202,20 @@ default action is `continue'. .SS Interaction with +/\- syntax (compat mode) Linux libc5 without NYS does not have the name service switch but does allow the user some policy control. In -.B /etc/passwd +.I /etc/passwd you could have entries of the form +user or +@netgroup (include the specified user from the NIS passwd map), \-user or \-@netgroup (exclude the specified user), and + (include every user, except the excluded ones, from the NIS passwd map). Since most people only put a + at the end of -.B /etc/passwd +.I /etc/passwd to include everything from NIS, the switch provides a faster alternative for this case (`passwd: files nis') which doesn't require the single + entry in -.BR /etc/passwd , -.BR /etc/group , +.IR /etc/passwd , +.IR /etc/group , and -.BR /etc/shadow . +.IR /etc/shadow . If this is not sufficient, the NSS `compat' service provides full +/\- semantics. By default, the source is `nis', but this may be overridden by specifying `nisplus' as source for the pseudo-databases @@ -231,7 +231,7 @@ that resides in .IR /lib . .TP 25 .PD 0 -.B /etc/nsswitch.conf +.I /etc/nsswitch.conf configuration file .TP .BI /lib/libnss_compat.so. X @@ -252,7 +252,7 @@ implements `hesiod' source for glibc2 .BI /lib/libnss_nis.so. X implements `nis' source for glibc2 .TP -.B /lib/libnss_nisplus.so.2 +.I /lib/libnss_nisplus.so.2 implements `nisplus' source for glibc 2.1 .SH NOTES Within each process that uses diff --git a/man5/passwd.5 b/man5/passwd.5 index 139762607..948deb22a 100644 --- a/man5/passwd.5 +++ b/man5/passwd.5 @@ -95,7 +95,7 @@ the user's $HOME directory. .TP .I shell the program to run at login (if empty, use -.BR /bin/sh ). +.IR /bin/sh ). If set to a non-existing executable, the user will be unable to login through .BR login (1). diff --git a/man5/shells.5 b/man5/shells.5 index cd7d091cb..2da5cb376 100644 --- a/man5/shells.5 +++ b/man5/shells.5 @@ -27,7 +27,7 @@ .SH NAME shells \- pathnames of valid login shells .SH DESCRIPTION -.B /etc/shells +.I /etc/shells is a text file which contains the full pathnames of valid login shells. This file is consulted by .BR chsh (1) @@ -37,7 +37,7 @@ Be aware that there are programs which consult this file to find out if a user is a normal user. E.g.: ftp daemons traditionally disallow access to users with shells not included in this file. .SH EXAMPLES -.B /etc/shells +.I /etc/shells may contain the following paths: .sp .RS diff --git a/man5/termcap.5 b/man5/termcap.5 index 098c367b8..97ef42ea5 100644 --- a/man5/termcap.5 +++ b/man5/termcap.5 @@ -35,7 +35,7 @@ only for capability with old programs; new ones should use the .BR terminfo (5) database and associated libraries. .LP -.B /etc/termcap +.I /etc/termcap is an ASCII file (the database master) that lists the capabilities of many different types of terminals. Programs can read termcap to find the particular escape codes needed to control the visual attributes of diff --git a/man5/tzfile.5 b/man5/tzfile.5 index 04bba0cdf..a0e5ee7f1 100644 --- a/man5/tzfile.5 +++ b/man5/tzfile.5 @@ -14,7 +14,7 @@ begin with the magic characters "TZif" to identify then as time zone information files, followed by sixteen bytes reserved for future use, followed by six four-byte values of type -.BR long , +.IR long , written in a ``standard'' byte order (the high-order byte of the value is written first). These values are, diff --git a/man7/LDP.7 b/man7/LDP.7 index 28f003408..774e174ee 100644 --- a/man7/LDP.7 +++ b/man7/LDP.7 @@ -73,13 +73,13 @@ for more information. Most distributions include the HOWTOs and mini-HOWTOs in the installation .PD 0 .TP -\fB/usr/doc/\fP (old place for documentation) +\fI/usr/doc/\fP (old place for documentation) .TP -\fB/usr/share/doc/\fP (new place for documentation) +\fI/usr/share/doc/\fP (new place for documentation) .TP -\fB/usr/share/doc/HOWTO/\fP (HOWTO files) +\fI/usr/share/doc/HOWTO/\fP (HOWTO files) .TP -\fB/usr/share/doc/HOWTO/mini/\fP (mini-HOWTO files) +\fI/usr/share/doc/HOWTO/mini/\fP (mini-HOWTO files) .PD .SH "SEE ALSO" .BR info (1), diff --git a/man7/arp.7 b/man7/arp.7 index de49b382f..dacd09e1f 100644 --- a/man7/arp.7 +++ b/man7/arp.7 @@ -64,7 +64,7 @@ Three ioctls are available on all .B PF_INET sockets. They take a pointer to a -.B struct arpreq +.I struct arpreq as their parameter. .nf @@ -126,7 +126,7 @@ is obsolete and should not be used. ARP supports a sysctl interface to configure parameters on a global or per-interface basis. The sysctls can be accessed by reading or writing the -.B /proc/sys/net/ipv4/neigh/*/* +.I /proc/sys/net/ipv4/neigh/*/* files or with the .BR sysctl (2) interface. Each interface in the system has its own directory in @@ -240,7 +240,7 @@ functionality together. .SH VERSIONS The -.B struct arpreq +.I struct arpreq changed in Linux 2.0 to include the .I arp_dev member and the ioctl numbers changed at the same time. diff --git a/man7/boot.7 b/man7/boot.7 index ff697d6b4..89330cfee 100644 --- a/man7/boot.7 +++ b/man7/boot.7 @@ -146,7 +146,7 @@ without parameters displays the possible arguments. .SS "Sequencing Directories" To make specific scripts start/stop at specific run-levels and in specific order, there are \fIsequencing directories\fR. These -are normally in \fB/etc/rc[0\-6S].d\fR. In each of these directories +are normally in \fI/etc/rc[0\-6S].d\fR. In each of these directories there are links (usually symbolic) to the scripts in the \fIinit.d\fR directory. diff --git a/man7/ddp.7 b/man7/ddp.7 index e67e58202..1fe698645 100644 --- a/man7/ddp.7 +++ b/man7/ddp.7 @@ -75,10 +75,10 @@ struct sockaddr_atalk { .PP .I sat_family is always set to -.B AF_APPLETALK. +.BR AF_APPLETALK . .I sat_port contains the port. The port numbers below 129 are known as -.B reserved ports. +.I reserved ports. Only processes with the effective user ID 0 or the .B CAP_NET_BIND_SERVICE capability may @@ -89,7 +89,7 @@ is the host address. The .I net member of -.B struct at_addr +.I struct at_addr contains the host network in network byte order. The value of .B AT_ANYNET is a @@ -97,7 +97,7 @@ wildcard and also implies \(lqthis network.\(rq The .I node member of -.B struct at_addr +.I struct at_addr contains the host node number. The value of .B AT_ANYNODE is a @@ -111,7 +111,7 @@ No protocol-specific socket options are supported. .SH SYSCTLS IP supports a sysctl interface to configure some global AppleTalk parameters. The sysctls can be accessed by reading or writing the -.B /proc/sys/net/atalk/* +.I /proc/sys/net/atalk/* files or with the .BR sysctl (2) interface. diff --git a/man7/icmp.7 b/man7/icmp.7 index 10ece8939..9bf75c620 100644 --- a/man7/icmp.7 +++ b/man7/icmp.7 @@ -34,7 +34,7 @@ are also limited by the destination route of the incoming packets. .SH SYSCTLS ICMP supports a sysctl interface to configure some global IP parameters. The sysctls can be accessed by reading or writing the -.B /proc/sys/net/ipv4/* +.I /proc/sys/net/ipv4/* files or with the .BR sysctl (2) interface. Most of these sysctls are rate limitations for specific ICMP types. diff --git a/man7/ip.7 b/man7/ip.7 index 280dde518..ccbc840bd 100644 --- a/man7/ip.7 +++ b/man7/ip.7 @@ -106,7 +106,7 @@ are implemented by higher level protocols like and .BR tcp (7). On raw sockets -.B sin_port +.I sin_port is set to the IP protocol. .PP @@ -152,9 +152,9 @@ is the IP host address. The .I addr member of -.B struct in_addr +.I struct in_addr contains the host interface address in network order. -.B in_addr +.I in_addr should be only accessed using the .BR inet_aton (3), .BR inet_addr (3), @@ -235,7 +235,7 @@ puts the current IP options used for sending into the supplied buffer. Pass an .I IP_PKTINFO ancillary message that contains a -.B pktinfo +.I pktinfo structure that supplies some information about the incoming packet. This only works for datagram oriented sockets. The argument is a flag that tells the socket whether the IP_PKTINFO message @@ -258,11 +258,11 @@ struct in_pktinfo { .RE .IP .\" FIXME elaborate on that. -.B ipi_ifindex +.I ipi_ifindex is the unique index of the interface the packet was received on. -.B ipi_spec_dst +.I ipi_spec_dst is the local address of the packet and -.B ipi_addr +.I ipi_addr is the destination address in the packet header. If .I IP_PKTINFO @@ -270,11 +270,11 @@ is passed to .BR sendmsg (2) and .\" This field is grossly misnamed -.B ipi_spec_dst +.I ipi_spec_dst is not zero, then it is used as the local source address for the routing table lookup and for setting up IP source route options. When -.B ipi_ifindex +.I ipi_ifindex is not zero the primary local address of the interface specified by the index overwrites .I ipi_spec_dst @@ -374,7 +374,7 @@ be received by calling with the .B MSG_ERRQUEUE flag set. The -.B sock_extended_err +.I sock_extended_err structure describing the error will be passed in a ancillary message with the type .I IP_RECVERR @@ -388,7 +388,7 @@ contains the error packet. The .I IP_RECVERR control message contains a -.B sock_extended_err +.I sock_extended_err structure: .IP .RS @@ -416,9 +416,9 @@ struct sockaddr *SO_EE_OFFENDER(struct sock_extended_err *); .fi .RE .IP -.B ee_errno +.I ee_errno contains the errno number of the queued error. -.B ee_origin +.I ee_origin is the origin code of where the error originated. The other fields are protocol specific. The macro .B SO_EE_OFFENDER @@ -427,15 +427,15 @@ where the error originated from given a pointer to the ancillary message. If this address is not known, the .I sa_family member of the -.B sockaddr +.I sockaddr contains .B AF_UNSPEC and the other fields of the -.B sockaddr +.I sockaddr are undefined. .IP IP uses the -.B sock_extended_err +.I sock_extended_err structure as follows: .I ee_origin is set to @@ -594,8 +594,8 @@ packets should be looped back to the local sockets. .\" .TP .B IP_ADD_MEMBERSHIP -Join a multicast group. Argument is a -.B struct ip_mreqn +Join a multicast group. Argument is an +.I ip_mreqn structure. .PP .RS @@ -625,9 +625,9 @@ is the interface index of the interface that should join/leave the group, or 0 to indicate any interface. .IP For compatibility, the old -.B ip_mreq +.I ip_mreq structure is still supported. It differs from -.B ip_mreqn +.I ip_mreqn only by not including the .I imr_ifindex @@ -637,18 +637,18 @@ field. Only valid as a .TP .B IP_DROP_MEMBERSHIP Leave a multicast group. Argument is an -.B ip_mreqn +.I ip_mreqn or -.B ip_mreq +.I ip_mreq structure similar to .IR IP_ADD_MEMBERSHIP . .\" .TP .B IP_MULTICAST_IF Set the local device for a multicast socket. Argument is an -.B ip_mreqn +.I ip_mreqn or -.B ip_mreq +.I ip_mreq structure similar to .IR IP_ADD_MEMBERSHIP . .IP @@ -659,7 +659,7 @@ is returned. The IP protocol supports the sysctl interface to configure some global options. The sysctls can be accessed by reading or writing the -.B /proc/sys/net/ipv4/* +.I /proc/sys/net/ipv4/* files or using the .\" FIXME As at 2.6.12, 14 Jun 2005, the following are undocumented: .\" ip_queue_maxlen @@ -926,7 +926,7 @@ are new options in Linux 2.2. They are also all Linux specific and should not be used in programs intended to be portable. .PP -.B struct ip_mreqn +.I struct ip_mreqn is new in Linux 2.2. Linux 2.0 only supported .BR ip_mreq . .PP @@ -940,7 +940,7 @@ socket. This is deprecated and should be replaced by .BI "socket(PF_PACKET, SOCK_RAW, " protocol ) instead. The main difference is the new -.B sockaddr_ll +.I sockaddr_ll address structure for generic link layer information instead of the old .BR sockaddr_pkt . .SH BUGS diff --git a/man7/ipv6.7 b/man7/ipv6.7 index 3c65bb3a3..78633030f 100644 --- a/man7/ipv6.7 +++ b/man7/ipv6.7 @@ -77,7 +77,7 @@ struct in6_addr { .sp .B sin6_family is always set to -.B AF_INET6; +.BR AF_INET6 ; .B sin6_port is the protocol port (see .B sin_port @@ -143,7 +143,7 @@ socket into a socket of a different address family. Only is currently supported for that. It is only allowed for IPv6 sockets that are connected and bound to a v4-mapped-on-v6 address. The argument is a pointer to a integer containing -.B AF_INET. +.BR AF_INET . This is useful to pass v4-mapped sockets as file descriptors to programs that don't know how to deal with the IPv6 API. .TP @@ -189,7 +189,7 @@ Argument is a pointer to boolean. .TP .B IPV6_ADD_MEMBERSHIP, IPV6_DROP_MEMBERSHIP Control membership in multicast groups. Argument is a pointer to a -.B struct ipv6_mreq +.I struct ipv6_mreq structure. .TP .B IPV6_MTU @@ -239,13 +239,13 @@ when the passed address length contains it. Some programs that pass a longer address buffer and then check the outgoing address length may break. .SH "PORTING NOTES" The -.B sockaddr_in6 +.I sockaddr_in6 structure is bigger than the generic -.B sockaddr. +.BR sockaddr . Programs that assume that all address types can be stored safely in a -.B struct sockaddr +.I struct sockaddr need to be changed to use -.B struct sockaddr_storage +.I struct sockaddr_storage for that instead. .SH BUGS The IPv6 extended API as in RFC\ 2292 is currently only partly implemented; diff --git a/man7/locale.7 b/man7/locale.7 index ad2994944..ecc0aa0ec 100644 --- a/man7/locale.7 +++ b/man7/locale.7 @@ -135,7 +135,7 @@ the value of is used. .PP Values about local numeric formatting is made available in a -.B struct lconv +.I struct lconv returned by the .BR localeconv () function, which has the following declaration: diff --git a/man7/packet.7 b/man7/packet.7 index f2ad62daf..251be91b0 100644 --- a/man7/packet.7 +++ b/man7/packet.7 @@ -74,7 +74,7 @@ are passed to a packet socket. To only get packets from a specific interface use .BR bind (2) specifying an address in a -.B struct sockaddr_ll +.I struct sockaddr_ll to bind the packet socket to an interface. Only the .B sll_protocol and the @@ -219,7 +219,7 @@ can be used for the same purpose. .B SIOCGSTAMP can be used to receive the time stamp of the last received packet. Argument is a -.B struct timeval. +.I struct timeval. In addition all standard ioctls defined in .BR netdevice (7) @@ -239,7 +239,7 @@ This is still supported but strongly deprecated. The main difference between the two methods is that .B SOCK_PACKET uses the old -.B struct sockaddr_pkt +.I struct sockaddr_pkt to specify an interface, which doesn't provide physical layer independence. .RS @@ -289,7 +289,7 @@ multiplexed on the DSAP/SSAP protocol fields; instead they are supplied to the user as protocol .B ETH_P_802_2 with the LLC header prepended. It is thus not possible to bind to -.B ETH_P_802_3; +.BR ETH_P_802_3 ; bind to .B ETH_P_802_2 instead and do the protocol multiplex yourself. diff --git a/man7/raw.7 b/man7/raw.7 index 929ef0ff1..0c8aa7cb1 100644 --- a/man7/raw.7 +++ b/man7/raw.7 @@ -140,7 +140,7 @@ A raw socket can be bound to a specific local address using the .BR bind (2) call. If it isn't bound all packets with the specified IP protocol are received. In addition a RAW socket can be bound to a specific network device using -.B SO_BINDTODEVICE; +.BR SO_BINDTODEVICE ; see .BR socket (7). @@ -174,7 +174,7 @@ RAW sockets are generally rather unportable and should be avoided in programs intended to be portable. Sending on raw sockets should take the IP protocol from -.B sin_port; +.BR sin_port ; this ability was lost in Linux 2.2. Work around is to use .BR IP_HDRINCL . diff --git a/man7/rtnetlink.7 b/man7/rtnetlink.7 index 0fb711689..8842e3a28 100644 --- a/man7/rtnetlink.7 +++ b/man7/rtnetlink.7 @@ -133,7 +133,7 @@ struct ifaddrmsg is the address family type (currently .B AF_INET or -.B AF_INET6), +.BR AF_INET6 ), .B ifa_prefixlen is the length of the address mask of the address if defined for the family (like for IPv4), @@ -402,16 +402,16 @@ If the field is .B NDA_CACHEINFO then a -.B struct nda_cacheinfo +.I struct nda_cacheinfo header follows .TP .BR RTM_NEWRULE ", " RTM_DELRULE ", " RTM_GETRULE Add, delete or retrieve a routing rule. Carries a -.B struct rtmsg +.I struct rtmsg .TP .BR RTM_NEWQDISC ", " RTM_DELQDISC ", " RTM_GETQDISC Add, remove or get a queueing discipline. The message contains a -.B struct tcmsg +.I struct tcmsg and may be followed by a series of attributes. @@ -447,13 +447,13 @@ For more information see the appropriate include files. .TP .BR RTM_NEWTCLASS ", " RTM_DELTCLASS ", " RTM_GETTCLASS Add, remove or get a traffic class. These messages contain a -.B struct tcmsg +.I struct tcmsg as described above. .TP .BR RTM_NEWTFILTER ", " RTM_DELTFILTER ", " RTM_GETTFILTER Add, remove or receive information about a traffic filter. These messages contain a -.B struct tcmsg +.I struct tcmsg as described above. .SH VERSIONS .B rtnetlink diff --git a/man7/socket.7 b/man7/socket.7 index 4eac632f9..870ae0de7 100644 --- a/man7/socket.7 +++ b/man7/socket.7 @@ -281,7 +281,7 @@ of the call to or .BR socketpair (2). Argument is a -.B ucred +.I ucred structure. Only valid as a .BR getsockopt (). @@ -372,7 +372,7 @@ sysctl. Sets or gets the .B SO_LINGER option. The argument is a -.B linger +.I linger structure. .PP .RS @@ -457,7 +457,7 @@ signal later. .\" .SH ANCILLARY MESSAGES .SH SYSCTLS The core socket networking sysctls can be accessed using the -.B /proc/sys/net/core/* +.I /proc/sys/net/core/* files or with the .BR sysctl (2) interface. @@ -504,12 +504,12 @@ These operations can be accessed using .TP .B SIOCGSTAMP Return a -.B struct timeval +.I struct timeval with the receive timestamp of the last packet passed to the user. This is useful for accurate round trip time measurements. See .BR setitimer (2) for a description of -.BR "struct timeval" . +.IR "struct timeval" . .\" .TP .BR SIOCSPGRP diff --git a/man7/tcp.7 b/man7/tcp.7 index 388d13b56..a673b7f66 100644 --- a/man7/tcp.7 +++ b/man7/tcp.7 @@ -146,7 +146,7 @@ communication; broadcasting and multicasting are not supported. .SH SYSCTLS These variables can be accessed by the -.B /proc/sys/net/ipv4/* +.I /proc/sys/net/ipv4/* files or with the .BR sysctl (2) interface. In addition, most IP sysctls also apply to TCP; see @@ -339,7 +339,7 @@ exceeds this number of pages, TCP moderates its memory consumption. This memory pressure state is exited once the number of pages allocated falls below the -.B low +.I low mark. .I high diff --git a/man7/unix.7 b/man7/unix.7 index c5ab72895..c5285d8f8 100644 --- a/man7/unix.7 +++ b/man7/unix.7 @@ -127,7 +127,7 @@ The passed file descriptors behave as though they have been created with .B SCM_CREDENTIALS Send or receive Unix credentials. This can be used for authentication. The credentials are passed as a -.B struct ucred +.I struct ucred ancillary message. .RS @@ -151,7 +151,7 @@ its user ID, effective user ID, or saved set-user-ID (unless it has and its group ID, effective group ID, or saved set-group-ID (unless it has .BR CAP_SETGID ). To receive a -.B struct ucred +.I struct ucred message the .B SO_PASSCRED option must be enabled on the socket. @@ -249,7 +249,7 @@ User memory address was not valid. .TP .B EPERM The sender passed invalid credentials in the -.BR "struct ucred" . +.IR "struct ucred" . .PP Other errors can be generated by the generic socket layer or by the filesystem while generating a filesystem socket object. See diff --git a/man7/x25.7 b/man7/x25.7 index 55677264b..5ab095f89 100644 --- a/man7/x25.7 +++ b/man7/x25.7 @@ -40,7 +40,7 @@ occurs, the X.25 connection will be reset. The .B AF_X25 socket address family uses the -.B struct sockaddr_x25 +.I struct sockaddr_x25 for representing network addresses as defined in ITU-T recommendation X.121. .PP diff --git a/man8/ld.so.8 b/man8/ld.so.8 index c4aafe35a..be271cbed 100644 --- a/man8/ld.so.8 +++ b/man8/ld.so.8 @@ -21,7 +21,7 @@ The program .B ld.so handles a.out binaries, a format used long ago; .B ld-linux.so* -handles ELF (\fB/lib/ld-linux.so.1\fP for libc5, \fB/lib/ld-linux.so.2\fP +handles ELF (\fI/lib/ld-linux.so.1\fP for libc5, \fI/lib/ld-linux.so.2\fP for glibc2), which everybody has been using for years now. Otherwise both have the same behaviour, and use the same support files and programs @@ -46,16 +46,16 @@ in which case it is ignored. of the binary if present. .IP o From the cache file -.BR /etc/ld.so.cache +.IR /etc/ld.so.cache which contains a compiled list of candidate libraries previously found in the augmented library path. If, however, the binary was linked with .B \-z nodeflib linker option, libraries in the default library paths are skipped. .IP o In the default path -.BR /lib , +.IR /lib , and then -.BR /usr/lib . +.IR /usr/lib . If the binary was linked with .B \-z nodeflib linker option, this step is skipped. @@ -67,7 +67,7 @@ which is stored in the .B .interp section of the program is executed) or directly by running: .P -.B /lib/ld-linux.so.* +.I /lib/ld-linux.so.* [OPTIONS] [PROGRAM [ARGUMENTS]] .SH COMMAND LINE OPTIONS .TP @@ -217,17 +217,17 @@ when none is present. .SH FILES .PD 0 .TP -.B /lib/ld.so +.I /lib/ld.so a.out dynamic linker/loader .TP -.BR /lib/ld\-linux.so. { 1 , 2 } +.IR /lib/ld\-linux.so. { 1 , 2 } ELF dynamic linker/loader .TP -.B /etc/ld.so.cache +.I /etc/ld.so.cache File containing a compiled list of directories in which to search for libraries and an ordered list of candidate libraries. .TP -.B /etc/ld.so.preload +.I /etc/ld.so.preload File containing a whitespace separated list of ELF shared libraries to be loaded before the program. libraries and an ordered list of candidate libraries. diff --git a/man8/ldconfig.8 b/man8/ldconfig.8 index 9e4a85c14..d048cda7b 100644 --- a/man8/ldconfig.8 +++ b/man8/ldconfig.8 @@ -81,11 +81,11 @@ Some existing libs do not contain enough information to allow the deduction of their type. Therefore, the .IR /etc/ld.so.conf file format allows the specification of an expected type. This is -.B only +.I only used for those ELF libs which we can not work out. The format is "dirname=TYPE", where TYPE can be libc4, libc5, or libc6. (This syntax also works on the command line.) Spaces are -.B not +.I not allowed. Also see the .B \-p option. @@ -137,7 +137,7 @@ instead of .TP .B \-r root Change to and use -.B root +.I root as the root directory. .TP .B \-l @@ -151,15 +151,15 @@ the current cache. .SH FILES .PD 0 .TP 20 -.B /lib/ld.so +.I /lib/ld.so run-time linker/loader .TP 20 -.B /etc/ld.so.conf +.I /etc/ld.so.conf File containing a list of colon, space, tab, newline, or comma-separated directories in which to search for libraries. .TP 20 -.B /etc/ld.so.cache +.I /etc/ld.so.cache File containing an ordered list of libraries found in the directories specified in -.BR /etc/ld.so.conf . +.IR /etc/ld.so.conf . .PD