Formatting fixes

This commit is contained in:
Michael Kerrisk 2005-10-19 14:48:35 +00:00
parent 4a225b7a41
commit b5cc2ffbaa
41 changed files with 177 additions and 61 deletions

View File

@ -29,6 +29,11 @@ New pages
Changes to individual pages
---------------------------
prctl.2
mtk
Remooved text saying there is no library interface. There
is nowadays.
mkfifo.3
mtk
Minor change to RETURN VALUE text.

View File

@ -361,7 +361,9 @@ A kernel bug means that
does not work in kernel 2.6.12; the problem is fixed in kernel 2.6.13.
In kernel 2.6.12, there was an off-by-one mismatch
between the priority ranges returned by getpriority(2) and
between the priority ranges returned by
.BR getpriority (2)
and
.BR RLIMIT_NICE .
This had the effect that actual ceiling for the nice value
was calculated as

View File

@ -217,8 +217,10 @@ _POSIX_SOURCE or compiling with the \-ansi flag).
.LP
Traditionally, the fields of struct timeval were longs.
.SH "CONFORMING TO"
SVr4, 4.3BSD. POSIX 1003.1-2001 describes gettimeofday()
but not settimeofday().
SVr4, 4.3BSD. POSIX 1003.1-2001 describes
.BR gettimeofday ()
but not
.BR settimeofday ().
.SH "SEE ALSO"
.BR date (1),
.BR adjtimex (2),

View File

@ -95,7 +95,9 @@ have a process group.
.SH NOTES
There are various differences between the permission checking
in BSD-type systems and SYSV-type systems. See the POSIX rationale
for kill(). A difference not mentioned by POSIX concerns the return
for
.BR kill ().
A difference not mentioned by POSIX concerns the return
value EPERM: BSD documents that no signal is sent and EPERM returned
when the permission check failed for at least one target process,
while POSIX documents EPERM only when the permission check failed

View File

@ -132,7 +132,9 @@ does not return correct information for MAP_PRIVATE mappings.
is not specified in POSIX.1-2001,
and it is not available on all Unix implementations.
.SH HISTORY
The mincore() function first appeared in 4.4BSD.
The
.BR mincore ()
function first appeared in 4.4BSD.
.SH AVAILABILITY
Since Linux 2.3.99pre1 and glibc 2.2.
.SH "SEE ALSO"

View File

@ -143,8 +143,12 @@ See the BUGS section of
.SH "CONFORMING TO"
XPG4-UNIX.
.SH AVAILABILITY
The poll() system call was introduced in Linux 2.1.23.
The poll() library call was introduced in libc 5.4.28
The
.BR poll ()
system call was introduced in Linux 2.1.23.
The
.BR poll()
library call was introduced in libc 5.4.28
(and provides emulation using select if your kernel does not
have a poll syscall).
.SH "SEE ALSO"

View File

@ -135,7 +135,9 @@ get the maximum number of processors the calling process can use,
find out whether a specified process is currently blocked,
get or set the maximum stack size, etc.
.SH AVAILABILITY
The prctl() system call was introduced in Linux 2.1.57.
There is no prctl() library call as yet.
The
.BR prctl ()
system call was introduced in Linux 2.1.57.
.\" The library interface was added in glibc 2.0.6
.SH "SEE ALSO"
.BR signal (2)

View File

@ -68,7 +68,8 @@ and the sizes are given as multiples of \fImem_unit\fP bytes.
.BR sysinfo ()
provides a simple way of getting overall system statistics. This is more
portable than reading \fI/dev/kmem\fP.
For an example of its use, see intro(2).
For an example of its use, see
.BR intro (2).
.SH "RETURN VALUE"
On success, zero is returned. On error, \-1 is returned, and
.I errno
@ -81,8 +82,12 @@ pointer to \fIstruct\ sysinfo\fP is invalid
This function is Linux-specific, and should not be used in programs
intended to be portable.
.sp
The Linux kernel has a sysinfo system call since 0.98.pl6.
Linux libc contains a sysinfo() routine since 5.3.5, and
The Linux kernel has a
.BR sysinfo ()
system call since 0.98.pl6.
Linux libc contains a
.BR sysinfo ()
routine since 5.3.5, and
glibc has one since 1.90.
.SH "SEE ALSO"
.BR proc (5)

