xref: /netbsd-src/lib/libc/sys/mkfifo.2 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
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.7 1994/04/22 00:13:39 jtc 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/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
48creates a new fifo file with name
49.Fa path .
50The access permissions are
51specified by
52.Fa mode
53and restricted by the
54.Xr umask 2
55of the calling process.
56.Pp
57The fifo's owner ID is set to the process's effective user ID.
58The fifo's group ID is set to that of the parent directory in
59which it is created.
60.Sh RETURN VALUES
61A 0 return value indicates success.  A -1 return value
62indicates an error, and an error code is stored in
63.Va errno .
64.Sh ERRORS
65.Fn Mkfifo
66will fail and no fifo will be created if:
67.Bl -tag -width Er
68.It Bq Er EOPNOTSUPP
69The kernel has not been configured to support fifo's.
70.It Bq Er ENOTDIR
71A component of the path prefix is not a directory.
72.It Bq Er ENAMETOOLONG
73A component of a pathname exceeded
74.Dv {NAME_MAX}
75characters, or an entire path name exceeded
76.Dv {PATH_MAX}
77characters.
78.It Bq Er ENOENT
79A component of the path prefix does not exist.
80.It Bq Er EACCES
81Search permission is denied for a component of the path prefix.
82.It Bq Er ELOOP
83Too many symbolic links were encountered in translating the pathname.
84.It Bq Er EROFS
85The named file resides on a read-only file system.
86.It Bq Er EEXIST
87The named file exists.
88.It Bq Er ENOSPC
89The directory in which the entry for the new fifo is being placed
90cannot be extended because there is no space left on the file
91system containing the directory.
92.It Bq Er ENOSPC
93There are no free inodes on the file system on which the
94fifo is being created.
95.It Bq Er EDQUOT
96The directory in which the entry for the new fifo
97is being placed cannot be extended because the
98user's quota of disk blocks on the file system
99containing the directory has been exhausted.
100.It Bq Er EDQUOT
101The user's quota of inodes on the file system on
102which the fifo is being created has been exhausted.
103.It Bq Er EIO
104An
105.Tn I/O
106error occurred while making the directory entry or allocating the inode.
107.It Bq Er EIO
108An
109.Tn I/O
110error occurred while reading from or writing to the file system.
111.It Bq Er EFAULT
112.Fa Path
113points outside the process's allocated address space.
114.El
115.Sh SEE ALSO
116.Xr chmod 2 ,
117.Xr stat 2 ,
118.Xr umask 2
119.Sh STANDARDS
120The
121.Nm mkfifo
122function call conforms to
123.St -p1003.1-88 .
124