xref: /freebsd/lib/libthr/libthr.3 (revision 18242d3b09dbc3f5e278e39baaa3c3b76624c901)
1.\" Copyright (c) 2005 Robert N. M. Watson
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 AUTHORS 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 AUTHORS 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$
26.\"
27.Dd June 11, 2005
28.Os
29.Dt LIBTHR 3
30.Sh NAME
31.Nm libthr
32.Nd "alternative POSIX threads library"
33.Sh LIBRARY
34.Lb libthr
35.Sh SYNOPSIS
36.In pthread.h
37.Sh DESCRIPTION
38The
39.Nm
40library provides an alternative 1:1 implementation of the
41.Xr pthread 3
42library interfaces for application threading.
43While applications may be linked directly against
44.Nm ,
45system administrators are offered maximum flexibility by linking against
46.Xr pthread 3 ,
47as they can then use
48.Xr libmap.conf 5
49to select the threading implementation on a per-application basis.
50.Pp
51The
52.Nm
53library
54has been optimized for use by applications expecting system scope thread
55semantics, and can provide significant performance improvements.
56.Sh SEE ALSO
57.Xr pthread 3
58.Sh AUTHORS
59.An -nosplit
60The
61.Nm
62library
63was originally created by
64.An "Jeff Roberson" Aq jeff@FreeBSD.org ,
65and enhanced by
66.An "Jonathan Mini" Aq mini@FreeBSD.org
67and
68.An "Mike Makonnen" Aq mtm@FreeBSD.org .
69It has been substantially rewritten and optimized by
70.An "David Xu" Aq davidxu@FreeBSD.org .
71