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