[gitmo/Mouse.git] / lib / Mouse / XS.pod


=head1 NAME

Mouse::XS - A Mouse guts in XS

=head1 VERSION

This document describes Mouse version 0.50_04

=head1 DESCRIPTION

Mouse has an optional XS implementation, which is automatically built
and used if available. According to benchmarks, this is about 2 times
faster than Mouse::PurePerl.

=head2 INSTALL

The XS implementation are selected by default, but you can force it by
passing the C<--xs> option to F<Makefile.PL>.

    perl Makefile.PL --xs

If you do not want to build the XS implementation, you can pass the C<--pp>
option to F<Makefile.PL>.

    perl Makefile.PL --pp

=head2 The MOUSE_PUREPERL environment variable

It can be used to enable the use of Mouse::PurePerl.

=head1 DEPENDENCIES

The XS implementation requires Perl 5.8.1 or later, and a C compiler.

=head1 SEE ALSO

L<Mouse>

L<Mouse::PurePerl>

=cut
Commit	Line	Data
ccb38d0b	1
	2	=head1 NAME
	3
	4	Mouse::XS - A Mouse guts in XS
	5
	6	=head1 VERSION
	7
c2168931	8	This document describes Mouse version 0.50_04
ccb38d0b	9
	10	=head1 DESCRIPTION
	11
a010dc3a	12	Mouse has an optional XS implementation, which is automatically built
f6387355	13	and used if available. According to benchmarks, this is about 2 times
e229d5a9	14	faster than Mouse::PurePerl.
ccb38d0b	15
	16	=head2 INSTALL
	17
a010dc3a	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
ccb38d0b	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 environment variable
	29
	30	It can be used to enable the use of Mouse::PurePerl.
	31
450e8bf6	32	=head1 DEPENDENCIES
	33
	34	The XS implementation requires Perl 5.8.1 or later, and a C compiler.
	35
ccb38d0b	36	=head1 SEE ALSO
ccb38d0b	37
450e8bf6	38	L<Mouse>
450e8bf6	39
ccb38d0b	40	L<Mouse::PurePerl>
	41
	42	=cut