.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .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. \*(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- .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" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" 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::XSUtil 3pm" .TH Module::Build::XSUtil 3pm "2014-08-12" "perl v5.18.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Module::Build::XSUtil \- A Module::Build class for building XS modules .SH "SYNOPSIS" .IX Header "SYNOPSIS" Use in your Build.PL .PP .Vb 3 \& use strict; \& use warnings; \& use Module::Build::XSUtil; \& \& my $builder = Module::Build::XSUtil\->new( \& dist_name => \*(AqYour\-XS\-Module\*(Aq, \& license => \*(Aqperl\*(Aq, \& dist_author => \*(AqYour Name \*(Aq, \& dist_version_from => \*(Aqlib/Your/XS/Module\*(Aq, \& generate_ppport_h => \*(Aqlib/Your/XS/ppport.h\*(Aq, \& generate_xshelper_h => \*(Aqlib/Your/XS/xshelper.h\*(Aq, \& needs_compiler_c99 => 1, \& ); \& \& $builder\->create_build_script(); .Ve .PP Use in custom builder module. .PP .Vb 4 \& pakcage builder::MyBuilder; \& use strict; \& use warnings; \& use base \*(AqModule::Build::XSUtil\*(Aq; \& \& sub new { \& my ($class, %args) = @_; \& my $self = $class\->SUPER::new( \& %args, \& generate_ppport_h => \*(Aqlib/Your/XS/ppport.h\*(Aq, \& generate_xshelper_h => \*(Aqlib/Your/XS/xshelper.h\*(Aq, \& needs_compiler_c99 => 1, \& ); \& return $self; \& } \& \& 1; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Module::Build::XSUtil is subclass of Module::Build for support building \s-1XS\s0 modules. .PP This is a list of a new parameters in the Module::Build::new method: .IP "needs_compiler_c99" 4 .IX Item "needs_compiler_c99" This option checks C99 compiler's availability. If it's not available, Build.PL exits by 0. .IP "needs_compiler_cpp" 4 .IX Item "needs_compiler_cpp" This option checks \*(C+ compiler's availability. If it's not available, Build.PL exits by 0. .Sp In addition, append 'extra_compiler_flags' and 'extra_linker_flags' for \*(C+. .IP "generate_ppport_h" 4 .IX Item "generate_ppport_h" Genereate ppport.h by Devel::PPPort. .IP "generate_xshelper_h" 4 .IX Item "generate_xshelper_h" Genereate xshelper.h which is a helper header file to include \s-1EXTERN\s0.h, perl.h, \s-1XSUB\s0.h and ppport.h, and defines some portability stuff which are not supported by ppport.h. .Sp It is porting from Module::Install::XSUtil. .IP "cc_warnings" 4 .IX Item "cc_warnings" Enable compiler warnings flag. It is enable by default. .IP "\-g options" 4 .IX Item "-g options" If invoke Build.PL with '\-g' option, It will build with debug options. .SH "SEE ALSO" .IX Header "SEE ALSO" Module::Install::XSUtil .SH "LICENSE" .IX Header "LICENSE" Copyright (C) Hideaki Ohno. .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "AUTHOR" .IX Header "AUTHOR" Hideaki Ohno