view release on metacpan or  search on metacpan

devdata/perlbrew-help.0.74  view on Meta::CPAN

NAME
    perlbrew - Perl environment manager.

SYNOPSIS
    perlbrew command syntax:

        perlbrew <command> [options] [arguments]

    Commands:

        init           Initialize perlbrew environment.
        info           Show useful information about the perlbrew installation

        install        Install perl
        uninstall      Uninstall the given installation
        available      List perls available to install
        lib            Manage local::lib directories.
        alias          Give perl installations a new name
        upgrade-perl   Upgrade the current perl

        list           List perl installations
        use            Use the specified perl in current shell
        off            Turn off perlbrew in current shell
        switch         Permanently use the specified perl as default
        switch-off     Permanently turn off perlbrew (revert to system perl)
        exec           exec programs with specified perl enviroments.

        self-install       Install perlbrew itself under PERLBREW_ROOT/bin
        self-upgrade       Upgrade perlbrew itself.

        install-patchperl  Install patchperl
        install-cpanm      Install cpanm, a friendly companion.
        install-multiple   Install multiple versions and flavors of perl

        download       Download the specified perl distribution tarball.
        clean          Purge tarballs and build directories
        version        Display version
        help           Read more detailed instructions

    Generic command options:

        -q --quiet     Be quiet on informative output message.
        -v --verbose   Tell me more about it.

    See `perlbrew help` for the full documentation of perlbrew, or

    See `perlbrew help <command>` for detail description of the command.

CONFIGURATION
    PERLBREW_ROOT
        By default, perlbrew builds and installs perls into
        "$ENV{HOME}/perl5/perlbrew" directory. To use a different directory,
        set this environment variable in your "bashrc" to the directory in
        your shell RC before sourcing perlbrew's RC.

        It is possible to share one perlbrew root with multiple user account
        on the same machine. Therefore people do not have to install the
        same version of perl over an over. Let's say "/opt/perl5" is the
        directory we want to share. All users should be able append this
        snippet to their bashrc to make it effective:

            export PERLBREW_ROOT=/opt/perl5
            source ${PERLBREW_ROOT}/etc/bashrc

        After doing so, everyone's PATH should include "/opt/perl5/bin" and
        "/opt/perl5/perls/${PERLBREW_PERL}/bin". Each user can invoke
        "perlbrew switch" and "perlbrew use" to independently switch to
        different perl environment of their choice. However, only the user
        with write permission to $PERLBREW_ROOT may install CPAN modules.
        This is both good and bad depending on the working convention of
        your team.

        If you wish to install CPAN modules only for yourself, you should
        use the "lib" command to construct a personal local::lib
        environment. local::lib environments are personal, and are not
        shared between different users. For more detail, read "perlbrew help
        lib" and the documentation of local::lib.

        If you want even a cooler module isolation and wish to install CPAN
        modules used for just one project, you should use carton for this
        purpose.

        It is also possible to set this variable before installing perlbrew
        to make perlbrew install itself under the given PERLBREW_ROOT:

            export PERLBREW_ROOT=/opt/perl5
            curl -kL http://install.perlbrew.pl | bash

        After doing this, the perlbrew executable is installed as
        "/opt/perl5/bin/perlbrew"

    PERLBREW_HOME
        By default, perlbrew stores per-user setting to
        "$ENV{HOME}/.perlbrew" directory. To use a different directory, set
        this environment variable in your shell RC before sourcing
        perlbrew's RC.

        In some cases, say, your home directory is on NFS and shared across
        multiple machines, you may wish to have several different perlbrew
        setting per-machine. To do so, you can use the "PERLBREW_HOME"
        environment variable to tell perlbrew where to look for the
        initialization file. Here's a brief bash snippet for the given
        scenario.

            if [ "$(hostname)" == "machine-a" ]; then
                export PERLBREW_HOME=~/.perlbrew-a
            elif [ "$(hostname)" == "machine-b" ]; then
                export PERLBREW_HOME=~/.perlbrew-b
            fi

            source ~/perl5/perlbrew/etc/bashrc

    PERLBREW_CONFIGURE_FLAGS
        This environment variable specify the list of command like flags to
        pass through to 'sh Configure'. By default it is '-de'.

    PERLBREW_CPAN_MIRROR
        The CPAN mirror url of your choice.