debian man page for latex::driver::filterprogram

LaTeX::Driver::FilterProgram(3pm)			User Contributed Perl Documentation			 LaTeX::Driver::FilterProgram(3pm)

NAME
       LaTeX::Driver::FilterProgram - LaTeX Driver (FilterProgram)

VERSION
SYNOPSIS
	 use LaTeX::Driver::FilterProgram;
	 LaTeX::Driver::FilterProgram->execute(format => $format);

DESCRIPTION
       This module is not intended to be used except by the programs "latex2pdf", "latex2ps" and "latex2dvi" that are included in the
       LaTeX::Driver distribution.  It implements the guts of those filter programs.

SUBROUTINES
/METHODS
       "execute(%params)"
	   This is the only method.  It implements the guts of the filter programs, gathering the parameters for the "LaTeX::Driver" 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.

	   If the "-tt2" 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 "LaTeX::Driver" module for latex formatting.  Template
	   variables may defined with the "-define" option and these are passed to the Template Toolkit processing stage (they are ignored if the
	   "-tt2" option is not specified).

DIAGNOSTICS
       The module invokes the "LaTeX::Driver" module and optionally the "Template" module.  Any errors from those modules are propogated outwards.

CONFIGURATION AND ENVIRONMENT
       The module invokes the latex family of programs via the "LaTeX::Driver" module.	Those programs have their own set of environment variables
       and configuration files.

DEPENDENCIES
       The module requires that the Template Toolkit is installed for the "-tt2" option.

INCOMPATIBILITIES
       None known.

BUGS AND LIMITATIONS
       None known.

AUTHOR
       Andrew Ford <a.ford@ford-mason.co.uk>

LICENSE AND COPYRIGHT
       Copyright (C) 2007 Andrew Ford.	All Rights Reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.12.4							    2011-09-18					 LaTeX::Driver::FilterProgram(3pm)