xref: /freebsd/bin/mkdir/mkdir.1 (revision 1db64f89363c97858961c4df0b7d02f3223723cf)
1.\"-
2.\" Copyright (c) 1989, 1990, 1993
3.\"	The Regents of the University of California.  All rights reserved.
4.\"
5.\" This code is derived from software contributed to Berkeley by
6.\" the Institute of Electrical and Electronics Engineers, Inc.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. 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.Dd March 15, 2013
33.Dt MKDIR 1
34.Os
35.Sh NAME
36.Nm mkdir
37.Nd make directories
38.Sh SYNOPSIS
39.Nm
40.Op Fl pv
41.Op Fl m Ar mode
42.Ar directory_name ...
43.Sh DESCRIPTION
44The
45.Nm
46utility creates the directories named as operands, in the order specified,
47using mode
48.Dq Li rwxrwxrwx
49(0777)
50as modified by the current
51.Xr umask 2 .
52.Pp
53The options are as follows:
54.Bl -tag -width ".Fl m Ar mode"
55.It Fl m Ar mode
56Set the file permission bits of the final created directory to
57the specified mode.
58The
59.Ar mode
60argument can be in any of the formats specified to the
61.Xr chmod 1
62command.
63If a symbolic mode is specified, the operation characters
64.Ql +
65and
66.Ql -
67are interpreted relative to an initial mode of
68.Dq Li a=rwx .
69.It Fl p
70Create intermediate directories as required.
71If this option is not specified, the full path prefix of each
72operand must already exist.
73On the other hand, with this option specified, no error will
74be reported if a directory given as an operand already exists.
75Intermediate directories are created with permission bits of
76.Dq Li rwxrwxrwx
77(0777)
78as modified by the current umask, plus write and search
79permission for the owner.
80.It Fl v
81Be verbose when creating directories, listing them as they are created.
82.El
83.Pp
84The user must have write permission in the parent directory.
85.Sh EXIT STATUS
86.Ex -std
87.Sh EXAMPLES
88Create a directory named
89.Pa foobar :
90.Pp
91.Dl $ mkdir foobar
92.Pp
93Create a directory named
94.Pa foobar
95and set its file mode to 700:
96.Pp
97.Dl $ mkdir -m 700 foobar
98.Pp
99Create a directory named
100.Pa cow/horse/monkey ,
101creating any non-existent intermediate directories as necessary:
102.Pp
103.Dl $ mkdir -p cow/horse/monkey
104.Sh COMPATIBILITY
105The
106.Fl v
107option is non-standard and its use in scripts is not recommended.
108.Sh SEE ALSO
109.Xr rmdir 1
110.Sh STANDARDS
111The
112.Nm
113utility is expected to be
114.St -p1003.2
115compatible.
116.Sh HISTORY
117A
118.Nm
119command appeared in
120.At v1 .
121