.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "LaTeX::Driver::FilterProgram 3pm"
.TH LaTeX::Driver::FilterProgram 3pm 2024-03-05 "perl v5.38.2" "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
LaTeX::Driver::FilterProgram \- LaTeX driver (FilterProgram)
.SH VERSION
.IX Header "VERSION"
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  use LaTeX::Driver::FilterProgram;
\&  LaTeX::Driver::FilterProgram\->execute(format => $format);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is not intended to be used except by the programs
\&\f(CW\*(C`latex2pdf\*(C'\fR, \f(CW\*(C`latex2ps\*(C'\fR and \f(CW\*(C`latex2dvi\*(C'\fR that are included in the
LaTeX::Driver distribution.  It implements the guts of those filter
programs.
.SH SUBROUTINES/METHODS
.IX Header "SUBROUTINES/METHODS"
.ie n .IP execute(%params) 4
.el .IP \f(CWexecute(%params)\fR 4
.IX Item "execute(%params)"
This is the only method.  It implements the guts of the filter
programs, gathering the parameters for the \f(CW\*(C`LaTeX::Driver\*(C'\fR object
constructor from the command line options, along with the options
passed from the calling script, which should be the format option.
Having constructed a driver object it then runs the driver.
.Sp
If the \f(CW\*(C`\-tt2\*(C'\fR option is specified then the source document is taken
to be a Template Toolkit template and a Template object is constructed
and the template processed through that before being fed to the
\&\f(CW\*(C`LaTeX::Driver\*(C'\fR module for latex formatting.  Template variables may
defined with the \f(CW\*(C`\-define\*(C'\fR option and these are passed to the
Template Toolkit processing stage (they are ignored if the \f(CW\*(C`\-tt2\*(C'\fR
option is not specified).
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
The module invokes the \f(CW\*(C`LaTeX::Driver\*(C'\fR module and optionally the
\&\f(CW\*(C`Template\*(C'\fR module.  Any errors from those modules are propagated
outwards.
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
The module invokes the latex family of programs via the
\&\f(CW\*(C`LaTeX::Driver\*(C'\fR module.  Those programs have their own set of
environment variables and configuration files.
.SH DEPENDENCIES
.IX Header "DEPENDENCIES"
The module requires that the Template Toolkit is installed for the \f(CW\*(C`\-tt2\*(C'\fR option.
.SH INCOMPATIBILITIES
.IX Header "INCOMPATIBILITIES"
None known.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
None known.
.SH AUTHOR
.IX Header "AUTHOR"
Andrew Ford <a.ford@ford\-mason.co.uk>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (C) 2007 Andrew Ford.  All Rights Reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.