]> git.saurik.com Git - apple/xnu.git/blame_incremental - bsd/man/man2/mkfifo.2
xnu-7195.101.1.tar.gz
[apple/xnu.git] / bsd / man / man2 / mkfifo.2
... / ...
CommitLineData
1.\" $NetBSD: mkfifo.2,v 1.8 1995/02/27 12:34:27 cgd 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 SYNOPSIS
43.Fd #include <sys/types.h>
44.Fd #include <sys/stat.h>
45.Ft int
46.Fn mkfifo "const char *path" "mode_t mode"
47.Sh DESCRIPTION
48.Fn mkfifo
49creates a new fifo file with name
50.Fa path .
51The access permissions are
52specified by
53.Fa mode
54and restricted by the
55.Xr umask 2
56of the calling process.
57.Pp
58The fifo's owner ID is set to the process's effective user ID.
59The fifo's group ID is set to that of the parent directory in
60which it is created.
61.Sh RETURN VALUES
62A 0 return value indicates success. A -1 return value
63indicates an error, and an error code is stored in
64.Va errno .
65.Sh ERRORS
66.Fn mkfifo
67will fail and no fifo will be created if:
68.Bl -tag -width Er
69.It Bq Er ENOTSUP
70The kernel has not been configured to support fifo's.
71.It Bq Er ENOTDIR
72A component of the path prefix is not a directory.
73.It Bq Er ENAMETOOLONG
74A component of a pathname exceeded
75.Dv {NAME_MAX}
76characters, or an entire path name exceeded
77.Dv {PATH_MAX}
78characters.
79.It Bq Er ENOENT
80A component of the path prefix does not exist.
81.It Bq Er EACCES
82Search permission is denied for a component of the path prefix.
83.It Bq Er ELOOP
84Too many symbolic links were encountered in translating the pathname.
85.It Bq Er EROFS
86The named file resides on a read-only file system.
87.It Bq Er EEXIST
88The named file exists.
89.It Bq Er ENOSPC
90The directory in which the entry for the new fifo is being placed
91cannot be extended because there is no space left on the file
92system containing the directory.
93.It Bq Er ENOSPC
94There are no free inodes on the file system on which the
95fifo is being created.
96.It Bq Er EDQUOT
97The directory in which the entry for the new fifo
98is being placed cannot be extended because the
99user's quota of disk blocks on the file system
100containing the directory has been exhausted.
101.It Bq Er EDQUOT
102The user's quota of inodes on the file system on
103which the fifo is being created has been exhausted.
104.It Bq Er EIO
105An
106.Tn I/O
107error occurred while making the directory entry or allocating the inode.
108.It Bq Er EIO
109An
110.Tn I/O
111error occurred while reading from or writing to the file system.
112.It Bq Er EFAULT
113.Fa Path
114points outside the process's allocated address space.
115.It Bq Eq EILSEQ
116The filename does not match the encoding rules.
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-88 .