usr/src/man/man2/mkdir.2

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 2016 Joyent, Inc.
   4 .\" Copyright 1989 AT&T
   5 .\" Portions Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   6 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   7 .\" http://www.opengroup.org/bookstore/.
   8 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   9 .\"  This notice shall appear on any product containing this material.
  10 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  11 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  12 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  13 .TH MKDIR 2 "Sep 24, 2016"
  14 .SH NAME
  15 mkdir, mkdirat \- make a directory
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 #include <sys/types.h>
  20 #include <sys/stat.h>
  21
  22 \fBint\fR \fBmkdir\fR(\fBconst char *\fR\fIpath\fR, \fBmode_t\fR \fImode\fR);
  23 .fi
  24 .LP
  25 .nf
  26 \fBint\fR \fBmkdirat\fR(\fBint\fR \fIfd\fR, \fBconst char *\fR\fIpath\fR, \fBmode_t\fR \fImode\fR);
  27 .fi
  28
  29 .SH DESCRIPTION
  30 .LP
  31 The \fBmkdir()\fR and \fBmkdirat()\fR functions create a new directory named by
  32 the path name pointed to by \fIpath\fR. The mode of the new directory is
  33 initialized from \fImode\fR (see \fBchmod\fR(2) for values of mode). The
  34 protection part of the \fImode\fR argument is modified by the process's file
  35 creation mask (see \fBumask\fR(2)).
  36 .sp
  37 .LP
  38 The directory's owner \fBID\fR is set to the process's effective user ID. The
  39 directory's group \fBID\fR is set to the process's effective group ID, or if
  40 the \fBS_ISGID\fR bit is set in the parent directory, then the group \fBID\fR
  41 of the directory is inherited from the parent.  The \fBS_ISGID\fR bit of the
  42 new directory is inherited from the parent directory.
  43 .sp
  44 .LP
  45 If \fIpath\fR names a symbolic link, \fBmkdir()\fR and \fBmkdirat()\fR fail and
  46 set errno to \fBEEXIST\fR.
  47 .sp
  48 .LP
  49 The newly created directory is empty with the exception of entries for itself
  50 (\fB\&.\fR) and its parent directory (\fB\&..\fR).
  51 .sp
  52 .LP
  53 The \fBmkdirat()\fR function behaves similarly to \fBmkdir()\fR; however, if
  54 \fIpath\fR is a relative path, then the directory represented by \fBfd\fR is
  55 used as the starting point for resolving \fIpath\fR. To use the processes
  56 current working directory, \fIfd\fR may be set to the value \fBAT_FDCWD\fR.
  57 .sp
  58 .LP
  59 Upon successful completion, \fBmkdir()\fR and \fBmkdirat()\fR mark for update
  60 the \fBst_atime\fR, \fBst_ctime\fR and \fBst_mtime\fR fields of the directory.
  61 Also, the \fBst_ctime\fR and \fBst_mtime\fR fields of the directory that
  62 contains the new entry are marked for update.
  63 .SH RETURN VALUES
  64 .LP
  65 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  66 returned, no directory is created, and \fBerrno\fR is set to indicate the
  67 error.
  68 .SH ERRORS
  69 .LP
  70 The \fBmkdir()\fR and \fBmkdirat()\fR functions will fail if:
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBEACCES\fR\fR
  75 .ad
  76 .RS 16n
  77 Either a component of the path prefix denies search permission or write
  78 permission is denied on the parent directory of the directory to be created.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEDQUOT\fR\fR
  85 .ad
  86 .RS 16n
  87 The directory where the new file entry is being placed cannot be extended
  88 because the user's quota of disk blocks on that file system has been exhausted;
  89 the new directory cannot be created because the user's quota of disk blocks on
  90 that file system has been exhausted; or the user's quota of inodes on the file
  91 system where the file is being created has been exhausted.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBEEXIST\fR\fR
  98 .ad
  99 .RS 16n
 100 The named file already exists.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBEFAULT\fR\fR
 107 .ad
 108 .RS 16n
 109 The \fIpath\fR argument points to an illegal address.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBEINVAL\fR\fR
 116 .ad
 117 .RS 16n
 118 An attempt was made to create an extended attribute that is a directory.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBEIO\fR\fR
 125 .ad
 126 .RS 16n
 127 An I/O error has occurred while accessing the file system.
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fBEILSEQ\fR\fR
 134 .ad
 135 .RS 16n
 136 The path argument includes non-UTF8 characters and the file system accepts only
 137 file names where all characters are part of the UTF-8 character codeset.
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fBELOOP\fR\fR
 144 .ad
 145 .RS 16n
 146 Too many symbolic links were encountered in translating \fIpath\fR, or a loop
 147 exists in symbolic links encountered during resolution of \fIpath\fR
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fBEMLINK\fR\fR
 154 .ad
 155 .RS 16n
 156 The maximum number of links to the parent directory would be exceeded.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBENAMETOOLONG\fR\fR
 163 .ad
 164 .RS 16n
 165 The length of the \fIpath\fR argument exceeds \fBPATH_MAX\fR, or the length of
 166 a \fIpath\fR component exceeds \fBNAME_MAX\fR while \fB_POSIX_NO_TRUNC\fR is in
 167 effect.
 168 .RE
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fBENOENT\fR\fR
 174 .ad
 175 .RS 16n
 176 A component of the path prefix does not exist or is a null pathname.
 177 .RE
 178
 179 .sp
 180 .ne 2
 181 .na
 182 \fB\fBENOLINK\fR\fR
 183 .ad
 184 .RS 16n
 185 The \fIpath\fR argument points to a remote machine and the link to that machine
 186 is no longer active.
 187 .RE
 188
 189 .sp
 190 .ne 2
 191 .na
 192 \fB\fBENOSPC\fR\fR
 193 .ad
 194 .RS 16n
 195 No free space is available on the device containing the directory.
 196 .RE
 197
 198 .sp
 199 .ne 2
 200 .na
 201 \fB\fBENOTDIR\fR\fR
 202 .ad
 203 .RS 16n
 204 A component of the path prefix is not a directory. For \fBlinkat()\fR, if
 205 \fIpath\fR is a relative path and \fIfd\fR refers to a valid file descriptor
 206 which is not a directory.
 207 .RE
 208
 209 .sp
 210 .ne 2
 211 .na
 212 \fB\fBEROFS\fR\fR
 213 .ad
 214 .RS 16n
 215 The path prefix resides on a read-only file system.
 216 .RE
 217
 218 .sp
 219 .LP
 220 The \fBmkdirat()\fR function will fail if:
 221 .sp
 222 .ne 2
 223 .na
 224 .B EBADF
 225 .ad
 226 .RS 16n
 227 The path \fIpath\fR is a relative path and \fIfd\fR is not a valid open file
 228 descriptor or the value \fBAT_FDCWD\fR.
 229 .RE
 230
 231 .sp
 232 .LP
 233 The \fBmkdir()\fR function may fail if:
 234 .sp
 235 .ne 2
 236 .na
 237 \fB\fBENAMETOOLONG\fR\fR
 238 .ad
 239 .RS 16n
 240 As a result of encountering a symbolic link in resolution of the \fIpath\fR
 241 argument, the length of the substituted pathname string exceeded
 242 {\fBPATH_MAX\fR}.
 243 .RE
 244
 245 .SH EXAMPLES
 246 .LP
 247 \fBExample 1 \fRCreate a directory.
 248 .sp
 249 .LP
 250 The following example demonstrates how to create a directory named
 251 \fB/home/cnd/mod1\fR, with read, write, and search permissions for owner and
 252 group, and with read and search permissions for others.
 253
 254 .sp
 255 .in +2
 256 .nf
 257 #include <sys/types.h>
 258 #include <sys/stat.h>
 259 int status;
 260 \&...
 261 status = mkdir("/home/cnd/mod1",
 262      S_IRWXU | S_IRWXG | S_IROTH | S_IXOTH);
 263 .fi
 264 .in -2
 265
 266 .SH ATTRIBUTES
 267 .LP
 268 See \fBattributes\fR(5) for descriptions of the following attributes:
 269 .sp
 270
 271 .sp
 272 .TS
 273 box;
 274 c | c
 275 l | l .
 276 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 277 _
 278 Interface Stability     Standard
 279 _
 280 MT-Level        Async-Signal-Safe
 281 .TE
 282
 283 .SH SEE ALSO
 284 .LP
 285 \fBchmod\fR(2), \fBmknod\fR(2), \fBumask\fR(2), \fBmkdirp\fR(3GEN),
 286 \fBstat.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)