add .Mt to man pages in lib/
[dragonfly.git] / lib / libpthread / pthread_suspend_np.3
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/share/man/man3/pthread_switch_add_np.3,v 1.5 2007/10/22 10:08:01 ru Exp $
26 .\"
27 .Dd July 10, 2009
28 .Dt PTHREAD_SUSPEND_NP 3
29 .Os
30 .Sh NAME
31 .Nm pthread_suspend_np
32 .Nd suspend a thread
33 .Sh LIBRARY
34 .Lb libpthread
35 .Sh SYNOPSIS
36 .In pthread.h
37 .In pthread_np.h
38 .Ft int
39 .Fn pthread_suspend_np "pthread_t tid"
40 .Sh DESCRIPTION
41 The
42 .Fn pthread_suspend_np
43 function, called on an active thread, causes it to suspend.
44 .Sh RETURN VALUES
45 If successful,
46 .Fn pthread_suspend_np
47 function returns 0.
48 Otherwise, an error number is returned to indicate the error.
49 .Sh ERRORS
50 The
51 .Fn pthread_suspend_np
52 function will fail if:
53 .Bl -tag -width Er
54 .It Bq Er EDEADLK
55 An attempt was made to suspend the current thread.
56 .It Bq Er EINVAL
57 The value specified by the
58 .Fa tid
59 argument is invalid.
60 .It Bq ESRC
61 No thread could be found corresponding to the thread ID specified by the
62 .Fa tid
63 argument.
64 .El
65 .Sh SEE ALSO
66 .Xr pthread_resume_all_np 3 ,
67 .Xr pthread_resume_np 3 ,
68 .Xr pthread_suspend_all_np 3
69 .Sh AUTHORS
70 This manual page was written by
71 .An Alexey Zelkin Aq Mt phantom@FreeBSD.org .