summaryrefslogtreecommitdiffstats
path: root/share/man/man3
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2004-07-03 18:29:24 +0000
committerru <ru@FreeBSD.org>2004-07-03 18:29:24 +0000
commit1cf159866714352fd8d7789b97068220cbb5a1a4 (patch)
tree5526e5113f4e9589bb734483867453b89a7ca4e6 /share/man/man3
parentbf15efbfc56854d6fb20bb4ff7801d7549fe2bfd (diff)
downloadFreeBSD-src-1cf159866714352fd8d7789b97068220cbb5a1a4.zip
FreeBSD-src-1cf159866714352fd8d7789b97068220cbb5a1a4.tar.gz
Mechanically kill hard sentence breaks and double whitespaces.
Diffstat (limited to 'share/man/man3')
-rw-r--r--share/man/man3/fpgetround.311
-rw-r--r--share/man/man3/intro.33
-rw-r--r--share/man/man3/pthread_cancel.32
-rw-r--r--share/man/man3/pthread_create.32
-rw-r--r--share/man/man3/pthread_detach.32
-rw-r--r--share/man/man3/pthread_exit.33
-rw-r--r--share/man/man3/pthread_join.32
-rw-r--r--share/man/man3/pthread_once.32
-rw-r--r--share/man/man3/pthread_rwlock_destroy.33
-rw-r--r--share/man/man3/pthread_rwlock_init.33
-rw-r--r--share/man/man3/pthread_rwlock_rdlock.311
-rw-r--r--share/man/man3/pthread_rwlock_unlock.33
-rw-r--r--share/man/man3/pthread_rwlock_wrlock.33
-rw-r--r--share/man/man3/pthread_rwlockattr_destroy.33
-rw-r--r--share/man/man3/pthread_rwlockattr_getpshared.39
-rw-r--r--share/man/man3/pthread_rwlockattr_init.33
-rw-r--r--share/man/man3/pthread_rwlockattr_setpshared.36
-rw-r--r--share/man/man3/stdarg.32
-rw-r--r--share/man/man3/sysexits.333
19 files changed, 68 insertions, 38 deletions
diff --git a/share/man/man3/fpgetround.3 b/share/man/man3/fpgetround.3
index 384cb9a..5d608f0 100644
--- a/share/man/man3/fpgetround.3
+++ b/share/man/man3/fpgetround.3
@@ -100,9 +100,11 @@ New code should use the functionality provided by
When a floating point exception is detected, the exception sticky flag is
set and the exception mask is tested.
If the mask is set, then a trap
-occurs. These routines allow both setting the floating point exception
-masks, and resetting the exception sticky flags after an exception is
-detected. In addition, they allow setting the floating point rounding mode
+occurs.
+These routines allow both setting the floating point exception
+masks, and resetting the exception sticky flags after an exception is
+detected.
+In addition, they allow setting the floating point rounding mode
and precision.
.Pp
The
@@ -170,7 +172,8 @@ At present, they are implemented only on the i386 and amd64 platforms.
.Xr isnan 3
.Sh CAVEAT
After a floating point exception and before a mask is set, the sticky
-flags must be reset. If another exception occurs before the sticky
+flags must be reset.
+If another exception occurs before the sticky
flags are reset, then a wrong exception type may be signaled.
.Sh HISTORY
These routines are based on SysV/386 routines of the same name.
diff --git a/share/man/man3/intro.3 b/share/man/man3/intro.3
index b7c5bff..5645ad9 100644
--- a/share/man/man3/intro.3
+++ b/share/man/man3/intro.3
@@ -97,7 +97,8 @@ Use of these routines should, for the most part, be avoided.
The manual page entry for each compatibility routine
indicates the proper interface to use.
.It Xr libkvm Pq Fl l Ns Ar kvm
-Functions used to access kernel memory are in this library. They can be used
+Functions used to access kernel memory are in this library.
+They can be used
against both a running system and a crash dump.
(See
.Xr kvm 3 . )
diff --git a/share/man/man3/pthread_cancel.3 b/share/man/man3/pthread_cancel.3
index f327316..fea6c47 100644
--- a/share/man/man3/pthread_cancel.3
+++ b/share/man/man3/pthread_cancel.3
@@ -47,7 +47,7 @@ expands to a constant expression of type
whose value matches no pointer to an object in memory nor the value
.Dv NULL .
.Sh RETURN VALUES
-If successful, the
+If successful, the
.Fn pthread_cancel
functions will return zero.
Otherwise an error number will be returned to
diff --git a/share/man/man3/pthread_create.3 b/share/man/man3/pthread_create.3
index a006b68..9c331ee 100644
--- a/share/man/man3/pthread_create.3
+++ b/share/man/man3/pthread_create.3
@@ -95,7 +95,7 @@ The signal mask is inherited from the creating thread.
The set of signals pending for the new thread is empty.
.El
.Sh RETURN VALUES
-If successful, the
+If successful, the
.Fn pthread_create
function will return zero.
Otherwise an error number will be returned to
diff --git a/share/man/man3/pthread_detach.3 b/share/man/man3/pthread_detach.3
index 2891632..5893934 100644
--- a/share/man/man3/pthread_detach.3
+++ b/share/man/man3/pthread_detach.3
@@ -60,7 +60,7 @@ The effect of multiple
.Fn pthread_detach
calls on the same target thread is unspecified.
.Sh RETURN VALUES
-If successful, the
+If successful, the
.Fn pthread_detach
function will return zero.
Otherwise an error number will be returned to
diff --git a/share/man/man3/pthread_exit.3 b/share/man/man3/pthread_exit.3
index 95da02b..dbc451e 100644
--- a/share/man/man3/pthread_exit.3
+++ b/share/man/man3/pthread_exit.3
@@ -68,7 +68,8 @@ An implicit call to
is made when a thread other than the thread in which
.Fn main
was first invoked returns from the start routine that was used to create
-it. The function's return value serves as the thread's exit status.
+it.
+The function's return value serves as the thread's exit status.
.Pp
The behavior of
.Fn pthread_exit
diff --git a/share/man/man3/pthread_join.3 b/share/man/man3/pthread_join.3
index 55bcd59..dfeffb9 100644
--- a/share/man/man3/pthread_join.3
+++ b/share/man/man3/pthread_join.3
@@ -75,7 +75,7 @@ is cancelled, then the target thread is not detached.
A thread that has exited but remains unjoined counts against
[_POSIX_THREAD_THREADS_MAX].
.Sh RETURN VALUES
-If successful, the
+If successful, the
.Fn pthread_join
function will return zero.
Otherwise an error number will be returned to
diff --git a/share/man/man3/pthread_once.3 b/share/man/man3/pthread_once.3
index bb5ebcf..00c5bdb 100644
--- a/share/man/man3/pthread_once.3
+++ b/share/man/man3/pthread_once.3
@@ -94,7 +94,7 @@ is undefined if
has automatic storage duration or is not initialized by
.Fa PTHREAD_ONCE_INIT .
.Sh RETURN VALUES
-If successful, the
+If successful, the
.Fn pthread_once
function will return zero.
Otherwise an error number will be returned to
diff --git a/share/man/man3/pthread_rwlock_destroy.3 b/share/man/man3/pthread_rwlock_destroy.3
index da284b6..f44aea6 100644
--- a/share/man/man3/pthread_rwlock_destroy.3
+++ b/share/man/man3/pthread_rwlock_destroy.3
@@ -46,7 +46,8 @@ function is used to destroy a read/write lock previously created with
.Sh RETURN VALUES
If successful, the
.Fn pthread_rwlock_destroy
-function will return zero. Otherwise an error number will be returned
+function will return zero.
+Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
.Xr pthread_rwlock_init 3
diff --git a/share/man/man3/pthread_rwlock_init.3 b/share/man/man3/pthread_rwlock_init.3
index 45ac47f..baee444 100644
--- a/share/man/man3/pthread_rwlock_init.3
+++ b/share/man/man3/pthread_rwlock_init.3
@@ -54,7 +54,8 @@ with an already initialized lock are undefined.
.Sh RETURN VALUES
If successful, the
.Fn pthread_rwlock_init
-function will return zero. Otherwise an error number will be returned
+function will return zero.
+Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
.Xr pthread_rwlockattr_init 3 ,
diff --git a/share/man/man3/pthread_rwlock_rdlock.3 b/share/man/man3/pthread_rwlock_rdlock.3
index 6c35a7d..6b8affd 100644
--- a/share/man/man3/pthread_rwlock_rdlock.3
+++ b/share/man/man3/pthread_rwlock_rdlock.3
@@ -49,17 +49,19 @@ function acquires a read lock on
provided that
.Fa lock
is not presently held for writing and no writer threads are
-presently blocked on the lock. If the read lock cannot be
+presently blocked on the lock.
+If the read lock cannot be
immediately acquired, the calling thread blocks until it can
acquire the lock.
.Pp
The
.Fn pthread_rwlock_tryrdlock
function performs the same action, but does not block if the lock
-cannot be immediately obtained (i.e. the lock is held for writing
+cannot be immediately obtained (i.e., the lock is held for writing
or there are waiting writers).
.Pp
-A thread may hold multiple concurrent read locks. If so,
+A thread may hold multiple concurrent read locks.
+If so,
.Fn pthread_rwlock_unlock
must be called once for each lock obtained.
.Pp
@@ -72,7 +74,8 @@ If successful, the
.Fn pthread_rwlock_rdlock
and
.Fn pthread_rwlock_tryrdlock
-functions will return zero. Otherwise an error number will be returned
+functions will return zero.
+Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
.Xr pthread_rwlock_init 3 ,
diff --git a/share/man/man3/pthread_rwlock_unlock.3 b/share/man/man3/pthread_rwlock_unlock.3
index ebc8ba3..91ba9f0 100644
--- a/share/man/man3/pthread_rwlock_unlock.3
+++ b/share/man/man3/pthread_rwlock_unlock.3
@@ -50,7 +50,8 @@ or
.Sh RETURN VALUES
If successful, the
.Fn pthread_rwlock_unlock
-function will return zero. Otherwise an error number will be returned
+function will return zero.
+Otherwise an error number will be returned
to indicate the error.
.Pp
The results are undefined if
diff --git a/share/man/man3/pthread_rwlock_wrlock.3 b/share/man/man3/pthread_rwlock_wrlock.3
index 2108d14..5349504 100644
--- a/share/man/man3/pthread_rwlock_wrlock.3
+++ b/share/man/man3/pthread_rwlock_wrlock.3
@@ -60,7 +60,8 @@ If successful, the
.Fn pthread_rwlock_wrlock
and
.Fn pthread_rwlock_trywrlock
-functions will return zero. Otherwise an error number will be returned
+functions will return zero.
+Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
.Xr pthread_rwlock_init 3 ,
diff --git a/share/man/man3/pthread_rwlockattr_destroy.3 b/share/man/man3/pthread_rwlockattr_destroy.3
index 42bcb80..8ccc219 100644
--- a/share/man/man3/pthread_rwlockattr_destroy.3
+++ b/share/man/man3/pthread_rwlockattr_destroy.3
@@ -47,7 +47,8 @@ previously created with
.Sh RETURN VALUES
If successful, the
.Fn pthread_rwlockattr_destroy
-function will return zero. Otherwise an error number will be returned
+function will return zero.
+Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
.Xr pthread_rwlockattr_init 3
diff --git a/share/man/man3/pthread_rwlockattr_getpshared.3 b/share/man/man3/pthread_rwlockattr_getpshared.3
index a7bbbe0..acda6e9 100644
--- a/share/man/man3/pthread_rwlockattr_getpshared.3
+++ b/share/man/man3/pthread_rwlockattr_getpshared.3
@@ -42,7 +42,8 @@
The
.Fn pthread_rwlockattr_getpshared
function is used to get the process shared setting of a read/write
-lock attribute object. The setting is returned via
+lock attribute object.
+The setting is returned via
.Fa pshared ,
and may be one of two values:
.Bl -tag -width PTHREAD_PROCESS_PRIVATE
@@ -51,13 +52,15 @@ Any thread of any process that has access to the memory where the
read/write lock resides can manipulate the lock.
.It Dv PTHREAD_PROCESS_PRIVATE
Only threads created within the same process as the thread that
-initialized the read/write lock can manipulate the lock. This is
+initialized the read/write lock can manipulate the lock.
+This is
the default value.
.El
.Sh RETURN VALUES
If successful, the
.Fn pthread_rwlockattr_getpshared
-function will return zero. Otherwise an error number will be returned
+function will return zero.
+Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
.Xr pthread_rwlockattr_init 3 ,
diff --git a/share/man/man3/pthread_rwlockattr_init.3 b/share/man/man3/pthread_rwlockattr_init.3
index cc78d54..0020386 100644
--- a/share/man/man3/pthread_rwlockattr_init.3
+++ b/share/man/man3/pthread_rwlockattr_init.3
@@ -45,7 +45,8 @@ function is used to initialize a read/write lock attributes object.
.Sh RETURN VALUES
If successful, the
.Fn pthread_rwlockattr_init
-function will return zero. Otherwise an error number will be returned
+function will return zero.
+Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
.Xr pthread_rwlockattr_destroy 3 ,
diff --git a/share/man/man3/pthread_rwlockattr_setpshared.3 b/share/man/man3/pthread_rwlockattr_setpshared.3
index 074794f..b4d2ecb 100644
--- a/share/man/man3/pthread_rwlockattr_setpshared.3
+++ b/share/man/man3/pthread_rwlockattr_setpshared.3
@@ -54,13 +54,15 @@ Any thread of any process that has access to the memory where the
read/write lock resides can manipulate the lock.
.It Dv PTHREAD_PROCESS_PRIVATE
Only threads created within the same process as the thread that
-initialized the read/write lock can manipulate the lock. This is
+initialized the read/write lock can manipulate the lock.
+This is
the default value.
.El
.Sh RETURN VALUES
If successful, the
.Fn pthread_rwlockattr_setpshared
-function will return zero. Otherwise an error number will be returned
+function will return zero.
+Otherwise an error number will be returned
to indicate the error.
.Sh SEE ALSO
.Xr pthread_rwlockattr_getpshared 3 ,
diff --git a/share/man/man3/stdarg.3 b/share/man/man3/stdarg.3
index 8dcd180..7f29f2a 100644
--- a/share/man/man3/stdarg.3
+++ b/share/man/man3/stdarg.3
@@ -85,7 +85,7 @@ and must be called first.
The parameter
.Fa last
is the name of the last parameter before the variable argument list,
-i.e. the last parameter of which the calling function knows the type.
+i.e., the last parameter of which the calling function knows the type.
.Pp
Because the address of this parameter is used in the
.Fn va_start
diff --git a/share/man/man3/sysexits.3 b/share/man/man3/sysexits.3
index 648fb06..b1ba47a 100644
--- a/share/man/man3/sysexits.3
+++ b/share/man/man3/sysexits.3
@@ -40,7 +40,8 @@ According to
it is not a good practice to call
.Xr exit 3
with arbitrary values to indicate a failure condition when ending
-a program. Instead, the pre-defined exit codes from
+a program.
+Instead, the pre-defined exit codes from
.Nm
should be used, so the caller of the process can get a rough
estimation about the failure class without looking up the source code.
@@ -50,14 +51,16 @@ The successful exit is always indicated by a status of 0, or
Error numbers begin at
.Sy EX__BASE
to reduce the possibility of clashing with other exit statuses that
-random programs may already return. The meaning of the codes is
+random programs may already return.
+The meaning of the codes is
approximately as follows:
.Bl -tag -width "EX_UNAVAILABLEXX(XX)"
.It Sy EX_USAGE Pq 64
The command was used incorrectly, e.g., with the wrong number of
arguments, a bad flag, a bad syntax in a parameter, or whatever.
.It Sy EX_DATAERR Pq 65
-The input data was incorrect in some way. This should only be used
+The input data was incorrect in some way.
+This should only be used
for user's data and not system files.
.It Sy EX_NOINPUT Pq 66
An input file (not a system file) did not exist or was not readable.
@@ -65,24 +68,31 @@ This could also include errors like
.Dq \&No message
to a mailer (if it cared to catch it).
.It Sy EX_NOUSER Pq 67
-The user specified did not exist. This might be used for mail
+The user specified did not exist.
+This might be used for mail
addresses or remote logins.
.It Sy EX_NOHOST Pq 68
-The host specified did not exist. This is used in mail addresses or
+The host specified did not exist.
+This is used in mail addresses or
network requests.
.It Sy EX_UNAVAILABLE Pq 69
-A service is unavailable. This can occur if a support program or file
-does not exist. This can also be used as a catchall message when
+A service is unavailable.
+This can occur if a support program or file
+does not exist.
+This can also be used as a catchall message when
something you wanted to do doesn't work, but you don't know why.
.It Sy EX_SOFTWARE Pq 70
-An internal software error has been detected. This should be limited
+An internal software error has been detected.
+This should be limited
to non-operating system related errors as possible.
.It Sy EX_OSERR Pq 71
-An operating system error has been detected. This is intended to be
+An operating system error has been detected.
+This is intended to be
used for such things as
.Dq cannot fork ,
.Dq cannot create pipe ,
-or the like. It includes things like getuid returning a user that
+or the like.
+It includes things like getuid returning a user that
does not exist in the passwd file.
.It Sy EX_OSFILE Pq 72
Some system file (e.g.,
@@ -103,7 +113,8 @@ The remote system returned something that was
.Dq not possible
during a protocol exchange.
.It Sy EX_NOPERM Pq 77
-You did not have sufficient permission to perform the operation. This
+You did not have sufficient permission to perform the operation.
+This
is not intended for file system problems, which should use
.Sy EX_NOINPUT
or
OpenPOWER on IntegriCloud