source: general/prog/new-perl-modules.xml@ 6df794d

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="new-perl-modules" xreflabel="Perl Modules (new page)">
  <?dbhtml filename="new-perl-modules.html" ?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Perl Modules (new page)</title>

  <indexterm zone="new-perl-modules">
    <primary sortas="a-new-perl-Modules">Perl Modules</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Perl Modules</title>

    <para>
      The <application>Perl</application> module packages (also referred to as
      Distributions, because each can contain multiple modules) add useful
      objects to the <application>Perl</application> language. The packages
      listed on this page are required or recommended for other packages in
      the book. If they have dependent modules, those are either on this page
      or else on the next page.
   </para>

    <para>
      Modules utilized by packages throughout BLFS are listed here, along with
      their dependencies.  The various ways of building and installing perl
      modules are shown at the bottom of this page.
    </para>

    <para>
      In many cases, only the required or recommended dependencies are listed -
      there might be other modules which allow more tests to be run, but
      omitting them will still allow the tests to <literal>PASS</literal>.
    </para>

    <para>
      For a few modules, the BLFS editors have determined that other modules
      still listed as prerequisites are not required, and omitted them.
    </para>

    <para>
      It is generally worth running the tests for perl modules, they often
      can show problems such as missing dependencies which are required to
      use the module.  In some cases, such dependencies are marked as
      '(for the testsuite)'.
    </para>

    <para>
      It is possible to automatically install the current version of a module and
      any missing or too-old dependencies using CPAN. See the end of this page for
      details.
    </para>

    <para>
      Most of these modules only install files below <filename
      class="directory">/usr/lib/perl5/site_perl/5.xx.y</filename> and those will
      not be documented. One or two install programs (mostly, perl scripts), or
      even a library, into <filename class="directory">/usr</filename> and those
      are documented.
    </para>

    <note>
      <para>
        This is a reminder to an editor to deal with Data-Uniquid (needs patch) and
        those modules which use the unsafe variant of the standard install.
      </para>
    </note>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/perl-modules"/>
    </para>

    <itemizedlist spacing="compact">
      <listitem>
        <para>
          <xref linkend="new-perl-archive-zip"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="new-perl-autovivification"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="new-perl-business-issn"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="new-perl-module-build"/>
        </para>
      </listitem>
      <listitem>
        <para>
          <xref linkend="new-perl-text-bibtex"/>
        </para>
      </listitem>
      <!-- Build and install options always come at the end, but one of
           them is perl-build-install so call the set perl-alternatives  -->
      <listitem>
        <para>
          <xref linkend="perl-alternatives"/>
        </para>
      </listitem>
    </itemizedlist>
  </sect2>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="perl-modules/perl-archive-zip.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="perl-modules/perl-autovivification.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="perl-modules/perl-business-issn.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="perl-modules/perl-module-build.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="perl-modules/perl-text-bibtex.xml"/>

  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="perl-alternatives.xml"/>

</sect1>