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 .Nd make a directory file
  42 .Sh SYNOPSIS
  43 .Fd #include <sys/stat.h>
  44 .Ft int
  45 .Fo mkdir
  46 .Fa "const char *path"
  47 .Fa "mode_t mode"
  48 .Fc
  49 .Sh DESCRIPTION
  50 The directory
  51 .Fa path
  52 is created with the access permissions specified by
  53 .Fa mode
  54 and restricted by the
  55 .Xr umask 2
  56 of the calling process. See
  57 .Xr chmod 2
  58 for the possible permission bit masks for
  59 .Fa mode .
  60 .Pp
  61 The directory's owner ID is set to the process's effective user ID.
  62 The directory's group ID is set to that of the parent directory in
  63 which it is created.
  64 .Pp
  65 Note: the behavior of
  66 .Fn mkdir
  67 is undefined when mode bits other than the low 9 bits are used. Use
  68 .Xr chmod 2
  69 after
  70 .Fn mkdir
  71 to explicitly set the other bits (See example below).
  72 .Sh RETURN VALUES
  73 A 0 return value indicates success.  A -1 return value
  74 indicates an error, and an error code is stored in
  75 .Va errno .
  76 .Sh ERRORS
  77 .Fn Mkdir
  78 will fail and no directory will be created if:
  79 .Bl -tag -width Er
  80 .\" ==========
  81 .It Bq Er EACCES
  82 Search permission is denied for a component of the path prefix.
  83 .\" ==========
  84 .It Bq Er EACCES
  85 Write permission is denied for the parent directory.
  86 .\" ==========
  87 .It Bq Er EDQUOT
  88 The new directory cannot be created because the user's
  89 quota of disk blocks on the file system that will
  90 contain the directory has been exhausted.
  91 .\" ==========
  92 .It Bq Er EDQUOT
  93 The user's quota of inodes on the file system on
  94 which the directory is being created has been exhausted.
  95 .\" ==========
  96 .It Bq Er EEXIST
  97 The named file exists.
  98 .\" ==========
  99 .It Bq Er EFAULT
 100 .Fa Path
 101 points outside the process's allocated address space.
 102 .\" ==========
 103 .It Bq Er EIO
 104 An I/O error occurred while making the directory entry
 105 or allocating the inode.
 106 .\" ==========
 107 .It Bq Er EIO
 108 An I/O error occurred while reading from or writing to the file system.
 109 .\" ==========
 110 .It Bq Er ELOOP
 111 Too many symbolic links were encountered in translating the pathname.
 112 This is taken to be indicative of a looping symbolic link.
 113 .\" ==========
 114 .It Bq Er EMLINK
 115 The parent directory already has {LINK_MAX} links.
 116 .\" ==========
 117 .It Bq Er ENAMETOOLONG
 118 A component of a pathname exceeded
 119 .Dv {NAME_MAX}
 120 characters, or an entire path name exceeded
 121 .Dv {PATH_MAX}
 122 characters.
 123 .\" ==========
 124 .It Bq Er ENOENT
 125 A component of the path prefix does not exist
 126 or path is an empty string.
 127 .It Bq Er ENOSPC
 128 The new directory cannot be created because there is no space left
 129 on the file system that would contain it.
 130 .\" ==========
 131 .It Bq Er ENOSPC
 132 There are no free inodes on the file system on which the
 133 directory is being created.
 134 .\" ==========
 135 .It Bq Er ENOTDIR
 136 A component of the path prefix is not a directory.
 137 .\" ==========
 138 .It Bq Er EROFS
 139 The parent directory resides on a read-only file system.
 140 .El
 141 .Sh EXAMPLE
 142 .Bd -literal -offset indent
 143
 144 int main (int argc, const char * argv[])
 145 {
 146         /* The behavior of mkdir is undefined for anything other than the "permission" bits */
 147         if (mkdir("/tmp/blah", 0777))
 148                 perror("/tmp/blah");
 149
 150         /* So we need to set the sticky/executable bits explicitly with chmod after calling mkdir */
 151         if (chmod("/tmp/blah", 07777))
 152                 perror("/tmp/blah");
 153 }
 154
 155 .Ed
 156 .Sh LEGACY SYNOPSIS
 157 .Fd #include <sys/types.h>
 158 .Fd #include <sys/stat.h>
 159 .Pp
 160 The include file
 161 .In sys/types.h
 162 is necessary.
 163 .Sh SEE ALSO
 164 .Xr chmod 2 ,
 165 .Xr stat 2 ,
 166 .Xr umask 2 ,
 167 .Xr compat 5
 168 .Sh STANDARDS
 169 The
 170 .Fn mkdir
 171 function conforms to
 172 .St -p1003.1-88 .