xref: /netbsd/lib/libc/sys/mkfifo.2 (revision c4a72b64)
1.\"	$NetBSD: mkfifo.2,v 1.15 2002/10/01 18:10:44 wiz 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. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	@(#)mkfifo.2	8.1 (Berkeley) 6/4/93
35.\"
36.Dd June 4, 1993
37.Dt MKFIFO 2
38.Os
39.Sh NAME
40.Nm mkfifo
41.Nd make a fifo file
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.Fd #include \*[Lt]sys/stat.h\*[Gt]
46.Ft int
47.Fn mkfifo "const char *path" "mode_t mode"
48.Sh DESCRIPTION
49.Fn mkfifo
50creates a new fifo file with name
51.Fa path .
52The access permissions are
53specified by
54.Fa mode
55and restricted by the
56.Xr umask 2
57of the calling process.
58.Pp
59The fifo's owner ID is set to the process's effective user ID.
60The fifo's group ID is set to that of the parent directory in
61which it is created.
62.Sh RETURN VALUES
63A 0 return value indicates success.
64A -1 return value indicates an error, and an error code is stored in
65.Va errno .
66.Sh ERRORS
67.Fn mkfifo
68will fail and no fifo will be created if:
69.Bl -tag -width Er
70.It Bq Er EOPNOTSUPP
71The kernel has not been configured to support fifo's.
72.It Bq Er ENOTDIR
73A component of the path prefix is not a directory.
74.It Bq Er ENAMETOOLONG
75A component of a pathname exceeded
76.Dv {NAME_MAX}
77characters, or an entire path name exceeded
78.Dv {PATH_MAX}
79characters.
80.It Bq Er ENOENT
81A component of the path prefix does not exist.
82.It Bq Er EACCES
83Search permission is denied for a component of the path prefix.
84.It Bq Er ELOOP
85Too many symbolic links were encountered in translating the pathname.
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-90 .
126