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