xref: /dragonfly/lib/libpthread/pthread_detach.3 (revision a563ca70)
1.\" Copyright (c) 1996-1998 John Birrell <jb@cimlogic.com.au>.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by John Birrell.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\" $FreeBSD: src/share/man/man3/pthread_detach.3,v 1.18 2007/10/22 10:08:00 ru Exp $
32.\" $DragonFly: src/lib/libc_r/man/pthread_detach.3,v 1.3 2007/06/30 19:03:52 swildner Exp $
33.\"
34.Dd July 10, 2009
35.Dt PTHREAD_DETACH 3
36.Os
37.Sh NAME
38.Nm pthread_detach
39.Nd detach a thread
40.Sh LIBRARY
41.Lb libpthread
42.Sh SYNOPSIS
43.In pthread.h
44.Ft int
45.Fn pthread_detach "pthread_t thread"
46.Sh DESCRIPTION
47The
48.Fn pthread_detach
49function is used to indicate to the implementation that storage for the
50thread
51.Fa thread
52can be reclaimed when the thread terminates.
53If
54.Fa thread
55has not terminated,
56.Fn pthread_detach
57will not cause it to terminate.
58The effect of multiple
59.Fn pthread_detach
60calls on the same target thread is unspecified.
61.Sh RETURN VALUES
62If successful, the
63.Fn pthread_detach
64function will return zero.
65Otherwise an error number will be returned to
66indicate the error.
67Note that the function does not change the value
68of
69.Va errno
70as it did for some drafts of the standard.
71These early drafts also passed a pointer to
72.Vt pthread_t
73as the argument.
74Beware!
75.Sh ERRORS
76The
77.Fn pthread_detach
78function will fail if:
79.Bl -tag -width Er
80.It Bq Er EINVAL
81The implementation has detected that the value specified by
82.Fa thread
83does not refer to a joinable thread.
84.It Bq Er ESRCH
85No thread could be found corresponding to that specified by the given
86thread ID,
87.Fa thread .
88.El
89.Sh SEE ALSO
90.Xr pthread_join 3
91.Sh STANDARDS
92The
93.Fn pthread_detach
94function conforms to
95.St -p1003.1-96 .
96