From e9496f74fa45afba28b87704fa69732e9dee8e99 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Wed, 6 Jul 2005 06:54:27 +0000 Subject: [PATCH] Hyphen/dash fixes --- man2/alloc_hugepages.2 | 4 ++-- man2/chdir.2 | 2 +- man2/chown.2 | 2 +- man2/futex.2 | 2 +- man2/getcontext.2 | 2 +- man2/getgroups.2 | 2 +- man2/getpriority.2 | 2 +- man2/gettimeofday.2 | 8 ++++---- man2/ioctl_list.2 | 6 +++--- man2/madvise.2 | 2 +- man2/mincore.2 | 4 ++-- man2/open.2 | 8 ++++---- man2/path_resolution.2 | 4 ++-- man2/rename.2 | 4 ++-- man2/select.2 | 2 +- man2/sigaction.2 | 2 +- man2/sigaltstack.2 | 2 +- man2/syslog.2 | 11 ++++++----- man2/times.2 | 2 +- man2/uname.2 | 2 +- man2/vfork.2 | 4 ++-- man2/wait4.2 | 4 ++-- 22 files changed, 41 insertions(+), 40 deletions(-) diff --git a/man2/alloc_hugepages.2 b/man2/alloc_hugepages.2 index 57a6ae181..df83cc972 100644 --- a/man2/alloc_hugepages.2 +++ b/man2/alloc_hugepages.2 @@ -59,7 +59,7 @@ The .I addr parameter of .B free_hugepages() -tells which page is being freed - it was the return value of a +tells which page is being freed: it was the return value of a call to .BR alloc_hugepages() . (The memory is first actually freed when all users have released it.) @@ -103,7 +103,7 @@ is set appropriately. .B ENOSYS The system call is not supported on this kernel. .SH "CONFORMING TO" -These calls existed only in Linux 2.5.36 - 2.5.54. +These calls existed only in Linux 2.5.36 through to 2.5.54. These calls are specific to Linux on Intel processors, and should not be used in programs intended to be portable. Indeed, the system call numbers are marked for reuse, so programs using these may do something random diff --git a/man2/chdir.2 b/man2/chdir.2 index 77caeac48..cb49ff431 100644 --- a/man2/chdir.2 +++ b/man2/chdir.2 @@ -108,7 +108,7 @@ The prototype for is only available if .B _BSD_SOURCE is defined (either explicitly, or implicitly, by not defining -_POSIX_SOURCE or compiling with the -ansi flag). +_POSIX_SOURCE or compiling with the \-ansi flag). .SH "CONFORMING TO" The .B chdir diff --git a/man2/chown.2 b/man2/chown.2 index 3e0fc3c0e..018f1448a 100644 --- a/man2/chown.2 +++ b/man2/chown.2 @@ -158,7 +158,7 @@ The prototype for is only available if .B _BSD_SOURCE is defined (either explicitly, or implicitly, by not defining -_POSIX_SOURCE or compiling with the -ansi flag). +_POSIX_SOURCE or compiling with the \-ansi flag). .SH "CONFORMING TO" The .B chown diff --git a/man2/futex.2 b/man2/futex.2 index 27a61fc76..15f1368d1 100644 --- a/man2/futex.2 +++ b/man2/futex.2 @@ -195,7 +195,7 @@ read the sources of the futex userspace library referenced below. Initial futex support was merged in Linux 2.5.7 but with different semantics from what was described above. A 4-parameter system call with the semantics given here was introduced in Linux 2.5.40. In Linux 2.5.70 one parameter -was added. In Linux 2.6.7 a sixth parameter was added - messy, especially +was added. In Linux 2.6.7 a sixth parameter was added \- messy, especially on the s390 architecture. .SH "SEE ALSO" .PP diff --git a/man2/getcontext.2 b/man2/getcontext.2 index 4ed154f52..9b44ec932 100644 --- a/man2/getcontext.2 +++ b/man2/getcontext.2 @@ -110,7 +110,7 @@ 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 +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" diff --git a/man2/getgroups.2 b/man2/getgroups.2 index ef5b81b58..23e33a5cc 100644 --- a/man2/getgroups.2 +++ b/man2/getgroups.2 @@ -115,7 +115,7 @@ The prototype for is only available if .B _BSD_SOURCE is defined (either explicitly, or implicitly, by not defining -_POSIX_SOURCE or compiling with the -ansi flag). +_POSIX_SOURCE or compiling with the \-ansi flag). .SH "CONFORMING TO" SVr4, SVID (issue 4 only; these calls were not present in SVr3), X/OPEN, 4.3BSD. The diff --git a/man2/getpriority.2 b/man2/getpriority.2 index d27768edc..9019e7941 100644 --- a/man2/getpriority.2 +++ b/man2/getpriority.2 @@ -152,7 +152,7 @@ the effective user ID of the caller to match the real or effective user ID of the process \fIwho\fP. .LP The actual priority range varies between kernel versions. -Linux before 1.3.36 had -infinity..15. Linux since 1.3.43 has \-20..19, +Linux before 1.3.36 had \-infinity..15. Linux since 1.3.43 has \-20..19, and the system call getpriority returns 40..1 for these values (since negative numbers are error codes). The library call converts N into 20-N. diff --git a/man2/gettimeofday.2 b/man2/gettimeofday.2 index f445dabc7..54fec837f 100644 --- a/man2/gettimeofday.2 +++ b/man2/gettimeofday.2 @@ -85,9 +85,9 @@ int tz_dsttime; /* type of dst correction */ }; .fi .PP -The use of the timezone struct is obsolete; the +The use of the timezone struct is obsolete: the .I tz_dsttime -field has never been used under Linux - it has not +field has never been used under Linux; it has not been and will not be supported by libc or glibc. Each and every occurrence of this field in the kernel source (other than the declaration) is a bug. Thus, the following @@ -97,7 +97,7 @@ The field .I tz_dsttime contains a symbolic constant (values are given below) that indicates in which part of the year Daylight Saving Time -is in force. (Note: its value is constant throughout the year - +is in force. (Note: its value is constant throughout the year: it does not indicate that DST is in force, it just selects an algorithm.) The daylight saving time algorithms defined are as follows : @@ -213,7 +213,7 @@ 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). +_POSIX_SOURCE or compiling with the \-ansi flag). .LP Traditionally, the fields of struct timeval were longs. .SH "CONFORMING TO" diff --git a/man2/ioctl_list.2 b/man2/ioctl_list.2 index d2094a0da..490c7d5a8 100644 --- a/man2/ioctl_list.2 +++ b/man2/ioctl_list.2 @@ -70,10 +70,10 @@ serial number. The macros describing this structure live in and are _IO(type,nr) and {_IOR,_IOW,_IOWR}(type,nr,size). They use sizeof(size) so that size is a -misnomer here - this third parameter is a data type. +misnomer here: this third parameter is a data type. .LP -Note that the size bits are very unreliable - in lots of cases -they are wrong - either because of buggy macros using +Note that the size bits are very unreliable: in lots of cases +they are wrong, either because of buggy macros using sizeof(sizeof(struct)), or because of legacy values. .LP Thus, it seems that the new structure only gave disadvantages: diff --git a/man2/madvise.2 b/man2/madvise.2 index 966ea823c..51354b6f0 100644 --- a/man2/madvise.2 +++ b/man2/madvise.2 @@ -110,7 +110,7 @@ to release locked or shared pages (with MADV_DONTNEED). maximum resident set size. .TP .B ENOMEM -(for MADV_WILLNEED) Not enough memory - paging in failed. +(for MADV_WILLNEED) Not enough memory: paging in failed. .TP .B ENOMEM Addresses in the specified range are not currently diff --git a/man2/mincore.2 b/man2/mincore.2 index e7fb628f8..6c1a89d21 100644 --- a/man2/mincore.2 +++ b/man2/mincore.2 @@ -51,7 +51,7 @@ address. On return, the kernel will have filled with bytes, of which the least significant bit indicates if a page is core resident. (The other bits are undefined, reserved for possible later use.) -Of course this is only a snapshot - pages that are not +Of course this is only a snapshot: pages that are not locked in core can come and go any moment, and the contents of .I vec may be stale already when this call returns. @@ -91,7 +91,7 @@ is not a multiple of the page size. .B ENOMEM .I len is greater than -.RI ( TASK_SIZE " - " start ). +.RI ( TASK_SIZE " \- " start ). (This could occur if a negative value is specified for .IR len , since that value will be interpreted as a large diff --git a/man2/open.2 b/man2/open.2 index 0d3cba75d..495f0b8f2 100644 --- a/man2/open.2 +++ b/man2/open.2 @@ -322,7 +322,7 @@ Note that .BR open () can open device special files, but .BR creat () -cannot create them - use +cannot create them; use .BR mknod (2) instead. .LP @@ -387,7 +387,7 @@ The system limit on the total number of open files has been reached. .B ENODEV .I pathname refers to a device special file and no corresponding device exists. -(This is a Linux kernel bug - in this situation ENXIO must be returned.) +(This is a Linux kernel bug; in this situation ENXIO must be returned.) .TP .B ENOENT O_CREAT is not set and the named file does not exist. @@ -418,7 +418,7 @@ Or, the file is a device special file and no corresponding device exists. .TP .B EOVERFLOW .I pathname -refers to a regular file, too large to be opened - see O_LARGEFILE above. +refers to a regular file, too large to be opened; see O_LARGEFILE above. .TP .B EPERM The @@ -480,7 +480,7 @@ macro to get its definition. .SH BUGS "The thing that has always disturbed me about O_DIRECT is that the whole interface is just stupid, and was probably designed by a deranged monkey -on some serious mind-controlling substances." -- Linus +on some serious mind-controlling substances." \(em Linus .SH RESTRICTIONS There are many infelicities in the protocol underlying NFS, affecting amongst others diff --git a/man2/path_resolution.2 b/man2/path_resolution.2 index f17f06217..b88ddea55 100644 --- a/man2/path_resolution.2 +++ b/man2/path_resolution.2 @@ -35,7 +35,7 @@ of the file hierarchy. A process may get a different root directory by use of the .BR chroot (2) system call. A process may get an entirely private namespace in case -it - or one of its ancestors - was started by an invocation of the +it \(em or one of its ancestors \(em was started by an invocation of the .BR clone (2) system call that had the CLONE_NEWNS flag set.) This handles the '/' part of the pathname. @@ -121,7 +121,7 @@ outside of the filesystem hierarchy on "dev". .SS "Trailing slashes" If a pathname ends in a '/', that forces resolution of the preceding -component as in Step 2 - it has to exist and resolve to a directory. +component as in Step 2: it has to exist and resolve to a directory. Otherwise a trailing '/' is ignored. (Or, equivalently, a pathname with a trailing '/' is equivalent to the pathname obtained by appending '.' to it.) diff --git a/man2/rename.2 b/man2/rename.2 index 0e5883941..bfc63acc4 100644 --- a/man2/rename.2 +++ b/man2/rename.2 @@ -46,7 +46,7 @@ are unaffected. If .I newpath already exists it will be atomically replaced (subject to -a few conditions - see ERRORS below), so that there is +a few conditions; see ERRORS below), so that there is no point at which another process attempting to access .I newpath will find it missing. @@ -105,7 +105,7 @@ it was open for reading) or is in use by the system (for example as mount point), while the system considers this an error. (Note that there is no requirement to return EBUSY in such -cases - there is nothing wrong with doing the rename anyway - +cases \(em there is nothing wrong with doing the rename anyway \(em but it is allowed to return EBUSY if the system cannot otherwise handle such situations.) .TP diff --git a/man2/select.2 b/man2/select.2 index b6b48ec17..e63b97726 100644 --- a/man2/select.2 +++ b/man2/select.2 @@ -108,7 +108,7 @@ Three independent sets of descriptors are watched. Those listed in .I readfds will be watched to see if characters become available for reading (more precisely, to see if a read will not -block - in particular, a file descriptor is also ready on end-of-file), +block; in particular, a file descriptor is also ready on end-of-file), those in .I writefds will be watched to see if a write will not block, and diff --git a/man2/sigaction.2 b/man2/sigaction.2 index 1397219d8..63b775d68 100644 --- a/man2/sigaction.2 +++ b/man2/sigaction.2 @@ -92,7 +92,7 @@ struct sigaction { .fi .RE .PP -On some architectures a union is involved - do not assign to both +On some architectures a union is involved: do not assign to both .I sa_handler and .IR sa_sigaction . diff --git a/man2/sigaltstack.2 b/man2/sigaltstack.2 index 9f94922f0..42668d361 100644 --- a/man2/sigaltstack.2 +++ b/man2/sigaltstack.2 @@ -21,7 +21,7 @@ .\" aeb, various minor fixes .TH SIGALTSTACK 2 2001-09-27 "Linux 2.4" "Linux Programmer's Manual" .SH NAME -sigaltstack - set and/or get signal stack context +sigaltstack \- set and/or get signal stack context .SH SYNOPSIS .B #include .sp diff --git a/man2/syslog.2 b/man2/syslog.2 index 3e653a32d..86bc6f5ed 100644 --- a/man2/syslog.2 +++ b/man2/syslog.2 @@ -121,10 +121,11 @@ only executes the `clear ring buffer' command. .br The kernel routine \fIprintk\fP() will only print a message on the console, if it has a loglevel less than the value of the variable -.I console_loglevel -(initially DEFAULT_CONSOLE_LOGLEVEL (7), but set to 10 if the +.IR console_loglevel . +This variable initially has the value DEFAULT_CONSOLE_LOGLEVEL (7), +but is set to 10 if the kernel command line contains the word `debug', and to 15 in case -of a kernel fault - the 10 and 15 are just silly, and equivalent to 8). +of a kernel fault (the 10 and 15 are just silly, and equivalent to 8). This variable is set (to a value in the range 1-8) by the call .B syslog .RI (8, dummy , value ). @@ -135,7 +136,7 @@ with \fItype\fP equal to 6 or 7, set it to 1 (kernel panics only) or 7 (all except debugging messages), respectively. Every text line in a message has its own loglevel. This level is -DEFAULT_MESSAGE_LOGLEVEL - 1 (6) unless the line starts with +DEFAULT_MESSAGE_LOGLEVEL \- 1 (6) unless the line starts with where \fId\fP is a digit in the range 1-7, in which case the level is \fId\fP. The conventional meaning of the loglevel is defined in .I @@ -166,7 +167,7 @@ An attempt was made to change console_loglevel or clear the kernel message ring buffer by a process without root permissions. .TP .B ERESTARTSYS -System call was interrupted by a signal - nothing was read. +System call was interrupted by a signal; nothing was read. (This can be seen only during a trace.) .SH "CONFORMING TO" This system call is Linux specific and should not be used in programs diff --git a/man2/times.2 b/man2/times.2 index 289861d02..cf4e901b5 100644 --- a/man2/times.2 +++ b/man2/times.2 @@ -102,7 +102,7 @@ All times reported are in clock ticks. returns the number of clock ticks that have elapsed since an arbitrary point in the past. For Linux 2.4 and earlier this point is the moment the system was booted. -Since Linux 2.6, this point is \fI(2^32/HZ) - 300\fP +Since Linux 2.6, this point is \fI(2^32/HZ) \- 300\fP (i.e., about 429 million) seconds before system boot time. The return value may overflow the possible range of type .I clock_t. diff --git a/man2/uname.2 b/man2/uname.2 index 5850b79bb..4dcc5184e 100644 --- a/man2/uname.2 +++ b/man2/uname.2 @@ -101,7 +101,7 @@ and the \fIdomainname\fP field. The length of the fields in the struct varies. Some operating systems or libraries use a hardcoded 9 or 33 or 65 or 257. Other systems use SYS_NMLN or _SYS_NMLN or UTSLEN or _UTSNAME_LENGTH. Clearly, it is a bad -idea to use any of these constants - just use sizeof(...). +idea to use any of these constants; just use sizeof(...). Often 257 is chosen in order to have room for an internet hostname. .LP There have been three Linux system calls \fIuname\fP(). The first one diff --git a/man2/vfork.2 b/man2/vfork.2 index 8a058e899..7c874ff43 100644 --- a/man2/vfork.2 +++ b/man2/vfork.2 @@ -53,7 +53,7 @@ family of functions. .SH ERRORS .TP .B EAGAIN -Too many processes - try again. +Too many processes; try again. .TP .B ENOMEM There is insufficient swap space for the new process. @@ -111,7 +111,7 @@ or an exit occurred. The parent process was suspended while the child was using its resources. The use of .BR vfork () -was tricky - for example, not modifying data +was tricky: for example, not modifying data in the parent process depended on knowing which variables are held in a register. .SH BUGS diff --git a/man2/wait4.2 b/man2/wait4.2 index b38df9aec..0091ad271 100644 --- a/man2/wait4.2 +++ b/man2/wait4.2 @@ -1,7 +1,7 @@ .\" Hey Emacs! This file is -*- nroff -*- source. .\" .\" (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de) -.\" (c) 2004 bu Michael Kerrisk (mtk-manpages@gmx.net) +.\" (c) 2004 by Michael Kerrisk (mtk-manpages@gmx.net) .\" .\" Permission is granted to make and distribute verbatim copies of this .\" manual provided the copyright notice and this permission notice are @@ -130,7 +130,7 @@ defined in The prototype for these functions is only available if .B _BSD_SOURCE is defined (either explicitly, or implicitly, by not defining -_POSIX_SOURCE or compiling with the -ansi flag). +_POSIX_SOURCE or compiling with the \-ansi flag). .SH "CONFORMING TO" 4.3BSD .SH "SEE ALSO"