xref: /netbsd-src/lib/libc/sys/mkfifo.2 (revision 5f7096188587a2c7c95fa3c69b78e1ec9c7923d0)
1.\" Copyright (c) 1990, 1991 The Regents of the University of California.
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, 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.\"	from: @(#)mkfifo.2	6.4 (Berkeley) 7/23/91
33.\"	$Id: mkfifo.2,v 1.2 1993/08/01 07:42:40 mycroft Exp $
34.\"
35.Dd July 23, 1991
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/stat.h>
43.Ft int
44.Fn mkfifo "const char *path" "mode_t mode"
45.Sh DESCRIPTION
46.Fn Mkfifo
47creates a new fifo file with name
48.Fa path .
49The access permissions are
50specified by
51.Fa mode
52and restricted by the
53.Xr umask 2
54of the calling process.
55.Pp
56The fifo's owner ID is set to the process's effective user ID.
57The fifo's group ID is set to that of the parent directory in
58which it is created.
59.Sh RETURN VALUES
60A 0 return value indicates success.  A -1 return value
61indicates an error, and an error code is stored in
62.Va errno .
63.Sh ERRORS
64.Fn Mkfifo
65will fail and no fifo will be created if:
66.Bl -tag -width ENAMETOOLO
67.It Bq Er ENOTSUPP
68The kernel has not been configured to support fifo's.
69.It Bq Er ENOTDIR
70A component of the path prefix is not a directory.
71.It Bq Er EINVAL
72The pathname contains a character with the high-order bit set.
73.It Bq Er ENAMETOOLONG
74A component of a pathname exceeded 255 characters,
75or an entire path name exceeded 1023 characters.
76.It Bq Er ENOENT
77A component of the path prefix does not exist.
78.It Bq Er EACCES
79Search permission is denied for a component of the path prefix.
80.It Bq Er ELOOP
81Too many symbolic links were encountered in translating the pathname.
82.It Bq Er EPERM
83The
84.Fa path
85argument contains a byte with the high-order bit set.
86.It Bq Er EROFS
87The named file resides on a read-only file system.
88.It Bq Er EEXIST
89The named file exists.
90.It Bq Er ENOSPC
91The directory in which the entry for the new fifo is being placed
92cannot be extended because there is no space left on the file
93system containing the directory.
94.It Bq Er ENOSPC
95There are no free inodes on the file system on which the
96fifo is being created.
97.It Bq Er EDQUOT
98The directory in which the entry for the new fifo
99is being placed cannot be extended because the
100user's quota of disk blocks on the file system
101containing the directory has been exhausted.
102.It Bq Er EDQUOT
103The user's quota of inodes on the file system on
104which the fifo is being created has been exhausted.
105.It Bq Er EIO
106An
107.Tn I/O
108error occurred while making the directory entry or allocating the inode.
109.It Bq Er EIO
110An
111.Tn I/O
112error occurred while reading from or writing to the file system.
113.It Bq Er EFAULT
114.Fa Path
115points outside the process's allocated address space.
116.El
117.Sh SEE ALSO
118.Xr chmod 2 ,
119.Xr stat 2 ,
120.Xr umask 2
121.Sh STANDARDS
122The
123.Nm mkfifo
124function call conforms to
125.St -p1003.1-88 .
126