Blame doc/html/mtree.5.html

Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348
"http://www.w3.org/TR/html4/loose.dtd">
Packit Service 1d0348
<html>
Packit Service 1d0348
<head>
Packit Service 1d0348
<meta name="generator" content="groff -Thtml, see www.gnu.org">
Packit Service 1d0348
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
Packit Service 1d0348
<meta name="Content-Style" content="text/css">
Packit Service 1d0348
<style type="text/css">
Packit Service 1d0348
       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
Packit Service 1d0348
       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
Packit Service 1d0348
       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
Packit Service 1d0348
       h1      { text-align: center }
Packit Service 1d0348
</style>
Packit Service 1d0348
<title></title>
Packit Service 1d0348
</head>
Packit Service 1d0348
<body>
Packit Service 1d0348
Packit Service 1d0348

Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348

MTREE(5) BSD File Formats Manual MTREE(5)

Packit Service 1d0348
Packit Service 1d0348

NAME

Packit Service 1d0348
Packit Service 1d0348

mtree — format of

Packit Service 1d0348
mtree dir hierarchy files

Packit Service 1d0348
Packit Service 1d0348

DESCRIPTION

Packit Service 1d0348
Packit Service 1d0348

The mtree format is a

Packit Service 1d0348
textual format that describes a collection of filesystem
Packit Service 1d0348
objects. Such files are typically used to create or verify
Packit Service 1d0348
directory hierarchies.

Packit Service 1d0348
Packit Service 1d0348

General

Packit Service 1d0348
Format 
Packit Service 1d0348
An mtree file consists of a series of lines, each
Packit Service 1d0348
providing information about a single filesystem object.
Packit Service 1d0348
Leading whitespace is always ignored.

Packit Service 1d0348
Packit Service 1d0348

When encoding

Packit Service 1d0348
file or pathnames, any backslash character or character
Packit Service 1d0348
outside of the 95 printable ASCII characters must be encoded
Packit Service 1d0348
as a backslash followed by three octal digits. When reading
Packit Service 1d0348
mtree files, any appearance of a backslash followed by three
Packit Service 1d0348
octal digits should be converted into the corresponding
Packit Service 1d0348
character.

Packit Service 1d0348
Packit Service 1d0348

Each line is

Packit Service 1d0348
interpreted independently as one of the following types:

Packit Service 1d0348
Packit Service 1d0348

Blank

Packit Service 1d0348
Packit Service 1d0348

Blank lines are

Packit Service 1d0348
ignored.

Packit Service 1d0348
Packit Service 1d0348

Comment

Packit Service 1d0348
Packit Service 1d0348

Lines beginning

Packit Service 1d0348
with # are ignored.

Packit Service 1d0348
Packit Service 1d0348

Special

Packit Service 1d0348
Packit Service 1d0348

Lines beginning

Packit Service 1d0348
with / are special commands that influence the
Packit Service 1d0348
interpretation of later lines.

Packit Service 1d0348
Packit Service 1d0348

Relative

Packit Service 1d0348
Packit Service 1d0348

If the first

Packit Service 1d0348
whitespace-delimited word has no / characters, it is
Packit Service 1d0348
the name of a file in the current directory. Any relative
Packit Service 1d0348
entry that describes a directory changes the current
Packit Service 1d0348
directory.

Packit Service 1d0348
Packit Service 1d0348

dot-dot

Packit Service 1d0348
Packit Service 1d0348

As a special

Packit Service 1d0348
case, a relative entry with the filename .. changes
Packit Service 1d0348
the current directory to the parent directory. Options on
Packit Service 1d0348
dot-dot entries are always ignored.

Packit Service 1d0348
Packit Service 1d0348

Full

Packit Service 1d0348
Packit Service 1d0348

If the first

Packit Service 1d0348
whitespace-delimited word has a / character after the
Packit Service 1d0348
first character, it is the pathname of a file relative to
Packit Service 1d0348
the starting directory. There can be multiple full entries
Packit Service 1d0348
describing the same file.

