converted man page

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

diff --git a/usr/src/usr.sbin/mtree/mtree.8 b/usr/src/usr.sbin/mtree/mtree.8
index 70dfd14..612b848 100644 (file)
--- a/usr/src/usr.sbin/mtree/mtree.8
+++ b/usr/src/usr.sbin/mtree/mtree.8
@@ -1,133 +1,112 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1990 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"
 .\" All rights reserved.
 .\"
 .\" %sccs.include.redist.man%
 .\"

-.\"    @(#)mtree.8     5.5 (Berkeley) %G%
+.\"     @(#)mtree.8    5.6 (Berkeley) %G%

 .\"
 .\"

-.TH MTREE 8 ""
-.UC 7
-.SH NAME
-mtree \- map a directory hierarchy
-.SH SYNOPSIS
-.nf
-.ft B
-mtree [ \-cderux ] [ \-f spec ] [ \-p path ]
-.ft R
-.fi
-.SH DESCRIPTION
-.I Mtree
+.Dd 
+.Dt MTREE 8
+.Os BSD 4.4
+.Sh NAME
+.Nm mtree
+.Nd map a directory hierarchy
+.Sh SYNOPSIS
+.Nm mtree
+.Op Fl cderux
+.Op Fl f Ar spec
+.Op Fl p Ar path
+.Sh DESCRIPTION
+.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.

-.I Mtree
+.Nm Mtree

 verifies that the tree rooted in the current directory matches the
 specification.
 verifies that the tree rooted in the current directory matches the
 specification.

-.PP
+.Pp

 Messages are written to standard output for any files whose
 characteristics do not match those of the specification, or which are
 missing from either the specification or the tree.
 Messages are written to standard output for any files whose
 characteristics do not match those of the specification, or which are
 missing from either the specification or the tree.

-.PP
+.Pp

 The options are as follows:
 The options are as follows:

-.TP
-\-c
+.Tp Fl c

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

-.TP
-\-d
+.Tp Fl d

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

-.TP
-\-e
+.Tp 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
-\-f
+.Tp Fl f

 Read the specification from
 Read the specification from

-.IR file ,
+.Ar file  ,

 instead of from standard input.
 instead of from standard input.

-.TP
-\-p
+.Tp Fl p

 Traverse the tree rooted in
 Traverse the tree rooted in

-.IR path ,
+.Ar path  ,

 instead of the current directory.
 instead of the current directory.

-.TP
-\-r
+.Tp 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
-\-u
+.Tp 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
-\-x
+.Tp Fl x

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

-.PP
+.Tp
+.Pp

 Specifications are mostly composed of ``keywords'', i.e. strings that
 that specify values relating to files.
 No keywords have default values, and if a keyword has no set value no
 checks based on it are performed.
 Specifications are mostly composed of ``keywords'', i.e. strings that
 that specify values relating to files.
 No keywords have default values, and if a keyword has no set value no
 checks based on it are performed.

-.PP
+.Pp

 Currently supported keywords are as follows:
 Currently supported keywords are as follows:

-.TP
-.B cksum
+.Tw Cm
+.Tp Cm cksum

 The checksum of the file using the algorithm specified by
 the program
 The checksum of the file using the algorithm specified by
 the program

-.IR cksum (1).
-.TP
-.B ignore
+.Xr cksum  1  .
+.Tp Cm ignore

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

-.TP
-.B group
+.Tp 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
-.B mode
+.Tp Cm mode

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

-.IR chmod (1)).
-.TP
-.B nlink
+.Xr chmod  1  ) .
+.Tp 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
-.B owner
+.Tp 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
-.B size
+.Tp Cm size

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

-.TP
-.B link
+.Tp Cm link

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

-.TP
-.B time
+.Tp Cm time

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

-.TP
-.B type
+.Tp 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:

-.RS
-.TP
-.B block
+.Tw Cm
+.Tp Tp Cm block

 block special device
 block special device

-.TP
-.B char
+.Tp Cm char

 character special device
 character special device

-.TP
-.B dir
+.Tp Cm dir

 directory
 directory

-.TP
-.B fifo
+.Tp Cm fifo

 fifo
 fifo

-.TP
-.B file
+.Tp Cm file

 regular file
 regular file

-.TP
-.B link
+.Tp Cm link

 symbolic link
 symbolic link

-.TP
-.B socket
+.Tp Cm socket

 socket
 socket

-.RE
-.PP
+.Tp
+.Tp
+.Pp

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

-.PP
+.Pp

 The first type of line sets a ``global'' value for a keyword, and
 consists of a leading ``/set'' followed by whitespace, followed by
 sets of keyword/value pairs, separated by whitespace.
 The first type of line sets a ``global'' value for a keyword, and
 consists of a leading ``/set'' followed by whitespace, followed by
 sets of keyword/value pairs, separated by whitespace.