View File

@ -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).

View File

@ -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

View File

@ -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.

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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.

View File

@ -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 ()

View File

@ -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

View File

@ -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)).

View File

@ -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

View File

@ -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)

View File

@ -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>

View File

@ -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

View File

@ -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"

View File

@ -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)

View File

@ -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>

View File

@ -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.

View File

@ -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"

View File

@ -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.

View File

@ -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 (),

View File

@ -49,7 +49,8 @@ Ctrl+Alt+F\fIn\fP to switch to console \fIn\fP; AltGr+F\fIn\fP
might bring you to console \fIn\fP+12 [here Alt and AltGr refer
to the left and right Alt keys, respectively];
(b) use Alt+RightArrow or Alt+LeftArrow to cycle through
the presently allocated consoles; (c) use the program chvt(1).
the presently allocated consoles; (c) use the program
.BR chvt (1).
(The key mapping is user settable, see
.BR loadkeys (1);
the above mentioned key combinations are according to the default settings.)

View File

@ -396,7 +396,9 @@ struct vt_sizes {
.fi
Note that this does not change the videomode.
See resizecons(8). (Since 1.1.54.)
See
.BR resizecons (8).
(Since 1.1.54.)
.IP \fBVT_RESIZEX\fP
Set the kernel's idea of various screen parameters. \fIargp\fP
@ -415,7 +417,9 @@ struct vt_consize {
Any parameter may be set to zero, indicating ``no change'', but if
multiple parameters are set, they must be self-consistent. Note that
this does not change the videomode. See resizecons(8). (Since 1.3.3.)
this does not change the videomode. See
.BR resizecons(8).
(Since 1.3.3.)
.PP
The action of the following ioctls depends on the first byte in the struct

View File

@ -48,8 +48,12 @@ processor found in Atari Falcon030-compatible computers. The
to send and receive data using the bi-directional handshaked host
port.
.PP
To send a data stream to the signal processor, use write() to the
device, and read() to receive processed data. The data can be sent or
To send a data stream to the signal processor, use
.BR write ()
to the
device, and
.BR read ()
to receive processed data. The data can be sent or
received in 8, 16, 24, or 32-bit quantities on the host side, but will
always be seen as 24-bit quantities in the DSP56001.
.PP
@ -58,8 +62,9 @@ The following
calls are used to control the
\fBdsp56k\fP device:
.IP \fBDSP56K_UPLOAD\fP
resets the DSP56001 and uploads a program. The third ioctl() argument
must be a pointer to a \fBstruct dsp56k_binary\fP with members
resets the DSP56001 and uploads a program. The third
.BR ioctl ()
argument must be a pointer to a \fBstruct dsp56k_binary\fP with members
\fBbin\fP pointing to a DSP56001 binary program, and \fBlen\fP set to
the length of the program, counted in 24-bit words.
.IP \fBDSP56K_SET_TX_WSIZE\fP
@ -79,7 +84,9 @@ general-purpose bits that can be read by both the hosting computer and
the DSP56001. Bits 0 and 1 can be written by the host, and bits 2 and
3 can be written by the DSP56001.
To access the host flags, the third ioctl() argument must be a pointer
To access the host flags, the third
.BR ioctl ()
argument must be a pointer
to a \fBstruct dsp56k_host_flags\fP. If bit 0 or 1 is set in the
\fBdir\fP member, the corresponding bit in \fBout\fP will be written
to the host flags. The state of all host flags will be returned in

View File

@ -346,14 +346,17 @@ then make sure to provide a way to mark its closure dynamically (ie- caused by
a previous event's processing). Suppose you receive 100 events from
.BR epoll_wait (2),
and in event #47 a condition causes event #13 to be closed.
If you remove the structure and close() the fd for event #13, then your
If you remove the structure and
.BR close()
the fd for event #13, then your
event cache might still say there are events waiting for that fd causing
confusion.
.PP
.PP
One solution for this is to call, during the processing of event 47,
.BR epoll_ctl ( EPOLL_CTL_DEL )
to delete fd 13 and close(), then mark its associated
to delete fd 13 and
.BR close (), then mark its associated
data structure as removed and link it to a cleanup list. If you find another
event for fd 13 in your batch processing, you will discover the fd had been
previously removed and there will be no confusion.

View File

@ -73,7 +73,9 @@ microseconds, but experience has shown the delay caused by the code is
already enough. For that reason, the default value is 0. This is
used for both the polling and the interrupt driver.
.IP "\fBint ioctl(int \fP\fIfd\fP\fB, LPSETIRQ, int \fP\fIarg\fP\fB)\fP"
This ioctl() requires superuser privileges. It takes an int containing the
This
.BR ioctl ()
requires superuser privileges. It takes an int containing the
new IRQ as argument. As a side effect, the printer will be reset. When
\fIarg\fP is 0, the polling driver will be used, which is also default.
.IP "\fBint ioctl(int \fP\fIfd\fP\fB, LPGETIRQ, int *\fP\fIarg\fP\fB)\fP"

View File

@ -654,7 +654,9 @@ The requested operation could not be completed.
A write operation could not be completed because the tape reached
end-of-medium.
.IP ENOMEM
The byte count in read() is smaller than the next physical block on
The byte count in
.BR read ()
is smaller than the next physical block on
the tape. (Before 2.2.18 and 2.4.0-test6 the extra bytes have been
silently ignored.)
.IP EACCES
@ -724,7 +726,11 @@ codes written into some messages are automatically translated to text
if verbose SCSI messages are enabled in kernel configuration.
.PP
5. The driver's internal buffering allows good throughput in fixed-block
mode also with small read() and write() byte counts. With direct transfers
mode also with small
.BR read ()
and
.BR write ()
byte counts. With direct transfers
this is not possible and may cause a surprise when moving to the 2.6
kernel.
The solution is to tell the software to use larger transfers (often

View File

@ -102,7 +102,8 @@ VFAT adds the capability to use long filenames under the MSDOS filesystem.
is a pseudo-filesystem which is used as an interface to kernel data
structures rather than reading and interpreting
.IR /dev/kmem .
In particular, its files do not take disk space. See proc(5).
In particular, its files do not take disk space. See
.BR proc (5).
.TP
.B iso9660
is a CD-ROM filesystem type conforming to the ISO 9660 standard.

View File

@ -150,7 +150,8 @@ are normally in \fB/etc/rc[0\-6S].d\fR. In each of these directories
there are links (usually symbolic) to the scripts in the \fIinit.d\fR
directory.
A primary script (usually \fI/etc/rc\fR) is called from inittab(5)
A primary script (usually \fI/etc/rc\fR) is called from
.BR inittab (5)
and calls the services scripts via the links in the sequencing directories.
All links with names that begin with 'S' are being called with
the argument 'start' (thereby starting the service). All links with

View File

@ -744,7 +744,9 @@ to the network.
.\" The following is from 2.6.12: Doumentation/networking/ip-sysctl.txt
.TP
.BR ip_nonlocal_bind " (Boolean; default: disabled)"
If set, allows processes to bind() to non-local IP addresses,
If set, allows processes to
.BR bind ()
to non-local IP addresses,
which can be quite useful, but may break some applications.
.\"
.\" The following is from 2.6.12: Doumentation/networking/ip-sysctl.txt

View File

@ -561,8 +561,9 @@ kernel structures; thus the sysctls are twice what can be observed
on the wire.
Linux will only allow port re-use with the SO_REUSEADDR option
when this option was set both in the previous program that performed
a bind() to the port and in the program that wants to re-use the port.
when this option was set both in the previous program that performed a
.BR bind ()
to the port and in the program that wants to re-use the port.
This differs from some implementations (e.g., FreeBSD)
where only the later program needs to set the SO_REUSEADDR option.
Typically this difference is invisible, since, for example, a server