[apple/xnu.git] / bsd / man / man2 / mknod.2

.\"	$NetBSD: mknod.2,v 1.6 1995/02/27 12:34:33 cgd Exp $
.\"
.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" 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.
.\"
.\"     @(#)mknod.2	8.1 (Berkeley) 6/4/93
.\"
.Dd June 4, 1993
.Dt MKNOD 2
.Os BSD 4
.Sh NAME
.Nm mknod
.Nd make a special file node
.Sh SYNOPSIS
.Fd #include <unistd.h>
.Ft int
.Fn mknod "const char *path" "mode_t mode" "dev_t dev"
.Sh DESCRIPTION
The device special file
.Fa path
is created with the major and minor
device numbers extracted from
.Fa mode.
The access permissions of
.Fa path
are descendant from the
.Xr umask 2
of the parent process.
.Pp
If
.Fa mode
indicates a block or character special file,
.Fa dev
is a configuration dependent specification of a character or block
I/O device and the superblock of the device.  If
.Fa mode
does not indicate a block special or character special device,
.Fa dev
is ignored.
.Pp
.Fn Mknod
requires super-user privileges.
.Sh RETURN VALUES
Upon successful completion a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn Mknod
will fail and the file will be not created if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG
A component of a pathname exceeded 
.Dv {NAME_MAX}
characters, or an entire path name exceeded 
.Dv {PATH_MAX}
characters.
.It Bq Er ENOENT
A component of the path prefix does not exist.
.It Bq Er EACCES
Search permission is denied for a component of the path prefix.
.It Bq Er ELOOP
Too many symbolic links were encountered in translating the pathname.
.It Bq Er EPERM
The process's effective user ID is not super-user.
.It Bq Er EIO
An I/O error occurred while making the directory entry or allocating the inode.
.It Bq Er ENOSPC
The directory in which the entry for the new node is being placed
cannot be extended because there is no space left on the file
system containing the directory.
.It Bq Er ENOSPC
There are no free inodes on the file system on which the
node is being created.
.It Bq Er EDQUOT
The directory in which the entry for the new node
is being placed cannot be extended because the
user's quota of disk blocks on the file system
containing the directory has been exhausted.
.It Bq Er EDQUOT
The user's quota of inodes on the file system on
which the node is being created has been exhausted.
.It Bq Er EROFS
The named file resides on a read-only file system.
.It Bq Er EEXIST
The named file exists.
.It Bq Er EFAULT
.Fa Path
points outside the process's allocated address space.
.El
.Sh SEE ALSO
.Xr chmod 2 ,
.Xr stat 2 ,
.Xr umask 2
.Sh HISTORY
A
.Fn mknod
function call appeared in 
.At v6 .
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: mknod.2,v 1.6 1995/02/27 12:34:33 cgd Exp $
	2	.\"
	3	.\" Copyright (c) 1980, 1991, 1993
	4	.\" The Regents of the University of California. All rights reserved.
	5	.\"
	6	.\" Redistribution and use in source and binary forms, with or without
	7	.\" modification, are permitted provided that the following conditions
	8	.\" are met:
	9	.\" 1. Redistributions of source code must retain the above copyright
	10	.\" notice, this list of conditions and the following disclaimer.
	11	.\" 2. Redistributions in binary form must reproduce the above copyright
	12	.\" notice, this list of conditions and the following disclaimer in the
	13	.\" documentation and/or other materials provided with the distribution.
	14	.\" 3. All advertising materials mentioning features or use of this software
	15	.\" must display the following acknowledgement:
	16	.\" This product includes software developed by the University of
	17	.\" California, Berkeley and its contributors.
	18	.\" 4. Neither the name of the University nor the names of its contributors
	19	.\" may be used to endorse or promote products derived from this software
	20	.\" without specific prior written permission.
	21	.\"
	22	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	23	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	26	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	27	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	28	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	29	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	30	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	31	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	32	.\" SUCH DAMAGE.
	33	.\"
	34	.\" @(#)mknod.2 8.1 (Berkeley) 6/4/93
	35	.\"
	36	.Dd June 4, 1993
	37	.Dt MKNOD 2
	38	.Os BSD 4
	39	.Sh NAME
	40	.Nm mknod
	41	.Nd make a special file node
	42	.Sh SYNOPSIS
	43	.Fd #include <unistd.h>
	44	.Ft int
	45	.Fn mknod "const char *path" "mode_t mode" "dev_t dev"
	46	.Sh DESCRIPTION
	47	The device special file
	48	.Fa path
	49	is created with the major and minor
	50	device numbers extracted from
	51	.Fa mode.
	52	The access permissions of
	53	.Fa path
	54	are descendant from the
	55	.Xr umask 2
	56	of the parent process.
	57	.Pp
	58	If
	59	.Fa mode
	60	indicates a block or character special file,
	61	.Fa dev
	62	is a configuration dependent specification of a character or block
	63	I/O device and the superblock of the device. If
	64	.Fa mode
65	does not indicate a block special or character special device,
66	.Fa dev
67	is ignored.
68	.Pp
69	.Fn Mknod
70	requires super-user privileges.
71	.Sh RETURN VALUES
72	Upon successful completion a value of 0 is returned.
73	Otherwise, a value of -1 is returned and
74	.Va errno
75	is set to indicate the error.
76	.Sh ERRORS
77	.Fn Mknod
78	will fail and the file will be not created if:
79	.Bl -tag -width Er
80	.It Bq Er ENOTDIR
81	A component of the path prefix is not a directory.
82	.It Bq Er ENAMETOOLONG
83	A component of a pathname exceeded
84	.Dv {NAME_MAX}
85	characters, or an entire path name exceeded
86	.Dv {PATH_MAX}
87	characters.
88	.It Bq Er ENOENT
89	A component of the path prefix does not exist.
90	.It Bq Er EACCES
91	Search permission is denied for a component of the path prefix.
92	.It Bq Er ELOOP
93	Too many symbolic links were encountered in translating the pathname.
94	.It Bq Er EPERM
95	The process's effective user ID is not super-user.
96	.It Bq Er EIO
97	An I/O error occurred while making the directory entry or allocating the inode.
98	.It Bq Er ENOSPC
99	The directory in which the entry for the new node is being placed
100	cannot be extended because there is no space left on the file
101	system containing the directory.
102	.It Bq Er ENOSPC
103	There are no free inodes on the file system on which the
104	node is being created.
105	.It Bq Er EDQUOT
106	The directory in which the entry for the new node
107	is being placed cannot be extended because the
108	user's quota of disk blocks on the file system
109	containing the directory has been exhausted.
110	.It Bq Er EDQUOT
111	The user's quota of inodes on the file system on
112	which the node is being created has been exhausted.
113	.It Bq Er EROFS
114	The named file resides on a read-only file system.
115	.It Bq Er EEXIST
116	The named file exists.
117	.It Bq Er EFAULT
118	.Fa Path
119	points outside the process's allocated address space.
120	.El
121	.Sh SEE ALSO
122	.Xr chmod 2 ,
123	.Xr stat 2 ,
124	.Xr umask 2
125	.Sh HISTORY
126	A
127	.Fn mknod
128	function call appeared in
129	.At v6 .