[apple/xnu.git] / bsd / man / man2 / mkfifo.2

.\"	$NetBSD: mkfifo.2,v 1.8 1995/02/27 12:34:27 cgd Exp $
.\"
.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)mkfifo.2	8.1 (Berkeley) 6/4/93
.\"
.Dd June 4, 1993
.Dt MKFIFO 2
.Os
.Sh NAME
.Nm mkfifo
.Nd make a fifo file
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/stat.h>
.Ft int
.Fn mkfifo "const char *path" "mode_t mode"
.Sh DESCRIPTION
.Fn Mkfifo
creates a new fifo file with name
.Fa path .
The access permissions are
specified by
.Fa mode
and restricted by the
.Xr umask 2
of the calling process.
.Pp
The fifo's owner ID is set to the process's effective user ID.
The fifo's group ID is set to that of the parent directory in
which it is created.
.Sh RETURN VALUES
A 0 return value indicates success.  A -1 return value
indicates an error, and an error code is stored in
.Va errno .
.Sh ERRORS
.Fn Mkfifo
will fail and no fifo will be created if:
.Bl -tag -width Er
.It Bq Er EOPNOTSUPP
The kernel has not been configured to support fifo's.
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG
A component of a pathname exceeded 
.Dv {NAME_MAX}
characters, or an entire path name exceeded 
.Dv {PATH_MAX}
characters.
.It Bq Er ENOENT
A component of the path prefix does not exist.
.It Bq Er EACCES
Search permission is denied for a component of the path prefix.
.It Bq Er ELOOP
Too many symbolic links were encountered in translating the pathname.
.It Bq Er EROFS
The named file resides on a read-only file system.
.It Bq Er EEXIST
The named file exists.
.It Bq Er ENOSPC
The directory in which the entry for the new fifo is being placed
cannot be extended because there is no space left on the file
system containing the directory.
.It Bq Er ENOSPC
There are no free inodes on the file system on which the
fifo is being created.
.It Bq Er EDQUOT
The directory in which the entry for the new fifo
is being placed cannot be extended because the
user's quota of disk blocks on the file system
containing the directory has been exhausted.
.It Bq Er EDQUOT
The user's quota of inodes on the file system on
which the fifo is being created has been exhausted.
.It Bq Er EIO
An
.Tn I/O
error occurred while making the directory entry or allocating the inode.
.It Bq Er EIO
An
.Tn I/O
error occurred while reading from or writing to the file system.
.It Bq Er EFAULT
.Fa Path
points outside the process's allocated address space.
.El
.Sh SEE ALSO
.Xr chmod 2 ,
.Xr stat 2 ,
.Xr umask 2
.Sh STANDARDS
The
.Nm mkfifo
function call conforms to
.St -p1003.1-88 .
Commit	Line	Data
9bccf70c A	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
	49	creates a new fifo file with name
	50	.Fa path .
	51	The access permissions are
	52	specified by
	53	.Fa mode
	54	and restricted by the
	55	.Xr umask 2
	56	of the calling process.
	57	.Pp
	58	The fifo's owner ID is set to the process's effective user ID.
	59	The fifo's group ID is set to that of the parent directory in
	60	which it is created.
	61	.Sh RETURN VALUES
	62	A 0 return value indicates success. A -1 return value
	63	indicates an error, and an error code is stored in
	64	.Va errno .
65	.Sh ERRORS
66	.Fn Mkfifo
67	will fail and no fifo will be created if:
68	.Bl -tag -width Er
69	.It Bq Er EOPNOTSUPP
70	The kernel has not been configured to support fifo's.
71	.It Bq Er ENOTDIR
72	A component of the path prefix is not a directory.
73	.It Bq Er ENAMETOOLONG
74	A component of a pathname exceeded
75	.Dv {NAME_MAX}
76	characters, or an entire path name exceeded
77	.Dv {PATH_MAX}
78	characters.
79	.It Bq Er ENOENT
80	A component of the path prefix does not exist.
81	.It Bq Er EACCES
82	Search permission is denied for a component of the path prefix.
83	.It Bq Er ELOOP
84	Too many symbolic links were encountered in translating the pathname.
85	.It Bq Er EROFS
86	The named file resides on a read-only file system.
87	.It Bq Er EEXIST
88	The named file exists.
89	.It Bq Er ENOSPC
90	The directory in which the entry for the new fifo is being placed
91	cannot be extended because there is no space left on the file
92	system containing the directory.
93	.It Bq Er ENOSPC
94	There are no free inodes on the file system on which the
95	fifo is being created.
96	.It Bq Er EDQUOT
97	The directory in which the entry for the new fifo
98	is being placed cannot be extended because the
99	user's quota of disk blocks on the file system
100	containing the directory has been exhausted.
101	.It Bq Er EDQUOT
102	The user's quota of inodes on the file system on
103	which the fifo is being created has been exhausted.
104	.It Bq Er EIO
105	An
106	.Tn I/O
107	error occurred while making the directory entry or allocating the inode.
108	.It Bq Er EIO
109	An
110	.Tn I/O
111	error occurred while reading from or writing to the file system.
112	.It Bq Er EFAULT
113	.Fa Path
114	points outside the process's allocated address space.
115	.El
116	.Sh SEE ALSO
117	.Xr chmod 2 ,
118	.Xr stat 2 ,
119	.Xr umask 2
120	.Sh STANDARDS
121	The
122	.Nm mkfifo
123	function call conforms to
124	.St -p1003.1-88 .