man ZoneMinder::Debug (3): ZoneMinder Debug module

SYNOPSIS

use ZoneMinder::Debug;
use ZoneMinder::Debug qw(:all);
zmDbgInit( "myproc", DBG_DEBUG );
Debug( "This is what is happening" );
Info( "Something interesting is happening" );
Warning( "Something might be going wrong." );
Error( "Something has gone wrong!!" );
Fatal( "Something has gone badly wrong, gotta stop!!" );

DESCRIPTION

The ZoneMinder:Debug module contains the common debug and error reporting routines used by the ZoneMinder scripts.

To use debug in your scripts you need to include this module, and call zmDbgInit. Thereafter you can sprinkle Debug or Error calls etc throughout the code safe in the knowledge that they will be reported to your error log, and possibly the syslogger, in a meaningful and consistent format.

Debug is discussed in terms of levels where 1 and above (currently only 1 for scripts) is considered debug, 0 is considered as informational, -1 is a warning, -2 is an error and -3 is a fatal error or panic. Where levels are mentioned below as thresholds the value given and anything with a lower level (ie. more serious) will be included.

METHODS

zmDbgInit ( $id, %options );

Initialises the debug and prepares the logging for forthcoming operations. If not called explicitly it will be called by the first debug call in your script, but with default (and probably meaningless) options. The only compulsory arguments are $id which must be a string that will identify debug coming from this script in mixed logs. Other options may be provided as below,

 Option       Default        Description
 ---------    ---------      -----------
 level        DBG_INFO       The initial debug level which defines which statements are output and which are ignored
 carp         0              Whether to use the Carp::shortmess format in debug statements to identify where the debug was emitted from
 to_log       1              Whether to write debug to a log file of the format of <id>.log in the standard log directory
 to_term      0              Whether to write debug to terminal standard error, 0 is no, 1 is yes, 2 is write only if terminal
 to_syslog    DBG_INFO       At what level debug is written to syslog. To disable entirely set this to DBG_NOSYSLOG

zmDbgTerm ();

Used to end the debug session and close any logs etc. Not usually necessary.

$id = zmDbgId ( [$id] );

$level = zmDbgLevel ( [$level] );

$carp = zmDbgId ( [$carp] );

$to_log = zmDbgToLog ( [$to_log] );

$to_term = zmDbgToTerm ( [$to_term] );

$to_syslog = zmDbgToSyslog ( [$to_syslog] );

These methods can be used to get and set the current settings as defined in zmDbgInit.

Debug( $string );

This method will output a debug message if the current debug level permits it, otherwise does nothing. This message will be tagged with the DBG string in the logs.

Info( $string );

This method will output an informational message if the current debug level permits it, otherwise does nothing. This message will be tagged with the INF string in the logs.

Warning( $string );

This method will output a warning message if the current debug level permits it, otherwise does nothing. This message will be tagged with the WAR string in the logs.

Error( $string );

This method will output an error message if the current debug level permits it, otherwise does nothing. This message will be tagged with the ERR string in the logs.

Fatal( $string );

This method will output a fatal error message and then die if the current debug level permits it, otherwise does nothing. This message will be tagged with the FAT string in the logs.

Panic( $string );

Synonym for Fatal.

EXPORT

None by default. The :constants tag will export the debug constants which define the various levels of debug The :variables tag will export variables containing the current debug id and level The :functions tag will export the debug functions. This or :all is what you would normally use. The :all tag will export all above symbols.

AUTHOR

Philip Coombes, <[email protected]>

COPYRIGHT AND LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.3 or, at your option, any later version of Perl 5 you may have available.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 443:: You forgot a '=back' before '=head2'