Sync some manuals from bin & sbin with NetBSD-8
[minix.git] / bin / mkdir / mkdir.1
blob89b8d364e51bb776eec874baefc47342e6696e66
1 .\"     $NetBSD: mkdir.1,v 1.19 2016/08/10 18:42:00 sevan Exp $
2 .\"
3 .\" Copyright (c) 1989, 1990, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to Berkeley by
7 .\" the Institute of Electrical and Electronics Engineers, Inc.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\" 3. Neither the name of the University nor the names of its contributors
18 .\"    may be used to endorse or promote products derived from this software
19 .\"    without specific prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" SUCH DAMAGE.
32 .\"
33 .\"     @(#)mkdir.1     8.2 (Berkeley) 1/25/94
34 .\"
35 .Dd August 10, 2016
36 .Dt MKDIR 1
37 .Os
38 .Sh NAME
39 .Nm mkdir
40 .Nd make directories
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl p
44 .Op Fl m Ar mode
45 .Ar directory_name  ...
46 .Sh DESCRIPTION
47 .Nm
48 creates the directories named as operands, in the order specified,
49 using mode
50 .Li rwxrwxrwx (\&0777)
51 as modified by the current
52 .Xr umask 2 .
53 .Pp
54 The options are as follows:
55 .Pp
56 .Bl -tag -width indent
57 .It Fl m
58 Set the file permission bits of the final created directory to
59 the specified mode.
60 The mode argument can be in any of the formats specified to the
61 .Xr chmod 1
62 utility.
63 If a symbolic mode is specified, the operation characters
64 .Dq +
65 and
66 .Dq -
67 are interpreted relative to an initial mode of
68 .Dq a=rwx .
69 .It Fl p
70 Create intermediate directories as required.
71 If this option is not specified, the full path prefix of each
72 operand must already exist.
73 Intermediate directories are created with permission bits of
74 .Li rwxrwxrwx (\&0777)
75 as modified by the current umask, plus write and search
76 permission for the owner.
77 Do not consider it an error if the argument directory already exists.
78 .El
79 .Pp
80 The user must have write permission in the parent directory.
81 .Sh EXIT STATUS
82 .Nm
83 exits 0 if successful, and \*[Gt]0 if an error occurred.
84 .Sh SEE ALSO
85 .Xr chmod 1 ,
86 .Xr rmdir 1 ,
87 .Xr mkdir 2 ,
88 .Xr umask 2
89 .Sh STANDARDS
90 The
91 .Nm
92 utility is expected to be
93 .St -p1003.2
94 compatible.
95 .Sh HISTORY
97 .Nm
98 utility appeared in
99 .At v1 .