file_cmds-321.100.10.0.1.tar.gz
[apple/file_cmds.git] / mkfifo / mkfifo.1
1 .\"     $NetBSD: mkfifo.1,v 1.6 1997/10/19 05:11:52 lukem Exp $
2 .\"
3 .\" Copyright (c) 1990, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to Berkeley by
7 .\" the Institute of Electrical and Electronics Engineers, Inc.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\" 3. All advertising materials mentioning features or use of this software
18 .\"    must display the following acknowledgement:
19 .\"     This product includes software developed by the University of
20 .\"     California, Berkeley and its contributors.
21 .\" 4. Neither the name of the University nor the names of its contributors
22 .\"    may be used to endorse or promote products derived from this software
23 .\"    without specific prior written permission.
24 .\"
25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .\" SUCH DAMAGE.
36 .\"
37 .\"     @(#)mkfifo.1    8.2 (Berkeley) 1/5/94
38 .\"
39 .Dd January 5, 1994
40 .Dt MKFIFO 1
41 .Os BSD 4.4
42 .Sh NAME
43 .Nm mkfifo
44 .Nd make fifos
45 .Sh SYNOPSIS
46 .Nm mkfifo
47 .Op Fl m Ar mode
48 .Ar fifo_name  ...
49 .Sh DESCRIPTION
50 .Nm mkfifo
51 creates the fifos requested, in the order specified.
52 By default,
53 the resulting fifos have mode
54 .Li \&0666
55 (rw-rw-rw-), limited by the current
56 .Xr umask 2 .
57 .Pp
58 The options are as follows:
59 .Bl -tag -width Ds
60 .It Fl m
61 Set the file permission bits of newly-created fifos to
62 .Ar mode ,
63 without respect to the current umask.
64 .Pp
65 The mode is specified as in 
66 .Xr chmod 1 .
67 In symbolic mode strings, the 
68 .Dq + 
69 and 
70 .Dq -
71 operators are interpreted relative to an assumed initial mode of 
72 .Dq a=rw
73 .El
74 .Pp
75 .Nm mkfifo
76 requires write permission in the parent directory.
77 .Pp
78 .Nm mkfifo
79 exits with 0 if successful, and with >0 if an error occurred.
80 .Sh LEGACY DESCRIPTION
81 In legacy mode, the fifo's file permission bits
82 are always limited by the current umask.
83 .Pp
84 For more information about legacy mode, see
85 .Xr compat 5 .
86 .Sh SEE ALSO
87 .Xr mkdir 1 ,
88 .Xr rm 1 ,
89 .Xr umask 1 ,
90 .Xr mkfifo 2 ,
91 .Xr umask 2 ,
92 .Xr compat 5 ,
93 .Xr mknod 8
94 .Sh STANDARDS
95 The
96 .Nm mkfifo
97 utility is expected to be
98 .St -p1003.2-92
99 compliant.
100 .Sh HISTORY
101 .Nm mkfifo
102 command appeared in
103 .Bx 4.4 .