[unix-history] / usr / src / lib / libc / sys / mkfifo.2

.\" Copyright (c) 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms are permitted provided
.\" that: (1) source distributions retain this entire copyright notice and
.\" comment, and (2) distributions including binaries display the following
.\" acknowledgement:  ``This product includes software developed by the
.\" University of California, Berkeley and its contributors'' in the
.\" documentation or other materials provided with the distribution and in
.\" all advertising materials mentioning features or use of this software.
.\" 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\"	@(#)mkfifo.2	6.2 (Berkeley) 6/23/90
.\"
.TH MKFIFO 2 "June 23, 1990"
.UC 7
.SH NAME
mkfifo \- make a fifo file
.SH SYNOPSIS
.nf
.ft B
mkfifo(path, mode)
char *path;
int mode;
.fi
.ft R
.SH DESCRIPTION
.I Mkfifo
creates a new fifo file with name
.IR path .
The mode of the new file
is initialized from
.IR mode .
(The protection part of the mode
is modified by the process's mode mask; see
.IR umask (2)).
.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.
.PP
The low-order 9 bits of mode are modified by the process's
file mode creation mask: all bits set in the process's file mode
creation mask are cleared.  See
.IR umask (2).
.SH "RETURN VALUE
A 0 return value indicates success.  A \-1 return value
indicates an error, and an error code is stored in
.I errno.
.SH "ERRORS
.I Mkfifo
will fail and no fifo will be created if:
.TP 15
[ENOTSUPP]
The kernel has not been configured to support fifo's.
.TP 15
[ENOTDIR]
A component of the path prefix is not a directory.
.TP 15
[EINVAL]
The pathname contains a character with the high-order bit set.
.TP 15
[ENAMETOOLONG]
A component of a pathname exceeded 255 characters,
or an entire path name exceeded 1023 characters.
.TP 15
[ENOENT]
A component of the path prefix does not exist.
.TP 15
[EACCES]
Search permission is denied for a component of the path prefix.
.TP 15
[ELOOP]
Too many symbolic links were encountered in translating the pathname.
.TP 15
[EPERM]
The \fIpath\fP argument contains a byte with the high-order bit set.
.TP 15
[EROFS]
The named file resides on a read-only file system.
.TP 15
[EEXIST]
The named file exists.
.TP 15
[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.
.TP 15
[ENOSPC]
There are no free inodes on the file system on which the
fifo is being created.
.TP 15
[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.
.TP 15
[EDQUOT]
The user's quota of inodes on the file system on
which the fifo is being created has been exhausted.
.TP 15
[EIO]
An I/O error occurred while making the directory entry or allocating the inode.
.TP 15
[EIO]
An I/O error occurred while reading from or writing to the file system.
.TP 15
[EFAULT]
.I Path
points outside the process's allocated address space.
.SH "SEE ALSO"
chmod(2), stat(2), umask(2)
Commit	Line	Data
e1d4f580 KM	1	.\" Copyright (c) 1990 The Regents of the University of California.
	2	.\" All rights reserved.
	3	.\"
1c15e888 C	4	.\" Redistribution and use in source and binary forms are permitted provided
	5	.\" that: (1) source distributions retain this entire copyright notice and
	6	.\" comment, and (2) distributions including binaries display the following
	7	.\" acknowledgement: ``This product includes software developed by the
	8	.\" University of California, Berkeley and its contributors'' in the
	9	.\" documentation or other materials provided with the distribution and in
	10	.\" all advertising materials mentioning features or use of this software.
	11	.\" Neither the name of the University nor the names of its contributors may
	12	.\" be used to endorse or promote products derived from this software without
	13	.\" specific prior written permission.
	14	.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
	15	.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
	16	.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
e1d4f580	17	.\"
1c15e888	18	.\" @(#)mkfifo.2 6.2 (Berkeley) 6/23/90
e1d4f580	19	.\"
1c15e888	20	.TH MKFIFO 2 "June 23, 1990"
e1d4f580 KM	21	.UC 7
	22	.SH NAME
	23	mkfifo \- make a fifo file
	24	.SH SYNOPSIS
	25	.nf
	26	.ft B
	27	mkfifo(path, mode)
	28	char *path;
	29	int mode;
	30	.fi
	31	.ft R
	32	.SH DESCRIPTION
	33	.I Mkfifo
	34	creates a new fifo file with name
	35	.IR path .
	36	The mode of the new file
	37	is initialized from
	38	.IR mode .
	39	(The protection part of the mode
	40	is modified by the process's mode mask; see
	41	.IR umask (2)).
	42	.PP
	43	The fifo's owner ID is set to the process's effective user ID.
	44	The fifo's group ID is set to that of the parent directory in
	45	which it is created.
	46	.PP
	47	The low-order 9 bits of mode are modified by the process's
	48	file mode creation mask: all bits set in the process's file mode
	49	creation mask are cleared. See
	50	.IR umask (2).
	51	.SH "RETURN VALUE
	52	A 0 return value indicates success. A \-1 return value
	53	indicates an error, and an error code is stored in
	54	.I errno.
	55	.SH "ERRORS
	56	.I Mkfifo
	57	will fail and no fifo will be created if:
	58	.TP 15
	59	[ENOTSUPP]
	60	The kernel has not been configured to support fifo's.
	61	.TP 15
	62	[ENOTDIR]
	63	A component of the path prefix is not a directory.
	64	.TP 15
	65	[EINVAL]
	66	The pathname contains a character with the high-order bit set.
	67	.TP 15
	68	[ENAMETOOLONG]
	69	A component of a pathname exceeded 255 characters,
	70	or an entire path name exceeded 1023 characters.
	71	.TP 15
	72	[ENOENT]
	73	A component of the path prefix does not exist.
	74	.TP 15
	75	[EACCES]
	76	Search permission is denied for a component of the path prefix.
	77	.TP 15
	78	[ELOOP]
	79	Too many symbolic links were encountered in translating the pathname.
	80	.TP 15
	81	[EPERM]
	82	The \fIpath\fP argument contains a byte with the high-order bit set.
	83	.TP 15
	84	[EROFS]
85	The named file resides on a read-only file system.
86	.TP 15
87	[EEXIST]
88	The named file exists.
89	.TP 15
90	[ENOSPC]
91	The directory in which the entry for the new fifo is being placed
92	cannot be extended because there is no space left on the file
93	system containing the directory.
94	.TP 15
95	[ENOSPC]
96	There are no free inodes on the file system on which the
97	fifo is being created.
98	.TP 15
99	[EDQUOT]
100	The directory in which the entry for the new fifo
101	is being placed cannot be extended because the
102	user's quota of disk blocks on the file system
103	containing the directory has been exhausted.
104	.TP 15
105	[EDQUOT]
106	The user's quota of inodes on the file system on
107	which the fifo is being created has been exhausted.
108	.TP 15
109	[EIO]
110	An I/O error occurred while making the directory entry or allocating the inode.
111	.TP 15
112	[EIO]
113	An I/O error occurred while reading from or writing to the file system.
114	.TP 15
115	[EFAULT]
116	.I Path
117	points outside the process's allocated address space.
118	.SH "SEE ALSO"
119	chmod(2), stat(2), umask(2)