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