module::build::api.3

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

documentation.
.IP "create_readme" 4
.IX Item "create_readme"
[version 0.22]
.Sp
This parameter tells Module::Build to automatically create a \fI\s-1README\s0\fR
file at the top level of your distribution.  Currently it will simply
use \f(CW\*(C`Pod::Text\*(C'\fR (or \f(CW\*(C`Pod::Readme\*(C'\fR if it's installed) on the file
indicated by \f(CW\*(C`dist_version_from\*(C'\fR and put the result in the \fI\s-1README\s0\fR
file.  This is by no means the only recommended style for writing a
\&\s-1README\s0, but it seems to be one common one used on the \s-1CPAN\s0.
.Sp
If you generate a \fI\s-1README\s0\fR in this way, it's probably a good idea to
create a separate \fI\s-1INSTALL\s0\fR file if that information isn't in the
generated \fI\s-1README\s0\fR.
.IP "dist_abstract" 4
.IX Item "dist_abstract"
[version 0.20]
.Sp
This should be a short description of the distribution.  This is used
when generating metadata for \fI\s-1META\s0.yml\fR and \s-1PPD\s0 files.  If it is not
given then \f(CW\*(C`Module::Build\*(C'\fR looks in the \s-1POD\s0 of the module from which
it gets the distribution's version.  It looks for the first line
matching \f(CW\*(C`$package\es\-\es(.+)\*(C'\fR, and uses the captured text as the
abstract.
.IP "dist_author" 4
.IX Item "dist_author"
[version 0.20]
.Sp
This should be something like \*(L"John Doe <[e-mail]>\*(R", or if
there are multiple authors, an anonymous array of strings may be
specified.  This is used when generating metadata for \fI\s-1META\s0.yml\fR and
\&\s-1PPD\s0 files.  If this is not specified, then \f(CW\*(C`Module::Build\*(C'\fR looks at
the module from which it gets the distribution's version.  If it finds
a \s-1POD\s0 section marked \*(L"=head1 \s-1AUTHOR\s0\*(R", then it uses the contents of
this section.
.IP "dist_name" 4
.IX Item "dist_name"
[version 0.11]
.Sp
Specifies the name for this distribution.  Most authors won't need to
set this directly, they can use \f(CW\*(C`module_name\*(C'\fR to set \f(CW\*(C`dist_name\*(C'\fR to
a reasonable default.  However, some agglomerative distributions like
\&\f(CW\*(C`libwww\-perl\*(C'\fR or \f(CW\*(C`bioperl\*(C'\fR have names that don't correspond directly
to a module name, so \f(CW\*(C`dist_name\*(C'\fR can be set independently.
.IP "dist_version" 4
.IX Item "dist_version"
[version 0.11]
.Sp
Specifies a version number for the distribution.  See \*(L"module_name\*(R"
or \*(L"dist_version_from\*(R" for ways to have this set automatically from a
\&\f(CW$VERSION\fR variable in a module.  One way or another, a version
number needs to be set.
.IP "dist_version_from" 4
.IX Item "dist_version_from"
[version 0.11]
.Sp
Specifies a file to look for the distribution version in.  Most
authors won't need to set this directly, they can use \*(L"module_name\*(R"
to set it to a reasonable default.
.Sp
The version is extracted from the specified file according to the same
rules as ExtUtils::MakeMaker and \f(CW\*(C`CPAN.pm\*(C'\fR.  It involves finding
the first line that matches the regular expression
.Sp
.Vb 1
\&   /([\e$*])(([\ew\e:\e\*(Aq]*)\ebVERSION)\eb.*\e=/
.Ve
.Sp
\&\fIeval()\fR\-ing that line, then checking the value of the \f(CW$VERSION\fR
variable.  Quite ugly, really, but all the modules on \s-1CPAN\s0 depend on
this process, so there's no real opportunity to change to something
better.
.IP "dynamic_config" 4
.IX Item "dynamic_config"
[version 0.07]
.Sp
A boolean flag indicating whether the \fIBuild.PL\fR file must be
executed, or whether this module can be built, tested and installed
solely from consulting its metadata file.  The main reason to set this
to a true value is that your module performs some dynamic
configuration as part of its build/install process.  If the flag is
omitted, the \fI\s-1META\s0.yml\fR spec says that installation tools should
treat it as 1 (true), because this is a safer way to behave.
.Sp
Currently \f(CW\*(C`Module::Build\*(C'\fR doesn't actually do anything with this flag
\&\- it's up to higher-level tools like \f(CW\*(C`CPAN.pm\*(C'\fR to do something useful
with it.  It can potentially bring lots of security, packaging, and
convenience improvements.
.IP "extra_compiler_flags" 4
.IX Item "extra_compiler_flags"
.PD 0
.IP "extra_linker_flags" 4
.IX Item "extra_linker_flags"
.PD
[version 0.19]
.Sp
These parameters can contain array references (or strings, in which
case they will be split into arrays) to pass through to the compiler
and linker phases when compiling/linking C code.  For example, to tell
the compiler that your code is \*(C+, you might do:
.Sp
.Vb 5
\&  my $build = Module::Build\->new
\&    (
\&     module_name          => \*(AqFoo::Bar\*(Aq,
\&     extra_compiler_flags => [\*(Aq\-x\*(Aq, \*(Aqc++\*(Aq],
\&    );
.Ve
.Sp
To link your \s-1XS\s0 code against glib you might write something like:
.Sp
.Vb 7
\&  my $build = Module::Build\->new
\&    (
\&     module_name          => \*(AqFoo::Bar\*(Aq,
\&     dynamic_config       => 1,
\&     extra_compiler_flags => scalar \`glib\-config \-\-cflags\`,
\&     extra_linker_flags   => scalar \`glib\-config \-\-libs\`,
\&    );
.Ve
.IP "get_options" 4
.IX Item "get_options"
[version 0.26]
.Sp
You can pass arbitrary command line options to \fIBuild.PL\fR or
\&\fIBuild\fR, and they will be stored in the Module::Build object and can
be accessed via the \*(L"\fIargs()\fR\*(R" method.  However, sometimes you want
more flexibility out of your argument processing than this allows.  In
such cases, use the \f(CW\*(C`get_options\*(C'\fR parameter to pass in a hash
reference of argument specifications, and the list of arguments to
\&\fIBuild.PL\fR or \fIBuild\fR will be processed according to those
specifications before they're passed on to \f(CW\*(C`Module::Build\*(C'\fR's own
argument processing.
.Sp
The supported option specification hash keys are:
.RS 4
.IP "type" 4
.IX Item "type"
The type of option.  The types are those supported by Getopt::Long; consult
its documentation for a complete list.  Typical types are \f(CW\*(C`=s\*(C'\fR for strings,
\&\f(CW\*(C`+\*(C'\fR for additive options, and \f(CW\*(C`!\*(C'\fR for negatable options.  If the
type is not specified, it will be considered a boolean, i.e. no
argument is taken and a value of 1 will be assigned when the option is
encountered.
.IP "store" 4
.IX Item "store"
A reference to a scalar in which to store the value passed to the option.
If not specified, the value will be stored under the option name in the
hash returned by the \f(CW\*(C`args()\*(C'\fR method.
.IP "default" 4
.IX Item "default"
A default value for the option.  If no default value is specified and no option
is passed, then the option key will not exist in the hash returned by
\&\f(CW\*(C`args()\*(C'\fR.
.RE
.RS 4
.Sp
You can combine references to your own variables or subroutines with
unreferenced specifications, for which the result will also be stored in the
hash returned by \f(CW\*(C`args()\*(C'\fR.  For example:
.Sp
.Vb 10
\&  my $loud = 0;
\&  my $build = Module::Build\->new
\&    (
\&     module_name => \*(AqFoo::Bar\*(Aq,
\&     get_options => {
\&                     loud =>     { store => \e$loud },
\&                     dbd  =>     { type  => \*(Aq=s\*(Aq   },
\&                     quantity => { type  => \*(Aq+\*(Aq    },
\&                    }
\&    );
\&
\&  print STDERR "HEY, ARE YOU LISTENING??\en" if $loud;
\&  print "We\*(Aqll use the ", $build\->args(\*(Aqdbd\*(Aq), " DBI driver\en";
\&  print "Are you sure you want that many?\en"
\&    if $build\->args(\*(Aqquantity\*(Aq) > 2;
.Ve
.Sp
The arguments for such a specification can be called like so:
.Sp
.Vb 1
\&  perl Build.PL \-\-loud \-\-dbd=DBD::pg \-\-quantity \-\-quantity \-\-quantity
.Ve
.Sp
\&\fB\s-1WARNING:\s0\fR Any option specifications that conflict with Module::Build's own
options (defined by its properties) will throw an exception.
.Sp
Consult the Getopt::Long documentation for details on its usage.
.RE
.IP "include_dirs" 4
.IX Item "include_dirs"
[version 0.24]
.Sp
Specifies any additional directories in which to search for C header
files.  May be given as a string indicating a single directory, or as
a list reference indicating multiple directories.
.IP "install_path" 4
.IX Item "install_path"
[version 0.19]
.Sp
You can set paths for individual installable elements by using the
\&\f(CW\*(C`install_path\*(C'\fR parameter:
.Sp
.Vb 8
\&  my $build = Module::Build\->new
\&    (
\&     ...other stuff here...
\&     install_path => {
\&                      lib  => \*(Aq/foo/lib\*(Aq,
\&                      arch => \*(Aq/foo/lib/arch\*(Aq,
\&                     }
\&    );
.Ve
.IP "installdirs" 4
.IX Item "installdirs"
[version 0.19]
.Sp
Determines where files are installed within the normal perl hierarchy
as determined by \fIConfig.pm\fR.  Valid values are: \f(CW\*(C`core\*(C'\fR, \f(CW\*(C`site\*(C'\fR,
\&\f(CW\*(C`vendor\*(C'\fR.  The default is \f(CW\*(C`site\*(C'\fR.  See
\&\*(L"\s-1INSTALL\s0 \s-1PATHS\s0\*(R" in Module::Build
.IP "license" 4
.IX Item "license"
[version 0.07]
.Sp
Specifies the licensing terms of your distribution.  Valid options include:
.RS 4
.IP "apache" 4
.IX Item "apache"
The distribution is licensed under the Apache Software License
(<http://opensource.org/licenses/apachepl.php>).
.IP "artistic" 4
.IX Item "artistic"
The distribution is licensed under the Artistic License, as specified
by the \fIArtistic\fR file in the standard Perl distribution.
.IP "artistic_2" 4
.IX Item "artistic_2"
The distribution is licensed under the Artistic 2.0 License
(<http://opensource.org/licenses/artistic\-license\-2.0.php>.)
.IP "bsd" 4
.IX Item "bsd"
The distribution is licensed under the \s-1BSD\s0 License
(<http://www.opensource.org/licenses/bsd\-license.php>).
.IP "gpl" 4
.IX Item "gpl"
The distribution is licensed under the terms of the \s-1GNU\s0 General
Public License (<http://www.opensource.org/licenses/gpl\-license.php>).
.IP "lgpl" 4
.IX Item "lgpl"
The distribution is licensed under the terms of the \s-1GNU\s0 Lesser
General Public License
(<http://www.opensource.org/licenses/lgpl\-license.php>).
.IP "mit" 4
.IX Item "mit"
The distribution is licensed under the \s-1MIT\s0 License
(<http://opensource.org/licenses/mit\-license.php>).
.IP "mozilla" 4
.IX Item "mozilla"
The distribution is licensed under the Mozilla Public
License.  (<http://opensource.org/licenses/mozilla1.0.php> or
<http://opensource.org/licenses/mozilla1.1.php>)
.IP "open_source" 4
.IX Item "open_source"
The distribution is licensed under some other Open Source
Initiative-approved license listed at
<http://www.opensource.org/licenses/>.
.IP "perl" 4
.IX Item "perl"
The distribution may be copied and redistributed under the same terms
as Perl itself (this is by far the most common licensing option for
modules on \s-1CPAN\s0).  This is a dual license, in which the user may
choose between either the \s-1GPL\s0 or the Artistic license.
.IP "restrictive" 4
.IX Item "restrictive"
The distribution may not be redistributed without special permission
from the author and/or copyright holder.
.IP "unrestricted" 4
.IX Item "unrestricted"
The distribution is licensed under a license that is \fBnot\fR approved
by www.opensource.org but that allows distribution without
restrictions.
.RE
.RS 4
.Sp
Note that you must still include the terms of your license in your
documentation \- this field only lets automated tools figure out your
licensing restrictions.  Humans still need something to read.  If you
choose to provide this field, you should make sure that you keep it in
sync with your written documentation if you ever change your licensing
terms.
.Sp
It is a fatal error to use a license other than the ones mentioned
above.  This is not because I wish to impose licensing terms on you \-
please let me know if you would like another license option to be
added to the list.  You may also use a license type of \f(CW\*(C`unknown\*(C'\fR if
you don't wish to specify your terms (but this is usually not a good
idea for you to do!).
.Sp
I just started out with a small set of licenses to keep things simple,
figuring I'd let people with actual working knowledge in this area
tell me what to do.  So if that's you, drop me a line.
.RE
.IP "meta_add" 4
.IX Item "meta_add"
[version 0.28]
.Sp
A hash of key/value pairs that should be added to 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
See the \*(L"\s-1MODULE\s0 \s-1METADATA\s0\*(R" section for details.
.IP "meta_merge" 4
.IX Item "meta_merge"
[version 0.28]