Blame doc/html/mtree.5.html

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

Packit 08bd4c
Packit 08bd4c
Packit 08bd4c

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

Packit 08bd4c
Packit 08bd4c

NAME

Packit 08bd4c
Packit 08bd4c

mtree — format of

Packit 08bd4c
mtree dir hierarchy files

Packit 08bd4c
Packit 08bd4c

DESCRIPTION

Packit 08bd4c
Packit 08bd4c

The mtree format is a

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

Packit 08bd4c
Packit 08bd4c

General

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

Packit 08bd4c
Packit 08bd4c

When encoding

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

Packit 08bd4c
Packit 08bd4c

Each line is

Packit 08bd4c
interpreted independently as one of the following types:

Packit 08bd4c
Packit 08bd4c

Blank

Packit 08bd4c
Packit 08bd4c

Blank lines are

Packit 08bd4c
ignored.

Packit 08bd4c
Packit 08bd4c

Comment

Packit 08bd4c
Packit 08bd4c

Lines beginning

Packit 08bd4c
with # are ignored.

Packit 08bd4c
Packit 08bd4c

Special

Packit 08bd4c
Packit 08bd4c

Lines beginning

Packit 08bd4c
with / are special commands that influence the
Packit 08bd4c
interpretation of later lines.

Packit 08bd4c
Packit 08bd4c

Relative

Packit 08bd4c
Packit 08bd4c

If the first

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

Packit 08bd4c
Packit 08bd4c

dot-dot

Packit 08bd4c
Packit 08bd4c

As a special

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

Packit 08bd4c
Packit 08bd4c

Full

Packit 08bd4c
Packit 08bd4c

If the first

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

Packit 08bd4c
Packit 08bd4c

Some tools that

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

Packit 08bd4c
Packit 08bd4c

Special

Packit 08bd4c
commands 
Packit 08bd4c
Two special commands are currently defined:

Packit 08bd4c
Packit 08bd4c

/set

Packit 08bd4c
Packit 08bd4c

This command

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

Packit 08bd4c
Packit 08bd4c

/unset

Packit 08bd4c
Packit 08bd4c

This command

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

Packit 08bd4c
Packit 08bd4c

Keywords

Packit 08bd4c

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

Packit 08bd4c
Packit 08bd4c

Currently

Packit 08bd4c
supported keywords are as follows:

Packit 08bd4c
Packit 08bd4c

cksum

Packit 08bd4c
Packit 08bd4c

The checksum of

Packit 08bd4c
the file using the default algorithm specified by the
Packit 08bd4c
cksum(1) utility.

Packit 08bd4c
Packit 08bd4c

device

Packit 08bd4c
Packit 08bd4c

The device

Packit 08bd4c
number for block or char file types. The value
Packit 08bd4c
must be one of the following forms:

Packit 08bd4c
Packit 08bd4c
Packit 08bd4c

format,major,minor[

Packit 08bd4c

Packit 08bd4c
,subunit]

Packit 08bd4c
Packit 08bd4c

A device with major,

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

Packit 08bd4c
Packit 08bd4c

number

Packit 08bd4c
Packit 08bd4c

Opaque number (as stored on the

Packit 08bd4c
file system).

Packit 08bd4c
Packit 08bd4c

The following

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

Packit 08bd4c
Packit 08bd4c

See mknod(8)

Packit 08bd4c
for more details.

Packit 08bd4c
Packit 08bd4c

contents

Packit 08bd4c
Packit 08bd4c

The full

Packit 08bd4c
pathname of a file that holds the contents of this file.

Packit 08bd4c
Packit 08bd4c

flags

Packit 08bd4c
Packit 08bd4c

The file flags

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

Packit 08bd4c
Packit 08bd4c

gid

Packit 08bd4c
Packit 08bd4c

The file group

Packit 08bd4c
as a numeric value.

Packit 08bd4c
Packit 08bd4c

gname

Packit 08bd4c
Packit 08bd4c

The file group

Packit 08bd4c
as a symbolic name.

Packit 08bd4c
Packit 08bd4c

ignore

Packit 08bd4c
Packit 08bd4c

Ignore any file

Packit 08bd4c
hierarchy below this file.

Packit 08bd4c
Packit 08bd4c

inode

Packit 08bd4c
Packit 08bd4c

The inode

Packit 08bd4c
number.

Packit 08bd4c
Packit 08bd4c

link

Packit 08bd4c
Packit 08bd4c

The target of

Packit 08bd4c
the symbolic link when type=link.

Packit 08bd4c
Packit 08bd4c

md5

Packit 08bd4c
Packit 08bd4c

The MD5 message

Packit 08bd4c
digest of the file.

Packit 08bd4c
Packit 08bd4c

md5digest

Packit 08bd4c
Packit 08bd4c

A synonym for

Packit 08bd4c
md5.

Packit 08bd4c
Packit 08bd4c

mode

Packit 08bd4c
Packit 08bd4c

The current

Packit 08bd4c
file’s permissions as a numeric (octal) or symbolic
Packit 08bd4c
value.

Packit 08bd4c
Packit 08bd4c

nlink