Packit Service 1d0348
Packit Service 1d0348

Some tools that

Packit Service 1d0348
process mtree files may require that multiple lines
Packit Service 1d0348
describing the same file occur consecutively. It is not
Packit Service 1d0348
permitted for the same file to be mentioned using both a
Packit Service 1d0348
relative and a full file specification.

Packit Service 1d0348
Packit Service 1d0348

Special

Packit Service 1d0348
commands 
Packit Service 1d0348
Two special commands are currently defined:

Packit Service 1d0348
Packit Service 1d0348

/set

Packit Service 1d0348
Packit Service 1d0348

This command

Packit Service 1d0348
defines default values for one or more keywords. It is
Packit Service 1d0348
followed on the same line by one or more
Packit Service 1d0348
whitespace-separated keyword definitions. These definitions
Packit Service 1d0348
apply to all following files that do not specify a value for
Packit Service 1d0348
that keyword.

Packit Service 1d0348
Packit Service 1d0348

/unset

Packit Service 1d0348
Packit Service 1d0348

This command

Packit Service 1d0348
removes any default value set by a previous /set
Packit Service 1d0348
command. It is followed on the same line by one or more
Packit Service 1d0348
keywords separated by whitespace.

Packit Service 1d0348
Packit Service 1d0348

Keywords

Packit Service 1d0348

Packit Service 1d0348
After the filename, a full or relative entry consists of
Packit Service 1d0348
zero or more whitespace-separated keyword definitions. Each
Packit Service 1d0348
such definition consists of a key from the following list
Packit Service 1d0348
immediately followed by an ’=’ sign and a value.
Packit Service 1d0348
Software programs reading mtree files should warn about
Packit Service 1d0348
unrecognized keywords.

Packit Service 1d0348
Packit Service 1d0348

Currently

Packit Service 1d0348
supported keywords are as follows:

Packit Service 1d0348
Packit Service 1d0348

cksum

Packit Service 1d0348
Packit Service 1d0348

The checksum of

Packit Service 1d0348
the file using the default algorithm specified by the
Packit Service 1d0348
cksum(1) utility.

Packit Service 1d0348
Packit Service 1d0348

device

Packit Service 1d0348
Packit Service 1d0348

The device

Packit Service 1d0348
number for block or char file types. The value
Packit Service 1d0348
must be one of the following forms:

Packit Service 1d0348
Packit Service 1d0348
Packit Service 1d0348

format,major,minor[

Packit Service 1d0348

Packit Service 1d0348
,subunit]

Packit Service 1d0348
Packit Service 1d0348

A device with major,

Packit Service 1d0348
minor and optional subunit fields. Their
Packit Service 1d0348
meaning is specified by the operating’s system
Packit Service 1d0348
format. See below for valid formats.

Packit Service 1d0348
Packit Service 1d0348

number

Packit Service 1d0348
Packit Service 1d0348

Opaque number (as stored on the

Packit Service 1d0348
file system).

Packit Service 1d0348
Packit Service 1d0348

The following

Packit Service 1d0348
values for format are recognized: native,
Packit Service 1d0348
386bsd, 4bsd, bsdos, freebsd,
Packit Service 1d0348
hpux, isc, linux, netbsd,
Packit Service 1d0348
osf1, sco, solaris, sunos,
Packit Service 1d0348
svr3, svr4, and ultrix.

Packit Service 1d0348
Packit Service 1d0348

See mknod(8)

Packit Service 1d0348
for more details.

Packit Service 1d0348
Packit Service 1d0348

contents

Packit Service 1d0348
Packit Service 1d0348

The full

Packit Service 1d0348
pathname of a file that holds the contents of this file.

Packit Service 1d0348
Packit Service 1d0348

flags

Packit Service 1d0348
Packit Service 1d0348

The file flags

Packit Service 1d0348
as a symbolic name. See chflags(1) for information on these
Packit Service 1d0348
names. If no flags are to be set the string
Packit Service 1d0348
’’none’’ may be used to override the
Packit Service 1d0348
current default.

