Merge branch 'master' of github.com:gfx/p5-Mouse-temporary
[gitmo/Mouse.git] / lib / Mouse / XS.pod
CommitLineData
ccb38d0b 1
2=head1 NAME
3
4Mouse::XS - A Mouse guts in XS
5
6=head1 VERSION
7
14cf9b5a 8This document describes Mouse version 0.95
ccb38d0b 9
10=head1 DESCRIPTION
11
a010dc3a 12Mouse has an optional XS implementation, which is automatically built
f6387355 13and used if available. According to benchmarks, this is about 2 times
e229d5a9 14faster than Mouse::PurePerl.
ccb38d0b 15
16=head2 INSTALL
17
a010dc3a 18The XS implementation are selected by default, but you can force it by
19passing the C<--xs> option to F<Makefile.PL>.
20
21 perl Makefile.PL --xs
22
ccb38d0b 23If you do not want to build the XS implementation, you can pass the C<--pp>
24option to F<Makefile.PL>.
25
26 perl Makefile.PL --pp
27
5ab8f626 28=head2 The MOUSE_PUREPERL (or PERL_ONLY) environment variable
ccb38d0b 29
5ab8f626 30It can be used to enable the use of Mouse::PurePerl in order to test
31and debug programs that use Mouse.
ccb38d0b 32
450e8bf6 33=head1 DEPENDENCIES
34
35The XS implementation requires Perl 5.8.1 or later, and a C compiler.
36
ccb38d0b 37=head1 SEE ALSO
38
450e8bf6 39L<Mouse>
40
ccb38d0b 41L<Mouse::PurePerl>
42
43=cut