diff options
Diffstat (limited to 'man2')
| -rw-r--r-- | man2/_exit.2 | 24 | ||||
| -rw-r--r-- | man2/alarm.2 | 6 | ||||
| -rw-r--r-- | man2/alloc_hugepages.2 | 6 | ||||
| -rw-r--r-- | man2/chroot.2 | 2 | ||||
| -rw-r--r-- | man2/execve.2 | 12 | ||||
| -rw-r--r-- | man2/getcontext.2 | 38 | ||||
| -rw-r--r-- | man2/gethostname.2 | 4 | ||||
| -rw-r--r-- | man2/getpagesize.2 | 8 | ||||
| -rw-r--r-- | man2/getrlimit.2 | 6 | ||||
| -rw-r--r-- | man2/getuid.2 | 4 | ||||
| -rw-r--r-- | man2/ipc.2 | 6 | ||||
| -rw-r--r-- | man2/kill.2 | 6 | ||||
| -rw-r--r-- | man2/mmap2.2 | 2 | ||||
| -rw-r--r-- | man2/msgop.2 | 2 | ||||
| -rw-r--r-- | man2/open.2 | 2 | ||||
| -rw-r--r-- | man2/pread.2 | 4 | ||||
| -rw-r--r-- | man2/read.2 | 6 | ||||
| -rw-r--r-- | man2/readahead.2 | 12 | ||||
| -rw-r--r-- | man2/remap_file_pages.2 | 18 | ||||
| -rw-r--r-- | man2/select_tut.2 | 30 | ||||
| -rw-r--r-- | man2/setpgid.2 | 4 | ||||
| -rw-r--r-- | man2/sigsuspend.2 | 2 | ||||
| -rw-r--r-- | man2/statfs.2 | 2 | ||||
| -rw-r--r-- | man2/stime.2 | 2 | ||||
| -rw-r--r-- | man2/sync.2 | 2 | ||||
| -rw-r--r-- | man2/syscalls.2 | 2 | ||||
| -rw-r--r-- | man2/syslog.2 | 6 | ||||
| -rw-r--r-- | man2/uselib.2 | 4 | ||||
| -rw-r--r-- | man2/write.2 | 4 |
29 files changed, 113 insertions, 113 deletions
diff --git a/man2/_exit.2 b/man2/_exit.2 index 74fc48cc37..15dc13c2c8 100644 --- a/man2/_exit.2 +++ b/man2/_exit.2 @@ -39,7 +39,7 @@ _exit, _Exit \- terminate the current process .BI "void _Exit(int " status ); .SH DESCRIPTION The function -.BR _exit() +.BR _exit () terminates the calling process "immediately". Any open file descriptors belonging to the process are closed; any children of the process are inherited by process 1, @@ -56,38 +56,38 @@ can be collected using one of the family of calls. .LP The function -.B _Exit() +.BR _Exit () is equivalent to -.BR _exit() . +.BR _exit (). .SH "RETURN VALUE" These functions do not return. .SH "CONFORMING TO" SVr4, SVID, POSIX, X/OPEN, 4.3BSD. -The function \fB_Exit()\fP was introduced by C99. +The function \fB_Exit\fP() was introduced by C99. .SH NOTES For a discussion on the effects of an exit, the transmission of exit status, zombie processes, signals sent, etc., see .BR exit (3). .LP The function -.B _exit() -is like \fBexit()\fP, but does not call any +.BR _exit () +is like \fBexit\fP(), but does not call any functions registered with -.BR atexit() +.BR atexit () or -.BR on_exit() . +.BR on_exit (). Whether it flushes standard I/O buffers and removes temporary files created with .BR tmpfile (3) is implementation dependent. On the other hand, -.B _exit() +.BR _exit () does close open file descriptors, and this may cause an unknown delay, waiting for pending output to finish. If the delay is undesired, -it may be useful to call functions like \fItcflush()\fP before -calling \fB_exit()\fP. +it may be useful to call functions like \fItcflush\fP() before +calling \fB_exit\fP(). Whether any pending I/O is cancelled, and which pending I/O may be -cancelled upon \fB_exit()\fP, is implementation-dependent. +cancelled upon \fB_exit\fP(), is implementation-dependent. .SH "SEE ALSO" .BR execve (2), .BR fork (2), diff --git a/man2/alarm.2 b/man2/alarm.2 index b854d53bbb..99aa12a785 100644 --- a/man2/alarm.2 +++ b/man2/alarm.2 @@ -61,13 +61,13 @@ scheduled alarm. share the same timer; calls to one will interfere with use of the other. .PP -.B sleep() +.BR sleep () may be implemented using .BR SIGALRM ; mixing calls to -.B alarm() +.BR alarm () and -.B sleep() +.BR sleep () is a bad idea. Scheduling delays can, as ever, cause the execution of the process to diff --git a/man2/alloc_hugepages.2 b/man2/alloc_hugepages.2 index 0b398f4a28..b363ca408b 100644 --- a/man2/alloc_hugepages.2 +++ b/man2/alloc_hugepages.2 @@ -58,15 +58,15 @@ and inherited by child processes. The .I addr parameter of -.B free_hugepages() +.BR free_hugepages () tells which page is being freed: it was the return value of a call to -.BR alloc_hugepages() . +.BR alloc_hugepages (). (The memory is first actually freed when all users have released it.) The .I addr parameter of -.B alloc_hugepages() +.BR alloc_hugepages () is a hint, that the kernel may or may not follow. Addresses must be properly aligned. .LP diff --git a/man2/chroot.2 b/man2/chroot.2 index c873f1a440..9e4872d594 100644 --- a/man2/chroot.2 +++ b/man2/chroot.2 @@ -110,7 +110,7 @@ X/OPEN does not document EIO, ENOMEM or EFAULT error conditions. This interface is marked as legacy by X/OPEN. .SH NOTES FreeBSD has a stronger -.I jail() +.IR jail () system call. .SH "SEE ALSO" .BR chdir (2), diff --git a/man2/execve.2 b/man2/execve.2 index 9bf34167d9..323f55a3c6 100644 --- a/man2/execve.2 +++ b/man2/execve.2 @@ -38,7 +38,7 @@ execve \- execute program .BI "int execve(const char *" filename ", char *const " argv .BI "[], char *const " envp []); .SH DESCRIPTION -\fBexecve()\fP executes the program pointed to by \fIfilename\fP. +\fBexecve\fP() executes the program pointed to by \fIfilename\fP. \fIfilename\fP must be either a binary executable, or a script starting with a line of the form "\fB#! \fIinterpreter \fR[arg]". In the latter case, the interpreter must be a valid pathname for an @@ -53,7 +53,7 @@ pointer. The argument vector and environment can be accessed by the called program's main function, when it is defined as \fBint main(int argc, char *argv[], char *envp[])\fR. -\fBexecve()\fP does not return on success, and the text, data, bss, and +\fBexecve\fP() does not return on success, and the text, data, bss, and stack of the calling process are overwritten by that of the program loaded. The program invoked inherits the calling process's PID, and any open file descriptors that are not set to close on exec. Signals pending @@ -62,7 +62,7 @@ the calling process are reset to their default behaviour. The SIGCHLD signal (when set to SIG_IGN) may or may not be reset to SIG_DFL. If the current program is being ptraced, a \fBSIGTRAP\fP is sent to it -after a successful \fBexecve()\fP. +after a successful \fBexecve\fP(). If the set-user-ID bit is set on the program file pointed to by \fIfilename\fP, and the calling process is not being ptraced, @@ -84,7 +84,7 @@ shared libraries. This interpreter is typically version 5, or \fI/lib/ld-linux.so.2\fR for binaries linked with the GNU libc version 2. .SH "RETURN VALUE" -On success, \fBexecve()\fP does not return, on error \-1 is returned, and +On success, \fBexecve\fP() does not return, on error \-1 is returned, and .I errno is set appropriately. .SH ERRORS @@ -178,7 +178,7 @@ conditions EAGAIN, EINTR, ELIBACC, ENOLINK, EMULTIHOP; POSIX does not document ETXTBSY, EPERM, EFAULT, ELOOP, EIO, ENFILE, EMFILE, EINVAL, EISDIR or ELIBBAD error conditions. .SH NOTES -SUID and SGID processes can not be \fBptrace()\fPd. +SUID and SGID processes can not be \fBptrace\fP()d. Linux ignores the SUID and SGID bits on scripts. @@ -195,7 +195,7 @@ a #! executable shell script. .\" Some Linux versions have failed to check permissions on ELF .\" interpreters. This is a security hole, because it allows users to .\" open any file, such as a rewinding tape device, for reading. Some -.\" Linux versions have also had other security holes in \fBexecve()\fP, +.\" Linux versions have also had other security holes in \fBexecve\fP(), .\" that could be exploited for denial of service by a suitably crafted .\" ELF binary. There are no known problems with 2.0.34 or 2.2.15. diff --git a/man2/getcontext.2 b/man2/getcontext.2 index 9b44ec9323..7cf6d8872f 100644 --- a/man2/getcontext.2 +++ b/man2/getcontext.2 @@ -34,8 +34,8 @@ In a SysV-like environment, one has the two types \fBmcontext_t\fP and \fBucontext_t\fP defined in .I <ucontext.h> and the four functions -\fBgetcontext()\fP, \fBsetcontext()\fP, \fBmakecontext()\fP -and \fBswapcontext()\fP +\fBgetcontext\fP(), \fBsetcontext\fP(), \fBmakecontext\fP() +and \fBswapcontext\fP() that allow user-level context switching between multiple threads of control within a process. .LP @@ -57,7 +57,7 @@ with \fBsigset_t\fP and \fBstack_t\fP defined in .IR <signal.h> . Here \fIuc_link\fP points to the context that will be resumed when the current context terminates (in case the current context -was created using \fBmakecontext()\fP), \fIuc_sigmask\fP is the +was created using \fBmakecontext\fP()), \fIuc_sigmask\fP is the set of signals blocked in this context (see .BR sigprocmask (2)), \fIuc_stack\fP is the stack used by this context (see @@ -66,24 +66,24 @@ and \fIuc_mcontext\fP is the machine-specific representation of the saved context, that includes the calling thread's machine registers. .LP -The function \fBgetcontext()\fP initializes the structure +The function \fBgetcontext\fP() initializes the structure pointed at by \fIucp\fP to the currently active context. .LP -The function \fBsetcontext()\fP restores the user context +The function \fBsetcontext\fP() restores the user context pointed at by \fIucp\fP. A successful call does not return. -The context should have been obtained by a call of \fBgetcontext()\fP, -or \fBmakecontext()\fP, or passed as third argument to a signal +The context should have been obtained by a call of \fBgetcontext\fP(), +or \fBmakecontext\fP(), or passed as third argument to a signal handler. .LP -If the context was obtained by a call of \fBgetcontext()\fP, +If the context was obtained by a call of \fBgetcontext\fP(), program execution continues as if this call just returned. .LP -If the context was obtained by a call of \fBmakecontext()\fP, +If the context was obtained by a call of \fBmakecontext\fP(), program execution continues by a call to the function \fIfunc\fP -specified as the second argument of that call to \fBmakecontext()\fP. +specified as the second argument of that call to \fBmakecontext\fP(). When the function \fIfunc\fP returns, we continue with the \fIuc_link\fP member of the structure \fIucp\fP specified as the -first argument of that call to \fBmakecontext()\fP. +first argument of that call to \fBmakecontext\fP(). When this member is NULL, the thread exits. .LP If the context was obtained by a call to a signal handler, @@ -92,27 +92,27 @@ program instruction following the instruction interrupted by the signal". However, this sentence was removed in SUSv2, and the present verdict is "the result is unspecified". .SH "RETURN VALUE" -When successful, \fBgetcontext()\fP returns 0 and \fBsetcontext()\fP +When successful, \fBgetcontext\fP() returns 0 and \fBsetcontext\fP() does not return. On error, both return \-1 and set \fIerrno\fP appropriately. .SH ERRORS None defined. .SH NOTES The earliest incarnation of this mechanism was the -\fIsetjmp()\fP/\fIlongjmp()\fP mechanism. Since that does not define +\fIsetjmp\fP()/\fIlongjmp\fP() mechanism. Since that does not define the handling of the signal context, the next stage was the -\fIsigsetjmp()\fP/\fIsiglongjmp()\fP pair. +\fIsigsetjmp\fP()/\fIsiglongjmp\fP() pair. The present mechanism gives much more control. On the other hand, -there is no easy way to detect whether a return from \fBgetcontext()\fP -is from the first call, or via a \fBsetcontext()\fP call. +there is no easy way to detect whether a return from \fBgetcontext\fP() +is from the first call, or via a \fBsetcontext\fP() call. The user has to invent her own bookkeeping device, and a register variable won't do since registers are restored. .LP When a signal occurs, the current user context is saved and a new context is created by the kernel for the signal handler. -Do not leave the handler using \fIlongjmp()\fP: it is undefined -what would happen with contexts. Use \fIsiglongjmp()\fP or -\fIsetcontext()\fP instead. +Do not leave the handler using \fIlongjmp\fP(): it is undefined +what would happen with contexts. Use \fIsiglongjmp\fP() or +\fIsetcontext\fP() instead. .SH "CONFORMING TO" SUSv2 .SH "SEE ALSO" diff --git a/man2/gethostname.2 b/man2/gethostname.2 index a394bebadf..1130db655b 100644 --- a/man2/gethostname.2 +++ b/man2/gethostname.2 @@ -41,9 +41,9 @@ gethostname, sethostname \- get/set host name These functions are used to access or to change the host name of the current processor. The -.B gethostname() +.BR gethostname () function returns a NUL-terminated hostname (set earlier by -.BR sethostname() ) +.BR sethostname ()) in the array \fIname\fP that has a length of \fIlen\fP bytes. In case the NUL-terminated hostname does not fit, no error is returned, but the hostname is truncated. It is unspecified diff --git a/man2/getpagesize.2 b/man2/getpagesize.2 index 6f68ea58ab..411649511d 100644 --- a/man2/getpagesize.2 +++ b/man2/getpagesize.2 @@ -29,7 +29,7 @@ getpagesize \- get memory page size .B int getpagesize(void); .SH DESCRIPTION The function -.B getpagesize() +.BR getpagesize () returns the number of bytes in a page, where a "page" is the thing used where it says in the description of .BR mmap (2) @@ -60,13 +60,13 @@ This call first appeared in 4.2BSD. .SH CONFORMING TO SVr4, 4.4BSD, SUSv2. In SUSv2 the -.B getpagesize() +.BR getpagesize () call is labeled "legacy", and in POSIX 1003.1-2001 it has been dropped. HPUX does not have this call. .SH NOTES Whether -.B getpagesize() +.BR getpagesize () is present as a Linux system call depends on the architecture. If it is, it returns the kernel symbol PAGE_SIZE, which is architecture and machine model dependent. @@ -77,7 +77,7 @@ should not find PAGE_SIZE at compile time from a header file, but use an actual system call, at least for those architectures (like sun4) where this dependency exists. Here libc4, libc5, glibc 2.0 fail because their -.B getpagesize() +.BR getpagesize () returns a statically derived value, and does not use a system call. Things are OK in glibc 2.1. .SH "SEE ALSO" diff --git a/man2/getrlimit.2 b/man2/getrlimit.2 index c902eddbdd..18fda103e6 100644 --- a/man2/getrlimit.2 +++ b/man2/getrlimit.2 @@ -180,7 +180,7 @@ fails with the error A limit on the combined number of .BR flock () locks and -.BR fcntl() +.BR fcntl () leases that this process may establish. .TP .B RLIMIT_MEMLOCK @@ -331,11 +331,11 @@ points outside the accessible address space. is not valid. .TP .B EPERM -An unprivileged process tried to use \fBsetrlimit()\fP to +An unprivileged process tried to use \fBsetrlimit\fP() to increase a soft or hard limit above the current hard limit; the .B CAP_SYS_RESOURCE capability is required to do this. -Or, the process tried to use \fBsetrlimit()\fP to increase +Or, the process tried to use \fBsetrlimit\fP() to increase the soft or hard RLIMIT_NOFILE limit above the current kernel maximum (NR_OPEN). .SH BUGS diff --git a/man2/getuid.2 b/man2/getuid.2 index 655ee69930..dbae7429da 100644 --- a/man2/getuid.2 +++ b/man2/getuid.2 @@ -45,8 +45,8 @@ These functions are always successful. .SH "CONFORMING TO" POSIX, 4.3BSD. .SH HISTORY -In Unix V6 the \fBgetuid()\fP call returned (euid << 8) + uid. -Unix V7 introduced separate calls \fBgetuid()\fP and \fBgeteuid()\fP. +In Unix V6 the \fBgetuid\fP() call returned (euid << 8) + uid. +Unix V7 introduced separate calls \fBgetuid\fP() and \fBgeteuid\fP(). .SH "SEE ALSO" .BR setreuid (2), .BR setuid (2) diff --git a/man2/ipc.2 b/man2/ipc.2 index b3d2b88e65..1726a02125 100644 --- a/man2/ipc.2 +++ b/man2/ipc.2 @@ -30,7 +30,7 @@ ipc \- System V IPC system calls .BI "int ipc(unsigned int " call ", int " first ", int " second , .BI "int " third ", void *" ptr ", long " fifth ); .SH DESCRIPTION -.B ipc() +.BR ipc () is a common kernel entry point for the System V IPC calls for messages, semaphores, and shared memory. .I call @@ -39,9 +39,9 @@ the other arguments are passed through to the appropriate call. .PP User programs should call the appropriate functions by their usual names. Only standard library implementors and kernel hackers need to know about -.BR ipc() . +.BR ipc (). .SH "CONFORMING TO" -\fBipc()\fP is Linux specific, and should not be used in programs +\fBipc\fP() is Linux specific, and should not be used in programs intended to be portable. .SH "SEE ALSO" .BR msgctl (2), diff --git a/man2/kill.2 b/man2/kill.2 index b487cb45d0..11e9678824 100644 --- a/man2/kill.2 +++ b/man2/kill.2 @@ -99,7 +99,7 @@ to any of the target processes. The pid or process group does not exist. Note that an existing process might be a zombie, a process which already committed termination, but -has not yet been \fBwait()\fPed for. +has not yet been \fBwait\fP()ed for. .SH NOTES The only signals that can be sent task number one, the .I init @@ -117,9 +117,9 @@ Linux allows a process to signal itself, but on Linux the call .LP POSIX 1003.1-2003 requires that if a process sends a signal to itself, and that process does not have the signal blocked, and no other thread -has it unblocked or is waiting for it in \fIsigwait()\fP, at least one +has it unblocked or is waiting for it in \fIsigwait\fP(), at least one unblocked signal must be delivered to the sending thread before the -call of \fIkill()\fP returns. +call of \fIkill\fP() returns. .SH "LINUX HISTORY" Across different kernel versions, Linux has enforced different rules for the permissions required for an unprivileged process diff --git a/man2/mmap2.2 b/man2/mmap2.2 index 61f38af01a..d13a9c1d84 100644 --- a/man2/mmap2.2 +++ b/man2/mmap2.2 @@ -70,7 +70,7 @@ The function is available since Linux 2.3.31. It is Linux specific, and should be avoided in portable applications. See also the -.I mmap64() +.IR mmap64 () function that is part of the LFS (Large File Summit). .SH "SEE ALSO" .BR getpagesize (2), diff --git a/man2/msgop.2 b/man2/msgop.2 index 0cf181d5f9..1b8be1effa 100644 --- a/man2/msgop.2 +++ b/man2/msgop.2 @@ -421,7 +421,7 @@ SVr4, SVID. .SH NOTE The pointer argument is declared as \fIstruct msgbuf *\fP with libc4, libc5, glibc 2.0, glibc 2.1. It is declared as \fIvoid *\fP -(\fIconst void *\fP for \fImsgsnd()\fP) with glibc 2.2, following the SUSv2. +(\fIconst void *\fP for \fImsgsnd\fP()) with glibc 2.2, following the SUSv2. .SH "SEE ALSO" .BR msgctl (2), .BR msgget (2), diff --git a/man2/open.2 b/man2/open.2 index f5d663b58e..ec1cde693a 100644 --- a/man2/open.2 +++ b/man2/open.2 @@ -182,7 +182,7 @@ locking tasks will contain a race condition. The solution for performing atomic file locking using a lockfile is to create a unique file on the same file system (e.g., incorporating hostname and pid), use .BR link (2) -to make a link to the lockfile. If \fBlink()\fP returns 0, the lock is +to make a link to the lockfile. If \fBlink\fP() returns 0, the lock is successful. Otherwise, use .BR stat (2) on the unique file to check if its link count has increased to 2, diff --git a/man2/pread.2 b/man2/pread.2 index b7d97d0f01..448810bbe8 100644 --- a/man2/pread.2 +++ b/man2/pread.2 @@ -33,7 +33,7 @@ pread, pwrite \- read from or write to a file descriptor at a given offset .BI "ssize_t pwrite(int " fd ", const void *" buf ", size_t " count ", off_t " offset ); .fi .SH DESCRIPTION -.B pread() +.BR pread () reads up to .I count bytes from file descriptor @@ -44,7 +44,7 @@ at offset .IR buf . The file offset is not changed. .PP -.B pwrite() +.BR pwrite () writes up to .I count bytes from the buffer starting at diff --git a/man2/read.2 b/man2/read.2 index 78a897522d..b06e010ce2 100644 --- a/man2/read.2 +++ b/man2/read.2 @@ -42,7 +42,7 @@ read \- read from a file descriptor .BI "ssize_t read(int " fd ", void *" buf ", size_t " count ); .fi .SH DESCRIPTION -.B read() +.BR read () attempts to read up to .I count bytes from file descriptor @@ -52,7 +52,7 @@ into the buffer starting at .PP If .I count -is zero, \fBread()\fP returns zero and has no other results. +is zero, \fBread\fP() returns zero and has no other results. If .I count is greater than SSIZE_MAX, the result is unspecified. @@ -64,7 +64,7 @@ It is not an error if this number is smaller than the number of bytes requested; this may happen for example because fewer bytes are actually available right now (maybe because we were close to end-of-file, or because we are reading from a pipe, or from a terminal), or because -\fBread()\fP was interrupted by a signal. +\fBread\fP() was interrupted by a signal. On error, \-1 is returned, and .I errno is set appropriately. In this case it is left unspecified whether diff --git a/man2/readahead.2 b/man2/readahead.2 index 5e0ef4ee7c..453cb2b35c 100644 --- a/man2/readahead.2 +++ b/man2/readahead.2 @@ -32,7 +32,7 @@ readahead \- perform file readahead into page cache .BI "ssize_t readahead(int " fd ", off64_t *" offset ", size_t " count ); .fi .SH DESCRIPTION -.B readahead() +.BR readahead () populates the page cache with data from a file so that subsequent reads from that file will not block on disk I/O. The @@ -51,16 +51,16 @@ is effectively rounded down to a page boundary and bytes are read up to the next page boundary greater than or equal to .IR "(offset+count)" . -.B readahead() +.BR readahead () does not read beyond the end of the file. -.B readahead() +.BR readahead () blocks until the specified data has been read. The current file offset of the open file referred to by .I fd is left unchanged. .SH "RETURN VALUE" On success, -.B readahead() +.BR readahead () returns 0; on failure, \-1 is returned, with .I errno set to indicate the cause of the error. @@ -77,12 +77,12 @@ does not refer to a file type to which can be applied. .SH "CONFORMING TO" The -.B readahead() +.BR readahead () system call is Linux specific, and its use should be avoided in portable applications. .SH NOTES The -.B readahead() +.BR readahead () system call appeared in Linux 2.4.13. .SH "SEE ALSO" .BR fadvise (2), diff --git a/man2/remap_file_pages.2 b/man2/remap_file_pages.2 index 766e991a69..cc13bd4f78 100644 --- a/man2/remap_file_pages.2 +++ b/man2/remap_file_pages.2 @@ -31,12 +31,12 @@ remap_file_pages \- create a non-linear file mapping .BI "ssize_t " pgoff ", int " flags ); .SH DESCRIPTION The -.B remap_file_pages() +.BR remap_file_pages () system call is used to create a non-linear mapping, that is, a mapping in which the pages of the file are mapped into a non-sequential order in memory. The advantage of using -.B remap_file_pages() +.BR remap_file_pages () over using repeated calls to .BR mmap (2) is that the former approach does not require the kernel to create @@ -46,14 +46,14 @@ To create a non-linear mapping we perform the following steps: .TP \fB1.\fp Use -.B mmap() +.BR mmap () to create a mapping (which is initially linear). This mapping must be created with the MAP_SHARED flag. .TP \fB2.\fp Use one or more calls to -.B remap_file_pages() +.BR remap_file_pages () to rearrange the correspondence between the pages of the mapping and the pages of the file. It is possible to map the same page of a file @@ -78,7 +78,7 @@ Thus, .I start must be an address that falls within a region previously mapped by a call to -.BR mmap() . +.BR mmap (). Second, .I start specifies the address at which the file pages @@ -109,18 +109,18 @@ argument must be specified as 0. The .I flags argument has the same meaning as for -.BR mmap() , +.BR mmap (), but all flags other than MAP_NONBLOCK are ignored. .SH "RETURN VALUE" On success, -.B remap_file_pages() +.BR remap_file_pages () returns 0. On error, \-1 is returned, and .I errno is set appropriately. .SH NOTES The -.B remap_file_pages() +.BR remap_file_pages () system call appeared in Linux 2.5.46. .SH ERRORS .TP @@ -139,7 +139,7 @@ is invalid. .\" And possibly others from vma->vm_ops->populate() .SH "CONFORMING TO" The -.B remap_file_pages() +.BR remap_file_pages () system call is Linux specific. .SH "SEE ALSO" .BR getpagesize (2), diff --git a/man2/select_tut.2 b/man2/select_tut.2 index b3c73f984e..8722f71e8b 100644 --- a/man2/select_tut.2 +++ b/man2/select_tut.2 @@ -86,15 +86,15 @@ I can't see the use for it in a clean program. This set is watched to see if data is available for reading from any of its file descriptors. After \fBselect\fP() has returned, \fIreadfds\fP will be cleared of all file descriptors except for those file descriptors that -are immediately available for reading with a \fBrecv()\fP (for sockets) or -\fBread()\fP (for pipes, files, and sockets) call. +are immediately available for reading with a \fBrecv\fP() (for sockets) or +\fBread\fP() (for pipes, files, and sockets) call. .TP \fIwritefds\fP This set is watched to see if there is space to write data to any of its file descriptor. After \fBselect\fP() has returned, \fIwritefds\fP will be cleared of all file descriptors except for those file descriptors that -are immediately available for writing with a \fBsend()\fP (for sockets) or -\fBwrite()\fP (for pipes, files, and sockets) call. +are immediately available for writing with a \fBsend\fP() (for sockets) or +\fBwrite\fP() (for pipes, files, and sockets) call. .TP \fIexceptfds\fP This set is watched for exceptions or errors on any of the file @@ -105,7 +105,7 @@ is data sent on a socket using the \fBMSG_OOB\fP flag, and hence \fBsend\fP(2) about this. After \fBselect\fP() has returned, \fIexceptfds\fP will be cleared of all file descriptors except for those descriptors that are available for reading OOB data. You can only ever -read one byte of OOB data though (which is done with \fBrecv()\fP), and +read one byte of OOB data though (which is done with \fBrecv\fP()), and writing OOB data (done with \fBsend\fP) can be done at any time and will not block. Hence there is no need for a fourth set to check if a socket is available for writing OOB data. @@ -559,10 +559,10 @@ int main (int argc, char **argv) { The above program properly forwards most kinds of TCP connections including OOB signal data transmitted by \fBtelnet\fP servers. It handles the tricky problem of having data flow in both directions -simultaneously. You might think it more efficient to use a \fBfork()\fP +simultaneously. You might think it more efficient to use a \fBfork\fP() call and devote a thread to each stream. This becomes more tricky than you might suspect. Another idea is to set non-blocking IO using an -\fBioctl()\fP call. This also has its problems because you end up having +\fBioctl\fP() call. This also has its problems because you end up having to have inefficient timeouts. The program does not handle more than one simultaneous connection at a @@ -603,8 +603,8 @@ for writing \fImust\fP be written to, and any file descriptor available for reading \fImust\fP be read, etc. .TP \fB5.\fP -The functions \fBread()\fP, \fBrecv()\fP, \fBwrite()\fP, and -\fBsend()\fP do \fInot\fP necessarily read/write the full amount of data +The functions \fBread\fP(), \fBrecv\fP(), \fBwrite\fP(), and +\fBsend\fP() do \fInot\fP necessarily read/write the full amount of data that you have requested. If they do read/write the full amount, its because you have a low traffic load and a fast stream. This is not always going to be the case. You should cope with the case of your @@ -619,8 +619,8 @@ easily be made as large as the maximum possible packet size on your local network. .TP \fB7.\fP -The functions \fBread()\fP, \fBrecv()\fP, \fBwrite()\fP, and -\fBsend()\fP as well as the \fBselect()\fP call can return \-1 with an +The functions \fBread\fP(), \fBrecv\fP(), \fBwrite\fP(), and +\fBsend\fP() as well as the \fBselect\fP() call can return \-1 with an errno of \fBEINTR\fP or \fBEAGAIN\fP (\fBEWOULDBLOCK\fP) which are not errors. These results must be properly managed (not done properly above). If your program is not going to receive any signals then @@ -629,14 +629,14 @@ set non-blocking IO, you will not get \fBEAGAIN\fP. Nonetheless you should still cope with these errors for completeness. .TP \fB8.\fP -Never call \fBread()\fP, \fBrecv()\fP, \fBwrite()\fP, or \fBsend()\fP +Never call \fBread\fP(), \fBrecv\fP(), \fBwrite\fP(), or \fBsend\fP() with a buffer length of zero. .TP \fB9.\fP -Except as indicated in \fB7.\fP, the functions \fBread()\fP, -\fBrecv()\fP, \fBwrite()\fP, and \fBsend()\fP never have a return value +Except as indicated in \fB7.\fP, the functions \fBread\fP(), +\fBrecv\fP(), \fBwrite\fP(), and \fBsend\fP() never have a return value less than 1 except if an error has occurred. For instance, a -\fBread()\fP on a pipe where the other end has died returns zero (so +\fBread\fP() on a pipe where the other end has died returns zero (so does an end-of-file error), \fIbut\fP only returns zero once (a followup read or write will return \-1). Should any of these functions return 0 or \-1, you should \fInot\fP diff --git a/man2/setpgid.2 b/man2/setpgid.2 index 0eec55a4bf..3a79ef8bc4 100644 --- a/man2/setpgid.2 +++ b/man2/setpgid.2 @@ -79,12 +79,12 @@ If is zero, the process ID of the current process is used. The call -.B setpgrp() +.BR setpgrp () is equivalent to .BR setpgid(0,0) . Similarly, -.B getpgrp() +.BR getpgrp () is equivalent to .BR getpgid(0) . Each process group is a member of a session and each process is a diff --git a/man2/sigsuspend.2 b/man2/sigsuspend.2 index 0b64eb0cdd..a643c66156 100644 --- a/man2/sigsuspend.2 +++ b/man2/sigsuspend.2 @@ -78,7 +78,7 @@ When the critical code has completed, the caller then waits for the signals by calling .BR sigsuspend () with the signal mask that was returned by -.BR sigprocmask() +.BR sigprocmask () (in the .IR oldset argument). diff --git a/man2/statfs.2 b/man2/statfs.2 index b3b4897ef4..947f6b77d4 100644 --- a/man2/statfs.2 +++ b/man2/statfs.2 @@ -222,7 +222,7 @@ when NFS-exported, and giving it out is a security concern. Under some OSes the .I fsid can be used as second parameter to the -.I sysfs() +.IR sysfs () system call. .SH NOTES The kernel has system calls statfs, fstatfs, statfs64, fstatfs64 diff --git a/man2/stime.2 b/man2/stime.2 index 04abd13cf6..b08cecaf43 100644 --- a/man2/stime.2 +++ b/man2/stime.2 @@ -39,7 +39,7 @@ stime \- set time .SH DESCRIPTION \fBstime\fP() sets the system's idea of the time and date. Time, pointed to by \fIt\fP, is measured in seconds from 00:00:00 GMT January 1, 1970. -\fBstime()\fP may only be executed by the superuser. +\fBstime\fP() may only be executed by the superuser. .SH "RETURN VALUE" On success, zero is returned. On error, \-1 is returned, and .I errno diff --git a/man2/sync.2 b/man2/sync.2 index 75fc6f8c11..ec9e0f3e53 100644 --- a/man2/sync.2 +++ b/man2/sync.2 @@ -47,7 +47,7 @@ This function is always successful. SVr4, SVID, X/OPEN, 4.3BSD .SH BUGS According to the standard specification (e.g., SVID), -\fBsync()\fP schedules the writes, but may return before the actual +\fBsync\fP() schedules the writes, but may return before the actual writing is done. However, since version 1.3.20 Linux does actually wait. (This still does not guarantee data integrity: modern disks have diff --git a/man2/syscalls.2 b/man2/syscalls.2 index 1fc0af027e..9de78f5883 100644 --- a/man2/syscalls.2 +++ b/man2/syscalls.2 @@ -267,7 +267,7 @@ Roughly speaking, the code belonging to the system call with number __NR_xxx defined in .I /usr/include/asm/unistd.h can be found in the kernel source in the routine -.IR sys_xxx() . +.IR sys_xxx (). (The dispatch table for i386 can be found in .IR /usr/src/linux/arch/i386/kernel/entry.S .) There are many exceptions, however, mostly because diff --git a/man2/syslog.2 b/man2/syslog.2 index befb390445..1402259bb5 100644 --- a/man2/syslog.2 +++ b/man2/syslog.2 @@ -46,15 +46,15 @@ syslog, klogctl \- read and/or clear kernel message ring buffer; set console_log .fi .SH DESCRIPTION If you need the libc function -.BR syslog() , +.BR syslog (), (that talks to .BR syslogd (8)), then look at .BR syslog (3). The system call of this name is about controlling the kernel -.I printk() +.IR printk () buffer, and the glibc version is called -.BR klogctl() . +.BR klogctl (). The \fItype\fP argument determines the action taken by this function. diff --git a/man2/uselib.2 b/man2/uselib.2 index 39c0cd3fd6..fd3540724d 100644 --- a/man2/uselib.2 +++ b/man2/uselib.2 @@ -70,10 +70,10 @@ The file specified by is not an executable of known type, e.g., does not have the correct magic numbers. .SH "CONFORMING TO" -\fBuselib()\fP is Linux specific, and should not be used in programs +\fBuselib\fP() is Linux specific, and should not be used in programs intended to be portable. .SH NOTES -\fBuselib()\fP was used by early libc startup code to load +\fBuselib\fP() was used by early libc startup code to load the shared libraries with names found in an array of names in the binary. .LP diff --git a/man2/write.2 b/man2/write.2 index c5060bcfc3..c3dd76ff4c 100644 --- a/man2/write.2 +++ b/man2/write.2 @@ -45,8 +45,8 @@ bytes to the file referenced by the file descriptor .I fd from the buffer starting at .IR buf . -POSIX requires that a \fBread()\fP which can be proved to occur after a -\fBwrite()\fP has returned returns the new data. Note that not all file +POSIX requires that a \fBread\fP() which can be proved to occur after a +\fBwrite\fP() has returned returns the new data. Note that not all file systems are POSIX conforming. .SH "RETURN VALUE" On success, the number of bytes written are returned (zero indicates |