lib/libpthread/sem_open.3

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