diff options
Diffstat (limited to 'man3')
223 files changed, 1100 insertions, 1100 deletions
diff --git a/man3/abort.3 b/man3/abort.3 index a6a47fd2..a02d712f 100644 --- a/man3/abort.3 +++ b/man3/abort.3 @@ -37,15 +37,15 @@ abort \- cause abnormal program termination .B void abort(void); .fi .SH DESCRIPTION -The \fBabort()\fP function causes abnormal program termination unless +The \fBabort\fP() function causes abnormal program termination unless the signal SIGABRT is caught and the signal handler does not return. -If the \fBabort()\fP function causes program termination, all open +If the \fBabort\fP() function causes program termination, all open streams are closed and flushed. .PP -If the SIGABRT signal is blocked or ignored, the \fBabort()\fP +If the SIGABRT signal is blocked or ignored, the \fBabort\fP() function will still override it. .SH "RETURN VALUE" -The \fBabort()\fP function never returns. +The \fBabort\fP() function never returns. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899 (C99) .SH "SEE ALSO" @@ -47,8 +47,8 @@ abs, labs, llabs, imaxabs \- compute the absolute value of an integer .BI "intmax_t imaxabs(intmax_t " j ); .fi .SH DESCRIPTION -The \fBabs()\fP function computes the absolute value of the integer -argument \fIj\fP. The \fBlabs()\fP, \fBllabs()\fP and \fBimaxabs()\fP +The \fBabs\fP() function computes the absolute value of the integer +argument \fIj\fP. The \fBlabs\fP(), \fBllabs\fP() and \fBimaxabs\fP() functions compute the absolute value of the argument \fIj\fP of the appropriate integer type for the function. .SH "RETURN VALUE" @@ -56,23 +56,23 @@ Returns the absolute value of the integer argument, of the appropriate integer type for the function. .SH "CONFORMING TO" SVID 3, POSIX.1, 4.3BSD, ISO/IEC 9899 (C99). POSIX.1 (1996 edition) only -requires the \fBabs()\fP function. ISO/IEC 9899:1990 (C89) only -includes the \fBabs()\fP and \fBlabs()\fP functions; the functions -\fBllabs()\fP and \fBimaxabs()\fP were added in C99. +requires the \fBabs\fP() function. ISO/IEC 9899:1990 (C89) only +includes the \fBabs\fP() and \fBlabs\fP() functions; the functions +\fBllabs\fP() and \fBimaxabs\fP() were added in C99. .SH NOTES Trying to take the absolute value of the most negative integer is not defined. .PP -The \fBllabs()\fP function is included in glibc since version 2.0, but -is not in libc5 or libc4. The \fBimaxabs()\fP function is included in +The \fBllabs\fP() function is included in glibc since version 2.0, but +is not in libc5 or libc4. The \fBimaxabs\fP() function is included in glibc since version 2.1.1. .PP -For \fBllabs()\fP to be declared, it may be necessary to define +For \fBllabs\fP() to be declared, it may be necessary to define \fB_ISOC99_SOURCE\fP or \fB_ISOC9X_SOURCE\fP (depending on the version of glibc) before including any standard headers. .PP -GCC handles \fBabs()\fP and \fBlabs()\fP as builtin functions. GCC -3.0 also handles \fBllabs()\fP and \fBimaxabs()\fP as builtins. +GCC handles \fBabs\fP() and \fBlabs\fP() as builtin functions. GCC +3.0 also handles \fBllabs\fP() and \fBimaxabs\fP() as builtins. .SH "SEE ALSO" .BR cabs (3), .BR ceil (3), diff --git a/man3/acos.3 b/man3/acos.3 index d2f23bcd..aea1f172 100644 --- a/man3/acos.3 +++ b/man3/acos.3 @@ -42,11 +42,11 @@ acos, acosf, acosl \- arc cosine function .sp Link with \-lm. .SH DESCRIPTION -The \fBacos()\fP function calculates the arc cosine of \fIx\fP; that is +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 -\-1 to 1, \fBacos()\fP fails and \fIerrno\fP is set. +\-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 +The \fBacos\fP() function returns the arc cosine in radians and the value is mathematically defined to be between 0 and PI (inclusive). .SH ERRORS .TP diff --git a/man3/acosh.3 b/man3/acosh.3 index fa41c844..fc17e5e9 100644 --- a/man3/acosh.3 +++ b/man3/acosh.3 @@ -44,9 +44,9 @@ acosh, acoshf, acoshl \- inverse hyperbolic cosine function .fi Link with \-lm. .SH DESCRIPTION -The \fBacosh()\fP function calculates the inverse hyperbolic cosine of +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 less than 1.0, \fBacosh\fP() returns not-a-number (NaN) and \fIerrno\fP is set. .SH ERRORS .TP diff --git a/man3/argz_add.3 b/man3/argz_add.3 index cd94c7b6..c5ea7a22 100644 --- a/man3/argz_add.3 +++ b/man3/argz_add.3 @@ -78,7 +78,7 @@ so that .BR free (3) can be used to dispose of them again. .LP -.B argz_add() +.BR argz_add () adds the string .I str at the end of the array @@ -88,7 +88,7 @@ and updates and .RI * argz_len . .LP -.B argz_add_sep() +.BR argz_add_sep () is similar, but splits the string .I str into substrings separated by the delimiter @@ -96,7 +96,7 @@ into substrings separated by the delimiter For example, one might use this on a Unix search path with delimiter ':'. .LP -.B argz_append() +.BR argz_append () appends the argz vector .RI ( buf , buf_len ) after @@ -110,17 +110,17 @@ and will be increased by .IR buf_len .) .LP -.B argz_count() +.BR argz_count () counts the number of strings, that is, the number of NUL bytes, in .RI ( argz , argz_len ). .LP -.B argz_create() +.BR argz_create () converts a Unix-style argument vector .IR argv , terminated by (char *) 0, into an argz vector .RI (* argz ,* argz_len ). .LP -.B argz_create_sep() +.BR argz_create_sep () converts the NUL-terminated string .I str into an argz vector @@ -128,7 +128,7 @@ into an argz vector by breaking it up at every occurrence of the separator .IR sep . .LP -.B argz_delete() +.BR argz_delete () removes the substring pointed to by .I entry from the argz vector @@ -138,9 +138,9 @@ and updates and .RI * argz_len . .LP -.B argz_extract() +.BR argz_extract () is the opposite of -.BR argz_create() . +.BR argz_create (). It takes the argz vector .RI ( argz , argz_len ) and fills the array starting at @@ -153,9 +153,9 @@ must have room for .IR argz_count ( argz , argz_len ") + 1" pointers. .LP -.B argz_insert() +.BR argz_insert () is the opposite of -.BR argz_delete() . +.BR argz_delete (). It inserts the argument .I entry at position @@ -172,13 +172,13 @@ is NULL, then .I entry will inserted at the end. .LP -.B argz_next() +.BR argz_next () is a function to step trough the argz vector. If .I entry is NULL, the first entry is returned. Otherwise, the entry following is returned. It returns NULL if there is no following entry. .LP -.B argz_replace() +.BR argz_replace () replaces each occurrence of .I str with @@ -189,9 +189,9 @@ is non-NULL, .RI * replace_count will be incremented by the number of replacements. .LP -.B argz_stringify() +.BR argz_stringify () is the opposite of -.BR argz_create_sep() . +.BR argz_create_sep (). It transforms the argz vector into a normal string by replacing all NULs except the last by .IR sep . diff --git a/man3/asin.3 b/man3/asin.3 index f9572a9e..fdcad22e 100644 --- a/man3/asin.3 +++ b/man3/asin.3 @@ -44,11 +44,11 @@ asin, asinf, asinl \- arc sine function .sp Link with \-lm. .SH DESCRIPTION -The \fBasin()\fP function calculates the arc sine of \fIx\fP; that is +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 -\-1 to 1, \fBasin()\fP fails and \fIerrno\fP is set. +\-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 +The \fBasin\fP() function returns the arc sine in radians and the value is mathematically defined to be between \-PI/2 and PI/2 (inclusive). .SH ERRORS diff --git a/man3/asinh.3 b/man3/asinh.3 index 3bc9a719..0aa54e8f 100644 --- a/man3/asinh.3 +++ b/man3/asinh.3 @@ -44,7 +44,7 @@ asinh, asinhf, asinhl \- inverse hyperbolic sine function .sp Link with \-lm. .SH DESCRIPTION -The \fBasinh()\fP function calculates the inverse hyperbolic sine of +The \fBasinh\fP() function calculates the inverse hyperbolic sine of \fIx\fP; that is the value whose hyperbolic sine is \fIx\fP. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899. diff --git a/man3/assert.3 b/man3/assert.3 index 1fd6287e..9f3c2f4d 100644 --- a/man3/assert.3 +++ b/man3/assert.3 @@ -37,13 +37,13 @@ If the macro was defined at the moment .B <assert.h> was last included, the macro -.B assert() +.BR assert () generates no code, and hence does nothing at all. Otherwise, the macro -.B assert() +.BR assert () prints an error message to standard error and terminates the program by calling -.B abort() +.BR abort () if .I expression is false (i.e., compares equal to zero). @@ -62,7 +62,7 @@ and undefined behavior results if it is not, but in the 1999 standard it may have any scalar type. .\" See Defect Report 107 for more details. .SH BUGS -.B assert() +.BR assert () is implemented as a macro; if the expression tested has side-effects, program behaviour will be different depending on whether .B NDEBUG diff --git a/man3/assert_perror.3 b/man3/assert_perror.3 index de9a795e..7d3abeee 100644 --- a/man3/assert_perror.3 +++ b/man3/assert_perror.3 @@ -38,13 +38,13 @@ If the macro was defined at the moment .B <assert.h> was last included, the macro -.B assert_perror() +.BR assert_perror () generates no code, and hence does nothing at all. Otherwise, the macro -.B assert_perror() +.BR assert_perror () prints an error message to standard output and terminates the program by calling -.B abort() +.BR abort () if .I errnum is non-zero. The message contains the filename, function name and diff --git a/man3/atan.3 b/man3/atan.3 index 27c0b853..cd1e73d4 100644 --- a/man3/atan.3 +++ b/man3/atan.3 @@ -44,10 +44,10 @@ atan, atanf, atanl \- arc tangent function .fi Link with \-lm. .SH DESCRIPTION -The \fBatan()\fP function calculates the arc tangent of \fIx\fP; that is +The \fBatan\fP() function calculates the arc tangent of \fIx\fP; that is the value whose tangent is \fIx\fP. .SH "RETURN VALUE" -The \fBatan()\fP function returns the arc tangent in radians and the +The \fBatan\fP() function returns the arc tangent in radians and the value is mathematically defined to be between \-PI/2 and PI/2 (inclusive). .SH "CONFORMING TO" diff --git a/man3/atan2.3 b/man3/atan2.3 index d8f0725d..53a37a5c 100644 --- a/man3/atan2.3 +++ b/man3/atan2.3 @@ -44,12 +44,12 @@ atan2, atan2f, atan2l \- arc tangent function of two variables .fi Link with \-lm. .SH DESCRIPTION -The \fBatan2()\fP function calculates the arc tangent of the two +The \fBatan2\fP() function calculates the arc tangent of the two 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" -The \fBatan2()\fP function returns the result in radians, which +The \fBatan2\fP() function returns the result in radians, which is between \-PI and PI (inclusive). .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899. diff --git a/man3/atanh.3 b/man3/atanh.3 index 63445eb8..d556fca2 100644 --- a/man3/atanh.3 +++ b/man3/atanh.3 @@ -44,9 +44,9 @@ atanh, atanhf, atanhl \- inverse hyperbolic tangent function .fi Link with \-lm. .SH DESCRIPTION -The \fBatanh()\fP function calculates the inverse hyperbolic tangent of +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 +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/atof.3 b/man3/atof.3 index d43b7640..76ec1fb3 100644 --- a/man3/atof.3 +++ b/man3/atof.3 @@ -36,14 +36,14 @@ atof \- convert a string to a double .BI "double atof(const char *" nptr ); .fi .SH DESCRIPTION -The \fBatof()\fP function converts the initial portion of the string +The \fBatof\fP() function converts the initial portion of the string pointed to by \fInptr\fP to double. The behaviour is the same as .sp .RS .B strtod(nptr, (char **)NULL); .RE .sp -except that \fBatof()\fP does not detect errors. +except that \fBatof\fP() does not detect errors. .SH "RETURN VALUE" The converted value. .SH "CONFORMING TO" diff --git a/man3/atoi.3 b/man3/atoi.3 index 870a029b..596313de 100644 --- a/man3/atoi.3 +++ b/man3/atoi.3 @@ -44,7 +44,7 @@ atoi, atol, atoll, atoq \- convert a string to an integer .BI "long long atoq(const char *" nptr ); .fi .SH DESCRIPTION -The \fBatoi()\fP function converts the initial portion of the string +The \fBatoi\fP() function converts the initial portion of the string pointed to by \fInptr\fP to .IR int . The behaviour is the same as @@ -53,23 +53,23 @@ The behaviour is the same as .B strtol(nptr, (char **)NULL, 10); .RE .sp -except that \fBatoi()\fP does not detect errors. +except that \fBatoi\fP() does not detect errors. .PP -The \fBatol()\fP and \fBatoll()\fP functions behave the same as -\fBatoi()\fR, except that they convert the initial portion of the +The \fBatol\fP() and \fBatoll\fP() functions behave the same as +\fBatoi\fR(), except that they convert the initial portion of the string to their return type of \fIlong\fP or \fIlong long\fP. -\fBatoq()\fP is an obsolete name for \fBatoll()\fP. +\fBatoq\fP() is an obsolete name for \fBatoll\fP(). .SH "RETURN VALUE" The converted value. .SH "CONFORMING TO" SVID 3, POSIX.1, 4.3BSD, ISO/IEC 9899. ISO/IEC 9899:1990 (C89) and -POSIX.1 (1996 edition) include the functions \fBatoi()\fP and -\fBatol()\fP only; C99 adds the function \fBatoll()\fP. +POSIX.1 (1996 edition) include the functions \fBatoi\fP() and +\fBatol\fP() only; C99 adds the function \fBatoll\fP(). .SH NOTES -The non-standard \fBatoq()\fP function is not present in libc 4.6.27 +The non-standard \fBatoq\fP() function is not present in libc 4.6.27 or glibc 2, but is present in libc5 and libc 4.7 (though only as an inline function in \fB<stdlib.h>\fP until libc 5.4.44). The -\fBatoll()\fP function is present in glibc 2 since version 2.0.2, but +\fBatoll\fP() function is present in glibc 2 since version 2.0.2, but not in libc4 or libc5. .SH "SEE ALSO" .BR atof (3), diff --git a/man3/bcmp.3 b/man3/bcmp.3 index d581be13..25e639c9 100644 --- a/man3/bcmp.3 +++ b/man3/bcmp.3 @@ -37,7 +37,7 @@ bcmp \- compare byte sequences .fi .SH DESCRIPTION The -.B bcmp() +.BR bcmp () function compares the two byte sequences .I s1 and @@ -47,11 +47,11 @@ of length each. If they are equal, and in particular if .I n is zero, -.B bcmp() +.BR bcmp () returns 0. Otherwise it returns a non-zero result. .SH "RETURN VALUE" The -.B bcmp() +.BR bcmp () function returns 0 if the byte sequences are equal, otherwise a non-zero result is returned. .SH "CONFORMING TO" diff --git a/man3/bcopy.3 b/man3/bcopy.3 index 730bc816..5e7fe541 100644 --- a/man3/bcopy.3 +++ b/man3/bcopy.3 @@ -39,7 +39,7 @@ bcopy \- copy byte sequence .fi .SH DESCRIPTION The -.B bcopy() +.BR bcopy () function copies .I n bytes from diff --git a/man3/bindresvport.3 b/man3/bindresvport.3 index 4de6c16a..009f2553 100644 --- a/man3/bindresvport.3 +++ b/man3/bindresvport.3 @@ -13,7 +13,7 @@ bindresvport \- bind a socket to a privileged IP port .fi .SH DESCRIPTION .LP -.B bindresvport() +.BR bindresvport () is used to bind a socket descriptor to a privileged .SM IP port, that is, a diff --git a/man3/bsearch.3 b/man3/bsearch.3 index 61a028a3..9b7b9766 100644 --- a/man3/bsearch.3 +++ b/man3/bsearch.3 @@ -39,7 +39,7 @@ bsearch \- binary search of a sorted array .RE .fi .SH DESCRIPTION -The \fBbsearch()\fP function searches an array of \fInmemb\fP objects, +The \fBbsearch\fP() function searches an array of \fInmemb\fP objects, the initial member of which is pointed to by \fIbase\fP, for a member that matches the object pointed to by \fIkey\fP. The size of each member of the array is specified by \fIsize\fP. @@ -52,14 +52,14 @@ less than, equal to, or greater than zero if the \fIkey\fP object is found, respectively, to be less than, to match, or be greater than the array member. .SH "RETURN VALUE" -The \fBbsearch()\fP function returns a pointer to a matching member of the +The \fBbsearch\fP() function returns a pointer to a matching member of the array, or NULL if no match is found. If there are multiple elements that match the key, the element returned is unspecified. .SH EXAMPLE The example below first sorts an array of structures using .BR qsort (3), then retrieves desired elements using -.BR bsearch() . +.BR bsearch (). .sp .nf #include <stdio.h> diff --git a/man3/byteorder.3 b/man3/byteorder.3 index 6d0df8fd..ac821306 100644 --- a/man3/byteorder.3 +++ b/man3/byteorder.3 @@ -44,16 +44,16 @@ byte order .BI "uint16_t ntohs(uint16_t " netshort ); .fi .SH DESCRIPTION -The \fBhtonl()\fP function converts the unsigned integer \fIhostlong\fP +The \fBhtonl\fP() function converts the unsigned integer \fIhostlong\fP from host byte order to network byte order. .PP -The \fBhtons()\fP function converts the unsigned short integer \fIhostshort\fP +The \fBhtons\fP() function converts the unsigned short integer \fIhostshort\fP from host byte order to network byte order. .PP -The \fBntohl()\fP function converts the unsigned integer \fInetlong\fP +The \fBntohl\fP() function converts the unsigned integer \fInetlong\fP from network byte order to host byte order. .PP -The \fBntohs()\fP function converts the unsigned short integer \fInetshort\fP +The \fBntohs\fP() function converts the unsigned short integer \fInetshort\fP from network byte order to host byte order. .PP On the i80x86 the host byte order is Least Significant Byte first, diff --git a/man3/bzero.3 b/man3/bzero.3 index 098623de..8054d529 100644 --- a/man3/bzero.3 +++ b/man3/bzero.3 @@ -37,7 +37,7 @@ bzero \- write zero bytes .fi .SH DESCRIPTION The -.B bzero() +.BR bzero () function sets the first .I n bytes of the byte area starting at diff --git a/man3/catgets.3 b/man3/catgets.3 index b4d0052c..caa28878 100644 --- a/man3/catgets.3 +++ b/man3/catgets.3 @@ -35,7 +35,7 @@ catgets \- get message from a message catalog .BI "char *catgets(nl_catd " catalog ", int " set_number , .BI "int " message_number ", const char *" message ); .SH DESCRIPTION -.B catgets() +.BR catgets () reads the message .IR message_number , in set @@ -49,7 +49,7 @@ is a catalog descriptor returned from an earlier call to The fourth argument .I message points to a default message string which will be returned by -.B catgets() +.BR catgets () if the identified message catalog is not currently available. The message-text is contained in an internal buffer area and should be copied by the application if it is to be saved or modified. The return string is @@ -57,11 +57,11 @@ always terminated with a null byte. .SH "RETURN VALUE" .LP On success, -.B catgets() +.BR catgets () returns a pointer to an internal buffer area containing the null-terminated message string. On failure, -.B catgets() +.BR catgets () returns the value .IR message . .SH NOTES diff --git a/man3/catopen.3 b/man3/catopen.3 index 543db237..c822a14e 100644 --- a/man3/catopen.3 +++ b/man3/catopen.3 @@ -34,7 +34,7 @@ catopen, catclose \- open/close a message catalog .BI "int catclose(nl_catd " catalog ); .SH DESCRIPTION The function -.B catopen() +.BR catopen () opens a message catalog and returns a catalog descriptor. The descriptor remains valid until catclose() or exec(). If a file descriptor is used to implement catalog descriptors @@ -83,7 +83,7 @@ open catalog descriptors. The .I flag argument to -.B catopen() +.BR catopen () is used to indicate the source for the language to use. If it is set to .B NL_CAT_LOCALE @@ -94,7 +94,7 @@ Otherwise it will use the environment variable. .LP The function -.B catclose() +.BR catclose () closes the message catalog identified by .IR catalog . It invalidates any subsequent references to the message catalog @@ -103,7 +103,7 @@ defined by .LP .SH "RETURN VALUE" The function -.B catopen() +.BR catopen () returns a message catalog descriptor of type .I nl_catd on success. @@ -112,11 +112,11 @@ and sets .I errno to indicate the error. The possible error values include all possible values for the -.I open() +.IR open () call. .LP The function -.B catclose() +.BR catclose () returns 0 on success, or \-1 on failure. .SH ENVIRONMENT .TP @@ -145,7 +145,7 @@ is a mmap()'ed area of memory and not a file descriptor. The .I flag argument to -.B catopen() +.BR catopen () should be either .B MCLoadBySet (=0) or diff --git a/man3/cbrt.3 b/man3/cbrt.3 index 9b2f70dd..64676946 100644 --- a/man3/cbrt.3 +++ b/man3/cbrt.3 @@ -41,11 +41,11 @@ cbrt, cbrtf, cbrtl \- cube root function .sp Link with \-lm. .SH DESCRIPTION -The \fBcbrt()\fP function returns the (real) cube root of \fIx\fP. +The \fBcbrt\fP() function returns the (real) cube root of \fIx\fP. This function cannot fail; every representable real value has a representable real cube root. .SH "CONFORMING TO" -.B cbrt() +.BR cbrt () was a GNU extension. It is now a C99 requirement. .SH "SEE ALSO" .BR pow (3), diff --git a/man3/ceil.3 b/man3/ceil.3 index 1f29f727..190b7ed0 100644 --- a/man3/ceil.3 +++ b/man3/ceil.3 @@ -58,7 +58,7 @@ the maximum value of the exponent is 128 (resp. 1024), and the number of mantissa bits is 24 (resp. 53).) .SH "CONFORMING TO" The -.B ceil() +.BR ceil () function conforms to SVID 3, POSIX, 4.3BSD, ISO 9899. The other functions are from C99. .SH "SEE ALSO" diff --git a/man3/cfree.3 b/man3/cfree.3 index 5d43a921..4fc2b0d2 100644 --- a/man3/cfree.3 +++ b/man3/cfree.3 @@ -46,7 +46,7 @@ This function should never be used. Use instead. .SS "1-arg cfree" In glibc, the function -.B cfree() +.BR cfree () is a synonym for .BR free (3), "added for compatibility with SunOS". @@ -59,7 +59,7 @@ and sometimes in .LP .SS "3-arg cfree" Some SCO and Solaris versions have malloc libraries with a 3-argument -.BR cfree() , +.BR cfree (), apparently as an analog to .BR calloc (3). .LP @@ -72,22 +72,22 @@ If you need it while porting something, add to your file. .LP A frequently asked question is "Can I use -.B free() +.BR free () to free memory allocated with -.BR calloc() , +.BR calloc (), or do I need .BR cfree() ?" Answer: use -.BR free() . +.BR free (). .LP An SCO manual writes: "The cfree routine is provided for compliance to the iBCSe2 standard and simply calls free. The num and size arguments to cfree are not used." .SH "RETURN VALUE" The SunOS version of -.B cfree() +.BR cfree () (which is a synonym for -.BR free() ) +.BR free ()) returns 1 on success and 0 on failure. In case of error, .I errno @@ -97,6 +97,6 @@ was not a pointer to a block previously allocated by one of the routines in the malloc() family. .SH "CONFORMING TO" The 3-argument version of -.B cfree() +.BR cfree () as used by SCO conforms to the iBCSe2 standard: Intel386 Binary Compatibility Specification, Edition 2. diff --git a/man3/clearenv.3 b/man3/clearenv.3 index 2126cd7b..b9481574 100644 --- a/man3/clearenv.3 +++ b/man3/clearenv.3 @@ -31,13 +31,13 @@ clearenv \- clear the environment .BI "int clearenv(void);" .fi .SH DESCRIPTION -The \fBclearenv()\fP function clears the environment of all name-value +The \fBclearenv\fP() function clears the environment of all name-value pairs and sets the value of the external variable .I environ to NULL. .SH "RETURN VALUE" -The \fBclearenv()\fP function returns zero on success, and a non-zero +The \fBclearenv\fP() function returns zero on success, and a non-zero value on failure. .\" Most versions of Unix return -1 on error, or do not even have errors. .\" Glibc info and the Watcom C library document "a non-zero value". @@ -48,10 +48,10 @@ Not in libc4, libc5. In glibc since glibc 2.0. .SH "CONFORMING TO" Various Unix variants (DGUX, HPUX, QNX, ...). POSIX.9 (bindings for FORTRAN77). -POSIX.1-1996 did not accept \fBclearenv()\fP and \fIputenv()\fP, +POSIX.1-1996 did not accept \fBclearenv\fP() and \fIputenv\fP(), but changed its mind and scheduled these functions for some later issue of this standard (cf. B.4.6.1). However, SUSv3 -only adds \fIputenv()\fP, and rejected \fBclearenv()\fP. +only adds \fIputenv\fP(), and rejected \fBclearenv\fP(). .SH NOTES Used in security-conscious applications. If it is unavailable @@ -66,12 +66,12 @@ will probably do. The DGUX and Tru64 manpages write: If .I environ has been modified by anything other than the -.IR putenv() , -.IR getenv() , +.IR putenv (), +.IR getenv (), or -.IR clearenv() +.IR clearenv () functions, then -.BR clearenv() +.BR clearenv () will return an error and the process environment will remain unchanged. .\" .LP .\" HPUX has a ENOMEM error return. diff --git a/man3/clock.3 b/man3/clock.3 index 5d7af400..7a3731ad 100644 --- a/man3/clock.3 +++ b/man3/clock.3 @@ -35,7 +35,7 @@ clock \- Determine processor time .fi .SH DESCRIPTION The -.B clock() +.BR clock () function returns an approximation of processor time used by the program. .SH "RETURN VALUE" The value returned is the CPU time used so far as a @@ -51,7 +51,7 @@ of the actual resolution. .SH NOTES The C standard allows for arbitrary values at the start of the program; subtract the value returned from a call to -.B clock() +.BR clock () at the start of the program to get maximum portability. .PP Note that the time can wrap around. On a 32bit system where @@ -73,7 +73,7 @@ value returned by .\" POSIX 1003.1-2001 doesn't explicitly allow this, nor is there an .\" explicit prohibition. -- MTK The -.B times() +.BR times () function, which explicitly returns (separate) information about the caller and its children, may be preferable. .SH "SEE ALSO" diff --git a/man3/closedir.3 b/man3/closedir.3 index 7c0a7adc..a21da0f2 100644 --- a/man3/closedir.3 +++ b/man3/closedir.3 @@ -38,11 +38,11 @@ closedir \- close a directory .BI "int closedir(DIR *" dir ); .fi .SH DESCRIPTION -The \fBclosedir()\fP function closes the directory stream associated with +The \fBclosedir\fP() function closes the directory stream associated with \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. +The \fBclosedir\fP() function returns 0 on success. On error, \-1 is returned, and .I errno is set appropriately. diff --git a/man3/confstr.3 b/man3/confstr.3 index b2f40972..02b5328e 100644 --- a/man3/confstr.3 +++ b/man3/confstr.3 @@ -40,7 +40,7 @@ or .BI "size_t confstr(int " "name" ", char *" buf ", size_t " len ); .fi .SH DESCRIPTION -.B confstr() +.BR confstr () gets the value of configuration-dependent string variables. .PP The @@ -69,14 +69,14 @@ is not and .I len is not zero, -.B confstr() +.BR confstr () copies the value of the string to .I buf truncated to .I len \- 1 characters if necessary, with a null character as termination. This can be detected by comparing the return value of -.B confstr() +.BR confstr () against .IR len . .PP @@ -86,13 +86,13 @@ is zero and .I buf is .BR NULL , -.B confstr() +.BR confstr () just returns the value as defined below. .SH "RETURN VALUE" If .I name does not correspond to a valid configuration variable, -.B confstr() +.BR confstr () returns 0. .SH EXAMPLES The following code fragment determines the path where to find diff --git a/man3/copysign.3 b/man3/copysign.3 index ec65d160..1fa6c1a8 100644 --- a/man3/copysign.3 +++ b/man3/copysign.3 @@ -42,11 +42,11 @@ copysign, copysignf, copysignl \- copy sign of a number .sp Link with \-lm. .SH DESCRIPTION -The \fBcopysign()\fP functions return a value whose absolute value matches +The \fBcopysign\fP() functions return a value whose absolute value matches that of \fIx\fP, but whose sign matches that of \fIy\fP. If \fIx\fP is a NaN, then a NaN with the sign of \fIy\fP is returned. .SH NOTES -The \fBcopysign()\fP functions may treat a negative zero as positive. +The \fBcopysign\fP() functions may treat a negative zero as positive. .SH "CONFORMING TO" C99, 4.3BSD. This function is defined in IEC 559 (and the appendix with @@ -43,10 +43,10 @@ cos, cosf, cosl \- cosine function .sp Link with \-lm. .SH DESCRIPTION -The \fBcos()\fP function returns the cosine of \fIx\fP, where \fIx\fP is +The \fBcos\fP() function returns the cosine of \fIx\fP, where \fIx\fP is given in radians. .SH "RETURN VALUE" -The \fBcos()\fP function returns a value between \-1 and 1. +The \fBcos\fP() function returns a value between \-1 and 1. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899. The float and the long double variants are C99 requirements. diff --git a/man3/cosh.3 b/man3/cosh.3 index 3ed5d220..ff74e601 100644 --- a/man3/cosh.3 +++ b/man3/cosh.3 @@ -45,7 +45,7 @@ cosh, coshf, coshl \- hyperbolic cosine function .sp Link with \-lm. .SH DESCRIPTION -The \fBcosh()\fP function returns the hyperbolic cosine of \fIx\fP, which +The \fBcosh\fP() function returns the hyperbolic cosine of \fIx\fP, which is defined mathematically as (exp(x) + exp(\-x)) / 2. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899 (C99). diff --git a/man3/ctermid.3 b/man3/ctermid.3 index 1cec6bf3..48c27aeb 100644 --- a/man3/ctermid.3 +++ b/man3/ctermid.3 @@ -31,7 +31,7 @@ ctermid \- get controlling terminal name .BI "char *ctermid(char *" "s" ); .fi .SH DESCRIPTION -.B ctermid() +.BR ctermid () returns a string which is the pathname for the current controlling terminal for this process. If diff --git a/man3/ctime.3 b/man3/ctime.3 index 37479717..e7515ab6 100644 --- a/man3/ctime.3 +++ b/man3/ctime.3 @@ -57,13 +57,13 @@ localtime_r \- transform date and time to broken-down time or ASCII .BI "time_t mktime(struct tm *" tm ); .fi .SH DESCRIPTION -The \fBctime()\fP, \fBgmtime()\fP and \fBlocaltime()\fP functions all take +The \fBctime\fP(), \fBgmtime\fP() and \fBlocaltime\fP() functions all take an argument of data type \fItime_t\fP which represents calendar time. When interpreted as an absolute time value, it represents the number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC). .PP -The \fBasctime()\fP and \fBmktime()\fP functions both take an argument +The \fBasctime\fP() and \fBmktime\fP() functions both take an argument representing broken-down time which is a representation separated into year, month, day, etc. .PP @@ -140,19 +140,19 @@ might be overwritten by subsequent calls to any of the date and time functions. The function also sets the external variable \fItzname\fP (see .BR tzset (3)) with information about the current time zone. -The re-entrant version \fBctime_r()\fP does the same, but stores the +The re-entrant version \fBctime_r\fP() does the same, but stores the string in a user-supplied buffer of length at least 26. It need not set \fItzname\fP. .PP -The \fBgmtime()\fP function converts the calendar time \fItimep\fP to +The \fBgmtime\fP() function converts the calendar time \fItimep\fP to broken-down time representation, expressed in Coordinated Universal Time (UTC). It may return NULL when the year does not fit into an integer. The return value points to a statically allocated struct which might be overwritten by subsequent calls to any of the date and time functions. -The \fBgmtime_r()\fP function does the same, but stores the data in a +The \fBgmtime_r\fP() function does the same, but stores the data in a user-supplied struct. .PP -The \fBlocaltime()\fP function converts the calendar time \fItimep\fP to +The \fBlocaltime\fP() function converts the calendar time \fItimep\fP to broken-time representation, expressed relative to the user's specified time zone. The function acts as if it called .BR tzset (3) @@ -163,45 +163,45 @@ seconds, and \fIdaylight\fP to a non-zero value if daylight savings time rules apply during some part of the year. The return value points to a statically allocated struct which might be overwritten by subsequent calls to any of the date and time functions. -The \fBlocaltime_r()\fP function does the same, but stores the data in a +The \fBlocaltime_r\fP() function does the same, but stores the data in a user-supplied struct. It need not set \fItzname\fP. .PP -The \fBasctime()\fP function converts the broken-down time value -\fItm\fP into a string with the same format as \fBctime()\fP. +The \fBasctime\fP() function converts the broken-down time value +\fItm\fP into a string with the same format as \fBctime\fP(). The return value points to a statically allocated string which might be overwritten by subsequent calls to any of the date and time functions. -The \fBasctime_r()\fP function does the same, but stores the string in +The \fBasctime_r\fP() function does the same, but stores the string in a user-supplied buffer of length at least 26. .PP -The \fBmktime()\fP function converts a broken-down time structure, expressed +The \fBmktime\fP() function converts a broken-down time structure, expressed as local time, to calendar time representation. The function ignores the specified contents of the structure members \fItm_wday\fP and \fItm_yday\fP and recomputes them from the other information in the broken-down time structure. If structure members are outside their legal interval, they will be normalized (so that, e.g., 40 October is changed into 9 November). -Calling \fBmktime()\fP also sets the external variable \fItzname\fP with +Calling \fBmktime\fP() also sets the external variable \fItzname\fP with information about the current time zone. If the specified broken-down time cannot be represented as calendar time (seconds since the epoch), -\fBmktime()\fP returns a value of (time_t)(\-1) and does not alter the +\fBmktime\fP() returns a value of (time_t)(\-1) and does not alter the \fItm_wday\fP and \fItm_yday\fP members of the broken-down time structure. .SH "RETURN VALUE" Each of these functions returns the value described, or NULL -(\-1 in case of \fBmktime()\fP) in case an error was detected. +(\-1 in case of \fBmktime\fP()) in case an error was detected. .SH NOTES The four functions -.BR asctime() , -.BR ctime() , -.B gmtime() +.BR asctime (), +.BR ctime (), +.BR gmtime () and -.B localtime() +.BR localtime () return a pointer to static data and hence are not thread-safe. Thread-safe versions -.BR asctime_r() , -.BR ctime_r() , -.B gmtime_r() +.BR asctime_r (), +.BR ctime_r (), +.BR gmtime_r () and -.BR localtime_r() +.BR localtime_r () are specified by SUSv2, and available since libc 5.2.5. .LP In many implementations, including diff --git a/man3/daemon.3 b/man3/daemon.3 index 3ff7bf66..14eb39e3 100644 --- a/man3/daemon.3 +++ b/man3/daemon.3 @@ -58,7 +58,7 @@ will redirect standard input, standard output and standard error to \fI/dev/null\fP. .SH "RETURN VALUE" (This function forks, and if the -.B fork() +.BR fork () succeeds, the parent does .\" not .IR in order not to underline _ .BR _exit (0), diff --git a/man3/difftime.3 b/man3/difftime.3 index 24bccc9a..823cce8f 100644 --- a/man3/difftime.3 +++ b/man3/difftime.3 @@ -35,7 +35,7 @@ difftime \- calculate time difference .BI "double difftime(time_t " time1 ", time_t " time0 ); .fi .SH DESCRIPTION -The \fBdifftime()\fP function returns the number of seconds elapsed +The \fBdifftime\fP() function returns the number of seconds elapsed between time \fItime1\fP and time \fItime0\fP, represented as a double. The two times are specified in calendar time, which represents the time elapsed since the Epoch diff --git a/man3/dirfd.3 b/man3/dirfd.3 index e2658750..d390a6a0 100644 --- a/man3/dirfd.3 +++ b/man3/dirfd.3 @@ -31,7 +31,7 @@ dirfd \- get directory stream file descriptor .BI "int dirfd(DIR *" dir ); .SH DESCRIPTION The function -.B dirfd() +.BR dirfd () returns the file descriptor associated with the directory stream .IR dir . .LP @@ -47,13 +47,13 @@ div, ldiv, lldiv, imaxdiv \- compute quotient and remainder of an integer divisi .BI "imaxdiv_t imaxdiv(intmax_t " numerator ", intmax_t " denominator ); .fi .SH DESCRIPTION -The \fBdiv()\fP function computes the value \fInumerator\fP/\fIdenominator\fP and +The \fBdiv\fP() function computes the value \fInumerator\fP/\fIdenominator\fP and returns the quotient and remainder in a structure named \fIdiv_t\fP that contains two integer members (in unspecified order) named \fIquot\fP and \fIrem\fP. The quotient is rounded towards zero. The result satisfies \fIquot\fP*\fIdenominator\fP+\fIrem\fP = \fInumerator\fP. .LP -The \fBldiv()\fP and \fBlldiv()\fP and \fBimaxdiv()\fP functions do the same, +The \fBldiv\fP() and \fBlldiv\fP() and \fBimaxdiv\fP() functions do the same, dividing numbers of the indicated type and returning the result in a structure of the indicated name, in all cases with fields \fIquot\fP and \fIrem\fP of the same type as the function arguments. diff --git a/man3/dl_iterate_phdr.3 b/man3/dl_iterate_phdr.3 index e9c1ef17..0dd3f663 100644 --- a/man3/dl_iterate_phdr.3 +++ b/man3/dl_iterate_phdr.3 @@ -82,7 +82,7 @@ argument is a structure of the following type: .fi (The -.I ElfW() +.IR ElfW () macro definition turns its argument into the name of an ELF data type suitable for the hardware architecture. For example, on a 32-bit platform, diff --git a/man3/drand48.3 b/man3/drand48.3 index f4c7590b..7427b895 100644 --- a/man3/drand48.3 +++ b/man3/drand48.3 @@ -55,20 +55,20 @@ lcong48 \- generate uniformly distributed pseudo-random numbers These functions generate pseudo-random numbers using the linear congruential algorithm and 48-bit integer arithmetic. .PP -The \fBdrand48()\fP and \fBerand48()\fP functions return non-negative +The \fBdrand48\fP() and \fBerand48\fP() functions return non-negative double-precision floating-point values uniformly distributed between [0.0, 1.0). .PP -The \fBlrand48()\fP and \fBnrand48()\fP functions return non-negative +The \fBlrand48\fP() and \fBnrand48\fP() functions return non-negative long integers uniformly distributed between 0 and 2^31. .PP -The \fBmrand48()\fP and \fBjrand48()\fP functions return signed long +The \fBmrand48\fP() and \fBjrand48\fP() functions return signed long integers uniformly distributed between \-2^31 and 2^31. .PP -The \fBsrand48()\fP, \fBseed48()\fP and \fBlcong48()\fP functions are +The \fBsrand48\fP(), \fBseed48\fP() and \fBlcong48\fP() functions are initialization functions, one of which should be called before using -\fBdrand48()\fP, \fBlrand48()\fP or \fBmrand48()\fP. The functions -\fBerand48()\fP, \fBnrand48()\fP and \fBjrand48()\fP do not require +\fBdrand48\fP(), \fBlrand48\fP() or \fBmrand48\fP(). The functions +\fBerand48\fP(), \fBnrand48\fP() and \fBjrand48\fP() do not require an initialization function to be called first. .PP All the functions work by generating a sequence of 48-bit integers, @@ -81,7 +81,7 @@ All the functions work by generating a sequence of 48-bit integers, .fi .sp The parameter \fIm\fP = 2^48, hence 48-bit integer arithmetic is performed. -Unless \fBlcong48()\fP is called, \fIa\fP and \fIc\fP are given by: +Unless \fBlcong48\fP() is called, \fIa\fP and \fIc\fP are given by: .sp .nf .RS @@ -90,36 +90,36 @@ Unless \fBlcong48()\fP is called, \fIa\fP and \fIc\fP are given by: .RE .fi .sp -The value returned by any of the functions \fBdrand48()\fP, \fBerand48()\fP, -\fBlrand48()\fP, \fBnrand48()\fP, \fBmrand48()\fP or \fBjrand48()\fP is +The value returned by any of the functions \fBdrand48\fP(), \fBerand48\fP(), +\fBlrand48\fP(), \fBnrand48\fP(), \fBmrand48\fP() or \fBjrand48\fP() is computed by first generating the next 48-bit \fIXi\fP in the sequence. Then the appropriate number of bits, according to the type of data item to be returned, is copied from the high-order bits of \fIXi\fP and transformed into the returned value. .PP -The functions \fBdrand48()\fP, \fBlrand48()\fP and \fBmrand48()\fP store +The functions \fBdrand48\fP(), \fBlrand48\fP() and \fBmrand48\fP() store the last 48-bit \fIXi\fP generated in an internal buffer. The functions -\fBerand48()\fP, \fBnrand48()\fP and \fBjrand48()\fP require the calling +\fBerand48\fP(), \fBnrand48\fP() and \fBjrand48\fP() require the calling program to provide storage for the successive \fIXi\fP values in the array argument \fIxsubi\fP. The functions are initialized by placing the initial value of \fIXi\fP into the array before calling the function for the first time. .PP -The initializer function \fBsrand48()\fP sets the high order 32-bits of +The initializer function \fBsrand48\fP() sets the high order 32-bits of \fIXi\fP to the argument \fIseedval\fP. The low order 16-bits are set to the arbitrary value 0x330E. .PP -The initializer function \fBseed48()\fP sets the value of \fIXi\fP to +The initializer function \fBseed48\fP() sets the value of \fIXi\fP to the 48-bit value specified in the array argument \fIseed16v\fP. The previous value of \fIXi\fP is copied into an internal buffer and a -pointer to this buffer is returned by \fBseed48()\fP. +pointer to this buffer is returned by \fBseed48\fP(). .PP -The initialization function \fBlcong48()\fP allows the user to specify +The initialization function \fBlcong48\fP() allows the user to specify initial values for \fIXi\fP, \fIa\fP and \fIc\fP. Array argument elements \fIparam[0-2]\fP specify \fIXi\fP, \fIparam[3-5]\fP specify -\fIa\fP, and \fIparam[6]\fP specifies \fIc\fP. After \fBlcong48()\fP -has been called, a subsequent call to either \fBsrand48()\fP or -\fBseed48()\fP will restore the standard values of \fIa\fP and \fIc\fP. +\fIa\fP, and \fIparam[6]\fP specifies \fIc\fP. After \fBlcong48\fP() +has been called, a subsequent call to either \fBsrand48\fP() or +\fBseed48\fP() will restore the standard values of \fIa\fP and \fIc\fP. .SH "CONFORMING TO" SVID 3 .SH NOTES diff --git a/man3/drand48_r.3 b/man3/drand48_r.3 index 0b033aa3..9a6bd552 100644 --- a/man3/drand48_r.3 +++ b/man3/drand48_r.3 @@ -68,10 +68,10 @@ the supplied data Before the first use, this struct must be initialized, e.g. by filling it with zeroes, or by calling one of the functions -.BR srand48_r() , -.BR seed48_r() , +.BR srand48_r (), +.BR seed48_r (), or -.BR lcong48_r() . +.BR lcong48_r (). .SH "RETURN VALUE" The return value is 0. .SH "CONFORMING TO" diff --git a/man3/ecvt.3 b/man3/ecvt.3 index aaffd056..9e014f60 100644 --- a/man3/ecvt.3 +++ b/man3/ecvt.3 @@ -39,7 +39,7 @@ ecvt, fcvt \- convert a floating-point number to a string .BI "char *fcvt(double " number ", int " ndigits ", int *" decpt , .BI "int *" sign ); .SH DESCRIPTION -The \fBecvt()\fP function converts \fInumber\fP to a null-terminated +The \fBecvt\fP() function converts \fInumber\fP to a null-terminated string of \fIndigits\fP digits (where \fIndigits\fP is reduced to an system-specific limit determined by the precision of a double), and returns a pointer to the string. The high-order digit is non-zero, @@ -55,13 +55,13 @@ it's set to 0. If .I number is zero, it is unspecified whether *\fIdecpt\fP is 0 or 1. .PP -The \fBfcvt()\fP function is identical to \fBecvt()\fP, except that +The \fBfcvt\fP() function is identical to \fBecvt\fP(), except that \fIndigits\fP specifies the number of digits after the decimal point. .SH "RETURN VALUE" -Both the \fBecvt()\fP and \fBfcvt()\fP functions return a pointer to a +Both the \fBecvt\fP() and \fBfcvt\fP() functions return a pointer to a static string containing the ASCII representation of \fInumber\fP. -The static string is overwritten by each call to \fBecvt()\fP or -\fBfcvt()\fP. +The static string is overwritten by each call to \fBecvt\fP() or +\fBfcvt\fP(). .SH NOTES These functions are obsolete. Instead, .IR sprintf () diff --git a/man3/encrypt.3 b/man3/encrypt.3 index d70abe46..056db9a1 100644 --- a/man3/encrypt.3 +++ b/man3/encrypt.3 @@ -49,9 +49,9 @@ Each of these requires linking with .BR \-lcrypt . .SH DESCRIPTION These functions encrypt and decrypt 64-bit messages. The -.B setkey() +.BR setkey () function sets the key used by -.BR encrypt() . +.BR encrypt (). The .I key parameter used here is an array of 64 bytes, each of which has @@ -67,9 +67,9 @@ The result is returned in that same vector. .PP These two functions are not reentrant, that is, the key data is kept in static storage. The functions -.B setkey_r() +.BR setkey_r () and -.B encrypt_r() +.BR encrypt_r () are the reentrant versions. They use the following structure to hold the key data: .RS @@ -88,7 +88,7 @@ struct crypt_data { .fi .RE Before calling -.B setkey_r() +.BR setkey_r () set .I data->initialized to zero. @@ -124,14 +124,14 @@ main() { In glibc2.2 these functions use the DES algorithm. .SH "CONFORMING TO" The functions -.B encrypt() +.BR encrypt () and -.B setkey() +.BR setkey () conform to SVID, SUSv2, and POSIX 1003.1-2001. The functions -.B encrypt_r() +.BR encrypt_r () and -.B setkey_r() +.BR setkey_r () are GNU extensions. .SH "SEE ALSO" .BR cbc_crypt (3), diff --git a/man3/envz_add.3 b/man3/envz_add.3 index 3beb7ca7..33b99a38 100644 --- a/man3/envz_add.3 +++ b/man3/envz_add.3 @@ -47,7 +47,7 @@ to be the value. If there is no '=', the value is taken to be NULL. .LP These functions are for handling envz vectors. .LP -.B envz_add() +.BR envz_add () adds the string .RI \&" name = value \&" (in case @@ -66,14 +66,14 @@ If an entry with the same .I name existed, it is removed. .LP -.B envz_entry() +.BR envz_entry () looks for .I name in the envz vector .RI ( envz , envz_len ) and returns the entry if found, or NULL if not. .LP -.B envz_get() +.BR envz_get () looks for .I name in the envz vector @@ -84,13 +84,13 @@ an entry for .I name without '=' sign.) .LP -.B envz_merge() +.BR envz_merge () adds each entry in .I envz2 to .RI * envz , as if with -.BR envz_add() . +.BR envz_add (). If .I override is true, then values in @@ -99,7 +99,7 @@ will supersede those with the same name in .RI * envz , otherwise not. .LP -.B envz_remove() +.BR envz_remove () removes the entry for .I name from @@ -50,12 +50,12 @@ erf, erff, erfl, erfc, erfcf, erfcl \- error function and complementary error fu .fi Link with \-lm. .SH DESCRIPTION -The \fBerf()\fP function returns the error function of \fIx\fP; defined +The \fBerf\fP() function returns the error function of \fIx\fP; defined as .TP erf(x) = 2/sqrt(pi)* integral from 0 to x of exp(\-t*t) dt .PP -The \fBerfc()\fP function returns the complementary error function of +The \fBerfc\fP() function returns the complementary error function of \fIx\fP, that is 1.0 \- erf(x). .SH "CONFORMING TO" SVID 3, 4.3BSD, C99. diff --git a/man3/errno.3 b/man3/errno.3 index ced5ec33..1b51943d 100644 --- a/man3/errno.3 +++ b/man3/errno.3 @@ -326,9 +326,9 @@ if (somecall() == \-1) { where .I errno no longer needs to have the value it had upon return from -.IR somecall() +.IR somecall () (i.e., it may have been changed by the -.IR printf() ). +.IR printf ()). If the value of .I errno should be preserved across a library call, it must be saved: diff --git a/man3/ether_aton.3 b/man3/ether_aton.3 index 5dfbf21a..b7e59edf 100644 --- a/man3/ether_aton.3 +++ b/man3/ether_aton.3 @@ -61,29 +61,29 @@ ether_ntoa_r, ether_aton_r \- Ethernet address manipulation routines .BI "ether_aton_r(const char *" asc ", struct ether_addr *" addr ); .fi .SH DESCRIPTION -\fBether_aton()\fP converts the 48-bit Ethernet host address \fIasc\fP +\fBether_aton\fP() converts the 48-bit Ethernet host address \fIasc\fP from the standard hex-digits-and-colons notation into binary data in network byte order and returns a pointer to it in a statically allocated buffer, which subsequent calls will overwrite. \fBether_aton\fP() returns NULL if the address is invalid. .PP -The \fBether_ntoa()\fP function converts the Ethernet host address +The \fBether_ntoa\fP() function converts the Ethernet host address \fIaddr\fP given in network byte order to a string in standard hex-digits-and-colons notation, omitting leading zeroes. The string is returned in a statically allocated buffer, which subsequent calls will overwrite. .PP -The \fBether_ntohost()\fP function maps an Ethernet address to the +The \fBether_ntohost\fP() function maps an Ethernet address to the corresponding hostname in .B /etc/ethers and returns non-zero if it cannot be found. .PP -The \fBether_hostton()\fP function maps a hostname to the +The \fBether_hostton\fP() function maps a hostname to the corresponding Ethernet address in .B /etc/ethers and returns non-zero if it cannot be found. .PP -The \fBether_line()\fP function parses a line in +The \fBether_line\fP() function parses a line in .B /etc/ethers format (ethernet address followed by whitespace followed by hostname; '#' introduces a comment) and returns an address @@ -45,7 +45,7 @@ exp, expf, expl \- base-e exponential function .sp Link with \-lm. .SH DESCRIPTION -The \fBexp()\fP function returns the value of e (the base of natural +The \fBexp\fP() function returns the value of e (the base of natural logarithms) raised to the power of \fIx\fP. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899. diff --git a/man3/exp10.3 b/man3/exp10.3 index be0a24bd..ff827b0a 100644 --- a/man3/exp10.3 +++ b/man3/exp10.3 @@ -46,7 +46,7 @@ exp10, exp10f, exp10l \- base-10 exponential function .sp Link with \-lm. .SH DESCRIPTION -The \fBexp10()\fP function returns the value of 10 +The \fBexp10\fP() function returns the value of 10 raised to the power of \fIx\fP. .SH "CONFORMING TO" The function is a GNU extension. diff --git a/man3/exp2.3 b/man3/exp2.3 index 8951d95b..acc488b4 100644 --- a/man3/exp2.3 +++ b/man3/exp2.3 @@ -45,7 +45,7 @@ exp2, exp2f, exp2l \- base-2 exponential function .sp Compile with \-std=c99; link with \-lm. .SH DESCRIPTION -The \fBexp2()\fP function returns the value of 2 +The \fBexp2\fP() function returns the value of 2 raised to the power of \fIx\fP. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899. diff --git a/man3/fabs.3 b/man3/fabs.3 index 9639d4f2..0898416a 100644 --- a/man3/fabs.3 +++ b/man3/fabs.3 @@ -49,7 +49,7 @@ number \fIx\fP. No errors can occur. .SH "CONFORMING TO" The -.B fabs() +.BR fabs () function conforms to SVID 3, POSIX, 4.3BSD, ISO 9899. The other functions are from C99. .SH "SEE ALSO" diff --git a/man3/fflush.3 b/man3/fflush.3 index 0061800e..def5dcff 100644 --- a/man3/fflush.3 +++ b/man3/fflush.3 @@ -86,7 +86,7 @@ for any of the errors specified for the routine .BR write (2). .SH NOTES Note that -.B fflush() +.BR fflush () only flushes the user space buffers provided by the C library. To ensure that the data is physically stored on disk the kernel buffers must be flushed too, e.g. with @@ -95,7 +95,7 @@ or .BR fsync (2). .SH "CONFORMING TO" The function -.BR fflush() +.BR fflush () conforms to ANSI X3.159-1989 (``ANSI C''). .SH "SEE ALSO" .BR fsync (2), @@ -46,12 +46,12 @@ ffs \- find first bit set in a word .BI "int ffsll(long long int " i ); .fi .SH DESCRIPTION -The \fBffs()\fP function returns the position of the first +The \fBffs\fP() function returns the position of the first (least significant) bit set in the word \fIi\fP. The least significant bit is position 1 and the most significant position e.g. 32 or 64. .BR -The functions \fBffsll()\fP and \fBffsl()\fP do the same but take +The functions \fBffsll\fP() and \fBffsl\fP() do the same but take arguments of possibly different size. .SH "RETURN VALUE" These functions return the position of the first bit set, diff --git a/man3/fgetgrent.3 b/man3/fgetgrent.3 index 94370b62..190c3a67 100644 --- a/man3/fgetgrent.3 +++ b/man3/fgetgrent.3 @@ -37,7 +37,7 @@ fgetgrent \- get group file entry .BI "struct group *fgetgrent(FILE *" stream ); .fi .SH DESCRIPTION -The \fBfgetgrent()\fP function returns a pointer to a structure containing +The \fBfgetgrent\fP() function returns a pointer to a structure containing the group information from the file \fIstream\fP. The first time it is called it returns the first entry; thereafter, it returns successive entries. The file \fIstream\fP must have the same format as \fI/etc/group\fP. @@ -57,7 +57,7 @@ struct group { .fi .RE .SH "RETURN VALUE" -The \fBfgetgrent()\fP function returns the group information structure, +The \fBfgetgrent\fP() function returns the group information structure, or NULL if there are no more entries or an error occurs. .SH ERRORS .TP diff --git a/man3/fgetpwent.3 b/man3/fgetpwent.3 index 5585773a..b7e0cb3e 100644 --- a/man3/fgetpwent.3 +++ b/man3/fgetpwent.3 @@ -40,7 +40,7 @@ fgetpwent \- get password file entry .BI "struct passwd *fgetpwent(FILE *" stream ); .fi .SH DESCRIPTION -The \fBfgetpwent()\fP function returns a pointer to a structure containing +The \fBfgetpwent\fP() function returns a pointer to a structure containing the broken out fields of a line in the file \fIstream\fP. The first time it is called it returns the first entry; thereafter, it returns successive entries. The file \fIstream\fP must have the same format as @@ -64,7 +64,7 @@ struct passwd { .fi .RE .SH "RETURN VALUE" -The \fBfgetpwent()\fP function returns the passwd structure, or NULL if +The \fBfgetpwent\fP() function returns the passwd structure, or NULL if there are no more entries or an error occurs. .SH ERRORS .TP diff --git a/man3/flockfile.3 b/man3/flockfile.3 index b0c32a3b..864c2c11 100644 --- a/man3/flockfile.3 +++ b/man3/flockfile.3 @@ -62,19 +62,19 @@ the non-locking versions of the stdio functions: with \fIgetc_unlocked\fP() and \fIputc_unlocked\fP() instead of \fIgetc\fP() and \fIputc\fP(). .LP -The \fBflockfile()\fP function waits for *\fIfilehandle\fP to be +The \fBflockfile\fP() function waits for *\fIfilehandle\fP to be no longer locked by a different thread, then makes the current thread owner of *\fIfilehandle\fP, and increments the lockcount. .LP -The \fBfunlockfile()\fP function decrements the lock count. +The \fBfunlockfile\fP() function decrements the lock count. .LP -The \fBftrylockfile()\fP function is a non-blocking version -of \fBflockfile()\fP. It does nothing in case some other thread +The \fBftrylockfile\fP() function is a non-blocking version +of \fBflockfile\fP(). It does nothing in case some other thread owns *\fIfilehandle\fP, and it obtains ownership and increments the lockcount otherwise. .SH "RETURN VALUE" -The \fBftrylockfile()\fP function returns zero for success +The \fBftrylockfile\fP() function returns zero for success (the lock was obtained), and non-zero for failure. .SH ERRORS None. diff --git a/man3/floor.3 b/man3/floor.3 index 1595f167..bdc27ecd 100644 --- a/man3/floor.3 +++ b/man3/floor.3 @@ -58,7 +58,7 @@ the maximum value of the exponent is 128 (resp. 1024), and the number of mantissa bits is 24 (resp. 53).) .SH "CONFORMING TO" The -.B floor() +.BR floor () function conforms to SVID 3, POSIX, 4.3BSD, ISO 9899. The other functions are from C99. .SH "SEE ALSO" @@ -20,7 +20,7 @@ fma, fmaf, fmal \- floating-point multiply and add Compile with \-std=c99; link with \-lm. .SH DESCRIPTION The -.B fma() +.BR fma () function computes .IR x " * " y " + " z . The result is rounded according to the diff --git a/man3/fmod.3 b/man3/fmod.3 index e9abdb19..75fde82b 100644 --- a/man3/fmod.3 +++ b/man3/fmod.3 @@ -44,11 +44,11 @@ fmod, fmodf, fmodl \- floating-point remainder function .sp Link with \-lm. .SH DESCRIPTION -The \fBfmod()\fP function computes the remainder of dividing \fIx\fP by +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 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, +The \fBfmod\fP() function returns the remainder, unless \fIy\fP is zero, when the function fails and \fIerrno\fP is set. .SH ERRORS .TP diff --git a/man3/fmtmsg.3 b/man3/fmtmsg.3 index e2e1e09b..79c4e24e 100644 --- a/man3/fmtmsg.3 +++ b/man3/fmtmsg.3 @@ -136,7 +136,7 @@ This value is printed as WARNING. This value is printed as INFO. .PP The numeric values are between 0 and 4. Using -.B addseverity() +.BR addseverity () or the environment variable .B SEV_LEVEL you can add more levels and strings to print. @@ -174,22 +174,22 @@ severity-keyword,level,printstring .RE .sp then -.I fmtmsg() +.IR fmtmsg () will also accept the indicated values for the level (in addition to the standard levels 0-4), and use the indicated printstring when such a level occurs. .LP The severity-keyword part is not used by -.I fmtmsg() +.IR fmtmsg () but it has to be present. The level part is a string representation of a number. The numeric value must be a number greater than 4. This value must be used in the severity parameter of -.I fmtmsg() +.IR fmtmsg () to select this class. It is not possible to overwrite any of the predefined classes. The printstring is the string printed when a message of this class is processed by -.IR fmtmsg() . +.IR fmtmsg (). .SH "RETURN VALUES" The function can return 4 values: .TP 12n @@ -207,16 +207,16 @@ Error writing to Error writing to the console. .SH "CONFORMING TO" The functions -.I fmtmsg() +.IR fmtmsg () and -.IR addseverity() , +.IR addseverity (), and environment variables .B MSGVERB and .B SEV_LEVEL come from System V (XPG4-UNIX). The function -.I fmtmsg() +.IR fmtmsg () and the environment variable .B MSGVERB are described in POSIX 1003.1-2001. diff --git a/man3/fnmatch.3 b/man3/fnmatch.3 index b6bf0d64..c5dc7376 100644 --- a/man3/fnmatch.3 +++ b/man3/fnmatch.3 @@ -34,7 +34,7 @@ fnmatch \- match filename or pathname .fi .SH DESCRIPTION The -.B fnmatch() +.BR fnmatch () function checks whether the .I string argument matches the diff --git a/man3/fpathconf.3 b/man3/fpathconf.3 index 5369f0d2..61911585 100644 --- a/man3/fpathconf.3 +++ b/man3/fpathconf.3 @@ -33,13 +33,13 @@ fpathconf, pathconf \- get configuration values for files .BI "long pathconf(char *" path ", int " name ); .fi .SH DESCRIPTION -.B fpathconf() +.BR fpathconf () gets a value for the configuration option .I name for the open file descriptor .IR filedes . .PP -.B pathconf() +.BR pathconf () gets a value for configuration option .I name for the file name @@ -49,9 +49,9 @@ The corresponding macros defined in .B <unistd.h> are minimum values; if an application wants to take advantage of values which may change, a call to -.B fpathconf() +.BR fpathconf () or -.B pathconf() +.BR pathconf () can be made, which may yield more liberal results. .PP Setting diff --git a/man3/fpclassify.3 b/man3/fpclassify.3 index 1e28a289..c0e4a19f 100644 --- a/man3/fpclassify.3 +++ b/man3/fpclassify.3 @@ -74,7 +74,7 @@ is positive infinity, and \-1 if is negative infinity. .SH NOTE In glibc 2.01 and earlier, -.B isinf() +.BR isinf () returns a non-zero value (actually: 1) if .I x is an infinity (positive or negative). diff --git a/man3/fpurge.3 b/man3/fpurge.3 index 84bda2a7..af7fd3e8 100644 --- a/man3/fpurge.3 +++ b/man3/fpurge.3 @@ -39,7 +39,7 @@ fpurge, __fpurge \- purge a stream .fi .SH DESCRIPTION The function -.B fpurge() +.BR fpurge () clears the buffers of the given stream. For output streams this discards any unwritten output. For input streams this discards any input read from the underlying object @@ -49,11 +49,11 @@ this includes any text pushed back via \fIungetc\fP(). See also .BR fflush (3). .LP The function -.B __fpurge() +.BR __fpurge () does precisely the same, but without returning a value. .SH "RETURN VALUE" Upon successful completion -.B fpurge() +.BR fpurge () returns 0. On error, it returns \-1 and sets .I errno diff --git a/man3/frexp.3 b/man3/frexp.3 index fdb8c3c5..09914bb2 100644 --- a/man3/frexp.3 +++ b/man3/frexp.3 @@ -45,10 +45,10 @@ and integral components .sp Link with \-lm. .SH DESCRIPTION -The \fBfrexp()\fP function is used to split the number \fIx\fP into a +The \fBfrexp\fP() function is used to split the number \fIx\fP into a normalized fraction and an exponent which is stored in \fIexp\fP. .SH "RETURN VALUE" -The \fBfrexp()\fP function returns the normalized fraction. If the +The \fBfrexp\fP() function returns the normalized fraction. If the argument \fIx\fP is not zero, the normalized fraction is \fIx\fP times a power of two, and is always in the range 1/2 (inclusive) to 1 (exclusive). If \fIx\fP is zero, then the normalized fraction is diff --git a/man3/fseeko.3 b/man3/fseeko.3 index e2b24569..efb52b06 100644 --- a/man3/fseeko.3 +++ b/man3/fseeko.3 @@ -33,11 +33,11 @@ fseeko, ftello \- seek to or report file position .BI .fi .SH DESCRIPTION -The \fBfseeko()\fP and \fBftello()\fP functions are identical to -\fBfseek()\fP and \fBftell()\fP (see +The \fBfseeko\fP() and \fBftello\fP() functions are identical to +\fBfseek\fP() and \fBftell\fP() (see .BR fseek (3)), -respectively, except that the \fIoffset\fP argument of \fBfseeko()\fP -and the return value of \fBftello()\fP is of type \fBoff_t\fP +respectively, except that the \fIoffset\fP argument of \fBfseeko\fP() +and the return value of \fBftello\fP() is of type \fBoff_t\fP instead of \fBlong\fP. .LP On many architectures both \fBoff_t\fP and \fBlong\fP are 32-bit types, diff --git a/man3/ftime.3 b/man3/ftime.3 index a3350f3d..3f9e8484 100644 --- a/man3/ftime.3 +++ b/man3/ftime.3 @@ -76,7 +76,7 @@ But early glibc2 is buggy and returns 0 there; glibc 2.1.1 is correct again. .SH HISTORY The -.B ftime() +.BR ftime () function appeared in 4.2BSD. .SH "CONFORMING TO" 4.2BSD, POSIX 1003.1-2001. @@ -79,7 +79,7 @@ which case it will return zero, or until it hits an error other than EACCES .BR malloc (3) failure), in which case it will return \-1. .PP -Because \fBftw()\fP uses dynamic data structures, the only safe way to +Because \fBftw\fP() uses dynamic data structures, the only safe way to exit out of a tree walk is to return a non-zero value. To handle interrupts, for example, mark that the interrupt occurred and return a non-zero value\(emdon't use diff --git a/man3/gamma.3 b/man3/gamma.3 index f0466832..b51a08e4 100644 --- a/man3/gamma.3 +++ b/man3/gamma.3 @@ -22,18 +22,18 @@ For the definition of the Gamma function, see .PP .SS "*BSD version" 4.4BSD and FreeBSD libm have a -.B gamma() +.BR gamma () function that computes the Gamma function, as one would expect. .SS "glibc version" Glibc has a -.B gamma() +.BR gamma () function that is equivalent to -.B lgamma() +.BR lgamma () and computes the natural logarithm of the Gamma function. (This is for compatibility reasons only. Don't use this function.) .SH HISTORY 4.2BSD had a -.B gamma() +.BR gamma () that computed .RI ln(|Gamma(| x |)|), leaving the sign of @@ -41,7 +41,7 @@ leaving the sign of in the external integer .IR signgam . In 4.3BSD the name was changed to -.BR lgamma() , +.BR lgamma (), and the man page promises .sp .in +3 @@ -50,11 +50,11 @@ and used for the Gamma function" .in .sp This did indeed happen in 4.4BSD, where -.B gamma() +.BR gamma () computes the Gamma function (with no effect on .IR signgam ). However, this came too late, and we now have -.BR tgamma() , +.BR tgamma (), the "true gamma" function. .\" The FreeBSD man page says about gamma() that it is like lgamma() .\" except that is does not set signgam. diff --git a/man3/gcvt.3 b/man3/gcvt.3 index ae6ee753..a44fed5a 100644 --- a/man3/gcvt.3 +++ b/man3/gcvt.3 @@ -35,7 +35,7 @@ gcvt \- convert a floating-point number to a string .BI "char *gcvt(double " number ", size_t " ndigit ", char *" buf ); .fi .SH DESCRIPTION -The \fBgcvt()\fP function converts \fInumber\fP to a minimal length NULL +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 .BR printf (3) @@ -45,7 +45,7 @@ This function is obsolete. Instead, .IR sprintf () is recommended. .SH "RETURN VALUE" -The \fBgcvt()\fP function returns the address of the string pointed to +The \fBgcvt\fP() function returns the address of the string pointed to by \fIbuf\fP. .SH "SEE ALSO" .BR ecvt (3), diff --git a/man3/getaddrinfo.3 b/man3/getaddrinfo.3 index 0b4d34c3..0b87ff7f 100644 --- a/man3/getaddrinfo.3 +++ b/man3/getaddrinfo.3 @@ -354,7 +354,7 @@ suitable for error reporting. .SH "CONFORMING TO" POSIX 1003.1-2003. The -.B getaddrinfo() +.BR getaddrinfo () function is documented in RFC\ 2553. .SH "NOTES" .BR AI_ADDRCONFIG , diff --git a/man3/getcwd.3 b/man3/getcwd.3 index 7669413b..f29f0363 100644 --- a/man3/getcwd.3 +++ b/man3/getcwd.3 @@ -65,9 +65,9 @@ is NULL, the behaviour of is undefined. .PP As an extension to the POSIX.1 standard, Linux (libc4, libc5, glibc) -.B getcwd() +.BR getcwd () allocates the buffer dynamically using -.B malloc() +.BR malloc () if .I buf is @@ -80,7 +80,7 @@ is zero, when .I buf is allocated as big as necessary. It is possible (and, indeed, advisable) to -.B free() +.BR free () the buffers if they have been obtained this way. .BR get_current_dir_name (), diff --git a/man3/getdate.3 b/man3/getdate.3 index cb3f3587..fa087575 100644 --- a/man3/getdate.3 +++ b/man3/getdate.3 @@ -44,7 +44,7 @@ getdate() \- convert a string to struct tm .br .SH DESCRIPTION The function -.B getdate() +.BR getdate () converts a string pointed to by .I string into the tm structure that it returns. @@ -56,7 +56,7 @@ In contrast to (which has a .I format argument), -.B getdate() +.BR getdate () uses the formats found in the file of which the full path name is given in the environment variable .BR DATEMSK . @@ -129,7 +129,7 @@ There is no line in the file that matches the input. Invalid input specification. .SH NOTES Since -.B getdate() +.BR getdate () is not reentrant because of the use of .B getdate_err and the static buffer to return the result in, glibc provides a @@ -141,17 +141,17 @@ values as given above for .IR getdate_err . .LP The POSIX 1003.1-2001 specification for -.B strptime() +.BR strptime () contains conversion specifications using the .B %E or .B %O modifier, while such specifications are not given for -.BR getdate() . +.BR getdate (). The glibc implementation implements -.B getdate() +.BR getdate () using -.B strptime() +.BR strptime () so that automatically precisely the same conversions are supported by both. .LP The glibc implementation does not support the @@ -163,7 +163,7 @@ conversion specification. File containing format patterns. .TP .BR TZ ", " LC_TIME -Variables used by \fBstrptime()\fP. +Variables used by \fBstrptime\fP(). .SH "CONFORMING TO" ISO 9899, POSIX 1003.1-2001 .SH "SEE ALSO" diff --git a/man3/getenv.3 b/man3/getenv.3 index 95feeb56..6e88702a 100644 --- a/man3/getenv.3 +++ b/man3/getenv.3 @@ -37,11 +37,11 @@ getenv \- get an environment variable .BI "char *getenv(const char *" name ); .fi .SH DESCRIPTION -The \fBgetenv()\fP function searches the environment list for a string +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. .SH "RETURN VALUE" -The \fBgetenv()\fP function returns a pointer to the value in the +The \fBgetenv\fP() function returns a pointer to the value in the environment, or NULL if there is no match. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899 diff --git a/man3/getfsent.3 b/man3/getfsent.3 index 0436d2f9..2b3d73ad 100644 --- a/man3/getfsent.3 +++ b/man3/getfsent.3 @@ -60,20 +60,20 @@ one of the five strings "rw", "rq", "ro", "sw", "xx" (read-write, read-write with quota, read-only, swap, ignore). The function -.B setfsent() +.BR setfsent () opens the file when required and positions it at the first line. .LP The function -.B getfsent() +.BR getfsent () parses the next line from the file. (After opening it when required.) .LP The function -.B endfsent() +.BR endfsent () closes the file when required. .LP The function -.B getfsspec() +.BR getfsspec () searches the file from the start and returns the first entry found for which the .I fs_spec @@ -82,7 +82,7 @@ field matches the argument. .LP The function -.B getfsfile() +.BR getfsfile () searches the file from the start and returns the first entry found for which the .I fs_file @@ -91,22 +91,22 @@ field matches the argument. .SH "RETURN VALUE" Upon success, the functions -.BR getfsent() , -.BR getfsfile() , +.BR getfsent (), +.BR getfsfile (), and -.BR getfsspec() +.BR getfsspec () return a pointer to a struct fstab, while -.BR setfsent() +.BR setfsent () returns 1. Upon failure or end-of-file, these functions return NULL and 0, respectively. .SH HISTORY The -.B getfsent() +.BR getfsent () function appeared in 4.0BSD; the other four functions appeared in 4.3BSD. .SH "CONFORMING TO" These functions are not in POSIX. Several operating systems have them, e.g., *BSD, SunOS, Digital Unix, AIX (which also has a -.IR getfstype() ). +.IR getfstype ()). HP-UX has functions of the same names, that however use a struct checklist instead of a struct fstab, and calls these functions obsolete, superseded by .BR getmntent (3). @@ -117,9 +117,9 @@ Since Linux allows mounting a block special device in several places, and since several devices can have the same mount point, where the last device with a given mount point is the interesting one, while -.B getfsfile() +.BR getfsfile () and -.B getfsspec() +.BR getfsspec () only return the first occurrence, these two functions are not suitable for use under Linux. .LP diff --git a/man3/getgrent.3 b/man3/getgrent.3 index 6fc3e8e2..e53b5f18 100644 --- a/man3/getgrent.3 +++ b/man3/getgrent.3 @@ -40,7 +40,7 @@ getgrent, setgrent, endgrent \- get group file entry .B void endgrent(void); .fi .SH DESCRIPTION -The \fBgetgrent()\fP +The \fBgetgrent\fP() function returns a pointer to a structure containing the broken-out fields of a record in the group database (e.g., the local group file @@ -49,10 +49,10 @@ NIS, and LDAP). The first time it is called it returns the first entry; thereafter, it returns successive entries. .PP -The \fBsetgrent()\fP function rewinds to the beginning +The \fBsetgrent\fP() function rewinds to the beginning of the group database, to allow repeated scans. .PP -The \fBendgrent()\fP function is used to close the group database +The \fBendgrent\fP() function is used to close the group database after all processing has been performed. .PP The \fIgroup\fP structure is defined in \fI<grp.h>\fP as follows: @@ -68,7 +68,7 @@ struct group { .fi .RE .SH "RETURN VALUE" -The \fBgetgrent()\fP function returns a pointer to a +The \fBgetgrent\fP() function returns a pointer to a .I group structure, or NULL if there are no more entries or an error occurs. diff --git a/man3/getgrent_r.3 b/man3/getgrent_r.3 index 9baa3513..1e5862df 100644 --- a/man3/getgrent_r.3 +++ b/man3/getgrent_r.3 @@ -38,9 +38,9 @@ getgrent_r, fgetgrent_r \- get group file entry reentrantly .BI " size_t " buflen ", struct group **" gbufp ); .SH DESCRIPTION The functions -.B getgrent_r() +.BR getgrent_r () and -.B fgetgrent_r() +.BR fgetgrent_r () are the reentrant versions of .BR getgrent (3) and @@ -160,7 +160,7 @@ getgrent_r(struct group *grp, char *buf, int buflen, .sp .SH NOTES The function -.B getgrent_r() +.BR getgrent_r () is not really reentrant since it shares the reading position in the stream with all other threads. .SH "SEE ALSO" diff --git a/man3/getgrnam.3 b/man3/getgrnam.3 index 2a591c77..bc368845 100644 --- a/man3/getgrnam.3 +++ b/man3/getgrnam.3 @@ -50,7 +50,7 @@ getgrnam, getgrnam_r, getgrgid, getgrgid_r \- get group file entry .fi .SH DESCRIPTION The -.B getgrnam() +.BR getgrnam () function returns a pointer to a structure containing the broken-out fields of the record in the group database (e.g., the local group file @@ -60,16 +60,16 @@ that matches the group name .IR name . .PP The -.B getgrgid() +.BR getgrgid () function returns a pointer to a structure containing the broken-out fields of the record in the group database that matches the group ID .IR gid . .PP The -.B getgrnam_r() +.BR getgrnam_r () and -.B getgrgid_r() +.BR getgrgid_r () functions obtain the same information, but store the retrieved .I group structure @@ -105,7 +105,7 @@ can be found using .BR sysconf (3) with the _SC_GETGR_R_SIZE_MAX parameter. .SH "RETURN VALUE" -The \fBgetgrnam()\fP and \fBgetgrgid()\fP functions return a pointer to a +The \fBgetgrnam\fP() and \fBgetgrgid\fP() functions return a pointer to a .I group structure, or NULL if the matching entry is not found or an error occurs. @@ -118,12 +118,12 @@ after the call, it should be set to zero before the call. .LP The return value may point to static area, and may be overwritten by subsequent calls to -.BR getgrent() , -.BR getgrgid() , +.BR getgrent (), +.BR getgrgid (), or -.BR getgrnam() . +.BR getgrnam (). .LP -The \fBgetgrnam_r()\fP and \fBgetgrgid_r()\fP functions return +The \fBgetgrnam_r\fP() and \fBgetgrgid_r\fP() functions return zero on success. In case of error, an error number is returned. .SH ERRORS .TP diff --git a/man3/getgrouplist.3 b/man3/getgrouplist.3 index c47cef92..6549c99a 100644 --- a/man3/getgrouplist.3 +++ b/man3/getgrouplist.3 @@ -15,7 +15,7 @@ getgrouplist \- list of groups a user belongs to .BI "gid_t *" groups ", int *" ngroups ); .SH DESCRIPTION The -.B getgrouplist() +.BR getgrouplist () function scans the group database for all the groups .I user belongs to. Up to @@ -31,7 +31,7 @@ is automatically included in the list of groups returned by If .RI * ngroups is smaller than the total number of groups found, then -.B getgrouplist() +.BR getgrouplist () returns a value of `\-1'. In all cases the actual number of groups is stored in .RI * ngroups . diff --git a/man3/gethostbyname.3 b/man3/gethostbyname.3 index f55d2543..0f640963 100644 --- a/man3/gethostbyname.3 +++ b/man3/gethostbyname.3 @@ -118,7 +118,7 @@ for the file format). The current domain and its parents are searched unless \fIname\fP ends in a dot. .PP -The \fBgethostbyaddr()\fP function returns a structure of type \fIhostent\fP +The \fBgethostbyaddr\fP() function returns a structure of type \fIhostent\fP for the given host address \fIaddr\fP of length \fIlen\fP and address type \fItype\fP. Valid address types are .B AF_INET @@ -126,24 +126,24 @@ and .BR AF_INET6 . The host address argument is a pointer to a struct of a type depending on the address type, for example a \fBstruct in_addr *\fP (probably -obtained via a call to \fIinet_addr()\fP) for address type AF_INET. +obtained via a call to \fIinet_addr\fP()) for address type AF_INET. .PP -The \fBsethostent()\fP function specifies, if \fIstayopen\fP is true (1), +The \fBsethostent\fP() function specifies, if \fIstayopen\fP is true (1), that a connected TCP socket should be used for the name server queries and that the connection should remain open during successive queries. Otherwise, name server queries will use UDP datagrams. .PP -The \fBendhostent()\fP function ends the use of a TCP connection for name +The \fBendhostent\fP() function ends the use of a TCP connection for name server queries. .PP -The (obsolete) \fBherror()\fP function prints the error message associated +The (obsolete) \fBherror\fP() function prints the error message associated with the current value of \fIh_errno\fP on stderr. .PP -The (obsolete) \fBhstrerror()\fP function takes an error number +The (obsolete) \fBhstrerror\fP() function takes an error number (typically \fIh_errno\fP) and returns the corresponding message string. .PP -The domain name queries carried out by \fBgethostbyname()\fP and -\fBgethostbyaddr()\fP use a combination of any or all of the name server +The domain name queries carried out by \fBgethostbyname\fP() and +\fBgethostbyaddr\fP() use a combination of any or all of the name server .BR named (8), a broken out line from \fI/etc/hosts\fP, and the Network Information Service (NIS or YP), depending upon the contents of the @@ -202,7 +202,7 @@ The first address in \fIh_addr_list\fP for backward compatibility. The .BR gethostbyname () and -.BR gethostbyaddr() +.BR gethostbyaddr () functions return the .I hostent structure or a NULL pointer if an error occurs. On error, the @@ -250,15 +250,15 @@ and glibc adds a reentrant version .BR gethostent_r (). .SH "GNU EXTENSIONS" Glibc2 also has a -.B gethostbyname2() +.BR gethostbyname2 () that works like -.BR gethostbyname() , +.BR gethostbyname (), but permits to specify the address family to which the address must belong. .LP Glibc2 also has reentrant versions -.B gethostbyname_r() +.BR gethostbyname_r () and -.BR gethostbyname2_r() . +.BR gethostbyname2_r (). These return 0 on success and non-zero on error. The result of the call is now stored in the struct with address .IR ret . @@ -289,7 +289,7 @@ does not suffice, since it contains pointers; a deep copy is required. The SUS-v2 standard is buggy and declares the .I len parameter of -.B gethostbyaddr() +.BR gethostbyaddr () to be of type .IR size_t . (That is wrong, because it has to be @@ -301,15 +301,15 @@ is not. POSIX 1003.1-2001 makes it which is OK.) .LP The BSD prototype for -.B gethostbyaddr() +.BR gethostbyaddr () uses .I const char * for the first argument. .LP POSIX 1003.1-2001 marks -.B gethostbyaddr() +.BR gethostbyaddr () and -.B gethostbyname() +.BR gethostbyname () obsolescent. See .BR getaddrinfo (3), .BR getnameinfo (3), diff --git a/man3/getline.3 b/man3/getline.3 index 328fd835..ee7822f3 100644 --- a/man3/getline.3 +++ b/man3/getline.3 @@ -33,7 +33,7 @@ getline, getdelim \- delimited string input .nl .BI "ssize_t getdelim(char **" lineptr ", size_t *" n ", int " delim ", FILE *" stream ); .SH DESCRIPTION -.B getline() +.BR getline () reads an entire line, storing the address of the buffer containing the text into .IR "*lineptr" . @@ -47,7 +47,7 @@ If is .BR "NULL" , the -.BR getline() +.BR getline () routine will allocate a buffer for containing the line, which must be freed by the user program. Alternatively, before calling @@ -58,7 +58,7 @@ can contain a pointer to a buffer .IR "*n" bytes in size. If the buffer is not large enough to hold the line read in, -.B getline() +.BR getline () resizes the buffer to fit with .BR "realloc()" , updating @@ -71,7 +71,7 @@ and .IR "*n" will be updated to reflect the buffer address and size respectively. -.BR getdelim() +.BR getdelim () works like .BR "getline()" , except a line delimiter other than newline can be specified as the diff --git a/man3/getmntent.3 b/man3/getmntent.3 index 5ef000e0..2f8b3119 100644 --- a/man3/getmntent.3 +++ b/man3/getmntent.3 @@ -58,31 +58,31 @@ These routines are used to access the file system description file \fI/etc/fstab\fP and the mounted file system description file \fI/etc/mtab\fP. .PP -The \fBsetmntent()\fP function opens the file system description file +The \fBsetmntent\fP() function opens the file system description file \fIfp\fP and returns a file pointer which can be used by -\fBgetmntent()\fP. The argument \fItype\fP is the type of access +\fBgetmntent\fP(). The argument \fItype\fP is the type of access required and can take the same values as the \fImode\fP argument of .BR fopen (3). .PP -The \fBgetmntent()\fP function reads the next line from the file system +The \fBgetmntent\fP() function reads the next line from the file system description file \fIfp\fP and returns a pointer to a structure containing the broken out fields from a line in the file. The pointer points to a static area of memory which is overwritten by subsequent -calls to \fBgetmntent()\fP. +calls to \fBgetmntent\fP(). .PP -The \fBaddmntent()\fP function adds the mntent structure \fImnt\fP to +The \fBaddmntent\fP() function adds the mntent structure \fImnt\fP to the end of the open file \fIfp\fP. .PP -The \fBendmntent()\fP function closes the file system description file +The \fBendmntent\fP() function closes the file system description file \fIfp\fP. .PP -The \fBhasmntopt()\fP function scans the \fImnt_opts\fP field (see below) +The \fBhasmntopt\fP() function scans the \fImnt_opts\fP field (see below) of the mntent structure \fImnt\fP for a substring that matches \fIopt\fP. See \fI<mntent.h>\fP and .BR mount (8) for valid mount options. .PP -The reentrant \fBgetmntent_r()\fP function is similar to \fBgetmntent()\fP, +The reentrant \fBgetmntent_r\fP() function is similar to \fBgetmntent\fP(), but stores the struct mount in the provided .RI * mntbuf and stores the strings pointed to by the entries in that struct @@ -113,17 +113,17 @@ Since fields in the mtab and fstab files are separated by whitespace, octal escapes are used to represent the four characters space (\e040), tab (\e011), newline (\e012) and backslash (\e134) in those files when they occur in one of the four strings in a mntent structure. -The routines \fBaddmntent()\fP and \fBgetmntent()\fP will convert +The routines \fBaddmntent\fP() and \fBgetmntent\fP() will convert from string representation to escaped representation and back. .SH "RETURN VALUE" -The \fBgetmntent()\fP and \fBgetmntent_r()\fP functions return +The \fBgetmntent\fP() and \fBgetmntent_r\fP() functions return a pointer to the mntent structure or NULL on failure. .PP -The \fBaddmntent()\fP function returns 0 on success and 1 on failure. +The \fBaddmntent\fP() function returns 0 on success and 1 on failure. .PP -The \fBendmntent()\fP function always returns 1. +The \fBendmntent\fP() function always returns 1. .PP -The \fBhasmntopt()\fP function returns the address of the substring if +The \fBhasmntopt\fP() function returns the address of the substring if a match is found and NULL otherwise. .SH FILES .nf @@ -133,21 +133,21 @@ a match is found and NULL otherwise. .SH "CONFORMING TO" The non-reentrant functions are from SunOS 4.1.3. A routine -.B getmntent_r() +.BR getmntent_r () was introduced in HPUX 10, but it returns an int. The prototype shown above is glibc-only. LSB deprecates the functions -.BR endhostent() , -.BR sethostent() +.BR endhostent (), +.BR sethostent () and -.BR setmntent() . +.BR setmntent (). .SH NOTES -SysV also has a \fBgetmntent()\fP function but the calling sequence +SysV also has a \fBgetmntent\fP() function but the calling sequence differs, and the returned structure is different. Under SysV .I /etc/mnttab is used. -4.4BSD and Digital Unix have a routine \fBgetmntinfo()\fP, -a wrapper around the system call \fBgetfsstat()\fP. +4.4BSD and Digital Unix have a routine \fBgetmntinfo\fP(), +a wrapper around the system call \fBgetfsstat\fP(). .SH "SEE ALSO" .BR fopen (3), .BR fstab (5), diff --git a/man3/getnetent.3 b/man3/getnetent.3 index 0a1fde0a..aef58e96 100644 --- a/man3/getnetent.3 +++ b/man3/getnetent.3 @@ -44,25 +44,25 @@ get network entry .B void endnetent(void); .fi .SH DESCRIPTION -The \fBgetnetent()\fP function reads the next line from the file +The \fBgetnetent\fP() function reads the next line from the file \fI/etc/networks\fP and returns a structure \fInetent\fP containing the broken out fields from the line. The \fI/etc/networks\fP file is opened if necessary. .PP -The \fBgetnetbyname()\fP function returns a \fInetent\fP structure +The \fBgetnetbyname\fP() function returns a \fInetent\fP structure for the line from \fI/etc/networks\fP that matches the network \fIname\fP. .PP -The \fBgetnetbyaddr()\fP function returns a \fInetent\fP structure +The \fBgetnetbyaddr\fP() function returns a \fInetent\fP structure for the line that matches the network number \fInet\fP of type \fItype\fP. .PP -The \fBsetnetent()\fP function opens and rewinds the +The \fBsetnetent\fP() function opens and rewinds the \fI/etc/networks\fP file. If \fIstayopen\fP is true (1), then the -file will not be closed between calls to \fBgetnetbyname()\fP and -\fBgetnetbyaddr()\fP. +file will not be closed between calls to \fBgetnetbyname\fP() and +\fBgetnetbyaddr\fP(). .PP -The \fBendnetent()\fP function closes \fI/etc/networks\fP. +The \fBendnetent\fP() function closes \fI/etc/networks\fP. .PP The \fInetent\fP structure is defined in \fI<netdb.h>\fP as follows: .sp @@ -94,7 +94,7 @@ The type of the network number; always AF_INET. .I n_net The network number in host byte order. .SH "RETURN VALUE" -The \fBgetnetent()\fP, \fBgetnetbyname()\fP and \fBgetnetbyaddr()\fP +The \fBgetnetent\fP(), \fBgetnetbyname\fP() and \fBgetnetbyaddr\fP() functions return the \fInetent\fP structure, or a NULL pointer if an error occurs or the end of the file is reached. .SH FILES diff --git a/man3/getopt.3 b/man3/getopt.3 index 3ebf44e0..5cbebd60 100644 --- a/man3/getopt.3 +++ b/man3/getopt.3 @@ -68,7 +68,7 @@ function parses the command-line arguments. Its arguments and .I argv are the argument count and array as passed to the -.I main() +.IR main () function on program invocation. An element of \fIargv\fP that starts with '\-' (and is not exactly "\-" or "\-\-") diff --git a/man3/getprotoent.3 b/man3/getprotoent.3 index cd89db1a..e5422d68 100644 --- a/man3/getprotoent.3 +++ b/man3/getprotoent.3 @@ -44,24 +44,24 @@ endprotoent \- get protocol entry .B void endprotoent(void); .fi .SH DESCRIPTION -The \fBgetprotoent()\fP function reads the next line from the file +The \fBgetprotoent\fP() function reads the next line from the file \fI/etc/protocols\fP and returns a structure \fIprotoent\fP containing the broken out fields from the line. The \fI/etc/protocols\fP file is opened if necessary. .PP -The \fBgetprotobyname()\fP function returns a \fIprotoent\fP +The \fBgetprotobyname\fP() function returns a \fIprotoent\fP structure for the line from \fI/etc/protocols\fP that matches the protocol name \fIname\fP. .PP -The \fBgetprotobynumber()\fP function returns a \fIprotoent\fP +The \fBgetprotobynumber\fP() function returns a \fIprotoent\fP structure for the line that matches the protocol number \fInumber\fP. .PP -The \fBsetprotoent()\fP function opens and rewinds the +The \fBsetprotoent\fP() function opens and rewinds the \fI/etc/protocols\fP file. If \fIstayopen\fP is true (1), then -the file will not be closed between calls to \fBgetprotobyname()\fP -or \fBgetprotobynumber()\fP. +the file will not be closed between calls to \fBgetprotobyname\fP() +or \fBgetprotobynumber\fP(). .PP -The \fBendprotoent()\fP function closes \fI/etc/protocols\fP. +The \fBendprotoent\fP() function closes \fI/etc/protocols\fP. .PP The \fIprotoent\fP structure is defined in \fI<netdb.h>\fP as follows: .sp @@ -89,7 +89,7 @@ A zero terminated list of alternative names for the protocol. .I p_proto The protocol number. .SH "RETURN VALUE" -The \fBgetprotoent()\fP, \fBgetprotobyname()\fP and \fBgetprotobynumber()\fP +The \fBgetprotoent\fP(), \fBgetprotobyname\fP() and \fBgetprotobynumber\fP() functions return the \fIprotoent\fP structure, or a NULL pointer if an error occurs or the end of the file is reached. .SH FILES diff --git a/man3/getpt.3 b/man3/getpt.3 index 8f95300c..ac89c211 100644 --- a/man3/getpt.3 +++ b/man3/getpt.3 @@ -12,7 +12,7 @@ getpt \- open the pseudo-terminal master (PTM) .B "int getpt(void)" .fi .SH DESCRIPTION -.B getpt() +.BR getpt () opens a pseudo-terminal master and returns its file descriptor. It is equivalent to .BI "open(" \fI"/dev/ptmx" , O_RDWR|O_NOCTTY ) @@ -20,13 +20,13 @@ on Linux systems, though the pseudo-terminal master is located elsewhere on some systems that use GNU Libc. .SH "RETURN VALUE" -.B getpt() +.BR getpt () returns an open file descriptor upon successful completion. Otherwise, it returns \-1 and sets .I errno to indicate the error. .SH CONFORMING TO -.B getpt() +.BR getpt () is specific to GNU Libc. .SH "SEE ALSO" .BR grantpt (3), diff --git a/man3/getpw.3 b/man3/getpw.3 index d73026fa..fd4da7f4 100644 --- a/man3/getpw.3 +++ b/man3/getpw.3 @@ -38,7 +38,7 @@ getpw \- Re-construct password line entry .BI "int getpw(uid_t " uid ", char *" buf ); .fi .SH DESCRIPTION -The \fBgetpw()\fP function re-constructs the password line entry for +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 .sp @@ -64,7 +64,7 @@ struct passwd { .fi .RE .SH "RETURN VALUE" -The \fBgetpw()\fP function returns 0 on success, or \-1 if an error +The \fBgetpw\fP() function returns 0 on success, or \-1 if an error occurs. .SH ERRORS .TP diff --git a/man3/getpwent.3 b/man3/getpwent.3 index 1a8b4208..ad964308 100644 --- a/man3/getpwent.3 +++ b/man3/getpwent.3 @@ -43,7 +43,7 @@ getpwent, setpwent, endpwent \- get password file entry .B void endpwent(void); .fi .SH DESCRIPTION -The \fBgetpwent()\fP function returns a pointer to a structure containing +The \fBgetpwent\fP() function returns a pointer to a structure containing the broken-out fields of a record from the password database (e.g., the local password file .IR /etc/passwd , @@ -52,10 +52,10 @@ The first time it is called it returns the first entry; thereafter, it returns successive entries. .PP -The \fBsetpwent()\fP function rewinds to the beginning +The \fBsetpwent\fP() function rewinds to the beginning of the password database. .PP -The \fBendpwent()\fP function is used to close the password database +The \fBendpwent\fP() function is used to close the password database after all processing has been performed. .PP The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows: @@ -74,7 +74,7 @@ struct passwd { .fi .RE .SH "RETURN VALUE" -The \fBgetpwent()\fP function returns a pointer to a +The \fBgetpwent\fP() function returns a pointer to a .I passwd structure, or NULL if there are no more entries or an error occurs. diff --git a/man3/getpwent_r.3 b/man3/getpwent_r.3 index 07e047e0..4e1730fc 100644 --- a/man3/getpwent_r.3 +++ b/man3/getpwent_r.3 @@ -38,9 +38,9 @@ getpwent_r, fgetpwent_r \- get passwd file entry reentrantly .BI " size_t " buflen ", struct passwd **" pwbufp ); .SH DESCRIPTION The functions -.B getpwent_r() +.BR getpwent_r () and -.B fgetpwent_r() +.BR fgetpwent_r () are the reentrant versions of .BR getpwent (3) and @@ -158,7 +158,7 @@ getpwent_r(struct passwd *pwd, char *buf, int buflen, .sp .SH NOTES The function -.B getpwent_r() +.BR getpwent_r () is not really reentrant since it shares the reading position in the stream with all other threads. .SH "SEE ALSO" diff --git a/man3/getpwnam.3 b/man3/getpwnam.3 index 610a97b3..8a04ad61 100644 --- a/man3/getpwnam.3 +++ b/man3/getpwnam.3 @@ -51,7 +51,7 @@ getpwnam, getpwnam_r, getpwuid, getpwuid_r \- get password file entry .fi .SH DESCRIPTION The -.B getpwnam() +.BR getpwnam () function returns a pointer to a structure containing the broken-out fields of the record in the password database (e.g., the local password file @@ -61,16 +61,16 @@ that matches the user name .IR name . .PP The -.B getpwuid() +.BR getpwuid () function returns a pointer to a structure containing the broken-out fields of the record in the password database that matches the user ID .IR uid . .PP The -.B getpwnam_r() +.BR getpwnam_r () and -.B getpwuid_r() +.BR getpwuid_r () functions obtain the same information, but store the retrieved .I passwd structure in the space pointed to by @@ -108,7 +108,7 @@ can be found using .BR sysconf (3) with the _SC_GETPW_R_SIZE_MAX parameter. .SH "RETURN VALUE" -The \fBgetpwnam()\fP and \fBgetpwuid()\fP functions return a pointer to a +The \fBgetpwnam\fP() and \fBgetpwuid\fP() functions return a pointer to a .I passwd structure, or NULL if the matching entry is not found or an error occurs. @@ -121,12 +121,12 @@ after the call, it should be set to zero before the call. .LP The return value may point to static area, and may be overwritten by subsequent calls to -.BR getpwent() , -.BR getpwnam() , +.BR getpwent (), +.BR getpwnam (), or -.BR getpwuid() . +.BR getpwuid (). .LP -The \fBgetpwnam_r()\fP and \fBgetpwuid_r()\fP functions return +The \fBgetpwnam_r\fP() and \fBgetpwuid_r\fP() functions return zero on success. In case of error, an error number is returned. .SH ERRORS .TP diff --git a/man3/getrpcent.3 b/man3/getrpcent.3 index 3d1eb541..8b446b6b 100644 --- a/man3/getrpcent.3 +++ b/man3/getrpcent.3 @@ -27,10 +27,10 @@ endrpcent () .fi .SH DESCRIPTION .LP -.BR getrpcent() , -.BR getrpcbyname() , +.BR getrpcent (), +.BR getrpcbyname (), and -.B getrpcbynumber() +.BR getrpcbynumber () each return a pointer to an object with the following structure containing the broken-out @@ -64,24 +64,24 @@ The rpc program number for this service. .PD .RE .LP -.B getrpcent() +.BR getrpcent () reads the next line of the file, opening the file if necessary. .LP -.B setrpcent() +.BR setrpcent () opens and rewinds the file. If the .I stayopen flag is non-zero, the net data base will not be closed after each call to -.B getrpcent() +.BR getrpcent () (either directly, or indirectly through one of the other \*(lqgetrpc\*(rq calls). .LP .BR endrpcent () closes the file. .LP -.B getrpcbyname() +.BR getrpcbyname () and -.B getrpcbynumber() +.BR getrpcbynumber () sequentially search from the beginning of the file until a matching rpc program name or program number is found, or until end-of-file is encountered. diff --git a/man3/getrpcport.3 b/man3/getrpcport.3 index a299fe60..e4e58b27 100644 --- a/man3/getrpcport.3 +++ b/man3/getrpcport.3 @@ -10,7 +10,7 @@ int getrpcport(host, prognum, versnum, proto) int prognum, versnum, proto; .fi .SH DESCRIPTION -.B getrpcport() +.BR getrpcport () returns the port number for version .I versnum of the RPC program diff --git a/man3/gets.3 b/man3/gets.3 index de325d77..1927b3be 100644 --- a/man3/gets.3 +++ b/man3/gets.3 @@ -41,7 +41,7 @@ fgetc, fgets, getc, getchar, gets, ungetc \- input of characters and strings .nl .BI "int ungetc(int " c ", FILE *" stream ); .SH DESCRIPTION -.B fgetc() +.BR fgetc () reads the next character from .I stream and returns it as an @@ -52,14 +52,14 @@ or .B EOF on end of file or error. .PP -.B getc() +.BR getc () is equivalent to -.B fgetc() +.BR fgetc () except that it may be implemented as a macro which evaluates .I stream more than once. .PP -.B getchar() +.BR getchar () is equivalent to .BI "getc(" stdin ) \fR. .PP @@ -76,7 +76,7 @@ No check for buffer overrun is performed (see .B BUGS below). .PP -.B fgets() +.BR fgets () reads in at most one less than .I size characters from @@ -89,7 +89,7 @@ or a newline. If a newline is read, it is stored into the buffer. A .B '\e0' is stored after the last character in the buffer. .PP -.B ungetc() +.BR ungetc () pushes .I c back to @@ -123,7 +123,7 @@ on success, and .B NULL on error or when end of file occurs while no characters have been read. .PP -.B ungetc() +.BR ungetc () returns .I c on success, or @@ -132,24 +132,24 @@ on error. .SH "CONFORMING TO" ANSI-C, POSIX.1. LSB deprecates -.BR gets() . +.BR gets (). .SH BUGS Never use -.BR gets() . +.BR gets (). Because it is impossible to tell without knowing the data in advance how many characters -.B gets() +.BR gets () will read, and because -.B gets() +.BR gets () will continue to store characters past the end of the buffer, it is extremely dangerous to use. It has been used to break computer security. Use -.B fgets() +.BR fgets () instead. .PP It is not advisable to mix calls to input functions from the .B stdio library with low-level calls to -.B read() +.BR read () for the file descriptor associated with the input stream; the results will be undefined and very probably not what you want. .SH "SEE ALSO" diff --git a/man3/getservent.3 b/man3/getservent.3 index ece9afba..12dbe9e9 100644 --- a/man3/getservent.3 +++ b/man3/getservent.3 @@ -48,27 +48,27 @@ get service entry .B void endservent(void); .fi .SH DESCRIPTION -The \fBgetservent()\fP function reads the next line from the file +The \fBgetservent\fP() function reads the next line from the file \fI/etc/services\fP and returns a structure \fIservent\fP containing the broken out fields from the line. The \fI/etc/services\fP file is opened if necessary. .PP -The \fBgetservbyname()\fP function returns a \fIservent\fP structure +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. .PP -The \fBgetservbyport()\fP function returns a \fIservent\fP structure +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. .PP -The \fBsetservent()\fP function opens and rewinds the +The \fBsetservent\fP() function opens and rewinds the \fI/etc/services\fP file. If \fIstayopen\fP is true (1), then the -file will not be closed between calls to \fBgetservbyname()\fP and -\fBgetservbyport()\fP. +file will not be closed between calls to \fBgetservbyname\fP() and +\fBgetservbyport\fP(). .PP -The \fBendservent()\fP function closes \fI/etc/services\fP. +The \fBendservent\fP() function closes \fI/etc/services\fP. .PP The \fIservent\fP structure is defined in \fI<netdb.h>\fP as follows: .sp @@ -100,7 +100,7 @@ The port number for the service given in network byte order. .I s_proto The name of the protocol to use with this service. .SH "RETURN VALUE" -The \fBgetservent()\fP, \fBgetservbyname()\fP and \fBgetservbyport()\fP +The \fBgetservent\fP(), \fBgetservbyname\fP() and \fBgetservbyport\fP() functions return the \fIservent\fP structure, or a NULL pointer if an error occurs or the end of the file is reached. .SH FILES diff --git a/man3/getspnam.3 b/man3/getspnam.3 index 95aa3ac4..eef261a8 100644 --- a/man3/getspnam.3 +++ b/man3/getspnam.3 @@ -83,40 +83,40 @@ and .\" now describes the sources to be used. .LP The -.B getspnam() +.BR getspnam () function returns a pointer to a structure containing the broken-out fields of the record in the shadow password database that matches the user name .IR name . .LP The -.B getspent() +.BR getspent () function returns a pointer to the next entry in the shadow password database. The position in the input stream is initialized by -.BR setspent() . +.BR setspent (). When done reading, the program may call -.BR endspent() +.BR endspent () so that resources can be deallocated. .\" some systems require a call of setspent() before the first getspent() .\" glibc does not .LP The -.B fgetspent() +.BR fgetspent () function is similar to -.B getspent() +.BR getspent () but uses the supplied stream instead of the one implicitly opened by -.BR setspent() . +.BR setspent (). .LP The -.B sgetspent() +.BR sgetspent () function parses the supplied string .I s into a struct .IR spwd . .LP The -.B putspent() +.BR putspent () function writes the contents of the supplied struct .I spwd .RI * p @@ -126,17 +126,17 @@ String entries with value NULL and numerical entries with value \-1 are written as an empty string. .LP The -.B lckpwdf() +.BR lckpwdf () function is intended to protect against multiple simultaneous accesses of the shadow password database. It tries to acquire a lock, and returns 0 on success, or \-1 on failure (lock not obtained within 15 seconds). The -.B ulckpwdf() +.BR ulckpwdf () function releases the lock again. Note that there is no protection against direct access of the shadow password file. Only programs that use -.B lckpwdf() +.BR lckpwdf () will notice the lock. .LP These were the functions that formed the original shadow API. @@ -147,9 +147,9 @@ They are widely available. Analogous to the reentrant functions for the password database, glibc also has reentrant functions for the shadow password database. The -.B getspnam_r() +.BR getspnam_r () function is like -.B getspnam() +.BR getspnam () but stores the retrieved shadow password structure in the space pointed to by .IR spbuf . This shadow password structure contains pointers to strings, and these strings @@ -162,10 +162,10 @@ was found or an error occurred) is stored in .RI * spbufp . .LP The functions -.BR getspent_r() , -.BR fgetspent_r() , +.BR getspent_r (), +.BR fgetspent_r (), and -.BR sgetspent_r() +.BR sgetspent_r () are similarly analogous to their non-reentrant counterparts. .LP Some non-glibc systems also have functions with these names, diff --git a/man3/getumask.3 b/man3/getumask.3 index 78b37380..95ae08ce 100644 --- a/man3/getumask.3 +++ b/man3/getumask.3 @@ -46,7 +46,7 @@ mode_t getumask(void) { .RE except that it is documented to be thread-safe (that is, shares a lock with the -.I umask() +.IR umask () library call). .SH NOTES This function is documented but not implemented yet in glibc 2.2.5. diff --git a/man3/getusershell.3 b/man3/getusershell.3 index bf22bbfa..d6a113ba 100644 --- a/man3/getusershell.3 +++ b/man3/getusershell.3 @@ -39,17 +39,17 @@ getusershell, setusershell, endusershell \- get legal user shells .B void endusershell(void); .fi .SH DESCRIPTION -The \fBgetusershell()\fP function returns the next line from the file +The \fBgetusershell\fP() function returns the next line from the file \fI/etc/shells\fP, opening the file if necessary. The line should contain the pathname of a valid user shell. If \fI/etc/shells\fP does not exist or -is unreadable, \fBgetusershell()\fP behaves as if \fI/bin/sh\fP and +is unreadable, \fBgetusershell\fP() behaves as if \fI/bin/sh\fP and \fI/bin/csh\fP were listed in the file. .PP -The \fBsetusershell()\fP function rewinds \fI/etc/shells\fP. +The \fBsetusershell\fP() function rewinds \fI/etc/shells\fP. .PP -The \fBendusershell()\fP function closes \fI/etc/shells\fP. +The \fBendusershell\fP() function closes \fI/etc/shells\fP. .SH "RETURN VALUE" -The \fBgetusershell()\fP function returns a NULL pointer on end-of-file. +The \fBgetusershell\fP() function returns a NULL pointer on end-of-file. .SH FILES .nf /etc/shells diff --git a/man3/getutent.3 b/man3/getutent.3 index 7a636b5f..3c207736 100644 --- a/man3/getutent.3 +++ b/man3/getutent.3 @@ -159,11 +159,11 @@ int main(int argc, char *argv[]) .SH "CONFORMING TO" XPG 2, SVID 2, Linux FSSTND 1.2 .LP -In XPG2 and SVID2 the function \fIpututline()\fP is documented +In XPG2 and SVID2 the function \fIpututline\fP() is documented to return void, and that is what it does on many systems (AIX, HPUX, Linux libc5). -HPUX introduces a new function \fI_pututline()\fP with the prototype -given above for \fIpututline()\fP (also found in Linux libc5). +HPUX introduces a new function \fI_pututline\fP() with the prototype +given above for \fIpututline\fP() (also found in Linux libc5). .LP All these functions are obsolete now on non-Linux systems. POSIX 1003.1-2001, following XPG4.2, diff --git a/man3/glob.3 b/man3/glob.3 index 025c3bac..00d9070a 100644 --- a/man3/glob.3 +++ b/man3/glob.3 @@ -42,7 +42,7 @@ glob, globfree \- find pathnames matching a pattern, free memory from glob() .fi .SH DESCRIPTION The -.B glob() +.BR glob () function searches for all the pathnames matching .I pattern according to the rules used by the shell (see @@ -52,13 +52,13 @@ these, use .BR wordexp (3). .PP The -.B globfree() +.BR globfree () function frees the dynamically allocated storage from an earlier call to -.BR glob() . +.BR glob (). .PP The results of a -.B glob() +.BR glob () call are stored in the structure pointed to by .IR pglob , which is a @@ -87,7 +87,7 @@ The parameter .I flags is made up of bitwise OR of zero or more the following symbolic constants, which modify the of behaviour of -.BR glob() : +.BR glob (): .TP .B GLOB_ERR which means to return upon read error (because a directory does not @@ -111,7 +111,7 @@ which means that, if no pattern matches, to return the original pattern, .B GLOB_APPEND which means to append to the results of a previous call. Do not set this flag on the first invocation of -.BR glob() . +.BR glob (). .TP .B GLOB_NOESCAPE which means that meta characters cannot be quoted by backslashes. @@ -163,7 +163,7 @@ If returns non-zero, or if .B GLOB_ERR is set, -.B glob() +.BR glob () will terminate after the call to .IR errfunc . .PP @@ -176,7 +176,7 @@ the last pathname is .BR NULL . .PP It is possible to call -.B glob() +.BR glob () several times. In that case, the .B GLOB_APPEND flag has to be set in @@ -190,7 +190,7 @@ is set to the flags specified, \fBor\fRed with if any metacharacters were found. .SH "RETURN VALUE" On successful completion, -.B glob() +.BR glob () returns zero. Other possible returns are: .TP @@ -224,7 +224,7 @@ execvp("ls", &globbuf.gl_pathv[0]); POSIX.2 .SH BUGS The -.B glob() +.BR glob () function may fail due to failure of underlying function calls, such as .BR malloc() " or " opendir() . These will store their error code in diff --git a/man3/gsignal.3 b/man3/gsignal.3 index 60bc23c1..84a6a144 100644 --- a/man3/gsignal.3 +++ b/man3/gsignal.3 @@ -38,23 +38,23 @@ gsignal, ssignal \- software signal facility Don't use these functions under Linux. Due to a historical mistake, under Linux these functions are aliases for -.I raise() +.IR raise () and -.IR signal() , +.IR signal (), respectively. .LP Elsewhere, on SYSV-like systems, these functions implement software signalling, entirely independent of the classical signal and kill functions. The function -.B ssignal() +.BR ssignal () defines the action to take when the software signal with number .I signum is raised using the function -.BR gsignal() , +.BR gsignal (), and returns the previous such action or SIG_DFL. The function -.B gsignal() +.BR gsignal () does the following: if no action (or the action SIG_DFL) was specified for .IR signum , @@ -75,9 +75,9 @@ These functions are available under AIX, DG-UX, HPUX, SCO, Solaris, Tru64. They are called obsolete under most of these systems, and are broken under Linux libc and glibc. Some systems also have -.I gsignal_r() +.IR gsignal_r () and -.IR ssignal_r() . +.IR ssignal_r (). .SH "SEE ALSO" .BR kill (2), .BR signal (2), diff --git a/man3/hsearch.3 b/man3/hsearch.3 index bb6c791e..4c06a0e0 100644 --- a/man3/hsearch.3 +++ b/man3/hsearch.3 @@ -58,13 +58,13 @@ and allow the user to create a hash table (only one at a time) which associates a key with any data. .PP -First the table must be created with the function \fBhcreate()\fP. +First the table must be created with the function \fBhcreate\fP(). The argument \fInel\fP is an estimate of the maximum number of entries in the table. -The function \fBhcreate()\fP may adjust this value upward to improve the +The function \fBhcreate\fP() may adjust this value upward to improve the performance of the resulting hash table. .PP -The corresponding function \fBhdestroy()\fP frees the memory occupied by +The corresponding function \fBhdestroy\fP() frees the memory occupied by the hash table so that a new table can be constructed. .PP The argument \fIitem\fP is of type \fBENTRY\fP, which is a typedef defined in @@ -80,11 +80,11 @@ The argument \fIitem\fP is of type \fBENTRY\fP, which is a typedef defined in The field \fIkey\fP points to the NUL-terminated string which is the search key. The field \fIdata\fP points to the data associated with that key. -The function \fBhsearch()\fP searches the hash table for an +The function \fBhsearch\fP() searches the hash table for an item with the same key as \fIitem\fP (where "the same" is determined using .BR strcmp (3)), and if successful returns a pointer to it. -The argument \fIaction\fP determines what \fBhsearch()\fP does +The argument \fIaction\fP determines what \fBhsearch\fP() does after an unsuccessful search. A value of \fBENTER\fP instructs it to insert a copy of \fIitem\fP, while a value of \fBFIND\fP means to return \fBNULL\fP. @@ -96,16 +96,16 @@ The three functions are reentrant versions that allow the use of more than one table. The last argument used identifies the table. The struct it points to must be zeroed before the first call to -.BR hcreate_r() . +.BR hcreate_r (). .SH "RETURN VALUE" -\fBhcreate()\fP and \fBhcreate_r()\fP return 0 when allocation of the memory +\fBhcreate\fP() and \fBhcreate_r\fP() return 0 when allocation of the memory for the hash table fails, non-zero otherwise. .LP -\fBhsearch()\fP returns \fBNULL\fP if \fIaction\fP is \fBENTER\fP and +\fBhsearch\fP() returns \fBNULL\fP if \fIaction\fP is \fBENTER\fP and the hash table is full, or \fIaction\fP is \fBFIND\fP and \fIitem\fP cannot be found in the hash table. .LP -\fBhsearch_r()\fP returns 0 if \fIaction\fP is \fBENTER\fP and +\fBhsearch_r\fP() returns 0 if \fIaction\fP is \fBENTER\fP and the hash table is full, and non-zero otherwise. .SH ERRORS POSIX documents diff --git a/man3/hypot.3 b/man3/hypot.3 index e26ec30c..7afa7a68 100644 --- a/man3/hypot.3 +++ b/man3/hypot.3 @@ -45,7 +45,7 @@ hypot, hypotf, hypotl \- Euclidean distance function Link with \-lm. .SH DESCRIPTION The -.B hypot() +.BR hypot () function returns .RI sqrt( x * x + y * y ). This is the length of the hypotenuse of a right-angle triangle diff --git a/man3/ilogb.3 b/man3/ilogb.3 index ce375c32..3b25c322 100644 --- a/man3/ilogb.3 +++ b/man3/ilogb.3 @@ -39,7 +39,7 @@ Link with \-lm. These functions return the exponent part of their argument as a signed integer. When no error occurs, these functions are equivalent to the corresponding -.B logb() +.BR logb () functions, cast to (int). An error will occur for zero and infinity and NaN, and possibly for overflow. diff --git a/man3/index.3 b/man3/index.3 index 8b3e55a7..446befef 100644 --- a/man3/index.3 +++ b/man3/index.3 @@ -38,16 +38,16 @@ index, rindex \- locate character in string .BI "char *rindex(const char *" s ", int " c ); .fi .SH DESCRIPTION -The \fBindex()\fP function returns a pointer to the first occurrence +The \fBindex\fP() function returns a pointer to the first occurrence of the character \fIc\fP in the string \fIs\fP. .PP -The \fBrindex()\fP function returns a pointer to the last occurrence +The \fBrindex\fP() function returns a pointer to the last occurrence of the character \fIc\fP in the string \fIs\fP. .PP The terminating NULL character is considered to be a part of the strings. .SH "RETURN VALUE" -The \fBindex()\fP and \fBrindex()\fP functions return a pointer to +The \fBindex\fP() and \fBrindex\fP() functions return a pointer to the matched character or NULL if the character is not found. .SH "CONFORMING TO" 4.3BSD diff --git a/man3/inet.3 b/man3/inet.3 index 93e3ec30..d5d2ecaf 100644 --- a/man3/inet.3 +++ b/man3/inet.3 @@ -57,12 +57,12 @@ inet_netof \- Internet address manipulation routines .BI "in_addr_t inet_netof(struct in_addr " in ); .fi .SH DESCRIPTION -\fBinet_aton()\fP converts the Internet host address \fIcp\fP from the +\fBinet_aton\fP() converts the Internet host address \fIcp\fP from the standard numbers-and-dots notation into binary data and stores it in the structure that \fIinp\fP points to. \fBinet_aton\fP() returns non-zero if the address is valid, zero if not. .PP -The \fBinet_addr()\fP function converts the Internet host address +The \fBinet_addr\fP() function converts the Internet host address \fIcp\fP from numbers-and-dots notation into binary data in network byte order. If the input is invalid, INADDR_NONE (usually \-1) is returned. This is an \fIobsolete\fP interface to \fBinet_aton\fP(), described @@ -70,30 +70,30 @@ immediately above; it is obsolete because \-1 is a valid address (255.255.255.255), and \fBinet_aton\fP() provides a cleaner way to indicate error return. .PP -The \fBinet_network()\fP function extracts the network number in +The \fBinet_network\fP() function extracts the network number in host byte order from the address \fIcp\fP in numbers-and-dots notation. If the input is invalid, \-1 is returned. .PP -The \fBinet_ntoa()\fP function converts the Internet host address +The \fBinet_ntoa\fP() function converts the Internet host address \fIin\fP given in network byte order to a string in standard numbers-and-dots notation. The string is returned in a statically allocated buffer, which subsequent calls will overwrite. .PP -The \fBinet_makeaddr()\fP function makes an Internet host address +The \fBinet_makeaddr\fP() function makes an Internet host address in network byte order by combining the network number \fInet\fP with the local address \fIhost\fP in network \fInet\fP, both in local host byte order. .PP -The \fBinet_lnaof()\fP function returns the local host address part +The \fBinet_lnaof\fP() function returns the local host address part of the Internet address \fIin\fP. The local host address is returned in local host byte order. .PP -The \fBinet_netof()\fP function returns the network number part of +The \fBinet_netof\fP() function returns the network number part of the Internet Address \fIin\fP. The network number is returned in local host byte order. .PP -The structure \fIin_addr\fP as used in \fBinet_ntoa()\fP, -\fBinet_makeaddr()\fP, \fBinet_lnoaf()\fP and \fBinet_netof()\fP +The structure \fIin_addr\fP as used in \fBinet_ntoa\fP(), +\fBinet_makeaddr\fP(), \fBinet_lnoaf\fP() and \fBinet_netof\fP() is defined in \fInetinet/in.h\fP as: .sp .RS diff --git a/man3/infnan.3 b/man3/infnan.3 index e48b30d4..7c147b96 100644 --- a/man3/infnan.3 +++ b/man3/infnan.3 @@ -40,7 +40,7 @@ infnan \- deal with infinite or not-a-number (NaN) result .sp Link with \-lm. .SH DESCRIPTION -The \fBinfnan()\fP function returns a suitable value for infinity and +The \fBinfnan\fP() function returns a suitable value for infinity and "not-a-number" (NaN) results. The value of \fIerror\fP can be ERANGE to represent infinity or anything else to represent NaN. \fIerrno\fP is also set. diff --git a/man3/initgroups.3 b/man3/initgroups.3 index 94c958e5..d2397843 100644 --- a/man3/initgroups.3 +++ b/man3/initgroups.3 @@ -38,7 +38,7 @@ initgroups \- initialize the supplementary group access list .BI "int initgroups(const char *" user ", gid_t " group ); .fi .SH DESCRIPTION -The \fBinitgroups()\fP function initializes the group access list by +The \fBinitgroups\fP() function initializes the group access list by reading the group database \fI/etc/group\fP and using all groups of which \fIuser\fP is a member. The additional group \fIgroup\fP is also added to the list. @@ -47,7 +47,7 @@ The .I user argument must be non-NULL. .SH "RETURN VALUE" -The \fBinitgroups()\fP function returns 0 on success. +The \fBinitgroups\fP() function returns 0 on success. On error, \-1 is returned, and .I errno is set appropriately. diff --git a/man3/insque.3 b/man3/insque.3 index c3357543..88192b45 100644 --- a/man3/insque.3 +++ b/man3/insque.3 @@ -38,16 +38,16 @@ insque, remque \- insert/remove an item from a queue .BI "void insque(void *" elem ", void *" prev ); .BI "void remque(void *" elem ); .SH DESCRIPTION -\fBinsque()\fP and \fBremque()\fP are functions for manipulating +\fBinsque\fP() and \fBremque\fP() are functions for manipulating doubly-linked lists. Each element in the list is a structure of which the first two structure elements are a forward and a backward pointer. -\fBinsque()\fP inserts the element pointed to by \fIelem\fP +\fBinsque\fP() inserts the element pointed to by \fIelem\fP immediately after the element pointed to by \fIprev\fP, which must not be NULL. -\fBremque()\fP removes the element pointed to by \fIelem\fP from the +\fBremque\fP() removes the element pointed to by \fIelem\fP from the doubly-linked list. .SH "CONFORMING TO" POSIX 1003.1-2001 diff --git a/man3/isalpha.3 b/man3/isalpha.3 index 532d8428..12dfe81c 100644 --- a/man3/isalpha.3 +++ b/man3/isalpha.3 @@ -79,7 +79,7 @@ checks for an alphabetic character; in the standard \fB"C"\fP locale, it is equivalent to .BI "(isupper(" c ") || islower(" c "))" \fR. In some locales, there may be additional characters for which -.B isalpha() +.BR isalpha () is true\(emletters which are neither upper case nor lower case. .TP @@ -142,13 +142,13 @@ falls into the tested class, and a zero value if not. .SH "CONFORMING TO" ANSI-C, 4.3BSD. -\fBisascii()\fP is a BSD extension +\fBisascii\fP() is a BSD extension and is also an SVID extension. -\fBisblank()\fP conforms to ISO C99 7.4.1.3. +\fBisblank\fP() conforms to ISO C99 7.4.1.3. .SH NOTE The details of what characters belong into which class depend on the current locale. For example, -.B isupper() +.BR isupper () will not recognize an A-umlaut (\(:A) as an uppercase letter in the default .B "C" locale. @@ -76,23 +76,23 @@ y0, y0f, y0l, y1, y1f, y1l, yn, ynf, ynl \- Bessel functions .sp Link with \-lm. .SH DESCRIPTION -The \fBj0()\fP and \fBj1()\fP functions return Bessel functions of \fIx\fP -of the first kind of orders 0 and 1, respectively. The \fBjn()\fP function +The \fBj0\fP() and \fBj1\fP() functions return Bessel functions of \fIx\fP +of the first kind of orders 0 and 1, respectively. The \fBjn\fP() function returns the Bessel function of \fIx\fP of the first kind of order \fIn\fP. .PP -The \fBy0()\fP and \fBy1()\fP functions return Bessel functions of \fIx\fP -of the second kind of orders 0 and 1, respectively. The \fByn()\fP function +The \fBy0\fP() and \fBy1\fP() functions return Bessel functions of \fIx\fP +of the second kind of orders 0 and 1, respectively. The \fByn\fP() function returns the Bessel function of \fIx\fP of the second kind of order \fIn\fP. .PP -For the functions \fBy0()\fP, \fBy1()\fP and \fByn()\fP, the value of \fIx\fP +For the functions \fBy0\fP(), \fBy1\fP() and \fByn\fP(), the value of \fIx\fP must be positive. For negative values of \fIx\fP, these functions return \-HUGE_VAL. .PP -The \fBj0f()\fP etc. and \fBj0l()\fP etc. functions are versions that take +The \fBj0f\fP() etc. and \fBj0l\fP() etc. functions are versions that take and return float and long double values, respectively. .SH "CONFORMING TO" The functions returning double conform to SVID 3, 4.3BSD, XPG4, POSIX 1003.1-2001. .SH BUGS -There are errors of up to 2e\-16 in the values returned by \fBj0()\fP, -\fBj1()\fP and \fBjn()\fP for values of \fIx\fP between \-8 and 8. +There are errors of up to 2e\-16 in the values returned by \fBj0\fP(), +\fBj1\fP() and \fBjn\fP() for values of \fIx\fP between \-8 and 8. diff --git a/man3/killpg.3 b/man3/killpg.3 index ca9e69f1..446ada9f 100644 --- a/man3/killpg.3 +++ b/man3/killpg.3 @@ -34,7 +34,7 @@ killpg \- send signal to all members of a process group .fi .SH DESCRIPTION The -.B killpg() +.BR killpg () function causes signal .I signal to be sent to all the processes in the process group diff --git a/man3/ldexp.3 b/man3/ldexp.3 index bc8037f8..5760f225 100644 --- a/man3/ldexp.3 +++ b/man3/ldexp.3 @@ -44,7 +44,7 @@ ldexp, ldexpf, ldexpl \- multiply floating-point number by integral power of 2 Link with \-lm. .SH DESCRIPTION The -.B ldexp() +.BR ldexp () function returns the result of multiplying the floating-point number .I x by 2 raised to the power diff --git a/man3/lgamma.3 b/man3/lgamma.3 index 8660984d..49207086 100644 --- a/man3/lgamma.3 +++ b/man3/lgamma.3 @@ -27,7 +27,7 @@ Compile with \-std=c99; link with \-lm. For the definition of the Gamma function, see .BR tgamma (3). .PP -The \fBlgamma()\fP function returns the natural logarithm of +The \fBlgamma\fP() function returns the natural logarithm of the absolute value of the Gamma function. The sign of the Gamma function is returned in the external integer \fIsigngam\fP declared in @@ -37,13 +37,13 @@ when it is negative. .PP Since using a constant location .I signgam -is not thread-safe, the functions \fBlgamma_r()\fP etc. have +is not thread-safe, the functions \fBlgamma_r\fP() etc. have been introduced; they return this sign via the parameter .IR signp . .PP -For nonpositive integer values of \fIx\fP, \fBlgamma()\fP returns HUGE_VAL, +For nonpositive integer values of \fIx\fP, \fBlgamma\fP() returns HUGE_VAL, sets \fIerrno\fP to ERANGE and raises the zero divide exception. -(Similarly, \fBlgammaf()\fP returns HUGE_VALF and \fBlgammal()\fP returns +(Similarly, \fBlgammaf\fP() returns HUGE_VALF and \fBlgammal\fP() returns HUGE_VALL.) .SH ERRORS In order to check for errors, set diff --git a/man3/localeconv.3 b/man3/localeconv.3 index db11a414..256104aa 100644 --- a/man3/localeconv.3 +++ b/man3/localeconv.3 @@ -32,7 +32,7 @@ localeconv \- get numeric formatting information .fi .SH DESCRIPTION The -.B localeconv() +.BR localeconv () function returns a pointer to a .B struct lconv for the current locale. This structure is defined in the header-file @@ -42,15 +42,15 @@ and contains all values associated with the locale categories and .BR LC_MONETARY . Programs may also use the functions -.B printf() +.BR printf () and -.B strfmon() +.BR strfmon () that behave according the actual locale in use. .SH "CONFORMING TO" ANSI C, POSIX.1 .SH BUGS The -.B printf() +.BR printf () family of functions may or may not honor the current locale. .SH "SEE ALSO" .BR locale (1), @@ -45,9 +45,9 @@ log, logf, logl \- natural logarithmic function .sp Link with \-lm. .SH DESCRIPTION -The \fBlog()\fP function returns the natural logarithm of \fIx\fP. +The \fBlog\fP() function returns the natural logarithm of \fIx\fP. .SH ERRORS -The \fBlog()\fP function can return the following errors: +The \fBlog\fP() function can return the following errors: .TP .B EDOM The argument \fIx\fP is negative. diff --git a/man3/log10.3 b/man3/log10.3 index 6d9dff26..b558d6ee 100644 --- a/man3/log10.3 +++ b/man3/log10.3 @@ -45,9 +45,9 @@ log10, log10f, log10l \- base-10 logarithmic function .sp Link with \-lm. .SH DESCRIPTION -The \fBlog10()\fP function returns the base 10 logarithm of \fIx\fP. +The \fBlog10\fP() function returns the base 10 logarithm of \fIx\fP. .SH ERRORS -The \fBlog10()\fP function can return the following errors: +The \fBlog10\fP() function can return the following errors: .TP .B EDOM The argument \fIx\fP is negative. diff --git a/man3/log2.3 b/man3/log2.3 index 43f1742a..fa3c144b 100644 --- a/man3/log2.3 +++ b/man3/log2.3 @@ -45,9 +45,9 @@ log2, log2f, log2l \- base-2 logarithmic function .sp Compile with \-std=c99; link with \-lm. .SH DESCRIPTION -The \fBlog2()\fP function returns the base 2 logarithm of \fIx\fP. +The \fBlog2\fP() function returns the base 2 logarithm of \fIx\fP. .SH ERRORS -The \fBlog2()\fP function can return the following error: +The \fBlog2\fP() function can return the following error: .TP .B EDOM The argument \fIx\fP is negative. diff --git a/man3/logb.3 b/man3/logb.3 index ea203134..49be7511 100644 --- a/man3/logb.3 +++ b/man3/logb.3 @@ -49,7 +49,7 @@ except it's probably faster. If .I x is de-normalized, -.B logb() +.BR logb () returns the exponent .I x would have if it were normalized. diff --git a/man3/longjmp.3 b/man3/longjmp.3 index 35a1a248..6b006ea0 100644 --- a/man3/longjmp.3 +++ b/man3/longjmp.3 @@ -36,18 +36,18 @@ longjmp, siglongjmp \- non-local jump to a saved stack context .fi .ad b .SH DESCRIPTION -\fBlongjmp()\fP and \fBsetjmp()\fP are useful for dealing with errors +\fBlongjmp\fP() and \fBsetjmp\fP() are useful for dealing with errors and interrupts encountered in a low-level subroutine of a program. -\fBlongjmp()\fP restores the environment saved by the last call of -\fBsetjmp()\fP with the corresponding \fIenv\fP argument. After -\fBlongjmp()\fP is completed, program execution continues as if the -corresponding call of \fBsetjmp()\fP had just returned the value -\fIval\fP. \fBlongjmp()\fP cannot cause 0 to be returned. If longjmp +\fBlongjmp\fP() restores the environment saved by the last call of +\fBsetjmp\fP() with the corresponding \fIenv\fP argument. After +\fBlongjmp\fP() is completed, program execution continues as if the +corresponding call of \fBsetjmp\fP() had just returned the value +\fIval\fP. \fBlongjmp\fP() cannot cause 0 to be returned. If longjmp is invoked with a second argument of 0, 1 will be returned instead. .P -\fBsiglongjmp()\fP is similar to \fBlongjmp()\fP except for the type of -its \fIenv\fP argument. If the \fBsigsetjmp()\fP call that set this -\fIenv\fP used a non-zero \fIsavesigs\fP flag, \fBsiglongjmp()\fP also +\fBsiglongjmp\fP() is similar to \fBlongjmp\fP() except for the type of +its \fIenv\fP argument. If the \fBsigsetjmp\fP() call that set this +\fIenv\fP used a non-zero \fIsavesigs\fP flag, \fBsiglongjmp\fP() also restores the set of blocked signals. .SH "RETURN VALUE" These functions never return. @@ -58,7 +58,7 @@ POSIX does not specify whether \fBlongjmp\fP() will restore the signal context. If you want to save and restore signal masks, use \fBsiglongjmp\fP(). .P -\fBlongjmp()\fP and \fBsiglongjmp()\fP make programs hard to +\fBlongjmp\fP() and \fBsiglongjmp\fP() make programs hard to understand and maintain. If possible an alternative should be used. .SH "SEE ALSO" .BR setjmp (3), diff --git a/man3/lsearch.3 b/man3/lsearch.3 index b09def99..71b26783 100644 --- a/man3/lsearch.3 +++ b/man3/lsearch.3 @@ -40,7 +40,7 @@ lfind, lsearch \- linear search of an array .RE .fi .SH DESCRIPTION -\fBlfind()\fP and \fBlsearch()\fP perform a linear search for +\fBlfind\fP() and \fBlsearch\fP() perform a linear search for \fIkey\fP in the array \fIbase\fP which has *\fInmemb\fP elements of \fIsize\fP bytes each. The comparison function referenced by \fIcompar\fP is expected to have two arguments which point to the @@ -48,14 +48,14 @@ lfind, lsearch \- linear search of an array returns zero if the \fIkey\fP object matches the array member, and non-zero otherwise. .PP -If \fBlsearch()\fP does not find a matching element, then the \fIkey\fP +If \fBlsearch\fP() does not find a matching element, then the \fIkey\fP object is inserted at the end of the table, and *\fInmemb\fP is incremented. In particular, one should know that a matching element exists, or that more room is available. .SH "RETURN VALUE" -\fBlfind()\fP returns a pointer to a matching member of the array, or -\fBNULL\fP if no match is found. \fBlsearch()\fP returns a pointer to +\fBlfind\fP() returns a pointer to a matching member of the array, or +\fBNULL\fP if no match is found. \fBlsearch\fP() returns a pointer to a matching member of the array, or to the newly added member if no match is found. .SH "CONFORMING TO" diff --git a/man3/lseek64.3 b/man3/lseek64.3 index 429d2fab..89f41f72 100644 --- a/man3/lseek64.3 +++ b/man3/lseek64.3 @@ -53,11 +53,11 @@ For more details, return value, and errors, see .BR lseek (2). .PP Four interfaces are available: -.IR lseek() , -.IR lseek64() , -.IR llseek() , +.IR lseek (), +.IR lseek64 (), +.IR llseek (), and the raw system call -.IR _llseek() . +.IR _llseek (). .SS lseek Prototype: .nf @@ -68,7 +68,7 @@ Prototype: .fi .sp The library routine -.I lseek() +.IR lseek () uses the type .BR off_t . This is a 32-bit signed type on 32-bit architectures, unless one @@ -92,7 +92,7 @@ Prototype: .fi .sp The library routine -.I lseek64() +.IR lseek64 () uses a 64-bit type even when .B off_t is a 32-bit type. Its prototype (and the type @@ -106,10 +106,10 @@ is available only when one compiles with .sp .fi The function -.I lseek64() +.IR lseek64 () .\" in glibc 2.0.94, not in 2.0.6 is available since glibc 2.1, and is defined to be an alias for -.IR llseek() . +.IR llseek (). .SS llseek Prototype: @@ -124,7 +124,7 @@ The type .B loff_t is a 64-bit signed type. The library routine -.I llseek() +.IR llseek () .\" in libc 5.0.9, not in 4.7.6 is available in libc5 and glibc and works without special defines. Its prototype was given in diff --git a/man3/makecontext.3 b/man3/makecontext.3 index f6d9e90b..a7548c0a 100644 --- a/man3/makecontext.3 +++ b/man3/makecontext.3 @@ -34,33 +34,33 @@ makecontext, swapcontext \- manipulate user context In a SysV-like environment, one has the type \fBucontext_t\fP defined in .I <ucontext.h> and the four functions -\fBgetcontext()\fP, \fBsetcontext()\fP, \fBmakecontext()\fP -and \fBswapcontext()\fP that allow user-level context switching +\fBgetcontext\fP(), \fBsetcontext\fP(), \fBmakecontext\fP() +and \fBswapcontext\fP() that allow user-level context switching between multiple threads of control within a process. .LP For the type and the first two functions, see .BR getcontext (2). .LP -The \fBmakecontext()\fP function modifies the context pointed to -by \fIucp\fP (which was obtained from a call to \fBgetcontext()\fP). -Before calling \fBmakecontext()\fP, one should allocate a new stack +The \fBmakecontext\fP() function modifies the context pointed to +by \fIucp\fP (which was obtained from a call to \fBgetcontext\fP()). +Before calling \fBmakecontext\fP(), one should allocate a new stack for this context, assigning to \fIucp->uc_stack\fP, and define a successor context, assigning to \fIucp->uc_link\fP. -When this context is later activated (using \fBsetcontext()\fP or -\fBswapcontext()\fP) then first the function \fIfunc\fP is called, +When this context is later activated (using \fBsetcontext\fP() or +\fBswapcontext\fP()) then first the function \fIfunc\fP is called, with the arguments specified following \fIargc\fP (where \fIargc\fP must contain the number of these arguments), and when this function returns, the successor context is activated. When the successor context pointer is NULL, the thread exits. .LP -The \fBswapcontext()\fP function saves the current context in +The \fBswapcontext\fP() function saves the current context in the structure pointed to by \fIoucp\fP, and then activates the context pointed to by \fIucp\fP. .SH "RETURN VALUE" -When successful, \fBswapcontext()\fP +When successful, \fBswapcontext\fP() does not return. (But we may return later, in case \fIoucp\fP is -activated, in which case it looks like \fBswapcontext()\fP returns 0.) -On error, \fBswapcontext()\fP returns \-1 and +activated, in which case it looks like \fBswapcontext\fP() returns 0.) +On error, \fBswapcontext\fP() returns \-1 and sets \-1 \fIerrno\fP appropriately. .SH ERRORS .TP diff --git a/man3/malloc.3 b/man3/malloc.3 index 078b9b3e..85b2c332 100644 --- a/man3/malloc.3 +++ b/man3/malloc.3 @@ -40,7 +40,7 @@ calloc, malloc, free, realloc \- Allocate and free dynamic memory .BI "void *realloc(void " "*ptr" ", size_t " "size" ); .fi .SH DESCRIPTION -.B calloc() +.BR calloc () allocates memory for an array of .I nmemb elements of @@ -48,20 +48,20 @@ elements of bytes each and returns a pointer to the allocated memory. The memory is set to zero. .PP -.B malloc() +.BR malloc () allocates .I size bytes and returns a pointer to the allocated memory. The memory is not cleared. .PP -.B free() +.BR free () frees the memory space pointed to by .IR ptr , which must have been returned by a previous call to -.BR malloc() , -.B calloc() +.BR malloc (), +.BR calloc () or -.BR realloc() . +.BR realloc (). Otherwise, or if .BI "free(" "ptr" ) has already been called before, undefined behaviour occurs. @@ -71,7 +71,7 @@ is .BR NULL , no operation is performed. .PP -.B realloc() +.BR realloc () changes the size of the memory block pointed to by .I ptr to @@ -93,10 +93,10 @@ Unless is .BR NULL , it must have been returned by an earlier call to -.BR malloc() , -.BR calloc() +.BR malloc (), +.BR calloc () or -.BR realloc() . +.BR realloc (). If the area pointed to was moved, a .BI "free(" "ptr" ) is done. @@ -108,10 +108,10 @@ aligned for any kind of variable, or .B NULL if the request fails. .PP -.B free() +.BR free () returns no value. .PP -.B realloc() +.BR realloc () returns a pointer to the newly allocated memory, which is suitably aligned for any kind of variable and may be different from .IR ptr , @@ -122,7 +122,7 @@ if the request fails. If was equal to 0, either NULL or a pointer suitable to be passed to .IR free () is returned. If -.B realloc() +.BR realloc () fails the original block is left untouched; it is not freed or moved. .SH "CONFORMING TO" ANSI-C @@ -131,8 +131,8 @@ ANSI-C .BR posix_memalign (3) .SH NOTES The Unix98 standard requires -.BR malloc() , -.BR calloc() , +.BR malloc (), +.BR calloc (), and .BR realloc () to set @@ -146,10 +146,10 @@ a reason in .IR errno . .LP Crashes in -.BR malloc() , -.BR free() +.BR malloc (), +.BR free () or -.BR realloc() +.BR realloc () are almost always related to heap corruption, such as overflowing an allocated chunk or freeing the same pointer twice. .PP @@ -160,7 +160,7 @@ variables. When is set, a special (less efficient) implementation is used which is designed to be tolerant against simple errors, such as double calls of -.BR free() +.BR free () with the same argument, or overruns of a single byte (off-by-one bugs). Not all such errors can be protected against, however, and memory leaks can result. @@ -169,14 +169,14 @@ If is set to 0, any detected heap corruption is silently ignored; if set to 1, a diagnostic is printed on stderr; if set to 2, -.BR abort() +.BR abort () is called immediately. This can be useful because otherwise a crash may happen much later, and the true cause for the problem is then very hard to track down. .SH BUGS By default, Linux follows an optimistic memory allocation strategy. This means that when -.B malloc() +.BR malloc () returns non-NULL there is no guarantee that the memory really is available. This is a really bad bug. In case it turns out that the system is out of memory, diff --git a/man3/memccpy.3 b/man3/memccpy.3 index 8b0cf5d3..a0a42006 100644 --- a/man3/memccpy.3 +++ b/man3/memccpy.3 @@ -35,11 +35,11 @@ memccpy \- copy memory area .BI "void *memccpy(void *" dest ", const void *" src ", int " c ", size_t " n ); .fi .SH DESCRIPTION -The \fBmemccpy()\fP function copies no more than \fIn\fP bytes from +The \fBmemccpy\fP() function copies no more than \fIn\fP bytes from memory area \fIsrc\fP to memory area \fIdest\fP, stopping when the character \fIc\fP is found. .SH "RETURN VALUE" -The \fBmemccpy()\fP function returns a pointer to the next character +The \fBmemccpy\fP() function returns a pointer to the next character in \fIdest\fP after \fIc\fP, or NULL if \fIc\fP was not found in the first \fIn\fP characters of \fIsrc\fP. .SH "CONFORMING TO" diff --git a/man3/memchr.3 b/man3/memchr.3 index deb766ae..20625872 100644 --- a/man3/memchr.3 +++ b/man3/memchr.3 @@ -37,28 +37,28 @@ memchr, memrchr \- scan memory for a character .fi .SH DESCRIPTION The -.B memchr() +.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 match \fIc\fP (interpreted as an unsigned character) stops the operation. .PP The -.B memrchr() +.BR memrchr () function is like the -.B memchr() +.BR memchr () function, except that it searches backwards from the end of the \fIn\fP bytes pointed to by \fIs\fP instead of forwards from the front. .SH "RETURN VALUE" -The \fBmemchr()\fP and \fBmemrchr()\fP functions return a pointer +The \fBmemchr\fP() and \fBmemrchr\fP() functions return a pointer to the matching byte or NULL if the character does not occur in the given memory area. .SH "CONFORMING TO" The -.B memchr() +.BR memchr () function conforms to SVID 3, 4.3BSD, ISO 9899, POSIX. The -.B memrchr() +.BR memrchr () function is a GNU extension, available since glibc 2.1.91. .SH "SEE ALSO" .BR index (3), diff --git a/man3/memcmp.3 b/man3/memcmp.3 index 5e3b0337..7416fc2e 100644 --- a/man3/memcmp.3 +++ b/man3/memcmp.3 @@ -35,12 +35,12 @@ memcmp \- compare memory areas .BI "int memcmp(const void *" s1 ", const void *" s2 ", size_t " n ); .fi .SH DESCRIPTION -The \fBmemcmp()\fP function compares the first \fIn\fP bytes of the +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, 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" -The \fBmemcmp()\fP function returns an integer less than, equal to, or +The \fBmemcmp\fP() function returns an integer less than, equal to, or greater than zero if the first \fIn\fP bytes of \fIs1\fP is found, respectively, to be less than, to match, or be greater than the first \fIn\fP bytes of \fIs2\fP. diff --git a/man3/memcpy.3 b/man3/memcpy.3 index 671ee4b8..35fa148f 100644 --- a/man3/memcpy.3 +++ b/man3/memcpy.3 @@ -35,11 +35,11 @@ memcpy \- copy memory area .BI "void *memcpy(void *" dest ", const void *" src ", size_t " n ); .fi .SH DESCRIPTION -The \fBmemcpy()\fP function copies \fIn\fP bytes from memory area +The \fBmemcpy\fP() function copies \fIn\fP bytes from memory area \fIsrc\fP to memory area \fIdest\fP. The memory areas should not overlap. Use \fBmemmove\fP(3) if the memory areas do overlap. .SH "RETURN VALUE" -The \fBmemcpy()\fP function returns a pointer to \fIdest\fP. +The \fBmemcpy\fP() function returns a pointer to \fIdest\fP. .SH "CONFORMING TO" SVID 3, 4.3BSD, ISO 9899 .SH "SEE ALSO" diff --git a/man3/memfrob.3 b/man3/memfrob.3 index d8643433..8fd7586d 100644 --- a/man3/memfrob.3 +++ b/man3/memfrob.3 @@ -35,18 +35,18 @@ memfrob \- frobnicate (encrypt) a memory area .BI "void *memfrob(void *" s ", size_t " n ); .fi .SH DESCRIPTION -The \fBmemfrob()\fP function encrypts the first \fIn\fP bytes of the +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 constant is fixed, and is only suitable for hiding strings. .SH "RETURN VALUE" -The \fBmemfrob()\fP function returns a pointer to the encrypted memory +The \fBmemfrob\fP() function returns a pointer to the encrypted memory area. .SH "CONFORMING TO" -The \fBmemfrob()\fP function is unique to the Linux C Library and +The \fBmemfrob\fP() function is unique to the Linux C Library and GNU C Library. .SH "SEE ALSO" .BR strfry (3) diff --git a/man3/memmem.3 b/man3/memmem.3 index 3cfa2127..b12153c7 100644 --- a/man3/memmem.3 +++ b/man3/memmem.3 @@ -40,11 +40,11 @@ memmem \- locate a substring .in .fi .SH DESCRIPTION -The \fBmemmem()\fP function finds the start of the first occurrence +The \fBmemmem\fP() function finds the start of the first occurrence of the substring \fIneedle\fP of length \fIneedlelen\fP in the memory area \fIhaystack\fP of length \fIhaystacklen\fP. .SH "RETURN VALUE" -The \fBmemmem()\fP function returns a pointer to the beginning of the +The \fBmemmem\fP() function returns a pointer to the beginning of the substring, or NULL if the substring is not found. .SH "CONFORMING TO" This function is a GNU extension. diff --git a/man3/memmove.3 b/man3/memmove.3 index 5abe75f8..e4c1540c 100644 --- a/man3/memmove.3 +++ b/man3/memmove.3 @@ -35,10 +35,10 @@ memmove \- copy memory area .BI "void *memmove(void *" dest ", const void *" src ", size_t " n ); .fi .SH DESCRIPTION -The \fBmemmove()\fP function copies \fIn\fP bytes from memory area +The \fBmemmove\fP() function copies \fIn\fP bytes from memory area \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. +The \fBmemmove\fP() function returns a pointer to \fIdest\fP. .SH "CONFORMING TO" SVID 3, 4.3BSD, ISO 9899 .SH "SEE ALSO" diff --git a/man3/mempcpy.3 b/man3/mempcpy.3 index 0203f475..212f10d4 100644 --- a/man3/mempcpy.3 +++ b/man3/mempcpy.3 @@ -22,9 +22,9 @@ mempcpy, wmempcpy \- copy memory area .fi .SH DESCRIPTION The -.B mempcpy() +.BR mempcpy () function is nearly identical to the -.B memcpy() +.BR memcpy () function. It copies .I n bytes from the object beginning at @@ -39,7 +39,7 @@ This function is useful in situations where a number of objects shall be copied to consecutive memory positions. .PP The -.B wmempcpy() +.BR wmempcpy () function is identical but takes .I wchar_t type arguments and copies diff --git a/man3/memset.3 b/man3/memset.3 index d1448440..2fef123c 100644 --- a/man3/memset.3 +++ b/man3/memset.3 @@ -35,10 +35,10 @@ memset \- fill memory with a constant byte .BI "void *memset(void *" s ", int " c ", size_t " n ); .fi .SH DESCRIPTION -The \fBmemset()\fP function fills the first \fIn\fP bytes of the +The \fBmemset\fP() function fills the first \fIn\fP bytes of the memory area pointed to by \fIs\fP with the constant byte \fIc\fP. .SH "RETURN VALUE" -The \fBmemset()\fP function returns a pointer to the memory area +The \fBmemset\fP() function returns a pointer to the memory area \fIs\fP. .SH "CONFORMING TO" SVID 3, 4.3BSD, ISO 9899 diff --git a/man3/mkdtemp.3 b/man3/mkdtemp.3 index 66505422..9b002358 100644 --- a/man3/mkdtemp.3 +++ b/man3/mkdtemp.3 @@ -31,7 +31,7 @@ mkdtemp \- create a unique temporary directory .BI "char *mkdtemp(char *" template ); .fi .SH DESCRIPTION -The \fBmkdtemp()\fP function generates a uniquely-named temporary +The \fBmkdtemp\fP() function generates a uniquely-named temporary directory from \fItemplate\fP. The last six characters of \fItemplate\fP must be XXXXXX and these are replaced with a string that makes the .\" FIXME: were the permissions 0700 in all glibc versions ? @@ -41,7 +41,7 @@ Since it will be modified, .I template must not be a string constant, but should be declared as a character array. .SH "RETURN VALUE" -The \fBmkdtemp()\fP function returns a pointer to the modified template +The \fBmkdtemp\fP() function returns a pointer to the modified template string on success, and \fBNULL\fP on failure, in which case .IR errno is set appropriately. diff --git a/man3/mkstemp.3 b/man3/mkstemp.3 index cfc1801f..a28588d5 100644 --- a/man3/mkstemp.3 +++ b/man3/mkstemp.3 @@ -38,7 +38,7 @@ mkstemp \- create a unique temporary file .BI "int mkstemp(char *" template ); .fi .SH DESCRIPTION -The \fBmkstemp()\fP function generates a unique temporary file name +The \fBmkstemp\fP() function generates a unique temporary file name 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 @@ -50,7 +50,7 @@ The file is opened with the O_EXCL flag, guaranteeing that when .BR mkstemp () returns successfully we are the only user. .SH "RETURN VALUE" -On success, the \fBmkstemp()\fP function returns the file descriptor +On success, the \fBmkstemp\fP() function returns the file descriptor of the temporary file. On error, \-1 is returned, and .I errno diff --git a/man3/mktemp.3 b/man3/mktemp.3 index 1d781e70..99ba67aa 100644 --- a/man3/mktemp.3 +++ b/man3/mktemp.3 @@ -39,14 +39,14 @@ mktemp \- make a unique temporary file name .BI "char *mktemp(char *" template ); .fi .SH DESCRIPTION -The \fBmktemp()\fP function generates a unique temporary file name +The \fBmktemp\fP() function generates a unique temporary file name 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, .I template must not be a string constant, but should be declared as a character array. .SH "RETURN VALUE" -The \fBmktemp()\fP function returns NULL on error (\fItemplate\fP did not +The \fBmktemp\fP() function returns NULL on error (\fItemplate\fP did not end in XXXXXX) and \fItemplate\fP otherwise. If the call was successful, the last six bytes of \fItemplate\fP will have been modified in such a way that the resulting name is unique @@ -67,12 +67,12 @@ for libc4, libc5, glibc1; glibc2 follows the Single Unix Specification and has the prototype in .IR <stdlib.h> . .SH BUGS -Never use \fBmktemp()\fP. Some implementations follow 4.3BSD +Never use \fBmktemp\fP(). Some implementations follow 4.3BSD and replace XXXXXX by the current process ID and a single letter, so that at most 26 different names can be returned. Since on the one hand the names are easy to guess, and on the other hand there is a race between testing whether the name exists and -opening the file, every use of \fBmktemp()\fP is a security risk. +opening the file, every use of \fBmktemp\fP() is a security risk. The race is avoided by .BR mkstemp (3). .SH "SEE ALSO" diff --git a/man3/modf.3 b/man3/modf.3 index 97a9b822..6c125572 100644 --- a/man3/modf.3 +++ b/man3/modf.3 @@ -45,11 +45,11 @@ number .sp Link with \-lm. .SH DESCRIPTION -The \fBmodf()\fP function breaks the argument \fIx\fP into an integral +The \fBmodf\fP() function breaks the argument \fIx\fP into an integral part and a fractional part, each of which has the same sign as \fIx\fP. The integral part is stored in \fIiptr\fP. .SH "RETURN VALUE" -The \fBmodf()\fP function returns the fractional part of \fIx\fP. +The \fBmodf\fP() function returns the fractional part of \fIx\fP. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899. The float and the long double variants are C99 requirements. diff --git a/man3/nextafter.3 b/man3/nextafter.3 index 40baea4e..3a23ceab 100644 --- a/man3/nextafter.3 +++ b/man3/nextafter.3 @@ -22,7 +22,7 @@ nextafter, nextafterf, nextafterl, nexttoward, nexttowardf, nexttowardl \- float Link with \-lm. .SH DESCRIPTION The -.B nextafter() +.BR nextafter () functions return the next representable neighbor of \fIx\fP in the direction towards \fIy\fP. The size of the step between \fIx\fP and the result depends on the type of the result. @@ -36,9 +36,9 @@ least significant bit in the mantissa is added or subtracted, depending on the direction. .PP The -.B nexttoward() +.BR nexttoward () functions do the same as the -.B nextafter() +.BR nextafter () functions, except that they have a long double second argument. .PP These functions will signal overflow or underflow if the result diff --git a/man3/opendir.3 b/man3/opendir.3 index 7cefc4f4..5992b596 100644 --- a/man3/opendir.3 +++ b/man3/opendir.3 @@ -38,11 +38,11 @@ opendir \- open a directory .BI "DIR *opendir(const char *" name ); .fi .SH DESCRIPTION -The \fBopendir()\fP function opens a directory stream corresponding to the +The \fBopendir\fP() function opens a directory stream corresponding to the directory \fIname\fP, and returns a pointer to the directory stream. The stream is positioned at the first entry in the directory. .SH "RETURN VALUE" -The \fBopendir()\fP function returns a pointer to the directory stream. +The \fBopendir\fP() function returns a pointer to the directory stream. On error, NULL is returned, and .I errno is set appropriately. diff --git a/man3/openpty.3 b/man3/openpty.3 index 81b9932a..a4c1a38d 100644 --- a/man3/openpty.3 +++ b/man3/openpty.3 @@ -48,7 +48,7 @@ openpty, login_tty, forkpty \- tty utility functions Link with \-lutil. .SH DESCRIPTION The -.B openpty() +.BR openpty () function finds an available pseudo-terminal and returns file descriptors for the master and slave in .I amaster @@ -69,12 +69,12 @@ is not NULL, the window size of the slave will be set to the values in .IR winp . The -.B login_tty() +.BR login_tty () function prepares for a login on the tty .I fd (which may be a real tty device, or the slave of a pseudo-terminal as returned by -.BR openpty() ) +.BR openpty ()) by creating a new session, making .I fd the controlling terminal for the current process, setting @@ -84,12 +84,12 @@ process, and closing .IR fd . The -.B forkpty() +.BR forkpty () function combines -.BR openpty() , -.BR fork() , +.BR openpty (), +.BR fork (), and -.B login_tty() +.BR login_tty () to create a new process operating in a pseudo-terminal. The file descriptor of the master side of the pseudo-terminal is returned in .IR amaster , @@ -104,39 +104,39 @@ will determine the terminal attributes and window size of the slave side of the pseudo-terminal. .SH "RETURN VALUES" If a call to -.BR openpty() , -.BR login_tty() , +.BR openpty (), +.BR login_tty (), or -.B forkpty() +.BR forkpty () is not successful, \-1 is returned and .I errno is set to indicate the error. Otherwise, -.BR openpty() , -.BR login_tty() , +.BR openpty (), +.BR login_tty (), and the child process of -.B forkpty() +.BR forkpty () return 0, and the parent process of -.B forkpty() +.BR forkpty () returns the process ID of the child process. .SH ERRORS -.B openpty() +.BR openpty () will fail if: .TP .B ENOENT There are no available ttys. .LP -.B login_pty() +.BR login_pty () will fail if -.B ioctl() +.BR ioctl () fails to set .I fd to the controlling terminal of the current process. .LP -.B forkpty() +.BR forkpty () will fail if either -.B openpty() +.BR openpty () or -.B fork() +.BR fork () fails. .SH NOTE These functions are included in libutil, hence you'll need to add @@ -150,9 +150,9 @@ These are BSD functions, present in libc5 and glibc2. Nobody knows how much space should be reserved for .IR name . So, calling -.B openpty() +.BR openpty () or -.B forkpty() +.BR forkpty () with non-NULL .I name may not be secure. diff --git a/man3/perror.3 b/man3/perror.3 index c21138f6..5e69970f 100644 --- a/man3/perror.3 +++ b/man3/perror.3 @@ -44,7 +44,7 @@ perror \- print a system error message .BI "int " errno ; .SH DESCRIPTION The routine -.B perror() +.BR perror () produces a message on the standard error output, describing the last error encountered during a call to a system or library function. First (if @@ -81,7 +81,7 @@ to a value describing what went wrong. (These values can be found in .IR "<errno.h>" .) Many library functions do likewise. The function -.B perror() +.BR perror () serves to translate this error code into human-readable form. Note that .I errno @@ -96,7 +96,7 @@ should be saved. .SH "CONFORMING TO" The function -.B perror() +.BR perror () and the external .I errno (see diff --git a/man3/popen.3 b/man3/popen.3 index b89180bc..680b2a2f 100644 --- a/man3/popen.3 +++ b/man3/popen.3 @@ -46,7 +46,7 @@ popen, pclose \- process I/O .BI "int pclose(FILE *" stream ); .SH DESCRIPTION The -.B popen() +.BR popen () function opens a process by creating a pipe, forking, and invoking the shell. Since a pipe is by definition unidirectional, the .I type @@ -66,15 +66,15 @@ argument is a pointer to a null-terminated string which must be either `r' for reading or `w' for writing. .PP The return value from -.B popen() +.BR popen () is a normal standard I/O stream in all respects save that it must be closed with -.B pclose() +.BR pclose () rather than -.BR fclose() . +.BR fclose (). Writing to such a stream writes to the standard input of the command; the command's standard output is the same as that of the process that called -.BR popen() , +.BR popen (), unless this is altered by the command itself. Conversely, reading from a ``popened'' stream reads the command's standard output, and the command's standard input is the same as that of the process that called @@ -128,7 +128,7 @@ is set to .BR EINVAL . .PP If -.B pclose() +.BR pclose () cannot obtain the child status, .I errno is set to @@ -138,7 +138,7 @@ POSIX.2 .SH BUGS Since the standard input of a command opened for reading shares its seek offset with the process that called -.BR popen() , +.BR popen (), if the original process has done a buffered read, the command's input position may not be as expected. Similarly, the output from a command opened for writing may become intermingled with that of the original @@ -152,9 +152,9 @@ to execute command, or an immediate exit of the command. The only hint is an exit status of 127. .SH HISTORY A -.B popen() +.BR popen () and a -.B pclose() +.BR pclose () function appeared in Version 7 AT&T UNIX. .SH "SEE ALSO" .BR sh (1), diff --git a/man3/posix_memalign.3 b/man3/posix_memalign.3 index ac20f9cc..becde50e 100644 --- a/man3/posix_memalign.3 +++ b/man3/posix_memalign.3 @@ -41,7 +41,7 @@ posix_memalign, memalign, valloc \- Allocate aligned memory .fi .SH DESCRIPTION The function -.B posix_memalign() +.BR posix_memalign () allocates .I size bytes and places the address of the allocated memory in @@ -52,7 +52,7 @@ which must be a power of two and a multiple of .IR "sizeof(void *)". The obsolete function -.B memalign() +.BR memalign () allocates .I size bytes and returns a pointer to the allocated memory. @@ -61,7 +61,7 @@ The memory address will be a multiple of which must be a power of two. The obsolete function -.B valloc() +.BR valloc () allocates .I size bytes and returns a pointer to the allocated memory. @@ -72,14 +72,14 @@ It is equivalent to For all three routines, the memory is not zeroed. .SH "RETURN VALUE" -.BR memalign() +.BR memalign () and -.BR valloc() +.BR valloc () return the pointer to the allocated memory, or .B NULL if the request fails. -.BR posix_memalign() +.BR posix_memalign () returns zero on success, or one of the error values listed in the next section on failure. Note that .IR errno @@ -108,13 +108,13 @@ to satisfy this requirement. verifies that .IR alignment matches the requirements detailed above. -.BR memalign() +.BR memalign () may not check that the .IR boundary parameter is correct. POSIX requires that memory obtained from -.BR posix_memalign() +.BR posix_memalign () can be freed using .IR free (). Some systems provide no way to reclaim memory allocated with @@ -44,10 +44,10 @@ pow, powf, powl \- power functions .sp Link with \-lm. .SH DESCRIPTION -The \fBpow()\fP function returns the value of \fIx\fP raised to the +The \fBpow\fP() function returns the value of \fIx\fP raised to the power of \fIy\fP. .SH ERRORS -The \fBpow()\fP function can return the following error: +The \fBpow\fP() function can return the following error: .TP .B EDOM The argument \fIx\fP is negative and \fIy\fP is not an integral value. diff --git a/man3/pow10.3 b/man3/pow10.3 index 1a183876..6e3b369b 100644 --- a/man3/pow10.3 +++ b/man3/pow10.3 @@ -37,7 +37,7 @@ pow10, pow10f, pow10l \- base-10 power functions .sp Link with \-lm. .SH DESCRIPTION -The \fBpow10()\fP function returns the value of 10 raised to the +The \fBpow10\fP() function returns the value of 10 raised to the power \fIx\fP. .SH "CONFORMING TO" This is a GNU extension. diff --git a/man3/psignal.3 b/man3/psignal.3 index 405d7a83..d739054c 100644 --- a/man3/psignal.3 +++ b/man3/psignal.3 @@ -37,7 +37,7 @@ psignal \- print signal message .BI "extern const char *const " sys_siglist []; .fi .SH DESCRIPTION -The \fBpsignal()\fP function displays a message on \fIstderr\fP +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, the message displayed will indicate an unknown signal. @@ -45,7 +45,7 @@ the message displayed will indicate an unknown signal. The array \fIsys_siglist\fP holds the signal description strings indexed by signal number. .SH "RETURN VALUE" -The \fBpsignal()\fP function returns no value. +The \fBpsignal\fP() function returns no value. .SH "CONFORMING TO" 4.3BSD .SH "SEE ALSO" diff --git a/man3/putenv.3 b/man3/putenv.3 index a9443a6e..ac0a935f 100644 --- a/man3/putenv.3 +++ b/man3/putenv.3 @@ -42,7 +42,7 @@ putenv \- change or add an environment variable .\" Not: const char * .fi .SH DESCRIPTION -The \fBputenv()\fP function adds or changes the value of environment +The \fBputenv\fP() function adds or changes the value of environment variables. The argument \fIstring\fP is of the form \fIname\fP=\fIvalue\fP. If \fIname\fP does not already exist in the environment, then \fIstring\fP is added to the environment. If \fIname\fP does exist, @@ -51,30 +51,30 @@ then the value of \fIname\fP in the environment is changed to The string pointed to by \fIstring\fP becomes part of the environment, so altering the string changes the environment. .SH "RETURN VALUE" -The \fBputenv()\fP function returns zero on success, or \-1 if an error +The \fBputenv\fP() function returns zero on success, or \-1 if an error occurs. .SH ERRORS .TP .B ENOMEM Insufficient space to allocate new environment. .SH NOTES -The \fBputenv()\fP function is not required to be reentrant, and the +The \fBputenv\fP() function is not required to be reentrant, and the one in libc4, libc5 and glibc2.0 is not, but the glibc2.1 version is. .LP Description for libc4, libc5, glibc: If the argument \fIstring\fP is of the form \fIname\fP, and does not contain an `=' character, then the variable \fIname\fP is removed from the environment. -If \fBputenv()\fP has to allocate a new array \fIenviron\fP, -and the previous array was also allocated by \fBputenv()\fP, +If \fBputenv\fP() has to allocate a new array \fIenviron\fP, +and the previous array was also allocated by \fBputenv\fP(), then it will be freed. In no case will the old storage associated to the environment variable itself be freed. .LP The libc4 and libc5 and glibc 2.1.2 versions conform to SUSv2: -the pointer \fIstring\fP given to \fBputenv()\fP is used. +the pointer \fIstring\fP given to \fBputenv\fP() is used. In particular, this string becomes part of the environment; changing it later will change the environment. -(Thus, it is an error is to call \fBputenv()\fP with an automatic variable +(Thus, it is an error is to call \fBputenv\fP() with an automatic variable as the argument, then return from the calling function while \fIstring\fP is still part of the environment.) However, glibc 2.0-2.1.1 differs: a copy of the string is used. diff --git a/man3/putgrent.3 b/man3/putgrent.3 index 400fe438..29816a10 100644 --- a/man3/putgrent.3 +++ b/man3/putgrent.3 @@ -13,9 +13,9 @@ putgrent \- write a group database entry to a file .sp .SH DESCRIPTION The -.B putgrent() +.BR putgrent () function is the counterpart for -.BR fgetgrent() . +.BR fgetgrent (). The function writes the content of the provided struct group into the file pointed to by .IR fp . diff --git a/man3/putpwent.3 b/man3/putpwent.3 index 446ea7a5..45021ce2 100644 --- a/man3/putpwent.3 +++ b/man3/putpwent.3 @@ -37,7 +37,7 @@ putpwent \- write a password file entry .BI "int putpwent(const struct passwd *" p ", FILE *" stream ); .fi .SH DESCRIPTION -The \fBputpwent()\fP function writes a password entry from the +The \fBputpwent\fP() function writes a password entry from the structure \fIp\fP in the file associated with \fIstream\fP. .PP The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows: @@ -58,7 +58,7 @@ struct passwd { .fi .RE .SH "RETURN VALUE" -The \fBputpwent()\fP function returns 0 on success, or \-1 if an error +The \fBputpwent\fP() function returns 0 on success, or \-1 if an error occurs. .SH ERRORS .TP diff --git a/man3/puts.3 b/man3/puts.3 index 2b88c22d..d5c63862 100644 --- a/man3/puts.3 +++ b/man3/puts.3 @@ -38,7 +38,7 @@ fputc, fputs, putc, putchar, puts \- output of characters and strings .nl .BI "int puts(const char *" "s" ); .SH DESCRIPTION -.B fputc() +.BR fputc () writes the character .IR c , cast to an @@ -46,7 +46,7 @@ cast to an to .IR stream . .PP -.B fputs() +.BR fputs () writes the string .I s to @@ -54,9 +54,9 @@ to without its trailing .BR '\e0' . .PP -.B putc() +.BR putc () is equivalent to -.B fputc() +.BR fputc () except that it may be implemented as a macro which evaluates .I stream more than once. @@ -65,7 +65,7 @@ more than once. is equivalent to .BI "putc(" c , stdout ). .PP -.BR puts() +.BR puts () writes the string .I s and a trailing newline @@ -100,7 +100,7 @@ ANSI-C, POSIX.1 It is not advisable to mix calls to output functions from the .B stdio library with low-level calls to -.B write() +.BR write () for the file descriptor associated with the same output stream; the results will be undefined and very probably not what you want. .SH "SEE ALSO" diff --git a/man3/qsort.3 b/man3/qsort.3 index 5d7bc551..f73a2557 100644 --- a/man3/qsort.3 +++ b/man3/qsort.3 @@ -41,7 +41,7 @@ qsort \- sorts an array .in .fi .SH DESCRIPTION -The \fBqsort()\fP function sorts an array with \fInmemb\fP elements of +The \fBqsort\fP() function sorts an array with \fInmemb\fP elements of size \fIsize\fP. The \fIbase\fP argument points to the start of the array. .PP @@ -54,7 +54,7 @@ greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second. If two members compare as equal, their order in the sorted array is undefined. .SH "RETURN VALUE" -The \fBqsort()\fP function returns no value. +The \fBqsort\fP() function returns no value. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899 .SH NOTE diff --git a/man3/raise.3 b/man3/raise.3 index e7ec7839..8cd591d3 100644 --- a/man3/raise.3 +++ b/man3/raise.3 @@ -34,7 +34,7 @@ raise \- send a signal to the current process .fi .SH DESCRIPTION The -.B raise() +.BR raise () function sends a signal to the current process. It is equivalent to .sp diff --git a/man3/rand.3 b/man3/rand.3 index c84af276..9fdf463a 100644 --- a/man3/rand.3 +++ b/man3/rand.3 @@ -49,39 +49,39 @@ rand, rand_r, srand \- pseudo-random number generator .BI "void srand(unsigned int " seed ); .fi .SH DESCRIPTION -The \fBrand()\fP function returns a pseudo-random integer between 0 +The \fBrand\fP() function returns a pseudo-random integer between 0 and \fBRAND_MAX\fR. .PP -The \fBsrand()\fP function sets its argument as the seed for a new -sequence of pseudo-random integers to be returned by \fBrand()\fP. -These sequences are repeatable by calling \fBsrand()\fP with the same +The \fBsrand\fP() function sets its argument as the seed for a new +sequence of pseudo-random integers to be returned by \fBrand\fP(). +These sequences are repeatable by calling \fBsrand\fP() with the same seed value. .PP -If no seed value is provided, the \fBrand()\fP function is automatically +If no seed value is provided, the \fBrand\fP() function is automatically seeded with a value of 1. .PP The function -.B rand() +.BR rand () is not reentrant or thread-safe, since it uses hidden state that is modified on each call. This might just be the seed value to be used by the next call, or it might be something more elaborate. In order to get reproducible behaviour in a threaded application, this state must be made explicit. The function -.B rand_r() +.BR rand_r () is supplied with a pointer to an unsigned int, to be used as state. This is a very small amount of state, so this function will be a weak pseudo-random generator. Try .BR drand48_r (3) instead. .SH "RETURN VALUE" -The \fBrand()\fP and \fBrand_r()\fP functions return a value +The \fBrand\fP() and \fBrand_r\fP() functions return a value between 0 and RAND_MAX. -The \fBsrand()\fP function returns no value. +The \fBsrand\fP() function returns no value. .SH EXAMPLE POSIX 1003.1-2003 gives the following example of an implementation of -.B rand() +.BR rand () and -.BR srand() , +.BR srand (), possibly useful when one needs the same sequence on two different machines. .sp .nf @@ -98,11 +98,11 @@ possibly useful when one needs the same sequence on two different machines. } .fi .SH NOTES -The versions of \fBrand()\fP and \fBsrand()\fP in the Linux C Library use -the same random number generator as \fBrandom()\fP and \fBsrandom()\fP, so +The versions of \fBrand\fP() and \fBsrand\fP() in the Linux C Library use +the same random number generator as \fBrandom\fP() and \fBsrandom\fP(), so the lower-order bits should be as random as the higher-order bits. However, on older -.B rand() +.BR rand () implementations, and on current implementations on different systems, the lower-order bits are much less random than the higher-order bits. Do not use this function in applications intended to be portable @@ -143,12 +143,12 @@ volume 2 (Seminumerical Algorithms), 2nd ed.; Reading, Massachusetts: Addison-Wesley Publishing Company, 1981. .SH "CONFORMING TO" The functions -.B rand() +.BR rand () and -.B srand() +.BR srand () conform to SVID 3, 4.3BSD, ISO 9899, POSIX 1003.1-2003. The function -.B rand_r() +.BR rand_r () is from POSIX 1003.1-2003. .SH "SEE ALSO" .BR drand48 (3), diff --git a/man3/random.3 b/man3/random.3 index 7235fcd0..e75d7593 100644 --- a/man3/random.3 +++ b/man3/random.3 @@ -44,41 +44,41 @@ random, srandom, initstate, setstate \- random number generator .BI "char *setstate(char *" state ); .fi .SH DESCRIPTION -The \fBrandom()\fP function uses a non-linear additive feedback random +The \fBrandom\fP() function uses a non-linear additive feedback random number generator employing a default table of size 31 long integers to return successive pseudo-random numbers in the range from 0 to \fBRAND_MAX\fR. The period of this random number generator is very large, approximately 16*((2**31)\-1). .PP -The \fBsrandom()\fP function sets its argument as the seed for a new -sequence of pseudo-random integers to be returned by \fBrandom()\fP. -These sequences are repeatable by calling \fBsrandom()\fP with the same -seed value. If no seed value is provided, the \fBrandom()\fP function +The \fBsrandom\fP() function sets its argument as the seed for a new +sequence of pseudo-random integers to be returned by \fBrandom\fP(). +These sequences are repeatable by calling \fBsrandom\fP() with the same +seed value. If no seed value is provided, the \fBrandom\fP() function is automatically seeded with a value of 1. .PP -The \fBinitstate()\fP function allows a state array \fIstate\fP to -be initialized for use by \fBrandom()\fP. The size of the state array -\fIn\fP is used by \fBinitstate()\fP to decide how sophisticated a +The \fBinitstate\fP() function allows a state array \fIstate\fP to +be initialized for use by \fBrandom\fP(). The size of the state array +\fIn\fP is used by \fBinitstate\fP() to decide how sophisticated a random number generator it should use \(em the larger the state array, the better the random numbers will be. \fIseed\fP is the seed for the initialization, which specifies a starting point for the random number sequence, and provides for restarting at the same point. .PP -The \fBsetstate()\fP function changes the state array used by the -\fBrandom()\fP function. The state array \fIstate\fP is used for -random number generation until the next call to \fBinitstate()\fP -or \fBsetstate()\fP. \fIstate\fP must first have been initialized -using \fBinitstate()\fP or be the result of a previous call of -\fBsetstate()\fP. +The \fBsetstate\fP() function changes the state array used by the +\fBrandom\fP() function. The state array \fIstate\fP is used for +random number generation until the next call to \fBinitstate\fP() +or \fBsetstate\fP(). \fIstate\fP must first have been initialized +using \fBinitstate\fP() or be the result of a previous call of +\fBsetstate\fP(). .SH "RETURN VALUE" -The \fBrandom()\fP function returns a value between 0 and RAND_MAX. -The \fBsrandom()\fP function returns no value. The \fBinitstate()\fP -and \fBsetstate()\fP functions return a pointer to the previous state +The \fBrandom\fP() function returns a value between 0 and RAND_MAX. +The \fBsrandom\fP() function returns no value. The \fBinitstate\fP() +and \fBsetstate\fP() functions return a pointer to the previous state array, or NULL on error. .SH ERRORS .TP .B EINVAL -A state array of less than 8 bytes was specified to \fBinitstate()\fP. +A state array of less than 8 bytes was specified to \fBinitstate\fP(). .SH NOTES Current "optimal" values for the size of the state array \fIn\fP are 8, 32, 64, 128, and 256 bytes; other amounts will be rounded down to diff --git a/man3/realpath.3 b/man3/realpath.3 index 67a35a28..9ba6416c 100644 --- a/man3/realpath.3 +++ b/man3/realpath.3 @@ -121,15 +121,15 @@ impossible to determine a suitable size for the output buffer, According to POSIX a buffer of size PATH_MAX suffices, but PATH_MAX need not be a defined constant, and may have to be obtained using -.IR pathconf() . +.IR pathconf (). And asking -.I pathconf() +.IR pathconf () does not really help, since on the one hand POSIX warns that the result of -.I pathconf() +.IR pathconf () may be huge and unsuitable for mallocing memory. And on the other hand -.I pathconf() +.IR pathconf () may return \-1 to signify that PATH_MAX is not bounded. .LP The libc4 and libc5 implementation contains a buffer overflow @@ -144,7 +144,7 @@ In Linux this function appears in libc 4.5.21. In 4.4BSD and Solaris the limit on the pathname length is MAXPATHLEN (found in <sys/param.h>). The SUSv2 prescribes PATH_MAX and NAME_MAX, as found in <limits.h> or provided by the -.I pathconf() +.IR pathconf () function. A typical source fragment would be .LP .RS diff --git a/man3/remainder.3 b/man3/remainder.3 index fe07ff47..d28472a5 100644 --- a/man3/remainder.3 +++ b/man3/remainder.3 @@ -52,7 +52,7 @@ floating-point remainder function Link with \-lm. .SH DESCRIPTION The -.B remainder() +.BR remainder () function computes the remainder of dividing .I x by @@ -70,11 +70,11 @@ If the return value is 0, it has the sign of .IR x . .LP The -.B drem() +.BR drem () function does precisely the same thing. .SH "RETURN VALUE" The -.B remainder() +.BR remainder () function returns the remainder, unless .I y is zero, when the function fails and @@ -91,11 +91,11 @@ IEC 60559. The three .B remainder*() functions are from C99. The function -.B drem() +.BR drem () is from 4.3BSD. The float and long double variants -.B dremf() +.BR dremf () and -.B dreml() +.BR dreml () exist on some systems, such as Tru64 and glibc2. .SH EXAMPLE The call "remainder(29.0, 3.0)" returns \-1. diff --git a/man3/resolver.3 b/man3/resolver.3 index cfc5bba7..0ca3f014 100644 --- a/man3/resolver.3 +++ b/man3/resolver.3 @@ -85,40 +85,40 @@ Link with \-lresolv. These functions make queries to and interpret the responses from Internet domain name servers. .PP -The \fBres_init()\fP function reads the configuration files (see +The \fBres_init\fP() function reads the configuration files (see resolv+(8)) to get the default domain name, search order and name server address(es). If no server is given, the local host is tried. If no domain is given, that associated with the local host is used. It can be overridden with the environment variable LOCALDOMAIN. -\fBres_init()\fP is normally executed by the first call to one of the +\fBres_init\fP() is normally executed by the first call to one of the other functions. .PP -The \fBres_query()\fP function queries the name server for the +The \fBres_query\fP() function queries the name server for the fully-qualified domain name \fIname\fP of specified \fItype\fP and \fIclass\fP. The reply is left in the buffer \fIanswer\fP of length \fIanslen\fP supplied by the caller. .PP -The \fBres_search()\fP function makes a query and waits for the response -like \fBres_query()\fP, but in addition implements the default and search +The \fBres_search\fP() function makes a query and waits for the response +like \fBres_query\fP(), but in addition implements the default and search rules controlled by RES_DEFNAMES and RES_DNSRCH (see description of \fI_res\fP options below). .PP -The \fBres_querydomain()\fP function makes a query using \fBres_query()\fP +The \fBres_querydomain\fP() function makes a query using \fBres_query\fP() on the concatenation of \fIname\fP and \fIdomain\fP. .PP -The following functions are lower-level routines used by \fBres_query()\fP. +The following functions are lower-level routines used by \fBres_query\fP(). .PP -The \fBres_mkquery()\fP function constructs a query message in \fIbuf\fP +The \fBres_mkquery\fP() function constructs a query message in \fIbuf\fP of length \fIbuflen\fP for the domain name \fIdname\fP. The query type \fIop\fP is usually QUERY, but can be any of the types defined in \fI<arpa/nameser.h>\fP. \fInewrr\fP is currently unused. .PP -The \fBres_send()\fP function sends a pre-formatted query given in +The \fBres_send\fP() function sends a pre-formatted query given in \fImsg\fP of length \fImsglen\fP and returns the answer in \fIanswer\fP -which is of length \fIanslen\fP. It will call \fBres_init()\fP, if it +which is of length \fIanslen\fP. It will call \fBres_init\fP(), if it has not already been called. .PP -The \fBdn_comp()\fP function compresses the domain name \fIexp_dn\fP +The \fBdn_comp\fP() function compresses the domain name \fIexp_dn\fP and stores it in the buffer \fIcomp_dn\fP of length \fIlength\fP. The compression uses an array of pointers \fIdnptrs\fP to previously compressed names in the current message. The first pointer points @@ -127,7 +127,7 @@ of the array is specified by \fIlastdnptr\fP. if \fIdnptr\fP is NULL, domain names are not compressed. If \fIlastdnptr\fP is NULL, the list of labels is not updated. .PP -The \fPdn_expand()\fP function expands the compressed domain name +The \fPdn_expand\fP() function expands the compressed domain name \fIcomp_dn\fP to a full domain name, which is placed in the buffer \fIexp_dn\fP of size \fIlength\fP. The compressed name is contained in a query or reply message, and \fImsg\fP points to the beginning of @@ -141,13 +141,13 @@ of the following options: .sp .TP .B RES_INIT -True if \fBres_init()\fP has been called. +True if \fBres_init\fP() has been called. .TP .B RES_DEBUG Print debugging messages. .TP .B RES_AAONLY -Accept authoritative answers only. \fBres_send()\fP continues until +Accept authoritative answers only. \fBres_send\fP() continues until it fins an authoritative answer or returns an error. [Not currently implemented]. .TP @@ -163,11 +163,11 @@ implemented]. .TP .B RES_RECURSE Set the recursion desired bit in queries. Recursion is carried out -by the domain name server, not by \fBres_send()\fP. [Enabled by +by the domain name server, not by \fBres_send\fP(). [Enabled by default]. .TP .B RES_DEFNAMES -If set, \fBres_search()\fP will append the default domain name to +If set, \fBres_search\fP() will append the default domain name to single component names, ie. those that do not contain a dot. [Enabled by default]. .TP @@ -175,19 +175,19 @@ single component names, ie. those that do not contain a dot. Used with RES_USEVC to keep the TCP connection open between queries. .TP .B RES_DNSRCH -If set, \fBres_search()\fP will search for host names in the current +If set, \fBres_search\fP() will search for host names in the current domain and in parent domains. This option is used by .BR gethostbyname (3). [Enabled by default]. .SH "RETURN VALUE" -The \fBres_init()\fP function returns 0 on success, or \-1 if an error +The \fBres_init\fP() function returns 0 on success, or \-1 if an error occurs. .PP -The \fBres_query()\fP, \fBres_search()\fP, \fBres_querydomain()\fP, -\fBres_mkquery()\fP and \fBres_send()\fP functions return the length +The \fBres_query\fP(), \fBres_search\fP(), \fBres_querydomain\fP(), +\fBres_mkquery\fP() and \fBres_send\fP() functions return the length of the response, or \-1 if an error occurs. .PP -The \fBdn_comp()\fP and \fBdn_expand()\fP functions return the length +The \fBdn_comp\fP() and \fBdn_expand\fP() functions return the length of the compressed name, or \-1 if an error occurs. .SH FILES .nf diff --git a/man3/rewinddir.3 b/man3/rewinddir.3 index 9b2cdd6a..8c785fb1 100644 --- a/man3/rewinddir.3 +++ b/man3/rewinddir.3 @@ -38,10 +38,10 @@ rewinddir \- reset directory stream .BI "void rewinddir(DIR *" dir ); .fi .SH DESCRIPTION -The \fBrewinddir()\fP function resets the position of the directory +The \fBrewinddir\fP() function resets the position of the directory stream \fIdir\fP to the beginning of the directory. .SH "RETURN VALUE" -The \fBrewinddir()\fP function returns no value. +The \fBrewinddir\fP() function returns no value. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD .SH "SEE ALSO" diff --git a/man3/rint.3 b/man3/rint.3 index a6609085..1e578b59 100644 --- a/man3/rint.3 +++ b/man3/rint.3 @@ -75,7 +75,7 @@ the maximum value of the exponent is 128 (resp. 1024), and the number of mantissa bits is 24 (resp. 53).) .SH "CONFORMING TO" The -.B rint() +.BR rint () function conforms to 4.3BSD. The other functions are from C99. .SH "SEE ALSO" @@ -41,7 +41,7 @@ Destruction usually involves deallocation of private data structures. The use of .I auth is undefined after calling -.BR auth_destroy() . +.BR auth_destroy (). .br .if t .ne 6 .LP @@ -103,7 +103,7 @@ authunix_create_default() .ft R .IP Calls -.B authunix_create() +.BR authunix_create () with the appropriate parameters. .br .if t .ne 13 @@ -139,14 +139,14 @@ This routine returns zero if it succeeds, or the value of .B "enum clnt_stat" cast to an integer if it fails. The routine -.B clnt_perrno() +.BR clnt_perrno () is handy for translating failure statuses into messages. .IP Warning: calling remote procedures with this routine uses .SM UDP/IP as a transport; see -.B clntudp_create() +.BR clntudp_create () for restrictions. You do not have control of timeouts or authentication using this routine. @@ -166,11 +166,11 @@ resultproc_t eachresult; .ft R .IP Like -.BR callrpc() , +.BR callrpc (), except the call message is broadcast to all locally connected broadcast nets. Each time it receives a response, this routine calls -.BR eachresult() , +.BR eachresult (), whose form is: .IP .RS 1i @@ -188,14 +188,14 @@ where is the same as .I out passed to -.BR clnt_broadcast() , +.BR clnt_broadcast (), except that the remote procedure's output is decoded there; .I addr points to the address of the machine that sent the results. If -.B eachresult() +.BR eachresult () returns zero, -.B clnt_broadcast() +.BR clnt_broadcast () waits for more replies; otherwise it returns with appropriate status. .IP @@ -226,7 +226,7 @@ associated with the client handle, which is obtained with an .SM RPC client creation routine such as -.BR clnt_create() . +.BR clnt_create (). The parameter .I in is the address of the procedure's argument(s), and @@ -257,7 +257,7 @@ of private data structures, including itself. Use of .I clnt is undefined after calling -.BR clnt_destroy() . +.BR clnt_destroy (). If the .SM RPC library opened the associated socket, it will close it also. @@ -285,7 +285,7 @@ indicates which kind of transport protocol to use. The currently supported values for this field are \(lqudp\(rq and \(lqtcp\(rq. Default timeouts are set, but can be modified using -.BR clnt_control() . +.BR clnt_control (). .IP Warning: Using .SM UDP @@ -328,9 +328,9 @@ and their argument types and what they do are: .fi .IP Note: if you set the timeout using -.BR clnt_control() , +.BR clnt_control (), the timeout parameter passed to -.B clnt_call() +.BR clnt_call () will be ignored in all future calls. .IP .nf @@ -418,11 +418,11 @@ The message is prepended with string .I s and a colon. Used when a -.BR clnt_create() , -.BR clntraw_create() , -.BR clnttcp_create() , +.BR clnt_create (), +.BR clntraw_create (), +.BR clnttcp_create (), or -.B clntudp_create() +.BR clntudp_create () call fails. .br .if t .ne 8 @@ -440,7 +440,7 @@ Print a message to standard error corresponding to the condition indicated by .IR stat . Used after -.BR callrpc() . +.BR callrpc (). .br .if t .ne 8 .LP @@ -462,7 +462,7 @@ The message is prepended with string .I s and a colon. Used after -.BR clnt_call() . +.BR clnt_call (). .br .if t .ne 9 .LP @@ -476,7 +476,7 @@ char *s; .ft R .IP Like -.BR clnt_pcreateerror() , +.BR clnt_pcreateerror (), except that it returns a string instead of printing to the standard error. .IP @@ -495,7 +495,7 @@ enum clnt_stat stat; .ft R .IP Take the same arguments as -.BR clnt_perrno() , +.BR clnt_perrno (), but instead of sending a message to the standard error indicating why an .SM RPC @@ -503,22 +503,22 @@ call failed, return a pointer to a string which contains the message. The string ends with a .SM NEWLINE\s0. .IP -.B clnt_sperrno() +.BR clnt_sperrno () is used instead of -.B clnt_perrno() +.BR clnt_perrno () 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 , or if a message format different than that supported by -.B clnt_perrno() +.BR clnt_perrno () is to be used. Note: unlike -.B clnt_sperror() +.BR clnt_sperror () and -.BR clnt_spcreaterror() , -.B clnt_sperrno() +.BR clnt_spcreaterror (), +.BR clnt_sperrno () returns pointer to static data, but the result will not get overwritten on each call. .br @@ -535,9 +535,9 @@ char *s; .ft R .IP Like -.BR clnt_perror() , +.BR clnt_perror (), except that (like -.BR clnt_sperrno() ) +.BR clnt_sperrno ()) it returns a string instead of printing to standard error. .IP Bugs: returns pointer to static data that is overwritten @@ -565,7 +565,7 @@ actually a buffer within the process's address space, so the corresponding .SM RPC server should live in the same address space; see -.BR svcraw_create() . +.BR svcraw_create (). This allows simulation of .SM RPC and acquisition of @@ -670,7 +670,7 @@ transport resends the call message in intervals of time until a response is received or until the call times out. The total time for the call to time out is specified by -.BR clnt_call() . +.BR clnt_call (). .IP Warning: since .SM UDP\s0-based @@ -724,7 +724,7 @@ transport resends the call message in intervals of time until a response is received or until the call times out. The total time for the call to time out is specified by -.BR clnt_call() . +.BR clnt_call (). .IP This allows the user to specify the maximum packet size for sending and receiving .SM UDP\s0-based @@ -812,7 +812,7 @@ the system failed to contact the remote .B portmap service. In the latter case, the global variable -.B rpc_createerr() +.BR rpc_createerr () contains the .SM RPC status. @@ -850,13 +850,13 @@ will be modified to the program's port number if the procedure succeeds. The definitions of other parameters are discussed in -.B callrpc() +.BR callrpc () and -.BR clnt_call() . +.BR clnt_call (). This procedure should be used for a \(lqping\(rq and nothing else. See also -.BR clnt_broadcast() . +.BR clnt_broadcast (). .br .if t .ne 9 .LP @@ -886,7 +886,7 @@ or .BR \s-1IPPROTO_TCP\s0 . This routine returns one if it succeeds, zero otherwise. Automatically done by -.BR svc_register() . +.BR svc_register (). .br .if t .ne 7 .LP @@ -946,7 +946,7 @@ Warning: remote procedures registered in this form are accessed using the .SM UDP/IP transport; see -.B svcudp_create() +.BR svcudp_create () for restrictions. .br .if t .ne 5 @@ -962,7 +962,7 @@ A global variable whose value is set by any .SM RPC client creation routine that does not succeed. Use the routine -.B clnt_pcreateerror() +.BR clnt_pcreateerror () to print the reason why. .if t .ne 7 .LP @@ -1003,12 +1003,12 @@ to the .B select system call. This is only of interest if a service implementor does not call -.BR svc_run() , +.BR svc_run (), but rather does his own asynchronous event processing. This variable is read-only (do not pass its address to .BR select !), yet it may change after calls to -.B svc_getreqset() +.BR svc_getreqset () or any creation routines. .br .if t .ne 6 @@ -1042,7 +1042,7 @@ A macro that frees any data allocated by the .SM RPC/XDR system when it decoded the arguments to a service procedure using -.BR svc_getargs() . +.BR svc_getargs (). This routine returns 1 if the results were successfully freed, and zero otherwise. @@ -1105,7 +1105,7 @@ fd_set *rdfds; .IP This routine is only of interest if a service implementor does not call -.BR svc_run() , +.BR svc_run (), but instead implements custom asynchronous event processing. It is called when the .B select @@ -1132,9 +1132,9 @@ int rdfds; .ft R .IP Similar to -.BR svc_getreqset() , +.BR svc_getreqset (), but limited to 32 descriptors. This interface is obsoleted by -.BR svc_getreqset() . +.BR svc_getreqset (). .br .if t .ne 17 .LP @@ -1190,7 +1190,7 @@ struct svc_req *request; .RE .IP The -.B svc_register() +.BR svc_register () routine returns one if it succeeds, and zero otherwise. .br .if t .ne 6 @@ -1206,9 +1206,9 @@ This routine never returns. It waits for .SM RPC requests to arrive, and calls the appropriate service procedure using -.B svc_getreq() +.BR svc_getreq () when one arrives. This procedure is usually waiting for a -.B select() +.BR select () system call to return. .br .if t .ne 9 @@ -1282,7 +1282,7 @@ svcerr_decode(xprt) .IP Called by a service dispatch routine that cannot successfully decode its parameters. See also -.BR svc_getargs() . +.BR svc_getargs (). .br .if t .ne 7 .LP @@ -1406,7 +1406,7 @@ so the corresponding client should live in the same address space; see -.BR clntraw_create() . +.BR clntraw_create (). This routine allows simulation of .SM RPC and acquisition of @@ -1701,7 +1701,7 @@ they should register themselves with the .SM RPC service package. This routine modifies the global variable -.BR svc_fds() . +.BR svc_fds (). Service implementors usually do not need this routine. .br .if t .ne 8 @@ -1722,7 +1722,7 @@ it should unregister itself with the .SM RPC service package. This routine modifies the global variable -.BR svc_fds() . +.BR svc_fds (). Service implementors usually do not need this routine. .SH "SEE ALSO" .\" We don't have an rpc_secure.3 page in the set at the moment -- MTK, 19 Sep 05 diff --git a/man3/scalb.3 b/man3/scalb.3 index 47cea815..e1642001 100644 --- a/man3/scalb.3 +++ b/man3/scalb.3 @@ -53,24 +53,24 @@ by FLT_RADIX (probably 2) to the power .IR exp . If FLT_RADIX equals 2, then -.B scalbn() +.BR scalbn () is equivalent to -.BR ldexp() . +.BR ldexp (). The value of FLT_RADIX is found in .IR <float.h> . .\" not in /usr/include but in a gcc lib .SH "CONFORMING TO" The -.B scalb() +.BR scalb () function is from 4.3BSD. The -.B scalbn() +.BR scalbn () and -.B scalbln() +.BR scalbln () functions are from C99. All three are in POSIX 1003.1-2003. The -.B scalb() +.BR scalb () function is marked obsolescent. .SH "SEE ALSO" .BR ldexp (3) diff --git a/man3/scandir.3 b/man3/scandir.3 index af06a9d3..ba7a379f 100644 --- a/man3/scandir.3 +++ b/man3/scandir.3 @@ -49,33 +49,33 @@ scandir, alphasort, versionsort \- scan a directory for matching entries .BI "int versionsort(const void *" a ", const void *" b ); .fi .SH DESCRIPTION -The \fBscandir()\fP function scans the directory \fIdir\fP, calling -\fIfilter()\fP on each directory entry. Entries for which -\fIfilter()\fP returns non-zero are stored in strings allocated via -\fBmalloc()\fP, sorted using \fBqsort()\fP with the comparison -function \fIcompar()\fP, and collected in array \fInamelist\fP -which is allocated via \fBmalloc()\fP. +The \fBscandir\fP() function scans the directory \fIdir\fP, calling +\fIfilter\fP() on each directory entry. Entries for which +\fIfilter\fP() returns non-zero are stored in strings allocated via +\fBmalloc\fP(), sorted using \fBqsort\fP() with the comparison +function \fIcompar\fP(), and collected in array \fInamelist\fP +which is allocated via \fBmalloc\fP(). If \fIfilter\fP is NULL, all entries are selected. .LP The -.B alphasort() +.BR alphasort () and -.B versionsort() +.BR versionsort () functions can be used as the comparison function -.IR compar() . +.IR compar (). The former sorts directory entries using .BR strcoll (3), the latter using .BR strvers\%cmp (3) on the strings \fI(*a)\->d_name\fP and \fI(*b)\->d_name\fP. .SH "RETURN VALUE" -The \fBscandir()\fP function returns the number of directory entries +The \fBscandir\fP() function returns the number of directory entries selected or \-1 if an error occurs. .PP The -.B alphasort() +.BR alphasort () and -.B versionsort() +.BR versionsort () functions return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second. @@ -86,14 +86,14 @@ Insufficient memory to complete the operation. .SH "CONFORMING TO" None of these functions is in POSIX. LSB has deprecated the library call -.B alphasort() +.BR alphasort () and never contained -.BR scandir() . +.BR scandir (). .LP The functions -.B scandir() +.BR scandir () and -.B alphasort() +.BR alphasort () are from 4.3BSD, and have been available under Linux since libc4. Libc4 and libc5 use the more precise prototype .sp @@ -104,10 +104,10 @@ Libc4 and libc5 use the more precise prototype but glibc 2.0 returns to the imprecise BSD prototype. .LP The function -.B versionsort() +.BR versionsort () is a GNU extension, available since glibc 2.1. Since glibc 2.1, -.B alphasort() +.BR alphasort () calls .BR strcoll (3); earlier it used diff --git a/man3/seekdir.3 b/man3/seekdir.3 index 0cafc42d..1bc0e986 100644 --- a/man3/seekdir.3 +++ b/man3/seekdir.3 @@ -36,11 +36,11 @@ stream. .BI "void seekdir(DIR *" dir ", off_t " offset ); .fi .SH DESCRIPTION -The \fBseekdir()\fP function sets the location in the directory stream -from which the next \fBreaddir()\fP call will start. \fBseekdir()\fP -should be used with an offset returned by \fBtelldir()\fP. +The \fBseekdir\fP() function sets the location in the directory stream +from which the next \fBreaddir\fP() call will start. \fBseekdir\fP() +should be used with an offset returned by \fBtelldir\fP(). .SH "RETURN VALUE" -The \fBseekdir()\fP function returns no value. +The \fBseekdir\fP() function returns no value. .SH "CONFORMING TO" 4.3BSD .SH "SEE ALSO" diff --git a/man3/setaliasent.3 b/man3/setaliasent.3 index 703a94d1..4f60e7c7 100644 --- a/man3/setaliasent.3 +++ b/man3/setaliasent.3 @@ -35,32 +35,32 @@ which databases are supported, try getent \-\-help .) Six functions are provided to access the aliases database. .PP The -.B getaliasent() +.BR getaliasent () function returns a pointer to a structure containing the group information from the aliases database. The first time it is called it returns the first entry; thereafter, it returns successive entries. .PP The -.B setaliasent() +.BR setaliasent () function rewinds the file pointer to the beginning of the aliases database. .PP The -.B endaliasent() +.BR endaliasent () function closes the aliases database. .PP -.B getaliasent_r() +.BR getaliasent_r () is the reentrant version of the previous function. The requested structure is stored via the first argument but the programmer needs to fill the other arguments also. Not providing enough space causes the function to fail. .PP The function -.B getaliasbyname() +.BR getaliasbyname () takes the name argument and searches the aliases database. The entry is returned as a pointer to a struct aliasent. .PP -.B getaliasbyname_r() +.BR getaliasbyname_r () is the reentrant version of the previous function. The requested structure is stored via the second argument but the programmer need to fill the other arguments also. Not providing enough space causes the function to fail. @@ -82,9 +82,9 @@ This can be changed in the file. .SH "RETURN VALUE" The functions -.B getaliasent_r() +.BR getaliasent_r () and -.B getaliasbyname_r() +.BR getaliasbyname_r () return a non-zero value on error. .SH EXAMPLE The following example compiles with diff --git a/man3/setenv.3 b/man3/setenv.3 index 694054d7..95bc76ed 100644 --- a/man3/setenv.3 +++ b/man3/setenv.3 @@ -43,19 +43,19 @@ setenv \- change or add an environment variable .BI "int unsetenv(const char *" name ); .fi .SH DESCRIPTION -The \fBsetenv()\fP function adds the variable \fIname\fP to the +The \fBsetenv\fP() function adds the variable \fIname\fP to the environment with the value \fIvalue\fP, if \fIname\fP does not already exist. If \fIname\fP does exist in the environment, then its value is changed to \fIvalue\fP if \fIoverwrite\fP is non-zero; if \fIoverwrite\fP is zero, then the value of \fIname\fP is not changed. .PP -The \fBunsetenv()\fP function deletes the variable \fIname\fP from +The \fBunsetenv\fP() function deletes the variable \fIname\fP from the environment. .SH "RETURN VALUE" -The \fBsetenv()\fP function returns zero on success, or \-1 if there +The \fBsetenv\fP() function returns zero on success, or \-1 if there was insufficient space in the environment. -The \fBunsetenv()\fP function returns zero on success, +The \fBunsetenv\fP() function returns zero on success, or \-1 on error, with .I errno set to indicate the cause of the error. @@ -67,7 +67,7 @@ contained an '=' character. .SH "CONFORMING TO" 4.3BSD .SH "NOTES" -Prior to glibc 2.2.2, \fBunsetenv()\fP was prototyped +Prior to glibc 2.2.2, \fBunsetenv\fP() was prototyped as returning \fIvoid\fP; more recent glibc versions follow the SUSv3-compliant prototype shown in the SYNOPSIS. .SH BUGS diff --git a/man3/setjmp.3 b/man3/setjmp.3 index cd9a8f29..2a1d5184 100644 --- a/man3/setjmp.3 +++ b/man3/setjmp.3 @@ -36,18 +36,18 @@ setjmp, sigsetjmp \- save stack context for non-local goto .fi .ad b .SH DESCRIPTION -\fBsetjmp()\fP and \fBlongjmp()\fP are useful for dealing with errors +\fBsetjmp\fP() and \fBlongjmp\fP() are useful for dealing with errors and interrupts encountered in a low-level subroutine of a program. -\fBsetjmp()\fP saves the stack context/environment in \fIenv\fP for -later use by \fBlongjmp()\fP. The stack context will be invalidated -if the function which called \fBsetjmp()\fP returns. +\fBsetjmp\fP() saves the stack context/environment in \fIenv\fP for +later use by \fBlongjmp\fP(). The stack context will be invalidated +if the function which called \fBsetjmp\fP() returns. .P -\fBsigsetjmp()\fP is similar to \fBsetjmp()\fP. If \fIsavesigs\fP is non-zero, +\fBsigsetjmp\fP() is similar to \fBsetjmp\fP(). If \fIsavesigs\fP is non-zero, the set of blocked signals is saved in \fIenv\fP and will be restored -if a \fBsiglongjmp()\fP is later performed with this \fIenv\fP. +if a \fBsiglongjmp\fP() is later performed with this \fIenv\fP. .SH "RETURN VALUE" -\fBsetjmp()\fP and \fBsigsetjmp()\fP return 0 if returning directly, and -non-zero when returning from \fBlongjmp()\fP using the saved context. +\fBsetjmp\fP() and \fBsigsetjmp\fP() return 0 if returning directly, and +non-zero when returning from \fBlongjmp\fP() using the saved context. .SH "CONFORMING TO" POSIX, ISO 9899 (C99) .SH NOTES @@ -56,7 +56,7 @@ signal context. (In SYSV it will not. In 4.3BSD will, and there is a function \fB_setjmp\fP that will not.) If you want to save signal masks, use \fBsigsetjmp\fP(). .P -\fBsetjmp()\fP and \fBsigsetjmp\fP() make programs hard to understand +\fBsetjmp\fP() and \fBsigsetjmp\fP() make programs hard to understand and maintain. If possible an alternative should be used. .SH "SEE ALSO" .BR longjmp (3), diff --git a/man3/setlocale.3 b/man3/setlocale.3 index 319c7421..54576617 100644 --- a/man3/setlocale.3 +++ b/man3/setlocale.3 @@ -38,7 +38,7 @@ setlocale \- set the current locale .fi .SH DESCRIPTION The -.B setlocale() +.BR setlocale () function is used to set or query the program's current locale. .PP If @@ -143,7 +143,7 @@ A program may be made portable to all locales by calling .B setlocale(LC_ALL, """""") after program initialization, by using the values returned from a -.B localeconv() +.BR localeconv () call for locale-dependent information, by using the multi-byte and wide character functions for text processing if @@ -155,7 +155,7 @@ or to compare strings. .SH "RETURN VALUE" A successful call to -.B setlocale() +.BR setlocale () returns an opaque string that corresponds to the locale set. This string may be allocated in static storage. The string returned is such that a subsequent call with that string diff --git a/man3/setlogmask.3 b/man3/setlogmask.3 index 7050e759..cb6364dd 100644 --- a/man3/setlogmask.3 +++ b/man3/setlogmask.3 @@ -39,7 +39,7 @@ bit set in The initial mask is such that logging is enabled for all priorities. .LP The -.B setlogmask() +.BR setlogmask () function sets this logmask for the current process, and returns the previous mask. If the mask argument is 0, the current logmask is not modified. diff --git a/man3/setnetgrent.3 b/man3/setnetgrent.3 index 2739b63c..43da3561 100644 --- a/man3/setnetgrent.3 +++ b/man3/setnetgrent.3 @@ -37,11 +37,11 @@ The file defines what database is searched. .PP The -.B setnetgrent() +.BR setnetgrent () call defines the netgroup that will be searched by subsequent -.B getnetgrent() +.BR getnetgrent () calls. The -.B getnetgrent() +.BR getnetgrent () function retrieves the next netgroup entry, and returns pointers in .IR host , .IR user , @@ -50,15 +50,15 @@ A NULL pointer means that the corresponding entry matches any string. The pointers are valid only as long as there is no call to other netgroup related functions. To avoid this problem you can use the GNU function -.B getnetgrent_r() +.BR getnetgrent_r () that stores the strings in the supplied buffer. To free all allocated buffers use -.BR endnetgrent() . +.BR endnetgrent (). .PP In most cases you only want to check if the triplet .BR (hostname "," username "," domainname) is a member of a netgroup. The function -.B innetgr() +.BR innetgr () can be used for this without calling the above three functions. Again, a NULL pointer is a wildcard and matches any string. The function is thread-safe. @@ -70,7 +70,7 @@ The function is thread-safe. These functions return 1 on success and 0 for failure. .SH NOTES In the BSD implementation, -.B setnetgrent() +.BR setnetgrent () returns void. .SH "SEE ALSO" .BR sethostent (3), diff --git a/man3/siginterrupt.3 b/man3/siginterrupt.3 index c7855765..8c46d955 100644 --- a/man3/siginterrupt.3 +++ b/man3/siginterrupt.3 @@ -36,7 +36,7 @@ siginterrupt \- allow signals to interrupt system calls .BI "int siginterrupt(int " sig ", int " flag ); .fi .SH DESCRIPTION -The \fBsiginterrupt()\fP function changes the restart behaviour when +The \fBsiginterrupt\fP() function changes the restart behaviour when a system call is interrupted by the signal \fIsig\fP. If the \fIflag\fP argument is false (0), then system calls will be restarted if interrupted by the specified signal \fIsig\fP. This is the default behaviour in @@ -51,7 +51,7 @@ If the \fIflags\fP argument is true (1) and data transfer has started, then the system call will be interrupted and will return the actual amount of data transferred. .SH "RETURN VALUE" -The \fBsiginterrupt()\fP function returns 0 on success, or \-1 if the +The \fBsiginterrupt\fP() function returns 0 on success, or \-1 if the signal number \fIsig\fP is invalid. .SH ERRORS .TP diff --git a/man3/significand.3 b/man3/significand.3 index 1487c1c1..20174d74 100644 --- a/man3/significand.3 +++ b/man3/significand.3 @@ -17,7 +17,7 @@ get mantissa of floating point number Link with \-lm. .SH DESCRIPTION The -.B significand() +.BR significand () function returns the mantissa of .I x scaled to the range [1,2). @@ -43,10 +43,10 @@ sin, sinf, sinl \- sine function .sp Link with \-lm. .SH DESCRIPTION -The \fBsin()\fP function returns the sine of \fIx\fP, where \fIx\fP is +The \fBsin\fP() function returns the sine of \fIx\fP, where \fIx\fP is given in radians. .SH "RETURN VALUE" -The \fBsin()\fP function returns a value between \-1 and 1. +The \fBsin\fP() function returns a value between \-1 and 1. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899. The float and the long double variants are C99 requirements. diff --git a/man3/sinh.3 b/man3/sinh.3 index b704e63a..cc601e34 100644 --- a/man3/sinh.3 +++ b/man3/sinh.3 @@ -45,7 +45,7 @@ sinh, sinhf, sinhl \- hyperbolic sine function .sp Link with \-lm. .SH DESCRIPTION -The \fBsinh()\fP function returns the hyperbolic sine of \fIx\fP, which +The \fBsinh\fP() function returns the hyperbolic sine of \fIx\fP, which is defined mathematically as (exp(x) \- exp(\-x)) / 2. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899 (C99). diff --git a/man3/sleep.3 b/man3/sleep.3 index 8a906ad8..0a6a538e 100644 --- a/man3/sleep.3 +++ b/man3/sleep.3 @@ -31,7 +31,7 @@ sleep \- Sleep for the specified number of seconds .BI "unsigned int sleep(unsigned int " "seconds" ); .fi .SH DESCRIPTION -.B sleep() +.BR sleep () makes the current process sleep until .I seconds seconds have elapsed or a signal arrives which is not ignored. @@ -40,17 +40,17 @@ Zero if the requested time has elapsed, or the number of seconds left to sleep. .SH "CONFORMING TO" POSIX.1 .SH BUGS -.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. .PP Using -.B longjmp() +.BR longjmp () from a signal handler or modifying the handling of .B SIGALRM while sleeping will cause undefined results. diff --git a/man3/sqrt.3 b/man3/sqrt.3 index a28f53c6..fa172f85 100644 --- a/man3/sqrt.3 +++ b/man3/sqrt.3 @@ -43,7 +43,7 @@ sqrt, sqrtf, sqrtl \- square root function .sp Link with \-lm. .SH DESCRIPTION -The \fBsqrt()\fP function returns the non-negative square root of \fIx\fP. +The \fBsqrt\fP() function returns the non-negative square root of \fIx\fP. It fails and sets \fIerrno\fP to EDOM, if \fIx\fP is negative. .SH ERRORS .TP diff --git a/man3/stdio_ext.3 b/man3/stdio_ext.3 index f996b476..ab6c8723 100644 --- a/man3/stdio_ext.3 +++ b/man3/stdio_ext.3 @@ -52,46 +52,46 @@ Solaris introduced routines to allow portable access to the internals of the FILE structure, and glibc also implemented these. .LP The -.B __fbufsize() +.BR __fbufsize () function returns the size of the buffer currently used by the given stream. .LP The -.B __fpending() +.BR __fpending () function returns the number of bytes in the output buffer. For wide-oriented streams the unit is wide characters. This function is undefined on buffers in reading mode, or opened read-only. .LP The -.B __flbf() +.BR __flbf () function returns a non-zero value if the stream is line-buffered, and zero otherwise. .LP The -.B __freadable() +.BR __freadable () function returns a non-zero value if the stream allows reading, and zero otherwise. .LP The -.B __fwritable() +.BR __fwritable () function returns a non-zero value if the stream allows writing, and zero otherwise. .LP The -.B __freading() +.BR __freading () function returns a non-zero value if the stream is read-only, or if the last operation on the stream was a read operation, and zero otherwise. .LP The -.B __fwriting() +.BR __fwriting () function returns a non-zero value if the stream is write-only (or append-only), or if the last operation on the stream was a write operation, and zero otherwise. .LP The -.B __fsetlocking() +.BR __fsetlocking () function can be used to select the desired type of locking on the stream. It returns the current type. The .I type @@ -111,12 +111,12 @@ will not do locking until the state is reset to FSETLOCKING_INTERNAL. Don't change the type of locking. (Only return it.) .LP The -.B _flushlbf() +.BR _flushlbf () function flushes all line-buffered streams. (Presumably so that output to a terminal is forced out, say before reading keyboard input.) .LP The -.B __fpurge() +.BR __fpurge () function discards the contents of the stream's buffer. .SH "SEE ALSO" .BR flockfile (3), diff --git a/man3/stpcpy.3 b/man3/stpcpy.3 index d3c65415..b6b98c25 100644 --- a/man3/stpcpy.3 +++ b/man3/stpcpy.3 @@ -34,12 +34,12 @@ stpcpy \- copy a string returning a pointer to its end .BI "char *stpcpy(char *" dest ", const char *" src ); .fi .SH DESCRIPTION -The \fBstpcpy()\fP function copies the string pointed to by \fIsrc\fP +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 must be large enough to receive the copy. .SH "RETURN VALUE" -\fBstpcpy()\fP returns a pointer to the \fBend\fP of the string +\fBstpcpy\fP() returns a pointer to the \fBend\fP of the string \fIdest\fP (that is, the address of the terminating null character) rather than the beginning. .SH EXAMPLE diff --git a/man3/strcasecmp.3 b/man3/strcasecmp.3 index b52b89ed..a4e46059 100644 --- a/man3/strcasecmp.3 +++ b/man3/strcasecmp.3 @@ -37,15 +37,15 @@ strcasecmp, strncasecmp \- compare two strings ignoring case .BI "int strncasecmp(const char *" s1 ", const char *" s2 ", size_t " n ); .fi .SH DESCRIPTION -The \fBstrcasecmp()\fP function compares the two strings \fIs1\fP and +The \fBstrcasecmp\fP() function compares the two strings \fIs1\fP and \fIs2\fP, ignoring the case of the characters. 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 -The \fBstrncasecmp()\fP function is similar, except it only compares +The \fBstrncasecmp\fP() function is similar, except it only compares the first \fIn\fP characters of \fIs1\fP. .SH "RETURN VALUE" -The \fBstrcasecmp()\fP and \fBstrncasecmp()\fP functions return +The \fBstrcasecmp\fP() and \fBstrncasecmp\fP() functions return an integer less than, equal to, or greater than zero if \fIs1\fP (or the first \fIn\fP bytes thereof) is found, respectively, to be less than, to match, or be greater than \fIs2\fP. diff --git a/man3/strcat.3 b/man3/strcat.3 index 9c7cde3f..a3662fe0 100644 --- a/man3/strcat.3 +++ b/man3/strcat.3 @@ -37,18 +37,18 @@ strcat, strncat \- concatenate two strings .BI "char *strncat(char *" dest ", const char *" src ", size_t " n ); .fi .SH DESCRIPTION -The \fBstrcat()\fP function appends the \fIsrc\fP string to the +The \fBstrcat\fP() function appends the \fIsrc\fP string to the \fIdest\fP string overwriting the `\\0' character at the end of \fIdest\fP, and then adds a terminating `\\0' character. The strings may not overlap, and the \fIdest\fP string must have enough space for the result. .PP -The \fBstrncat()\fP function is similar, except that it will use +The \fBstrncat\fP() function is similar, except that it will use at most \fIn\fP characters from \fIsrc\fP. Since the result is always terminated with `\\0', at most \fIn\fP+1 characters are written. .SH "RETURN VALUE" -The \fBstrcat()\fP and \fBstrncat()\fP functions return a pointer +The \fBstrcat\fP() and \fBstrncat\fP() functions return a pointer to the resulting string \fIdest\fP. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899 diff --git a/man3/strchr.3 b/man3/strchr.3 index c5c9baf7..0c25428e 100644 --- a/man3/strchr.3 +++ b/man3/strchr.3 @@ -37,16 +37,16 @@ strchr, strrchr \- locate character in string .BI "char *strrchr(const char *" s ", int " c ); .fi .SH DESCRIPTION -The \fBstrchr()\fP function returns a pointer to the first occurrence +The \fBstrchr\fP() function returns a pointer to the first occurrence of the character \fIc\fP in the string \fIs\fP. .PP -The \fBstrrchr()\fP function returns a pointer to the last occurrence +The \fBstrrchr\fP() function returns a pointer to the last occurrence of the character \fIc\fP in the string \fIs\fP. .PP Here "character" means "byte"; these functions do not work with wide or multi-byte characters. .SH "RETURN VALUE" -The \fBstrchr()\fP and \fBstrrchr()\fP functions return a pointer to +The \fBstrchr\fP() and \fBstrrchr\fP() functions return a pointer to the matched character or NULL if the character is not found. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899 diff --git a/man3/strcmp.3 b/man3/strcmp.3 index 0f9c2cb9..faee524e 100644 --- a/man3/strcmp.3 +++ b/man3/strcmp.3 @@ -39,15 +39,15 @@ strcmp, strncmp \- compare two strings .BI "int strncmp(const char *" s1 ", const char *" s2 ", size_t " n ); .fi .SH DESCRIPTION -The \fBstrcmp()\fP function compares the two strings \fIs1\fP and +The \fBstrcmp\fP() function compares the two strings \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. .PP -The \fBstrncmp()\fP function is similar, except it only compares +The \fBstrncmp\fP() function is similar, except it only compares the first (at most) \fIn\fP characters of \fIs1\fP and \fIs2\fP. .SH "RETURN VALUE" -The \fBstrcmp()\fP and \fBstrncmp()\fP functions return an integer +The \fBstrcmp\fP() and \fBstrncmp\fP() functions return an integer less than, equal to, or greater than zero if \fIs1\fP (or the first \fIn\fP bytes thereof) is found, respectively, to be less than, to match, or be greater than \fIs2\fP. diff --git a/man3/strcoll.3 b/man3/strcoll.3 index c280cde9..b8fdcd39 100644 --- a/man3/strcoll.3 +++ b/man3/strcoll.3 @@ -35,22 +35,22 @@ strcoll \- compare two strings using the current locale .BI "int strcoll(const char *" s1 ", const char *" s2 ); .fi .SH DESCRIPTION -The \fBstrcoll()\fP function compares the two strings \fIs1\fP and +The \fBstrcoll\fP() function compares the two strings \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. 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" -The \fBstrcoll()\fP function returns an integer less than, equal to, +The \fBstrcoll\fP() function 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, when both are interpreted as appropriate for the current locale. .SH "CONFORMING TO" SVID 3, 4.3BSD, ISO 9899 .SH NOTES -In the \fI"POSIX"\fP or \fI"C"\fP locales \fBstrcoll()\fP is equivalent to -\fBstrcmp()\fP. +In the \fI"POSIX"\fP or \fI"C"\fP locales \fBstrcoll\fP() is equivalent to +\fBstrcmp\fP(). .SH "SEE ALSO" .BR bcmp (3), .BR memcmp (3), diff --git a/man3/strcpy.3 b/man3/strcpy.3 index 57896b8e..d996edc5 100644 --- a/man3/strcpy.3 +++ b/man3/strcpy.3 @@ -40,12 +40,12 @@ strcpy, strncpy \- copy a string .BI "char *strncpy(char *" dest ", const char *" src ", size_t " n ); .fi .SH DESCRIPTION -The \fBstrcpy()\fP function copies the string pointed to by \fIsrc\fP +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 must be large enough to receive the copy. .PP -The \fBstrncpy()\fP function is similar, except that not more than +The \fBstrncpy\fP() function is similar, except that not more than \fIn\fP bytes of \fIsrc\fP are copied. Thus, if there is no null byte among the first \fIn\fP bytes of \fIsrc\fP, the result will not be null-terminated. @@ -58,10 +58,10 @@ the remainder of .I dest will be padded with nulls. .SH "RETURN VALUE" -The \fBstrcpy()\fP and \fBstrncpy()\fP functions return a pointer to +The \fBstrcpy\fP() and \fBstrncpy\fP() functions return a pointer to the destination string \fIdest\fP. .SH BUGS -If the destination string of a \fBstrcpy()\fP is not large enough +If the destination string of a \fBstrcpy\fP() is not large enough (that is, if the programmer was stupid/lazy, and failed to check the size before copying) then anything might happen. Overflowing fixed length strings is a favourite cracker technique. diff --git a/man3/strdup.3 b/man3/strdup.3 index e19c03cf..075982bb 100644 --- a/man3/strdup.3 +++ b/man3/strdup.3 @@ -47,11 +47,11 @@ strdup, strndup, strdupa, strndupa \- duplicate a string .sp .fi .SH DESCRIPTION -The \fBstrdup()\fP function returns a pointer to a new string which +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 obtained with \fBmalloc\fP(3), and can be freed with \fBfree\fP(3). -The \fBstrndup()\fP function is similar, but only copies at most +The \fBstrndup\fP() function is similar, but only copies at most \fIn\fP characters. If \fIs\fP is longer than \fIn\fP, only \fIn\fP characters are copied, and a terminating NUL is added. @@ -60,7 +60,7 @@ to allocate the buffer. They are only available when using the GNU GCC suite, and suffer from the same limitations described in \fBalloca(3)\fP. .SH "RETURN VALUE" -The \fBstrdup()\fP function returns a pointer to the duplicated +The \fBstrdup\fP() function returns a pointer to the duplicated string, or NULL if insufficient memory was available. .SH ERRORS .TP @@ -69,7 +69,7 @@ Insufficient memory available to allocate duplicate string. .SH "CONFORMING TO" .\" 4.3BSD-Reno, not (first) 4.3BSD. SVID 3, 4.3BSD. -\fBstrndup()\fP, \fBstrdupa()\fP, and \fBstrndupa()\fP are GNU extensions. +\fBstrndup\fP(), \fBstrdupa\fP(), and \fBstrndupa\fP() are GNU extensions. .SH "SEE ALSO" .BR alloca (3), .BR calloc (3), diff --git a/man3/strerror.3 b/man3/strerror.3 index fd8ba081..533b8cac 100644 --- a/man3/strerror.3 +++ b/man3/strerror.3 @@ -46,25 +46,25 @@ strerror, strerror_r \- return string describing error code .BI "int strerror_r(int " errnum ", char *" buf ", size_t " n ); .fi .SH DESCRIPTION -The \fBstrerror()\fP function returns a string describing the error +The \fBstrerror\fP() function returns a string describing the error code passed in the argument \fIerrnum\fP, possibly using the LC_MESSAGES part of the current locale to select the appropriate language. This string must not be modified by the application, but may be -modified by a subsequent call to \fBperror()\fP or \fBstrerror()\fP. +modified by a subsequent call to \fBperror\fP() or \fBstrerror\fP(). No library function will modify this string. -The \fBstrerror_r()\fP function is similar to \fBstrerror()\fP, but is +The \fBstrerror_r\fP() function is similar to \fBstrerror\fP(), but is thread safe. It returns the string in the user-supplied buffer .I buf of length .IR n . .SH "RETURN VALUE" -The \fBstrerror()\fP function returns the appropriate error description +The \fBstrerror\fP() function returns the appropriate error description string, or an unknown error message if the error code is unknown. The value of \fIerrno\fP is not changed for a successful call, and is set to a non-zero value upon error. -The \fBstrerror_r()\fP function returns 0 on success and \-1 on failure, +The \fBstrerror_r\fP() function returns 0 on success and \-1 on failure, setting \fIerrno\fP. .SH ERRORS @@ -80,7 +80,7 @@ Insufficient storage was supplied to contain the error description string. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO/IEC 9899:1990 (C89). .br -.BR strerror_r() +.BR strerror_r () with prototype as given above is specified by SUSv3, and was in use under Digital Unix and HP Unix. An incompatible function, with prototype .sp diff --git a/man3/strfmon.3 b/man3/strfmon.3 index 3e3102b0..e26609c5 100644 --- a/man3/strfmon.3 +++ b/man3/strfmon.3 @@ -31,7 +31,7 @@ strfmon \- convert monetary value to a string .B "...);" .fi .SH DESCRIPTION -The \fBstrfmon()\fP function formats the specified amounts +The \fBstrfmon\fP() function formats the specified amounts according to the format specification \fIformat\fP and places the result in the character array \fIs\fP of size \fImax\fP. .PP @@ -101,7 +101,7 @@ international currency format. One argument of type double is converted using the locale's national currency format. .SH "RETURN VALUE" -The \fBstrfmon()\fP function returns the number of characters placed +The \fBstrfmon\fP() function returns the number of characters placed in the array \fIs\fP, not including the terminating NUL character, provided the string, including the terminating NUL, fits. Otherwise, it sets diff --git a/man3/strfry.3 b/man3/strfry.3 index 8a67e1b0..9b4323cc 100644 --- a/man3/strfry.3 +++ b/man3/strfry.3 @@ -37,14 +37,14 @@ strfry \- randomize a string .BI "char *strfry(char *" string ); .fi .SH DESCRIPTION -The \fBstrfry()\fP function randomizes the contents of \fIstring\fP by +The \fBstrfry\fP() function randomizes the contents of \fIstring\fP by using \fBrand\fP(3) to randomly swap characters in the string. The result is an anagram of \fIstring\fP. .SH "RETURN VALUE" -The \fBstrfry()\fP functions returns a pointer to the randomized +The \fBstrfry\fP() functions returns a pointer to the randomized string. .SH "CONFORMING TO" -The \fBstrfry()\fP function is unique to the Linux C Library and +The \fBstrfry\fP() function is unique to the Linux C Library and GNU C Library. .SH "SEE ALSO" .BR memfrob (3) diff --git a/man3/strftime.3 b/man3/strftime.3 index 3b7803b1..3472c762 100644 --- a/man3/strftime.3 +++ b/man3/strftime.3 @@ -41,7 +41,7 @@ strftime \- format date and time .BI " const struct tm *" tm ); .fi .SH DESCRIPTION -The \fBstrftime()\fP function formats the broken-down time \fItm\fP +The \fBstrftime\fP() function formats the broken-down time \fItm\fP according to the format specification \fIformat\fP and places the result in the character array \fIs\fP of size \fImax\fP. .PP @@ -225,7 +225,7 @@ See also .BR ctime (3). .SH "RETURN VALUE" -The \fBstrftime()\fP function returns the number of characters placed +The \fBstrftime\fP() function returns the number of characters placed in the array \fIs\fP, not including the terminating NUL character, provided the string, including the terminating NUL, fits. Otherwise, it returns 0, and the contents of the array is undefined. diff --git a/man3/strlen.3 b/man3/strlen.3 index e325810e..ce09a141 100644 --- a/man3/strlen.3 +++ b/man3/strlen.3 @@ -35,10 +35,10 @@ strlen \- calculate the length of a string .BI "size_t strlen(const char *" s ); .fi .SH DESCRIPTION -The \fBstrlen()\fP function calculates the length of the string +The \fBstrlen\fP() function calculates the length of the string \fIs\fP, not including the terminating `\\0' character. .SH "RETURN VALUE" -The \fBstrlen()\fP function returns the number of characters in \fIs\fP. +The \fBstrlen\fP() function returns the number of characters in \fIs\fP. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899 .SH "SEE ALSO" diff --git a/man3/strpbrk.3 b/man3/strpbrk.3 index e748dd4e..ac508116 100644 --- a/man3/strpbrk.3 +++ b/man3/strpbrk.3 @@ -35,10 +35,10 @@ strpbrk \- search a string for any of a set of characters .BI "char *strpbrk(const char *" s ", const char *" accept ); .fi .SH DESCRIPTION -The \fBstrpbrk()\fP function locates the first occurrence in the +The \fBstrpbrk\fP() function locates the first occurrence in the string \fIs\fP of any of the characters in the string \fIaccept\fP. .SH "RETURN VALUE" -The \fBstrpbrk()\fP function returns a pointer to the character in +The \fBstrpbrk\fP() function returns a pointer to the character in \fIs\fP that matches one of the characters in \fIaccept\fP, or NULL if no such character is found. .SH "CONFORMING TO" diff --git a/man3/strptime.3 b/man3/strptime.3 index 5c50c8b5..8f588849 100644 --- a/man3/strptime.3 +++ b/man3/strptime.3 @@ -38,9 +38,9 @@ strptime \- convert a string representation of time to a time tm structure .BI "struct tm *" tm ); .SH DESCRIPTION The -.B strptime() +.BR strptime () function is the converse function to -.B strftime() +.BR strftime () and converts the character string pointed to by .I s to values which are stored in the @@ -66,7 +66,7 @@ whitespace characters in the input string. There should be white\%space or other alphanumeric characters between any two field descriptors. .PP -The \fBstrptime()\fP function processes the input string from left +The \fBstrptime\fP() function processes the input string from left to right. Each of the three possible input elements (whitespace, literal, or format) are handled one after the other. If the input cannot be matched to the format string the function stops. The @@ -260,14 +260,14 @@ not processed in this function call. In case the input string contains more characters than required by the format string the return value points right after the last consumed input character. In case the whole input string is consumed the return value points to the NUL -byte at the end of the string. If \fBstrptime()\fP fails to match all +byte at the end of the string. If \fBstrptime\fP() fails to match all of the format string and therefore an error occurred the function returns \fBNULL\fP. .SH "CONFORMING TO" XPG4, SUSv2, POSIX 1003.1-2001. .SH EXAMPLE -The following example demonstrates the use of \fBstrptime()\fP -and \fBstrftime()\fP. +The following example demonstrates the use of \fBstrptime\fP() +and \fBstrftime\fP(). .sp .nf .ne 12 diff --git a/man3/strsep.3 b/man3/strsep.3 index ad8a9eba..3a8fae12 100644 --- a/man3/strsep.3 +++ b/man3/strsep.3 @@ -38,7 +38,7 @@ strsep \- extract token from string .BI "char *strsep(char **" stringp ", const char *" delim ); .fi .SH DESCRIPTION -If *\fIstringp\fP is NULL, the \fBstrsep()\fP function returns NULL +If *\fIstringp\fP is NULL, the \fBstrsep\fP() function returns NULL and does nothing else. Otherwise, this function finds the first token in the string *\fIstringp\fP, where tokens are delimited by symbols in the string \fIdelim\fP. @@ -48,14 +48,14 @@ and *\fIstringp\fP is updated to point past the token. In case no delimiter was found, the token is taken to be the entire string *\fIstringp\fP, and *\fIstringp\fP is made NULL. .SH "RETURN VALUE" -The \fBstrsep()\fP function returns a pointer to the token, +The \fBstrsep\fP() function returns a pointer to the token, that is, it returns the original value of *\fIstringp\fP. .SH NOTES -The \fBstrsep()\fP function was introduced as a replacement for -\fBstrtok()\fP, since the latter cannot handle empty fields. -However, \fBstrtok()\fP conforms to ANSI-C and hence is more portable. +The \fBstrsep\fP() function was introduced as a replacement for +\fBstrtok\fP(), since the latter cannot handle empty fields. +However, \fBstrtok\fP() conforms to ANSI-C and hence is more portable. .SH BUGS -This function suffers from the same problems as \fBstrtok()\fP. +This function suffers from the same problems as \fBstrtok\fP(). In particular, it modifies the original string. Avoid it. .SH "CONFORMING TO" 4.4BSD diff --git a/man3/strsignal.3 b/man3/strsignal.3 index c68e4e57..120fb1ae 100644 --- a/man3/strsignal.3 +++ b/man3/strsignal.3 @@ -39,15 +39,15 @@ strsignal \- return string describing signal .BI "extern const char * const " sys_siglist []; .fi .SH DESCRIPTION -The \fBstrsignal()\fP function returns a string describing the signal +The \fBstrsignal\fP() function returns a string describing the signal number passed in the argument \fIsig\fP. The string can only be used -until the next call to \fBstrsignal()\fP. +until the next call to \fBstrsignal\fP(). .PP The array \fIsys_siglist\fP holds the signal description strings -indexed by signal number. The \fBstrsignal()\fP function should be +indexed by signal number. The \fBstrsignal\fP() function should be used if possible instead of this array. .SH "RETURN VALUE" -The \fBstrsignal()\fP function returns the appropriate description +The \fBstrsignal\fP() function returns the appropriate description string, or an unknown signal message if the signal number is invalid. On some systems (but not on Linux), a \fBNULL\fP pointer may be returned instead for an invalid signal number. diff --git a/man3/strspn.3 b/man3/strspn.3 index 94322419..c3f546a7 100644 --- a/man3/strspn.3 +++ b/man3/strspn.3 @@ -37,19 +37,19 @@ strspn, strcspn \- search a string for a set of characters .BI "size_t strcspn(const char *" s ", const char *" reject ); .fi .SH DESCRIPTION -The \fBstrspn()\fP function calculates the length of the initial +The \fBstrspn\fP() function calculates the length of the initial segment of \fIs\fP which consists entirely of characters in \fIaccept\fP. .PP -The \fBstrcspn()\fP function calculates the length of the initial +The \fBstrcspn\fP() function calculates the length of the initial segment of \fIs\fP which consists entirely of characters not in \fIreject\fP. .SH "RETURN VALUE" -The \fBstrspn()\fP function returns the number of characters in +The \fBstrspn\fP() function returns the number of characters in the initial segment of \fIs\fP which consist only of characters from \fIaccept\fP. .PP -The \fBstrcspn()\fP function returns the number of characters in +The \fBstrcspn\fP() function returns the number of characters in the initial segment of \fIs\fP which are not in the string \fIreject\fP. .SH "CONFORMING TO" diff --git a/man3/strstr.3 b/man3/strstr.3 index 8e4ad22b..3c76baee 100644 --- a/man3/strstr.3 +++ b/man3/strstr.3 @@ -44,23 +44,23 @@ strstr \- locate a substring .BI "char *strcasestr(const char *" haystack ", const char *" needle ); .fi .SH DESCRIPTION -The \fBstrstr()\fP function finds the first occurrence of the substring +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. -The \fBstrcasestr()\fP function is like \fBstrstr()\fP, +The \fBstrcasestr\fP() function is like \fBstrstr\fP(), but ignores the case of both arguments. .SH "RETURN VALUE" These functions return a pointer to the beginning of the substring, or NULL if the substring is not found. .SH BUGS Early versions of Linux libc (like 4.5.26) would not allow -an empty \fIneedle\fP argument for \fBstrstr()\fP. +an empty \fIneedle\fP argument for \fBstrstr\fP(). Later versions (like 4.6.27) work correctly, and return \fIhaystack\fP when \fIneedle\fP is empty. .SH "CONFORMING TO" -The \fBstrstr()\fP function conforms to ISO 9899. -The \fBstrcasestr()\fP function is a non-standard extension. +The \fBstrstr\fP() function conforms to ISO 9899. +The \fBstrcasestr\fP() function is a non-standard extension. .SH "SEE ALSO" .BR index (3), .BR memchr (3), diff --git a/man3/strtoimax.3 b/man3/strtoimax.3 index 0db4360e..a1661897 100644 --- a/man3/strtoimax.3 +++ b/man3/strtoimax.3 @@ -33,9 +33,9 @@ strtoimax, strtoumax \- convert string to integer .fi .SH DESCRIPTION These functions are just like -.B strtol() +.BR strtol () and -.BR strtoul() , +.BR strtoul (), except that they return a value of type .B intmax_t and diff --git a/man3/strtok.3 b/man3/strtok.3 index a2b52901..1ebb1001 100644 --- a/man3/strtok.3 +++ b/man3/strtok.3 @@ -38,21 +38,21 @@ A `token' is a nonempty string of characters not occurring in the string \fIdelim\fP, followed by \e0 or by a character occurring in \fIdelim\fP. .PP -The \fBstrtok()\fP function can be used to parse the string \fIs\fP -into tokens. The first call to \fBstrtok()\fP should have \fIs\fP +The \fBstrtok\fP() function can be used to parse the string \fIs\fP +into tokens. The first call to \fBstrtok\fP() should have \fIs\fP as its first argument. Subsequent calls should have the first argument set to NULL. Each call returns a pointer to the next token, or NULL when no more tokens are found. .PP If a token ends with a delimiter, this delimiting character is overwritten with a \e0 and a pointer to the next character is -saved for the next call to \fBstrtok()\fP. +saved for the next call to \fBstrtok\fP(). The delimiter string \fIdelim\fP may be different for each call. .PP The -.B strtok_r() +.BR strtok_r () function is a reentrant version of the -.B strtok() +.BR strtok () function, which instead of using its own static buffer, requires a pointer to a user allocated char*. This pointer, the .I ptrptr @@ -90,7 +90,7 @@ function uses a static buffer while parsing, so it's not thread safe. Use if this matters to you. .RE .SH "RETURN VALUE" -The \fBstrtok()\fP function returns a pointer to the next token, or +The \fBstrtok\fP() function returns a pointer to the next token, or NULL if there are no more tokens. .SH "CONFORMING TO" .TP diff --git a/man3/strtol.3 b/man3/strtol.3 index 4664eeaf..a86472a4 100644 --- a/man3/strtol.3 +++ b/man3/strtol.3 @@ -40,7 +40,7 @@ strtol, strtoll, strtoq \- convert a string to a long integer .BI "strtoll(const char *" nptr ", char **" endptr ", int " base ); .fi .SH DESCRIPTION -The \fBstrtol()\fP function converts the initial part of the string +The \fBstrtol\fP() function converts the initial part of the string in \fInptr\fP to a long integer value according to the given \fIbase\fP, which must be between 2 and 36 inclusive, or be the special value 0. .PP @@ -59,25 +59,25 @@ valid digit in the given base. (In bases above 10, the letter `A' in either upper or lower case represents 10, `B' represents 11, and so forth, with `Z' representing 35.) .PP -If \fIendptr\fP is not NULL, \fBstrtol()\fP stores the address of the +If \fIendptr\fP is not NULL, \fBstrtol\fP() stores the address of the first invalid character in \fI*endptr\fP. If there were no digits at -all, \fBstrtol()\fP stores the original value of \fInptr\fP in +all, \fBstrtol\fP() stores the original value of \fInptr\fP in \fI*endptr\fP (and returns 0). In particular, if \fI*nptr\fP is not `\\0' but \fI**endptr\fP is `\\0' on return, the entire string is valid. .PP The -.B strtoll() +.BR strtoll () function works just like the -.B strtol() +.BR strtol () function but returns a long long integer value. .SH "RETURN VALUE" -The \fBstrtol()\fP function returns the result of the conversion, +The \fBstrtol\fP() function returns the result of the conversion, unless the value would underflow or overflow. If an underflow occurs, -\fBstrtol()\fP returns LONG_MIN. If an overflow occurs, \fBstrtol()\fP +\fBstrtol\fP() returns LONG_MIN. If an overflow occurs, \fBstrtol\fP() returns LONG_MAX. In both cases, \fIerrno\fP is set to ERANGE. Precisely the same holds for -.B strtoll() +.BR strtoll () (with LLONG_MIN and LLONG_MAX instead of LONG_MIN and LONG_MAX). .SH ERRORS .TP @@ -109,13 +109,13 @@ BSD also has with completely analogous definition. Depending on the wordsize of the current architecture, this may be equivalent to -.B strtoll() +.BR strtoll () or to -.BR strtol() . +.BR strtol (). .SH "CONFORMING TO" -.B strtol() +.BR strtol () conforms to SVID 3, 4.3BSD, ISO 9899 (C99) and POSIX, and -.B strtoll() +.BR strtoll () to ISO 9899 (C99) and POSIX 1003.1-2001. .SH "SEE ALSO" .BR atof (3), diff --git a/man3/strtoul.3 b/man3/strtoul.3 index 839f9b2a..54c57d99 100644 --- a/man3/strtoul.3 +++ b/man3/strtoul.3 @@ -42,7 +42,7 @@ strtoul, strtoull, strtouq \- convert a string to an unsigned long integer .BI "strtoull(const char *" nptr ", char **" endptr ", int " base ); .fi .SH DESCRIPTION -The \fBstrtoul()\fP function converts the initial part of the string +The \fBstrtoul\fP() function converts the initial part of the string in \fInptr\fP to an unsigned long integer value according to the given \fIbase\fP, which must be between 2 and 36 inclusive, or be the special value 0. @@ -62,26 +62,26 @@ valid digit in the given base. (In bases above 10, the letter `A' in either upper or lower case represents 10, `B' represents 11, and so forth, with `Z' representing 35.) .PP -If \fIendptr\fP is not NULL, \fBstrtoul()\fP stores the address of the +If \fIendptr\fP is not NULL, \fBstrtoul\fP() stores the address of the first invalid character in \fI*endptr\fP. If there were no digits at -all, \fBstrtoul()\fP stores the original value of \fInptr\fP in +all, \fBstrtoul\fP() stores the original value of \fInptr\fP in \fI*endptr\fP (and returns 0). In particular, if \fI*nptr\fP is not `\\0' but \fI**endptr\fP is `\\0' on return, the entire string is valid. .PP The -.B strtoull() +.BR strtoull () function works just like the -.B strtoul() +.BR strtoul () function but returns an unsigned long long integer value. .SH "RETURN VALUE" -The \fBstrtoul()\fP function returns either the result of the conversion +The \fBstrtoul\fP() function returns either the result of the conversion or, if there was a leading minus sign, the negation of the result of the conversion, unless the original (non-negated) value would overflow; in -the latter case, \fBstrtoul()\fP returns ULONG_MAX and sets the global +the latter case, \fBstrtoul\fP() returns ULONG_MAX and sets the global variable \fIerrno\fP to ERANGE. Precisely the same holds for -.B strtoull() +.BR strtoull () (with ULLONG_MAX instead of ULONG_MAX). .SH ERRORS .TP @@ -113,13 +113,13 @@ BSD also has with completely analogous definition. Depending on the wordsize of the current architecture, this may be equivalent to -.B strtoull() +.BR strtoull () or to -.BR strtoul() . +.BR strtoul (). .SH "CONFORMING TO" -.B strtoul() +.BR strtoul () conforms to SVID 3, 4.3BSD, ISO 9899 (C99) and POSIX, and -.BR strtoull() +.BR strtoull () to ISO 9899 (C99) and POSIX 1003.1-2001. .SH "SEE ALSO" .BR atof (3), diff --git a/man3/strverscmp.3 b/man3/strverscmp.3 index 17e93f7f..3697f78b 100644 --- a/man3/strverscmp.3 +++ b/man3/strverscmp.3 @@ -72,7 +72,7 @@ come before digit strings with fewer leading zeroes). Thus, the ordering is .IR 000 ", " 00 ", " 01 ", " 010 ", " 09 ", " 0 ", " 1 ", " 9 ", " 10 . .SH "RETURN VALUE" -The \fBstrverscmp()\fP function returns an integer +The \fBstrverscmp\fP() function returns an integer less than, equal to, or greater than zero if \fIs1\fP is found, respectively, to be earlier than, equal to, or later than \fIs2\fP. diff --git a/man3/strxfrm.3 b/man3/strxfrm.3 index 9de984e5..08757ebe 100644 --- a/man3/strxfrm.3 +++ b/man3/strxfrm.3 @@ -35,23 +35,23 @@ strxfrm \- string transformation .BI "size_t strxfrm(char *" dest ", const char *" src ", size_t " n ); .fi .SH DESCRIPTION -The \fBstrxfrm()\fP function transforms the \fIsrc\fP string into a -form such that the result of \fBstrcmp()\fP on two strings that have -been transformed with \fBstrxfrm()\fP is the same as the result of -\fBstrcoll()\fP on the two strings before their transformation. The +The \fBstrxfrm\fP() function transforms the \fIsrc\fP string into a +form such that the result of \fBstrcmp\fP() on two strings that have +been transformed with \fBstrxfrm\fP() is the same as the result of +\fBstrcoll\fP() on the two strings before their transformation. The first \fIn\fP characters of the transformed string are placed in \fIdest\fP. The transformation is based on the program's current locale for category \fILC_COLLATE\fP. (See \fBsetlocale\fP(3)). .SH "RETURN VALUE" -The \fBstrxfrm()\fP function returns the number of bytes required to +The \fBstrxfrm\fP() function returns the number of bytes required to store the transformed string in \fIdest\fP excluding the terminating `\\0' character. If the value returned is \fIn\fP or more, the contents of \fIdest\fP are indeterminate. .SH "CONFORMING TO" SVID 3, 4.3BSD, ISO 9899 .SH NOTES -In the \fI"POSIX"\fP or \fI"C"\fP locales \fBstrxfrm()\fP is equivalent to -copying the string with \fBstrncpy()\fP. +In the \fI"POSIX"\fP or \fI"C"\fP locales \fBstrxfrm\fP() is equivalent to +copying the string with \fBstrncpy\fP(). .SH "SEE ALSO" .BR bcmp (3), .BR memcmp (3), diff --git a/man3/swab.3 b/man3/swab.3 index c3a7020a..ed5abaee 100644 --- a/man3/swab.3 +++ b/man3/swab.3 @@ -36,7 +36,7 @@ swab \- swap adjacent bytes .BI "void swab(const void *" from ", void *" to ", ssize_t " n ); .fi .SH DESCRIPTION -The \fBswab()\fP function copies \fIn\fP bytes from the array pointed +The \fBswab\fP() function copies \fIn\fP bytes from the array pointed to by \fIfrom\fP to the array pointed to by \fIto\fP, exchanging adjacent even and odd bytes. This function is used to exchange data between machines that have different low/high byte ordering. @@ -46,7 +46,7 @@ When \fIn\fP is positive and odd, it handles \fIn\fP-1 bytes as above, and does something unspecified with the last byte. (In other words, \fIn\fP should be even.) .SH "RETURN VALUE" -The \fBswab()\fP function returns no value. +The \fBswab\fP() function returns no value. .SH "CONFORMING TO" SVID 3, 4.3BSD, POSIX 1003.1-2001 .SH "SEE ALSO" diff --git a/man3/sysconf.3 b/man3/sysconf.3 index a84e3025..c5cd35d1 100644 --- a/man3/sysconf.3 +++ b/man3/sysconf.3 @@ -72,7 +72,7 @@ to indicate support as long as the POSIX revision has not been published yet. .\" and 999 to indicate support for options no longer present in the latest .\" standard. (?) The -.B sysconf() +.BR sysconf () argument will be .BR _SC_FOO . For a list of options, see @@ -91,7 +91,7 @@ If the constant is defined, it gives a guaranteed value, and more might actually be supported. If an application wants to take advantage of values which may change between systems, a call to -.B sysconf() +.BR sysconf () can be made. The .B @@ -100,7 +100,7 @@ argument will be .BR _SC_FOO . .SH "POSIX.1 VARIABLES" We give the name of the variable, the name of the -.B sysconf() +.BR sysconf () parameter used to inquire about its value, and a short description. .LP @@ -125,7 +125,7 @@ First, the POSIX.1 compatible values. .TP .BR ARG_MAX " - " _SC_ARG_MAX The maximum length of the arguments to the -.B exec() +.BR exec () family of functions. Must not be less than _POSIX_ARG_MAX (4096). .TP @@ -289,7 +289,7 @@ POSIX.1. It is difficult to use .B ARG_MAX because it is not specified how much of the argument space for -.B exec() +.BR exec () is consumed by the user's environment variables. .PP Some returned values may be huge; they are not suitable for allocating diff --git a/man3/syslog.3 b/man3/syslog.3 index cb5cf09a..3a7c3d22 100644 --- a/man3/syslog.3 +++ b/man3/syslog.3 @@ -48,12 +48,12 @@ closelog, openlog, syslog \- send messages to the system logger .BI "void vsyslog(int " priority ", const char *" format ", va_list " ap ); .br .SH DESCRIPTION -.B closelog() +.BR closelog () closes the descriptor being used to write to the system logger. The use of -.B closelog() +.BR closelog () is optional. .sp -.B openlog() +.BR openlog () opens a connection to the system logger for a program. The string pointed to by .I ident @@ -61,27 +61,27 @@ is prepended to every message, and is typically set to the program name. The .I option argument specifies flags which control the operation of -.B openlog() +.BR openlog () and subsequent calls to -.BR syslog() . +.BR syslog (). The .I facility argument establishes a default to be used if none is specified in subsequent calls to -.BR syslog() . +.BR syslog (). Values for .I option and .I facility are given below. The use of -.B openlog() +.BR openlog () is optional; it will automatically be called by -.B syslog() +.BR syslog () if necessary, in which case .I ident will default to NULL. .sp -.B syslog() +.BR syslog () generates a log message, which will be distributed by .BR syslogd (8). The @@ -103,9 +103,9 @@ the error message string A trailing newline is added when needed. The function -.B vsyslog() +.BR vsyslog () performs the same task as -.B syslog() +.BR syslog () with the difference that it takes a set of arguments which have been obtained using the .BR stdarg (3) @@ -117,7 +117,7 @@ This section lists the parameters used to set the values of The .I option argument to -.B openlog() +.BR openlog () is an OR of any of these: .TP .B LOG_CONS @@ -137,7 +137,7 @@ option has no effect on Linux.) The converse of .BR LOG_NDELAY ; opening of the connection is delayed until -.B syslog() +.BR syslog () is called. (This is the default, and need not be specified.) .TP .B LOG_PERROR @@ -228,12 +228,12 @@ The function can be used to restrict logging to specified levels only. .SH "CONFORMING TO" The functions -.BR openlog() , -.BR closelog() , +.BR openlog (), +.BR closelog (), and -.BR syslog() +.BR syslog () (but not -.BR vsyslog() ) +.BR vsyslog ()) are specified in SUSv2 and POSIX 1003.1-2001. POSIX 1003.1-2001 specifies only the .B LOG_USER @@ -274,10 +274,10 @@ mechanism, which is not compatible with The parameter .I ident in the call of -.B openlog() +.BR openlog () is probably stored as-is. Thus, if the string it points to is changed, -.B syslog() +.BR syslog () may start prepending the changed string, and if the string it points to ceases to exist, the results are undefined. Most portable is to use a string constant. @@ -44,7 +44,7 @@ tan, tanf, tanl \- tangent function .sp Link with \-lm. .SH DESCRIPTION -The \fBtan()\fP function returns the tangent of \fIx\fP, where \fIx\fP is +The \fBtan\fP() function returns the tangent of \fIx\fP, where \fIx\fP is given in radians. .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899. diff --git a/man3/tanh.3 b/man3/tanh.3 index 24b05e08..bc26ea1d 100644 --- a/man3/tanh.3 +++ b/man3/tanh.3 @@ -44,7 +44,7 @@ tanh, tanhf, tanhl \- hyperbolic tangent function .sp Link with \-lm. .SH DESCRIPTION -The \fBtanh()\fP function returns the hyperbolic tangent of \fIx\fP, which +The \fBtanh\fP() function returns the hyperbolic tangent of \fIx\fP, which is defined mathematically as sinh(x) / cosh(x). .SH "CONFORMING TO" SVID 3, POSIX, 4.3BSD, ISO 9899 (C99). diff --git a/man3/tcgetpgrp.3 b/man3/tcgetpgrp.3 index d4c83278..23bb9a6c 100644 --- a/man3/tcgetpgrp.3 +++ b/man3/tcgetpgrp.3 @@ -32,7 +32,7 @@ tcgetpgrp, tcsetpgrp \- get and set terminal foreground process group .BI "int tcsetpgrp(int " fd ", pid_t " pgrp ); .SH DESCRIPTION The function -.B tcgetpgrp() +.BR tcgetpgrp () returns the process group ID of the foreground process group on the terminal associated to .IR fd , @@ -40,7 +40,7 @@ which must be the controlling terminal of the calling process. .\" The process itself may be a background process. .LP The function -.B tcsetpgrp() +.BR tcsetpgrp () makes the process group with process group ID \fIpgrp\fP the foreground process group on the terminal associated to .IR fd , @@ -50,7 +50,7 @@ Moreover, \fIpgrp\fP must be a (nonempty) process group belonging to the same session as the calling process. .LP If -.B tcsetpgrp() +.BR tcsetpgrp () is called by a member of a background process group in its session, and the calling process is not blocking or ignoring SIGTTOU, a SIGTTOU signal is sent to all members of this background process group. @@ -59,7 +59,7 @@ When .I fd refers to the controlling terminal of the calling process, the function -.B tcgetpgrp() +.BR tcgetpgrp () will return the foreground process group ID of that terminal if there is one, and some value larger than 1 that is not presently a process group ID otherwise. @@ -71,7 +71,7 @@ does not refer to the controlling terminal of the calling process, is set appropriately. .LP When successful, -.B tcsetpgrp() +.BR tcsetpgrp () returns 0. Otherwise, it returns \-1, and .I errno is set appropriately. @@ -90,7 +90,7 @@ The calling process does not have a controlling terminal, or it has one but it is not described by .IR fd , or, for -.BR tcsetpgrp() , +.BR tcsetpgrp (), this controlling terminal is no longer associated with the session of the calling process. .TP diff --git a/man3/tcgetsid.3 b/man3/tcgetsid.3 index d0cc7144..7891d167 100644 --- a/man3/tcgetsid.3 +++ b/man3/tcgetsid.3 @@ -30,7 +30,7 @@ tcgetsid \- get session ID .BI "pid_t tcgetsid(int " fd ); .SH DESCRIPTION The function -.B tcgetsid() +.BR tcgetsid () returns the session ID of the current session that has the terminal associated to .I fd @@ -41,7 +41,7 @@ When .I fd refers to the controlling terminal of our session, the function -.B tcgetsid() +.BR tcgetsid () will return the session ID of this session. Otherwise, \-1 is returned, and .I errno diff --git a/man3/telldir.3 b/man3/telldir.3 index 983023a0..4fdb0aff 100644 --- a/man3/telldir.3 +++ b/man3/telldir.3 @@ -35,10 +35,10 @@ telldir \- return current location in directory stream .BI "off_t telldir(DIR *" dir ); .fi .SH DESCRIPTION -The \fBtelldir()\fP function returns the current location associated with +The \fBtelldir\fP() function returns the current location associated with the directory stream \fIdir\fP. .SH "RETURN VALUE" -On success, the \fBtelldir()\fP function returns the current location +On success, the \fBtelldir\fP() function returns the current location in the directory stream. On error, \-1 is returned, and .I errno diff --git a/man3/tempnam.3 b/man3/tempnam.3 index 27287fdd..06b34e00 100644 --- a/man3/tempnam.3 +++ b/man3/tempnam.3 @@ -31,10 +31,10 @@ tempnam \- create a name for a temporary file .fi .SH DESCRIPTION The -.B tempnam() +.BR tempnam () function returns a pointer to a string that is a valid filename, and such that a file with this name did not exist when -.B tempnam() +.BR tempnam () checked. The filename suffix of the pathname generated will start with .I pfx @@ -57,7 +57,7 @@ is used when appropriate. (iv) Finally an implementation-defined directory may be used. .SH "RETURN VALUE" The -.B tempnam() +.BR tempnam () function returns a pointer to a unique temporary filename, or NULL if a unique name cannot be generated. .SH ERRORS @@ -71,14 +71,14 @@ when the program is not set-user-ID. SVID2 specifies that the directory used under (iv) is .IR /tmp . SVID2 specifies that the string returned by -.B tempnam() +.BR tempnam () was allocated using .BR malloc (3) and hence can be freed by .BR free (3). .LP The -.B tempnam() +.BR tempnam () function generates a different string each time it is called, up to TMP_MAX (defined in .IR <stdio.h> ) diff --git a/man3/termios.3 b/man3/termios.3 index 7ef0a4e2..d01182a2 100644 --- a/man3/termios.3 +++ b/man3/termios.3 @@ -204,9 +204,9 @@ Form feed delay mask. Values are \fBFF0\fP or \fBFF1\fP. .LP (POSIX says that the baud speed is stored in the termios structure without specifying where precisely, and provides -.B cfgetispeed() +.BR cfgetispeed () and -.B cfsetispeed() +.BR cfsetispeed () for getting at it. Some systems use bits selected by CBAUD in .IR c_cflag , other systems use separate fields, e.g. @@ -349,7 +349,7 @@ Recognized when ICANON is set, and then not passed as input. End-of-file character. More precisely: this character causes the pending tty buffer to be sent to the waiting user program without waiting for end-of-line. -If it is the first character of the line, the \fIread()\fP in the +If it is the first character of the line, the \fIread\fP() in the user program returns 0, which signifies end-of-file. Recognized when ICANON is set, and then not passed as input. .TP @@ -434,14 +434,14 @@ return as soon as either at least one character has been received, or the timer times out. If neither is set, the read will return immediately, only giving the currently already available characters.) .PP -.B tcgetattr() +.BR tcgetattr () gets the parameters associated with the object referred by \fIfd\fP and stores them in the \fBtermios\fP structure referenced by \fItermios_p\fP. This function may be invoked from a background process; however, the terminal attributes may be subsequently changed by a foreground process. .LP -.B tcsetattr() +.BR tcsetattr () sets the parameters associated with the terminal (unless support is required from the underlying hardware that is not available) from the \fBtermios\fP structure referred to by \fItermios_p\fP. @@ -459,7 +459,7 @@ the change occurs after all output written to the object referred by has been transmitted, and all input that has been received but not read will be discarded before the change is made. .LP -.B tcsendbreak() +.BR tcsendbreak () transmits a continuous stream of zero-valued bits for a specific duration, if the terminal is using asynchronous serial data transmission. If \fIduration\fP is zero, it transmits zero-valued bits @@ -468,14 +468,14 @@ for at least 0.25 seconds, and not more that 0.5 seconds. If implementation-defined length of time. .LP If the terminal is not using asynchronous serial data transmission, -\fBtcsendbreak()\fP returns without taking any action. +\fBtcsendbreak\fP() returns without taking any action. .LP -.B tcdrain() +.BR tcdrain () waits until all output written to the object referred to by .I fd has been transmitted. .LP -.B tcflush() +.BR tcflush () discards data written to the object referred to by .I fd but not transmitted, or data received but not read, depending on the @@ -489,7 +489,7 @@ flushes data written but not transmitted. flushes both data received but not read, and data written but not transmitted. .LP -.B tcflow() +.BR tcflow () suspends transmission or reception of data on the object referred to by .IR fd , depending on the value of @@ -511,7 +511,7 @@ output is suspended. The baud rate functions are provided for getting and setting the values of the input and output baud rates in the \fBtermios\fP structure. The new values do not take effect -until \fBtcsetattr()\fP is successfully called. +until \fBtcsetattr\fP() is successfully called. Setting the speed to \fBB0\fP instructs the modem to "hang up". The actual bit rate corresponding to \fBB38400\fP may be altered with @@ -530,12 +530,12 @@ structure. termios_p->c_cflag |= CS8; .fi .LP -.B cfgetospeed() +.BR cfgetospeed () returns the output baud rate stored in the \fBtermios\fP structure pointed to by .IR termios_p . .LP -.B cfsetospeed() +.BR cfsetospeed () sets the output baud rate stored in the \fBtermios\fP structure pointed to by \fItermios_p\fP to \fIspeed\fP, which must be one of these constants: .nf @@ -568,25 +568,25 @@ Normally, this will disconnect the line. \fBCBAUDEX\fP is a mask for the speeds beyond those defined in POSIX.1 (57600 and above). Thus, \fBB57600\fP & \fBCBAUDEX\fP is non-zero. .LP -.B cfgetispeed() +.BR cfgetispeed () returns the input baud rate stored in the \fBtermios\fP structure. .LP -.B cfsetispeed() +.BR cfsetispeed () sets the input baud rate stored in the \fBtermios\fP structure to .IR speed . If the input baud rate is set to zero, the input baud rate will be equal to the output baud rate. .LP -.B cfsetspeed() +.BR cfsetspeed () is a 4.4 BSD extension. It will set both input and output speed. .SH "RETURN VALUE" .LP -.B cfgetispeed() +.BR cfgetispeed () returns the input baud rate stored in the \fBtermios\fP structure. .LP -.B cfgetospeed() +.BR cfgetospeed () returns the output baud rate stored in the \fBtermios\fP structure. .LP All other functions return: @@ -598,11 +598,11 @@ on failure and set to indicate the error. .LP Note that -.BI tcsetattr() +.BI tcsetattr () returns success if \fIany\fP of the requested changes could be successfully carried out. Therefore, when making multiple changes it may be necessary to follow this call with a further call to -.BI tcgetattr() +.BI tcgetattr () to check that all changes have been performed successfully. .SH NOTES diff --git a/man3/tgamma.3 b/man3/tgamma.3 index 4c9af08a..3c846a38 100644 --- a/man3/tgamma.3 +++ b/man3/tgamma.3 @@ -38,7 +38,7 @@ outside the poles: This function returns the value of the Gamma function for the argument \fIx\fP. It had to be called "true gamma function" since there is already a function -.I gamma() +.IR gamma () that returns something else. .SH ERRORS In order to check for errors, set diff --git a/man3/timegm.3 b/man3/timegm.3 index f5fd3eb6..31a5479b 100644 --- a/man3/timegm.3 +++ b/man3/timegm.3 @@ -32,9 +32,9 @@ timegm, timelocal \- inverses for gmtime and localtime .BI "time_t timegm (struct tm *" tm ); .SH DESCRIPTION The functions -.B timelocal() +.BR timelocal () and -.B timegm() +.BR timegm () are the inverses to .BR localtime (3) and @@ -42,17 +42,17 @@ and .SH NOTES These functions are GNU extensions. The -.B timelocal() +.BR timelocal () function is equivalent to the POSIX standard function .BR mktime (3). There is no reason to ever use it. .LP For a portable version of -.BR timegm() , +.BR timegm (), set the .B TZ environment variable to UTC, call -.B mktime() +.BR mktime () and restore the value of .BR TZ . Something like diff --git a/man3/tmpfile.3 b/man3/tmpfile.3 index 6ea89b77..7d3fb8d3 100644 --- a/man3/tmpfile.3 +++ b/man3/tmpfile.3 @@ -36,12 +36,12 @@ tmpfile \- create a temporary file .B FILE *tmpfile (void); .fi .SH DESCRIPTION -The \fBtmpfile()\fP function generates a unique temporary filename. +The \fBtmpfile\fP() function generates a unique temporary filename. The temporary file is then opened in binary read/write (w+b) mode. The file will be automatically deleted when it is closed or the program terminates normally. .SH "RETURN VALUE" -The \fBtmpfile()\fP function returns a stream descriptor, or NULL if +The \fBtmpfile\fP() function returns a stream descriptor, or NULL if a unique filename cannot be generated or the unique file cannot be opened. In the latter case, \fIerrno\fP is set to indicate the error. .SH ERRORS @@ -72,7 +72,7 @@ SVID 3, POSIX, 4.3BSD, ISO 9899, SUSv2 An error message may be written to \fIstdout\fP if the stream cannot be opened. .LP -The standard does not specify the directory that \fItmpfile()\fP +The standard does not specify the directory that \fItmpfile\fP() will use. Glibc will try the path prefix \fIP_tmpdir\fP defined in \fI<stdio.h>\fP, and if that fails the directory \fI/tmp\fP. .SH "SEE ALSO" diff --git a/man3/tmpnam.3 b/man3/tmpnam.3 index 8f8cd2fa..9268cd85 100644 --- a/man3/tmpnam.3 +++ b/man3/tmpnam.3 @@ -33,7 +33,7 @@ tmpnam, tmpnam_r \- create a name for a temporary file .fi .SH DESCRIPTION The -.B tmpnam() +.BR tmpnam () function returns a pointer to a string that is a valid filename, and such that a file with this name did not exist at some point in time, so that naive programmers may think it @@ -41,7 +41,7 @@ a suitable name for a temporary file. If the argument .I s is NULL this name is generated in an internal static buffer and may be overwritten by the next call to -.BR tmpnam() . +.BR tmpnam (). If .I s is not NULL, the name is copied to the character array (of length @@ -64,25 +64,25 @@ are defined in just like the TMP_MAX mentioned below.) .SH "RETURN VALUE" The -.B tmpnam() +.BR tmpnam () function returns a pointer to a unique temporary filename, or NULL if a unique name cannot be generated. .SH ERRORS No errors are defined. .SH NOTES The -.B tmpnam() +.BR tmpnam () function generates a different string each time it is called, up to TMP_MAX times. If it is called more than TMP_MAX times, the behaviour is implementation defined. .LP Portable applications that use threads cannot call -.B tmpnam() +.BR tmpnam () with NULL parameter if either _POSIX_THREADS or _POSIX_THREAD_SAFE_FUNCTIONS is defined. .LP A POSIX draft proposed to use a function -.B tmpnam_r() +.BR tmpnam_r () defined by .sp .nf diff --git a/man3/toupper.3 b/man3/toupper.3 index 3e1fe458..88c53bb9 100644 --- a/man3/toupper.3 +++ b/man3/toupper.3 @@ -34,12 +34,12 @@ toupper, tolower \- convert letter to upper or lower case .BI "int tolower(int " "c" ); .fi .SH DESCRIPTION -.B toupper() +.BR toupper () converts the letter .I c to upper case, if possible. .PP -.B tolower() +.BR tolower () converts the letter .I c to lower case, if possible. diff --git a/man3/tsearch.3 b/man3/tsearch.3 index 60cefc20..7cd34c19 100644 --- a/man3/tsearch.3 +++ b/man3/tsearch.3 @@ -191,7 +191,7 @@ in order. .SH "CONFORMING TO" SVID. The function -.B tdestroy() +.BR tdestroy () is a GNU extension. .SH "SEE ALSO" .BR bsearch (3), diff --git a/man3/tzset.3 b/man3/tzset.3 index 990e4e47..c97ea733 100644 --- a/man3/tzset.3 +++ b/man3/tzset.3 @@ -42,7 +42,7 @@ tzset, tzname, timezone, daylight \- initialize time conversion information .BI "extern int " daylight ; .fi .SH DESCRIPTION -The \fBtzset()\fP function initializes the \fItzname\fP variable from the +The \fBtzset\fP() function initializes the \fItzname\fP variable from the TZ environment variable. This function is automatically called by the other time conversion functions that depend on the time zone. In a SysV-like environment it will also set the variables \fItimezone\fP diff --git a/man3/ualarm.3 b/man3/ualarm.3 index 8ad1ef33..72fc9f7c 100644 --- a/man3/ualarm.3 +++ b/man3/ualarm.3 @@ -40,7 +40,7 @@ ualarm \- schedule signal after given number of microseconds .BI "useconds_t ualarm(useconds_t " usecs ", useconds_t " interval ); .fi .SH DESCRIPTION -The \fBualarm()\fP function causes the signal SIGALRM to be sent +The \fBualarm\fP() function causes the signal SIGALRM to be sent to the invoking process after (not less than) .I usecs microseconds. diff --git a/man3/usleep.3 b/man3/usleep.3 index 3e0b0380..cc58fd79 100644 --- a/man3/usleep.3 +++ b/man3/usleep.3 @@ -46,7 +46,7 @@ usleep \- suspend execution for microsecond intervals .BI "int usleep(useconds_t " usec "); .fi .SH DESCRIPTION -The \fBusleep()\fP function suspends execution of the calling process for +The \fBusleep\fP() function suspends execution of the calling process for (at least) \fIusec\fP microseconds. The sleep may be lengthened slightly by any system activity or by the time spent processing the call or by the granularity of system timers. diff --git a/man3/wcstoimax.3 b/man3/wcstoimax.3 index 2bb1cd49..1ba0bc50 100644 --- a/man3/wcstoimax.3 +++ b/man3/wcstoimax.3 @@ -35,9 +35,9 @@ wcstoimax, wcstoumax \- convert wide-character string to integer .fi .SH DESCRIPTION These functions are just like -.B wcstol() +.BR wcstol () and -.BR wcstoul() , +.BR wcstoul (), except that they return a value of type .B intmax_t and diff --git a/man3/wordexp.3 b/man3/wordexp.3 index 13244c17..84bb24d2 100644 --- a/man3/wordexp.3 +++ b/man3/wordexp.3 @@ -33,7 +33,7 @@ wordexp, wordfree \- perform word expansion like a posix-shell .sp .SH DESCRIPTION The function -.B wordexp() +.BR wordexp () performs a shell-like expansion of the string .I s and returns the result in the structure pointed to by @@ -67,7 +67,7 @@ see below) used to indicate the number of initial elements in the array that should be filled with NULLs. .LP The function -.B wordfree() +.BR wordfree () frees the allocated memory again. More precisely, it does not free its argument, but it frees the array .I we_wordv @@ -152,9 +152,9 @@ Don't do command substitution. The parameter .I p resulted from a previous call to -.BR wordexp() , +.BR wordexp (), and -.BR wordfree() +.BR wordfree () was not called. Reuse the allocated storage. .TP .B WRDE_SHOWERR diff --git a/man3/xcrypt.3 b/man3/xcrypt.3 index ae0efada..0602aa4c 100644 --- a/man3/xcrypt.3 +++ b/man3/xcrypt.3 @@ -21,7 +21,7 @@ xencrypt, xdecrypt, passwd2des \- RFS password encryption .sp .SH DESCRIPTION The function -.B passwd2des() +.BR passwd2des () takes a character string .I passwd of arbitrary length and fills a character array @@ -35,7 +35,7 @@ argument into a DES key. .LP The -.B xencrypt() +.BR xencrypt () function takes the ASCII character string .I secret given in hex, @@ -44,7 +44,7 @@ which must have a length that is a multiple of 16, encrypts it using the DES key derived from .I passwd by -.BR passwd2des() , +.BR passwd2des (), and outputs the result again in .I secret as a hex string @@ -52,13 +52,13 @@ as a hex string of the same length. .LP The -.B xdecrypt() +.BR xdecrypt () function performs the converse operation. .SH "RETURN VALUE" The functions -.B xencrypt() +.BR xencrypt () and -.B xdecrypt() +.BR xdecrypt () return 1 on success and 0 on error. .SH AVAILABILITY These routines are present in libc 4.6.27 and later, and in @@ -100,10 +100,10 @@ This routine returns one if it succeeds, zero otherwise. Note: encoded characters are not packed, and occupy 4 bytes each. For arrays of characters, it is worthwhile to consider -.BR xdr_bytes() , -.B xdr_opaque() +.BR xdr_bytes (), +.BR xdr_opaque () or -.BR xdr_string() . +.BR xdr_string (). .br .if t .ne 8 .LP @@ -124,7 +124,7 @@ Destruction usually involves freeing private data structures associated with the stream. Using .I xdrs after invoking -.B xdr_destroy() +.BR xdr_destroy () is undefined. .br .if t .ne 7 @@ -249,7 +249,7 @@ Note: pointer is cast to .BR "long *" . .IP Warning: -.B xdr_inline() +.BR xdr_inline () may return .SM NULL (0) @@ -357,13 +357,13 @@ xdrproc_t xdrobj; .ft R .IP Like -.B xdr_reference() +.BR xdr_reference () except that it serializes .SM NULL pointers, whereas -.B xdr_reference() +.BR xdr_reference () does not. Thus, -.B xdr_pointer() +.BR xdr_pointer () can represent recursive data structures, such as binary trees or linked lists. @@ -431,7 +431,7 @@ int sendnow; .IP This routine can be invoked only on streams created by -.BR xdrrec_create() . +.BR xdrrec_create (). The data in the output buffer is marked as a completed record, and the output buffer is optionally written out if @@ -452,7 +452,7 @@ int empty; .IP This routine can be invoked only on streams created by -.BR xdrrec_create() . +.BR xdrrec_create (). After consuming the rest of the current record in the stream, this routine returns one if the stream has no more input, zero otherwise. @@ -469,7 +469,7 @@ xdrrec_skiprecord(xdrs) .IP This routine can be invoked only on streams created by -.BR xdrrec_create() . +.BR xdrrec_create (). It tells the .SM XDR implementation that the rest of the current record @@ -509,7 +509,7 @@ This routine returns one if it succeeds, zero otherwise. Warning: this routine does not understand .SM NULL pointers. Use -.B xdr_pointer() +.BR xdr_pointer () instead. .br .if t .ne 10 @@ -531,7 +531,7 @@ stream The parameter .I pos is a position value obtained from -.BR xdr_getpos() . +.BR xdr_getpos (). This routine returns one if the .SM XDR stream could be repositioned, @@ -594,11 +594,11 @@ or Warning: the destroy routine associated with such .SM XDR streams calls -.B fflush() +.BR fflush () on the .I file stream, but never -.BR fclose() . +.BR fclose (). .br .if t .ne 9 .LP @@ -713,7 +713,7 @@ Next the union located at is translated. The parameter .I choices is a pointer to an array of -.B xdr_discrim() +.BR xdr_discrim () structures. Each structure contains an ordered pair of .RI [ value , proc ]. If the union's discriminant is equal to the associated @@ -721,7 +721,7 @@ If the union's discriminant is equal to the associated then the .I proc is called to translate the union. The end of the -.B xdr_discrim() +.BR xdr_discrim () structure array is denoted by a routine of value .SM NULL\s0. If the discriminant is not found in the @@ -797,13 +797,13 @@ where .B .SM MAXUN.UNSIGNED is the maximum value of an unsigned integer. -.B xdr_wrapstring() +.BR xdr_wrapstring () is handy because the .SM RPC package passes a maximum of two .SM XDR routines as parameters, and -.BR xdr_string() , +.BR xdr_string (), one of the most frequently used primitives, requires three. Returns one if it succeeds, zero otherwise. .SH "SEE ALSO" |