diff --git a/scripts/ZoneMinder/lib/ZoneMinder.pm b/scripts/ZoneMinder/lib/ZoneMinder.pm index dbedf34c3..3e3fb84b2 100644 --- a/scripts/ZoneMinder/lib/ZoneMinder.pm +++ b/scripts/ZoneMinder/lib/ZoneMinder.pm @@ -71,41 +71,44 @@ our $VERSION = $ZoneMinder::Base::VERSION; 1; __END__ -# Below is stub documentation for your module. You'd better edit it! =head1 NAME -ZoneMinder - Perl extension for blah blah blah +ZoneMinder - Container module for common ZoneMinder modules =head1 SYNOPSIS use ZoneMinder; - blah blah blah =head1 DESCRIPTION -Stub documentation for ZoneMinder, created by h2xs. It looks like the -author of the extension was negligent enough to leave the stub -unedited. +This module is a convenience container module that uses the +ZoneMinder::Base, ZoneMinder::Common, ZoneMinder::Debug, +ZoneMinder::Database and ZoneMinder::SharedMem modules. It also +exports by default all symbols provided by the 'all' tag of +each of the modules. -Blah blah blah. +Thus 'use'ing this module is equivalent to the following + + use ZoneMinder::Base qw(:all); + use ZoneMinder::Config qw(:all); + use ZoneMinder::Debug qw(:all); + use ZoneMinder::Database qw(:all); + use ZoneMinder::SharedMem qw(:all); + +but is somewhat easier. =head2 EXPORT -None by default. - - +All symbols exported by the 'all' tag of each of the included +modules. =head1 SEE ALSO -Mention other useful documentation such as the documentation of -related modules or operating system documentation (such as man pages -in UNIX), or any relevant external documentation such as RFCs or -standards. +ZoneMinder::Base, ZoneMinder::Common, ZoneMinder::Debug, +ZoneMinder::Database, ZoneMinder::SharedMem -If you have a mailing list set up for your module, mention it here. - -If you have a web site set up for your module, mention it here. +http://www.zoneminder.com =head1 AUTHOR diff --git a/scripts/ZoneMinder/lib/ZoneMinder/Base.pm.in b/scripts/ZoneMinder/lib/ZoneMinder/Base.pm.in index c6395290a..a6bc7df2b 100644 --- a/scripts/ZoneMinder/lib/ZoneMinder/Base.pm.in +++ b/scripts/ZoneMinder/lib/ZoneMinder/Base.pm.in @@ -39,9 +39,7 @@ our @ISA = qw(Exporter); # This allows declaration use ZoneMinder ':all'; # If you do not need this, moving things directly into @EXPORT or @EXPORT_OK # will save memory. -our %EXPORT_TAGS = ( 'all' => [ qw( - -) ] ); +our %EXPORT_TAGS = ( 'all' => [ qw() ] ); our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } ); @@ -51,41 +49,26 @@ our $VERSION = "@VERSION@"; 1; __END__ -# Below is stub documentation for your module. You'd better edit it! =head1 NAME -ZoneMinder - Perl extension for blah blah blah +ZoneMinder::Base - Base perl module for ZoneMinder =head1 SYNOPSIS - use ZoneMinder; - blah blah blah + use ZoneMinder::Base; =head1 DESCRIPTION -Stub documentation for ZoneMinder, created by h2xs. It looks like the -author of the extension was negligent enough to leave the stub -unedited. - -Blah blah blah. +This module is the base module for the rest of the ZoneMinder modules. It is included by each of the other modules but serves no purpose other than to propagate the perl module version amongst the other modules. You will never need to use this module directly but if you write new ZoneMinder modules they should include it. =head2 EXPORT None by default. - - =head1 SEE ALSO -Mention other useful documentation such as the documentation of -related modules or operating system documentation (such as man pages -in UNIX), or any relevant external documentation such as RFCs or -standards. - -If you have a mailing list set up for your module, mention it here. - -If you have a web site set up for your module, mention it here. +http://www.zoneminder.com =head1 AUTHOR diff --git a/scripts/ZoneMinder/lib/ZoneMinder/Config.pm.in b/scripts/ZoneMinder/lib/ZoneMinder/Config.pm.in index cdf1653cc..9996ce93b 100644 --- a/scripts/ZoneMinder/lib/ZoneMinder/Config.pm.in +++ b/scripts/ZoneMinder/lib/ZoneMinder/Config.pm.in @@ -98,41 +98,33 @@ BEGIN 1; __END__ -# Below is stub documentation for your module. You'd better edit it! =head1 NAME -ZoneMinder - Perl extension for blah blah blah +ZoneMinder::Config - ZoneMinder configuration module. =head1 SYNOPSIS - use ZoneMinder; - blah blah blah + use ZoneMinder::Config qw(:all); =head1 DESCRIPTION -Stub documentation for ZoneMinder, created by h2xs. It looks like the -author of the extension was negligent enough to leave the stub -unedited. +The ZoneMinder::Config module is used to import the ZoneMinder configuration from the database. It will do this at compile time in a BEGIN block and require access to the zm.conf file either in the current directory or in its defined location in order to determine database access details, configuration from this file will also be included. If the :all or :config tags are used then this configuration is exported into the namespace of the calling program or module. -Blah blah blah. +Once the configuration has been imported then configuration variables are defined as constants and can be accessed directory by name, e.g. + + $lang = ZM_LANG_DEFAULT; =head2 EXPORT None by default. - - +The :constants tag will export the ZM_PID constant which details the location of the zm.pid file +The :config tag will export all configuration from the database as well as any from the zm.conf file +The :all tag will export all above symbols. =head1 SEE ALSO -Mention other useful documentation such as the documentation of -related modules or operating system documentation (such as man pages -in UNIX), or any relevant external documentation such as RFCs or -standards. - -If you have a mailing list set up for your module, mention it here. - -If you have a web site set up for your module, mention it here. +http://www.zoneminder.com =head1 AUTHOR