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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)mkfifo.2    8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd December 10, 2006
  32 .Dt MKFIFO 2
  33 .Os
  34 .Sh NAME
  35 .Nm mkfifo
  36 .Nd make a fifo file
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/stat.h
  42 .Ft int
  43 .Fn mkfifo "const char *path" "mode_t mode"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn mkfifo
  47 system call
  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 .Rv -std mkfifo
  62 .Sh ERRORS
  63 The
  64 .Fn mkfifo
  65 system call
  66 will fail and no fifo will be created if:
  67 .Bl -tag -width Er
  68 .It Bq Er ENOTSUP
  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 A component of the path prefix denies search permission, or write permission
  79 is denied on the parent directory of the fifo to be created.
  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 would reside on a read-only file system.
  84 .It Bq Er EEXIST
  85 The named file exists.
  86 .It Bq Er EPERM
  87 The parent directory of the named file has its immutable flag set, see the
  88 .Xr chflags 2
  89 manual page for more information.
  90 .It Bq Er ENOSPC
  91 The directory in which the entry for the new fifo is being placed
  92 cannot be extended because there is no space left on the file
  93 system containing the directory.
  94 .It Bq Er ENOSPC
  95 There are no free inodes on the file system on which the
  96 fifo is being created.
  97 .It Bq Er EDQUOT
  98 The directory in which the entry for the new fifo
  99 is being placed cannot be extended because the
 100 user's quota of disk blocks on the file system
 101 containing the directory has been exhausted.
 102 .It Bq Er EDQUOT
 103 The user's quota of inodes on the file system on
 104 which the fifo is being created has been exhausted.
 105 .It Bq Er EIO
 106 An
 107 .Tn I/O
 108 error occurred while making the directory entry or allocating the inode.
 109 .It Bq Er EIO
 110 An
 111 .Tn I/O
 112 error occurred while reading from or writing to the file system.
 113 .It Bq Er EFAULT
 114 The
 115 .Fa path
 116 argument
 117 points outside the process's allocated address space.
 118 .El
 119 .Sh SEE ALSO
 120 .Xr chflags 2 ,
 121 .Xr chmod 2 ,
 122 .Xr mknod 2 ,
 123 .Xr stat 2 ,
 124 .Xr umask 2
 125 .Sh STANDARDS
 126 The
 127 .Fn mkfifo
 128 system call is expected to conform to
 129 .St -p1003.1-90 .