summaryrefslogtreecommitdiffstats
path: root/lib/libpthread
diff options
context:
space:
mode:
authorcharnier <charnier@FreeBSD.org>2003-06-08 10:40:44 +0000
committercharnier <charnier@FreeBSD.org>2003-06-08 10:40:44 +0000
commit732ab8fe2e2621c3d80fd6947fc75403ec4c628a (patch)
tree17aab05cee878f741bbcab80eb855cf9fcb68ed2 /lib/libpthread
parent5e579c3a89371f65765b9e26f498a195df556c6b (diff)
downloadFreeBSD-src-732ab8fe2e2621c3d80fd6947fc75403ec4c628a.zip
FreeBSD-src-732ab8fe2e2621c3d80fd6947fc75403ec4c628a.tar.gz
The .Fn function
Diffstat (limited to 'lib/libpthread')
-rw-r--r--lib/libpthread/man/pthread_attr.330
-rw-r--r--lib/libpthread/man/pthread_cancel.36
-rw-r--r--lib/libpthread/man/pthread_cleanup_pop.36
-rw-r--r--lib/libpthread/man/pthread_cleanup_push.36
-rw-r--r--lib/libpthread/man/pthread_cond_broadcast.36
-rw-r--r--lib/libpthread/man/pthread_cond_destroy.36
-rw-r--r--lib/libpthread/man/pthread_cond_init.36
-rw-r--r--lib/libpthread/man/pthread_cond_signal.36
-rw-r--r--lib/libpthread/man/pthread_cond_timedwait.36
-rw-r--r--lib/libpthread/man/pthread_cond_wait.36
-rw-r--r--lib/libpthread/man/pthread_condattr.39
-rw-r--r--lib/libpthread/man/pthread_create.36
-rw-r--r--lib/libpthread/man/pthread_detach.36
13 files changed, 70 insertions, 35 deletions
diff --git a/lib/libpthread/man/pthread_attr.3 b/lib/libpthread/man/pthread_attr.3
index 9208fe5..982d03c 100644
--- a/lib/libpthread/man/pthread_attr.3
+++ b/lib/libpthread/man/pthread_attr.3
@@ -119,23 +119,26 @@ to the location pointed to by the second function parameter.
If successful, these functions return 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
+The
.Fn pthread_attr_init
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Out of memory.
.El
.Pp
+The
.Fn pthread_attr_destroy
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.El
.Pp
+The
.Fn pthread_attr_setstacksize
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa stacksize
@@ -143,24 +146,27 @@ is less than
.Dv PTHREAD_STACK_MIN .
.El
.Pp
+The
.Fn pthread_attr_setdetachstate
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa detachstate .
.El
.Pp
+The
.Fn pthread_attr_setinheritsched
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.El
.Pp
+The
.Fn pthread_attr_setschedparam
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
@@ -170,8 +176,9 @@ Invalid value for
.Fa param .
.El
.Pp
+The
.Fn pthread_attr_setschedpolicy
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
@@ -181,8 +188,9 @@ Invalid or unsupported value for
.Fa policy .
.El
.Pp
+The
.Fn pthread_attr_setscope
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
@@ -194,6 +202,7 @@ Invalid or unsupported value for
.Sh SEE ALSO
.Xr pthread_create 3
.Sh STANDARDS
+The
.Fn pthread_attr_init ,
.Fn pthread_attr_destroy ,
.Fn pthread_attr_setstacksize ,
@@ -203,9 +212,10 @@ Invalid or unsupported value for
.Fn pthread_attr_setdetachstate ,
and
.Fn pthread_attr_getdetachstate
-conform to
+functions conform to
.St -p1003.1-96
.Pp
+The
.Fn pthread_attr_setinheritsched ,
.Fn pthread_attr_getinheritsched ,
.Fn pthread_attr_setschedparam ,
@@ -215,5 +225,5 @@ conform to
.Fn pthread_attr_setscope ,
and
.Fn pthread_attr_getscope
-conform to
+functions conform to
.St -susv2
diff --git a/lib/libpthread/man/pthread_cancel.3 b/lib/libpthread/man/pthread_cancel.3
index a64e3d7..ffa5b6d 100644
--- a/lib/libpthread/man/pthread_cancel.3
+++ b/lib/libpthread/man/pthread_cancel.3
@@ -51,8 +51,9 @@ functions will return zero.
Otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
+The
.Fn pthread_cancel
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er ESRCH
No thread could be found corresponding to that specified by the given
@@ -67,8 +68,9 @@ thread ID.
.Xr pthread_setcanceltype 3 ,
.Xr pthread_testcancel 3
.Sh STANDARDS
+The
.Fn pthread_cancel
-conforms to
+function conforms to
.St -p1003.1-96 .
.Sh AUTHORS
This man page was written by
diff --git a/lib/libpthread/man/pthread_cleanup_pop.3 b/lib/libpthread/man/pthread_cleanup_pop.3
index 85c22db..519e53f 100644
--- a/lib/libpthread/man/pthread_cleanup_pop.3
+++ b/lib/libpthread/man/pthread_cleanup_pop.3
@@ -51,14 +51,16 @@ then
.Fn pthread_cleanup_pop
does nothing.
.Sh RETURN VALUES
+The
.Fn pthread_cleanup_pop
-does not return any value.
+function does not return any value.
.Sh ERRORS
None
.Sh SEE ALSO
.Xr pthread_cleanup_push 3 ,
.Xr pthread_exit 3
.Sh STANDARDS
+The
.Fn pthread_cleanup_pop
-conforms to
+function conforms to
.St -p1003.1-96 .
diff --git a/lib/libpthread/man/pthread_cleanup_push.3 b/lib/libpthread/man/pthread_cleanup_push.3
index f7cf663..2790987 100644
--- a/lib/libpthread/man/pthread_cleanup_push.3
+++ b/lib/libpthread/man/pthread_cleanup_push.3
@@ -53,14 +53,16 @@ is called, it is passed
.Fa arg
as its only argument.
.Sh RETURN VALUES
+The
.Fn pthread_cleanup_push
-does not return any value.
+function does not return any value.
.Sh ERRORS
None
.Sh SEE ALSO
.Xr pthread_cleanup_pop 3 ,
.Xr pthread_exit 3
.Sh STANDARDS
+The
.Fn pthread_cleanup_push
-conforms to
+function conforms to
.St -p1003.1-96 .
diff --git a/lib/libpthread/man/pthread_cond_broadcast.3 b/lib/libpthread/man/pthread_cond_broadcast.3
index 4852615..bbd2741 100644
--- a/lib/libpthread/man/pthread_cond_broadcast.3
+++ b/lib/libpthread/man/pthread_cond_broadcast.3
@@ -50,8 +50,9 @@ If successful, the
function will return zero, otherwise an error number will be returned
to indicate the error.
.Sh ERRORS
+The
.Fn pthread_cond_broadcast
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@@ -65,6 +66,7 @@ is invalid.
.Xr pthread_cond_timedwait 3 ,
.Xr pthread_cond_wait 3
.Sh STANDARDS
+The
.Fn pthread_cond_broadcast
-conforms to
+function conforms to
.St -p1003.1-96 .
diff --git a/lib/libpthread/man/pthread_cond_destroy.3 b/lib/libpthread/man/pthread_cond_destroy.3
index 92c8392..ca435ea 100644
--- a/lib/libpthread/man/pthread_cond_destroy.3
+++ b/lib/libpthread/man/pthread_cond_destroy.3
@@ -50,8 +50,9 @@ If successful, the
function will return zero, otherwise an error number will be returned
to indicate the error.
.Sh ERRORS
+The
.Fn pthread_cond_destroy
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@@ -69,6 +70,7 @@ is locked by another thread.
.Xr pthread_cond_timedwait 3 ,
.Xr pthread_cond_wait 3
.Sh STANDARDS
+The
.Fn pthread_cond_destroy
-conforms to
+function conforms to
.St -p1003.1-96 .
diff --git a/lib/libpthread/man/pthread_cond_init.3 b/lib/libpthread/man/pthread_cond_init.3
index 7089410..3eac40b 100644
--- a/lib/libpthread/man/pthread_cond_init.3
+++ b/lib/libpthread/man/pthread_cond_init.3
@@ -54,8 +54,9 @@ function will return zero and put the new condition variable id into
.Fa cond ,
otherwise an error number will be returned to indicate the error.
.Sh ERRORS
+The
.Fn pthread_cond_init
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@@ -75,6 +76,7 @@ variable.
.Xr pthread_cond_timedwait 3 ,
.Xr pthread_cond_wait 3
.Sh STANDARDS
+The
.Fn pthread_cond_init
-conforms to
+function conforms to
.St -p1003.1-96 .
diff --git a/lib/libpthread/man/pthread_cond_signal.3 b/lib/libpthread/man/pthread_cond_signal.3
index dac3dde..8ab801f 100644
--- a/lib/libpthread/man/pthread_cond_signal.3
+++ b/lib/libpthread/man/pthread_cond_signal.3
@@ -50,8 +50,9 @@ If successful, the
function will return zero, otherwise an error number will be returned
to indicate the error.
.Sh ERRORS
+The
.Fn pthread_cond_signal
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@@ -65,6 +66,7 @@ is invalid.
.Xr pthread_cond_timedwait 3 ,
.Xr pthread_cond_wait 3
.Sh STANDARDS
+The
.Fn pthread_cond_signal
-conforms to
+function conforms to
.St -p1003.1-96 .
diff --git a/lib/libpthread/man/pthread_cond_timedwait.3 b/lib/libpthread/man/pthread_cond_timedwait.3
index dc13945..24f4141 100644
--- a/lib/libpthread/man/pthread_cond_timedwait.3
+++ b/lib/libpthread/man/pthread_cond_timedwait.3
@@ -63,8 +63,9 @@ function will return zero.
Otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
+The
.Fn pthread_cond_timedwait
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@@ -84,6 +85,7 @@ The system time has reached or exceeded the time specified in
.Xr pthread_cond_signal 3 ,
.Xr pthread_cond_wait 3
.Sh STANDARDS
+The
.Fn pthread_cond_timedwait
-conforms to
+function conforms to
.St -p1003.1-96 .
diff --git a/lib/libpthread/man/pthread_cond_wait.3 b/lib/libpthread/man/pthread_cond_wait.3
index dd84a63..2740297 100644
--- a/lib/libpthread/man/pthread_cond_wait.3
+++ b/lib/libpthread/man/pthread_cond_wait.3
@@ -61,8 +61,9 @@ function will return zero.
Otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
+The
.Fn pthread_cond_wait
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The value specified by
@@ -78,6 +79,7 @@ is invalid.
.Xr pthread_cond_signal 3 ,
.Xr pthread_cond_timedwait 3
.Sh STANDARDS
+The
.Fn pthread_cond_wait
-conforms to
+function conforms to
.St -p1003.1-96 .
diff --git a/lib/libpthread/man/pthread_condattr.3 b/lib/libpthread/man/pthread_condattr.3
index 4891089..86e772a 100644
--- a/lib/libpthread/man/pthread_condattr.3
+++ b/lib/libpthread/man/pthread_condattr.3
@@ -61,15 +61,17 @@ function destroys a condition attribute object.
If successful, these functions return 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
+The
.Fn pthread_condattr_init
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Out of memory.
.El
.Pp
+The
.Fn pthread_condattr_destroy
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
@@ -78,8 +80,9 @@ Invalid value for
.Sh SEE ALSO
.Xr pthread_cond_init 3
.Sh STANDARDS
+The
.Fn pthread_condattr_init
and
.Fn pthread_condattr_destroy
-conform to
+functions conform to
.St -p1003.1-96
diff --git a/lib/libpthread/man/pthread_create.3 b/lib/libpthread/man/pthread_create.3
index 1998122..c89f42f 100644
--- a/lib/libpthread/man/pthread_create.3
+++ b/lib/libpthread/man/pthread_create.3
@@ -99,8 +99,9 @@ function will return zero.
Otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
+The
.Fn pthread_create
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EAGAIN
The system lacked the necessary resources to create another thread, or
@@ -118,6 +119,7 @@ is invalid.
.Xr pthread_exit 3 ,
.Xr pthread_join 3
.Sh STANDARDS
+The
.Fn pthread_create
-conforms to
+function conforms to
.St -p1003.1-96 .
diff --git a/lib/libpthread/man/pthread_detach.3 b/lib/libpthread/man/pthread_detach.3
index 3147f64..6232814 100644
--- a/lib/libpthread/man/pthread_detach.3
+++ b/lib/libpthread/man/pthread_detach.3
@@ -69,8 +69,9 @@ These early drafts
also passed a pointer to pthread_t as the argument.
Beware!
.Sh ERRORS
+The
.Fn pthread_detach
-will fail if:
+function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The implementation has detected that the value specified by
@@ -84,6 +85,7 @@ thread ID,
.Sh SEE ALSO
.Xr pthread_join 3
.Sh STANDARDS
+The
.Fn pthread_detach
-conforms to
+function conforms to
.St -p1003.1-96 .
OpenPOWER on IntegriCloud