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