Formatting fixes

This commit is contained in:
Michael Kerrisk 2005-10-19 13:48:50 +00:00
parent 7eda86b16c
commit 35e21ba7ca
13 changed files with 31 additions and 20 deletions

View File

@ -14,6 +14,9 @@ Apologies if I missed anyone!
Global changes
--------------
Most instances of the constant "NULL" are not formatted (bolded) in
man pages, but a few are. For consistency, formatting on "NULL" has i
been removed where it occurred.
Typographical or grammatical errors have been corrected in several
places.
@ -26,3 +29,6 @@ New pages
Changes to individual pages
---------------------------
mkfifo.3
mtk
Minor change to RETURN VALUE text.

View File

@ -323,7 +323,9 @@ Because of the buffering performed by the
.BR stdio (3)
library, the use of record locking with routines in that package
should be avoided; use
.BR read "(2) and " write (2)
.BR read (2)
and
.BR write (2)
instead.
.P
.SS "Mandatory locking"

View File

@ -73,7 +73,9 @@ Locks created by
.BR flock ()
are associated with an open file table entry.
This means that duplicate file descriptors (created by, for example,
.BR fork "(2) or " dup (2))
.BR fork (2)
or
.BR dup (2))
refer to the same lock, and this lock may be modified
or released using any of these descriptors.
Furthermore, the lock is released either by an explicit

View File

@ -115,4 +115,5 @@ In kernels before 2.6.6, if
was specified as 0, then this was interpreted literally as "zero bytes",
rather than as meaning "all bytes through to the end of the file".
.SH "SEE ALSO"
.BR posix_fallocate "(2), " posix_madvise "(2)."
.BR posix_fallocate (2),
.BR posix_madvise (2).

View File

@ -184,7 +184,7 @@ is:
.TP
.I flag
specifies how results are returned for a long option. If \fIflag\fP
is \fBNULL\fP, then \fBgetopt_long\fP() returns \fIval\fP. (For
is NULL, then \fBgetopt_long\fP() returns \fIval\fP. (For
example, the calling program may set \fIval\fP to the equivalent short
option character.) Otherwise, \fBgetopt_long\fP() returns 0, and
\fIflag\fP points to a variable which is set to \fIval\fP if the
@ -196,7 +196,7 @@ to by \fIflag\fP.
.PP
The last element of the array has to be filled with zeroes.
.PP
If \fIlongindex\fP is not \fBNULL\fP, it
If \fIlongindex\fP is not NULL, it
points to a variable which is set to the index of the long option relative to
.IR longopts .
.PP
@ -225,7 +225,7 @@ if it is ':', then ':' is returned; otherwise '?' is returned.
.PP
\fBgetopt_long\fP() and \fBgetopt_long_only\fP() also return the option
character when a short option is recognized. For a long option, they
return \fIval\fP if \fIflag\fP is \fBNULL\fP, and 0 otherwise. Error
return \fIval\fP if \fIflag\fP is NULL, and 0 otherwise. Error
and \-1 returns are the same as for \fBgetopt\fP() (), plus '?' for an
ambiguous match or an extraneous parameter.
.SH "ENVIRONMENT VARIABLES"

View File

@ -87,7 +87,7 @@ and if successful returns a pointer to it.
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.
NULL.
.PP
The three functions
.BR hcreate_r (),
@ -101,7 +101,7 @@ must be zeroed before the first call to
\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 NULL 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

View File

@ -55,7 +55,7 @@ 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
NULL 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"

View File

@ -42,7 +42,7 @@ Since it will be modified,
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
string on success, and \fBNULL\fP on failure, in which case
string on success, and NULL on failure, in which case
.IR errno
is set appropriately.
.SH ERRORS

View File

@ -262,7 +262,7 @@ 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
of the format string and therefore an error occurred the function
returns \fBNULL\fP.
returns NULL.
.SH "CONFORMING TO"
XPG4, SUSv2, POSIX 1003.1-2001.
.SH EXAMPLE

View File

@ -49,7 +49,7 @@ used if possible instead of this array.
.SH "RETURN VALUE"
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
On some systems (but not on Linux), a NULL pointer may be
returned instead for an invalid signal number.
.SH "CONFORMING TO"
This function is not part of any standard, but may be found on Linux

View File

@ -61,13 +61,13 @@ equal to, or greater than the second.
\fBtsearch\fP() searches the tree for an item. \fIkey\fP
points to the item to be searched for. \fIrootp\fP points to a
variable which points to the root of the tree. If the tree is empty,
then the variable that \fIrootp\fP points to should be set to \fBNULL\fP.
then the variable that \fIrootp\fP points to should be set to NULL.
If the item is found in the tree, then \fBtsearch\fP() returns a pointer
to it. If it is not found, then \fBtsearch\fP() adds it, and returns a
pointer to the newly added item.
.PP
\fBtfind\fP() is like \fBtsearch\fP(), except that if the item is not
found, then \fBtfind\fP() returns \fBNULL\fP.
found, then \fBtfind\fP() returns NULL.
.PP
\fBtdelete\fP() deletes an item from the tree. Its arguments are the
same as for \fBtsearch\fP().
@ -100,17 +100,17 @@ no such work is necessary \fIfree_node\fP must point to a function
doing nothing.
.SH "RETURN VALUE"
\fBtsearch\fP() returns a pointer to a matching item in the tree, or to
the newly added item, or \fBNULL\fP if there was insufficient memory
the newly added item, or NULL if there was insufficient memory
to add the item. \fBtfind\fP() returns a pointer to the item, or
\fBNULL\fP if no match is found. If there
NULL if no match is found. If there
are multiple elements that match the key, the element returned is
unspecified.
.PP
\fBtdelete\fP() returns a pointer to the parent of the item deleted, or
\fBNULL\fP if the item was not found.
NULL if the item was not found.
.PP
\fBtsearch\fP(), \fBtfind\fP(), and \fBtdelete\fP() also
return \fBNULL\fP if \fIrootp\fP was \fBNULL\fP on entry.
return NULL if \fIrootp\fP was NULL on entry.
.SH WARNINGS
\fBtwalk\fP() takes a pointer to the root, while the other functions
take a pointer to a variable which points to the root.

View File

@ -38,7 +38,7 @@ ttyname, ttyname_r \- return name of a terminal
The function
.BR ttyname ()
returns a pointer to the NUL-terminated pathname of the terminal device
that is open on the file descriptor \fIfd\fP, or \fBNULL\fP on error
that is open on the file descriptor \fIfd\fP, or NULL on error
(for example, if \fIfd\fP is not connected to a terminal).
The return value may point to static data, possibly overwritten by the
next call.

View File

@ -162,7 +162,7 @@ invalidates the Unicode mapping. (Since 1.3.1.)
.IP \fBPIO_FONTRESET\fP
Resets the screen font, size and Unicode mapping to the bootup
defaults. \fIargp\fP is unused, but should be set to \fBNULL\fP to
defaults. \fIargp\fP is unused, but should be set to NULL to
ensure compatibility with future versions of Linux. (Since 1.3.28.)
.IP \fBGIO_SCRNMAP\fP