module::build::api.3

视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.

.Sp
A hash of key/value pairs that should be merged into the \fI\s-1META\s0.yml\fR
file during the \f(CW\*(C`distmeta\*(C'\fR action.  Any existing entries with the
same names will be overridden.
.Sp
The only difference between \f(CW\*(C`meta_add\*(C'\fR and \f(CW\*(C`meta_merge\*(C'\fR is their
behavior on hash-valued and array-valued entries: \f(CW\*(C`meta_add\*(C'\fR will
completely blow away the existing hash or array value, but
\&\f(CW\*(C`meta_merge\*(C'\fR will merge the supplied data into the existing hash or
array value.
.Sp
See the \*(L"\s-1MODULE\s0 \s-1METADATA\s0\*(R" section for details.
.IP "module_name" 4
.IX Item "module_name"
[version 0.03]
.Sp
The \f(CW\*(C`module_name\*(C'\fR is a shortcut for setting default values of
\&\f(CW\*(C`dist_name\*(C'\fR and \f(CW\*(C`dist_version_from\*(C'\fR, reflecting the fact that the
majority of \s-1CPAN\s0 distributions are centered around one \*(L"main\*(R" module.
For instance, if you set \f(CW\*(C`module_name\*(C'\fR to \f(CW\*(C`Foo::Bar\*(C'\fR, then
\&\f(CW\*(C`dist_name\*(C'\fR will default to \f(CW\*(C`Foo\-Bar\*(C'\fR and \f(CW\*(C`dist_version_from\*(C'\fR will
default to \f(CW\*(C`lib/Foo/Bar.pm\*(C'\fR.  \f(CW\*(C`dist_version_from\*(C'\fR will in turn be
used to set \f(CW\*(C`dist_version\*(C'\fR.
.Sp
Setting \f(CW\*(C`module_name\*(C'\fR won't override a \f(CW\*(C`dist_*\*(C'\fR parameter you
specify explicitly.
.IP "PL_files" 4
.IX Item "PL_files"
[version 0.06]
.Sp
An optional parameter specifying a set of \f(CW\*(C`.PL\*(C'\fR files in your
distribution.  These will be run as Perl scripts prior to processing
the rest of the files in your distribution.  They are usually used as
templates for creating other files dynamically, so that a file like
\&\f(CW\*(C`lib/Foo/Bar.pm.PL\*(C'\fR might create the file \f(CW\*(C`lib/Foo/Bar.pm\*(C'\fR.
.Sp
The files are specified with the \f(CW\*(C`.PL\*(C'\fR files as hash keys, and the
file(s) they generate as hash values, like so:
.Sp
.Vb 6
\&  my $build = Module::Build\->new
\&    (
\&     module_name => \*(AqFoo::Bar\*(Aq,
\&     ...
\&     PL_files => { \*(Aqlib/Foo/Bar.pm.PL\*(Aq => \*(Aqlib/Foo/Bar.pm\*(Aq },
\&    );
.Ve
.Sp
Note that the path specifications are \fIalways\fR given in Unix-like
format, not in the style of the local system.
.Sp
If your \f(CW\*(C`.PL\*(C'\fR scripts don't create any files, or if they create files
with unexpected names, or even if they create multiple files, you can
indicate that so that Module::Build can properly handle these created
files:
.Sp
.Vb 5
\&  PL_files => {
\&               \*(Aqlib/Foo/Bar.pm.PL\*(Aq => \*(Aqlib/Foo/Bar.pm\*(Aq,
\&               \*(Aqlib/something.PL\*(Aq  => [\*(Aq/lib/something\*(Aq, \*(Aq/lib/else\*(Aq],
\&               \*(Aqlib/funny.PL\*(Aq      => [],
\&              }
.Ve
.IP "pm_files" 4
.IX Item "pm_files"
[version 0.19]
.Sp
An optional parameter specifying the set of \f(CW\*(C`.pm\*(C'\fR files in this
distribution, specified as a hash reference whose keys are the files'
locations in the distributions, and whose values are their logical
locations based on their package name, i.e. where they would be found
in a \*(L"normal\*(R" Module::Build\-style distribution.  This parameter is
mainly intended to support alternative layouts of files.
.Sp
For instance, if you have an old-style MakeMaker distribution for a
module called \f(CW\*(C`Foo::Bar\*(C'\fR and a \fIBar.pm\fR file at the top level of the
distribution, you could specify your layout in your \f(CW\*(C`Build.PL\*(C'\fR like
this:
.Sp
.Vb 6
\&  my $build = Module::Build\->new
\&    (
\&     module_name => \*(AqFoo::Bar\*(Aq,
\&     ...
\&     pm_files => { \*(AqBar.pm\*(Aq => \*(Aqlib/Foo/Bar.pm\*(Aq },
\&    );
.Ve
.Sp
Note that the values should include \f(CW\*(C`lib/\*(C'\fR, because this is where
they would be found in a \*(L"normal\*(R" Module::Build\-style distribution.
.Sp
Note also that the path specifications are \fIalways\fR given in
Unix-like format, not in the style of the local system.
.IP "pod_files" 4
.IX Item "pod_files"
[version 0.19]
.Sp
Just like \f(CW\*(C`pm_files\*(C'\fR, but used for specifying the set of \f(CW\*(C`.pod\*(C'\fR
files in your distribution.
.IP "recommends" 4
.IX Item "recommends"
[version 0.08]
.Sp
This is just like the \*(L"requires\*(R" argument, except that modules listed
in this section aren't essential, just a good idea.  We'll just print
a friendly warning if one of these modules aren't found, but we'll
continue running.
.Sp
If a module is recommended but not required, all tests should still
pass if the module isn't installed.  This may mean that some tests
may be skipped if recommended dependencies aren't present.
.Sp
Automated tools like \s-1CPAN\s0.pm should inform the user when recommended
modules aren't installed, and it should offer to install them if it
wants to be helpful.
.Sp
See the documentation for \*(L"\s-1PREREQUISITES\s0\*(R" in Module::Build::Authoring
for the details of how requirements can be specified.
.IP "recursive_test_files" 4
.IX Item "recursive_test_files"
[version 0.28]
.Sp
Normally, \f(CW\*(C`Module::Build\*(C'\fR does not search subdirectories when looking
for tests to run. When this options is set it will search recursively
in all subdirectories of the standard 't' test directory.
.IP "requires" 4
.IX Item "requires"
[version 0.07]
.Sp
An optional \f(CW\*(C`requires\*(C'\fR argument specifies any module prerequisites
that the current module depends on.
.Sp
One note: currently \f(CW\*(C`Module::Build\*(C'\fR doesn't actually \fIrequire\fR the
user to have dependencies installed, it just strongly urges.  In the
future we may require it.  There's also a \*(L"recommends\*(R" section for
things that aren't absolutely required.
.Sp
Automated tools like \s-1CPAN\s0.pm should refuse to install a module if one
of its dependencies isn't satisfied, unless a \*(L"force\*(R" command is given
by the user.  If the tools are helpful, they should also offer to
install the dependencies.
.Sp
A synonym for \f(CW\*(C`requires\*(C'\fR is \f(CW\*(C`prereq\*(C'\fR, to help succour people
transitioning from \f(CW\*(C`ExtUtils::MakeMaker\*(C'\fR.  The \f(CW\*(C`requires\*(C'\fR term is
preferred, but the \f(CW\*(C`prereq\*(C'\fR term will remain valid in future
distributions.
.Sp
See the documentation for \*(L"\s-1PREREQUISITES\s0\*(R" in Module::Build::Authoring
for the details of how requirements can be specified.
.IP "script_files" 4
.IX Item "script_files"
[version 0.18]
.Sp
An optional parameter specifying a set of files that should be
installed as executable Perl scripts when the module is installed.
May be given as an array reference of the files, or as a hash
reference whose keys are the files (and whose values will currently be
ignored).
.Sp
The default is to install no script files \- in other words, there is
no default location where Module::Build will look for script files to
install.
.Sp
For backward compatibility, you may use the parameter \f(CW\*(C`scripts\*(C'\fR
instead of \f(CW\*(C`script_files\*(C'\fR.  Please consider this usage deprecated,
though it will continue to exist for several version releases.
.IP "sign" 4
.IX Item "sign"
[version 0.16]
.Sp
If a true value is specified for this parameter, Module::Signature
will be used (via the 'distsign' action) to create a \s-1SIGNATURE\s0 file
for your distribution during the 'distdir' action, and to add the
\&\s-1SIGNATURE\s0 file to the \s-1MANIFEST\s0 (therefore, don't add it yourself).
.Sp
The default value is false.  In the future, the default may change to
true if you have \f(CW\*(C`Module::Signature\*(C'\fR installed on your system.
.IP "test_files" 4
.IX Item "test_files"
[version 0.23]
.Sp
An optional parameter specifying a set of files that should be used as
\&\f(CW\*(C`Test::Harness\*(C'\fR\-style regression tests to be run during the \f(CW\*(C`test\*(C'\fR
action.  May be given as an array reference of the files, or as a hash
reference whose keys are the files (and whose values will currently be
ignored).  If the argument is given as a single string (not in an
array reference), that string will be treated as a \f(CW\*(C`glob()\*(C'\fR pattern
specifying the files to use.
.Sp
The default is to look for a \fItest.pl\fR script in the top-level
directory of the distribution, and any files matching the glob pattern
\&\f(CW\*(C`*.t\*(C'\fR in the \fIt/\fR subdirectory.  If the \f(CW\*(C`recursive_test_files\*(C'\fR
property is true, then the \f(CW\*(C`t/\*(C'\fR directory will be scanned recursively
for \f(CW\*(C`*.t\*(C'\fR files.
.IP "xs_files" 4
.IX Item "xs_files"
[version 0.19]
.Sp
Just like \f(CW\*(C`pm_files\*(C'\fR, but used for specifying the set of \f(CW\*(C`.xs\*(C'\fR
files in your distribution.
.RE
.RS 4
.RE
.IP "new_from_context(%args)" 4
.IX Item "new_from_context(%args)"
[version 0.28]
.Sp
When called from a directory containing a \fIBuild.PL\fR script and a
\&\fI\s-1META\s0.yml\fR file (in other words, the base directory of a
distribution), this method will run the \fIBuild.PL\fR and return the
resulting \f(CW\*(C`Module::Build\*(C'\fR object to the caller.  Any key-value
arguments given to \f(CW\*(C`new_from_context()\*(C'\fR are essentially like
command line arguments given to the \fIBuild.PL\fR script, so for example
you could pass \f(CW\*(C`verbose => 1\*(C'\fR to this method to turn on
verbosity.
.IP "\fIresume()\fR" 4
.IX Item "resume()"
[version 0.03]
.Sp
You'll probably never call this method directly, it's only called from
the auto-generated \f(CW\*(C`Build\*(C'\fR script.  The \f(CW\*(C`new()\*(C'\fR method is only
called once, when the user runs \f(CW\*(C`perl Build.PL\*(C'\fR.  Thereafter, when
the user runs \f(CW\*(C`Build test\*(C'\fR or another action, the \f(CW\*(C`Module::Build\*(C'\fR
object is created using the \f(CW\*(C`resume()\*(C'\fR method to re-instantiate with
the settings given earlier to \f(CW\*(C`new()\*(C'\fR.
.IP "\fIsubclass()\fR" 4
.IX Item "subclass()"
[version 0.06]
.Sp
This creates a new \f(CW\*(C`Module::Build\*(C'\fR subclass on the fly, as described
in the \*(L"\s-1SUBCLASSING\s0\*(R" in Module::Build::Authoring section.  The caller
must provide either a \f(CW\*(C`class\*(C'\fR or \f(CW\*(C`code\*(C'\fR parameter, or both.  The
\&\f(CW\*(C`class\*(C'\fR parameter indicates the name to use for the new subclass, and
defaults to \f(CW\*(C`MyModuleBuilder\*(C'\fR.  The \f(CW\*(C`code\*(C'\fR parameter specifies Perl
code to use as the body of the subclass.
.Sh "\s-1METHODS\s0"
.IX Subsection "METHODS"
.IP "add_build_element($type)" 4
.IX Item "add_build_element($type)"
[version 0.26]
.Sp
Adds a new type of entry to the build process.  Accepts a single
string specifying its type-name.  There must also be a method defined
to process things of that type, e.g. if you add a build element called
\&\f(CW\*(Aqfoo\*(Aq\fR, then you must also define a method called
\&\f(CW\*(C`process_foo_files()\*(C'\fR.
.Sp
See also
\&\*(L"Adding new file types to the build process\*(R" in Module::Build::Cookbook.
.IP "add_to_cleanup(@files)" 4
.IX Item "add_to_cleanup(@files)"
[version 0.03]
.Sp
You may call \f(CW\*(C`$self\->add_to_cleanup(@patterns)\*(C'\fR to tell
\&\f(CW\*(C`Module::Build\*(C'\fR that certain files should be removed when the user
performs the \f(CW\*(C`Build clean\*(C'\fR action.  The arguments to the method are
patterns suitable for passing to Perl's \f(CW\*(C`glob()\*(C'\fR function, specified
in either Unix format or the current machine's native format.  It's
usually convenient to use Unix format when you hard-code the filenames
(e.g. in \fIBuild.PL\fR) and the native format when the names are
programmatically generated (e.g. in a testing script).
.Sp
I decided to provide a dynamic method of the \f(CW$build\fR object, rather
than just use a static list of files named in the \fIBuild.PL\fR, because
these static lists can get difficult to manage.  I usually prefer to
keep the responsibility for registering temporary files close to the
code that creates them.
.IP "\fIargs()\fR" 4
.IX Item "args()"
[version 0.26]
.Sp
.Vb 4
\&  my $args_href = $build\->args;
\&  my %args = $build\->args;
\&  my $arg_value = $build\->args($key);
\&  $build\->args($key, $value);
.Ve
.Sp
This method is the preferred interface for retrieving the arguments passed via
command line options to \fIBuild.PL\fR or \fIBuild\fR, minus the Module-Build
specific options.
.Sp
When called in in a scalar context with no arguments, this method returns a
reference to the hash storing all of the arguments; in an array context, it
returns the hash itself.  When passed a single argument, it returns the value
stored in the args hash for that option key.  When called with two arguments,
the second argument is assigned to the args hash under the key passed as the
first argument.
.ie n .IP "autosplit_file($from, $to)" 4
.el .IP "autosplit_file($from, \f(CW$to\fR)" 4
.IX Item "autosplit_file($from, $to)"
[version 0.28]
.Sp
Invokes the AutoSplit module on the \f(CW$from\fR file, sending the
output to the \f(CW\*(C`lib/auto\*(C'\fR directory inside \f(CW$to\fR.  \f(CW$to\fR is
typically the \f(CW\*(C`blib/\*(C'\fR directory.
.IP "\fIbase_dir()\fR" 4
.IX Item "base_dir()"
[version 0.14]
.Sp
Returns a string containing the root-level directory of this build,
i.e. where the \f(CW\*(C`Build.PL\*(C'\fR script and the \f(CW\*(C`lib\*(C'\fR directory can be
found.  This is usually the same as the current working directory,
because the \f(CW\*(C`Build\*(C'\fR script will \f(CW\*(C`chdir()\*(C'\fR into this directory as
soon as it begins execution.
.IP "\fIbuild_requires()\fR" 4
.IX Item "build_requires()"
[version 0.21]
.Sp
Returns a hash reference indicating the \f(CW\*(C`build_requires\*(C'\fR
prerequisites that were passed to the \f(CW\*(C`new()\*(C'\fR method.
.ie n .IP "check_installed_status($module, $version)" 4
.el .IP "check_installed_status($module, \f(CW$version\fR)" 4
.IX Item "check_installed_status($module, $version)"
[version 0.11]
.Sp