The new bridge(4) manual page somehow never found its way into the Makefile.
[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. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)mkdir.1     8.2 (Berkeley) 1/25/94
36 .\" $FreeBSD: src/bin/mkdir/mkdir.1,v 1.12.2.5 2002/07/14 21:42:14 keramida Exp $
37 .\" $DragonFly: src/bin/mkdir/mkdir.1,v 1.3 2006/02/17 19:33:31 swildner Exp $
38 .\"
39 .Dd January 25, 1994
40 .Dt MKDIR 1
41 .Os
42 .Sh NAME
43 .Nm mkdir
44 .Nd make directories
45 .Sh SYNOPSIS
46 .Nm
47 .Op Fl pv
48 .Op Fl m Ar mode
49 .Ar directory_name  ...
50 .Sh DESCRIPTION
51 The
52 .Nm
53 utility creates the directories named as operands, in the order specified,
54 using mode
55 .Li rwxrwxrwx (\&0777)
56 as modified by the current
57 .Xr umask  2  .
58 .Pp
59 The options are as follows:
60 .Pp
61 .Bl -tag -width indent
62 .It Fl m Ar mode
63 Set the file permission bits of the final created directory to
64 the specified mode.
65 The
66 .Ar mode
67 argument can be in any of the formats specified to the
68 .Xr chmod 1
69 command.
70 If a symbolic mode is specified, the operation characters
71 .Dq +
72 and
73 .Dq -
74 are interpreted relative to an initial mode of
75 .Dq a=rwx .
76 .It Fl p
77 Create intermediate directories as required.
78 If this option is not specified, the full path prefix of each
79 operand must already exist.
80 On the other hand, with this option specified, no error will
81 be reported if a directory given as an operand already exists.
82 Intermediate directories are created with permission bits of
83 .Li rwxrwxrwx (\&0777)
84 as modified by the current umask, plus write and search
85 permission for the owner.
86 .It Fl v
87 Be verbose when creating directories, listing them as they are created.
88 .El
89 .Pp
90 The user must have write permission in the parent directory.
91 .Sh DIAGNOSTICS
92 .Ex -std
93 .Sh COMPATIBILITY
94 The
95 .Fl v
96 option is non-standard and its use in scripts is not recommended.
97 .Sh SEE ALSO
98 .Xr rmdir 1
99 .Sh STANDARDS
100 The
101 .Nm
102 utility is expected to be
103 .St -p1003.2
104 compatible.
105 .Sh HISTORY
106 A
107 .Nm
108 command appeared in
109 .At v1 .