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