lib/libc/sys/mkdir.2

   1 .\"     $NetBSD: mkdir.2,v 1.24 2010/05/31 12:16:20 njoly 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. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)mkdir.2     8.2 (Berkeley) 12/11/93
  31 .\"
  32 .Dd December 27, 2005
  33 .Dt MKDIR 2
  34 .Os
  35 .Sh NAME
  36 .Nm mkdir
  37 .Nd make a directory file
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/stat.h
  42 .Ft int
  43 .Fn mkdir "const char *path" "mode_t mode"
  44 .Sh DESCRIPTION
  45 The directory
  46 .Fa path
  47 is created with the access permissions specified by
  48 .Fa mode
  49 and restricted by the
  50 .Xr umask 2
  51 of the calling process.
  52 .Pp
  53 The directory's owner ID is set to the process's effective user ID.
  54 The directory's group ID is set to that of the parent directory in
  55 which it is created.
  56 .Sh RETURN VALUES
  57 A 0 return value indicates success.
  58 A \-1 return value indicates an error, and an error code is stored in
  59 .Va errno .
  60 .Sh ERRORS
  61 .Fn mkdir
  62 will fail and no directory will be created if:
  63 .Bl -tag -width Er
  64 .It Bq Er ENOTDIR
  65 A component of the path prefix is not a directory.
  66 .It Bq Er ENAMETOOLONG
  67 A component of a pathname exceeded
  68 .Brq Dv NAME_MAX
  69 characters, or an entire path name exceeded
  70 .Brq Dv PATH_MAX
  71 characters.
  72 .It Bq Er ENOENT
  73 A component of the path prefix does not exist.
  74 .It Bq Er EACCES
  75 Search permission is denied for a component of the path prefix.
  76 .It Bq Er ELOOP
  77 Too many symbolic links were encountered in translating the pathname.
  78 .It Bq Er EROFS
  79 The named file resides on a read-only file system.
  80 .It Bq Er EEXIST
  81 The named file exists.
  82 .It Bq Er ENOSPC
  83 The new directory cannot be created because there is no space left
  84 on the file system that will contain the directory.
  85 .It Bq Er ENOSPC
  86 There are no free inodes on the file system on which the
  87 directory is being created.
  88 .It Bq Er EDQUOT
  89 The new directory cannot be created because the user's
  90 quota of disk blocks on the file system that will
  91 contain the directory has been exhausted.
  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 .It Bq Er EIO
  96 An I/O error occurred while making the directory entry or allocating the inode.
  97 .It Bq Er EIO
  98 An I/O error occurred while reading from or writing to the file system.
  99 .It Bq Er EFAULT
 100 .Fa path
 101 points outside the process's allocated address space.
 102 .El
 103 .Sh SEE ALSO
 104 .Xr chmod 2 ,
 105 .Xr stat 2 ,
 106 .Xr umask 2
 107 .Sh STANDARDS
 108 The
 109 .Fn mkdir
 110 function conforms to
 111 .St -p1003.1-90 .