NAME
$notes_name - Configuration for $module_name
SYNOPSIS
use $notes_name;
\$value = $notes_name->config('foo');
\$value = $notes_name->feature('bar');
\@names = $notes_name->config_names;
\@names = $notes_name->feature_names;
$notes_name->set_config(foo => \$new_value);
$notes_name->set_feature(bar => \$new_value);
$notes_name->write; # Save changes
DESCRIPTION
This module holds the configuration data for the $module_name
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 $notes_name
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
$notes_name
, or in scalar context the number of items. - feature_names()
-
Returns a list of all the names of features currently defined in
$notes_name
, or in scalar context the number of features. - write()
-
Commits any changes from
set_config()
andset_feature()
to disk. Requires write access to the$notes_name
module.
AUTHOR
$notes_name
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 $notes_name
.
NAME
Module::Build::Base - Default methods for Module::Build
SYNOPSIS
Please see the Module::Build documentation.
DESCRIPTION
The Module::Build::Base
module defines the core functionality of Module::Build
. Its methods may be overridden by any of the platform-dependent modules in the Module::Build::Platform::
namespace, but the intention here is to make this base module as platform-neutral as possible. Nicely enough, Perl has several core tools available in the File::
namespace for doing this, so the task isn't very difficult.
Please see the Module::Build
documentation for more details.
AUTHOR
Ken Williams, ken@mathforum.org
SEE ALSO
perl(1), Module::Build(3)