Move pthread* manpages to lib/libpthread as they are not libc_r specific.
[dragonfly.git] / lib / libpthread / pthread_attr_setcreatesuspend_np.3
CommitLineData
984263bc
MD
1.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD: src/lib/libc_r/man/pthread_attr_setcreatesuspend_np.3,v 1.2.2.1 2003/03/03 22:06:37 phantom Exp $
1de703da 26.\" $DragonFly: src/lib/libc_r/man/pthread_attr_setcreatesuspend_np.3,v 1.2 2003/06/17 04:26:47 dillon Exp $
984263bc
MD
27.\"
28.Dd February 13, 2003
29.Dt PTHREAD_ATTR_SETCREATESUSPEND_NP 3
30.Os
31.Sh NAME
32.Nm pthread_attr_setcreatesuspend_np
33.Nd prepare attribute for creattion of suspended thread
34.Sh LIBRARY
35.Lb libc_r
36.Sh SYNOPSIS
37.In pthread_np.h
38.Ft int
39.Fn pthread_attr_setcreatesuspend_np "pthread_attr_t *attr"
40.Sh DESCRIPTION
41The
42.Fn pthread_attr_setcreatesuspend_np
43instructs
44.Xr pthread_create 3
45that the thread created with the
46.Fa attr
47attribute
48should be created and left in a suspended state until explicitly resumed
49by the call to
50.Fn pthread_resume_np
51or
52.Fn pthread_resume_all_np .
53.Sh RETURN VALUES
54.Rv -std pthread_attr_setcreatesuspend_np
55.Sh ERRORS
56The
57.Fn pthread_attr_setcreatesuspend_np
58function will fail if:
59.Bl -tag -width Er
60.It Bq Er EINVAL
61The value specified by
62.Fa attr
63is invalid.
64.El
65.Sh SEE ALSO
66.Xr pthread_attr_destroy 3 ,
67.Xr pthread_attr_init 3 ,
68.Xr pthread_create 3 ,
69.Xr pthread_resume_all_np 3 ,
70.Xr pthread_resume_np 3
71.Sh AUTHORS
72This manual page was written by
73.An Alexey Zelkin Aq phantom@FreeBSD.org .