xref: /netbsd/lib/libc/sys/mkdir.2 (revision c4a72b64)
1.\"	$NetBSD: mkdir.2,v 1.17 2002/10/01 18:10:44 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 \*[Lt]sys/stat.h\*[Gt]
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.
62A -1 return value indicates 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
72.Dv {NAME_MAX}
73characters, or an entire path name exceeded
74.Dv {PATH_MAX}
75characters.
76.It Bq Er ENOENT
77A component of the path prefix does not exist.
78.It Bq Er EACCES
79Search permission is denied for a component of the path prefix.
80.It Bq Er ELOOP
81Too many symbolic links were encountered in translating the pathname.
82.It Bq Er EROFS
83The named file resides on a read-only file system.
84.It Bq Er EEXIST
85The named file exists.
86.It Bq Er ENOSPC
87The new directory cannot be created because there is no space left
88on the file system that will contain the directory.
89.It Bq Er ENOSPC
90There are no free inodes on the file system on which the
91directory is being created.
92.It Bq Er EDQUOT
93The new directory cannot be created because the user's
94quota of disk blocks on the file system that will
95contain the directory has been exhausted.
96.It Bq Er EDQUOT
97The user's quota of inodes on the file system on
98which the directory is being created has been exhausted.
99.It Bq Er EIO
100An I/O error occurred while making the directory entry or allocating the inode.
101.It Bq Er EIO
102An I/O error occurred while reading from or writing to the file system.
103.It Bq Er EFAULT
104.Fa path
105points outside the process's allocated address space.
106.El
107.Sh SEE ALSO
108.Xr chmod 2 ,
109.Xr stat 2 ,
110.Xr umask 2
111.Sh STANDARDS
112The
113.Fn mkdir
114function conforms to
115.St -p1003.1-90 .
116