usr/src/man/man1m/mkfifo.1m

   1 '\" te
   2 .\" Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved
   5 .\" 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/.
   6 .\" 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
   7 .\" are reprinted and reproduced in electronic form in the Sun OS 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
   8 .\" 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.
   9 .\"  This notice shall appear on any product containing this material.
  10 .\" 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.
  11 .\"  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
  12 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  13 .TH MKFIFO 1M "Aug 11, 2009"
  14 .SH NAME
  15 mkfifo \- make FIFO special file
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 \fB/usr/bin/mkfifo\fR [\fB-m\fR \fImode\fR] \fIpath\fR...
  20 .fi
  21
  22 .SS "ksh93"
  23 .LP
  24 .nf
  25 mkfifo [ \fIoptions\fR ] \fIfile\fR...
  26 .fi
  27
  28 .SH DESCRIPTION
  29 .SS "/usr/bin/mkfifo"
  30 .sp
  31 .LP
  32 The \fBmkfifo\fR utility creates the \fBFIFO\fR special files named by its
  33 argument list. The arguments are taken sequentially, in the order specified;
  34 and each \fBFIFO\fR special file is either created completely or, in the case
  35 of an error or signal, not created at all.
  36 .sp
  37 .LP
  38 If errors are encountered in creating one of the special files, \fBmkfifo\fR
  39 writes a diagnostic message to the standard error and continues with the
  40 remaining arguments, if any.
  41 .sp
  42 .LP
  43 The \fBmkfifo\fR utility calls the library routine \fBmkfifo\fR(3C), with the
  44 \fIpath\fR argument is passed as the \fIpath\fR argument from the command line,
  45 and  \fImode\fR is set to the equivalent of \fBa=rw\fR, modified by the current
  46 value of the file mode creation mask \fBumask\fR(1).
  47 .SS "ksh93"
  48 .sp
  49 .LP
  50 The \fBmkfifo\fR utility creates one or more \fBFIFO\fRs. By default, the mode
  51 of the created FIFO is \fBa=rw\fR minus the bits set in \fBumask\fR(1).
  52 .SH OPTIONS
  53 .SS "/usr/bin/ksh93"
  54 .sp
  55 .LP
  56 The following option is supported for \fB/usr/bin/mkfifo\fR:
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fB-m\fR \fImode\fR\fR
  61 .ad
  62 .RS 11n
  63 Set the file permission bits of the newly-created \fBFIFO\fR to the specified
  64 \fImode\fR value. The \fImode\fR option-argument will be the same as the
  65 \fImode\fR operand defined for the \fBchmod\fR(1) command. In
  66 <\fIsymbolic\fRmode> strings, the \fIop\fR characters \fB+\fR and \fB\(mi\fR
  67 will be interpreted relative to an assumed initial mode of \fBa=rw\fR.
  68 .RE
  69
  70 .SS "ksh93"
  71 .sp
  72 .LP
  73 The following option is supported for \fBksh93\fR:
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fB-m\fR \fImode\fR\fR
  78 .ad
  79 .br
  80 .na
  81 \fB\fB--mode=\fR\fImode\fR\fR
  82 .ad
  83 .RS 15n
  84 Set the mode of the created FIFO to \fImode\fR. The \fImode\fR option-argument
  85 is a symbolic or octal mode as in \fBchmod\fR(1). Relative modes assume an
  86 initial mode of \fBa=rw\fR.
  87 .RE
  88
  89 .SH OPERANDS
  90 .sp
  91 .LP
  92 The following operand is supported:
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fIfile\fR\fR
  97 .ad
  98 .RS 8n
  99 A path name of the \fBFIFO\fR special file to be created.
 100 .RE
 101
 102 .SH USAGE
 103 .sp
 104 .LP
 105 See \fBlargefile\fR(5) for the description of the behavior of \fBmkfifo\fR when
 106 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
 107 .SH ENVIRONMENT VARIABLES
 108 .sp
 109 .LP
 110 See \fBenviron\fR(5) for descriptions of the following environment variables
 111 that affect the execution of \fBmkfifo\fR: \fBLANG\fR, \fBLC_ALL\fR,
 112 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 113 .SH EXIT STATUS
 114 .sp
 115 .LP
 116 The following exit values are returned:
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fB0\fR\fR
 121 .ad
 122 .RS 6n
 123 All the specified \fBFIFO\fR special files were created successfully.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fB>0\fR\fR
 130 .ad
 131 .RS 6n
 132 An error occurred.
 133 .RE
 134
 135 .SH ATTRIBUTES
 136 .sp
 137 .LP
 138 See \fBattributes\fR(5) for descriptions of the following attributes:
 139 .sp
 140
 141 .sp
 142 .TS
 143 box;
 144 c | c
 145 l | l .
 146 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 147 _
 148 Interface Stability     Standard
 149 .TE
 150
 151 .SH SEE ALSO
 152 .sp
 153 .LP
 154 \fBchmod\fR(1), \fBumask\fR(1), \fBmkfifo\fR(3C), \fBattributes\fR(5),
 155 \fBenviron\fR(5), \fBlargefile\fR(5), \fBstandards\fR(5)