flag fields are u_int's

[unix-history] / usr / src / lib / libc / sys / mkdir.2

diff --git a/usr/src/lib/libc/sys/mkdir.2 b/usr/src/lib/libc/sys/mkdir.2
index 211f35d..2d9f89f 100644 (file)
--- a/usr/src/lib/libc/sys/mkdir.2
+++ b/usr/src/lib/libc/sys/mkdir.2
@@ -1,124 +1,97 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted
-.\" provided that the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not be used to endorse or promote products derived
-.\" from this software without specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
-.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" %sccs.include.redist.man%

 .\"
 .\"

-.\"    @(#)mkdir.2     6.5 (Berkeley) %G%
+.\"     @(#)mkdir.2    6.7 (Berkeley) %G%

 .\"
 .\"

-.TH MKDIR 2 ""
-.UC 5
-.SH NAME
-mkdir \- make a directory file
-.SH SYNOPSIS
-.nf
-.ft B
-mkdir(path, mode)
-char *path;
-int mode;
-.fi
-.ft R
-.SH DESCRIPTION
-.I Mkdir
-creates a new directory file with name
-.IR path .
-The mode of the new file
-is initialized from
-.IR mode .
-(The protection part of the mode
-is modified by the process's mode mask; see
-.IR umask (2)).
-.PP
+.Dd 
+.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
+.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 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.
 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.

-.PP
-The low-order 9 bits of mode are modified by the process's
-file mode creation mask: all bits set in the process's file mode
-creation mask are cleared.  See
-.IR umask (2).
-.SH "RETURN VALUE
-A 0 return value indicates success.  A \-1 return value
+.Sh RETURN VALUES
+A 0 return value indicates success.  A -1 return value

 indicates an error, and an error code is stored in
 indicates an error, and an error code is stored in

-.I errno.
-.SH "ERRORS
-.I Mkdir
+.Va errno .
+.Sh ERRORS
+.Fn Mkdir

 will fail and no directory will be created if:
 will fail and no directory will be created if:

-.TP 15
-[ENOTDIR]
+.Bl -tag -width ENAMETOOLO
+.It Bq Er ENOTDIR

 A component of the path prefix is not a directory.
 A component of the path prefix is not a directory.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 The pathname contains a character with the high-order bit set.
 The pathname contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.
 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 A component of the path prefix does not exist.
 A component of the path prefix does not exist.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 Search permission is denied for a component of the path prefix.
 Search permission is denied for a component of the path prefix.

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 Too many symbolic links were encountered in translating the pathname.

-.TP 15
-[EPERM]
-The \fIpath\fP argument contains a byte with the high-order bit set.
-.TP 15
-[EROFS]
+.It Bq Er EPERM
+The
+.Fa path
+argument contains a byte with the high-order bit set.
+.It Bq Er EROFS

 The named file resides on a read-only file system.
 The named file resides on a read-only file system.

-.TP 15
-[EEXIST]
+.It Bq Er EEXIST

 The named file exists.
 The named file exists.

-.TP 15
-[ENOSPC]
+.It Bq Er ENOSPC

 The directory in which the entry for the new directory is being placed
 cannot be extended because there is no space left on the file
 system containing the directory.
 The directory in which the entry for the new directory is being placed
 cannot be extended because there is no space left on the file
 system containing the directory.

-.TP 15
-[ENOSPC]
+.It Bq Er ENOSPC

 The new directory cannot be created because there
 there is no space left on the file
 system that will contain the directory.
 The new directory cannot be created because there
 there is no space left on the file
 system that will contain the directory.

-.TP 15
-[ENOSPC]
+.It Bq Er ENOSPC

 There are no free inodes on the file system on which the
 directory is being created.
 There are no free inodes on the file system on which the
 directory is being created.

-.TP 15
-[EDQUOT]
+.It Bq Er EDQUOT

 The directory in which the entry for the new directory
 is being placed cannot be extended because the
 user's quota of disk blocks on the file system
 containing the directory has been exhausted.
 The directory in which the entry for the new directory
 is being placed cannot be extended because the
 user's quota of disk blocks on the file system
 containing the directory has been exhausted.

-.TP 15
-[EDQUOT]
+.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.
 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.

-.TP 15
-[EDQUOT]
+.It Bq Er EDQUOT

 The user's quota of inodes on the file system on
 which the directory is being created has been exhausted.
 The user's quota of inodes on the file system on
 which the directory is being created has been exhausted.

-.TP 15
-[EIO]
+.It Bq Er EIO

 An I/O error occurred while making the directory entry or allocating the inode.
 An I/O error occurred while making the directory entry or allocating the inode.

-.TP 15
-[EIO]
+.It Bq Er EIO

 An I/O error occurred while reading from or writing to the file system.
 An I/O error occurred while reading from or writing to the file system.

-.TP 15
-[EFAULT]
-.I Path
+.It Bq Er EFAULT
+.Fa Path

 points outside the process's allocated address space.
 points outside the process's allocated address space.

-.SH "SEE ALSO"
-chmod(2), stat(2), umask(2)
+.El
+.Sh SEE ALSO
+.Xr chmod 2 ,
+.Xr stat 2 ,
+.Xr umask 2
+.Sh STANDARDS
+.Fn Mkdir
+conforms to IEEE Std 1003.1-1988
+.Pq Dq Tn POSIX .