Packit Service 1d0348
Packit Service 1d0348

gid

Packit Service 1d0348
Packit Service 1d0348

The file group

Packit Service 1d0348
as a numeric value.

Packit Service 1d0348
Packit Service 1d0348

gname

Packit Service 1d0348
Packit Service 1d0348

The file group

Packit Service 1d0348
as a symbolic name.

Packit Service 1d0348
Packit Service 1d0348

ignore

Packit Service 1d0348
Packit Service 1d0348

Ignore any file

Packit Service 1d0348
hierarchy below this file.

Packit Service 1d0348
Packit Service 1d0348

inode

Packit Service 1d0348
Packit Service 1d0348

The inode

Packit Service 1d0348
number.

Packit Service 1d0348
Packit Service 1d0348

link

Packit Service 1d0348
Packit Service 1d0348

The target of

Packit Service 1d0348
the symbolic link when type=link.

Packit Service 1d0348
Packit Service 1d0348

md5

Packit Service 1d0348
Packit Service 1d0348

The MD5 message

Packit Service 1d0348
digest of the file.

Packit Service 1d0348
Packit Service 1d0348

md5digest

Packit Service 1d0348
Packit Service 1d0348

A synonym for

Packit Service 1d0348
md5.

Packit Service 1d0348
Packit Service 1d0348

mode

Packit Service 1d0348
Packit Service 1d0348

The current

Packit Service 1d0348
file’s permissions as a numeric (octal) or symbolic
Packit Service 1d0348
value.

Packit Service 1d0348
Packit Service 1d0348

nlink

Packit Service 1d0348
Packit Service 1d0348

The number of

Packit Service 1d0348
hard links the file is expected to have.

Packit Service 1d0348
Packit Service 1d0348

nochange

Packit Service 1d0348
Packit Service 1d0348

Make sure this

Packit Service 1d0348
file or directory exists but otherwise ignore all
Packit Service 1d0348
attributes.

Packit Service 1d0348
Packit Service 1d0348

optional

Packit Service 1d0348
Packit Service 1d0348

The file is

Packit Service 1d0348
optional; do not complain about the file if it is not in the
Packit Service 1d0348
file hierarchy.

Packit Service 1d0348
Packit Service 1d0348

resdevice

Packit Service 1d0348
Packit Service 1d0348

The

Packit Service 1d0348
’’resident’’ device number of the
Packit Service 1d0348
file, e.g. the ID of the device that contains the file. Its
Packit Service 1d0348
format is the same as the one for device.

Packit Service 1d0348
Packit Service 1d0348

ripemd160digest

Packit Service 1d0348
Packit Service 1d0348

The RIPEMD160 message digest of

Packit Service 1d0348
the file.

Packit Service 1d0348
Packit Service 1d0348

rmd160

Packit Service 1d0348
Packit Service 1d0348

A synonym for

Packit Service 1d0348
ripemd160digest.

Packit Service 1d0348
Packit Service 1d0348

rmd160digest

Packit Service 1d0348
Packit Service 1d0348

A synonym for

Packit Service 1d0348
ripemd160digest.

Packit Service 1d0348
Packit Service 1d0348

sha1

Packit Service 1d0348
Packit Service 1d0348

The FIPS 160-1

Packit Service 1d0348
(’’SHA-1’’) message digest of the
Packit Service 1d0348
file.

Packit Service 1d0348
Packit Service 1d0348

sha1digest

Packit Service 1d0348
Packit Service 1d0348

A synonym for

Packit Service 1d0348
sha1.

Packit Service 1d0348
Packit Service 1d0348

sha256

Packit Service 1d0348
Packit Service 1d0348

The FIPS 180-2

Packit Service 1d0348
(’’SHA-256’’) message digest of the
Packit Service 1d0348
file.

Packit Service 1d0348
Packit Service 1d0348

sha256digest

Packit Service 1d0348
Packit Service 1d0348

A synonym for

Packit Service 1d0348
sha256.

Packit Service 1d0348
Packit Service 1d0348

sha384

