Thorsten Schwander > TeX-AutoTeX > TeX::AutoTeX::Log

Download:
TeX-AutoTeX-v0.906.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.10.2.5   Source  

NAME ^

TeX::AutoTeX::Log - log handling for TeX::AutoTeX

DESCRIPTION ^

Logging object for AutoTeX.

HISTORY ^

 AutoTeX automatic TeX processing system
 Copyright (c) 1994-2006 arXiv.org and contributors

 AutoTeX is supplied under the GNU Public License and comes
 with ABSOLUTELY NO WARRANTY; see COPYING for more details.

 AutoTeX is an automatic TeX processing system designed to
 process TeX/LaTeX/AMSTeX/etc source code of papers submitted
 to the arXiv.org (nee xxx.lanl.gov) e-print archive. The
 portable part of this code has been extracted and is made
 available in the hope that it will be useful to other projects
 and that the input of others will benefit arXiv.org.

 Code developed and contributed to by Tanmoy Bhattacharya, Rob
 Hartill, Mark Doyle, Thorsten Schwander, and Simeon Warner.
 Refactored to separate generic code from arXiv.org specific code
 by Stephen Marsh, Michael Fromerth, and Simeon Warner 2005/2006.

 Major cleanups and algorithmic improvements/corrections by
 Thorsten Schwander 2006 - 2011

new()

Constructor with facilities to override all settings via input hash. In particular, a second file handle may be supplied to duplicate the output, e.g.

my $log=TeX::AutoTeX::Log->new( dupefh => \*STDOUT);

To duplicate to STDOUT.

A call to open_logfile must be made to actually create and start writing to a logfile. This is separated to that the Log object can be created before changing to the appropriate directory to write the logfile.

open_logfile()

Open the logfile. This action will overwrite an existing file of the same name.

close_logfile()

Attempts to close the logfile, if a logfilehandle exists.

error

Log an error message and croak

verbose

Log message if verbose is set true

to_stringref

$log->to_stringref() returns a scalar reference to the contents of the log file

internal method __logit

Log a generic message. Called by the various functions for different types of messages. Not intended to be called externally.

BUGS AND LIMITATIONS ^

Please report bugs to www-admin

AUTHOR ^

See history above. Current maintainer: Thorsten Schwander for arXiv.org

LICENSE AND COPYRIGHT ^

Copyright (c) 2007 - 2011 arxiv.org http://arxiv.org/help/contact

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

syntax highlighting: