]> git.saurik.com Git - apple/xnu.git/blame - bsd/man/man2/mknod.2
xnu-1228.7.58.tar.gz
[apple/xnu.git] / bsd / man / man2 / mknod.2
CommitLineData
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
2d21ac55 43.Fd #include <sys/stat.h>
9bccf70c 44.Ft int
2d21ac55
A
45.Fo mknod
46.Fa "const char *path"
47.Fa "mode_t mode"
48.Fa "dev_t dev"
49.Fc
9bccf70c
A
50.Sh DESCRIPTION
51The device special file
52.Fa path
53is created with the major and minor
54device numbers extracted from
2d21ac55 55.Fa mode .
9bccf70c
A
56The access permissions of
57.Fa path
2d21ac55 58are constrained by the
9bccf70c
A
59.Xr umask 2
60of the parent process.
61.Pp
62If
63.Fa mode
64indicates a block or character special file,
65.Fa dev
2d21ac55 66is a configuration-dependent specification of a character or block
9bccf70c
A
67I/O device and the superblock of the device. If
68.Fa mode
69does not indicate a block special or character special device,
70.Fa dev
71is ignored.
72.Pp
73.Fn Mknod
74requires super-user privileges.
75.Sh RETURN VALUES
2d21ac55 76Upon successful completion, a value of 0 is returned.
9bccf70c
A
77Otherwise, a value of -1 is returned and
78.Va errno
79is set to indicate the error.
80.Sh ERRORS
81.Fn Mknod
82will fail and the file will be not created if:
83.Bl -tag -width Er
2d21ac55 84.\" ==========
9bccf70c
A
85.It Bq Er EACCES
86Search permission is denied for a component of the path prefix.
2d21ac55
A
87.\" ==========
88.It Bq Er EACCES
89Write permission is denied for the parent directory.
90.\" ==========
9bccf70c
A
91.It Bq Er EDQUOT
92The directory in which the entry for the new node
2d21ac55
A
93is being placed cannot be extended;
94the user's quota of disk blocks on the file system
9bccf70c 95containing the directory has been exhausted.
2d21ac55 96.\" ==========
9bccf70c 97.It Bq Er EDQUOT
2d21ac55
A
98The user's quota of inodes for the file system
99on which the node is being created has been exhausted.
100.\" ==========
9bccf70c
A
101.It Bq Er EEXIST
102The named file exists.
2d21ac55 103.\" ==========
9bccf70c
A
104.It Bq Er EFAULT
105.Fa Path
106points outside the process's allocated address space.
2d21ac55
A
107.\" ==========
108.It Bq Er EINVAL
109One or more of the arguments is invalid.
110.\" ==========
111.It Bq Er EIO
112An I/O error occurs while making the directory entry
113or allocating the inode.
114.\" ==========
115.It Bq Er ELOOP
116Too many symbolic links were encountered in translating the pathname.
117This is taken to be indicative of a looping symbolic link.
118.\" ==========
119.It Bq Er ENAMETOOLONG
120A component of a pathname exceeds
121.Dv {NAME_MAX}
122characters or an entire path name exceeds
123.Dv {PATH_MAX}
124characters.
125.\" ==========
126.It Bq Er ENOENT
127A component of the path prefix does not exist
128or path is an empty string.
129.\" ==========
130.It Bq Er ENOSPC
131The directory in which the entry for the new node is being placed
132cannot be extended,
133because there is no space left on the file system containing the directory.
134.\" ==========
135.It Bq Er ENOSPC
136There are no free inodes on the file system
137on which the node is being created.
138.\" ==========
139.It Bq Er ENOTDIR
140A component of the path prefix is not a directory.
141.\" ==========
142.It Bq Er EPERM
143The process's effective user ID is not super-user.
144.\" ==========
145.It Bq Er EROFS
146The created node would reside on a read-only file system.
9bccf70c 147.El
2d21ac55
A
148.Sh LEGACY SYNOPSIS
149.Fd #include <unistd.h>
150.Pp
151The include file has changed.
9bccf70c
A
152.Sh SEE ALSO
153.Xr chmod 2 ,
154.Xr stat 2 ,
2d21ac55
A
155.Xr umask 2 ,
156.Xr compat 5
9bccf70c
A
157.Sh HISTORY
158A
159.Fn mknod
160function call appeared in
161.At v6 .