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

.\" Copyright (c) 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" %sccs.include.redist.man%
.\"
.\"	@(#)mkfifo.2	6.2 (Berkeley) %G%
.\"
.TH MKFIFO 2 ""
.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	.\"
91cff1e1	4	.\" %sccs.include.redist.man%
e1d4f580	5	.\"
91cff1e1	6	.\" @(#)mkfifo.2 6.2 (Berkeley) %G%
e1d4f580 KM	7	.\"
	8	.TH MKFIFO 2 ""
	9	.UC 7
	10	.SH NAME
	11	mkfifo \- make a fifo file
	12	.SH SYNOPSIS
	13	.nf
	14	.ft B
	15	mkfifo(path, mode)
	16	char *path;
	17	int mode;
	18	.fi
	19	.ft R
	20	.SH DESCRIPTION
	21	.I Mkfifo
	22	creates a new fifo file with name
	23	.IR path .
	24	The mode of the new file
	25	is initialized from
	26	.IR mode .
	27	(The protection part of the mode
	28	is modified by the process's mode mask; see
	29	.IR umask (2)).
	30	.PP
	31	The fifo's owner ID is set to the process's effective user ID.
	32	The fifo's group ID is set to that of the parent directory in
	33	which it is created.
	34	.PP
	35	The low-order 9 bits of mode are modified by the process's
	36	file mode creation mask: all bits set in the process's file mode
	37	creation mask are cleared. See
	38	.IR umask (2).
	39	.SH "RETURN VALUE
	40	A 0 return value indicates success. A \-1 return value
	41	indicates an error, and an error code is stored in
	42	.I errno.
	43	.SH "ERRORS
	44	.I Mkfifo
	45	will fail and no fifo will be created if:
	46	.TP 15
	47	[ENOTSUPP]
	48	The kernel has not been configured to support fifo's.
	49	.TP 15
	50	[ENOTDIR]
	51	A component of the path prefix is not a directory.
	52	.TP 15
	53	[EINVAL]
	54	The pathname contains a character with the high-order bit set.
	55	.TP 15
	56	[ENAMETOOLONG]
	57	A component of a pathname exceeded 255 characters,
	58	or an entire path name exceeded 1023 characters.
	59	.TP 15
	60	[ENOENT]
	61	A component of the path prefix does not exist.
	62	.TP 15
	63	[EACCES]
	64	Search permission is denied for a component of the path prefix.
	65	.TP 15
	66	[ELOOP]
	67	Too many symbolic links were encountered in translating the pathname.
	68	.TP 15
	69	[EPERM]
	70	The \fIpath\fP argument contains a byte with the high-order bit set.
71	.TP 15
72	[EROFS]
73	The named file resides on a read-only file system.
74	.TP 15
75	[EEXIST]
76	The named file exists.
77	.TP 15
78	[ENOSPC]
79	The directory in which the entry for the new fifo is being placed
80	cannot be extended because there is no space left on the file
81	system containing the directory.
82	.TP 15
83	[ENOSPC]
84	There are no free inodes on the file system on which the
85	fifo is being created.
86	.TP 15
87	[EDQUOT]
88	The directory in which the entry for the new fifo
89	is being placed cannot be extended because the
90	user's quota of disk blocks on the file system
91	containing the directory has been exhausted.
92	.TP 15
93	[EDQUOT]
94	The user's quota of inodes on the file system on
95	which the fifo is being created has been exhausted.
96	.TP 15
97	[EIO]
98	An I/O error occurred while making the directory entry or allocating the inode.
99	.TP 15
100	[EIO]
101	An I/O error occurred while reading from or writing to the file system.
102	.TP 15
103	[EFAULT]
104	.I Path
105	points outside the process's allocated address space.
106	.SH "SEE ALSO"
107	chmod(2), stat(2), umask(2)