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$ 32.\" 33.Dd April 4, 1996 34.Dt PTHREAD_DETACH 3 35.Os 36.Sh NAME 37.Nm pthread_detach 38.Nd detach a thread 39.Sh LIBRARY 40.Lb libpthread 41.Lb libthr 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 errno as it did for some drafts of the standard. 69These early drafts 70also passed a pointer to pthread_t as the argument. 71Beware! 72.Sh ERRORS 73The 74.Fn pthread_detach 75function will fail if: 76.Bl -tag -width Er 77.It Bq Er EINVAL 78The implementation has detected that the value specified by 79.Fa thread 80does not refer to a joinable thread. 81.It Bq Er ESRCH 82No thread could be found corresponding to that specified by the given 83thread ID, 84.Fa thread . 85.El 86.Sh SEE ALSO 87.Xr pthread_join 3 88.Sh STANDARDS 89The 90.Fn pthread_detach 91function conforms to 92.St -p1003.1-96 . 93