xref: /386bsd/usr/src/lib/libc/sys/mkdir.2 (revision a2142627)
1.\" Copyright (c) 1983, 1991 The Regents of the University of California.
2.\" 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.\"     @(#)mkdir.2	6.7 (Berkeley) 3/10/91
33.\"
34.Dd March 10, 1991
35.Dt MKDIR 2
36.Os BSD 4.2
37.Sh NAME
38.Nm mkdir
39.Nd make a directory file
40.Sh SYNOPSIS
41.Fd #include <sys/stat.h>
42.Ft int
43.Fn mkdir "const char *path" "mode_t mode"
44.Sh DESCRIPTION
45The directory
46.Fa path
47is created with the access permissions specified by
48.Fa mode
49and restricted by the the
50.Xr umask 2
51of the calling process.
52.Pp
53The directory's owner ID is set to the process's effective user ID.
54The directory's group ID is set to that of the parent directory in
55which it is created.
56.Sh RETURN VALUES
57A 0 return value indicates success.  A -1 return value
58indicates an error, and an error code is stored in
59.Va errno .
60.Sh ERRORS
61.Fn Mkdir
62will fail and no directory will be created if:
63.Bl -tag -width ENAMETOOLO
64.It Bq Er ENOTDIR
65A component of the path prefix is not a directory.
66.It Bq Er EINVAL
67The pathname contains a character with the high-order bit set.
68.It Bq Er ENAMETOOLONG
69A component of a pathname exceeded 255 characters,
70or an entire path name exceeded 1023 characters.
71.It Bq Er ENOENT
72A component of the path prefix does not exist.
73.It Bq Er EACCES
74Search permission is denied for a component of the path prefix.
75.It Bq Er ELOOP
76Too many symbolic links were encountered in translating the pathname.
77.It Bq Er EPERM
78The
79.Fa path
80argument contains a byte with the high-order bit set.
81.It Bq Er EROFS
82The named file resides on a read-only file system.
83.It Bq Er EEXIST
84The named file exists.
85.It Bq Er ENOSPC
86The directory in which the entry for the new directory is being placed
87cannot be extended because there is no space left on the file
88system containing the directory.
89.It Bq Er ENOSPC
90The new directory cannot be created because there
91there is no space left on the file
92system that will contain the directory.
93.It Bq Er ENOSPC
94There are no free inodes on the file system on which the
95directory is being created.
96.It Bq Er EDQUOT
97The directory in which the entry for the new directory
98is being placed cannot be extended because the
99user's quota of disk blocks on the file system
100containing the directory has been exhausted.
101.It Bq Er EDQUOT
102The new directory cannot be created because the user's
103quota of disk blocks on the file system that will
104contain the directory has been exhausted.
105.It Bq Er EDQUOT
106The user's quota of inodes on the file system on
107which the directory is being created has been exhausted.
108.It Bq Er EIO
109An I/O error occurred while making the directory entry or allocating the inode.
110.It Bq Er EIO
111An I/O error occurred while reading from or writing to the file system.
112.It Bq Er EFAULT
113.Fa Path
114points outside the process's allocated address space.
115.El
116.Sh SEE ALSO
117.Xr chmod 2 ,
118.Xr stat 2 ,
119.Xr umask 2
120.Sh STANDARDS
121.Fn Mkdir
122conforms to IEEE Std 1003.1-1988
123.Pq Dq Tn POSIX .
124