summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2005-06-15 19:04:04 +0000
committerru <ru@FreeBSD.org>2005-06-15 19:04:04 +0000
commit38fc91ca963def6ed6e416c706b47a96a211a4f6 (patch)
tree97fc4e4f3aa3a37fb93d81a61acfc80eec59bd98
parent079805c17f57ca60fceff319c87ae1a9d5e032c5 (diff)
downloadFreeBSD-src-38fc91ca963def6ed6e416c706b47a96a211a4f6.zip
FreeBSD-src-38fc91ca963def6ed6e416c706b47a96a211a4f6.tar.gz
Assorted markup fixes.
Approved by: re
-rw-r--r--lib/libarchive/libarchive-formats.53
-rw-r--r--lib/libarchive/tar.52
-rw-r--r--lib/libautofs/libautofs.322
-rw-r--r--lib/libc/gen/sysctl.318
-rw-r--r--lib/libc/gen/ttyname.329
-rw-r--r--lib/libc/net/getaddrinfo.36
-rw-r--r--lib/libc/net/getnameinfo.36
-rw-r--r--lib/libc/net/getnetent.32
-rw-r--r--lib/libc/net/inet6_rth_space.326
-rw-r--r--lib/libc/nls/catgets.32
-rw-r--r--lib/libc/sys/send.24
-rw-r--r--lib/libpam/modules/pam_exec/pam_exec.82
-rw-r--r--lib/libsdp/sdp.32
-rw-r--r--lib/msun/man/fenv.32
-rw-r--r--lib/msun/man/lround.36
-rw-r--r--lib/msun/man/round.32
-rw-r--r--lib/msun/man/trunc.32
17 files changed, 85 insertions, 51 deletions
diff --git a/lib/libarchive/libarchive-formats.5 b/lib/libarchive/libarchive-formats.5
index 196d94e..0b32c7b 100644
--- a/lib/libarchive/libarchive-formats.5
+++ b/lib/libarchive/libarchive-formats.5
@@ -222,7 +222,8 @@ shardump archives less portable than plain shar archives.
.El
.Ss ISO9660 format
Libarchive can read and extract from files containing ISO9660-compliant
-CDROM images. It also has partial support for Rockridge extensions.
+CDROM images.
+It also has partial support for Rockridge extensions.
In many cases, this can remove the need to burn a physical CDROM.
It also avoids security and complexity issues that come with
virtual mounts and loopback devices.
diff --git a/lib/libarchive/tar.5 b/lib/libarchive/tar.5
index 3c08fce..c887931 100644
--- a/lib/libarchive/tar.5
+++ b/lib/libarchive/tar.5
@@ -191,7 +191,7 @@ This format is often called the
format, after the magic value used
in the header.
(The name is an acronym for
-.Dq Unix Standard TAR. )
+.Dq Unix Standard TAR . )
It extends the historic format with new fields:
.Bd -literal -offset indent
struct header_posix_ustar {
diff --git a/lib/libautofs/libautofs.3 b/lib/libautofs/libautofs.3
index f450175..16b9f4c 100644
--- a/lib/libautofs/libautofs.3
+++ b/lib/libautofs/libautofs.3
@@ -180,7 +180,8 @@ return the offset request associated with the request
(used for readdir request)
.It Fn autoreq_getxid
return the transaction id associated with an autofs request, these
-are unique per mount point, but not system wide. They can be used
+are unique per mount point, but not system wide.
+They can be used
for debugging to ensure requests are being accepted by the kernel.
.El
.Pp
@@ -197,11 +198,14 @@ this is typically unused.
.It Fn autoreq_seterrno
set the error returned to the application sending the request, typically
this is left alone, or set to ENOENT if the request is for a non-existant
-name. The default error is no error. Meaning the application will see
+name.
+The default error is no error.
+Meaning the application will see
a successful return.
.It Fn autoreq_setaux
used to set the auxilliray data for a request, currently used to set
-the dirent structures for serving a readdir request. Default is no
+the dirent structures for serving a readdir request.
+Default is no
auxilliary data.
.It Fn autoreq_seteof
used to set the eof flag for readdir requests (default is not eof.)
@@ -217,11 +221,13 @@ directory via
.Fa path
and
.Fa fd
-respectively. The
+respectively.
+The
.Fa pid
argument should be set to the pid of the process serving
.Xr autofs 9
-requests, or -1 to disable the option. The options are
+requests, or -1 to disable the option.
+The options are
.Bl -tag -width AUTO_INDIRECT
.It Fa AUTO_MOUNTER
set this process as the one responsible for the
@@ -237,11 +243,13 @@ and
will be routed to userland after the current actual directory contents
are read into userland.
.It Fa AUTO_DIRECT
-Set the directory as a mount trigger. Any request to enter the directory
+Set the directory as a mount trigger.
+Any request to enter the directory
will trigger a callback into the process
.Fa pid .
.It Fa AUTO_INDIRECT
-Set the directory as an indirect trigger. Any request for an entry inside
+Set the directory as an indirect trigger.
+Any request for an entry inside
the directory will be routed to the process identified by
.Fa pid .
.El
diff --git a/lib/libc/gen/sysctl.3 b/lib/libc/gen/sysctl.3
index 5fe33dc..9ac8cee 100644
--- a/lib/libc/gen/sysctl.3
+++ b/lib/libc/gen/sysctl.3
@@ -454,20 +454,26 @@ whose size depends on the current number of such objects in the system.
.It "KERN_PROC_RUID A real user ID"
.El
.Pp
-If the third level name is KERN_PROC_ARGS then the command line argument
+If the third level name is
+.Dv KERN_PROC_ARGS
+then the command line argument
array is returned in a flattened form, i.e., zero-terminated arguments
follow each other.
The total size of array is returned.
It is also possible for a process to set its own process title this way.
-If the third level name is KERN_PROC_PATHNAME, the path of the
+If the third level name is
+.Dv KERN_PROC_PATHNAME ,
+the path of the
process' text file is stored.
-For KERN_PROC_PATHNAME, a process ID of
-.Li -1
+For
+.Dv KERN_PROC_PATHNAME ,
+a process ID of
+.Li \-1
implies the current process.
.Bl -column "Third level nameXXXXXX" "Fourth level is:XXXXXX" -offset indent
.It Sy "Third level name Fourth level is:"
-.It "KERN_PROC_ARGS A process ID"
-.It "KERN_PROC_PATHNAME A process ID"
+.It Dv KERN_PROC_ARGS Ta "A process ID"
+.It Dv KERN_PROC_PATHNAME Ta "A process ID"
.El
.It Li KERN_PROF
Return profiling information about the kernel.
diff --git a/lib/libc/gen/ttyname.3 b/lib/libc/gen/ttyname.3
index db67314..5f427fb 100644
--- a/lib/libc/gen/ttyname.3
+++ b/lib/libc/gen/ttyname.3
@@ -85,10 +85,14 @@ a file descriptor for which
.Fn isatty
is true.
.Pp
+The
.Fn ttyname
+function
returns the name stored in a static buffer which will be overwritten
on subsequent calls.
+The
.Fn ttyname_r
+function
takes a buffer and length as arguments to avoid this problem.
.Pp
The
@@ -109,40 +113,49 @@ a
pointer is returned.
The
.Fn ttyname_r
-function returns 0 if successful. Otherwise an error number is returned.
+function returns 0 if successful.
+Otherwise an error number is returned.
.Pp
The
.Fn ttyslot
function
returns the unit number of the device file if found; otherwise
the value zero is returned.
+.Sh FILES
+.Bl -tag -width ".Pa /etc/ttys" -compact
+.It Pa /dev/\(**
+.It Pa /etc/ttys
+.El
.Sh ERRORS
+The
.Fn ttyname_r
-may return the following error codes:
+may fail and return the following error codes:
.Bl -tag -width Er
.It Bq Er ENOTTY
+The
.Fa fd
+argument
is not a valid file descriptor.
.It Bq Er ERANGE
+The
.Fa bufsize
+argument
is smaller than the length of the string to be returned.
-.Sh FILES
-.Bl -tag -width /etc/ttys -compact
-.It Pa /dev/\(**
-.It Pa /etc/ttys
.El
.Sh SEE ALSO
.Xr ioctl 2 ,
.Xr ttys 5
.Sh HISTORY
-A
+The
.Fn isatty ,
.Fn ttyname ,
and
.Fn ttyslot
-function
+functions
appeared in
.At v7 .
+The
.Fn ttyname_r
+function
appeared in
.Fx 6.0 .
diff --git a/lib/libc/net/getaddrinfo.3 b/lib/libc/net/getaddrinfo.3
index 3982bfe..9c5a8b6 100644
--- a/lib/libc/net/getaddrinfo.3
+++ b/lib/libc/net/getaddrinfo.3
@@ -30,8 +30,10 @@
.Fd #include <sys/socket.h>
.Fd #include <netdb.h>
.Ft int
-.Fn getaddrinfo "const char *hostname" "const char *servname" \
- "const struct addrinfo *hints" "struct addrinfo **res"
+.Fo getaddrinfo
+.Fa "const char *hostname" "const char *servname"
+.Fa "const struct addrinfo *hints" "struct addrinfo **res"
+.Fc
.Ft void
.Fn freeaddrinfo "struct addrinfo *ai"
.Sh DESCRIPTION
diff --git a/lib/libc/net/getnameinfo.3 b/lib/libc/net/getnameinfo.3
index 54dce39..61479cf 100644
--- a/lib/libc/net/getnameinfo.3
+++ b/lib/libc/net/getnameinfo.3
@@ -29,8 +29,10 @@
.Fd #include <sys/socket.h>
.Fd #include <netdb.h>
.Ft int
-.Fn getnameinfo "const struct sockaddr *sa" "socklen_t salen" "char *host" \
- "size_t hostlen" "char *serv" "size_t servlen" "int flags"
+.Fo getnameinfo
+.Fa "const struct sockaddr *sa" "socklen_t salen" "char *host"
+.Fa "size_t hostlen" "char *serv" "size_t servlen" "int flags"
+.Fc
.Sh DESCRIPTION
The
.Fn getnameinfo
diff --git a/lib/libc/net/getnetent.3 b/lib/libc/net/getnetent.3
index 978b25b..3c329a6 100644
--- a/lib/libc/net/getnetent.3
+++ b/lib/libc/net/getnetent.3
@@ -167,7 +167,7 @@ functions appeared in
.Bx 4.2 .
.Sh BUGS
The data space used by
-these functions is a thread-specific; if future use requires the data, it should be
+these functions is thread-specific; if future use requires the data, it should be
copied before any subsequent calls to these functions overwrite it.
Only Internet network
numbers are currently understood.
diff --git a/lib/libc/net/inet6_rth_space.3 b/lib/libc/net/inet6_rth_space.3
index b8110e1..3903485 100644
--- a/lib/libc/net/inet6_rth_space.3
+++ b/lib/libc/net/inet6_rth_space.3
@@ -61,7 +61,7 @@
The IPv6 Advanced API, RFC 3542, defines the functions that an
application calls to build and examine IPv6 Routing headers.
Routing headers are used to perform source routing in IPv6 networks.
-The RFC uses the word
+The RFC uses the word
.Dq segments
to describe addresses and that is the term used here as well.
All of the functions are defined in the
@@ -82,14 +82,14 @@ The
.Fn inet6_rth_space
function returns the number of bytes required to hold a Routing Header
of the type, specified in the
-.Fa type
+.Fa type
argument and containing the number of addresses specified in the
.Fa segments
argumment.
-When the type is
+When the type is
.Dv IPV6_RTHDR_TYPE_0
the number of segments must be from 0 through 127.
-Routing headers of type
+Routing headers of type
.Dv IPV6_RTHDR_TYPE_2
contain only one segment, and are only used with Mobile IPv6.
The return value from this function is the number of bytes required to
@@ -166,20 +166,25 @@ The
.Fa index
is the location in the routing header from which the application wants
to retrieve an address.
-The
-.Fa index
+The
+.Fa index
parameter must have a value between 0 and one less than the number of
segments present in the routing header.
The
-.Fn inet6_rth_segments
+.Fn inet6_rth_segments
function, described in the last section, should be used to determine
the total number of segments in the routing header.
The
.Fn inet6_rth_getaddr
-function returns a pointer to an IPv6 address on success or
+function returns a pointer to an IPv6 address on success or
.Dv NULL
when an error has occurred.
.\"
+.Sh EXAMPLES
+RFC 3542 gives extensive examples in Section 21, Appendix B.
+.Pp
+KAME also provides examples in the advapitest directory of its kit.
+.\"
.Sh DIAGNOSTICS
The
.Fn inet6_rth_space
@@ -198,11 +203,6 @@ and
.Fn inet6_rth_reverse
functions return 0 on success, or \-1 upon an error.
.\"
-.Sh EXAMPLES
-RFC 3542 gives extensive examples in Section 21, Appendix B.
-.Pp
-KAME also provides examples in the advapitest directory of its kit.
-.\"
.Sh SEE ALSO
.Rs
.%A W. Stevens
diff --git a/lib/libc/nls/catgets.3 b/lib/libc/nls/catgets.3
index fe78211..38e92ba 100644
--- a/lib/libc/nls/catgets.3
+++ b/lib/libc/nls/catgets.3
@@ -63,7 +63,7 @@ otherwise it returns
.It Bq Er EBADF
The
.Fa catd
-argument is not valid message catalog descriptor.
+argument is not a valid message catalog descriptor.
.It Bq Er EBADMSG
The message identified by
.Fa set_id
diff --git a/lib/libc/sys/send.2 b/lib/libc/sys/send.2
index 7434db2..20e005b 100644
--- a/lib/libc/sys/send.2
+++ b/lib/libc/sys/send.2
@@ -137,7 +137,9 @@ protocol family, and is used to implement Transaction
.Dv MSG_DONTROUTE
is usually used only by diagnostic or routing programs.
.Dv MSG_NOSIGNAL
-is used to prevent SIGPIPE generation when writing a socket that
+is used to prevent
+.Dv SIGPIPE
+generation when writing a socket that
may be closed.
.Pp
See
diff --git a/lib/libpam/modules/pam_exec/pam_exec.8 b/lib/libpam/modules/pam_exec/pam_exec.8
index d7e5308..311d64c 100644
--- a/lib/libpam/modules/pam_exec/pam_exec.8
+++ b/lib/libpam/modules/pam_exec/pam_exec.8
@@ -60,8 +60,8 @@ variables:
and
.Ev PAM_USER .
.Sh SEE ALSO
-.Xr pam.conf 5 ,
.Xr pam_get_item 3 ,
+.Xr pam.conf 5 ,
.Xr pam 8
.Sh AUTHORS
The
diff --git a/lib/libsdp/sdp.3 b/lib/libsdp/sdp.3
index e80d0ac..c51b6f9 100644
--- a/lib/libsdp/sdp.3
+++ b/lib/libsdp/sdp.3
@@ -25,7 +25,7 @@
.\" $Id: sdp.3,v 1.1 2003/09/07 20:34:19 max Exp $
.\" $FreeBSD$
.\"
-.Dd September 7, 2003
+.Dd May 27, 2005
.Dt SDP 3
.Os
.Sh NAME
diff --git a/lib/msun/man/fenv.3 b/lib/msun/man/fenv.3
index 1ae0177..3450153 100644
--- a/lib/msun/man/fenv.3
+++ b/lib/msun/man/fenv.3
@@ -75,7 +75,7 @@
.Ft int
.Fn fedisableexcept "int excepts"
.Ft int
-.Fn fegetexcept "void"
+.Fn fegetexcept void
.Sh DESCRIPTION
The
.In fenv.h
diff --git a/lib/msun/man/lround.3 b/lib/msun/man/lround.3
index f2c4a3f..a98229d 100644
--- a/lib/msun/man/lround.3
+++ b/lib/msun/man/lround.3
@@ -101,12 +101,12 @@ functions conform to
.St -isoC-99 .
.Sh HISTORY
The
-.Ft float
+.Vt float
and
-.Ft double
+.Vt double
versions of these routines first appeared in
.Fx 5.4 .
The
-.Ft long double
+.Vt "long double"
versions appeared in
.Fx 6.0 .
diff --git a/lib/msun/man/round.3 b/lib/msun/man/round.3
index 262cf0f..24b3970 100644
--- a/lib/msun/man/round.3
+++ b/lib/msun/man/round.3
@@ -40,7 +40,7 @@
.Fn round "double x"
.Ft float
.Fn roundf "float x"
-.Ft long double
+.Ft "long double"
.Fn roundl "long double x"
.Sh DESCRIPTION
The
diff --git a/lib/msun/man/trunc.3 b/lib/msun/man/trunc.3
index c510095..7d9e828 100644
--- a/lib/msun/man/trunc.3
+++ b/lib/msun/man/trunc.3
@@ -40,7 +40,7 @@
.Fn trunc "double x"
.Ft float
.Fn truncf "float x"
-.Ft long double
+.Ft "long double"
.Fn truncl "long double x"
.Sh DESCRIPTION
The
OpenPOWER on IntegriCloud