local-lib5/man/man3/Module::Build::Notes.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Module::Build::Notes 3"
 132 .TH Module::Build::Notes 3 "2009-12-09" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 $notes_name \- Configuration for $module_name
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 3
 138 \&  use $notes_name;
 139 \&  \e$value = $notes_name\->config('foo');
 140 \&  \e$value = $notes_name\->feature('bar');
 141 .Ve
 142 .PP
 143 .Vb 2
 144 \&  \e@names = $notes_name\->config_names;
 145 \&  \e@names = $notes_name\->feature_names;
 146 .Ve
 147 .PP
 148 .Vb 3
 149 \&  $notes_name\->set_config(foo => \e$new_value);
 150 \&  $notes_name\->set_feature(bar => \e$new_value);
 151 \&  $notes_name\->write;  # Save changes
 152 .Ve
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 This module holds the configuration data for the \f(CW$module_name\fR
 156 module.  It also provides a programmatic interface for getting or
 157 setting that configuration data.  Note that in order to actually make
 158 changes, you'll have to have write access to the \f(CW$notes_name\fR
 159 module, and you should attempt to understand the repercussions of your
 160 actions.
 161 .SH "METHODS"
 162 .IX Header "METHODS"
 163 .IP "config(\e$name)" 4
 164 .IX Item "config($name)"
 165 Given a string argument, returns the value of the configuration item
 166 by that name, or \f(CW\*(C`undef\*(C'\fR if no such item exists.
 167 .IP "feature(\e$name)" 4
 168 .IX Item "feature($name)"
 169 Given a string argument, returns the value of the feature by that
 170 name, or \f(CW\*(C`undef\*(C'\fR if no such feature exists.
 171 .IP "set_config(\e$name, \e$value)" 4
 172 .IX Item "set_config($name, $value)"
 173 Sets the configuration item with the given name to the given value.
 174 The value may be any Perl scalar that will serialize correctly using
 175 \&\f(CW\*(C`Data::Dumper\*(C'\fR.  This includes references, objects (usually), and
 176 complex data structures.  It probably does not include transient
 177 things like filehandles or sockets.
 178 .IP "set_feature(\e$name, \e$value)" 4
 179 .IX Item "set_feature($name, $value)"
 180 Sets the feature with the given name to the given boolean value.  The
 181 value will be converted to 0 or 1 automatically.
 182 .IP "\fIconfig_names()\fR" 4
 183 .IX Item "config_names()"
 184 Returns a list of all the names of config items currently defined in
 185 \&\f(CW$notes_name\fR, or in scalar context the number of items.
 186 .IP "\fIfeature_names()\fR" 4
 187 .IX Item "feature_names()"
 188 Returns a list of all the names of features currently defined in
 189 \&\f(CW$notes_name\fR, or in scalar context the number of features.
 190 .IP "\fIauto_feature_names()\fR" 4
 191 .IX Item "auto_feature_names()"
 192 Returns a list of all the names of features whose availability is
 193 dynamically determined, or in scalar context the number of such
 194 features.  Does not include such features that have later been set to
 195 a fixed value.
 196 .IP "\fIwrite()\fR" 4
 197 .IX Item "write()"
 198 Commits any changes from \f(CW\*(C`set_config()\*(C'\fR and \f(CW\*(C`set_feature()\*(C'\fR to disk.
 199 Requires write access to the \f(CW$notes_name\fR module.
 200 .SH "AUTHOR"
 201 .IX Header "AUTHOR"
 202 \&\f(CW$notes_name\fR was automatically created using \f(CW\*(C`Module::Build\*(C'\fR.
 203 \&\f(CW\*(C`Module::Build\*(C'\fR was written by Ken Williams, but he holds no
 204 authorship claim or copyright claim to the contents of \f(CW$notes_name\fR.