Packit 08bd4c
Packit 08bd4c

The number of

Packit 08bd4c
hard links the file is expected to have.

Packit 08bd4c
Packit 08bd4c

nochange

Packit 08bd4c
Packit 08bd4c

Make sure this

Packit 08bd4c
file or directory exists but otherwise ignore all
Packit 08bd4c
attributes.

Packit 08bd4c
Packit 08bd4c

optional

Packit 08bd4c
Packit 08bd4c

The file is

Packit 08bd4c
optional; do not complain about the file if it is not in the
Packit 08bd4c
file hierarchy.

Packit 08bd4c
Packit 08bd4c

resdevice

Packit 08bd4c
Packit 08bd4c

The

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

Packit 08bd4c
Packit 08bd4c

ripemd160digest

Packit 08bd4c
Packit 08bd4c

The RIPEMD160 message digest of

Packit 08bd4c
the file.

Packit 08bd4c
Packit 08bd4c

rmd160

Packit 08bd4c
Packit 08bd4c

A synonym for

Packit 08bd4c
ripemd160digest.

Packit 08bd4c
Packit 08bd4c

rmd160digest

Packit 08bd4c
Packit 08bd4c

A synonym for

Packit 08bd4c
ripemd160digest.

Packit 08bd4c
Packit 08bd4c

sha1

Packit 08bd4c
Packit 08bd4c

The FIPS 160-1

Packit 08bd4c
(’’SHA-1’’) message digest of the
Packit 08bd4c
file.

Packit 08bd4c
Packit 08bd4c

sha1digest

Packit 08bd4c
Packit 08bd4c

A synonym for

Packit 08bd4c
sha1.

Packit 08bd4c
Packit 08bd4c

sha256

Packit 08bd4c
Packit 08bd4c

The FIPS 180-2

Packit 08bd4c
(’’SHA-256’’) message digest of the
Packit 08bd4c
file.

Packit 08bd4c
Packit 08bd4c

sha256digest

Packit 08bd4c
Packit 08bd4c

A synonym for

Packit 08bd4c
sha256.

Packit 08bd4c
Packit 08bd4c

sha384

Packit 08bd4c
Packit 08bd4c

The FIPS 180-2

Packit 08bd4c
(’’SHA-384’’) message digest of the
Packit 08bd4c
file.

Packit 08bd4c
Packit 08bd4c

sha384digest

Packit 08bd4c
Packit 08bd4c

A synonym for

Packit 08bd4c
sha384.

Packit 08bd4c
Packit 08bd4c

sha512

Packit 08bd4c
Packit 08bd4c

The FIPS 180-2

Packit 08bd4c
(’’SHA-512’’) message digest of the
Packit 08bd4c
file.

Packit 08bd4c
Packit 08bd4c

sha512digest

Packit 08bd4c
Packit 08bd4c

A synonym for

Packit 08bd4c
sha512.

Packit 08bd4c
Packit 08bd4c

size

Packit 08bd4c
Packit 08bd4c

The size, in

Packit 08bd4c
bytes, of the file.

Packit 08bd4c
Packit 08bd4c

time

Packit 08bd4c
Packit 08bd4c

The last

Packit 08bd4c
modification time of the file.

Packit 08bd4c
Packit 08bd4c

type

Packit 08bd4c
Packit 08bd4c

The type of the

Packit 08bd4c
file; may be set to any one of the following:

Packit 08bd4c
Packit 08bd4c

block

Packit 08bd4c
Packit 08bd4c

block special

Packit 08bd4c
device

Packit 08bd4c
Packit 08bd4c

char

Packit 08bd4c
Packit 08bd4c

character

Packit 08bd4c
special device

Packit 08bd4c
Packit 08bd4c

dir

Packit 08bd4c
Packit 08bd4c

directory

Packit 08bd4c
Packit 08bd4c

fifo

Packit 08bd4c
Packit 08bd4c

fifo

Packit 08bd4c
Packit 08bd4c

file

Packit 08bd4c
Packit 08bd4c

regular

Packit 08bd4c
file

Packit 08bd4c
Packit 08bd4c

link

Packit 08bd4c
Packit 08bd4c

symbolic

Packit 08bd4c
link

Packit 08bd4c
Packit 08bd4c

socket

Packit 08bd4c
Packit 08bd4c

socket

Packit 08bd4c
Packit 08bd4c

uid

Packit 08bd4c
Packit 08bd4c

The file owner

Packit 08bd4c
as a numeric value.

Packit 08bd4c
Packit 08bd4c

uname

Packit 08bd4c
Packit 08bd4c

The file owner

Packit 08bd4c
as a symbolic name.

Packit 08bd4c
Packit 08bd4c

SEE ALSO

Packit 08bd4c
Packit 08bd4c

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

Packit 08bd4c
Packit 08bd4c

BUGS

Packit 08bd4c
HISTORY

Packit 08bd4c
Packit 08bd4c

The mtree utility

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

Packit 08bd4c
Packit 08bd4c

BSD

Packit 08bd4c
September 4, 2013 BSD

Packit 08bd4c

Packit 08bd4c
</body>
Packit 08bd4c
</html>