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