Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
ZoneMinder::Config(3) User Contributed Perl DocumentationZoneMinder::Config(3)

NAME
       ZoneMinder::Config - ZoneMinder configuration module.

SYNOPSIS
       use ZoneMinder::Config qw(:all);

DESCRIPTION
       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.

       Once the	configuration has been imported	then configuration variables
       are defined as constants	and can	be accessed directory by name, e.g.

       $lang = $Config{ZM_LANG_DEFAULT};

METHODS
       loadConfigFromDB	();
	   Loads existing configuration	from the database (if any) and merges
	   it with the definitions held	in this	module.	This results in	the
	   merging of any new configuration and	the removal of any deprecated
	   configuration while preserving the existing values of every else.

       saveConfigToDB ();
	   Saves configuration held in memory to the database. The act of
	   loading and saving configuration is a convenient way	to ensure that
	   the configuration held in the database corresponds with the most
	   recent definitions and that all components are using	the same set
	   of configuration.

   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.

SEE ALSO
       http://www.zoneminder.com

AUTHOR
       Philip Coombes, <philip.coombes@zoneminder.com>

COPYRIGHT AND LICENSE
       Copyright (C) 2001-2008	Philip Coombes

       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.

perl v5.32.0			  2020-08-31		 ZoneMinder::Config(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=ZoneMinder::Config&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help