BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.sbin / mtree / mtree.1

diff --git a/usr/src/usr.sbin/mtree/mtree.1 b/usr/src/usr.sbin/mtree/mtree.1
index 4a30d00..64fbb42 100644 (file)
--- a/usr/src/usr.sbin/mtree/mtree.1
+++ b/usr/src/usr.sbin/mtree/mtree.1
@@ -1,25 +1,39 @@
 .\" Copyright (c) 1989, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1989, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"     @(#)mtree.1    5.7 (Berkeley) 7/24/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.Dd July 24, 1990
+.\"     @(#)mtree.1    5.10 (Berkeley) 7/30/91
+.\"
+.Dd July 30, 1991

 .Dt MTREE 8
 .Dt MTREE 8

-.Os BSD 4.4
+.Os

 .Sh NAME
 .Nm mtree
 .Nd map a directory hierarchy
 .Sh NAME
 .Nm mtree
 .Nd map a directory hierarchy


@@ -29,7 +43,8 @@
 .Op Fl f Ar spec
 .Op Fl p Ar path
 .Sh DESCRIPTION
 .Op Fl f Ar spec
 .Op Fl p Ar path
 .Sh DESCRIPTION

-.Nm Mtree
+The utility
+.Nm mtree

 compares a directory hierarchy against a specification for a
 directory hierarchy.
 By default, the specification is read from the standard input.
 compares a directory hierarchy against a specification for a
 directory hierarchy.
 By default, the specification is read from the standard input.


@@ -42,31 +57,32 @@ characteristics do not match those of the specification, or which are
 missing from either the specification or the tree.
 .Pp
 The options are as follows:
 missing from either the specification or the tree.
 .Pp
 The options are as follows:

-.Tp Fl c
+.Bl -tag -width flag
+.It Fl c

 Print a specification for the tree to standard output.
 Print a specification for the tree to standard output.

-.Tp Fl d
+.It Fl d

 Ignore everything except directory type files.
 Ignore everything except directory type files.

-.Tp Fl e
+.It Fl e

 Don't object to files that are in the tree but not in the specification.
 Don't object to files that are in the tree but not in the specification.

-.Tp Fl f
+.It Fl f

 Read the specification from
 .Ar file  ,
 instead of from standard input.
 Read the specification from
 .Ar file  ,
 instead of from standard input.

-.Tp Fl p
+.It Fl p

 Traverse the tree rooted in
 .Ar path  ,
 instead of the current directory.
 Traverse the tree rooted in
 .Ar path  ,
 instead of the current directory.

-.Tp Fl r
+.It Fl r

 Remove any files in the tree that are not described in the
 specification.
 Remove any files in the tree that are not described in the
 specification.

-.Tp Fl u
+.It Fl u

 Modify the owner, group, and permissions of existing files to match
 the specification, as well as create any missing directories.
 Owner, group, and permissions must all be specified for missing
 directories to be created.
 Modify the owner, group, and permissions of existing files to match
 the specification, as well as create any missing directories.
 Owner, group, and permissions must all be specified for missing
 directories to be created.

-.Tp Fl x
+.It Fl x

 Don't descend below any mount points.
 Don't descend below any mount points.

-.Tp
+.El

 .Pp
 Specifications are mostly composed of ``keywords'', i.e. strings that
 that specify values relating to files.
 .Pp
 Specifications are mostly composed of ``keywords'', i.e. strings that
 that specify values relating to files.


@@ -74,48 +90,48 @@ No keywords have default values, and if a keyword has no set value no
 checks based on it are performed.
 .Pp
 Currently supported keywords are as follows:
 checks based on it are performed.
 .Pp
 Currently supported keywords are as follows:

-.Tw Cm
-.Tp Cm cksum
+.Bl -tag -width Cm
+.It Cm cksum

 The checksum of the file using the algorithm specified by
 the program
 .Xr cksum  1  .
 The checksum of the file using the algorithm specified by
 the program
 .Xr cksum  1  .

-.Tp Cm ignore
+.It Cm ignore

 Causes the hierarchy below the file to be ignored.
 Causes the hierarchy below the file to be ignored.

-.Tp Cm group
+.It Cm group

 The group of the file; may be either numeric or symbolic.
 The group of the file; may be either numeric or symbolic.

-.Tp Cm mode
+.It Cm mode

 The current file's permissions as an absolute (octal) or symbolic
 value (see
 .Xr chmod  1  ) .
 The current file's permissions as an absolute (octal) or symbolic
 value (see
 .Xr chmod  1  ) .

-.Tp Cm nlink
+.It Cm nlink

 The number of hard links the file is expected to have.
 The number of hard links the file is expected to have.

-.Tp Cm owner
+.It Cm owner

 The owner of the file; may be either numeric or symbolic.
 The owner of the file; may be either numeric or symbolic.

-.Tp Cm size
+.It Cm size

 The size, in bytes, of the file.
 The size, in bytes, of the file.

-.Tp Cm link
+.It Cm link

 The file a symbolic link is expected to reference.
 The file a symbolic link is expected to reference.

-.Tp Cm time
+.It Cm time

 The last modification time of the file.
 The last modification time of the file.

-.Tp Cm type
+.It Cm type

 The type of the file; may be set to any one of the following:
 The type of the file; may be set to any one of the following:

-.Tw Cm
-.Tp Cm block
+.Bl -tag -width Cm -compact
+.It Cm block

 block special device
 block special device

-.Tp Cm char
+.It Cm char

 character special device
 character special device

-.Tp Cm dir
+.It Cm dir

 directory
 directory

-.Tp Cm fifo
+.It Cm fifo

 fifo
 fifo

-.Tp Cm file
+.It Cm file

 regular file
 regular file

-.Tp Cm link
+.It Cm link

 symbolic link
 symbolic link

-.Tp Cm socket
+.It Cm socket

 socket
 socket

-.Tp
-.Tp
+.El
+.El

 .Pp
 There are four types of lines in a specification.
 .Pp
 .Pp
 There are four types of lines in a specification.
 .Pp


@@ -162,11 +178,10 @@ mark (``#'') are ignored.
 exits with a status of 0 on success and >0 if an error occurred or the
 tree did not match the specification.
 .Sh FILES
 exits with a status of 0 on success and >0 if an error occurred or the
 tree did not match the specification.
 .Sh FILES

-.Dw /etc/mtree
-.Di L
-.Dp Pa /etc/mtree
+.Bl -tag -width /etc/mtree -compact
+.It Pa /etc/mtree

 system specification directory
 system specification directory

-.Dp
+.El

 .Sh SEE ALSO
 .Xr chmod 1 ,
 .Xr chown 1 ,
 .Sh SEE ALSO
 .Xr chmod 1 ,
 .Xr chown 1 ,


@@ -185,11 +200,11 @@ The
 .Cm time
 keyword should be specifiable in human readable terms.
 .Sh EXAMPLE
 .Cm time
 keyword should be specifiable in human readable terms.
 .Sh EXAMPLE

-.Ds I
+.Bd -literal -offset indent -compact

 #        fs: /a/staff/rick/mybin
 #        by: rick
 #      date: Fri May 25 12:26:57 1990
 #        fs: /a/staff/rick/mybin
 #        by: rick
 #      date: Fri May 25 12:26:57 1990

-.sp
+

 /set group=staff mode=0555 nlink=1 owner=rick type=file
 [              nlink=2 size=6144
 adb            size=53248
 /set group=staff mode=0555 nlink=1 owner=rick type=file
 [              nlink=2 size=6144
 adb            size=53248


@@ -197,13 +212,16 @@ df                group=operator mode=02555 size=20480
 ps             group=kmem mode=02555 size=54272
 rcp            owner=root mode=04555 size=79872
 test           nlink=2 size=6144
 ps             group=kmem mode=02555 size=54272
 rcp            owner=root mode=04555 size=79872
 test           nlink=2 size=6144

-.sp
+

 /set group=wheel mode=0444 nlink=1 owner=rick type=file
 manpages       type=dir mode=0775 nlink=2 size=1024
 adb.man        size=9473
 df.man size=5263
 tar.man        size=3324
 \&..
 /set group=wheel mode=0444 nlink=1 owner=rick type=file
 manpages       type=dir mode=0775 nlink=2 size=1024
 adb.man        size=9473
 df.man size=5263
 tar.man        size=3324
 \&..

-.De
+.Ed

 .Sh HISTORY
 .Sh HISTORY

-4.3 Reno BSD.
+The
+.Nm mtree
+utility appeared in
+.Bx 4.3 Reno .