Packit Service 1d0348
Packit Service 1d0348

The FIPS 180-2

Packit Service 1d0348
(’’SHA-384’’) message digest of the
Packit Service 1d0348
file.

Packit Service 1d0348
Packit Service 1d0348

sha384digest

Packit Service 1d0348
Packit Service 1d0348

A synonym for

Packit Service 1d0348
sha384.

Packit Service 1d0348
Packit Service 1d0348

sha512

Packit Service 1d0348
Packit Service 1d0348

The FIPS 180-2

Packit Service 1d0348
(’’SHA-512’’) message digest of the
Packit Service 1d0348
file.

Packit Service 1d0348
Packit Service 1d0348

sha512digest

Packit Service 1d0348
Packit Service 1d0348

A synonym for

Packit Service 1d0348
sha512.

Packit Service 1d0348
Packit Service 1d0348

size

Packit Service 1d0348
Packit Service 1d0348

The size, in

Packit Service 1d0348
bytes, of the file.

Packit Service 1d0348
Packit Service 1d0348

time

Packit Service 1d0348
Packit Service 1d0348

The last

Packit Service 1d0348
modification time of the file.

Packit Service 1d0348
Packit Service 1d0348

type

Packit Service 1d0348
Packit Service 1d0348

The type of the

Packit Service 1d0348
file; may be set to any one of the following:

Packit Service 1d0348
Packit Service 1d0348

block

Packit Service 1d0348
Packit Service 1d0348

block special

Packit Service 1d0348
device

Packit Service 1d0348
Packit Service 1d0348

char

Packit Service 1d0348
Packit Service 1d0348

character

Packit Service 1d0348
special device

Packit Service 1d0348
Packit Service 1d0348

dir

Packit Service 1d0348
Packit Service 1d0348

directory

Packit Service 1d0348
Packit Service 1d0348

fifo

Packit Service 1d0348
Packit Service 1d0348

fifo

Packit Service 1d0348
Packit Service 1d0348

file

Packit Service 1d0348
Packit Service 1d0348

regular

Packit Service 1d0348
file

Packit Service 1d0348
Packit Service 1d0348

link

Packit Service 1d0348
Packit Service 1d0348

symbolic

Packit Service 1d0348
link

Packit Service 1d0348
Packit Service 1d0348

socket

Packit Service 1d0348
Packit Service 1d0348

socket

Packit Service 1d0348
Packit Service 1d0348

uid

Packit Service 1d0348
Packit Service 1d0348

The file owner

Packit Service 1d0348
as a numeric value.

Packit Service 1d0348
Packit Service 1d0348

uname

Packit Service 1d0348
Packit Service 1d0348

The file owner

Packit Service 1d0348
as a symbolic name.

Packit Service 1d0348
Packit Service 1d0348

SEE ALSO

Packit Service 1d0348
Packit Service 1d0348

cksum(1), find(1), mtree(8)

Packit Service 1d0348
Packit Service 1d0348

BUGS

Packit Service 1d0348
HISTORY

Packit Service 1d0348
Packit Service 1d0348

The mtree utility

Packit Service 1d0348
appeared in 4.3BSD-Reno. The MD5 digest capability was added
Packit Service 1d0348
in FreeBSD 2.1, in response to the widespread use of
Packit Service 1d0348
programs which can spoof cksum(1). The SHA-1 and RIPEMD160
Packit Service 1d0348
digests were added in FreeBSD 4.0, as new attacks have
Packit Service 1d0348
demonstrated weaknesses in MD5. The SHA-256 digest was added
Packit Service 1d0348
in FreeBSD 6.0. Support for file flags was added in
Packit Service 1d0348
FreeBSD 4.0, and mostly comes from NetBSD. The
Packit Service 1d0348
’’full’’ entry format was added by
Packit Service 1d0348
NetBSD.

Packit Service 1d0348
Packit Service 1d0348

BSD

Packit Service 1d0348
September 4, 2013 BSD

Packit Service 1d0348

Packit Service 1d0348
</body>
Packit Service 1d0348
</html>