[p5sagit/Sub-Name.git] / INSTALL

This is the Perl distribution Sub-Name.

Installing Sub-Name is straightforward.

## Installation with cpanm

If you have cpanm, you only need one line:

    % cpanm Sub::Name

If it does not have permission to install modules to the current perl, cpanm
will automatically set up and install to a local::lib in your home directory.
See the local::lib documentation (https://metacpan.org/pod/local::lib) for
details on enabling it in your environment.

## Installing with the CPAN shell

Alternatively, if your CPAN shell is set up, you should just be able to do:

    % cpan Sub::Name

## Manual installation

As a last resort, you can manually install it. Download the tarball, untar it,
then build it:

    % perl Makefile.PL
    % make && make test

Then install it:

    % make install

If your perl is system-managed, you can create a local::lib in your home
directory to install modules to. For details, see the local::lib documentation:
https://metacpan.org/pod/local::lib

## Documentation

Sub-Name documentation is available as POD.
You can run perldoc from a shell to read the documentation:

    % perldoc Sub::Name
Commit	Line	Data
71457ae8	1	This is the Perl distribution Sub-Name.
	2
	3	Installing Sub-Name is straightforward.
	4
	5	## Installation with cpanm
	6
	7	If you have cpanm, you only need one line:
	8
	9	% cpanm Sub::Name
	10
63ea1fd0	11	If it does not have permission to install modules to the current perl, cpanm
	12	will automatically set up and install to a local::lib in your home directory.
	13	See the local::lib documentation (https://metacpan.org/pod/local::lib) for
	14	details on enabling it in your environment.
71457ae8	15
	16	## Installing with the CPAN shell
	17
	18	Alternatively, if your CPAN shell is set up, you should just be able to do:
	19
	20	% cpan Sub::Name
	21
	22	## Manual installation
	23
	24	As a last resort, you can manually install it. Download the tarball, untar it,
	25	then build it:
	26
	27	% perl Makefile.PL
	28	% make && make test
	29
	30	Then install it:
	31
	32	% make install
	33
63ea1fd0	34	If your perl is system-managed, you can create a local::lib in your home
	35	directory to install modules to. For details, see the local::lib documentation:
	36	https://metacpan.org/pod/local::lib
71457ae8	37
	38	## Documentation
	39
	40	Sub-Name documentation is available as POD.
	41	You can run perldoc from a shell to read the documentation:
	42
	43	% perldoc Sub::Name