diff options
53 files changed, 150 insertions, 92 deletions
@@ -8,6 +8,8 @@ Contributors The following people contributed notes, ideas, or patches that have been incorporated in changes in this release: +Colin Watson <cjwatson@debian.org> +Justin Pryzby <justinpryzby@users.sourceforge.net> Apologies if I missed anyone! @@ -27,3 +29,7 @@ places. Changes to individual pages --------------------------- +man.7 + Justin Pryzby / Colin Watson / mtk + .SH doesn't require quotes. + See Debian bug 411303. diff --git a/man2/getgroups.2 b/man2/getgroups.2 index d4a0014f..3a61cd96 100644 --- a/man2/getgroups.2 +++ b/man2/getgroups.2 @@ -99,7 +99,8 @@ The calling process has insufficient privilege to call .BR setgroups (). .SH NOTES A process can have up to at least NGROUPS_MAX supplementary group IDs -in addition to the effective group ID. The set of supplementary group IDs +in addition to the effective group ID. +The set of supplementary group IDs is inherited from the parent process and may be changed using .BR setgroups (). The maximum number of supplementary group IDs can be found using diff --git a/man2/getrlimit.2 b/man2/getrlimit.2 index 74c9d932..a2ac6121 100644 --- a/man2/getrlimit.2 +++ b/man2/getrlimit.2 @@ -122,7 +122,8 @@ and .BR mremap (2), which fail with the error .B ENOMEM -upon exceeding this limit. Also automatic stack expansion will fail +upon exceeding this limit. +Also automatic stack expansion will fail (and generate a .B SIGSEGV that kills the process if no alternate stack @@ -134,7 +135,8 @@ either this limit is at most 2 GiB, or this resource is unlimited. .B RLIMIT_CORE Maximum size of .I core -file. When 0 no core dump files are created. +file. +When 0 no core dump files are created. When non-zero, larger dumps are truncated to this size. .TP .B RLIMIT_CPU diff --git a/man2/msync.2 b/man2/msync.2 index 3af3be17..c9089d0b 100644 --- a/man2/msync.2 +++ b/man2/msync.2 @@ -104,7 +104,8 @@ are defined in <unistd.h> to a value greater than 0. (See also POSIX.1-2001. This call was introduced in Linux 1.3.21, and then used EFAULT instead of -ENOMEM. In Linux 2.4.19 this was changed to the POSIX value ENOMEM. +ENOMEM. +In Linux 2.4.19 this was changed to the POSIX value ENOMEM. .SH "SEE ALSO" .BR mmap (2) .br diff --git a/man2/prctl.2 b/man2/prctl.2 index 25ed5f0a..a64fa7d7 100644 --- a/man2/prctl.2 +++ b/man2/prctl.2 @@ -147,9 +147,10 @@ or .TP .B PR_SET_UNALIGN (Since Linux 2.3.48, only on parisc and ia64) -Set unaligned access control bits to \fIarg2\fP. Pass -\fBPR_UNALIGN_NOPRINT\fP to silently fix up unaligned user accesses, or -\fBPR_UNALIGN_SIGBUS\fP to generate SIGBUS on unaligned user access. +Set unaligned access control bits to \fIarg2\fP. +Pass +\fBPR_UNALIGN_NOPRINT\fP to silently fix up unaligned user accesses, +or \fBPR_UNALIGN_SIGBUS\fP to generate SIGBUS on unaligned user access. .TP .B PR_GET_UNALIGN (Since Linux 2.3.48, only on parisc and ia64) @@ -167,8 +168,8 @@ Get floating-point emulation control bits from \fIarg2\fP. .TP .B PR_SET_FPEXC (Since Linux 2.4.21, 2.5.32, only on PowerPC) -Set floating-point exception mode to \fIarg2\fP. Pass -\fBPR_FP_EXC_SW_ENABLE\fP to use FPEXC for FP exception enables, +Set floating-point exception mode to \fIarg2\fP. +Pass \fBPR_FP_EXC_SW_ENABLE\fP to use FPEXC for FP exception enables, \fBPR_FP_EXC_DIV\fP for floating point divide by zero, \fBPR_FP_EXC_OVF\fP for floating point overflow, \fBPR_FP_EXC_UND\fP for floating point underflow, diff --git a/man2/pread.2 b/man2/pread.2 index 2cd6a606..716e0b56 100644 --- a/man2/pread.2 +++ b/man2/pread.2 @@ -79,7 +79,8 @@ POSIX.1-2001. .SH HISTORY The \fBpread\fR() and \fBpwrite\fR() system calls were added to Linux in version 2.1.60; the entries in the i386 system call table were added -in 2.1.69. The libc support (including emulation on older kernels +in 2.1.69. +The libc support (including emulation on older kernels without the system calls) was added in glibc 2.1. .SH "SEE ALSO" .BR lseek (2), diff --git a/man2/sched_rr_get_interval.2 b/man2/sched_rr_get_interval.2 index 11057b2b..e6421ff8 100644 --- a/man2/sched_rr_get_interval.2 +++ b/man2/sched_rr_get_interval.2 @@ -52,7 +52,8 @@ struct timespec { If \fIpid\fR is zero, the time quantum for the calling process is written -into *\fItp\fR. The identified process should be running under the +into *\fItp\fR. +The identified process should be running under the .I SCHED_RR scheduling policy. diff --git a/man2/select_tut.2 b/man2/select_tut.2 index dc746da9..1506e3f0 100644 --- a/man2/select_tut.2 +++ b/man2/select_tut.2 @@ -198,7 +198,8 @@ Now, somewhere in the main loop will be a conditional to check the global flag. So we must ask: what if a signal arrives after the conditional, but before the -\fBselect\fP() call? The answer is that \fBselect\fP() would block +\fBselect\fP() call? +The answer is that \fBselect\fP() would block indefinitely, even though an event is actually pending. This race condition is solved by the \fBpselect\fP() call. diff --git a/man2/socketpair.2 b/man2/socketpair.2 index e9afdda3..4dc8bc9d 100644 --- a/man2/socketpair.2 +++ b/man2/socketpair.2 @@ -90,7 +90,8 @@ The specified protocol is not supported on this machine. 4.4BSD, POSIX.1-2001. The .BR socketpair () -function call appeared in 4.2BSD. It is generally portable to/from +function call appeared in 4.2BSD. +It is generally portable to/from non-BSD systems supporting clones of the BSD socket layer (including System V variants). .SH NOTES diff --git a/man2/unlink.2 b/man2/unlink.2 index fbf4cca5..95ed3912 100644 --- a/man2/unlink.2 +++ b/man2/unlink.2 @@ -53,7 +53,8 @@ If the name referred to a socket, fifo or device the name for it is removed but processes which have the object open may continue to use it. .SH "RETURN VALUE" -On success, zero is returned. On error, \-1 is returned, and +On success, zero is returned. +On error, \-1 is returned, and .I errno is set appropriately. .SH ERRORS diff --git a/man3/acos.3 b/man3/acos.3 index e72a0bce..d44e0f36 100644 --- a/man3/acos.3 +++ b/man3/acos.3 @@ -43,7 +43,8 @@ acos, acosf, acosl \- arc cosine function Link with \-lm. .SH DESCRIPTION The \fBacos\fP() function calculates the arc cosine of \fIx\fP; that is -the value whose cosine is \fIx\fP. If \fIx\fP falls outside the range +the value whose cosine is \fIx\fP. +If \fIx\fP falls outside the range \-1 to 1, \fBacos\fP() fails and \fIerrno\fP is set. .SH "RETURN VALUE" The \fBacos\fP() function returns the arc cosine in radians and the diff --git a/man3/acosh.3 b/man3/acosh.3 index 97249385..8785aa32 100644 --- a/man3/acosh.3 +++ b/man3/acosh.3 @@ -45,9 +45,9 @@ acosh, acoshf, acoshl \- inverse hyperbolic cosine function Link with \-lm. .SH DESCRIPTION The \fBacosh\fP() function calculates the inverse hyperbolic cosine of -\fIx\fP; that is the value whose hyperbolic cosine is \fIx\fP. If \fIx\fP -is less than 1.0, \fBacosh\fP() returns not-a-number (NaN) and \fIerrno\fP -is set. +\fIx\fP; that is the value whose hyperbolic cosine is \fIx\fP. +If \fIx\fP is less than 1.0, \fBacosh\fP() returns +not-a-number (NaN) and \fIerrno\fP is set. .SH ERRORS .TP .B EDOM diff --git a/man3/asin.3 b/man3/asin.3 index 3d8c8a4c..0fe40c54 100644 --- a/man3/asin.3 +++ b/man3/asin.3 @@ -45,7 +45,8 @@ asin, asinf, asinl \- arc sine function Link with \-lm. .SH DESCRIPTION The \fBasin\fP() function calculates the arc sine of \fIx\fP; that is -the value whose sine is \fIx\fP. If \fIx\fP falls outside the range +the value whose sine is \fIx\fP. +If \fIx\fP falls outside the range \-1 to 1, \fBasin\fP() fails and \fIerrno\fP is set. .SH "RETURN VALUE" The \fBasin\fP() function returns the arc sine in radians and the diff --git a/man3/atan2.3 b/man3/atan2.3 index 68e9aa03..f52ab3a4 100644 --- a/man3/atan2.3 +++ b/man3/atan2.3 @@ -45,7 +45,8 @@ atan2, atan2f, atan2l \- arc tangent function of two variables Link with \-lm. .SH DESCRIPTION The \fBatan2\fP() function calculates the arc tangent of the two -variables \fIx\fP and \fIy\fP. It is similar to calculating the +variables \fIx\fP and \fIy\fP. +It is similar to calculating the arc tangent of \fIy\fP / \fIx\fP, except that the signs of both arguments are used to determine the quadrant of the result. .SH "RETURN VALUE" diff --git a/man3/atanh.3 b/man3/atanh.3 index 5fee932f..a75a3e5d 100644 --- a/man3/atanh.3 +++ b/man3/atanh.3 @@ -45,8 +45,8 @@ atanh, atanhf, atanhl \- inverse hyperbolic tangent function Link with \-lm. .SH DESCRIPTION The \fBatanh\fP() function calculates the inverse hyperbolic tangent of -\fIx\fP; that is the value whose hyperbolic tangent is \fIx\fP. If the -absolute value of \fIx\fP is greater than 1.0, \fBatanh\fP() returns +\fIx\fP; that is the value whose hyperbolic tangent is \fIx\fP. +If the absolute value of \fIx\fP is greater than 1.0, \fBatanh\fP() returns not-a-number (NaN) and \fIerrno\fP is set. .SH ERRORS .TP diff --git a/man3/closedir.3 b/man3/closedir.3 index 17e96ffd..b773c8a3 100644 --- a/man3/closedir.3 +++ b/man3/closedir.3 @@ -39,7 +39,8 @@ closedir \- close a directory .fi .SH DESCRIPTION The \fBclosedir\fP() function closes the directory stream associated with -\fIdir\fP. The directory stream descriptor \fIdir\fP is not available +\fIdir\fP. +The directory stream descriptor \fIdir\fP is not available after this call. .SH "RETURN VALUE" The \fBclosedir\fP() function returns 0 on success. diff --git a/man3/fmod.3 b/man3/fmod.3 index 670b5aee..84d1e575 100644 --- a/man3/fmod.3 +++ b/man3/fmod.3 @@ -45,7 +45,8 @@ fmod, fmodf, fmodl \- floating-point remainder function Link with \-lm. .SH DESCRIPTION The \fBfmod\fP() function computes the remainder of dividing \fIx\fP by -\fIy\fP. The return value is \fIx\fP \- \fIn\fP * \fIy\fP, where \fIn\fP +\fIy\fP. +The return value is \fIx\fP \- \fIn\fP * \fIy\fP, where \fIn\fP is the quotient of \fIx\fP / \fIy\fP, rounded towards zero to an integer. .SH "RETURN VALUE" The \fBfmod\fP() function returns the remainder, unless \fIy\fP is zero, diff --git a/man3/fpathconf.3 b/man3/fpathconf.3 index 569929ca..a70bf465 100644 --- a/man3/fpathconf.3 +++ b/man3/fpathconf.3 @@ -110,7 +110,8 @@ returns the size of the pipe buffer, where .I filedes must refer to a pipe or FIFO and .I path -must refer to a FIFO. The corresponding macro is +must refer to a FIFO. +The corresponding macro is .BR _POSIX_PIPE_BUF . .TP .B _PC_CHOWN_RESTRICTED diff --git a/man3/fpclassify.3 b/man3/fpclassify.3 index 2a1e8221..a1f87ccc 100644 --- a/man3/fpclassify.3 +++ b/man3/fpclassify.3 @@ -24,11 +24,13 @@ fpclassify, isfinite, isnormal, isnan \- floating-point classification macros Compile with \-std=c99; link with \-lm. .SH DESCRIPTION Floating point numbers can have special values, such as -infinite or NaN. With the macro +infinite or NaN. +With the macro .BI fpclassify( x ) you can find out what type .I x -is. The macro takes any floating-point expression as argument. +is. +The macro takes any floating-point expression as argument. The result is one of the following values: .TP FP_NAN diff --git a/man3/gcvt.3 b/man3/gcvt.3 index 73430b42..f8e9d812 100644 --- a/man3/gcvt.3 +++ b/man3/gcvt.3 @@ -36,8 +36,8 @@ gcvt \- convert a floating-point number to a string .fi .SH DESCRIPTION The \fBgcvt\fP() function converts \fInumber\fP to a minimal length NULL -terminated ASCII string and stores the result in \fIbuf\fP. It produces -\fIndigit\fP significant digits in either +terminated ASCII string and stores the result in \fIbuf\fP. +It produces \fIndigit\fP significant digits in either .BR printf (3) F format or E format. .SH NOTES diff --git a/man3/getenv.3 b/man3/getenv.3 index a1c6454b..a43a03a0 100644 --- a/man3/getenv.3 +++ b/man3/getenv.3 @@ -38,8 +38,8 @@ getenv \- get an environment variable .fi .SH DESCRIPTION The \fBgetenv\fP() function searches the environment list for a string -that matches the string pointed to by \fIname\fP. The strings are of -the form \fIname = value\fP. +that matches the string pointed to by \fIname\fP. +The strings are of the form \fIname = value\fP. .SH "RETURN VALUE" The \fBgetenv\fP() function returns a pointer to the value in the environment, or NULL if there is no match. diff --git a/man3/getpw.3 b/man3/getpw.3 index 77fc2f69..d3054ef1 100644 --- a/man3/getpw.3 +++ b/man3/getpw.3 @@ -39,8 +39,8 @@ getpw \- Re-construct password line entry .fi .SH DESCRIPTION The \fBgetpw\fP() function re-constructs the password line entry for -the given user ID \fIuid\fP in the buffer \fIbuf\fP. The returned -buffer contains a line of format +the given user ID \fIuid\fP in the buffer \fIbuf\fP. +The returned buffer contains a line of format .sp .RS .B name:passwd:uid:gid:gecos:dir:shell diff --git a/man3/getservent.3 b/man3/getservent.3 index c7a79dd5..9a74d367 100644 --- a/man3/getservent.3 +++ b/man3/getservent.3 @@ -56,13 +56,13 @@ is opened if necessary. .PP The \fBgetservbyname\fP() function returns a \fIservent\fP structure for the line from \fI/etc/services\fP that matches the service -\fIname\fP using protocol \fIproto\fP. If \fIproto\fP is NULL, -any protocol will be matched. +\fIname\fP using protocol \fIproto\fP. +If \fIproto\fP is NULL, any protocol will be matched. .PP The \fBgetservbyport\fP() function returns a \fIservent\fP structure for the line that matches the port \fIport\fP given in network byte order -using protocol \fIproto\fP. If \fIproto\fP is NULL, -any protocol will be matched. +using protocol \fIproto\fP. +If \fIproto\fP is NULL, any protocol will be matched. .PP The \fBsetservent\fP() function opens and rewinds the \fI/etc/services\fP file. diff --git a/man3/getw.3 b/man3/getw.3 index d3d9da74..edbd4cbe 100644 --- a/man3/getw.3 +++ b/man3/getw.3 @@ -31,11 +31,12 @@ getw, putw \- input and output of words (ints) .br .BI "int putw(int " w ", FILE *" stream ); .SH DESCRIPTION -\fBgetw\fP() reads a word (that is, an \fIint\fP) from \fIstream\fP. It's -provided for compatibility with SVr4. We recommend you use -\fBfread\fP(3) instead. +\fBgetw\fP() reads a word (that is, an \fIint\fP) from \fIstream\fP. +It's provided for compatibility with SVr4. +We recommend you use \fBfread\fP(3) instead. .P -\fBputw\fP() writes the word \fIw\fP (that is, an \fIint\fP) to \fIstream\fP. +\fBputw\fP() writes the word \fIw\fP (that is, +an \fIint\fP) to \fIstream\fP. It is provided for compatibility with SVr4, but we recommend you use \fBfwrite\fP(3) instead. .SH "RETURN VALUE" diff --git a/man3/iswgraph.3 b/man3/iswgraph.3 index b64f3fff..7cf63540 100644 --- a/man3/iswgraph.3 +++ b/man3/iswgraph.3 @@ -29,7 +29,8 @@ belonging to the wide character class "graph". The wide character class "graph" is a subclass of the wide character class "print". .PP -Being a subclass of the wide character class "print", the wide character class +Being a subclass of the wide character class "print", +the wide character class "graph" is disjoint from the wide character class "cntrl". .PP The wide character class "graph" is disjoint from the wide character class @@ -39,10 +40,12 @@ The wide character class "graph" is disjoint from the wide character class .\" section 7.25.2.1.10) says that "space" and "graph" are disjoint. .PP The wide character class "graph" contains all the wide characters from the -wide character class "print" except the space character. It therefore contains +wide character class "print" except the space character. +It therefore contains the wide character classes "alnum" and "punct". .SH "RETURN VALUE" -The \fBiswgraph\fP() function returns non-zero if \fIwc\fP is a wide character +The \fBiswgraph\fP() function returns non-zero +if \fIwc\fP is a wide character belonging to the wide character class "graph". Otherwise it returns zero. .SH "CONFORMING TO" diff --git a/man3/login.3 b/man3/login.3 index eac7a64e..fd34fc34 100644 --- a/man3/login.3 +++ b/man3/login.3 @@ -98,7 +98,8 @@ of .I struct utmp is called .I ut_name -in BSD. Therefore, +in BSD. +Therefore, .I ut_name is defined as an alias for .I ut_user diff --git a/man3/memchr.3 b/man3/memchr.3 index 8c4017eb..604fd8ce 100644 --- a/man3/memchr.3 +++ b/man3/memchr.3 @@ -39,7 +39,8 @@ memchr, memrchr \- scan memory for a character The .BR memchr () function scans the first \fIn\fP bytes of the memory -area pointed to by \fIs\fP for the character \fIc\fP. The first byte to +area pointed to by \fIs\fP for the character \fIc\fP. +The first byte to match \fIc\fP (interpreted as an unsigned character) stops the operation. .PP The diff --git a/man3/memcmp.3 b/man3/memcmp.3 index aad84b7b..866e6de6 100644 --- a/man3/memcmp.3 +++ b/man3/memcmp.3 @@ -36,7 +36,8 @@ memcmp \- compare memory areas .fi .SH DESCRIPTION The \fBmemcmp\fP() function compares the first \fIn\fP bytes of the -memory areas \fIs1\fP and \fIs2\fP. It returns an integer less than, +memory areas \fIs1\fP and \fIs2\fP. +It returns an integer less than, equal to, or greater than zero if \fIs1\fP is found, respectively, to be less than, to match, or be greater than \fIs2\fP. .SH "RETURN VALUE" diff --git a/man3/memfrob.3 b/man3/memfrob.3 index 7c443790..ee3e9658 100644 --- a/man3/memfrob.3 +++ b/man3/memfrob.3 @@ -37,7 +37,8 @@ memfrob \- frobnicate (encrypt) a memory area .SH DESCRIPTION The \fBmemfrob\fP() function encrypts the first \fIn\fP bytes of the memory area \fIs\fP by exclusive-ORing each character with the number -42. The effect can be reversed by using \fBmemfrob\fP() on the +42. +The effect can be reversed by using \fBmemfrob\fP() on the encrypted memory area. .PP Note that this function is not a proper encryption routine as the XOR diff --git a/man3/memmove.3 b/man3/memmove.3 index 4c6f2a34..ca2c25b2 100644 --- a/man3/memmove.3 +++ b/man3/memmove.3 @@ -36,7 +36,8 @@ memmove \- copy memory area .fi .SH DESCRIPTION The \fBmemmove\fP() function copies \fIn\fP bytes from memory area -\fIsrc\fP to memory area \fIdest\fP. The memory areas may overlap. +\fIsrc\fP to memory area \fIdest\fP. +The memory areas may overlap. .SH "RETURN VALUE" The \fBmemmove\fP() function returns a pointer to \fIdest\fP. .SH "CONFORMING TO" diff --git a/man3/mkstemp.3 b/man3/mkstemp.3 index c69b1fbb..862a412f 100644 --- a/man3/mkstemp.3 +++ b/man3/mkstemp.3 @@ -39,7 +39,8 @@ mkstemp \- create a unique temporary file .fi .SH DESCRIPTION The \fBmkstemp\fP() function generates a unique temporary filename -from \fItemplate\fP. The last six characters of \fItemplate\fP must +from \fItemplate\fP. +The last six characters of \fItemplate\fP must be XXXXXX and these are replaced with a string that makes the filename unique. The file is then created with mode read/write and diff --git a/man3/mktemp.3 b/man3/mktemp.3 index 73063374..d93a4475 100644 --- a/man3/mktemp.3 +++ b/man3/mktemp.3 @@ -40,7 +40,8 @@ mktemp \- make a unique temporary filename .fi .SH DESCRIPTION The \fBmktemp\fP() function generates a unique temporary filename -from \fItemplate\fP. The last six characters of \fItemplate\fP must +from \fItemplate\fP. +The last six characters of \fItemplate\fP must be XXXXXX and these are replaced with a string that makes the filename unique. Since it will be modified, @@ -19,7 +19,8 @@ Compile with \-std=c99; link with \-lm. .SH DESCRIPTION These functions return a representation (determined by .IR tagp ) -of a quiet NaN. If the implementation does not support +of a quiet NaN. +If the implementation does not support quiet NaNs, these functions return zero. .LP The call @@ -43,7 +44,8 @@ On IEEE 754 systems, there are many representations of NaN, and selects one. On other systems it may do nothing. .SH "CONFORMING TO" -C99. See also IEC 559 and the appendix with +C99. +See also IEC 559 and the appendix with recommended functions in IEEE 754/IEEE 854. .SH "SEE ALSO" .BR isnan (3), diff --git a/man3/nextafter.3 b/man3/nextafter.3 index f284bfa1..28c65163 100644 --- a/man3/nextafter.3 +++ b/man3/nextafter.3 @@ -47,7 +47,8 @@ functions, except that they have a long double second argument. These functions will signal overflow or underflow if the result goes outside of the range of normalized numbers. .SH "CONFORMING TO" -C99. This function is defined in IEC 559 (and the appendix with +C99. +This function is defined in IEC 559 (and the appendix with recommended functions in IEEE 754/IEEE 854). .SH "SEE ALSO" .BR nearbyint (3) diff --git a/man3/psignal.3 b/man3/psignal.3 index 67ab4207..982ae0b6 100644 --- a/man3/psignal.3 +++ b/man3/psignal.3 @@ -39,7 +39,8 @@ psignal \- print signal message .SH DESCRIPTION The \fBpsignal\fP() function displays a message on \fIstderr\fP consisting of the string \fIs\fP, a colon, a space, and a string -describing the signal number \fIsig\fP. If \fIsig\fP is invalid, +describing the signal number \fIsig\fP. +If \fIsig\fP is invalid, the message displayed will indicate an unknown signal. .PP The array \fIsys_siglist\fP holds the signal description strings diff --git a/man3/readdir.3 b/man3/readdir.3 index 9addb31a..5e52f1d9 100644 --- a/man3/readdir.3 +++ b/man3/readdir.3 @@ -42,7 +42,8 @@ readdir \- read a directory .SH DESCRIPTION The \fBreaddir\fP() function returns a pointer to a \fIdirent\fP structure representing the next directory entry in the directory stream pointed -to by \fIdir\fP. It returns NULL on reaching the end-of-file or if +to by \fIdir\fP. +It returns NULL on reaching the end-of-file or if an error occurred. .PP On Linux, the diff --git a/man3/remainder.3 b/man3/remainder.3 index 2de66fca..a0bf7313 100644 --- a/man3/remainder.3 +++ b/man3/remainder.3 @@ -96,7 +96,8 @@ and are from C99. The function .BR drem () -is from 4.3BSD. The +is from 4.3BSD. +The .I float and .I "long double" diff --git a/man3/stpcpy.3 b/man3/stpcpy.3 index fefd0797..51cfedbf 100644 --- a/man3/stpcpy.3 +++ b/man3/stpcpy.3 @@ -36,7 +36,8 @@ stpcpy \- copy a string returning a pointer to its end .SH DESCRIPTION The \fBstpcpy\fP() function copies the string pointed to by \fIsrc\fP (including the terminating `\\0' character) to the array pointed to by -\fIdest\fP. The strings may not overlap, and the destination string +\fIdest\fP. +The strings may not overlap, and the destination string \fIdest\fP must be large enough to receive the copy. .SH "RETURN VALUE" \fBstpcpy\fP() returns a pointer to the \fBend\fP of the string diff --git a/man3/strcmp.3 b/man3/strcmp.3 index 7fe2bfa9..6ddabb45 100644 --- a/man3/strcmp.3 +++ b/man3/strcmp.3 @@ -40,7 +40,8 @@ strcmp, strncmp \- compare two strings .fi .SH DESCRIPTION The \fBstrcmp\fP() function compares the two strings \fIs1\fP and -\fIs2\fP. It returns an integer less than, equal to, or greater +\fIs2\fP. +It returns an integer less than, equal to, or greater than zero if \fIs1\fP is found, respectively, to be less than, to match, or be greater than \fIs2\fP. .PP diff --git a/man3/strcoll.3 b/man3/strcoll.3 index ded1c4ea..c0f976cb 100644 --- a/man3/strcoll.3 +++ b/man3/strcoll.3 @@ -36,9 +36,11 @@ strcoll \- compare two strings using the current locale .fi .SH DESCRIPTION The \fBstrcoll\fP() function compares the two strings \fIs1\fP and -\fIs2\fP. It returns an integer less than, equal to, or greater +\fIs2\fP. +It returns an integer less than, equal to, or greater than zero if \fIs1\fP is found, respectively, to be less than, -to match, or be greater than \fIs2\fP. The comparison is based on +to match, or be greater than \fIs2\fP. +The comparison is based on strings interpreted as appropriate for the program's current locale for category \fILC_COLLATE\fP. (See \fBsetlocale\fP(3)). .SH "RETURN VALUE" diff --git a/man3/strcpy.3 b/man3/strcpy.3 index 7534c9c9..6429afaf 100644 --- a/man3/strcpy.3 +++ b/man3/strcpy.3 @@ -42,7 +42,8 @@ strcpy, strncpy \- copy a string .SH DESCRIPTION The \fBstrcpy\fP() function copies the string pointed to by \fIsrc\fP (including the terminating `\\0' character) to the array pointed to by -\fIdest\fP. The strings may not overlap, and the destination string +\fIdest\fP. +The strings may not overlap, and the destination string \fIdest\fP must be large enough to receive the copy. .PP The \fBstrncpy\fP() function is similar, except that not more than diff --git a/man3/strdup.3 b/man3/strdup.3 index c2635793..e232cd51 100644 --- a/man3/strdup.3 +++ b/man3/strdup.3 @@ -47,7 +47,8 @@ strdup, strndup, strdupa, strndupa \- duplicate a string .fi .SH DESCRIPTION The \fBstrdup\fP() function returns a pointer to a new string which -is a duplicate of the string \fIs\fP. Memory for the new string is +is a duplicate of the string \fIs\fP. +Memory for the new string is obtained with \fBmalloc\fP(3), and can be freed with \fBfree\fP(3). The \fBstrndup\fP() function is similar, but only copies at most diff --git a/man3/strnlen.3 b/man3/strnlen.3 index 9e106b28..28d458d7 100644 --- a/man3/strnlen.3 +++ b/man3/strnlen.3 @@ -22,7 +22,8 @@ strnlen \- determine the length of a fixed-size string .SH DESCRIPTION The \fBstrnlen\fP() function returns the number of characters in the string pointed to by \fIs\fP, not including the terminating '\\0' character, but -at most \fImaxlen\fP. In doing this, \fBstrnlen\fP() looks only at the first +at most \fImaxlen\fP. +In doing this, \fBstrnlen\fP() looks only at the first \fImaxlen\fP characters at \fIs\fP and never beyond \fIs+maxlen\fP. .SH "RETURN VALUE" The \fBstrnlen\fP() function returns \fIstrlen(s)\fP, if that is less than diff --git a/man3/strstr.3 b/man3/strstr.3 index 122b5d4e..87255199 100644 --- a/man3/strstr.3 +++ b/man3/strstr.3 @@ -45,8 +45,8 @@ strstr \- locate a substring .fi .SH DESCRIPTION The \fBstrstr\fP() function finds the first occurrence of the substring -\fIneedle\fP in the string \fIhaystack\fP. The terminating \`\\0' -characters are not compared. +\fIneedle\fP in the string \fIhaystack\fP. +The terminating \`\\0' characters are not compared. The \fBstrcasestr\fP() function is like \fBstrstr\fP(), but ignores the case of both arguments. diff --git a/man3/system.3 b/man3/system.3 index 87deca38..c762e3b5 100644 --- a/man3/system.3 +++ b/man3/system.3 @@ -87,7 +87,8 @@ etc.) are made available when including .PP As mentioned, .BR system () -ignores SIGINT and SIGQUIT. This may make programs that call it +ignores SIGINT and SIGQUIT. +This may make programs that call it from a loop uninterruptible, unless they take care themselves to check the exit status of the child. E.g. diff --git a/man3/tcgetpgrp.3 b/man3/tcgetpgrp.3 index fa3cc058..2407f4d5 100644 --- a/man3/tcgetpgrp.3 +++ b/man3/tcgetpgrp.3 @@ -102,7 +102,8 @@ process in the same session as the calling process. These functions are implemented via the TIOCGPGRP and TIOCSPGRP ioctls. .SH HISTORY -These ioctls appeared in 4.2BSD. The functions are POSIX inventions. +These ioctls appeared in 4.2BSD. +The functions are POSIX inventions. .SH "CONFORMING TO" POSIX.1-2001. .SH "SEE ALSO" diff --git a/man3/towctrans.3 b/man3/towctrans.3 index 09967c9a..0ac12a51 100644 --- a/man3/towctrans.3 +++ b/man3/towctrans.3 @@ -21,15 +21,15 @@ towctrans \- wide-character transliteration .BI "wint_t towctrans(wint_t " wc ", wctrans_t " desc ); .fi .SH DESCRIPTION -If \fIwc\fP is a wide character, the \fBtowctrans\fP() function translates it -according to the transliteration descriptor \fIdesc\fP. If \fIwc\fP is WEOF, -WEOF is returned. +If \fIwc\fP is a wide character, the \fBtowctrans\fP() function +translates it according to the transliteration descriptor \fIdesc\fP. +If \fIwc\fP is WEOF, WEOF is returned. .PP -\fIdesc\fP must be a transliteration descriptor returned by the \fBwctrans\fP() -function. +\fIdesc\fP must be a transliteration descriptor returned by +the \fBwctrans\fP() function. .SH "RETURN VALUE" -The \fBtowctrans\fP() function returns the translated wide character, or WEOF if -\fIwc\fP is WEOF. +The \fBtowctrans\fP() function returns the translated wide character, +or WEOF if \fIwc\fP is WEOF. .SH "CONFORMING TO" C99. .SH "SEE ALSO" diff --git a/man3/wcstok.3 b/man3/wcstok.3 index d8990c40..353e4f95 100644 --- a/man3/wcstok.3 +++ b/man3/wcstok.3 @@ -28,12 +28,13 @@ It can be used to split a wide-character string \fIwcs\fP into tokens, where a token is defined as a substring not containing any wide-characters from \fIdelim\fP. .PP -The search starts at \fIwcs\fP, if \fIwcs\fP is not NULL, or at \fI*ptr\fP, if -\fIwcs\fP is NULL. First, any delimiter wide-characters are skipped, i.e. the +The search starts at \fIwcs\fP, if \fIwcs\fP is not NULL, +or at \fI*ptr\fP, if \fIwcs\fP is NULL. +First, any delimiter wide-characters are skipped, i.e. the pointer is advanced beyond any wide-characters which occur in \fIdelim\fP. -If the end of the wide-character string is now reached, \fBwcstok\fP() returns -NULL, to indicate that no tokens were found, and stores an appropriate value -in \fI*ptr\fP, +If the end of the wide-character string is now +reached, \fBwcstok\fP() returns NULL, to indicate that no tokens +were found, and stores an appropriate value in \fI*ptr\fP, so that subsequent calls to \fBwcstok\fP() will continue to return NULL. Otherwise, the \fBwcstok\fP() function recognizes the beginning of a token and returns a pointer to it, but before doing that, it zero-terminates the @@ -41,8 +42,8 @@ token by replacing the next wide-character which occurs in \fIdelim\fP with a L'\\0' character, and it updates \fI*ptr\fP so that subsequent calls will continue searching after the end of recognized token. .SH "RETURN VALUE" -The \fBwcstok\fP() function returns a pointer to the next token, or NULL if no -further token was found. +The \fBwcstok\fP() function returns a pointer to the next token, +or NULL if no further token was found. .SH NOTES The original \fIwcs\fP wide-character string is destructively modified during the operation. diff --git a/man3/wcwidth.3 b/man3/wcwidth.3 index 5059f5ba..08ebbca8 100644 --- a/man3/wcwidth.3 +++ b/man3/wcwidth.3 @@ -21,11 +21,14 @@ wcwidth \- determine columns needed for a wide character .BI "int wcwidth(wchar_t " c ); .fi .SH DESCRIPTION -The \fBwcwidth\fP() function returns the number of columns needed to represent -the wide character \fIc\fP. If \fIc\fP is a printable wide character, the value -is at least 0. If \fIc\fP is L'\\0', the value is 0. Otherwise \-1 is returned. +The \fBwcwidth\fP() function returns the number of columns +needed to represent the wide character \fIc\fP. +If \fIc\fP is a printable wide character, the value +is at least 0. +If \fIc\fP is L'\\0', the value is 0. Otherwise \-1 is returned. .SH "RETURN VALUE" -The \fBwcwidth\fP() function returns the number of column positions for \fIc\fP. +The \fBwcwidth\fP() function returns the number of +column positions for \fIc\fP. .SH "CONFORMING TO" POSIX.1-2001. @@ -41,9 +41,11 @@ then SIGHUP and SIGCONT signals are sent to the foreground process group and all processes in the current session lose their controlling tty. .sp This \fBioctl\fP() call only works on file descriptors connected -to \fI/dev/tty\fP. It is used by daemon processes when they are invoked +to \fI/dev/tty\fP. +It is used by daemon processes when they are invoked by a user at a terminal. -The process attempts to open \fI/dev/tty\fP. If the open succeeds, it +The process attempts to open \fI/dev/tty\fP. +If the open succeeds, it detaches itself from the terminal by using \fBTIOCNOTTY\fP, while if the open fails, it is obviously not attached to a terminal and does not need to detach itself. @@ -59,7 +59,8 @@ No requests are supported. .SH EXAMPLE You may do a screendump on vt3 by switching to vt1 and typing -\fIcat /dev/vcs3 >foo\fP. Note that the output does not contain +\fIcat /dev/vcs3 >foo\fP. +Note that the output does not contain newline characters, so some processing may be required, like in \fIfold \-w 81 /dev/vcs3 | lpr\fP or (horrors) \fIsetterm \-dump 3 \-file /proc/self/fd/1\fP. diff --git a/man5/utmp.5 b/man5/utmp.5 index e9db6ea2..09bcf75d 100644 --- a/man5/utmp.5 +++ b/man5/utmp.5 @@ -263,7 +263,8 @@ must always exist on Linux. If you want to disable \fIwho\fP(1) then do not make utmp world readable. .PP -Note that the utmp struct from libc5 has changed in libc6. Because of this, +Note that the utmp struct from libc5 has changed in libc6. +Because of this, binaries using the old libc5 struct will corrupt .IR /var/run/utmp " and/or " /var/log/wtmp . Debian systems include a patched libc5 which uses the new utmp format. diff --git a/man7/epoll.7 b/man7/epoll.7 index e37bc24f..a84eee61 100644 --- a/man7/epoll.7 +++ b/man7/epoll.7 @@ -244,8 +244,8 @@ This is a harmless condition. .B Q2 Can two .B epoll -sets wait for the same fd? If so, are events reported -to both +sets wait for the same fd? +If so, are events reported to both .B epoll sets fds? .TP |