Add built local::lib

[catagits/Gitalist.git] / local-lib5 / man / man3 / Module::Build::Notes.3pm

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Module::Build::Notes 3"
.TH Module::Build::Notes 3 "2009-12-09" "perl v5.8.7" "User Contributed Perl Documentation"
.SH "NAME"
$notes_name \- Configuration for $module_name
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use $notes_name;
\&  \e$value = $notes_name\->config('foo');
\&  \e$value = $notes_name\->feature('bar');
.Ve
.PP
.Vb 2
\&  \e@names = $notes_name\->config_names;
\&  \e@names = $notes_name\->feature_names;
.Ve
.PP
.Vb 3
\&  $notes_name\->set_config(foo => \e$new_value);
\&  $notes_name\->set_feature(bar => \e$new_value);
\&  $notes_name\->write;  # Save changes
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module holds the configuration data for the \f(CW$module_name\fR
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 \f(CW$notes_name\fR
module, and you should attempt to understand the repercussions of your
actions.
.SH "METHODS"
.IX Header "METHODS"
.IP "config(\e$name)" 4
.IX Item "config($name)"
Given a string argument, returns the value of the configuration item
by that name, or \f(CW\*(C`undef\*(C'\fR if no such item exists.
.IP "feature(\e$name)" 4
.IX Item "feature($name)"
Given a string argument, returns the value of the feature by that
name, or \f(CW\*(C`undef\*(C'\fR if no such feature exists.
.IP "set_config(\e$name, \e$value)" 4
.IX Item "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
\&\f(CW\*(C`Data::Dumper\*(C'\fR.  This includes references, objects (usually), and
complex data structures.  It probably does not include transient
things like filehandles or sockets.
.IP "set_feature(\e$name, \e$value)" 4
.IX Item "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.
.IP "\fIconfig_names()\fR" 4
.IX Item "config_names()"
Returns a list of all the names of config items currently defined in
\&\f(CW$notes_name\fR, or in scalar context the number of items.
.IP "\fIfeature_names()\fR" 4
.IX Item "feature_names()"
Returns a list of all the names of features currently defined in
\&\f(CW$notes_name\fR, or in scalar context the number of features.
.IP "\fIauto_feature_names()\fR" 4
.IX Item "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.
.IP "\fIwrite()\fR" 4
.IX Item "write()"
Commits any changes from \f(CW\*(C`set_config()\*(C'\fR and \f(CW\*(C`set_feature()\*(C'\fR to disk.
Requires write access to the \f(CW$notes_name\fR module.
.SH "AUTHOR"
.IX Header "AUTHOR"
\&\f(CW$notes_name\fR was automatically created using \f(CW\*(C`Module::Build\*(C'\fR.
\&\f(CW\*(C`Module::Build\*(C'\fR was written by Ken Williams, but he holds no
authorship claim or copyright claim to the contents of \f(CW$notes_name\fR.