source: general/prog/perl-modules/perl-libwww-perl.xml@ a9880c8f

<?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;

  <!ENTITY my-download-http "&perl_authors;/id/S/SI/SIMBABQUE/libwww-perl-&libwww-perl-version;.tar.gz">
  <!ENTITY my-md5sum "1f2301cbc155265fbf889c980db78894">
]>

  <!-- Begin libwww-perl -->
  <sect2 id="perl-libwww-perl" xreflabel="libwww-perl-&libwww-perl-version;">

    <title>LWP (libwww-perl-&libwww-perl-version;)</title>

    <indexterm zone="perl-libwww-perl">
      <primary sortas="a-libwww-perl">libwww-perl</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to LWP - The World-wide Web library for
      <application>Perl</application></title>

      <para>
        The libwww-perl collection is a set of Perl modules which provides a
        simple and consistent application programming interface (API) to the
        World-Wide Web. The main focus of the library is to provide classes and
        functions that allow you to write WWW clients. The library also contains
        modules that are of more general use and even classes that help you
        implement simple HTTP servers.
      </para>

      <!-- For CPAN, this may be pulled in with 'cpan -i Bundle::LWP'   or just LWP-->

      &lfs113_checked;

      <bridgehead renderas="sect4">Package Information</bridgehead>
      <itemizedlist spacing="compact">
        <listitem>
          <para>
            Download (HTTP): <ulink url="&my-download-http;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download MD5 sum: &my-md5sum;
          </para>
        </listitem>
      </itemizedlist>

      <bridgehead renderas="sect4">libwww-perl Dependencies</bridgehead>

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="perl-file-listing"/>,
        <xref linkend="perl-http-cookies"/>,
        <xref linkend="perl-http-daemon"/>,
        <!-- perl-http-daemon pulls in perl-http-message
          for HTTP::Request, HTTP::Response, HTTP::Status -->
        <!-- perl-http-message pulls in perl-encode-locale,
          perl-http-date, perl-lwp-mediatypes and perl-uri -->
        <xref linkend="perl-http-negotiate"/>,
        <xref linkend="perl-html-parser"/>,
        <xref linkend="perl-net-http"/>,
        <xref linkend="perl-try-tiny"/> and
        <xref linkend="perl-www-robotrules"/>
      </para>

      <bridgehead renderas="sect5">Recommended (required for the test suite)</bridgehead>
      <para role="recommended">
        <xref linkend="perl-test-fatal"/>,
        <xref linkend="perl-test-needs"/> and
        <xref linkend="perl-test-requiresinternet"/>
      </para>

    </sect3>

    <sect3 role="installation">
      <title>Installation of libwww-perl</title>

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

      <para>
        After installing this package, if you want HTTPS protocol support
        install <xref linkend="perl-lwp-protocol-https"/>.
      </para>

    </sect3>

    <sect3 role="content">
      <title>Contents</title>

      <segmentedlist>
        <segtitle>Installed Programs</segtitle>

        <seglistitem>
          <seg>
            lwp-download, lwp-dump, lwp-mirror, lwp-request
          </seg>
        </seglistitem>
      </segmentedlist>

      <variablelist>
        <bridgehead renderas="sect3">Short Descriptions</bridgehead>
        <?dbfo list-presentation="list"?>
        <?dbhtml list-presentation="table"?>

        <varlistentry id="lwp-download-prog">
          <term><command>lwp-download</command></term>
          <listitem>
            <para>
              is a script to fetch a large file from the web
            </para>
            <!-- the -prog is for while (old) and new- perl module pages
             are both in the book, without it the link to the package is
             correct, but the link to the prog goes to the progs in old
             perl-modules.xml -->
            <indexterm zone="perl-libwww-perl lwp-download-prog">
              <primary sortas="b-lwp-download">lwp-download</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="lwp-dump-prog">
          <term><command>lwp-dump</command></term>
          <listitem>
            <para>
              is used to see what headers and content is returned for a URL
            </para>
            <indexterm zone="perl-libwww-perl lwp-dump-prog">
              <primary sortas="b-lwp-dump">lwp-dump</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="lwp-mirror-prog">
          <term><command>lwp-mirror</command></term>
          <listitem>
            <para>
              is a simple mirror utility
            </para>
            <indexterm zone="perl-libwww-perl lwp-mirror-prog">
              <primary sortas="b-lwp-mirror">lwp-mirror</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="lwp-request-prog">
          <term><command>lwp-request</command></term>
          <listitem>
            <para>
              is a simple command line user agent
            </para>
            <indexterm zone="perl-libwww-perl lwp-request-prog">
              <primary sortas="b-lwp-request">lwp-request</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>