Merge branch 'vendor/DIFFUTILS'
[dragonfly.git] / bin / mkdir / mkdir.1
1 .\" Copyright (c) 1989, 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the Institute of Electrical and Electronics Engineers, Inc.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. Neither the name of the University nor the names of its contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"    without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\"     @(#)mkdir.1     8.2 (Berkeley) 1/25/94
32 .\" $FreeBSD: src/bin/mkdir/mkdir.1,v 1.12.2.5 2002/07/14 21:42:14 keramida Exp $
33 .\"
34 .Dd January 25, 1994
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
46 The
47 .Nm
48 utility 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 .Bl -tag -width indent
56 .It Fl m Ar mode
57 Set the file permission bits of the final created directory to
58 the specified mode.
59 The
60 .Ar mode
61 argument can be in any of the formats specified to the
62 .Xr chmod 1
63 command.
64 If a symbolic mode is specified, the operation characters
65 .Dq +
66 and
67 .Dq -
68 are interpreted relative to an initial mode of
69 .Dq a=rwx .
70 .It Fl p
71 Create intermediate directories as required.
72 If this option is not specified, the full path prefix of each
73 operand must already exist.
74 On the other hand, with this option specified, no error will
75 be reported if a directory given as an operand already exists.
76 Intermediate directories are created with permission bits of
77 .Li rwxrwxrwx (\&0777)
78 as modified by the current umask, plus write and search
79 permission for the owner.
80 .It Fl v
81 Be verbose when creating directories, listing them as they are created.
82 .El
83 .Pp
84 The user must have write permission in the parent directory.
85 .Sh EXIT STATUS
86 .Ex -std
87 .Sh COMPATIBILITY
88 The
89 .Fl v
90 option is non-standard and its use in scripts is not recommended.
91 .Sh SEE ALSO
92 .Xr rmdir 1
93 .Sh STANDARDS
94 The
95 .Nm
96 utility is expected to be
97 .St -p1003.2
98 compatible.
99 .Sh HISTORY
100 A
101 .Nm
102 command appeared in
103 .At v1 .