.\" 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 "MasonX::ProcessDir 3pm"
.TH MasonX::ProcessDir 3pm "2022-06-15" "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"
MasonX::ProcessDir \- Process a directory of Mason 2 templates
.SH "VERSION"
.IX Header "VERSION"
version 0.02
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use MasonX::ProcessDir;
\&
\&    # Generate result files in the same directory as the templates
\&    #
\&    my $pd = MasonX::ProcessDir\->new(
\&        dir => \*(Aq/path/to/dir\*(Aq
\&    );
\&    $pd\->process_dir();
\&
\&    # Generate result files in a separate directory
\&    #
\&    my $pd = MasonX::ProcessDir\->new(
\&        source_dir => \*(Aq/path/to/source/dir\*(Aq,
\&        dest_dir   => \*(Aq/path/to/dest/dir\*(Aq
\&    );
\&    $pd\->process_dir();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Recursively processes a directory of Mason 2 templates, generating a
set of result files in the same directory or in a parallel directory.
.PP
Every file with suffix \*(L".mc\*(R" will be processed, and the results placed in a
file of the same name without the suffix. \*(L".mi\*(R", autobase and dhandler files
will be used by Mason when processing the templates but will not generate files
themselves.
.PP
For example, if the source directory contains
.PP
.Vb 6
\&   Base.mc
\&   httpd.conf.mc
\&   proxy.conf.mc
\&   etc/crontab.mc
\&   blah.mi
\&   somefile.txt
.Ve
.PP
and we run
.PP
.Vb 5
\&    my $pd = MasonX::ProcessDir\->new(
\&        source_dir => \*(Aq/path/to/source/dir\*(Aq,
\&        dest_dir   => \*(Aq/path/to/dest/dir\*(Aq
\&    );
\&    $pd\->process_dir();
.Ve
.PP
then afterwards the destination directory will contain files
.PP
.Vb 4
\&    httpd.conf
\&    proxy.conf
\&    etc/crontab
\&    somefile.txt
.Ve
.PP
where \fIfoo\fR and \fIbar\fR are the results of processing \fIfoo.mc\fR and \fIbar.mc\fR
through Mason. \fIBase.mc\fR and \fIblah.mi\fR may be used during Mason processing
but won't generate result files themselves.
.PP
This class is a convenience extension of
Any::Template::ProcessDir.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "Specifying directory/directories"
.IX Subsection "Specifying directory/directories"
.IP "\(bu" 4
If you want to generate the result files in the \fBsame\fR directory as the
templates, just specify \fIdir\fR.
.Sp
.Vb 4
\&    my $pd = MasonX::ProcessDir\->new(
\&        dir => \*(Aq/path/to/dir\*(Aq,
\&        ...
\&    );
.Ve
.IP "\(bu" 4
If you want to generate the result files in a \fBseparate\fR directory from the
templates, specify \fIsource_dir\fR and \fIdest_dir\fR.
.Sp
.Vb 5
\&    my $pd = MasonX::ProcessDir\->new(
\&        source_dir => \*(Aq/path/to/source/dir\*(Aq,
\&        source_dir => \*(Aq/path/to/dest/dir\*(Aq,
\&        ...
\&    );
.Ve
.SS "Mason options"
.IX Subsection "Mason options"
.IP "mason_options" 4
.IX Item "mason_options"
An optional hash of options to the Mason interpreter. For example, the default
Mason data directory will be \*(L".mason\*(R" under the source directory, but you can
override this:
.Sp
.Vb 1
\&    mason_options => { data_dir => \*(Aq/path/to/data/dir\*(Aq }
.Ve
.SS "Options inherited from Any::Template::ProcessDir"
.IX Subsection "Options inherited from Any::Template::ProcessDir"
See Any::Template::ProcessDir for other options, such as
.PP
.Vb 3
\&    dir_create_mode
\&    file_create_mode
\&    readme_filename
.Ve
.SH "SUPPORT AND DOCUMENTATION"
.IX Header "SUPPORT AND DOCUMENTATION"
Bugs and feature requests will be tracked at \s-1RT:\s0
.PP
.Vb 2
\&    http://rt.cpan.org/NoAuth/Bugs.html?Dist=MasonX\-ProcessDir
\&    bug\-masonx\-processdir@rt.cpan.org
.Ve
.PP
The latest source code can be browsed and fetched at:
.PP
.Vb 2
\&    http://github.com/jonswar/perl\-masonx\-processdir
\&    git clone git://github.com/jonswar/perl\-masonx\-processdir.git
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mason, Any::Template::ProcessDir
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz <swartz@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Jonathan Swartz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.