BSD 4_3_Net_2 release

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

diff --git a/usr/src/lib/libc/sys/mkfifo.2 b/usr/src/lib/libc/sys/mkfifo.2
index d504ad8..6c4f0f5 100644 (file)
--- a/usr/src/lib/libc/sys/mkfifo.2
+++ b/usr/src/lib/libc/sys/mkfifo.2
@@ -1,119 +1,124 @@
-.\" Copyright (c) 1990 The Regents of the University of California.
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" 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.
+.\" 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.

 .\"
 .\"

-.\"    @(#)mkfifo.2    6.2 (Berkeley) 6/23/90
+.\" 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.

 .\"
 .\"

-.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
+.\"    @(#)mkfifo.2    6.4 (Berkeley) 7/23/91
+.\"
+.Dd July 23, 1991
+.Dt MKFIFO 2
+.Os
+.Sh NAME
+.Nm mkfifo
+.Nd make a fifo file
+.Sh SYNOPSIS
+.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
 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
+.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.
 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
+.Sh RETURN VALUES
+A 0 return value indicates success.  A -1 return value

 indicates an error, and an error code is stored in
 indicates an error, and an error code is stored in

-.I errno.
-.SH "ERRORS
-.I Mkfifo
+.Va errno .
+.Sh ERRORS
+.Fn Mkfifo

 will fail and no fifo will be created if:
 will fail and no fifo will be created if:

-.TP 15
-[ENOTSUPP]
+.Bl -tag -width ENAMETOOLO
+.It Bq Er ENOTSUPP

 The kernel has not been configured to support fifo's.
 The kernel has not been configured to support fifo's.

-.TP 15
-[ENOTDIR]
+.It Bq Er ENOTDIR

 A component of the path prefix is not a directory.
 A component of the path prefix is not a directory.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 The pathname contains a character with the high-order bit set.
 The pathname contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.
 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 A component of the path prefix does not exist.
 A component of the path prefix does not exist.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 Search permission is denied for a component of the path prefix.
 Search permission is denied for a component of the path prefix.

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 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]
+.It Bq Er EPERM
+The
+.Fa path
+argument contains a byte with the high-order bit set.
+.It Bq Er EROFS

 The named file resides on a read-only file system.
 The named file resides on a read-only file system.

-.TP 15
-[EEXIST]
+.It Bq Er EEXIST

 The named file exists.
 The named file exists.

-.TP 15
-[ENOSPC]
+.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.
 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]
+.It Bq Er ENOSPC

 There are no free inodes on the file system on which the
 fifo is being created.
 There are no free inodes on the file system on which the
 fifo is being created.

-.TP 15
-[EDQUOT]
+.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.
 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]
+.It Bq Er EDQUOT

 The user's quota of inodes on the file system on
 which the fifo is being created has been exhausted.
 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
+.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.
 points outside the process's allocated address space.

-.SH "SEE ALSO"
-chmod(2), stat(2), umask(2)
+.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 .