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