xref: /openbsd/lib/libpthread/man/sem_open.3 (revision 404b540a)
1.\" $OpenBSD: sem_open.3,v 1.4 2007/05/31 19:19:37 jmc Exp $
2.\"
3.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
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(s), this list of conditions and the following disclaimer as
11.\"    the first lines of this file unmodified other than the possible
12.\"    addition of one or more copyright notices.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice(s), this list of conditions and the following disclaimer in
15.\"    the documentation and/or other materials provided with the
16.\"    distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
19.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
22.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
25.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\" $FreeBSD: src/lib/libc_r/man/sem_open.3,v 1.7 2001/10/01 16:09:09 ru Exp $
31.Dd $Mdocdate: May 31 2007 $
32.Dt SEM_OPEN 3
33.Os
34.Sh NAME
35.Nm sem_open ,
36.Nm sem_close ,
37.Nm sem_unlink
38.Nd named semaphore operations
39.Sh SYNOPSIS
40.Fd #include <semaphore.h>
41.Ft sem_t *
42.Fn sem_open "const char *name" "int oflag" "..."
43.Ft int
44.Fn sem_close "sem_t *sem"
45.Ft int
46.Fn sem_unlink "const char *name"
47.Sh DESCRIPTION
48The
49.Fn sem_open ,
50.Fn sem_close ,
51and
52.Fn sem_unlink
53functions are not supported by this implementation.
54.Sh RETURN VALUES
55.Fn sem_open
56returns SEM_FAILED and sets
57.Va errno
58to indicate an error.
59.Fn sem_close
60and
61.Fn sem_unlink
62return -1 and set
63.Va errno
64to indicate an error.
65.Sh ERRORS
66.Fn sem_open ,
67.Fn sem_close ,
68and
69.Fn sem_unlink
70will fail:
71.Bl -tag -width Er
72.It Bq Er ENOSYS
73Function not supported by this implementation.
74.El
75.Sh SEE ALSO
76.Xr sem_destroy 3 ,
77.Xr sem_getvalue 3 ,
78.Xr sem_init 3 ,
79.Xr sem_post 3 ,
80.Xr sem_wait 3
81.Sh STANDARDS
82.Fn sem_open ,
83.Fn sem_close ,
84and
85.Fn sem_unlink
86conform to
87.St -p1003.1-96 .
88