git.maemo.org Git - pkg-perl/blob - deb-src/libwx-perl/libwx-perl-0.96/blib/man3/Wx::build::MakeMaker.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   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 "build::Wx::build::MakeMaker 3"
 132 .TH build::Wx::build::MakeMaker 3 "2007-04-29" "perl v5.8.3" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Wx::build::MakeMaker \- ExtUtils::MakeMaker specialisation for wxPerl modules
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 use Wx::build::MakeMaker;
 138 .PP
 139 wxWriteMakefile( \s-1NAME\s0         => 'My::Module',
 140                  \s-1VERSION_FROM\s0 => 'Module.pm' );
 141 .SH "FUNCTIONS"
 142 .IX Header "FUNCTIONS"
 143 .Sh "wxWriteMakefile"
 144 .IX Subsection "wxWriteMakefile"
 145 .Vb 1
 146 \&  wxWriteMakefile( arameter => value, ... );
 147 .Ve
 148 .PP
 149 This functions is meant to be used exactly as
 150 ExtUtils::MakeMaker::WriteMakefile (see). It accepts all WriteMakefile's
 151 parameters, plus:
 152 .IP "* \s-1WX_CORE_LIB\s0" 4
 153 .IX Item "WX_CORE_LIB"
 154 .Vb 1
 155 \&  WX_CORE_LIB => 'xrc core base'
 156 .Ve
 157 .Sp
 158 link libraries from wxWidgets' core or contrib directory.
 159 If not spedified, defaults to 'adv html core net base' for compatibility.
 160 .IP "* \s-1WX_LIB\s0" 4
 161 .IX Item "WX_LIB"
 162 .Vb 1
 163 \&  WX_LIB => '-lxrc'
 164 .Ve
 165 .Sp
 166 Link additional libraries from wxWidgets' contrib directory.
 167 .IP "* \s-1REQUIRE_WX\s0" 4
 168 .IX Item "REQUIRE_WX"
 169 .Vb 1
 170 \&  REQUIRE_WX => 2.003002  # wxWidgets 2.3.2
 171 .Ve
 172 .Sp
 173 Do not build this module if wxWidgets' version is lower than the version
 174 specified.
 175 .IP "* \s-1NO_WX_PLATFORMS\s0" 4
 176 .IX Item "NO_WX_PLATFORMS"
 177 .Vb 1
 178 \&  NO_WX_PLATFORMS => [ 'x11', 'msw' ]
 179 .Ve
 180 .Sp
 181 Do not build this module on the specified platform(s).
 182 .IP "* ON_WX_PLATFORMs" 4
 183 .IX Item "ON_WX_PLATFORMs"
 184 .Vb 1
 185 \&  ON_WX_PLATFORMS => [ 'gtk' ]
 186 .Ve
 187 .Sp
 188 only build this module on the specified platform(s).
 189 .SH "PRIVATE FUNCTIONS"
 190 .IX Header "PRIVATE FUNCTIONS"
 191 These functions are here for reference, do not use them.
 192 .Sh "is_core"
 193 .IX Subsection "is_core"
 194 .Vb 1
 195 \&  if( is_core ) { ... }
 196 .Ve
 197 .PP
 198 True if it is building the wxPerl core (Wx.dll), false otherwise.
 199 .Sh "is_wxPerl_tree"
 200 .IX Subsection "is_wxPerl_tree"
 201 .Vb 1
 202 \&  if( is_wxPerl_tree ) { ... }
 203 .Ve
 204 .PP
 205 True if it is building any part of wxPerl, false otherwise.
 206 .Sh "set_hook_package"
 207 .IX Subsection "set_hook_package"
 208 .Vb 1
 209 \&  Wx::build::MakeMaker::set_hook_package( 'package_name' );
 210 .Ve
 211 .PP
 212 Package to be hooked into the MakeMaker inheritance chain.
 213 .SH "METHODS"
 214 .IX Header "METHODS"
 215 .Sh "get_api_directory"
 216 .IX Subsection "get_api_directory"
 217 .Vb 1
 218 \&  my $dir = $cfg->get_api_directory;
 219 .Ve
 220 .Sh "get_arch_directory"
 221 .IX Subsection "get_arch_directory"
 222 .Vb 1
 223 \&  my $dir = $cfg->get_arch_directory;
 224 .Ve