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 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
The first line of any mtree file must begin with
62
If a file contains any full path entries, the first line should
65
otherwise, the first line should begin with
68
Blank lines are ignored.
76
are special commands that influence
77
the interpretation of later lines.
79
If the first whitespace-delimited word has no
82
it is the name of a file in the current directory.
83
Any relative entry that describes a directory changes the
86
As a special case, a relative entry with the filename
88
changes the current directory to the parent directory.
89
Options on dot-dot entries are always ignored.
91
If the first whitespace-delimited word has a
94
the first character, it is the pathname of a file relative to the
96
There can be multiple full entries describing the same file.
99
Some tools that process
101
files may require that multiple lines describing the same file
103
It is not permitted for the same file to be mentioned using
104
both a relative and a full file specification.
106
Two special commands are currently defined:
109
This command defines default values for one or more keywords.
110
It is followed on the same line by one or more whitespace-separated
112
These definitions apply to all following files that do not specify
113
a value for that keyword.
115
This command removes any default value set by a previous
118
It is followed on the same line by one or more keywords
119
separated by whitespace.
122
After the filename, a full or relative entry consists of zero
123
or more whitespace-separated keyword definitions.
124
Each such definition consists of a key from the following
125
list immediately followed by an '=' sign
127
Software programs reading mtree files should warn about
128
unrecognized keywords.
130
Currently supported keywords are as follows:
133
The checksum of the file using the default algorithm specified by
138
The full pathname of a file that holds the contents of this file.
140
The file flags as a symbolic name.
143
for information on these names.
144
If no flags are to be set the string
146
may be used to override the current default.
148
The file group as a numeric value.
150
The file group as a symbolic name.
152
Ignore any file hierarchy below this file.
154
The target of the symbolic link when type=link.
156
The MD5 message digest of the file.
161
The current file's permissions as a numeric (octal) or symbolic
164
The number of hard links the file is expected to have.
166
Make sure this file or directory exists but otherwise ignore all attributes.
167
.It Cm ripemd160digest
170
message digest of the file.
173
.Cm ripemd160digest .
176
.Cm ripemd160digest .
182
message digest of the file.
191
message digest of the file.
196
The size, in bytes, of the file.
198
The last modification time of the file.
200
The type of the file; may be set to any one of the following:
202
.Bl -tag -width Cm -compact
206
character special device
219
The file owner as a numeric value.
221
The file owner as a symbolic name.
231
implementation of mtree does not currently support
236
The requirement for a
238
signature line is new and not yet widely implemented.
246
digest capability was added in
248
in response to the widespread use of programs which can spoof
254
digests were added in
256
as new attacks have demonstrated weaknesses in
262
Support for file flags was added in
264
and mostly comes from
268
entry format was added by