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