ActivePerl 5.20.2.2001 -- Installation Guide

# Installing ActivePerl 5.20.2.2001

- General Installation Notes
- Installing ActivePerl on Windows (x86)

- Windows Prerequisites
- Upgrading from ActivePerl 5.16
- Windows Installers
- Windows Configuration
- Uninstalling ActivePerl on Windows

- Installing ActivePerl on Mac OS X (x86)

- OS X Prerequisites
- OS X Installer
- OS X Configuration
- Uninstalling ActivePerl on OS X

- Installing ActivePerl on Linux (x86)

- Linux Prerequisites
- Linux Installers
- Linux Configuration
- Uninstalling ActivePerl on Linux

- Installing ActivePerl on Solaris (sparc, x86)

- Solaris Prerequisites
- Solaris Installers
- Solaris Configuration
- Uninstalling ActivePerl on Solaris

## General Installation Notes

Welcome, and thank you for choosing ActivePerl.

- Version Numbers:The first three numbers of an ActivePerl release correspond to the core Perl version. The fourth number is the ActivePerl build number, which may be followed by a fifth number that specifies a modified build for ActivePerl Enterprise. For example, this release of ActivePerl is 5.20.2.2001, which corresponds to Perl 5.20.2.
- Binary Incompatibility: ActivePerl 2000 series builds (Perl 5.20) are not binary-compatible with the 1800 (Perl 5.18), and older series builds. In particular, do not attempt to use extensions or PPM packages built for an older series builds with ActivePerl 1800 series builds and vice versa.
- Side-by-Side x64 and x86 Installation: On 64 bit operating systems which support 32 bit compatibility, both x86 and x64 versions of ActivePerl can be installed on the same system as long as they are installed in separate directories. The Windows MSI installer will suggest the following default directories to keep them separate:
  - Windows x64: `C:\Perl64`
  - Windows x86: `C:\Perl`
  Other installers will not suggest a platform-specific default install directory. You must specify a unique installation directory manually.

## Installing ActivePerl on Windows (x86)

### Windows Prerequisites

- Hardware: 200 MB hard disk space for typical install
- Perl for ISAPI: requires an ISAPI-compatible web server, such as IIS
- PerlScript: requires an ActiveX scripting host such as Internet Explorer or Windows Scripting Host
- Perl Environment Variables: if Perl environment variables such as `PERLLIB`, `PERL5LIB` or `PERL5OPT` have been set on your system, you should unset them before installing ActivePerl. Otherwise, these variables may cause incompatible versions of Perl modules to be used during the installation process.
- System Account: (MSI Installer only) Do not launch the installation package from a directory for which the "System" account does not have read permission. If you do, the Windows Installer Service will not be able to access the MSI file in order to perform the installation. You may get an error message to this effect, or it may fail mysteriously.
- Administrative Privileges: On Windows 2003/Vista systems ActivePerl installations must be performed by a privileged user only. If you install ActivePerl without full administrator privileges, the following problems occur:
  - Environment variables are set only for the current user
  - PerlScript file associations are not created
  - The PerlScript feature will be unavailable
  - Registry entries are created under HKEY_CURRENT_USER and not under HKEY_LOCAL_MACHINE
  - IIS script mappings are not set
  - ActivePerl applications will not write messages to the event log
  - ActivePerl only appears in the Add/Remove Programs list for the current user

### Upgrading from ActivePerl 5.18

Upgrading from earlier ActivePerl versions requires that you delete the old version of ActivePerl, and then install the 5.20 version. This means that any additional packages that were installed using PPM must be manually reinstalled after the ActivePerl 5.20 installation, so creating a list of these packages is an important first step.

You can use ppm profile to help save and restore your locally installed PPM packages. For example, to save a profile before you upgrade, you can type:

      ppm profile save C:\profile.xml

Once you have saved this profile, you can proceed with the new install. Once done, you can use the profile you saved to reinstall the same set of PPM packages in your new installation by typing:

      ppm profile restore C:\profile.xml

### Windows Installers

If you are using ActivePerl to serve CGI / ASP scripts using IIS or another Web server, stop the Web server before installing ActivePerl.

