[apple/xnu.git] / bsd / man / man2 / mkdir.2

.\"	$NetBSD: mkdir.2,v 1.8 1995/02/27 12:34:22 cgd Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)mkdir.2	8.2 (Berkeley) 12/11/93
.\"
.Dd December 11, 1993
.Dt MKDIR 2
.Os BSD 4.2
.Sh NAME
.Nm mkdir
.Nd make a directory file
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/stat.h>
.Ft int
.Fn mkdir "const char *path" "mode_t mode"
.Sh DESCRIPTION
The directory
.Fa path
is created with the access permissions specified by
.Fa mode
and restricted by the
.Xr umask 2
of the calling process.
.Pp
The directory's owner ID is set to the process's effective user ID.
The directory's group ID is set to that of the parent directory in
which it is created.
.Sh RETURN VALUES
A 0 return value indicates success.  A -1 return value
indicates an error, and an error code is stored in
.Va errno .
.Sh ERRORS
.Fn Mkdir
will fail and no directory will be created if:
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG
A component of a pathname exceeded 
.Dv {NAME_MAX}
characters, or an entire path name exceeded 
.Dv {PATH_MAX}
characters.
.It Bq Er ENOENT
A component of the path prefix does not exist.
.It Bq Er EACCES
Search permission is denied for a component of the path prefix.
.It Bq Er ELOOP
Too many symbolic links were encountered in translating the pathname.
.It Bq Er EROFS
The named file resides on a read-only file system.
.It Bq Er EEXIST
The named file exists.
.It Bq Er ENOSPC
The new directory cannot be created because there is no space left
on the file system that will contain the directory.
.It Bq Er ENOSPC
There are no free inodes on the file system on which the
directory is being created.
.It Bq Er EDQUOT
The new directory cannot be created because the user's
quota of disk blocks on the file system that will
contain the directory has been exhausted.
.It Bq Er EDQUOT
The user's quota of inodes on the file system on
which the directory is being created has been exhausted.
.It Bq Er EIO
An I/O error occurred while making the directory entry or allocating the inode.
.It Bq Er EIO
An I/O error occurred while reading from or writing to the file system.
.It Bq Er EFAULT
.Fa Path
points outside the process's allocated address space.
.El
.Sh SEE ALSO
.Xr chmod 2 ,
.Xr stat 2 ,
.Xr umask 2
.Sh STANDARDS
The 
.Fn mkdir
function conforms to 
.St -p1003.1-88 .
Commit	Line	Data
9bccf70c A	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/types.h>
	44	.Fd #include <sys/stat.h>
	45	.Ft int
	46	.Fn mkdir "const char *path" "mode_t mode"
	47	.Sh DESCRIPTION
	48	The directory
	49	.Fa path
	50	is created with the access permissions specified by
	51	.Fa mode
	52	and restricted by the
	53	.Xr umask 2
	54	of the calling process.
	55	.Pp
	56	The directory's owner ID is set to the process's effective user ID.
	57	The directory's group ID is set to that of the parent directory in
	58	which it is created.
	59	.Sh RETURN VALUES
	60	A 0 return value indicates success. A -1 return value
	61	indicates an error, and an error code is stored in
	62	.Va errno .
	63	.Sh ERRORS
	64	.Fn Mkdir
65	will fail and no directory will be created if:
66	.Bl -tag -width Er
67	.It Bq Er ENOTDIR
68	A component of the path prefix is not a directory.
69	.It Bq Er ENAMETOOLONG
70	A component of a pathname exceeded
71	.Dv {NAME_MAX}
72	characters, or an entire path name exceeded
73	.Dv {PATH_MAX}
74	characters.
75	.It Bq Er ENOENT
76	A component of the path prefix does not exist.
77	.It Bq Er EACCES
78	Search permission is denied for a component of the path prefix.
79	.It Bq Er ELOOP
80	Too many symbolic links were encountered in translating the pathname.
81	.It Bq Er EROFS
82	The named file resides on a read-only file system.
83	.It Bq Er EEXIST
84	The named file exists.
85	.It Bq Er ENOSPC
86	The new directory cannot be created because there is no space left
87	on the file system that will contain the directory.
88	.It Bq Er ENOSPC
89	There are no free inodes on the file system on which the
90	directory is being created.
91	.It Bq Er EDQUOT
92	The new directory cannot be created because the user's
93	quota of disk blocks on the file system that will
94	contain the directory has been exhausted.
95	.It Bq Er EDQUOT
96	The user's quota of inodes on the file system on
97	which the directory is being created has been exhausted.
98	.It Bq Er EIO
99	An I/O error occurred while making the directory entry or allocating the inode.
100	.It Bq Er EIO
101	An I/O error occurred while reading from or writing to the file system.
102	.It Bq Er EFAULT
103	.Fa Path
104	points outside the process's allocated address space.
105	.El
106	.Sh SEE ALSO
107	.Xr chmod 2 ,
108	.Xr stat 2 ,
109	.Xr umask 2
110	.Sh STANDARDS
111	The
112	.Fn mkdir
113	function conforms to
114	.St -p1003.1-88 .