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
29 .\" $FreeBSD: src/usr.sbin/mtree/mtree.8,v 1.16.2.11 2003/03/11 22:31:29 trhodes Exp $
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 Don't follow symbolic links in the file hierarchy, instead consider
73 the symbolic link itself in any comparisons. This is the default.
75 Modify the owner, group and permissions of existing files to match
76 the specification and create any missing directories or symbolic links.
77 User, group and permissions must all be specified for missing directories
79 Corrected mismatches are not considered errors.
81 Print a specification for the file hierarchy to the standard output.
83 Ignore everything except directory type files.
85 Don't complain about files that are in the file hierarchy, but not in the
88 Indent the output 4 spaces each time a directory level is descended when
89 create a specification with the
92 This does not affect either the /set statements or the comment before each
94 It does however affect the comment before the close of each directory.
96 Do not emit pathname comments when creating a specification. Normally
97 a comment is emitted before each directory and before the close of that
98 directory when using the
102 Quiet mode. Do not complain when a
104 directory cannot be created because it already exists.
105 This occurs when the directory is a symbolic link.
107 Remove any files in the file hierarchy that are not described in the
112 except a status of 2 is returned if the file hierarchy did not match
115 Don't descend below mount points in the file hierarchy.
117 Read the specification from
119 instead of from the standard input.
121 Add the specified (whitespace or comma separated)
123 to the current set of keywords.
125 Use the ``type'' keyword plus the specified (whitespace or comma separated)
127 instead of the current set of keywords.
129 Use the file hierarchy rooted in
131 instead of the current directory.
133 Display a single checksum to the standard error output that represents all
134 of the files for which the keyword
137 The checksum is seeded with the specified value.
138 .It Fl X Ar exclude-list
139 The specified file contains
141 patterns matching files to be excluded from
142 the specification, one to a line.
143 If the pattern contains a
145 character, it will be matched against entire pathnames (relative to
146 the starting directory); otherwise,
147 it will be matched against basenames only. No comments are allowed in
153 Specifications are mostly composed of ``keywords'', i.e. strings
154 that specify values relating to files.
155 No keywords have default values, and if a keyword has no value set, no
156 checks based on it are performed.
158 Currently supported keywords are as follows:
161 The checksum of the file using the default algorithm specified by
166 The file flags as a symbolic name. See
168 for information on these names. If no flags are to be set the string
170 may be used to override the current default.
172 Ignore any file hierarchy below this file.
174 The file group as a numeric value.
176 The file group as a symbolic name.
178 The MD5 message digest of the file.
184 message digest of the file.
185 .It Cm ripemd160digest
188 message digest of the file.
190 The current file's permissions as a numeric (octal) or symbolic
193 The number of hard links the file is expected to have.
195 Make sure this file or directory exists but otherwise ignore all attributes.
197 The file owner as a numeric value.
199 The file owner as a symbolic name.
201 The size, in bytes, of the file.
203 The file the symbolic link is expected to reference.
205 The last modification time of the file.
207 The type of the file; may be set to any one of the following:
209 .Bl -tag -width Cm -compact
213 character special device
227 The default set of keywords are
238 There are four types of lines in a specification.
240 The first type of line sets a global value for a keyword, and consists of
241 the string ``/set'' followed by whitespace, followed by sets of keyword/value
242 pairs, separated by whitespace.
243 Keyword/value pairs consist of a keyword, followed by an equals sign
244 (``=''), followed by a value, without whitespace characters.
245 Once a keyword has been set, its value remains unchanged until either
248 The second type of line unsets keywords and consists of the string
249 ``/unset'', followed by whitespace, followed by one or more keywords,
250 separated by whitespace.
252 The third type of line is a file specification and consists of a file
253 name, followed by whitespace, followed by zero or more whitespace
254 separated keyword/value pairs.
255 The file name may be preceded by whitespace characters.
256 The file name may contain any of the standard file name matching
257 characters (``['', ``]'', ``?'' or ``*''), in which case files
258 in the hierarchy will be associated with the first pattern that
261 Each of the keyword/value pairs consist of a keyword, followed by an
262 equals sign (``=''), followed by the keyword's value, without
263 whitespace characters.
264 These values override, without changing, the global value of the
265 corresponding keyword.
267 All paths are relative.
268 Specifying a directory will cause subsequent files to be searched
269 for in that directory hierarchy.
270 Which brings us to the last type of line in a specification: a line
271 containing only the string
273 causes the current directory
274 path to ascend one level.
276 Empty lines and lines whose first non-whitespace character is a hash
277 mark (``#'') are ignored.
281 utility exits with a status of 0 on success, 1 if any error occurred,
282 and 2 if the file hierarchy did not match the specification.
283 A status of 2 is converted to a status of 0 if the
287 .Bl -tag -width /etc/mtree -compact
289 system specification directory
294 To detect system binaries that have been ``trojan horsed'', it is recommended
299 be run on the file systems, and a copy of the results stored on a different
300 machine, or, at least, in encrypted form.
301 The output file itself should be digested using the
308 should be run against the on-line specifications.
309 While it is possible for the bad guys to change the on-line specifications
310 to conform to their modified binaries, it is believed to be
311 impractical for them to create a modified specification which has
312 the same MD5 digest as the original.
318 options can be used in combination to create directory hierarchies
319 for distributions and other such things; the files in
321 were used to create almost all directories in this
327 style BSD.*.dist file, use
334 .Cm uname,gname,mode,nochange .
352 digest capability was added in
354 in response to the widespread use of programs which can spoof
360 digests were added in
362 as new attacks have demonstrated weaknesses in
364 Support for file flags was added in
366 and mostly comes from