Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[dragonfly.git] / usr.bin / mkfifo / mkfifo.1
1 .\" Copyright (c) 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the Institute of Electrical and Electronics Engineers, Inc.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. Neither the name of the University nor the names of its contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"    without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\"     @(#)mkfifo.1    8.2 (Berkeley) 1/5/94
32 .\" $FreeBSD: src/usr.bin/mkfifo/mkfifo.1,v 1.6.2.4 2002/06/21 15:28:15 charnier Exp $
33 .\" $DragonFly: src/usr.bin/mkfifo/mkfifo.1,v 1.3 2006/02/17 19:39:09 swildner Exp $
34 .\"
35 .Dd January 5, 1994
36 .Dt MKFIFO 1
37 .Os
38 .Sh NAME
39 .Nm mkfifo
40 .Nd make fifos
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl m Ar mode
44 .Ar fifo_name  ...
45 .Sh DESCRIPTION
46 The
47 .Nm
48 utility creates the fifos requested, in the order specified.
49 .Pp
50 The options are as follows:
51 .Bl -tag -width indent
52 .It Fl m
53 Set the file permission bits of the created fifos to the
54 specified mode, ignoring the
55 .Xr umask 2
56 of the calling process.
57 The mode argument takes any format that can be specified to the
58 .Xr chmod 1
59 command.
60 If a symbolic mode is specified, the op symbols
61 .Dq +
62 (plus) and
63 .Dq -
64 (hyphen) are interpreted relative to an assumed initial mode of
65 .Dq a=rw
66 (read and write permissions for all).
67 .El
68 .Pp
69 If the
70 .Fl m
71 option is not specified, fifos are created with mode
72 .Li \&0666
73 modified by the
74 .Xr umask 2
75 of the calling process.
76 The
77 .Nm
78 utility requires write permission in the parent directory.
79 .Sh EXIT STATUS
80 .Ex -std
81 .Sh SEE ALSO
82 .Xr mkdir 1 ,
83 .Xr rm 1 ,
84 .Xr mkfifo 2 ,
85 .Xr mknod 2
86 .Sh STANDARDS
87 The
88 .Nm
89 utility is expected to be
90 .St -p1003.2
91 compliant.
92 .Sh HISTORY
93 The
94 .Nm
95 command appeared in
96 .Bx 4.4 .