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 .\" 3. 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 map a directory hierarchy
56 .Op Fl X Ar exclude-list
61 utility compares the file hierarchy rooted in the current directory against a
62 specification read from the standard input.
63 Messages are written to the standard output for any files whose
64 characteristics do not match the specifications, or which are
65 missing from either the file hierarchy or the specification.
67 The options are as follows:
70 Follow all symbolic links in the file hierarchy.
72 Do not follow symbolic links in the file hierarchy, instead consider
73 the symbolic link itself in any comparisons.
76 Modify the owner, group, permissions, and modification time of existing
77 files to match the specification and create any missing directories or
79 User, group and permissions must all be specified for missing directories
81 Corrected mismatches are not considered errors.
83 Print a specification for the file hierarchy to the standard output.
85 Ignore everything except directory type files.
87 Do not complain about files that are in the file hierarchy, but not in the
90 Indent the output 4 spaces each time a directory level is descended when
91 creating a specification with the
94 This does not affect either the /set statements or the comment before each
96 It does however affect the comment before the close of each directory.
98 Do not emit pathname comments when creating a specification.
100 a comment is emitted before each directory and before the close of that
101 directory when using the
106 Do not complain when a
108 directory cannot be created because it already exists.
109 This occurs when the directory is a symbolic link.
111 Remove any files in the file hierarchy that are not described in the
116 except a status of 2 is returned if the file hierarchy did not match
119 Make some errors non-fatal warnings.
121 Do not descend below mount points in the file hierarchy.
123 Read the specification from
125 instead of from the standard input.
127 If this option is specified twice, the two specifications are compared
128 to each other rather than to the file hierarchy.
129 The specifications will be sorted like output generated using
131 The output format in this case is somewhat remniscent of
133 having "in first spec only", "in second spec only", and "different"
134 columns, prefixed by zero, one and two TAB characters respectively.
135 Each entry in the "different" column occupies two lines, one from each specification.
137 Add the specified (whitespace or comma separated)
139 to the current set of keywords.
141 Use the ``type'' keyword plus the specified (whitespace or comma separated)
143 instead of the current set of keywords.
145 Use the file hierarchy rooted in
147 instead of the current directory.
149 Display a single checksum to the standard error output that represents all
150 of the files for which the keyword
153 The checksum is seeded with the specified value.
154 .It Fl X Ar exclude-list
155 The specified file contains
157 patterns matching files to be excluded from
158 the specification, one to a line.
159 If the pattern contains a
161 character, it will be matched against entire pathnames (relative to
162 the starting directory); otherwise,
163 it will be matched against basenames only.
164 No comments are allowed in
170 Specifications are mostly composed of ``keywords'', i.e., strings
171 that specify values relating to files.
172 No keywords have default values, and if a keyword has no value set, no
173 checks based on it are performed.
175 Currently supported keywords are as follows:
178 The checksum of the file using the default algorithm specified by
183 The file flags as a symbolic name.
186 for information on these names.
187 If no flags are to be set the string
189 may be used to override the current default.
191 Ignore any file hierarchy below this file.
193 The file group as a numeric value.
195 The file group as a symbolic name.
197 The MD5 message digest of the file.
203 message digest of the file.
209 message digest of the file.
210 .It Cm ripemd160digest
213 message digest of the file.
215 The current file's permissions as a numeric (octal) or symbolic
218 The number of hard links the file is expected to have.
220 Make sure this file or directory exists but otherwise ignore all attributes.
222 The file is optional; do not complain about the file if it is
223 not in the file hierarchy.
225 The file owner as a numeric value.
227 The file owner as a symbolic name.
229 The size, in bytes, of the file.
231 The file the symbolic link is expected to reference.
233 The last modification time of the file, in seconds and nanoseconds.
234 The value should include a period character and exactly nine digits
237 The type of the file; may be set to any one of the following:
239 .Bl -tag -width Cm -compact
243 character special device
257 The default set of keywords are
268 There are four types of lines in a specification.
270 The first type of line sets a global value for a keyword, and consists of
271 the string ``/set'' followed by whitespace, followed by sets of keyword/value
272 pairs, separated by whitespace.
273 Keyword/value pairs consist of a keyword, followed by an equals sign
274 (``=''), followed by a value, without whitespace characters.
275 Once a keyword has been set, its value remains unchanged until either
278 The second type of line unsets keywords and consists of the string
279 ``/unset'', followed by whitespace, followed by one or more keywords,
280 separated by whitespace.
282 The third type of line is a file specification and consists of a file
283 name, followed by whitespace, followed by zero or more whitespace
284 separated keyword/value pairs.
285 The file name may be preceded by whitespace characters.
286 The file name may contain any of the standard file name matching
287 characters (``['', ``]'', ``?'' or ``*''), in which case files
288 in the hierarchy will be associated with the first pattern that
291 Each of the keyword/value pairs consist of a keyword, followed by an
292 equals sign (``=''), followed by the keyword's value, without
293 whitespace characters.
294 These values override, without changing, the global value of the
295 corresponding keyword.
297 All paths are relative.
298 Specifying a directory will cause subsequent files to be searched
299 for in that directory hierarchy.
300 Which brings us to the last type of line in a specification: a line
301 containing only the string
303 causes the current directory
304 path to ascend one level.
306 Empty lines and lines whose first non-whitespace character is a hash
307 mark (``#'') are ignored.
311 utility exits with a status of 0 on success, 1 if any error occurred,
312 and 2 if the file hierarchy did not match the specification.
313 A status of 2 is converted to a status of 0 if the
317 .Bl -tag -width /etc/mtree -compact
319 system specification directory
324 To detect system binaries that have been ``trojan horsed'', it is recommended
329 be run on the file systems, and a copy of the results stored on a different
330 machine, or, at least, in encrypted form.
331 The output file itself should be digested using the
338 should be run against the on-line specifications.
339 While it is possible for the bad guys to change the on-line specifications
340 to conform to their modified binaries, it is believed to be
341 impractical for them to create a modified specification which has
342 the same SHA-256 digest as the original.
348 options can be used in combination to create directory hierarchies
349 for distributions and other such things; the files in
351 were used to create almost all directories in this
357 style BSD.*.dist file, use
364 .Cm uname,gname,mode,nochange.
382 digest capability was added in
384 in response to the widespread use of programs which can spoof
390 digests were added in
392 as new attacks have demonstrated weaknesses in
398 Support for file flags was added in
400 and mostly comes from