zoneminder::configdata(3pm) [debian man page]

ZoneMinder::ConfigData(3pm)				User Contributed Perl Documentation			       ZoneMinder::ConfigData(3pm)

NAME

       ZoneMinder::ConfigData - ZoneMinder Configuration Data module

SYNOPSIS

	 use ZoneMinder::ConfigData;
	 use ZoneMinder::ConfigData qw(:all);

	 loadConfigFromDB();
	 saveConfigToDB();

DESCRIPTION

       The ZoneMinder:ConfigData module contains the master definition of the ZoneMinder configuration options as well as helper methods. This
       module is intended for specialist confguration management and would not normally be used by end users.

       The configuration held in this module, which was previously in zmconfig.pl, includes the name, default value, description, help text, type
       and category for each option, as well as a number of additional fields in a small number of cases.

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 :data tag will export the various configuration data structures The :functions tag will export the helper functions.
       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.

POD ERRORS

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

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

perl v5.14.2							    2013-02-12					       ZoneMinder::ConfigData(3pm)

File::ChangeNotify::ConfigData(3pm)			User Contributed Perl Documentation		       File::ChangeNotify::ConfigData(3pm)

NAME

       File::ChangeNotify::ConfigData - Configuration for File::ChangeNotify

SYNOPSIS

	 use File::ChangeNotify::ConfigData;
	 $value = File::ChangeNotify::ConfigData->config('foo');
	 $value = File::ChangeNotify::ConfigData->feature('bar');

	 @names = File::ChangeNotify::ConfigData->config_names;
	 @names = File::ChangeNotify::ConfigData->feature_names;

	 File::ChangeNotify::ConfigData->set_config(foo => $new_value);
	 File::ChangeNotify::ConfigData->set_feature(bar => $new_value);
	 File::ChangeNotify::ConfigData->write;  # Save changes

DESCRIPTION

       This module holds the configuration data for the "File::ChangeNotify" module.  It also provides a programmatic interface for getting or
       setting that configuration data.  Note that in order to actually make changes, you'll have to have write access to the
       "File::ChangeNotify::ConfigData" module, and you should attempt to understand the repercussions of your actions.

METHODS

       config($name)
	   Given a string argument, returns the value of the configuration item by that name, or "undef" if no such item exists.

       feature($name)
	   Given a string argument, returns the value of the feature by that name, or "undef" if no such feature exists.

       set_config($name, $value)
	   Sets the configuration item with the given name to the given value.	The value may be any Perl scalar that will serialize correctly
	   using "Data::Dumper".  This includes references, objects (usually), and complex data structures.  It probably does not include
	   transient things like filehandles or sockets.

       set_feature($name, $value)
	   Sets the feature with the given name to the given boolean value.  The value will be converted to 0 or 1 automatically.

       config_names()
	   Returns a list of all the names of config items currently defined in "File::ChangeNotify::ConfigData", or in scalar context the number
	   of items.

       feature_names()
	   Returns a list of all the names of features currently defined in "File::ChangeNotify::ConfigData", or in scalar context the number of
	   features.

       auto_feature_names()
	   Returns a list of all the names of features whose availability is dynamically determined, or in scalar context the number of such
	   features.  Does not include such features that have later been set to a fixed value.

       write()
	   Commits any changes from "set_config()" and "set_feature()" to disk.  Requires write access to the "File::ChangeNotify::ConfigData"
	   module.

AUTHOR

       "File::ChangeNotify::ConfigData" was automatically created using "Module::Build".  "Module::Build" was written by Ken Williams, but he
       holds no authorship claim or copyright claim to the contents of "File::ChangeNotify::ConfigData".

perl v5.14.2							    2012-04-14				       File::ChangeNotify::ConfigData(3pm)