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