[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/stat.h>
.Ft int
.Fo mkdir
.Fa "const char *path"
.Fa "mode_t mode"
.Fc
.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 EACCES
Search permission is denied for a component of the path prefix.
.\" ==========
.It Bq Er EACCES
Write permission is denied for the parent directory.
.\" ==========
.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 EEXIST
The named file exists.
.\" ==========
.It Bq Er EFAULT
.Fa Path
points outside the process's allocated address space.
.\" ==========
.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 ELOOP
Too many symbolic links were encountered in translating the pathname.
This is taken to be indicative of a looping symbolic link.
.\" ==========
.It Bq Er EMLINK
The parent directory already has {LINK_MAX} links.
.\" ==========
.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
or path is an empty string.
.It Bq Er ENOSPC
The new directory cannot be created because there is no space left
on the file system that would contain it.
.\" ==========
.It Bq Er ENOSPC
There are no free inodes on the file system on which the
directory is being created.
.\" ==========
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.\" ==========
.It Bq Er EROFS
The parent directory resides on a read-only file system.
.El
.Sh LEGACY SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/stat.h>
.Pp
The include file
.In sys/types.h
is necessary.
.Sh SEE ALSO
.Xr chmod 2 ,
.Xr stat 2 ,
.Xr umask 2 ,
.Xr compat 5
.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
9bccf70c A	43	.Fd #include <sys/stat.h>
9bccf70c A	44	.Ft int
2d21ac55 A	45	.Fo mkdir
	46	.Fa "const char *path"
	47	.Fa "mode_t mode"
	48	.Fc
9bccf70c A	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.
	57	.Pp
	58	The directory's owner ID is set to the process's effective user ID.
	59	The directory's group ID is set to that of the parent directory in
	60	which it is created.
	61	.Sh RETURN VALUES
	62	A 0 return value indicates success. A -1 return value
	63	indicates an error, and an error code is stored in
	64	.Va errno .
	65	.Sh ERRORS
	66	.Fn Mkdir
	67	will fail and no directory will be created if:
	68	.Bl -tag -width Er
2d21ac55	69	.\" ==========
9bccf70c A	70	.It Bq Er EACCES
9bccf70c A	71	Search permission is denied for a component of the path prefix.
2d21ac55 A	72	.\" ==========
	73	.It Bq Er EACCES
	74	Write permission is denied for the parent directory.
	75	.\" ==========
9bccf70c A	76	.It Bq Er EDQUOT
	77	The new directory cannot be created because the user's
	78	quota of disk blocks on the file system that will
	79	contain the directory has been exhausted.
2d21ac55	80	.\" ==========
9bccf70c A	81	.It Bq Er EDQUOT
	82	The user's quota of inodes on the file system on
	83	which the directory is being created has been exhausted.
2d21ac55 A	84	.\" ==========
	85	.It Bq Er EEXIST
	86	The named file exists.
	87	.\" ==========
9bccf70c A	88	.It Bq Er EFAULT
	89	.Fa Path
	90	points outside the process's allocated address space.
2d21ac55 A	91	.\" ==========
	92	.It Bq Er EIO
	93	An I/O error occurred while making the directory entry
	94	or allocating the inode.
	95	.\" ==========
	96	.It Bq Er EIO
	97	An I/O error occurred while reading from or writing to the file system.
	98	.\" ==========
	99	.It Bq Er ELOOP
	100	Too many symbolic links were encountered in translating the pathname.
	101	This is taken to be indicative of a looping symbolic link.
	102	.\" ==========
	103	.It Bq Er EMLINK
	104	The parent directory already has {LINK_MAX} links.
	105	.\" ==========
	106	.It Bq Er ENAMETOOLONG
	107	A component of a pathname exceeded
	108	.Dv {NAME_MAX}
	109	characters, or an entire path name exceeded
	110	.Dv {PATH_MAX}
	111	characters.
	112	.\" ==========
	113	.It Bq Er ENOENT
	114	A component of the path prefix does not exist
	115	or path is an empty string.
	116	.It Bq Er ENOSPC
	117	The new directory cannot be created because there is no space left
	118	on the file system that would contain it.
	119	.\" ==========
	120	.It Bq Er ENOSPC
	121	There are no free inodes on the file system on which the
	122	directory is being created.
	123	.\" ==========
	124	.It Bq Er ENOTDIR
	125	A component of the path prefix is not a directory.
	126	.\" ==========
	127	.It Bq Er EROFS
	128	The parent directory resides on a read-only file system.
9bccf70c	129	.El
2d21ac55 A	130	.Sh LEGACY SYNOPSIS
	131	.Fd #include <sys/types.h>
	132	.Fd #include <sys/stat.h>
	133	.Pp
	134	The include file
	135	.In sys/types.h
	136	is necessary.
9bccf70c A	137	.Sh SEE ALSO
	138	.Xr chmod 2 ,
	139	.Xr stat 2 ,
2d21ac55 A	140	.Xr umask 2 ,
2d21ac55 A	141	.Xr compat 5
9bccf70c A	142	.Sh STANDARDS
	143	The
	144	.Fn mkdir
	145	function conforms to
	146	.St -p1003.1-88 .