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 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt MKFIFO 2
  37 .Os
  38 .Sh NAME
  39 .Nm mkfifo
  40 .Nd make a fifo file
  41 .Sh SYNOPSIS
  42 .Fd #include <sys/types.h>
  43 .Fd #include <sys/stat.h>
  44 .Ft int
  45 .Fn mkfifo "const char *path" "mode_t mode"
  46 .Sh DESCRIPTION
  47 .Fn Mkfifo
  48 creates a new fifo file with name
  49 .Fa path .
  50 The access permissions are
  51 specified by
  52 .Fa mode
  53 and restricted by the
  54 .Xr umask 2
  55 of the calling process.
  56 .Pp
  57 The fifo's owner ID is set to the process's effective user ID.
  58 The fifo's group ID is set to that of the parent directory in
  59 which it is created.
  60 .Sh RETURN VALUES
  61 A 0 return value indicates success.  A -1 return value
  62 indicates an error, and an error code is stored in
  63 .Va errno .
  64 .Sh ERRORS
  65 .Fn Mkfifo
  66 will fail and no fifo will be created if:
  67 .Bl -tag -width ENAMETOOLO
  68 .It Bq Er ENOTSUPP
  69 The kernel has not been configured to support fifo's.
  70 .It Bq Er ENOTDIR
  71 A component of the path prefix is not a directory.
  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 EROFS
  82 The named file resides on a read-only file system.
  83 .It Bq Er EEXIST
  84 The named file exists.
  85 .It Bq Er ENOSPC
  86 The directory in which the entry for the new fifo is being placed
  87 cannot be extended because there is no space left on the file
  88 system containing the directory.
  89 .It Bq Er ENOSPC
  90 There are no free inodes on the file system on which the
  91 fifo is being created.
  92 .It Bq Er EDQUOT
  93 The directory in which the entry for the new fifo
  94 is being placed cannot be extended because the
  95 user's quota of disk blocks on the file system
  96 containing the directory has been exhausted.
  97 .It Bq Er EDQUOT
  98 The user's quota of inodes on the file system on
  99 which the fifo is being created has been exhausted.
 100 .It Bq Er EIO
 101 An
 102 .Tn I/O
 103 error occurred while making the directory entry or allocating the inode.
 104 .It Bq Er EIO
 105 An
 106 .Tn I/O
 107 error occurred while reading from or writing to the file system.
 108 .It Bq Er EFAULT
 109 .Fa Path
 110 points outside the process's allocated address space.
 111 .El
 112 .Sh SEE ALSO
 113 .Xr chmod 2 ,
 114 .Xr mknod 2 ,
 115 .Xr stat 2 ,
 116 .Xr umask 2
 117 .Sh STANDARDS
 118 The
 119 .Fn mkfifo
 120 function call is expected to conform to
 121 .St -p1003.1-90 .