@@ -135,11 +114,11 @@ Keyword/value pairs consist of a keyword, followed by a equals sign
 (``=''), followed by a value, without intervening whitespace.
 Once a keyword has been set, its value remains unchanged until either
 set again or unset.
 (``=''), followed by a value, without intervening whitespace.
 Once a keyword has been set, its value remains unchanged until either
 set again or unset.

-.PP
+.Pp

 The second type of line unsets keywords and consists of a leading
 ``/unset'', followed by whitespace, followed by one or more keywords,
 separated by whitespace.
 The second type of line unsets keywords and consists of a leading
 ``/unset'', followed by whitespace, followed by one or more keywords,
 separated by whitespace.

-.PP
+.Pp

 The third type of line is a file specification and consists of a file
 name, followed by whitespace, followed by zero or more whitespace
 separated keyword/value pairs.
 The third type of line is a file specification and consists of a file
 name, followed by whitespace, followed by zero or more whitespace
 separated keyword/value pairs.


@@ -148,56 +127,73 @@ The file name may contain any of the standard file name matching
 characters (``['', ``]'', ``?'' or ``*''), in which case files
 in the hierarchy will be associated with the first pattern that
 they match.
 characters (``['', ``]'', ``?'' or ``*''), in which case files
 in the hierarchy will be associated with the first pattern that
 they match.

-.PP
+.Pp

 Each of the keyword/value pairs consist of a keyword, followed by an
 equals sign (``=''), followed by the keyword's value, without intervening
 whitespace.
 These values override, without changing, the global value of the
 corresponding keyword.
 Each of the keyword/value pairs consist of a keyword, followed by an
 equals sign (``=''), followed by the keyword's value, without intervening
 whitespace.
 These values override, without changing, the global value of the
 corresponding keyword.

-.PP
+.Pp

 All paths are relative.
 Specifying a directory will cause subsequent files to be searched
 for in that directory hierarchy.
 Which brings us to the last type of line in a specification: a line
 All paths are relative.
 Specifying a directory will cause subsequent files to be searched
 for in that directory hierarchy.
 Which brings us to the last type of line in a specification: a line

-containing only the string ``\fB..\fR'' causes the current directory
+containing only the string
+.Dq Nm \&..
+causes the current directory

 path to ascend one level.
 path to ascend one level.

-.PP
+.Pp

 Empty lines and lines whose first non-whitespace character is a hash
 mark (``#'') are ignored.
 Empty lines and lines whose first non-whitespace character is a hash
 mark (``#'') are ignored.

-.PP
-.I Mtree
+.Pp
+.Nm Mtree

 exits with a status of 0 on success and >0 if an error occurred or the
 tree did not match the specification.
 exits with a status of 0 on success and >0 if an error occurred or the
 tree did not match the specification.

-.SH FILES
-/etc/mtree     system specification directory
-.SH "SEE ALSO"
-chmod(1), chown(1), chgrp(1), cksum(1), find(1), stat(2), fts(3), mkproto(8)
-.SH BUGS
+.Sh FILES
+.Dw /etc/mtree
+.Di L
+.Dp Pa /etc/mtree
+system specification directory
+.Dp
+.Sh SEE ALSO
+.Xr chmod 1 ,
+.Xr chown 1 ,
+.Xr chgrp 1 ,
+.Xr cksum 1 ,
+.Xr find 1 ,
+.Xr stat 2 ,
+.Xr fts 3 ,
+.Xr mkproto 8
+.Sh BUGS

 The
 The

-.I cksum
+.Cm cksum

 keyword is not yet implemented.
 keyword is not yet implemented.

-.br
+.Pp

 The
 The

-.I time
+.Cm time

 keyword should be specifiable in human readable terms.
 keyword should be specifiable in human readable terms.

-.SH EXAMPLE
-.nf
+.Sh EXAMPLE
+.Ds I

 #        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
 /set group=staff mode=0555 nlink=1 owner=rick type=file

-[              nlink=2 size=6144
+[              nlink=2 size=6144

 adb            size=53248
 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
 adb            size=53248
 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

-
+.sp

 /set group=wheel mode=0444 nlink=1 owner=rick type=file
 manpages       type=dir mode=0775 nlink=2 size=1024
 /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
+adb.man        size=9473
+df.man size=5263
+tar.man        size=3324

 \&..
 \&..

-.fi
+.De
+.\" .Sh ENVIRONMENT
+.Sh HISTORY
+.Nm Mtree
+debuts in 4.4 BSD.