lib/libc/sys/mkfifo.2

   1 .\"     $NetBSD: mkfifo.2,v 1.20 2010/05/31 12:16:20 njoly Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1991, 1993
   4 .\"     The Regents of the University of California.  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, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)mkfifo.2    8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt MKFIFO 2
  34 .Os
  35 .Sh NAME
  36 .Nm mkfifo
  37 .Nd make a fifo file
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/stat.h
  42 .Ft int
  43 .Fn mkfifo "const char *path" "mode_t mode"
  44 .Sh DESCRIPTION
  45 .Fn mkfifo
  46 creates a new fifo file with name
  47 .Fa path .
  48 The access permissions are
  49 specified by
  50 .Fa mode
  51 and restricted by the
  52 .Xr umask 2
  53 of the calling process.
  54 .Pp
  55 The fifo's owner ID is set to the process's effective user ID.
  56 The fifo's group ID is set to that of the parent directory in
  57 which it is created.
  58 .Sh RETURN VALUES
  59 A 0 return value indicates success.
  60 A \-1 return value indicates an error, and an error code is stored in
  61 .Va errno .
  62 .Sh ERRORS
  63 .Fn mkfifo
  64 will fail and no fifo will be created if:
  65 .Bl -tag -width Er
  66 .It Bq Er EOPNOTSUPP
  67 The kernel has not been configured to support fifo's.
  68 .It Bq Er ENOTDIR
  69 A component of the path prefix is not a directory.
  70 .It Bq Er ENAMETOOLONG
  71 A component of a pathname exceeded
  72 .Brq Dv NAME_MAX
  73 characters, or an entire path name exceeded
  74 .Brq Dv PATH_MAX
  75 characters.
  76 .It Bq Er ENOENT
  77 A component of the path prefix does not exist.
  78 .It Bq Er EACCES
  79 Search permission is denied for a component of the path prefix.
  80 .It Bq Er ELOOP
  81 Too many symbolic links were encountered in translating the pathname.
  82 .It Bq Er EROFS
  83 The named file resides on a read-only file system.
  84 .It Bq Er EEXIST
  85 The named file exists.
  86 .It Bq Er ENOSPC
  87 The directory in which the entry for the new fifo is being placed
  88 cannot be extended because there is no space left on the file
  89 system containing the directory.
  90 .It Bq Er ENOSPC
  91 There are no free inodes on the file system on which the
  92 fifo is being created.
  93 .It Bq Er EDQUOT
  94 The directory in which the entry for the new fifo
  95 is being placed cannot be extended because the
  96 user's quota of disk blocks on the file system
  97 containing the directory has been exhausted.
  98 .It Bq Er EDQUOT
  99 The user's quota of inodes on the file system on
 100 which the fifo is being created has been exhausted.
 101 .It Bq Er EIO
 102 An
 103 .Tn I/O
 104 error occurred while making the directory entry or allocating the inode.
 105 .It Bq Er EIO
 106 An
 107 .Tn I/O
 108 error occurred while reading from or writing to the file system.
 109 .It Bq Er EFAULT
 110 .Fa path
 111 points outside the process's allocated address space.
 112 .El
 113 .Sh SEE ALSO
 114 .Xr chmod 2 ,
 115 .Xr stat 2 ,
 116 .Xr umask 2
 117 .Sh STANDARDS
 118 The
 119 .Nm mkfifo
 120 function call conforms to
 121 .St -p1003.1-90 .