1 .\" Copyright (c) 1989, 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" From: @(#)mtree.8 8.2 (Berkeley) 12/11/93
36 .Nd format of mtree dir hierarchy files
40 format is a textual format that describes a collection of filesystem objects.
41 Such files are typically used to create or verify directory hierarchies.
45 file consists of a series of lines, each providing information
46 about a single filesystem object.
47 Leading whitespace is always ignored.
49 When encoding file or pathnames, any backslash character or
50 character outside of the 95 printable ASCII characters must be
51 encoded as a backslash followed by three
53 When reading mtree files, any appearance of a backslash
54 followed by three octal digits should be converted into the
55 corresponding character.
57 Each line is interpreted independently as one of the following types:
60 Blank lines are ignored.
68 are special commands that influence
69 the interpretation of later lines.
71 If the first whitespace-delimited word has no
74 it is the name of a file in the current directory.
75 Any relative entry that describes a directory changes the
78 As a special case, a relative entry with the filename
80 changes the current directory to the parent directory.
81 Options on dot-dot entries are always ignored.
83 If the first whitespace-delimited word has a
86 the first character, it is the pathname of a file relative to the
88 There can be multiple full entries describing the same file.
91 Some tools that process
93 files may require that multiple lines describing the same file
95 It is not permitted for the same file to be mentioned using
96 both a relative and a full file specification.
98 Two special commands are currently defined:
101 This command defines default values for one or more keywords.
102 It is followed on the same line by one or more whitespace-separated
104 These definitions apply to all following files that do not specify
105 a value for that keyword.
107 This command removes any default value set by a previous
110 It is followed on the same line by one or more keywords
111 separated by whitespace.
114 After the filename, a full or relative entry consists of zero
115 or more whitespace-separated keyword definitions.
116 Each such definition consists of a key from the following
117 list immediately followed by an '=' sign
119 Software programs reading mtree files should warn about
120 unrecognized keywords.
122 Currently supported keywords are as follows:
125 The checksum of the file using the default algorithm specified by
130 The device number for
135 The value must be one of the following forms:
137 .It Ar format , Ns Ar major , Ns Ar minor Ns Bo , Ns Ar subunit Bc
143 Their meaning is specified by the operating's system
145 See below for valid formats.
147 Opaque number (as stored on the file system).
150 The following values for
175 The full pathname of a file that holds the contents of this file.
177 The file flags as a symbolic name.
180 for information on these names.
181 If no flags are to be set the string
183 may be used to override the current default.
185 The file group as a numeric value.
187 The file group as a symbolic name.
189 Ignore any file hierarchy below this file.
193 The target of the symbolic link when type=link.
195 The MD5 message digest of the file.
200 The current file's permissions as a numeric (octal) or symbolic
203 The number of hard links the file is expected to have.
205 Make sure this file or directory exists but otherwise ignore all attributes.
207 The file is optional; do not complain about the file if it is not in
212 device number of the file, e.g. the ID of the device that
214 Its format is the same as the one for
216 .It Cm ripemd160digest
219 message digest of the file.
222 .Cm ripemd160digest .
225 .Cm ripemd160digest .
231 message digest of the file.
240 message digest of the file.
249 message digest of the file.
258 message digest of the file.
263 The size, in bytes, of the file.
265 The last modification time of the file.
267 The type of the file; may be set to any one of the following:
269 .Bl -tag -width Cm -compact
273 character special device
286 The file owner as a numeric value.
288 The file owner as a symbolic name.
301 digest capability was added in
303 in response to the widespread use of programs which can spoof
309 digests were added in
311 as new attacks have demonstrated weaknesses in
317 Support for file flags was added in
319 and mostly comes from
323 entry format was added by