xref: /openbsd-src/lib/libc/sys/mkdir.2 (revision 2b0358df1d88d06ef4139321dd05bd5e05d91eaf)
1.\"	$OpenBSD: mkdir.2,v 1.9 2007/05/31 19:19:33 jmc Exp $
2.\"	$NetBSD: mkdir.2,v 1.8 1995/02/27 12:34:22 cgd Exp $
3.\"
4.\" Copyright (c) 1983, 1991, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"     @(#)mkdir.2	8.2 (Berkeley) 12/11/93
32.\"
33.Dd $Mdocdate: May 31 2007 $
34.Dt MKDIR 2
35.Os
36.Sh NAME
37.Nm mkdir
38.Nd make a directory file
39.Sh SYNOPSIS
40.Fd #include <sys/types.h>
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
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.
58A \-1 return value indicates 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 Er
64.It Bq Er ENOTDIR
65A component of the path prefix is not a directory.
66.It Bq Er ENAMETOOLONG
67A component of a pathname exceeded
68.Dv {NAME_MAX}
69characters, or an entire path name exceeded
70.Dv {PATH_MAX}
71characters.
72.It Bq Er ENOENT
73A component of the path prefix does not exist.
74.It Bq Er EACCES
75Search permission is denied for a component of the path prefix.
76.It Bq Er ELOOP
77Too many symbolic links were encountered in translating the pathname.
78.It Bq Er EROFS
79The named file resides on a read-only file system.
80.It Bq Er EEXIST
81The named file exists.
82.It Bq Er ENOSPC
83The new directory cannot be created because there is no space left
84on the file system that will contain the directory.
85.It Bq Er ENOSPC
86There are no free inodes on the file system on which the
87directory is being created.
88.It Bq Er EDQUOT
89The new directory cannot be created because the user's
90quota of disk blocks on the file system that will
91contain the directory has been exhausted.
92.It Bq Er EDQUOT
93The user's quota of inodes on the file system on
94which the directory is being created has been exhausted.
95.It Bq Er EIO
96An I/O error occurred while making the directory entry or allocating the inode.
97.It Bq Er EIO
98An I/O error occurred while reading from or writing to the file system.
99.It Bq Er EFAULT
100.Fa path
101points outside the process's allocated address space.
102.El
103.Sh SEE ALSO
104.Xr chmod 2 ,
105.Xr stat 2 ,
106.Xr umask 2
107.Sh STANDARDS
108The
109.Fn mkdir
110function conforms to
111.St -p1003.1-88 .
112