lib/libc/sys/mkfifo.2

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)mkfifo.2    8.1 (Berkeley) 6/4/93
  33 .\"
  34 .Dd June 4, 1993
  35 .Dt MKFIFO 2
  36 .Os
  37 .Sh NAME
  38 .Nm mkfifo
  39 .Nd make a fifo file
  40 .Sh SYNOPSIS
  41 .Fd #include <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.  A -1 return value
  60 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 ENAMETOOLO
  66 .It Bq Er ENOTSUPP
  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 EINVAL
  71 The pathname contains a character with the high-order bit set.
  72 .It Bq Er ENAMETOOLONG
  73 A component of a pathname exceeded 255 characters,
  74 or an entire path name exceeded 1023 characters.
  75 .It Bq Er ENOENT
  76 A component of the path prefix does not exist.
  77 .It Bq Er EACCES
  78 Search permission is denied for a component of the path prefix.
  79 .It Bq Er ELOOP
  80 Too many symbolic links were encountered in translating the pathname.
  81 .It Bq Er EPERM
  82 The
  83 .Fa path
  84 argument contains a byte with the high-order bit set.
  85 .It Bq Er EROFS
  86 The named file resides on a read-only file system.
  87 .It Bq Er EEXIST
  88 The named file exists.
  89 .It Bq Er ENOSPC
  90 The directory in which the entry for the new fifo is being placed
  91 cannot be extended because there is no space left on the file
  92 system containing the directory.
  93 .It Bq Er ENOSPC
  94 There are no free inodes on the file system on which the
  95 fifo is being created.
  96 .It Bq Er EDQUOT
  97 The directory in which the entry for the new fifo
  98 is being placed cannot be extended because the
  99 user's quota of disk blocks on the file system
 100 containing the directory has been exhausted.
 101 .It Bq Er EDQUOT
 102 The user's quota of inodes on the file system on
 103 which the fifo is being created has been exhausted.
 104 .It Bq Er EIO
 105 An
 106 .Tn I/O
 107 error occurred while making the directory entry or allocating the inode.
 108 .It Bq Er EIO
 109 An
 110 .Tn I/O
 111 error occurred while reading from or writing to the file system.
 112 .It Bq Er EFAULT
 113 .Fa Path
 114 points outside the process's allocated address space.
 115 .El
 116 .Sh SEE ALSO
 117 .Xr chmod 2 ,
 118 .Xr stat 2 ,
 119 .Xr umask 2
 120 .Sh STANDARDS
 121 The
 122 .Fn mkfifo
 123 function call is expected to conform to
 124 .St -p1003.1-90 .