bin/mkdir/mkdir.1

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