bsd/man/man2/mkdir.2

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