.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "File::CheckTree 3pm"
.TH File::CheckTree 3pm "2022-10-13" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
File::CheckTree \- run many filetest checks on a tree
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use File::CheckTree;
\&
\&    $num_warnings = validate( q{
\&        /vmunix                 \-e || die
\&        /boot                   \-e || die
\&        /bin                    cd
\&            csh                 \-ex
\&            csh                 !\-ug
\&            sh                  \-ex
\&            sh                  !\-ug
\&        /usr                    \-d || warn "What happened to $file?\en"
\&    });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBvalidate()\fR routine takes a single multiline string consisting of
directives, each containing a filename plus a file test to try on it.
(The file test may also be a \*(L"cd\*(R", causing subsequent relative filenames
to be interpreted relative to that directory.)  After the file test
you may put \f(CW\*(C`|| die\*(C'\fR to make it a fatal error if the file test fails.
The default is \f(CW\*(C`|| warn\*(C'\fR.  The file test may optionally have a "!' prepended
to test for the opposite condition.  If you do a cd and then list some
relative filenames, you may want to indent them slightly for readability.
If you supply your own \fBdie()\fR or \fBwarn()\fR message, you can use \f(CW$file\fR to
interpolate the filename.
.PP
Filetests may be bunched:  \*(L"\-rwx\*(R" tests for all of \f(CW\*(C`\-r\*(C'\fR, \f(CW\*(C`\-w\*(C'\fR, and \f(CW\*(C`\-x\*(C'\fR.
Only the first failed test of the bunch will produce a warning.
.PP
The routine returns the number of warnings issued.
.SH "AUTHOR"
.IX Header "AUTHOR"
File::CheckTree was derived from lib/validate.pl which was
written by Larry Wall.
Revised by Paul Grassie <\fIgrassie@perl.com\fR> in 2002.
.SH "HISTORY"
.IX Header "HISTORY"
File::CheckTree used to not display fatal error messages.
It used to count only those warnings produced by a generic \f(CW\*(C`|| warn\*(C'\fR
(and not those in which the user supplied the message).  In addition,
the \fBvalidate()\fR routine would leave the user program in whatever
directory was last entered through the use of \*(L"cd\*(R" directives.
These bugs were fixed during the development of perl 5.8.
The first fixed version of File::CheckTree was 4.2.