[apple/file_cmds.git] / mkfifo / mkfifo.1

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