=head1 NAME

Shipwright::Manual::ENV - ENV variables Shipwright uses

=head1 SYNOPSIS

Introduce ENV variables Shipwright makes use of.

=head1 DESCRIPTION

=over 4

=item HOME

user's home directory, e.g. /home/joe

=item USER

user's name, e.g. joe

=item SHIPWRIGHT_SHIPYARD

=item SHIPWRIGHT_REPOSITORY ( deprecated )

    shipwright's shipyard's uri, i.e. the uri occurs in cmd option -r ...
    if there's no -r arg in cmd, this env is used if any.

    SHIPWRIGHT_SHIPYARD has higher priority.

    e.g. fs:/tmp/fs

=item SHIPWRIGHT_MAKE

    path of 'make' cmd, default value is 'make' on UNIX

=item SHIPWRIGHT_SOURCE_ROOT

    directory where shipwright keeps source data except downloads,
    which will be in $ENV{SHIPWRIGHT_USER_ROOT}/downloads.
    default value is a temp dir.

=item SHIPWRIGHT_USER_ROOT

    directory where shipwright keeps internal data
    ( mostly, to speed things up ).
    default value is ~/.shipwright

=item SHIPWRIGHT_LWP_TIMEOUT

    LWP timeout( seconds ).
    technically, it's the seconds we take to call $ua->timeout($seconds)

=item SHIPWRIGHT_SVK

path of F<svk> command, default value is F<svk>.

=item SHIPWRIGHT_SVN 

path of F<svn> command, default value is F<svn>.
F<svnadmin> command is expected to be in the same directory as F<svn>.

=item SHIPWRIGHT_GIT 

path of F<git> command, default value is F<git>.

=item SHIPWRIGHT_DZIL 

path of F<dzil> command, default value is F<dzil>.

=item SHIPWRIGHT_CPAN_MIRROR

url of the cpan mirror

=item SHIPWRIGHT_TEST_EXTRA

    some tests depend on something that's missing in some distribution, to
    make cpan's report happy, thoese tests are disabled by default.
    you can enable this to set this true.

=item SHIPWRIGHT_TEST_SVK

    test svk backend if this's true

=item SHIPWRIGHT_TEST_SVN

    test svn backend if this's true

=item SHIPWRIGHT_TEST_GIT

    test git backend if this's true

=item SHIPWRIGHT_DEVEL

    use confess instead of die if this's true

=item PERL_MM_USE_DEFAULT

    CPAN in Shipwright is always run without interaction,
    so this will always be true.

=item FTP_PASSIVE

    used in FTP source, true by default 

=item SVKROOT

    used in tests, svk depot path

=back

=head1 SEE ALSO

L<Shipwright>, L<Shipwright::Manual>

=head1 AUTHORS

sunnavy  C<< <sunnavy@bestpractical.com> >>

=head1 LICENCE AND COPYRIGHT

Shipwright is Copyright 2007-2012 Best Practical Solutions, LLC.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.