diff options
author | Michael Kerrisk <mtk.manpages@gmail.com> | 2005-10-19 14:48:35 +0000 |
---|---|---|
committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2005-10-19 14:48:35 +0000 |
commit | b5cc2ffbaa46690a318bbe0ec4d4e9d3ea3d91ef (patch) | |
tree | 389218686fb47d7c8eae10f3198ac00adaeb38bd /man3 | |
parent | 4a225b7a41cad73eb6b2f680d8a029bd173b9aaa (diff) |
Formatting fixes
Diffstat (limited to 'man3')
-rw-r--r-- | man3/cabs.3 | 4 | ||||
-rw-r--r-- | man3/cacos.3 | 4 | ||||
-rw-r--r-- | man3/cacosh.3 | 4 | ||||
-rw-r--r-- | man3/casin.3 | 4 | ||||
-rw-r--r-- | man3/casinh.3 | 4 | ||||
-rw-r--r-- | man3/catan.3 | 4 | ||||
-rw-r--r-- | man3/catanh.3 | 4 | ||||
-rw-r--r-- | man3/catopen.3 | 5 | ||||
-rw-r--r-- | man3/cerf.3 | 8 | ||||
-rw-r--r-- | man3/cfree.3 | 4 | ||||
-rw-r--r-- | man3/cimag.3 | 4 | ||||
-rw-r--r-- | man3/conj.3 | 4 | ||||
-rw-r--r-- | man3/creal.3 | 4 | ||||
-rw-r--r-- | man3/div.3 | 6 | ||||
-rw-r--r-- | man3/encrypt.3 | 9 | ||||
-rw-r--r-- | man3/fmtmsg.3 | 8 | ||||
-rw-r--r-- | man3/getline.3 | 6 | ||||
-rw-r--r-- | man3/getlogin.3 | 18 | ||||
-rw-r--r-- | man3/getutent.3 | 5 | ||||
-rw-r--r-- | man3/round.3 | 3 | ||||
-rw-r--r-- | man3/setlocale.3 | 4 | ||||
-rw-r--r-- | man3/strftime.3 | 4 | ||||
-rw-r--r-- | man3/ulimit.3 | 6 |
23 files changed, 95 insertions, 31 deletions
diff --git a/man3/cabs.3 b/man3/cabs.3 index 2c31d7269..547913a2b 100644 --- a/man3/cabs.3 +++ b/man3/cabs.3 @@ -15,7 +15,9 @@ cabs, cabsf, cabsl \- absolute value of a complex number .sp Link with \-lm. .SH DESCRIPTION -The cabs() function returns the absolute value of the complex number z. The +The +.BR cabs () +function returns the absolute value of the complex number z. The result is a real number. .SH NOTE The function is actually an alias for hypot(a,b) = sqrt(a*a+b*b). diff --git a/man3/cacos.3 b/man3/cacos.3 index 073b5ed59..cd8e02d4d 100644 --- a/man3/cacos.3 +++ b/man3/cacos.3 @@ -15,7 +15,9 @@ cacos, cacosf, cacosl \- complex arc cosine .sp Link with \-lm. .SH DESCRIPTION -The cacos() function calculates the complex acos(). +The +.BR cacos () +function calculates the complex acos(). If y = cacos(z), then z = ccos(y). The real part of y is chosen in the interval [0,pi]. .LP diff --git a/man3/cacosh.3 b/man3/cacosh.3 index 4fc9b0634..856db418f 100644 --- a/man3/cacosh.3 +++ b/man3/cacosh.3 @@ -15,7 +15,9 @@ cacosh, cacoshf, cacoshl \- complex arc hyperbolic cosine .sp Link with \-lm. .SH DESCRIPTION -The cacosh() function calculates the complex acosh(). +The +.BR cacosh () +function calculates the complex acosh(). If y = cacosh(z), then z = ccosh(y). The imaginary part of y is chosen in the interval [\-pi,pi]. The real part of y is chosen nonnegative. diff --git a/man3/casin.3 b/man3/casin.3 index 24fcc790a..950b8320a 100644 --- a/man3/casin.3 +++ b/man3/casin.3 @@ -15,7 +15,9 @@ casin, casinf, casinl \- complex arc sine .sp Link with \-lm. .SH DESCRIPTION -The casin() function calculates the complex asin(). +The +.BR casin () +function calculates the complex asin(). If y = casin(z), then z = csin(y). The real part of y is chosen in the interval [\-pi/2,pi/2]. .LP diff --git a/man3/casinh.3 b/man3/casinh.3 index 4c1f94b2a..3e5f6758c 100644 --- a/man3/casinh.3 +++ b/man3/casinh.3 @@ -15,7 +15,9 @@ casinh, casinhf, casinhl \- complex arc sine hyperbolic .sp Link with \-lm. .SH DESCRIPTION -The casinh() function calculates the complex asinh(). +The +.BR casinh () +function calculates the complex asinh(). If y = casinh(z), then z = csinh(y). The imaginary part of y is chosen in the interval [\-pi/2,pi/2]. .LP diff --git a/man3/catan.3 b/man3/catan.3 index b9f1247a4..9da3dd6df 100644 --- a/man3/catan.3 +++ b/man3/catan.3 @@ -15,7 +15,9 @@ catan, catanf, catanl \- complex arc tangents .sp Link with \-lm. .SH DESCRIPTION -The catan() function calculates the complex atan(). +The +.BR catan () +function calculates the complex atan(). If y = catan(z), then z = ctan(y). The real part of y is chosen in the interval [\-pi/2,pi/2]. .LP diff --git a/man3/catanh.3 b/man3/catanh.3 index 9998ae023..460b8e178 100644 --- a/man3/catanh.3 +++ b/man3/catanh.3 @@ -15,7 +15,9 @@ catanh, catanhf, catanhl \- complex arc tangents hyperbolic .sp Link with \-lm. .SH DESCRIPTION -The catanh() function calculates the complex atanh(). +The +.BR catanh () +function calculates the complex atanh(). If y = catanh(z), then z = ctanh(y). The imaginary part of y is chosen in the interval [\-pi/2,pi/2]. .LP diff --git a/man3/catopen.3 b/man3/catopen.3 index c822a14eb..c30b9fbf7 100644 --- a/man3/catopen.3 +++ b/man3/catopen.3 @@ -36,7 +36,10 @@ catopen, catclose \- open/close a message catalog The function .BR catopen () opens a message catalog and returns a catalog descriptor. -The descriptor remains valid until catclose() or exec(). +The descriptor remains valid until +.BR catclose () +or +.BR exec (). If a file descriptor is used to implement catalog descriptors then the FD_CLOEXEC flag will be set. .LP diff --git a/man3/cerf.3 b/man3/cerf.3 index 7265bf1d1..e3f81e476 100644 --- a/man3/cerf.3 +++ b/man3/cerf.3 @@ -21,9 +21,13 @@ cerf, cerff, cerfl, cerfc, cerfcf, cerfcl \- complex error function .sp Link with \-lm. .SH DESCRIPTION -The function cerf() is the complex version of the error function. +The function +.BR cerf () +is the complex version of the error function. erf(z) = 2/sqrt(pi) * integral from 0 to z of exp(\-t*t) dt. -The function cerfc() is defined as cerfc(z) = 1\-cerf(z). +The function +.BR cerfc () +is defined as cerfc(z) = 1\-cerf(z). .\" must check 1/sqrt(2*pi) ? .SH "CONFORMING TO" The function name is reserved for future use in C99. diff --git a/man3/cfree.3 b/man3/cfree.3 index a628b2922..d587895d4 100644 --- a/man3/cfree.3 +++ b/man3/cfree.3 @@ -94,7 +94,9 @@ In case of error, is set to EINVAL: the value of .I ptr was not a pointer to a block previously allocated by -one of the routines in the malloc() family. +one of the routines in the +.BR malloc (3) +family. .SH "CONFORMING TO" The 3-argument version of .BR cfree () diff --git a/man3/cimag.3 b/man3/cimag.3 index ef37bcfec..e54239024 100644 --- a/man3/cimag.3 +++ b/man3/cimag.3 @@ -15,7 +15,9 @@ cimag, cimagf, cimagl \- get imaginary part of a complex number .sp Link with \-lm. .SH DESCRIPTION -The cimag() function returns the imaginary part of the complex number z. +The +.BR cimag () +function returns the imaginary part of the complex number z. .LP One has z = creal(z) + I*cimag(z). .SH NOTE diff --git a/man3/conj.3 b/man3/conj.3 index f70cc5490..d5e6561c4 100644 --- a/man3/conj.3 +++ b/man3/conj.3 @@ -15,7 +15,9 @@ conj, conjf, conjl \- calculate the complex conjugate .sp Link with \-lm. .SH DESCRIPTION -The conj() function returns the complex conjugate value of z. +The +.BR conj () +function returns the complex conjugate value of z. That is the value obtained by changing the sign of the imaginary part. .LP One has cabs(z) = csqrt(z * conj(z)). diff --git a/man3/creal.3 b/man3/creal.3 index ae340fb65..bd06e1465 100644 --- a/man3/creal.3 +++ b/man3/creal.3 @@ -15,7 +15,9 @@ creal, crealf, creall \- get real part of a complex number .sp Link with \-lm. .SH DESCRIPTION -The creal() function returns the real part of the complex number z. +The +.BR creal () +function returns the real part of the complex number z. .LP One has z = creal(z) + I*cimag(z). .SH NOTE diff --git a/man3/div.3 b/man3/div.3 index 552826cd1..d72524478 100644 --- a/man3/div.3 +++ b/man3/div.3 @@ -67,7 +67,11 @@ After the values \fIq.quot\fP and \fIq.rem\fP are \-1 and \-2, respectively. .SH "CONFORMING TO" SVID 3, 4.3BSD, ISO 9899. -The functions lldiv() and imaxdiv() were added in ISO C99. +The functions +.BR lldiv () +and +.BR imaxdiv () +were added in ISO C99. .SH "SEE ALSO" .BR abs (3), .BR remainder (3) diff --git a/man3/encrypt.3 b/man3/encrypt.3 index 056db9a19..2073c1a33 100644 --- a/man3/encrypt.3 +++ b/man3/encrypt.3 @@ -58,7 +58,9 @@ parameter used here is an array of 64 bytes, each of which has numerical value 1 or 0. The bytes key[n] where n=8*i-1 are ignored, so that the effective key length is 56 bits. .PP -The encrypt() function modifies the passed buffer, encoding if +The +.BR encrypt () +function modifies the passed buffer, encoding if .I edflag is 0, and decoding if 1 is being passed. Like the key parameter also .I block @@ -107,7 +109,10 @@ The function is not provided. You need to link with libcrypt to compile this example with glibc2.2. To do useful work the key[] and txt[] arrays must be filled with a useful bit pattern. Note that the <crypt.h> header unconditionally -gives the prototypes for setkey() and encrypt(). +gives the prototypes for +.BR setkey () +and +.BR encrypt (). .sp .nf #include <crypt.h> diff --git a/man3/fmtmsg.3 b/man3/fmtmsg.3 index 79c4e24e8..f3f135ac0 100644 --- a/man3/fmtmsg.3 +++ b/man3/fmtmsg.3 @@ -156,8 +156,9 @@ The environment variable .B SEV_LEVEL can be used to introduce new severity levels. By default, only the five severity levels described -above are available. Any other numeric value would make fmtmsg() print -nothing. +above are available. Any other numeric value would make +.BR fmtmsg () +print nothing. If the user puts .B SEV_LEVEL with a format like @@ -166,7 +167,8 @@ with a format like SEV_LEVEL=[description[:description[:...]]] .RE .sp -in the environment of the process before the first call to fmtmsg(), +in the environment of the process before the first call to +.BR fmtmsg (), where each description is of the form .sp .RS diff --git a/man3/getline.3 b/man3/getline.3 index 1a83fc0df..e7bd55d5f 100644 --- a/man3/getline.3 +++ b/man3/getline.3 @@ -129,7 +129,11 @@ int main(void) } .fi .SH "CONFORMING TO" -Both getline() and getdelim() are GNU extensions. +Both +.BR getline () +and +.BR getdelim () +are GNU extensions. They are available since libc 4.6.27. .SH "SEE ALSO" diff --git a/man3/getlogin.3 b/man3/getlogin.3 index 7ed1568ce..29f085f54 100644 --- a/man3/getlogin.3 +++ b/man3/getlogin.3 @@ -113,12 +113,15 @@ was included in the 1988 version of POSIX, but removed from the 1990 version. OpenBSD has \fBgetlogin\fP() and \fBsetlogin\fP(), and a username associated with a session, even if it has no controlling tty. .SH BUGS -Unfortunately, it is often rather easy to fool getlogin(). +Unfortunately, it is often rather easy to fool +.BR getlogin (). Sometimes it does not work at all, because some program messed up the utmp file. Often, it gives only the first 8 characters of the login name. The user currently logged in on the controlling tty of our program need not be the user who started it. -Avoid getlogin() for security-related purposes. +Avoid +.BR getlogin () +for security-related purposes. .LP Note that glibc does not follow the POSIX spec and uses stdin instead of @@ -126,10 +129,15 @@ instead of A bug. (Other recent systems, like SunOS 5.8 and HPUX 11.11 and FreeBSD 4.8 all return the login name also when stdin is redirected.) .LP -Nobody knows precisely what cuserid() does; avoid it in portable programs. -Or avoid it altogether: use getpwuid(geteuid()) instead, if that is +Nobody knows precisely what +.BR cuserid () +does; avoid it in portable programs. +Or avoid it altogether: use +.I getpwuid(geteuid()) +instead, if that is what you meant. -DO NOT USE cuserid(). +DO NOT USE +.BR cuserid (). .SH "SEE ALSO" .BR geteuid (2), .BR getuid (2) diff --git a/man3/getutent.3 b/man3/getutent.3 index 3c2077361..9c9e87eb1 100644 --- a/man3/getutent.3 +++ b/man3/getutent.3 @@ -110,7 +110,10 @@ On error these functions return \-1. .SH EXAMPLE The following example adds and removes a utmp record, assuming it is run from within a pseudo terminal. For usage in a real application, you -should check the return values of getpwuid() and ttyname(). +should check the return values of +.BR getpwuid () +and +.BR ttyname (). .PP .nf #include <string.h> diff --git a/man3/round.3 b/man3/round.3 index 6c52e14df..a9658f780 100644 --- a/man3/round.3 +++ b/man3/round.3 @@ -38,7 +38,8 @@ Compile with \-std=c99; link with \-lm. .SH DESCRIPTION These functions round \fIx\fP to the nearest integer, but round halfway cases away from zero (regardless of the current rounding -direction), instead of to the nearest even integer like rint(). +direction), instead of to the nearest even integer like +.BR rint (). .SH "RETURN VALUE" The rounded integer value. If \fIx\fP is integral or infinite, \fIx\fP itself is returned. diff --git a/man3/setlocale.3 b/man3/setlocale.3 index bbc6b3729..a39f2fd42 100644 --- a/man3/setlocale.3 +++ b/man3/setlocale.3 @@ -177,7 +177,9 @@ locale (e.g. in libc-4.5.21 and libc-4.6.27), and the Russian .B """KOI-8""" (more precisely, "koi-8r") locale (e.g. in libc-4.6.27), so that having an environment variable LC_CTYPE=ISO-8859-1 -sufficed to make isprint() return the right answer. +sufficed to make +.BR isprint () +return the right answer. These days non-English speaking Europeans have to work a bit harder, and must install actual locale files. .SH "SEE ALSO" diff --git a/man3/strftime.3 b/man3/strftime.3 index 3472c7624..d9b6f5c6f 100644 --- a/man3/strftime.3 +++ b/man3/strftime.3 @@ -203,7 +203,9 @@ Required to emit RFC\ 822-conformant dates The time zone or name or abbreviation. .TP .B %+ -The date and time in date(1) format. (TZ) +The date and time in +.BR date(1) +format. (TZ) .TP .B %% A literal `%' character. diff --git a/man3/ulimit.3 b/man3/ulimit.3 index 7d120c13a..4abc525f9 100644 --- a/man3/ulimit.3 +++ b/man3/ulimit.3 @@ -33,7 +33,11 @@ ulimit \- get and set user limits .BI "long ulimit(int " cmd ", long " newlimit ); .SH DESCRIPTION Warning: This routine is obsolete. The include file is no longer -provided by glibc. Use getrlimit(2), setrlimit(2) and sysconf(3) +provided by glibc. Use +.BR getrlimit (2), +.BR setrlimit (2) +and +.BR sysconf (3) instead. For the shell command .BR ulimit (), |