xref: /freebsd-14.2/lib/libc/sys/mkdir.2 (revision fffcbbcd)
1.\" Copyright (c) 1983, 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.\"     @(#)mkdir.2	8.2 (Berkeley) 12/11/93
33.\" $FreeBSD$
34.\"
35.Dd December 11, 1993
36.Dt MKDIR 2
37.Os
38.Sh NAME
39.Nm mkdir
40.Nd make a directory file
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.Fd #include <sys/types.h>
45.Fd #include <sys/stat.h>
46.Ft int
47.Fn mkdir "const char *path" "mode_t mode"
48.Sh DESCRIPTION
49The directory
50.Fa path
51is created with the access permissions specified by
52.Fa mode
53and restricted by the
54.Xr umask 2
55of the calling process.
56.Pp
57The directory's owner ID is set to the process's effective user ID.
58The directory's group ID is set to that of the parent directory in
59which it is created.
60.Sh RETURN VALUES
61A 0 return value indicates success.  A -1 return value
62indicates an error, and an error code is stored in
63.Va errno .
64.Sh ERRORS
65.Fn Mkdir
66will fail and no directory will be created if:
67.Bl -tag -width Er
68.It Bq Er ENOTDIR
69A component of the path prefix is not a directory.
70.It Bq Er ENAMETOOLONG
71A component of a pathname exceeded 255 characters,
72or an entire path name exceeded 1023 characters.
73.It Bq Er ENOENT
74A component of the path prefix does not exist.
75.It Bq Er EACCES
76Search permission is denied for a component of the path prefix,
77or write permission is denied
78on the parent directory of the directory to be created.
79.It Bq Er ELOOP
80Too many symbolic links were encountered in translating the pathname.
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 new directory cannot be created because there is no space left
87on the file system that will contain the directory.
88.It Bq Er ENOSPC
89There are no free inodes on the file system on which the
90directory is being created.
91.It Bq Er EDQUOT
92The new directory cannot be created because the user's
93quota of disk blocks on the file system that will
94contain the directory has been exhausted.
95.It Bq Er EDQUOT
96The user's quota of inodes on the file system on
97which the directory is being created has been exhausted.
98.It Bq Er EIO
99An I/O error occurred while making the directory entry or allocating the inode.
100.It Bq Er EIO
101An I/O error occurred while reading from or writing to the file system.
102.It Bq Er EFAULT
103.Fa Path
104points outside the process's allocated address space.
105.El
106.Sh SEE ALSO
107.Xr chmod 2 ,
108.Xr stat 2 ,
109.Xr umask 2
110.Sh STANDARDS
111The
112.Fn mkdir
113function call is expected to conform to
114.St -p1003.1-90 .
115