--- pth.3 2001/07/12 07:20:04 1.231
+++ pth.3 2002/01/27 12:34:30 1.232
@@ -1,5 +1,5 @@
.\" Automatically generated by Pod::Man version 1.15
-.\" Thu Jul 12 09:19:00 2001
+.\" Sun Jan 27 13:33:11 2002
.\"
.\" Standard preamble:
.\" ======================================================================
@@ -138,13 +138,13 @@
.\" ======================================================================
.\"
.IX Title "pth 3"
-.TH pth 3 "24-Mar-2001" "GNU Pth 1.4.0" "GNU Portable Threads"
+.TH pth 3 "27-Jan-2002" "GNU Pth 1.4.1" "GNU Portable Threads"
.UC
.SH "NAME"
\&\fBpth\fR \- \s-1GNU\s0 Portable Threads
.SH "VERSION"
.IX Header "VERSION"
-\&\s-1GNU\s0 Pth \s-11.4.0 (24-Mar-2001)\s0
+\&\s-1GNU\s0 Pth \s-11.4.1 (27-Jan-2002)\s0
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Ip "\fBGlobal Library Management\fR" 4
@@ -756,9 +756,10 @@
.if n .Ip "\f(CW""""PTH_ATTR_JOINABLE""""\fR (read-write> [\f(CW""""int""""\fR]" 4
.el .Ip "\f(CWPTH_ATTR_JOINABLE\fR (read-write> [\f(CWint\fR]" 4
.IX Item "PTH_ATTR_JOINABLE (read-write> [int]"
-The thread detachment type, \f(CW\*(C`TRUE\*(C'\fR indicates a joinable thread, \f(CW\*(C`FALSE\*(C'\fR
-indicates a detached thread. When a the is detached after termination it is
-immediately kicked out of the system instead of inserted into the dead queue.
+The thread detachment type, \f(CW\*(C`TRUE\*(C'\fR indicates a joinable thread,
+\&\f(CW\*(C`FALSE\*(C'\fR indicates a detached thread. When a thread is detached,
+after termination it is immediately kicked out of the system instead of
+inserted into the dead queue.
.if n .Ip "\f(CW""""PTH_ATTR_CANCEL_STATE""""\fR (read-write) [\f(CW""""unsigned int""""\fR]" 4
.el .Ip "\f(CWPTH_ATTR_CANCEL_STATE\fR (read-write) [\f(CWunsigned int\fR]" 4
.IX Item "PTH_ATTR_CANCEL_STATE (read-write) [unsigned int]"
@@ -1006,21 +1007,23 @@
`\f(CW\*(C`pth_cancel(\*(C'\fR\fItid\fR\f(CW\*(C`)\*(C'\fR'.
.Ip "int \fBpth_join\fR(pth_t \fItid\fR, void **\fIvalue\fR);" 4
.IX Item "int pth_join(pth_t tid, void **value);"
-This joins the current thread with the thread specified via \fItid\fR. It first
-suspends the current thread until the \fItid\fR thread has terminated. Then it is
-awakened and stores the value of \fItid\fR's \fIpth_exit\fR\|(3) call into *\fIvalue\fR (if
-\&\fIvalue\fR and not \f(CW\*(C`NULL\*(C'\fR) and returns to the caller. A thread can be joined
-only when it was \fInot\fR spawned with \f(CW\*(C`PTH_FLAG_NOJOIN\*(C'\fR. A thread can only be
-joined once, i.e., after the \fIpth_join\fR\|(3) call the thread \fItid\fR is removed
-from the system.
+This joins the current thread with the thread specified via \fItid\fR.
+It first suspends the current thread until the \fItid\fR thread has
+terminated. Then it is awakened and stores the value of \fItid\fR's
+\&\fIpth_exit\fR\|(3) call into *\fIvalue\fR (if \fIvalue\fR and not \f(CW\*(C`NULL\*(C'\fR) and
+returns to the caller. A thread can be joined only when it has the
+attribute \f(CW\*(C`PTH_ATTR_JOINABLE\*(C'\fR set to \f(CW\*(C`TRUE\*(C'\fR (the default). A thread
+can only be joined once, i.e., after the \fIpth_join\fR\|(3) call the thread
+\&\fItid\fR is completely removed from the system.
.Ip "void \fBpth_exit\fR(void *\fIvalue\fR);" 4
.IX Item "void pth_exit(void *value);"
-This terminates the current thread. Whether it's immediately removed from the
-system or inserted into the dead queue of the scheduler depends on its join
-type which was specified at spawning time. When it was spawned with
-\&\f(CW\*(C`PTH_FLAG_NOJOIN\*(C'\fR it's immediately removed and \fIvalue\fR is ignored.
-Else the thread is inserted into the dead queue and \fIvalue\fR remembered
-for a \fIpth_join\fR\|(3) call by another thread.
+This terminates the current thread. Whether it's immediately removed
+from the system or inserted into the dead queue of the scheduler depends
+on its join type which was specified at spawning time. If it has the
+attribute \f(CW\*(C`PTH_ATTR_JOINABLE\*(C'\fR set to \f(CW\*(C`FALSE\*(C'\fR, it's immediately removed
+and \fIvalue\fR is ignored. Else the thread is inserted into the dead queue
+and \fIvalue\fR remembered for a subsequent \fIpth_join\fR\|(3) call by another
+thread.
.Sh "Utilities"
.IX Subsection "Utilities"
The following functions are utility functions.
@@ -1098,7 +1101,7 @@
.el .Ip "\f(CWPTH_EVENT_FD\fR" 4
.IX Item "PTH_EVENT_FD"
This is a file descriptor event. One or more of \f(CW\*(C`PTH_UNTIL_FD_READABLE\*(C'\fR,
-\&\f(CW\*(C`PTH_UNTIL_FD_WRITEABLE\*(C'\fR or \f(CW\*(C`PTH_UNTIL_FD_EXECPTION\*(C'\fR have to be OR-ed into
+\&\f(CW\*(C`PTH_UNTIL_FD_WRITEABLE\*(C'\fR or \f(CW\*(C`PTH_UNTIL_FD_EXCEPTION\*(C'\fR have to be OR-ed into
\&\fIspec\fR to specify on which state of the file descriptor you want to wait. The
file descriptor itself has to be given as an additional argument. Example:
`\f(CW\*(C`pth_event(PTH_EVENT_FD|PTH_UNTIL_FD_READABLE, fd)\*(C'\fR'.
@@ -1821,9 +1824,8 @@
\& | rm -f Makefile
.Ve
Because \fBautoconf\fR generates additional files, we added a canonical
-\&\f(CW\*(C`distclean\*(C'\fR target which cleanups this, too. Second, we write
-a (minimalistic) \fBautoconf\fR script specification in a file
-\&\f(CW\*(C`configure.in\*(C'\fR:
+\&\f(CW\*(C`distclean\*(C'\fR target which cleans this up. Secondly, we wrote
+\&\f(CW\*(C`configure.in\*(C'\fR, a (minimal) \fBautoconf\fR script specification:
.PP
.Vb 4
\& $ vi configure.in
@@ -1881,8 +1883,8 @@
.IX Subsection "Autoconf Build Environment with Local Copy of Pth (Expert)"
Finally let us assume the \f(CW\*(C`foo\*(C'\fR program stays under either a \fI\s-1GPL\s0\fR or
\&\fI\s-1LGPL\s0\fR distribution license and we want to make it a stand-alone package for
-easier distribution and installation. That is, we don't want that the
-end-user first has to install \fBPth\fR just to allow our \f(CW\*(C`foo\*(C'\fR package to
+easier distribution and installation. That is, we don't want to oblige the
+end-user to install \fBPth\fR just to allow our \f(CW\*(C`foo\*(C'\fR package to
compile. For this, it is a convenient practice to include the required
libraries (here \fBPth\fR) into the source tree of the package (here \f(CW\*(C`foo\*(C'\fR).
\&\fBPth\fR ships with all necessary support to allow us to easily achieve this
|
