lib/libc/sys/mkdir.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)mkdir.2     8.2 (Berkeley) 12/11/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 26, 2008
  32 .Dt MKDIR 2
  33 .Os
  34 .Sh NAME
  35 .Nm mkdir
  36 .Nd make a directory file
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/stat.h
  41 .Ft int
  42 .Fn mkdir "const char *path" "mode_t mode"
  43 .Sh DESCRIPTION
  44 The directory
  45 .Fa path
  46 is created with the access permissions specified by
  47 .Fa mode
  48 and restricted by the
  49 .Xr umask 2
  50 of the calling process.
  51 .Pp
  52 The directory's owner ID is set to the process's effective user ID.
  53 The directory's group ID is set to that of the parent directory in
  54 which it is created.
  55 .Sh RETURN VALUES
  56 .Rv -std mkdir
  57 .Sh ERRORS
  58 The
  59 .Fn mkdir
  60 system call
  61 will fail and no directory will be created if:
  62 .Bl -tag -width Er
  63 .It Bq Er ENOTDIR
  64 A component of the path prefix is not a directory.
  65 .It Bq Er ENAMETOOLONG
  66 A component of a pathname exceeded 255 characters,
  67 or an entire path name exceeded 1023 characters.
  68 .It Bq Er ENOENT
  69 A component of the path prefix does not exist.
  70 .It Bq Er EACCES
  71 Search permission is denied for a component of the path prefix,
  72 or write permission is denied
  73 on the parent directory of the directory to be created.
  74 .It Bq Er ELOOP
  75 Too many symbolic links were encountered in translating the pathname.
  76 .It Bq Er EPERM
  77 The parent directory of the directory to be created has its immutable flag set,
  78 see the
  79 .Xr chflags 2
  80 manual page for more information.
  81 .It Bq Er EROFS
  82 The named directory would reside on a read-only file system.
  83 .It Bq Er EMLINK
  84 The new directory cannot be created because the parent directory contains
  85 too many subdirectories.
  86 .It Bq Er EEXIST
  87 The named file exists.
  88 .It Bq Er ENOSPC
  89 The new directory cannot be created because there is no space left
  90 on the file system that will contain the directory.
  91 .It Bq Er ENOSPC
  92 There are no free inodes on the file system on which the
  93 directory is being created.
  94 .It Bq Er EDQUOT
  95 The new directory cannot be created because the user's
  96 quota of disk blocks on the file system that will
  97 contain the directory has been exhausted.
  98 .It Bq Er EDQUOT
  99 The user's quota of inodes on the file system on
 100 which the directory is being created has been exhausted.
 101 .It Bq Er EIO
 102 An I/O error occurred while making the directory entry or allocating the inode.
 103 .It Bq Er EIO
 104 An I/O error occurred while reading from or writing to the file system.
 105 .It Bq Er EFAULT
 106 The
 107 .Fa path
 108 argument
 109 points outside the process's allocated address space.
 110 .El
 111 .Sh SEE ALSO
 112 .Xr chflags 2 ,
 113 .Xr chmod 2 ,
 114 .Xr stat 2 ,
 115 .Xr umask 2
 116 .Sh STANDARDS
 117 The
 118 .Fn mkdir
 119 system call is expected to conform to
 120 .St -p1003.1-90 .