MSI Installer Package
  To install the MSI package double-click on the MSI file in Windows Explorer.

  Do not install over a 1600 or older series build of ActivePerl. This package must be installed into a separate directory.

  MSI Package Installation from the Command Line
    You can install ActivePerl from the command line using the 'msiexec' program. For example:

            msiexec /i msi_file.msi

    The ADDLOCAL command line property is used to specify which features should be installed. (If ADDLOCAL is not specified, all features are installed.) For example:

            msiexec /i msi_file.msi ADDLOCAL="PERL_FEATURE,PERLIS"

    The following features may be specified with the ADDLOCAL switch:

    - PERL_FEATURE (the Perl core)
    - PPM (the Programmer's Package Manager)
    - PERLIS (the Perl for ISAPI interpreter)
    - PERLSE (the Perl ActiveX Scripting Engine)
    - EXAMPLES (some simple examples)

    A set of command-line properties can be used to configure the installation. For example:

            msiexec /i msi_file.msi TARGETDIR="c:\" PERL_PATH="Yes"

    - TARGETDIR: Used to specify the absolute path where ActivePerl will be installed. If not specified, ActivePerl will be installed in a default location on the same drive as the Windows operating system. If this option is used, a value is required.
      Note: Ensure that the NT 'SYSTEM' user account that actually runs the MSI installer has full access to the target directory.
      Also, don't select a directory with spaces in its name. Perl will likely work, but many scripts will not.
    - PERL_EXT: If set to 'No', the installer will not create the default '.pl' file extension association with `perl`.
    - PL_IISMAP: If is set to 'No', the installer will not create a global IIS script mapping for '.pl' and Perl.
    - PLEX_IISMAP: If set to 'No', the installer will not create a global IIS script mapping for '.plex' and PerlIS.
    - PLX_IISMAP: If set to 'No', the installer will not create a global IIS script mapping for '.plx' and PerlIS.
    - PERL_PATH: If set to 'No', the Perl/bin directory will not be added to the system PATH environment variable.
    - CREATE_SAMPLE_DIR: If set to 'No', the PerlEx sample virtual directory in IIS is not created.

    The following command-line switches can be used:

    Silent Mode
      To run in silent mode, specify the '/q' command line option. The installer will run with no UI.
    Logging
      To log the installation process, specify the '/l' command line option and the name of the log file. For example:

              msiexec /i msi_file.msi /l log.txt

      To enable verbose logging, use the `*v` modifier with the `/l` command line option. For example:

              msiexec /i msi_file.msi /l*v log.txt

AS Installer Package
  The AS package is a generic installation package that can be used on systems where the MSI package is not supported. The AS package provides no uninstall functionality. To install using the AS package, double-click the installer file and follow the prompts.

### Windows Configuration

If you run Perl at the command prompt, the script will be executed by the first `Perl.exe` it encounters in the list of paths in the PATH environment variable. To ensure the script is executed by the Perl interpreter of your choice, specify the complete path to the `Perl.exe` you want to use. (Typing `perl -v` at the command prompt will tell you which version of Perl is currently first in your PATH)

Installing ActivePerl will change your Path environment variable and may change registry settings, such as file associations, which may affect your Web server. If you want to use a previously installed copy of Perl, you will need to modify these settings.

        ftype PerlScript=perl.exe %1 %*
        assoc .pl=PerlScript

### Uninstalling ActivePerl on Windows

MSI Package
  If you installed ActivePerl using the MSI installer, uninstall using the Windows Add / Remove Programs applet.
AS Package
  If you installed ActivePerl using the AS installer, uninstall by deleting the directory in which ActivePerl was installed.
Manual Uninstall
  If you must uninstall ActivePerl manually, delete the Perl directory, including all sub-directories, and the following registry entries:
  1. HKEY_LOCAL_MACHINE/Software/ActiveState/ActivePerl
  2. HKEY_LOCAL_MACHINE/Software/ActiveState/PerlScript
  3. HKEY_LOCAL_MACHINE/Software/Microsoft/Windows/CurrentVersion/Uninstall/ActivePerl

## Installing ActivePerl on Mac OS X (x86)

### OS X Prerequisites

- Hardware: 200 MB hard disk space for typical install
- Operating System: OS X 10.6 or later

### OS X Installer

Installing the OS X Package

  ActivePerl is distributed on Mac OS X as a disk image (`.dmg` file). The disk image contains an installer package (`.pkg` bundle) that installs ActivePerl.

  - Download the ActivePerl disk image (`ActivePerl-<version>-<platform>.dmg`).
  - If the browser does not automatically mount the disk image and open the mounted folder in Finder, double-click `ActivePerl-<version>-<platform>.dmg` to do so.
  - Double-click the ActivePerl installer package (ActivePerl-<version>.pkg) to start the installation.
  - Follow the Installer prompts. The installer will ask for administrative authentication if the current user does not have administrative priviledges.
  - After installation is complete, you may eject the ActivePerl disk image and move ActivePerl-version.dmg to the Trash.

  OS X includes a non-interactive command line interface to Apple's Installer. To install the ActivePerl Apple installer from the command line:

          $ sudo installer -pkg /Users/<username>/ActivePerl-<version>.pkg -target /

  More information on the command line interface to Installer can be found in its `man` page.

### OS X Configuration

The Apple Installer package installs ActivePerl in /usr/local/ActivePerl-5.20. To run the perl interpreter and PPM package manager (without having to enter the full path), add /usr/local/ActivePerl-5.20/bin to your PATH environment variable. For example:

        $ export PATH=/usr/local/ActivePerl-5.20/bin:$PATH
        $ export PATH=/usr/local/ActivePerl-5.20/site/bin:$PATH

To permanently add the directory to your PATH, add it to the `.profile` or `.bash_profile` file in the user's home directory. For example:

        PATH=/usr/local/ActivePerl-5.20/bin:$PATH
        PATH=/usr/local/ActivePerl-5.20/site/bin:$PATH
        export PATH

Alternatively, symbolic links to the binaries can be created in any bin directory currently in the PATH. For example:

        PATH=/Users/<username>/bin:$PATH

        $ ln -s /usr/local/ActivePerl-5.20/bin/perl /Users/<username>/bin/perl
        $ ln -s /usr/local/ActivePerl-5.20/bin/ppm /Users/<username>/bin/ppm

### Uninstalling ActivePerl on OS X

To uninstall ActivePerl, run the uninstall script:

        $ sudo /usr/local/ActivePerl-5.20/bin/ap-uninstall

Removing ActivePerl will also remove perl modules manually installed using PPM.

If neccessary, remove any symbolic links created during configuration. For example:

        $ rm /Users/<username>/bin/perl

### Linux Prerequisites

- Hardware: 200 MB hard disk space for typical install
- Operating System: Linux distribution using glibc 2.15 or later (e.g. Ubuntu 12.04)
- Online Help: Web browser

## Installing ActivePerl on Linux

The installer allows installation as an unprivileged user into a user-specified path. GNU tar is required for extracting the files. See Known Issues in the ActivePerl Release Notes for details.

Download the distribution to a temporary directory, extract the files, chdir to the ActivePerl directory and then run the script `install.sh`. The installation script will prompt you for the target installation directory.

        % tar zxf ActivePerl-5.20.2.2001-i686-linux.tar.gz
        % cd ActivePerl-5.20.2.2001
        % ./install.sh

If you share the system with other people, or if you do not have root access, it is recommended that you install ActivePerl in your own user directory. For example:

        /home/<username>/ActivePerl-5.20

We suggest adding the following line to your .bash_profile file:

        PATH=$PATH:/home/<username>/bin

Also, we suggest that you create symbolic links to the binaries:

        ln -s /home/<username>/ActivePerl-5.20/bin/perl /home/<username>/bin/perl
        ln -s /home/<username>/ActivePerl-5.20/bin/ppm /home/<username>/bin/ppm

This will allow you to call ActivePerl with a command like:

        perl -le "Hello World!;"

### Linux Configuration

The installer allows you to install the package anywhere that the user has write permission. Add the bin directory to your PATH environment variable to conveniently access it. For example, in the C shell (assuming you installed into /home/<username>/ActivePerl-5.20):

        % setenv PATH /home/<username>/ActivePerl-5.20/bin:$PATH

### Uninstalling ActivePerl on Linux

If you installed ActivePerl using the AS format installer, remove the directory into which ActivePerl was installed. For example:

        /bin/rm -rf /opt/ActivePerl-5.20

## Installing ActivePerl on Solaris (sparc, x86)

### Solaris Prerequisites

- Hardware: 200 MB hard disk space for typical install
- Operating System: Solaris 2.6 or later for sparc, Solaris 10 or later for x86
- Online Help: Web browser

### Solaris Installers

PKGADD Package
  The Solaris package is in pkgadd format. This should be installed as root, using the following commands:

          % gunzip ActivePerl-5.20.2.2001-sun4-solaris.pkg.gz
          % pkgadd -d ActivePerl-5.20.2.2001-sun4-solaris.pkg

  This will install ActivePerl into /opt/ActivePerl-5.20.

  To uninstall ActivePerl, run:

          % pkgrm ASperl

  This package has only been tested with Solaris 2.6, but is expected to be compatible with other Solaris 2.6 compatible installations as well, including Solaris 7 and Solaris 8.

Gzipped Tarball for Solaris
  The generic installer allows installation as an unprivileged user, and into a user-specified path. GNU tar is required for extracting the files. See Known Issues in the ActivePerl Release Notes for details.

  Download the distribution to a temporary directory, extract the files, `chdir` to the ActivePerl directory and then run the script `install.sh`. The installation script will prompt you for the target installation directory.

          % tar zxf ActivePerl-5.20.2.2001-sun4-solaris.tar.gz
          % cd ActivePerl-5.20.2.2001
          % ./install.sh

  If GNU tar is installed as 'gtar', substitute that executable name in the first command above.

### Solaris Configuration

The Solaris package is installed into the /opt/ActivePerl-5.20 directory. Add the /opt/ActivePerl-5.20/bin directory to your PATH environment variable to conveniently access it. For example, in the C shell:

        % setenv PATH /opt/ActivePerl-5.20/bin:$PATH

The generic installer allows you to install the package anywhere that the user has write permission. Add the bin directory to your PATH environment variable to conveniently access it. For example, in the C shell (assuming you installed into /home/<username>/ActivePerl-5.20):

        % setenv PATH /home/<username>/ActivePerl-5.20/bin:$PATH

### Uninstalling ActivePerl on Solaris

PKGADD Package
  If you installed ActivePerl using the PKGADD format installer, uninstall as follows:

          pkgrm -d ASperl

Gzipped Tarball Package
  If you installed ActivePerl using the AS format installer, remove the directory into which ActivePerl was installed. For example:

          /bin/rm -rf /opt/ActivePerl-5.20