diff options
| author | Michael Kerrisk <mtk.manpages@gmail.com> | 2005-10-19 07:29:28 +0000 |
|---|---|---|
| committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2005-10-19 07:29:28 +0000 |
| commit | e1d6264d9feaed449e70f288ebdd40d8abae818c (patch) | |
| tree | c3c8c2c31ecf22c1e9cb32458e485d02a695d3c6 | |
| parent | f8fc5a2301bcf0cbfaa1db15adedde386e26a081 (diff) | |
| download | man-pages-e1d6264d9feaed449e70f288ebdd40d8abae818c.tar.gz | |
Manual fixes for parentheses formatting
64 files changed, 229 insertions, 181 deletions
diff --git a/man2/_exit.2 b/man2/_exit.2 index 15dc13c2c8..8ff39798a6 100644 --- a/man2/_exit.2 +++ b/man2/_exit.2 @@ -52,7 +52,7 @@ The value .I status is returned to the parent process as the process's exit status, and can be collected using one of the -.B wait +.BR wait () family of calls. .LP The function diff --git a/man2/arch_prctl.2 b/man2/arch_prctl.2 index 92ff014ca7..e7301f03e8 100644 --- a/man2/arch_prctl.2 +++ b/man2/arch_prctl.2 @@ -72,7 +72,7 @@ pointed to by the .I address parameter. .SH NOTES -.I arch_prctl +.IR arch_prctl () is only supported on Linux/x86-64 for 64bit programs currently. The 64bit base changes when a new 32bit segment selector is loaded. @@ -96,7 +96,7 @@ with the flag. No prototype for -.I arch_prctl +.IR arch_prctl () in glibc 2.2. You have to declare it yourself for now. This will be fixed in future glibc versions. @@ -118,7 +118,7 @@ is outside the process address space. .SH AUTHOR Man page written by Andi Kleen. .SH CONFORMANCE -.I arch_prctl +.IR arch_prctl () is a Linux/x86-64 extension and should not be used in programs intended to be portable. .SH "SEE ALSO" .BR mmap (2), diff --git a/man2/chown.2 b/man2/chown.2 index 513edbaf07..cdb0c0c12f 100644 --- a/man2/chown.2 +++ b/man2/chown.2 @@ -66,7 +66,7 @@ is specified as \-1, then that ID is not changed. When the owner or group of an executable file are changed by a non-superuser, the S_ISUID and S_ISGID mode bits are cleared. POSIX does not specify whether this also should happen when root does the -.IR chown ; +.BR chown (); the Linux behaviour depends on the kernel version. .\" In Linux 2.0 kernels, superuser was like everyone else .\" In 2.2, up to 2.2.12, these bits were not cleared for superuser. @@ -74,7 +74,7 @@ the Linux behaviour depends on the kernel version. In case of a non-group-executable file (with clear S_IXGRP bit) the S_ISGID bit indicates mandatory locking, and is not cleared by a -.IR chown . +.BR chown (). .SH "RETURN VALUE" On success, zero is returned. On error, \-1 is returned, and diff --git a/man2/connect.2 b/man2/connect.2 index a1307f49ab..70f5fc29f5 100644 --- a/man2/connect.2 +++ b/man2/connect.2 @@ -176,7 +176,7 @@ immediately. It is possible to or .BR poll (2) for completion by selecting the socket for writing. After -.B select +.BR select (2) indicates writability, use .BR getsockopt (2) to read the diff --git a/man2/dup.2 b/man2/dup.2 index de7f505e07..1f12c699cb 100644 --- a/man2/dup.2 +++ b/man2/dup.2 @@ -40,7 +40,9 @@ dup, dup2 \- duplicate a file descriptor .BI "int dup2(int " oldfd ", int " newfd ); .fi .SH DESCRIPTION -.BR dup "() and " dup2 () +.BR dup () +and +.BR dup2 () create a copy of the file descriptor .IR oldfd . @@ -68,7 +70,9 @@ uses the lowest-numbered unused descriptor for the new descriptor. .RI "makes " newfd " be the copy of " oldfd ", closing " newfd first if necessary. .SH "RETURN VALUE" -.BR dup "() and " dup2 () +.BR dup () +and +.BR dup2 () return the new descriptor, or \-1 if an error occurred (in which case, .I errno is set appropriately). diff --git a/man2/fdatasync.2 b/man2/fdatasync.2 index f720bac4bb..af9f2b4c9e 100644 --- a/man2/fdatasync.2 +++ b/man2/fdatasync.2 @@ -39,15 +39,15 @@ fdatasync \- synchronize a file's in-core data with that on disk .BR fdatasync () flushes all data buffers of a file to disk (before the system call returns). It resembles -.B fsync +.BR fsync () but is not required to update the metadata such as access time. Applications that access databases or log files often write a tiny data fragment (e.g., one line in a log file) and then call -.B fsync +.BR fsync () immediately in order to ensure that the written data is physically stored on the harddisk. Unfortunately, -.B fsync +.BR fsync () will always initiate two write operations: one for the newly written data and another one in order to update the modification time stored in the inode. If the modification time is not a part of the transaction @@ -74,7 +74,7 @@ is bound to a special file which does not support synchronization. Currently (Linux 2.2) .BR fdatasync () is equivalent to -.BR fsync . +.BR fsync (). .SH AVAILABILITY On POSIX systems on which .BR fdatasync () diff --git a/man2/getpagesize.2 b/man2/getpagesize.2 index 411649511d..a9263ce803 100644 --- a/man2/getpagesize.2 +++ b/man2/getpagesize.2 @@ -36,7 +36,7 @@ used where it says in the description of that files are mapped in page-sized units. The size of the kind of pages that -.B mmap +.BR mmap () uses, is found using .RS diff --git a/man2/getrlimit.2 b/man2/getrlimit.2 index 18fda103e6..22c085c003 100644 --- a/man2/getrlimit.2 +++ b/man2/getrlimit.2 @@ -80,7 +80,9 @@ Each resource has an associated soft and hard limit, as defined by the structure (the .I rlim argument to both -.BR getrlimit "() and " setrlimit ()): +.BR getrlimit () +and +.BR setrlimit ()): .PP .in +0.5i .nf @@ -159,7 +161,9 @@ perform an orderly termination upon first receipt of The maximum size of the process's data segment (initialized data, uninitialized data, and heap). This limit affects calls to -.BR brk "() and " sbrk (), +.BR brk () +and +.BR sbrk (), which fail with the error .B ENOMEM upon encountering the soft limit of this resource. @@ -171,7 +175,8 @@ Attempts to extend a file beyond this limit result in delivery of a signal. By default, this signal terminates a process, but a process can catch this signal instead, in which case the relevant system call (e.g., -.BR write "(), " truncate ()) +.BR write () +.BR truncate ()) fails with the error .BR EFBIG . .TP @@ -189,7 +194,9 @@ into RAM. In effect this limit is rounded down to the nearest multiple of the system page size. This limit affects -.BR mlock "(2) and " mlockall (2) +.BR mlock (2) +and +.BR mlockall (2) and the .BR mmap (2) .B MAP_LOCKED @@ -206,7 +213,8 @@ The .B SHM_LOCK locks are accounted for separately from the per-process memory locks established by -.BR mlock "(2), " mlockall (2), +.BR mlock (2), +.BR mlockall (2), and .BR mmap (2) .BR MAP_LOCKED ; diff --git a/man2/intro.2 b/man2/intro.2 index 3f63a709b3..f6a34e75d5 100644 --- a/man2/intro.2 +++ b/man2/intro.2 @@ -133,7 +133,7 @@ For the error codes, see .BR errno (3). .sp Some system calls, such as -.BR mmap , +.BR mmap (), require more than five arguments. These are handled by pushing the arguments on the stack and passing a pointer to the block of arguments. .sp diff --git a/man2/ioperm.2 b/man2/ioperm.2 index 2e4f5171d5..8f5b6fa592 100644 --- a/man2/ioperm.2 +++ b/man2/ioperm.2 @@ -50,7 +50,7 @@ ioperm \- set port input/output permissions Only the first 0x3ff I/O ports can be specified in this manner. For more ports, the -.B iopl +.BR iopl () function must be used. Permissions are not inherited on fork, but on exec they are. This is useful for giving port access permissions to non-privileged tasks. diff --git a/man2/iopl.2 b/man2/iopl.2 index fe75f3c31d..9a259f987b 100644 --- a/man2/iopl.2 +++ b/man2/iopl.2 @@ -44,7 +44,7 @@ changes the I/O privilege level of the current process, as specified in This call is necessary to allow 8514-compatible X servers to run under Linux. Since these X servers require access to all 65536 I/O ports, the -.B ioperm +.BR ioperm () call is not sufficient. In addition to granting unrestricted I/O port access, running at a higher diff --git a/man2/madvise.2 b/man2/madvise.2 index f4bba0b81c..23fae3b953 100644 --- a/man2/madvise.2 +++ b/man2/madvise.2 @@ -143,7 +143,7 @@ POSIX 1003.1-2001 describes .B posix_madvise with constants POSIX_MADV_NORMAL, etc., with a behaviour close to that described here. There is a similar -.I posix_fadvise +.IR posix_fadvise () for file access. .SH "SEE ALSO" .BR getrlimit (2), diff --git a/man2/open.2 b/man2/open.2 index ec1cde693a..4a2083d9cd 100644 --- a/man2/open.2 +++ b/man2/open.2 @@ -318,7 +318,9 @@ with equal to .BR O_CREAT|O_WRONLY|O_TRUNC . .SH "RETURN VALUE" -.BR open "() and " creat () +.BR open () +and +.BR creat () return the new file descriptor, or \-1 if an error occurred (in which case, .I errno @@ -365,7 +367,8 @@ already exists and were used. .TP .B EFAULT -.IR pathname " points outside your accessible address space." +.IR pathname +points outside your accessible address space. .TP .B EISDIR .I pathname @@ -387,7 +390,8 @@ was a symbolic link. The process already has the maximum number of files open. .TP .B ENAMETOOLONG -.IR pathname " was too long." +.IR pathname +was too long. .TP .B ENFILE The system limit on the total number of open files has been reached. diff --git a/man2/ptrace.2 b/man2/ptrace.2 index 70249838b8..c35463848a 100644 --- a/man2/ptrace.2 +++ b/man2/ptrace.2 @@ -75,9 +75,9 @@ PTRACE_TRACEME Indicates that this process is to be traced by its parent. Any signal (except SIGKILL) delivered to this process will cause it to stop and its parent to be notified via -.BR wait . +.BR wait() . Also, all subsequent calls to -.BR exec +.BR exec () by this process will cause a SIGTRAP to be sent to it, giving the parent a chance to gain control before the new program begins execution. A process probably shouldn't make this request if its parent isn't expecting to trace @@ -170,7 +170,7 @@ output as the child's parent), but a by the child will still return the PID of the original parent. The child is sent a SIGSTOP, but will not necessarily have stopped by the completion of this call; use -.BR wait +.BR wait () to wait for the child to stop. (\fIaddr\fP and \fIdata\fP are ignored.) .TP PTRACE_DETACH @@ -202,7 +202,7 @@ it's 32 bits, etc.). Tracing causes a few subtle differences in the semantics of traced processes. For example, if a process is attached to with PTRACE_ATTACH, its original parent can no longer receive notification via -.BR wait +.BR wait () when it stops, and there is no way for the new parent to effectively simulate this notification. .LP diff --git a/man2/send.2 b/man2/send.2 index e8cef33aab..174dc96cdc 100644 --- a/man2/send.2 +++ b/man2/send.2 @@ -67,7 +67,7 @@ state (so that the intended recipient is known). The only difference between .BR send () and -.B write +.BR write () is the presence of .IR flags . With zero @@ -75,7 +75,7 @@ With zero parameter, .BR send () is equivalent to -.BR write . +.BR write (). Also, .RI send( s , buf , len ) is equivalent to diff --git a/man2/setfsgid.2 b/man2/setfsgid.2 index c01b664180..6d63281f26 100644 --- a/man2/setfsgid.2 +++ b/man2/setfsgid.2 @@ -46,7 +46,7 @@ effective group ID is changed, will also be changed to the new value of the effective group ID. Explicit calls to -.B setfsuid +.BR setfsuid () and .BR setfsgid () are usually only used by programs such as the Linux NFS server that diff --git a/man2/setfsuid.2 b/man2/setfsuid.2 index d4a1456bc8..417ce12577 100644 --- a/man2/setfsuid.2 +++ b/man2/setfsuid.2 @@ -48,7 +48,7 @@ will also be changed to the new value of the effective user ID. Explicit calls to .BR setfsuid () and -.B setfsgid +.BR setfsgid () are usually only used by programs such as the Linux NFS server that need to change what user and group ID is used for file access without a corresponding change in the real and effective user and group IDs. diff --git a/man2/setuid.2 b/man2/setuid.2 index 9006594fbc..1a4a180e22 100644 --- a/man2/setuid.2 +++ b/man2/setuid.2 @@ -61,7 +61,7 @@ privileges, assume the identity of a non-root user, and then regain root privileges afterwards cannot use .BR setuid (). You can accomplish this with the (non-POSIX, BSD) call -.BR seteuid . +.BR seteuid (). .SH "RETURN VALUE" On success, zero is returned. On error, \-1 is returned, and .I errno diff --git a/man2/shmop.2 b/man2/shmop.2 index 843c8097e5..6cca3d6d9a 100644 --- a/man2/shmop.2 +++ b/man2/shmop.2 @@ -204,7 +204,7 @@ value, unaligned (i.e., not page-aligned and \fBSHM_RND\fP was not specified) or invalid .I shmaddr value, or failing attach at -.BR brk , +.BR brk (), .\" FIXME What does "failing attach at brk" mean? or .B SHM_REMAP diff --git a/man2/sigvec.2 b/man2/sigvec.2 index 7c1b6180f8..0bda978d7d 100644 --- a/man2/sigvec.2 +++ b/man2/sigvec.2 @@ -38,7 +38,7 @@ This interface is made obsolete by Under Linux .BR sigvec () is #define'd to -.BR sigaction , +.BR sigaction (), and provides at best a rough approximation of the BSD sigvec interface. .SH "CONFORMING TO" BSD, SVr4 diff --git a/man2/socketpair.2 b/man2/socketpair.2 index 96d6274a74..bbfe599037 100644 --- a/man2/socketpair.2 +++ b/man2/socketpair.2 @@ -47,7 +47,7 @@ socketpair \- create a pair of connected sockets .BI "int socketpair(int " d ", int " type ", int " protocol ", int " sv [2]); .SH DESCRIPTION The -.I socketpair +.IR socketpair () call creates an unnamed pair of connected sockets in the specified domain .IR d , diff --git a/man2/statfs.2 b/man2/statfs.2 index 947f6b77d4..593f3aa333 100644 --- a/man2/statfs.2 +++ b/man2/statfs.2 @@ -191,7 +191,7 @@ containing an .B "unsigned long" .IR f_fsid . Linux, SunOS, HPUX, 4.4BSD have a system call -.I statfs +.IR statfs () that returns a .B "struct statfs" (defined in diff --git a/man2/symlink.2 b/man2/symlink.2 index d46ebf855e..1805818060 100644 --- a/man2/symlink.2 +++ b/man2/symlink.2 @@ -135,7 +135,7 @@ is done. Deleting the name referred to by a symlink will actually delete the file (unless it also has other hard links). If this behaviour is not desired, use -.BR link . +.BR link (). .SH "CONFORMING TO" SVr4, SVID, POSIX, 4.3BSD. SVr4 documents additional error codes SVr4, SVID, 4.3BSD, X/OPEN. SVr4 documents additional error codes diff --git a/man2/truncate.2 b/man2/truncate.2 index 8bc1849e16..15736141ec 100644 --- a/man2/truncate.2 +++ b/man2/truncate.2 @@ -162,7 +162,7 @@ does not reference a regular file. POSIX 1003.1-1996 has .BR ftruncate (). POSIX 1003.1-2001 also has -.IR truncate , +.BR truncate (), as an XSI extension. .LP SVr4 documents additional diff --git a/man2/uname.2 b/man2/uname.2 index 194cf630dd..0374d61224 100644 --- a/man2/uname.2 +++ b/man2/uname.2 @@ -109,7 +109,7 @@ used length 9, the second one used 65, the third one also uses 65 but adds the \fIdomainname\fP field. .LP Part of the utsname information is also accessible via -.I sysctl +.IR sysctl () and via .IR /proc/sys/kernel/ { ostype , .IR hostname , diff --git a/man2/vfork.2 b/man2/vfork.2 index 911705f219..1d2b201ad1 100644 --- a/man2/vfork.2 +++ b/man2/vfork.2 @@ -48,7 +48,7 @@ or returns from the function in which was called, or calls any other function before successfully calling .BR _exit () or one of the -.I exec +.IR exec () family of functions. .SH ERRORS .TP @@ -128,7 +128,7 @@ Formally speaking, the standard description given above does not allow one to use .BR vfork () since a following -.IR exec +.IR exec () might fail, and then what happens is undefined. Details of the signal handling are obscure and differ between systems. diff --git a/man2/wait.2 b/man2/wait.2 index bc7e4728c5..c88e97c7ef 100644 --- a/man2/wait.2 +++ b/man2/wait.2 @@ -362,10 +362,16 @@ Each of these calls sets to an appropriate value in the case of an error. .SH ERRORS .TP -.BR ECHILD " (for " wait ()) +.BR ECHILD +(for +.BR wait ()) The calling process does not have any unwaited-for children. .TP -.BR ECHILD " (for " waitpid "() or " waitid ()) +.BR ECHILD +(for +.BR waitpid () +or +.BR waitid ()) The process specified by .I pid .RB ( waitpid ()) @@ -428,7 +434,9 @@ unspecified.) Linux 2.6 conforms to this specification. However, Linux 2.4 (and earlier) does not: if a -.BR wait "() or " waitpid () +.BR wait () +or +.BR waitpid () call is made while .B SIGCHLD is being ignored, the call behaves just as though diff --git a/man3/asprintf.3 b/man3/asprintf.3 index 21ff7d1862..4e3c5fe772 100644 --- a/man3/asprintf.3 +++ b/man3/asprintf.3 @@ -39,9 +39,9 @@ The functions and .BR vasprintf () are analogues of -.B sprintf +.BR sprintf () and -.BR vsprintf , +.BR vsprintf (), except that they allocate a string large enough to hold the output including the terminating NUL, and return a pointer to it via the first parameter. diff --git a/man3/bcmp.3 b/man3/bcmp.3 index 25e639c9d7..2cbb1b875d 100644 --- a/man3/bcmp.3 +++ b/man3/bcmp.3 @@ -56,7 +56,7 @@ function returns 0 if the byte sequences are equal, otherwise a non-zero result is returned. .SH "CONFORMING TO" 4.3BSD. This function is deprecated: use -.BR memcmp +.BR memcmp () in new programs. .SH "SEE ALSO" .BR memcmp (3), diff --git a/man3/bcopy.3 b/man3/bcopy.3 index 5e7fe54122..bdd8cbeffd 100644 --- a/man3/bcopy.3 +++ b/man3/bcopy.3 @@ -51,14 +51,14 @@ The result is correct, even when both areas overlap. None. .SH "CONFORMING TO" 4.3BSD. This function is deprecated: use -.B memcpy +.BR memcpy () or -.B memmove +.BR memmove () in new programs. Note that the first two parameters are interchanged for -.BR memcpy +.BR memcpy () and -.BR memmove . +.BR memmove (). .SH "SEE ALSO" .BR memccpy (3), .BR memcpy (3), diff --git a/man3/btree.3 b/man3/btree.3 index 40705d9a70..b093f47618 100644 --- a/man3/btree.3 +++ b/man3/btree.3 @@ -44,7 +44,7 @@ btree \- btree database access method .fi .SH DESCRIPTION The routine -.IR dbopen +.IR dbopen () is the library interface to database files. One of the supported file formats is btree files. The general description of the database access methods is in @@ -55,7 +55,7 @@ The btree data structure is a sorted, balanced tree structure storing associated key/data pairs. .PP The btree access method specific data structure provided to -.I dbopen +.IR dbopen () is defined in the <db.h> include file as follows: .PP typedef struct { diff --git a/man3/bzero.3 b/man3/bzero.3 index 8054d5290c..8bdb2d8491 100644 --- a/man3/bzero.3 +++ b/man3/bzero.3 @@ -47,7 +47,7 @@ to zero. None. .SH "CONFORMING TO" 4.3BSD. This function is deprecated: use -.BR memset +.BR memset () in new programs. .SH "SEE ALSO" .BR memset (3), diff --git a/man3/cfree.3 b/man3/cfree.3 index 4fc2b0d22d..a628b29223 100644 --- a/man3/cfree.3 +++ b/man3/cfree.3 @@ -76,7 +76,7 @@ A frequently asked question is "Can I use to free memory allocated with .BR calloc (), or do I need -.BR cfree() ?" +.BR cfree ()?" Answer: use .BR free (). .LP diff --git a/man3/clock_getres.3 b/man3/clock_getres.3 index 407e857933..fb1e8aebf4 100644 --- a/man3/clock_getres.3 +++ b/man3/clock_getres.3 @@ -116,7 +116,8 @@ High-resolution per-process timer from the CPU. .B CLOCK_THREAD_CPUTIME_ID Thread-specific CPU-time clock. .SH "RETURN VALUE" -.BR clock_gettime "(), " clock_settime () +.BR clock_gettime (), +.BR clock_settime () and .BR clock_getres () return 0 for success, or \-1 for failure (in which case diff --git a/man3/des_crypt.3 b/man3/des_crypt.3 index 4709e76f83..f23c8843cf 100644 --- a/man3/des_crypt.3 +++ b/man3/des_crypt.3 @@ -27,9 +27,9 @@ des_crypt, ecb_crypt, cbc_crypt, des_setparity, DES_FAILED \- fast DES encryptio .BI "int DES_FAILED(int " status ); .fi .SH DESCRIPTION -.B ecb_crypt(\|) +.BR ecb_crypt () and -.B cbc_crypt(\|) +.BR cbc_crypt () implement the .SM NBS .SM DES @@ -39,12 +39,12 @@ These routines are faster and more general purpose than They also are able to utilize .SM DES hardware if it is available. -.B ecb_crypt(\|) +.BR ecb_crypt () encrypts in .SM ECB (Electronic Code Book) mode, which encrypts blocks of data independently. -.B cbc_crypt(\|) +.BR cbc_crypt () encrypts in .SM CBC (Cipher Block Chaining) diff --git a/man3/dprintf.3 b/man3/dprintf.3 index fc6863cc2e..b6cada5a22 100644 --- a/man3/dprintf.3 +++ b/man3/dprintf.3 @@ -39,9 +39,9 @@ The functions and .BR vdprintf () (as found in the glibc2 library) are exact analogues of -.B fprintf +.BR fprintf () and -.BR vfprintf , +.BR vfprintf (), except that they output to a file descriptor .I fd instead of to a given stream. @@ -49,9 +49,9 @@ instead of to a given stream. These functions are GNU extensions, not in C or POSIX. Clearly, the names were badly chosen. Many systems (like MacOS) have incompatible functions called -.IR dprintf , +.IR dprintf (), usually some debugging version of -.IR printf , +.IR printf (), perhaps with a prototype like .BI "void dprintf (int level, const char *" format ", ...);" @@ -67,6 +67,6 @@ So, probably, it is better to avoid this function in programs intended to be portable. A better name would have been -.IR fdprintf . +.IR fdprintf (). .SH "SEE ALSO" .BR printf (3) diff --git a/man3/exec.3 b/man3/exec.3 index 83d8bb380c..fcbc355118 100644 --- a/man3/exec.3 +++ b/man3/exec.3 @@ -56,13 +56,13 @@ execl, execlp, execle, execv, execvp \- execute a file .BI "int execvp(const char *" file ", char *const " argv "[]);" .SH DESCRIPTION The -.B exec +.BR exec () family of functions replaces the current process image with a new process image. The functions described in this manual page are front-ends for the function .BR execve (2). (See the manual page for -.B execve +.BR execve () for detailed information about the replacement of the current process.) .PP The initial argument for these functions is the pathname of a file which is @@ -134,7 +134,7 @@ variable. If this variable isn't specified, the default path errors are treated specially. .PP If permission is denied for a file (the attempted -.B execve +.BR execve () returned .BR EACCES ), these functions will continue searching the rest of the search path. If no @@ -144,14 +144,14 @@ set to .BR EACCES . .PP If the header of a file isn't recognized (the attempted -.B execve +.BR execve () returned .BR ENOEXEC ), these functions will execute the shell with the path of the file as its first argument. (If this attempt fails, no further searching is done.) .SH "RETURN VALUE" If any of the -.B exec +.BR exec () functions returns, an error will have occurred. The return value is \-1, and the global variable .I errno diff --git a/man3/fenv.3 b/man3/fenv.3 index 27ffcc99f3..02e8434198 100644 --- a/man3/fenv.3 +++ b/man3/fenv.3 @@ -219,11 +219,11 @@ is defined. The C99 standard does not define a way to set individual bits in the floating point mask, e.g. to trap on specific flags. glibc 2.2 supports the functions -.I feenableexcept +.IR feenableexcept () and -.I fedisableexcept +.IR fedisableexcept () to set individual floating point traps, and -.I fegetexcept +.IR fegetexcept () to query the state. .sp .nf diff --git a/man3/fopen.3 b/man3/fopen.3 index 7e6338f1d4..4f3f781dcb 100644 --- a/man3/fopen.3 +++ b/man3/fopen.3 @@ -113,9 +113,9 @@ between output and input, unless an input operation encounters end-of-file. result of writes other than the most recent.) Therefore it is good practice (and indeed sometimes necessary under Linux) to put an -.B fseek +.BR fseek () or -.B fgetpos +.BR fgetpos () operation between write and read operations on such a stream. This operation may be an apparent no-op (as in \fIfseek(..., 0L, SEEK_CUR)\fR called for its synchronizing side effect. diff --git a/man3/getline.3 b/man3/getline.3 index ee7822f3b9..1a83fc0dff 100644 --- a/man3/getline.3 +++ b/man3/getline.3 @@ -51,16 +51,16 @@ the routine will allocate a buffer for containing the line, which must be freed by the user program. Alternatively, before calling -.BR "getline()" , +.BR getline (), .IR "*lineptr" can contain a pointer to a -.BR "malloc()"\-allocated +.BR malloc ()\-allocated buffer .IR "*n" bytes in size. If the buffer is not large enough to hold the line read in, .BR getline () resizes the buffer to fit with -.BR "realloc()" , +.BR realloc (), updating .IR "*lineptr" and @@ -73,19 +73,19 @@ will be updated to reflect the buffer address and size respectively. .BR getdelim () works like -.BR "getline()" , +.BR getline (), except a line delimiter other than newline can be specified as the .IR delimiter argument. As with -.BR "getline()" , +.BR getline (), a delimiter character is not added if one was not present in the input before end of file was reached. .SH "RETURN VALUE" On success, -.B "getline()" +.BR getline () and -.B "getdelim()" +.B getdelim () return the number of characters read, including the delimiter character, but not including the terminating null character. This value can be used to handle embedded null characters in the line read. diff --git a/man3/gets.3 b/man3/gets.3 index 1927b3be52..386d34d8cc 100644 --- a/man3/gets.3 +++ b/man3/gets.3 @@ -63,8 +63,8 @@ more than once. is equivalent to .BI "getc(" stdin ) \fR. .PP -.BR gets() " reads" -a line from +.BR gets () +reads a line from .I stdin into the buffer pointed to by .I s @@ -107,7 +107,10 @@ library for the same input stream. For non-locking counterparts, see .BR unlocked_stdio (3). .SH "RETURN VALUE" -.BR fgetc() , " getc() " and " getchar()" +.BR fgetc (), +.BR getc () +and +.BR getchar () return the character read as an .B unsigned char cast to an @@ -116,7 +119,9 @@ or .B EOF on end of file or error. .PP -.BR gets() " and " fgets() +.BR gets() +and +.BR fgets() return .I s on success, and diff --git a/man3/glob.3 b/man3/glob.3 index 00d9070ada..0e284968a1 100644 --- a/man3/glob.3 +++ b/man3/glob.3 @@ -157,7 +157,10 @@ a pointer to the path which failed, and the value of .I errno as returned from one of the calls to -.BR opendir() ", " readdir() ", or " stat() . +.BR opendir (), +.BR readdir (), +or +.BR stat(). If .I errfunc returns non-zero, or if @@ -226,7 +229,9 @@ POSIX.2 The .BR glob () function may fail due to failure of underlying function calls, such as -.BR malloc() " or " opendir() . +.BR malloc () +or +.BR opendir (). These will store their error code in .IR errno . .SH NOTES diff --git a/man3/inet_pton.3 b/man3/inet_pton.3 index 4419ae738c..973a52cb21 100644 --- a/man3/inet_pton.3 +++ b/man3/inet_pton.3 @@ -79,7 +79,7 @@ bytes long. Certain legacy hex and octal formats of .B AF_INET addresses are not supported by -.IR inet_pton , +.IR inet_pton (), which rejects them. .SH "RETURN VALUE" .BR inet_pton () diff --git a/man3/isalpha.3 b/man3/isalpha.3 index 12dfe81c18..9754df3f0c 100644 --- a/man3/isalpha.3 +++ b/man3/isalpha.3 @@ -70,11 +70,11 @@ or .BR EOF , falls into a certain character class according to the current locale. .TP -.B "isalnum()" +.BR isalnum () checks for an alphanumeric character; it is equivalent to .BI "(isalpha(" c ") || isdigit(" c "))" \fR. .TP -.B "isalpha()" +.BR isalpha () checks for an alphabetic character; in the standard \fB"C"\fP locale, it is equivalent to .BI "(isupper(" c ") || islower(" c "))" \fR. @@ -83,36 +83,36 @@ In some locales, there may be additional characters for which is true\(emletters which are neither upper case nor lower case. .TP -.B "isascii()" +.BR isascii () checks whether \fIc\fP is a 7-bit .I unsigned char value that fits into the ASCII character set. This function is a BSD extension and is also an SVID extension. .TP -.B "isblank()" +.BR isblank () checks for a blank character; that is, a space or a tab. .TP -.B "iscntrl()" +.BR iscntrl () checks for a control character. .TP -.B "isdigit()" +.BR isdigit () checks for a digit (0 through 9). .TP -.B "isgraph()" +.BR isgraph () checks for any printable character except space. .TP -.B "islower()" +.BR islower () checks for a lower-case character. .TP -.B "isprint()" +.BR isprint () checks for any printable character including space. .TP -.B "ispunct()" +.BR ispunct () checks for any printable character which is not a space or an alphanumeric character. .TP -.B "isspace()" +.BR isspace () checks for white-space characters. In the .B """C""" and @@ -128,10 +128,10 @@ horizontal tab and vertical tab .RB ( '\ev' ). .TP -.B "isupper()" +.BR isupper () checks for an uppercase letter. .TP -.B "isxdigit()" +.BR isxdigit () checks for a hexadecimal digits, i.e. one of .nl .BR "0 1 2 3 4 5 6 7 8 9 a b c d e f A B C D E F" . diff --git a/man3/lockf.3 b/man3/lockf.3 index 1564ea9e57..fca468a4f2 100644 --- a/man3/lockf.3 +++ b/man3/lockf.3 @@ -53,7 +53,7 @@ On Linux, this call is just an interface for (In general, the relation between .BR lockf () and -.B fcntl +.BR fcntl () is unspecified.) .LP Valid operations are given below: diff --git a/man3/malloc.3 b/man3/malloc.3 index 85b2c3325a..fa3348911b 100644 --- a/man3/malloc.3 +++ b/man3/malloc.3 @@ -102,7 +102,9 @@ If the area pointed to was moved, a is done. .SH "RETURN VALUE" For -.BR calloc() " and " malloc() , +.BR calloc () +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 diff --git a/man3/mpool.3 b/man3/mpool.3 index 10ef507a61..56e105a1b3 100644 --- a/man3/mpool.3 +++ b/man3/mpool.3 @@ -72,7 +72,7 @@ of files. The buffers may be shared between processes. .PP The function -.I mpool_open +.IR mpool_open () initializes a memory pool. The .I key @@ -104,7 +104,7 @@ buffers, but will be the largest value specified by any of the processes sharing the file. .PP The -.I mpool_filter +.IR mpool_filter () function is intended to make transparent input and output processing of the pages possible. If the @@ -120,7 +120,7 @@ Both functions are called with the pointer, the page number and a pointer to the page to being read or written. .PP The function -.I mpool_new +.IR mpool_new () takes an MPOOL pointer and an address as arguments. If a new page can be allocated, a pointer to the page is returned and the page number is stored into the @@ -129,21 +129,21 @@ address. Otherwise, NULL is returned and errno is set. .PP The function -.I mpool_get +.IR mpool_get () takes a MPOOL pointer and a page number as arguments. If the page exists, a pointer to the page is returned. Otherwise, NULL is returned and errno is set. The flags parameter is not currently used. .PP The function -.I mpool_put +.IR mpool_put () unpins the page referenced by .IR pgaddr . .I Pgaddr must be an address previously returned by -.I mpool_get +.IR mpool_get () or -.IR mpool_new . +.IR mpool_new (). The flag value is specified by .IR or 'ing any of the following values: @@ -151,35 +151,35 @@ any of the following values: MPOOL_DIRTY The page has been modified and needs to be written to the backing file. .PP -.I Mpool_put +.IR Mpool_put () returns 0 on success and \-1 if an error occurs. .PP The function -.I mpool_sync +.IR mpool_sync () writes all modified pages associated with the MPOOL pointer to the backing file. -.I Mpool_sync +.IR Mpool_sync () returns 0 on success and \-1 if an error occurs. .PP The -.I mpool_close +.IR mpool_close () function free's up any allocated memory associated with the memory pool cookie. Modified pages are .B not written to the backing file. -.I Mpool_close +.IR Mpool_close () returns 0 on success and \-1 if an error occurs. .SH ERRORS The -.I mpool_open +.IR mpool_open () function may fail and set .I errno for any of the errors specified for the library routine .IR malloc (3). .PP The -.I mpool_get +.IR mpool_get () function may fail and set .I errno for the following: @@ -188,9 +188,9 @@ for the following: The requested record doesn't exist. .PP The -.I mpool_new +.IR mpool_new () and -.I mpool_get +.IR mpool_get () functions may fail and set .I errno for any of the errors specified for the library routines @@ -200,14 +200,14 @@ and .IR malloc (3). .PP The -.I mpool_sync +.IR mpool_sync () function may fail and set .I errno for any of the errors specified for the library routine .IR write (2). .PP The -.I mpool_close +.IR mpool_close () function may fail and set .I errno for any of the errors specified for the library routine diff --git a/man3/nan.3 b/man3/nan.3 index 19b55f34e5..8ca190ae27 100644 --- a/man3/nan.3 +++ b/man3/nan.3 @@ -27,13 +27,13 @@ The call is equivalent to .I strtod ("NAN(char-sequence)",NULL) and similarly calls to -.I nanf +.IR nanf () and -.I nanl +.IR nanl () are equivalent to analogous calls to -.I strtof +.IR strtof () and -.IR strtold . +.IR strtold (). .PP The argument .I tagp diff --git a/man3/popen.3 b/man3/popen.3 index 680b2a2f03..64b58178a3 100644 --- a/man3/popen.3 +++ b/man3/popen.3 @@ -88,7 +88,7 @@ The .BR pclose () function waits for the associated process to terminate and returns the exit status of the command as returned by -.BR wait4 . +.BR wait4 (). .SH "RETURN VALUE" The .BR popen () @@ -109,7 +109,7 @@ function returns \-1 if .\" is not associated with a ``popened'' command, if .\".I stream .\" already ``pclosed'', or if -.B wait4 +.BR wait4 () returns an error, or some other error is detected. .SH ERRORS The @@ -117,7 +117,9 @@ The function does not set .I errno if memory allocation fails. If the underlying -.BR fork() " or " pipe() +.BR fork () +or +.BR pipe () fails, .I errno is set appropriately. If the diff --git a/man3/posix_memalign.3 b/man3/posix_memalign.3 index becde50e2d..dd86523342 100644 --- a/man3/posix_memalign.3 +++ b/man3/posix_memalign.3 @@ -141,7 +141,7 @@ reclaimed with .IR free (). GNU libc -.BR "malloc()" +.BR malloc () always returns 8-byte aligned memory addresses, so these routines are only needed if you require larger alignment values. diff --git a/man3/printf.3 b/man3/printf.3 index 0517311d40..e7d271e72a 100644 --- a/man3/printf.3 +++ b/man3/printf.3 @@ -629,7 +629,7 @@ modifier is present, the .I wint_t (wide character) argument is converted to a multibyte sequence by a call to the -.B wcrtomb +.BR wcrtomb () function, with a conversion state starting in the initial state, and the resulting multibyte string is written. .TP @@ -656,7 +656,7 @@ modifier is present: The argument is expected to be a pointer to an array of wide characters. Wide characters from the array are converted to multibyte characters (each by a call to the -.B wcrtomb +.BR wcrtomb () function, with a conversion state starting in the initial state before the first wide character), up to and including a terminating null wide character. The resulting multibyte characters are written up to @@ -875,9 +875,9 @@ and .BR vsnprintf (), and the length modifier q. FreeBSD also has functions -.I asprintf +.IR asprintf () and -.IR vasprintf , +.IR vasprintf (), that allocate a buffer large enough for .BR sprintf (). In glibc there are functions @@ -898,7 +898,7 @@ Use and .BR vsnprintf () instead (or -.B asprintf +.BR asprintf () and .BR vasprintf ). .PP diff --git a/man3/puts.3 b/man3/puts.3 index d5c6386289..4852c06075 100644 --- a/man3/puts.3 +++ b/man3/puts.3 @@ -80,7 +80,10 @@ library for the same output stream. For non-locking counterparts, see .BR unlocked_stdio (3). .SH "RETURN VALUE" -.BR fputc() , " putc() " and " putchar()" +.BR fputc (), +.BR putc () +and +.BR putchar () return the character written as an .B unsigned char cast to an @@ -89,7 +92,9 @@ or .B EOF on error. .PP -.BR puts() " and " fputs() +.BR puts () +and +.BR fputs () return a non-negative number on success, or .B EOF on error. diff --git a/man3/qsort.3 b/man3/qsort.3 index f73a2557c1..f8dd521040 100644 --- a/man3/qsort.3 +++ b/man3/qsort.3 @@ -61,10 +61,10 @@ SVID 3, POSIX, 4.3BSD, ISO 9899 Library routines suitable for use as the .I compar argument include -.IR strcmp , -.IR alphasort , +.IR strcmp (), +.IR alphasort (), and -.IR versionsort . +.IR versionsort (). .SH EXAMPLE For an example of use, see the example on the .BR bsearch (3) diff --git a/man3/remove.3 b/man3/remove.3 index 1fb8d2e8c8..a47eb760bf 100644 --- a/man3/remove.3 +++ b/man3/remove.3 @@ -39,9 +39,9 @@ remove \- delete a name and possibly the file it refers to .BR remove () deletes a name from the filesystem. It calls -.I unlink +.IR unlink () for files, and -.I rmdir +.IR rmdir () for directories. If the removed name was the @@ -74,7 +74,9 @@ disappearance of files which are still being used. .SH NOTE Under libc4 and libc5, .BR remove () -was an alias for unlink (and hence would not remove directories). +was an alias for +.BR unlink () +(and hence would not remove directories). .SH "SEE ALSO" .BR rm (1), .BR link (2), diff --git a/man3/rpc.3 b/man3/rpc.3 index 80a663c2a9..2ef694d0b4 100644 --- a/man3/rpc.3 +++ b/man3/rpc.3 @@ -510,7 +510,7 @@ if the program does not have a standard error (as a program running as a server quite likely does not), or if the programmer does not want the message to be output with -.BR printf , +.BR printf (), or if a message format different than that supported by .BR clnt_perrno () is to be used. @@ -1000,13 +1000,13 @@ A global variable reflecting the service side's read file descriptor bit mask; it is suitable as a parameter to the -.B select +.BR select () system call. This is only of interest if a service implementor does not call .BR svc_run (), but rather does his own asynchronous event processing. This variable is read-only (do not pass its address to -.BR select !), +.BR select ()!), yet it may change after calls to .BR svc_getreqset () or any creation routines. @@ -1108,7 +1108,7 @@ does not call .BR svc_run (), but instead implements custom asynchronous event processing. It is called when the -.B select +.BR select () system call has determined that an .SM RPC request has arrived on some diff --git a/man3/scanf.3 b/man3/scanf.3 index d2619743fa..aea5ed2f91 100644 --- a/man3/scanf.3 +++ b/man3/scanf.3 @@ -116,9 +116,9 @@ The function scans a variable argument list from the standard input and the .BR vsscanf () function scans it from a string; these are analogous to the -.B vprintf +.BR vprintf () and -.B vsprintf +.BR vsprintf () functions respectively. .PP The diff --git a/man3/setlocale.3 b/man3/setlocale.3 index 545766177b..bbc6b3729c 100644 --- a/man3/setlocale.3 +++ b/man3/setlocale.3 @@ -149,9 +149,11 @@ for locale-dependent information, by using the multi-byte and wide character functions for text processing if .BR "MB_CUR_MAX > 1" , and by using -.BR strcoll() ", " wcscoll() +.BR strcoll () , +.BR wcscoll () or -.BR strxfrm() ", " wcsxfrm() +.BR strxfrm (), +.BR wcsxfrm () to compare strings. .SH "RETURN VALUE" A successful call to diff --git a/man3/strptime.3 b/man3/strptime.3 index 8f5888498e..806b422ed5 100644 --- a/man3/strptime.3 +++ b/man3/strptime.3 @@ -290,7 +290,7 @@ int main() { For reasons of symmetry, glibc tries to support for .BR strptime () the same format characters as for -.BR strftime . +.BR strftime (). (In most cases the corresponding fields are parsed, but no field in \fItm\fP is changed.) This leads to @@ -320,7 +320,7 @@ An RFC-822/ISO 8601 standard time zone specification. .B %Z The timezone name. .LP -Similarly, because of GNU extensions to \fIstrftime\fP, +Similarly, because of GNU extensions to \fIstrftime\fP(), %k is accepted as a synonym for %H, and %l should be accepted as a synonym for %I, and %P is accepted as a synonym for %p. Finally diff --git a/man3/strverscmp.3 b/man3/strverscmp.3 index 3697f78b3e..fb45d53ab6 100644 --- a/man3/strverscmp.3 +++ b/man3/strverscmp.3 @@ -51,7 +51,7 @@ which again uses Thus, the task of .BR strverscmp () is to compare two strings and find the "right" order, while -.B strcmp +.BR strcmp () only finds the lexicographic order. This function does not use the locale category LC_COLLATE, so is meant mostly for situations where the strings are expected to be in ASCII. @@ -63,7 +63,7 @@ while directly after it there is a difference. Find the largest consecutive digit strings containing (or starting at, or ending at) this position. If one or both of these is empty, then return what -.B strcmp +.BR strcmp () would have returned (numerical ordering of byte values). Otherwise, compare both digit strings numerically, where digit strings with one or more leading zeroes are interpreted as if they have a decimal point diff --git a/man3/wprintf.3 b/man3/wprintf.3 index 045b37ca1a..a579f4644e 100644 --- a/man3/wprintf.3 +++ b/man3/wprintf.3 @@ -73,7 +73,7 @@ If no modifier is present, the .I int argument is converted to a wide character by a call to the -.B btowc +.BR btowc () function, and the resulting wide character is written. If an .B l @@ -90,7 +90,7 @@ argument is expected to be a pointer to an array of character type (pointer to a string) containing a multibyte character sequence beginning in the initial shift state. Characters from the array are converted to wide characters (each by a call to the -.B mbrtowc +.BR mbrtowc () function with a conversion state starting in the initial state before the first byte). The resulting wide characters are written up to (but not including) the terminating null wide character. If a precision is @@ -142,8 +142,8 @@ of the form \\unnnn does not solve this problem.) Therefore, in internationalized programs, the \fIformat\fP string should consist of ASCII wide characters only, or should be constructed at run time in an internationalized way (e.g. using -.B gettext +.BR gettext () or -.BR iconv , +.BR iconv (), followed by -.BR mbstowcs ). +.BR mbstowcs ()). diff --git a/man3/xdr.3 b/man3/xdr.3 index 5c4014d564..a3e2c92b10 100644 --- a/man3/xdr.3 +++ b/man3/xdr.3 @@ -400,9 +400,9 @@ is called. Similarly, when a stream's input buffer is empty, is called. The behavior of these two routines is similar to the system calls -.B read +.BR read () and -.BR write , +.BR write (), except that .I handle is passed to the former routines as the first parameter. diff --git a/man5/ipc.5 b/man5/ipc.5 index 9fcb8808ae..2901e38725 100644 --- a/man5/ipc.5 +++ b/man5/ipc.5 @@ -187,22 +187,22 @@ queue. .TP .B msg_lspid ID of the process that performed the last -.B msgsnd +.BR msgsnd () system call. .TP .B msg_lrpid ID of the process that performed the last -.B msgrcv +.BR msgrcv () system call. .TP .B msg_stime Time of the last -.B msgsnd +.BR msgsnd () system call. .TP .B msg_rtime Time of the last -.B msgcv +.BR msgcv () system call. .TP .B msg_ctime @@ -241,12 +241,12 @@ set. .TP .B sem_otime Time of last -.B semop +.BR semop () system call. .TP .B sem_ctime Time of last -.B semctl +.BR semctl () system call that changed a member of the above structure or of one semaphore belonging to the set. .TP @@ -347,9 +347,9 @@ ID of the process that created the shared memory segment. .TP .B shm_lpid ID of the last process that executed a -.B shmat +.BR shmat () or -.B shmdt +.BR shmdt () system call. .TP .B shm_nattch @@ -357,17 +357,17 @@ Number of current alive attaches for this shared memory segment. .TP .B shm_atime Time of the last -.B shmat +.BR shmat () system call. .TP .B shm_dtime Time of the last -.B shmdt +.BR shmdt () system call. .TP .B shm_ctime Time of the last -.B shmctl +.BR shmctl () system call that changed .BR shmid_ds . .SH "SEE ALSO" diff --git a/man7/capabilities.7 b/man7/capabilities.7 index a138780944..79ffcdb8dd 100644 --- a/man7/capabilities.7 +++ b/man7/capabilities.7 @@ -351,7 +351,7 @@ Eventually, it should be possible to associate three capability sets with an executable file, which, in conjunction with the capability sets of the process, will determine the capabilities of a process after an -.IR exec : +.IR exec (): .TP .IR Allowed : this set is ANDed with the process's inheritable set to determine which diff --git a/man7/socket.7 b/man7/socket.7 index c4efd3146b..a7015f15e2 100644 --- a/man7/socket.7 +++ b/man7/socket.7 @@ -282,7 +282,7 @@ Argument is a .B ucred structure. Only valid as a -.BR getsockopt . +.BR getsockopt (). .TP .B SO_BINDTODEVICE Bind this socket to a particular device like \(lqeth0\(rq, @@ -322,7 +322,7 @@ Gets the socket type as an integer (like .BR SOCK_STREAM ). Can only be read with -.BR getsockopt . +.BR getsockopt (). .\" SO_ACCEPTCONN is in SUSv3, and its origin is explained in .\" W R Stevens, UNPv1 .TP @@ -334,7 +334,7 @@ The value 0 indicates that this is not a listening socket, the value 1 indicates that this is a listening socket. Can only be read with -.BR getsockopt . +.BR getsockopt (). .TP .B SO_DONTROUTE Don't send via a gateway, only send to directly connected hosts. @@ -408,7 +408,7 @@ capability. .TP .B SO_ERROR Get and clear the pending socket error. Only valid as a -.BR getsockopt . +.BR getsockopt (). Expects an integer. .SH SIGNALS When writing onto a connection-oriented socket that has been shut down |