| blob | 7de2d659bbb1070e438746c68ca603d97ee7653c |
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document. The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright 1989 AT&T
44 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved
45 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
46 .\"
47 .TH MKFIFO 8 "Aug 11, 2009"
48 .SH NAME
49 mkfifo \- make FIFO special file
50 .SH SYNOPSIS
51 .LP
52 .nf
53 \fB/usr/bin/mkfifo\fR [\fB-m\fR \fImode\fR] \fIpath\fR...
54 .fi
56 .SS "ksh93"
57 .LP
58 .nf
59 mkfifo [ \fIoptions\fR ] \fIfile\fR...
60 .fi
62 .SH DESCRIPTION
63 .SS "/usr/bin/mkfifo"
64 .sp
65 .LP
66 The \fBmkfifo\fR utility creates the \fBFIFO\fR special files named by its
67 argument list. The arguments are taken sequentially, in the order specified;
68 and each \fBFIFO\fR special file is either created completely or, in the case
69 of an error or signal, not created at all.
70 .sp
71 .LP
72 If errors are encountered in creating one of the special files, \fBmkfifo\fR
73 writes a diagnostic message to the standard error and continues with the
74 remaining arguments, if any.
75 .sp
76 .LP
77 The \fBmkfifo\fR utility calls the library routine \fBmkfifo\fR(3C), with the
78 \fIpath\fR argument is passed as the \fIpath\fR argument from the command line,
79 and \fImode\fR is set to the equivalent of \fBa=rw\fR, modified by the current
80 value of the file mode creation mask \fBumask\fR(1).
81 .SS "ksh93"
82 .sp
83 .LP
84 The \fBmkfifo\fR utility creates one or more \fBFIFO\fRs. By default, the mode
85 of the created FIFO is \fBa=rw\fR minus the bits set in \fBumask\fR(1).
86 .SH OPTIONS
87 .SS "/usr/bin/ksh93"
88 .sp
89 .LP
90 The following option is supported for \fB/usr/bin/mkfifo\fR:
91 .sp
92 .ne 2
93 .na
94 \fB\fB-m\fR \fImode\fR\fR
95 .ad
96 .RS 11n
97 Set the file permission bits of the newly-created \fBFIFO\fR to the specified
98 \fImode\fR value. The \fImode\fR option-argument will be the same as the
99 \fImode\fR operand defined for the \fBchmod\fR(1) command. In
100 <\fIsymbolic\fRmode> strings, the \fIop\fR characters \fB+\fR and \fB\(mi\fR
101 will be interpreted relative to an assumed initial mode of \fBa=rw\fR.
102 .RE
104 .SS "ksh93"
105 .sp
106 .LP
107 The following option is supported for \fBksh93\fR:
108 .sp
109 .ne 2
110 .na
111 \fB\fB-m\fR \fImode\fR\fR
112 .ad
113 .br
114 .na
115 \fB\fB--mode=\fR\fImode\fR\fR
116 .ad
117 .RS 15n
118 Set the mode of the created FIFO to \fImode\fR. The \fImode\fR option-argument
119 is a symbolic or octal mode as in \fBchmod\fR(1). Relative modes assume an
120 initial mode of \fBa=rw\fR.
121 .RE
123 .SH OPERANDS
124 .sp
125 .LP
126 The following operand is supported:
127 .sp
128 .ne 2
129 .na
130 \fB\fIfile\fR\fR
131 .ad
132 .RS 8n
133 A path name of the \fBFIFO\fR special file to be created.
134 .RE
136 .SH ENVIRONMENT VARIABLES
137 .sp
138 .LP
139 See \fBenviron\fR(5) for descriptions of the following environment variables
140 that affect the execution of \fBmkfifo\fR: \fBLANG\fR, \fBLC_ALL\fR,
141 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
142 .SH EXIT STATUS
143 .sp
144 .LP
145 The following exit values are returned:
146 .sp
147 .ne 2
148 .na
149 \fB\fB0\fR\fR
150 .ad
151 .RS 6n
152 All the specified \fBFIFO\fR special files were created successfully.
153 .RE
155 .sp
156 .ne 2
157 .na
158 \fB\fB>0\fR\fR
159 .ad
160 .RS 6n
161 An error occurred.
162 .RE
164 .SH ATTRIBUTES
165 .sp
166 .LP
167 See \fBattributes\fR(5) for descriptions of the following attributes:
168 .sp
170 .sp
171 .TS
172 box;
173 c | c
174 l | l .
175 ATTRIBUTE TYPE ATTRIBUTE VALUE
176 _
177 Interface Stability Standard
178 .TE
180 .SH SEE ALSO
181 .sp
182 .LP
183 \fBchmod\fR(1), \fBumask\fR(1), \fBmkfifo\fR(3C), \fBattributes\fR(5),
184 \fBenviron\fR(5), \fBstandards\fR(5)