source: lwp-protocol-https.xml@ 6397333

<?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 perl_authors "https://www.cpan.org/authors">
  <!ENTITY LWP-Protocol-https-download-http "&perl_authors;/id/O/OA/OALDERS/LWP-Protocol-https-&LWP-Protocol-https-version;.tar.gz">
  <!ENTITY LWP-Protocol-https-md5sum "b8943dfb7d187af63c36fc18ab15947d">
]>

<sect1 id="lwp-protocol-https" xreflabel="LWP::Protocol::https">
  <?dbhtml filename="lwp-protocol-https.html" ?>

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

  <title>LWP::Protocol::https-&LWP-Protocol-https-version; (Perl Module)</title>

  <sect2 role="package">
    <title>Introduction to Perl Module LWP::Protocol::https</title>


    <!-- LWP::Protocol::https -->
    <bridgehead renderas="sect3" id="perl-lwp-protocol-https"
    xreflabel="LWP::Protocol::https-&LWP-Protocol-https-version;">
    LWP::Protocol::https-&LWP-Protocol-https-version;</bridgehead>

    <indexterm zone="lwp-protocol-https perl-lwp-protocol-https">
      <primary sortas="a-LWP-Protocol-https">LWP::Protocol::https</primary>
    </indexterm>

    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&perl_authors;/id/O/OA/OALDERS/LWP-Protocol-https-&LWP-Protocol-https-version;.tar.gz"/>
        </para>
      </listitem>
    </itemizedlist>

    <note>
      <para>Explicit download of this package is not necessary when using
      auto installation instructions.</para>
    </note>

    <para>LWP::Protocol::https provides https support for
    LWP::UserAgent (i.e. for LWP). This module uses 
    <xref linkend="perl-auto-install"/>:.</para>

<screen><userinput>cpan -i LWP::Protocol::https</userinput></screen>

  </sect2>

  <sect2 role="installation" id="perl-auto-install"
  xreflabel="auto installation instructions">
    <title>Auto Installation of Perl Modules.</title>

    <para>
      Install Perl modules using the <command>cpan</command> shell
      <command>install</command> command. The command automatically downloads
      the source from the CPAN archive, extracts it, runs the compilation,
      testing and installation commands mentioned above. 
    </para>

    <para>The first time you run <command>cpan</command>, you'll be prompted
    to enter some information regarding download locations and methods. This
    information is retained in files located in
    <filename class='directory'>~/.cpan</filename>. Start the
    <command>cpan</command> shell by issuing '<command>cpan</command>' as the
    <systemitem class="username">root</systemitem> user. Any module may now be
    installed from the
    <emphasis role='underlined'><prompt>cpan&gt;&nbsp;</prompt></emphasis>
    prompt with the command:</para>

<screen role="root"><userinput>install <replaceable>&lt;Module::Name&gt;</replaceable></userinput></screen>

    <para>For additional commands and help, issue '<command>help</command>'
    from the
    <emphasis role='underlined'><prompt>cpan&gt;&nbsp;</prompt></emphasis>
    prompt.</para>

    <para>Alternatively, for scripted or non-interactive installations, use the
    following syntax as the
    <systemitem class="username">root</systemitem> user to install one or more
    modules:</para>

<screen role="root"><userinput>cpan -i <replaceable>&lt;Module1::Name&gt; &lt;Module2::Name&gt;</replaceable></userinput></screen>

    <para>Review the <filename>cpan.1</filename> man page for additional
    parameters you can pass to <command>cpan</command> on the command
    line.</para>

  </sect2>

</sect1>