1.\" $NetBSD: mkdir.2,v 1.8 1995/02/27 12:34:22 cgd 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 BSD 4.2 39.Sh NAME 40.Nm mkdir , 41.Nm mkdirat 42.Nd make a directory file 43.Sh SYNOPSIS 44.Fd #include <sys/stat.h> 45.Ft int 46.Fo mkdir 47.Fa "const char *path" 48.Fa "mode_t mode" 49.Fc 50.Ft int 51.Fn mkdirat "int fd" "const char *path" "mode_t mode" 52.Sh DESCRIPTION 53The directory 54.Fa path 55is created with the access permissions specified by 56.Fa mode 57and restricted by the 58.Xr umask 2 59of the calling process. See 60.Xr chmod 2 61for the possible permission bit masks for 62.Fa mode . 63.Pp 64The directory's owner ID is set to the process's effective user ID. 65The directory's group ID is set to that of the parent directory in 66which it is created. 67.Pp 68Note: the behavior of 69.Fn mkdir 70is undefined when mode bits other than the low 9 bits are used. Use 71.Xr chmod 2 72after 73.Fn mkdir 74to explicitly set the other bits (See example below). 75.Pp 76The 77.Fn mkdirat 78system call is equivalent to 79.Fn mkdir 80except in the case where 81.Fa path 82specifies a relative path. 83In this case the newly created directory is created relative to the 84directory associated with the file descriptor 85.Fa fd 86instead of the current working directory. 87If 88.Fn mkdirat 89is passed the special value 90.Dv AT_FDCWD 91in the 92.Fa fd 93parameter, the current working directory is used and the behavior is 94identical to a call to 95.Fn mkdir . 96.Sh RETURN VALUES 97A 0 return value indicates success. A -1 return value 98indicates an error, and an error code is stored in 99.Va errno . 100.Sh ERRORS 101.Fn mkdir 102will fail and no directory will be created if: 103.Bl -tag -width Er 104.\" ========== 105.It Bq Er EACCES 106Search permission is denied for a component of the path prefix. 107.\" ========== 108.It Bq Er EACCES 109Write permission is denied for the parent directory. 110.\" ========== 111.It Bq Er EDQUOT 112The new directory cannot be created because the user's 113quota of disk blocks on the file system that will 114contain the directory has been exhausted. 115.\" ========== 116.It Bq Er EDQUOT 117The user's quota of inodes on the file system on 118which the directory is being created has been exhausted. 119.\" ========== 120.It Bq Er EEXIST 121The named file exists. 122.\" ========== 123.It Bq Er EFAULT 124.Fa Path 125points outside the process's allocated address space. 126.\" ========== 127.It Bq Er EIO 128An I/O error occurred while making the directory entry 129or allocating the inode. 130.\" ========== 131.It Bq Er EIO 132An I/O error occurred while reading from or writing to the file system. 133.\" ========== 134.It Bq Er EISDIR 135The named file is the root directory. 136.\" ========== 137.It Bq Er ELOOP 138Too many symbolic links were encountered in translating the pathname. 139This is taken to be indicative of a looping symbolic link. 140.\" ========== 141.It Bq Er EMLINK 142The parent directory already has {LINK_MAX} links. 143.\" ========== 144.It Bq Er ENAMETOOLONG 145A component of a pathname exceeded 146.Dv {NAME_MAX} 147characters, or an entire path name exceeded 148.Dv {PATH_MAX} 149characters. 150.\" ========== 151.It Bq Er ENOENT 152A component of the path prefix does not exist 153or path is an empty string. 154.It Bq Er ENOSPC 155The new directory cannot be created because there is no space left 156on the file system that would contain it. 157.\" ========== 158.It Bq Er ENOSPC 159There are no free inodes on the file system on which the 160directory is being created. 161.\" ========== 162.It Bq Er ENOTDIR 163A component of the path prefix is not a directory. 164.\" ========== 165.It Bq Er EROFS 166The parent directory resides on a read-only file system. 167.El 168.Pp 169In addition to the errors returned by the 170.Fn mkdir , 171the 172.Fn mkdirat 173function may fail if: 174.Bl -tag -width Er 175.It Bq Er EBADF 176The 177.Fa path 178argument does not specify an absolute path and the 179.Fa fd 180argument is neither 181.Dv AT_FDCWD 182nor a valid file descriptor open for searching. 183.It Bq Er ENOTDIR 184The 185.Fa path 186argument is not an absolute path and 187.Fa fd 188is neither 189.Dv AT_FDCWD 190nor a file descriptor associated with a directory. 191.It Bq Er EILSEQ 192The filename does not match the encoding rules. 193.El 194.Sh EXAMPLE 195.Bd -literal -offset indent 196 197int main (int argc, const char * argv[]) 198{ 199 /* The behavior of mkdir is undefined for anything other than the "permission" bits */ 200 if (mkdir("/tmp/blah", 0777)) 201 perror("/tmp/blah"); 202 203 /* So we need to set the sticky/executable bits explicitly with chmod after calling mkdir */ 204 if (chmod("/tmp/blah", 07777)) 205 perror("/tmp/blah"); 206} 207 208.Ed 209.Sh LEGACY SYNOPSIS 210.Fd #include <sys/types.h> 211.Fd #include <sys/stat.h> 212.Pp 213The include file 214.In sys/types.h 215is necessary. 216.Sh SEE ALSO 217.Xr chmod 2 , 218.Xr stat 2 , 219.Xr umask 2 , 220.Xr compat 5 221.Sh STANDARDS 222The 223.Fn mkdir 224function conforms to 225.St -p1003.1-88 . 226The 227.Fn mkdirat 228system call is expected to conform to POSIX.1-2008 . 229.Sh HISTORY 230The 231.Fn mkdirat 232system call appeared in OS X 10.10 233