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


=head1 NAME

Mouse::XS - A Mouse guts in XS

=head1 VERSION

This document describes Mouse version 0.42

=head1 DESCRIPTION

Mouse has an optional XS implementation, which is automatically built
and used if available.

=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
5176a3e4	8	This document describes Mouse version 0.42
ccb38d0b	9
	10	=head1 DESCRIPTION
	11
a010dc3a	12	Mouse has an optional XS implementation, which is automatically built
ccb38d0b	13	and used if available.
	14
	15	=head2 INSTALL
	16
a010dc3a	17	The XS implementation are selected by default, but you can force it by
	18	passing the C<--xs> option to F<Makefile.PL>.
	19
	20	perl Makefile.PL --xs
	21
ccb38d0b	22	If you do not want to build the XS implementation, you can pass the C<--pp>
	23	option to F<Makefile.PL>.
	24
	25	perl Makefile.PL --pp
	26
	27	=head2 The MOUSE_PUREPERL environment variable
	28
	29	It can be used to enable the use of Mouse::PurePerl.
	30
450e8bf6	31	=head1 DEPENDENCIES
	32
	33	The XS implementation requires Perl 5.8.1 or later, and a C compiler.
	34
ccb38d0b	35	=head1 SEE ALSO
ccb38d0b	36
450e8bf6	37	L<Mouse>
450e8bf6	38
ccb38d0b	39	L<Mouse::PurePerl>
	40
	41	=cut