xref: /illumos-gate/usr/src/man/man8/mkfifo.8 (revision bbf21555)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1989 AT&T
Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved

MKFIFO 8 "Jun 24, 2020"
NAME
mkfifo - make FIFO special file
SYNOPSIS
/usr/bin/mkfifo [-m mode] file...
"ksh93"
mkfifo [ options ] file...
DESCRIPTION
The mkfifo utility creates the FIFO special files named by its argument list. The arguments are taken sequentially, in the order specified; and each FIFO special file is either created completely or, in the case of an error or signal, not created at all.

If errors are encountered in creating one of the special files, mkfifo writes a diagnostic message to standard error and continues with the remaining arguments, if any.

The mkfifo utility calls the library routine mkfifo(3C), with a path argument equivalent to the file argument from the command line, and mode is set to the equivalent of a=rw, modified by the current value of the file mode creation mask umask(1).

"ksh93"
The mkfifo utility creates one or more FIFOs. By default, the mode of the created FIFO is a=rw minus the bits set in umask(1).
OPTIONS
The following option is supported for /usr/bin/mkfifo: -m mode

Set the file permission bits of the newly-created FIFO to the specified mode value. The mode option-argument will be the same as the mode operand defined for the chmod(1) command. For a symbolic mode option-argument, the op characters + and - will be interpreted relative to an assumed initial mode of a=rw.

"ksh93"
The following option is supported for ksh93: -m mode

--mode=mode

Set the mode of the created FIFO to mode. The mode option-argument is a symbolic or octal mode as in chmod(1). Relative modes assume an initial mode of a=rw.

OPERANDS
The following operand is supported: file

A path name of the FIFO special file to be created.

USAGE
See largefile(7) for the description of the behavior of mkfifo when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
ENVIRONMENT VARIABLES
See environ(7) for descriptions of the following environment variables that affect the execution of mkfifo: LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH.
EXIT STATUS
The following exit values are returned: 0

All the specified FIFO special files were created successfully.

>0

An error occurred.

ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO
chmod (1), umask (1), mkfifo (3C), attributes (7), environ (7), largefile (7), standards (7)