Added indexing tags to Perl modules

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3372 af4574ff-66df-0310-9fd7-8a98e5e911e0
This commit is contained in:
Randy McMurchy 2005-02-01 00:03:18 +00:00
parent 8e0e0313fa
commit 7fc4452325

View File

@ -12,6 +12,8 @@
</sect1info> </sect1info>
<?dbhtml filename="perl-modules.html" ?> <?dbhtml filename="perl-modules.html" ?>
<title><application>Perl</application> modules</title> <title><application>Perl</application> modules</title>
<indexterm zone="perl-modules">
<primary sortas="a-Perl-modules">Perl modules</primary></indexterm>
<sect2> <sect2>
<title>Introduction to <application>Perl</application> modules</title> <title>Introduction to <application>Perl</application> modules</title>
@ -25,7 +27,10 @@ occasionally you'll also see Module, Module-SubName or Module-Sub-Name. Most
references on this page are in the latter form, as these are the official references on this page are in the latter form, as these are the official
package names.</para> package names.</para>
<sect3><title>The Module::Info module</title> <sect3 id="perl-module-info"><title>The Module::Info module</title>
<indexterm zone="perl-modules perl-module-info">
<primary sortas="g-Module-Info">Module::Info</primary></indexterm>
<para>One module in particular is shown first, as this module's usefulness <para>One module in particular is shown first, as this module's usefulness
warrants installation, even though it won't be required by many other modules. warrants installation, even though it won't be required by many other modules.
The Module::Info module can tell you if a particular module is included in, The Module::Info module can tell you if a particular module is included in,
@ -43,18 +48,24 @@ Module-Info-&Module-Info-version;</ulink></para>
<sect3><title><application>Perl</application> Module Packages</title> <sect3><title><application>Perl</application> Module Packages</title>
<itemizedlist><listitem><para><ulink <itemizedlist><listitem><para id="perl-gtk-perl"><ulink
url="http://www.cpan.org/authors/id/M/ML/MLEHMANN/Gtk-Perl-&Gtk-Perl-version;.tar.gz"> url="http://www.cpan.org/authors/id/M/ML/MLEHMANN/Gtk-Perl-&Gtk-Perl-version;.tar.gz">
Gtk-Perl-&Gtk-Perl-version;</ulink></para> Gtk-Perl-&Gtk-Perl-version;</ulink></para>
<indexterm zone="perl-modules perl-gtk-perl">
<primary sortas="g-Gtk-Perl">Gtk::Perl</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-xml-writer"><ulink
url="http://www.cpan.org/authors/id/J/JO/JOSEPHW/XML-Writer-&XML-Writer-version;.tar.gz"> url="http://www.cpan.org/authors/id/J/JO/JOSEPHW/XML-Writer-&XML-Writer-version;.tar.gz">
XML-Writer-&XML-Writer-version;</ulink></para> XML-Writer-&XML-Writer-version;</ulink></para>
<indexterm zone="perl-modules perl-xml-writer">
<primary sortas="g-XML-Writer">XML::Writer</primary></indexterm>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-xml-parser"><ulink
url="http://www.cpan.org/authors/id/M/MS/MSERGEANT/XML-Parser-&XML-Parser-version;.tar.gz"> url="http://www.cpan.org/authors/id/M/MS/MSERGEANT/XML-Parser-&XML-Parser-version;.tar.gz">
XML-Parser-&XML-Parser-version;</ulink></para> XML-Parser-&XML-Parser-version;</ulink></para>
<indexterm zone="perl-modules perl-xml-parser">
<primary sortas="g-XML-Parser">XML::Parser</primary></indexterm>
<itemizedlist spacing='compact'><listitem> <itemizedlist spacing='compact'><listitem>
<para><xref linkend="expat"/></para> <para><xref linkend="expat"/></para>
@ -66,123 +77,167 @@ XML-Parser-&XML-Parser-version;</ulink></para>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-sgmlspm"><ulink
url="http://www.cpan.org/authors/id/D/DM/DMEGG/SGMLSpm-&SGMLSpm-version;.tar.gz"> url="http://www.cpan.org/authors/id/D/DM/DMEGG/SGMLSpm-&SGMLSpm-version;.tar.gz">
SGMLSpm-&SGMLSpm-version;</ulink></para> SGMLSpm-&SGMLSpm-version;</ulink></para>
<indexterm zone="perl-modules perl-sgmlspm">
<primary sortas="g-SGMLSpm">SGMLSpm</primary></indexterm>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-perl-tk"><ulink
url="http://www.cpan.org/authors/id/N/NI/NI-S/Tk-&Perl-Tk-version;.tar.gz"> url="http://www.cpan.org/authors/id/N/NI/NI-S/Tk-&Perl-Tk-version;.tar.gz">
Tk-&Perl-Tk-version;</ulink></para> Tk-&Perl-Tk-version;</ulink></para>
<indexterm zone="perl-modules perl-perl-tk">
<primary sortas="g-Perl-Tk">Perl::Tk</primary></indexterm>
<itemizedlist spacing='compact'><listitem> <itemizedlist spacing='compact'><listitem>
<para><xref linkend="tk"/> and <xref linkend="libjpeg"/></para> <para><xref linkend="tk"/> and <xref linkend="libjpeg"/></para>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-net-dns"><ulink
url="http://www.cpan.org/authors/id/C/CR/CREIN/Net-DNS-&Net-DNS-version;.tar.gz"> url="http://www.cpan.org/authors/id/C/CR/CREIN/Net-DNS-&Net-DNS-version;.tar.gz">
Net-DNS-&Net-DNS-version;</ulink></para> Net-DNS-&Net-DNS-version;</ulink></para>
<indexterm zone="perl-modules perl-net-dns">
<primary sortas="g-Net-DNS">Net::DNS</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-digest-hmac"><ulink
url="http://www.cpan.org/authors/id/G/GA/GAAS/Digest-HMAC-&Digest-HMAC-version;.tar.gz"> url="http://www.cpan.org/authors/id/G/GA/GAAS/Digest-HMAC-&Digest-HMAC-version;.tar.gz">
Digest-HMAC-&Digest-HMAC-version;</ulink></para> Digest-HMAC-&Digest-HMAC-version;</ulink></para>
<indexterm zone="perl-modules perl-digest-hmac">
<primary sortas="g-Digest-HMAC">Digest::HMAC</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-digest-sha1"><ulink
url="http://www.cpan.org/authors/id/G/GA/GAAS/Digest-SHA1-&Digest-SHA1-version;.tar.gz"> url="http://www.cpan.org/authors/id/G/GA/GAAS/Digest-SHA1-&Digest-SHA1-version;.tar.gz">
Digest-SHA1-&Digest-SHA1-version;</ulink></para> Digest-SHA1-&Digest-SHA1-version;</ulink></para>
<indexterm zone="perl-modules perl-digest-sha1">
<primary sortas="g-Digest-SHA1">Digest::SHA1</primary></indexterm>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-lwp"><ulink
url="http://www.cpan.org/authors/id/G/GA/GAAS/libwww-perl-&LWP-version;.tar.gz"> url="http://www.cpan.org/authors/id/G/GA/GAAS/libwww-perl-&LWP-version;.tar.gz">
LWP-&LWP-version;</ulink></para> LWP-&LWP-version;</ulink></para>
<indexterm zone="perl-modules perl-lwp">
<primary sortas="g-LWP">LWP</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-uri"><ulink
url="http://www.cpan.org/authors/id/G/GA/GAAS/URI-&URI-version;.tar.gz"> url="http://www.cpan.org/authors/id/G/GA/GAAS/URI-&URI-version;.tar.gz">
URI-&URI-version;</ulink></para> URI-&URI-version;</ulink></para>
<indexterm zone="perl-modules perl-uri">
<primary sortas="g-URI">URI</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-business-isbn"><ulink
url="http://www.cpan.org/authors/id/B/BD/BDFOY/Business-ISBN-&Business-ISBN-version;.tar.gz"> url="http://www.cpan.org/authors/id/B/BD/BDFOY/Business-ISBN-&Business-ISBN-version;.tar.gz">
Business-ISBN-&Business-ISBN-version;</ulink> (Only used during the test Business-ISBN-&Business-ISBN-version;</ulink> (Only used during the test
suite)</para> suite)</para>
<indexterm zone="perl-modules perl-business-isbn">
<primary sortas="g-Business-ISBN">Business::ISBN</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-business-isbn-data"><ulink
url="http://www.cpan.org/authors/id/B/BD/BDFOY/Business-ISBN-Data-&Business-ISBN-Data-version;.tar.gz"> url="http://www.cpan.org/authors/id/B/BD/BDFOY/Business-ISBN-Data-&Business-ISBN-Data-version;.tar.gz">
Business-ISBN-Data-&Business-ISBN-Data-version;</ulink></para> Business-ISBN-Data-&Business-ISBN-Data-version;</ulink></para>
<indexterm zone="perl-modules perl-business-isbn-data">
<primary sortas="g-Business-ISBN-Data">Business::ISBN::Data</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-test-pod"><ulink
url="http://www.cpan.org/authors/id/P/PE/PETDANCE/Test-Pod-&Test-Pod-version;.tar.gz"> url="http://www.cpan.org/authors/id/P/PE/PETDANCE/Test-Pod-&Test-Pod-version;.tar.gz">
Test-Pod-&Test-Pod-version;</ulink></para> Test-Pod-&Test-Pod-version;</ulink></para>
<indexterm zone="perl-modules perl-test-pod">
<primary sortas="g-Test-Pod">Test::Pod</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-pod-simple"><ulink
url="http://www.cpan.org/authors/id/S/SB/SBURKE/Pod-Simple-&Pod-Simple-version;.tar.gz"> url="http://www.cpan.org/authors/id/S/SB/SBURKE/Pod-Simple-&Pod-Simple-version;.tar.gz">
Pod-Simple-&Pod-Simple-version;</ulink></para> Pod-Simple-&Pod-Simple-version;</ulink></para>
<indexterm zone="perl-modules perl-pod-simple">
<primary sortas="g-Pod-Simple">Pod::Simple</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-pod-escapes"><ulink
url="http://www.cpan.org/authors/id/S/SB/SBURKE/Pod-Escapes-&Pod-Escapes-version;.tar.gz"> url="http://www.cpan.org/authors/id/S/SB/SBURKE/Pod-Escapes-&Pod-Escapes-version;.tar.gz">
Pod-Escapes-&Pod-Escapes-version;</ulink></para> Pod-Escapes-&Pod-Escapes-version;</ulink></para>
<indexterm zone="perl-modules perl-pod-escapes">
<primary sortas="g-Pod-Escapes">Pod::Escapes</primary></indexterm>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-test-builder-tester"><ulink
url="http://www.cpan.org/authors/id/M/MA/MARKF/Test-Builder-Tester-&Test-Builder-Tester-version;.tar.gz"> url="http://www.cpan.org/authors/id/M/MA/MARKF/Test-Builder-Tester-&Test-Builder-Tester-version;.tar.gz">
Test-Builder-Tester-&Test-Builder-Tester-version;</ulink></para> Test-Builder-Tester-&Test-Builder-Tester-version;</ulink></para>
<indexterm zone="perl-modules perl-test-builder-tester">
<primary sortas="g-Test-Builder-Tester">Test::Builder::Tester</primary></indexterm>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-test-prereq"><ulink
url="http://www.cpan.org/authors/id/B/BD/BDFOY/Test-Prereq-&Test-Prereq-version;.tar.gz"> url="http://www.cpan.org/authors/id/B/BD/BDFOY/Test-Prereq-&Test-Prereq-version;.tar.gz">
Test-Prereq-&Test-Prereq-version;</ulink></para> Test-Prereq-&Test-Prereq-version;</ulink></para>
<indexterm zone="perl-modules perl-test-prereq">
<primary sortas="g-Test-Prereq">Test::Prereq</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para><ulink
url="http://www.cpan.org/authors/id/M/MB/MBARBON/Module-Info-&Module-Info-version;.tar.gz"> url="http://www.cpan.org/authors/id/M/MB/MBARBON/Module-Info-&Module-Info-version;.tar.gz">
Module-Info-&Module-Info-version;</ulink></para> Module-Info-&Module-Info-version;</ulink></para>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-module-corelist"><ulink
url="http://www.cpan.org/authors/id/R/RC/RCLAMP/Module-CoreList-&Module-Corelist-version;.tar.gz"> url="http://www.cpan.org/authors/id/R/RC/RCLAMP/Module-CoreList-&Module-Corelist-version;.tar.gz">
Module-CoreList-&Module-Corelist-version;</ulink></para> Module-CoreList-&Module-Corelist-version;</ulink></para>
<indexterm zone="perl-modules perl-module-corelist">
<primary sortas="g-Module-Corelist">Module::Corelist</primary></indexterm>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-html-parser"><ulink
url="http://www.cpan.org/authors/id/G/GA/GAAS/HTML-Parser-&HTML-Parser-version;.tar.gz"> url="http://www.cpan.org/authors/id/G/GA/GAAS/HTML-Parser-&HTML-Parser-version;.tar.gz">
HTML-Parser-&HTML-Parser-version;</ulink></para> HTML-Parser-&HTML-Parser-version;</ulink></para>
<indexterm zone="perl-modules perl-html-parser">
<primary sortas="g-HTML-Parser">HTML::Parser</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-html-tagset"><ulink
url="http://www.cpan.org/authors/id/S/SB/SBURKE/HTML-Tagset-&HTML-Tagset-version;.tar.gz"> url="http://www.cpan.org/authors/id/S/SB/SBURKE/HTML-Tagset-&HTML-Tagset-version;.tar.gz">
HTML-Tagset-&HTML-Tagset-version;</ulink></para> HTML-Tagset-&HTML-Tagset-version;</ulink></para>
<indexterm zone="perl-modules perl-html-tagset">
<primary sortas="g-HTML-Tagset">HTML::Tagset</primary></indexterm>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-compress-zlib"><ulink
url="http://www.cpan.org/authors/id/P/PM/PMQS/Compress-Zlib-&Compress-Zlib-version;.tar.gz"> url="http://www.cpan.org/authors/id/P/PM/PMQS/Compress-Zlib-&Compress-Zlib-version;.tar.gz">
Compress-Zlib-&Compress-Zlib-version;</ulink></para> Compress-Zlib-&Compress-Zlib-version;</ulink></para>
<indexterm zone="perl-modules perl-compress-zlib">
<primary sortas="g-Compress-Zlib">Compress::Zlib</primary></indexterm>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-crypt-ssleay"><ulink
url="http://www.cpan.org/authors/id/C/CH/CHAMAS/Crypt-SSLeay-&Crypt-SSLeay-version;.tar.gz"> url="http://www.cpan.org/authors/id/C/CH/CHAMAS/Crypt-SSLeay-&Crypt-SSLeay-version;.tar.gz">
Crypt-SSLeay-&Crypt-SSLeay-version;</ulink></para> Crypt-SSLeay-&Crypt-SSLeay-version;</ulink></para>
<indexterm zone="perl-modules perl-crypt-ssleay">
<primary sortas="g-Crypt-SSLeay">Crypt::SSLeay</primary></indexterm>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-datemanip"><ulink
url="http://www.cpan.org/authors/id/S/SB/SBECK/DateManip-&DateManip-version;.tar.gz"> url="http://www.cpan.org/authors/id/S/SB/SBECK/DateManip-&DateManip-version;.tar.gz">
DateManip-&DateManip-version;</ulink></para> DateManip-&DateManip-version;</ulink></para>
<indexterm zone="perl-modules perl-datemanip">
<primary sortas="g-DateManip">DateManip</primary></indexterm>
</listitem> </listitem>
<listitem><para><ulink <listitem><para id="perl-finance-quote"><ulink
url="http://www.cpan.org/authors/id/P/PJ/PJF/Finance-Quote-&Finance-Quote-version;.tar.gz"> url="http://www.cpan.org/authors/id/P/PJ/PJF/Finance-Quote-&Finance-Quote-version;.tar.gz">
Finance-Quote-&Finance-Quote-version;</ulink></para> Finance-Quote-&Finance-Quote-version;</ulink></para>
<indexterm zone="perl-modules perl-finance-quote">
<primary sortas="g-Finance-Quote">Finance::Quote</primary></indexterm>
<itemizedlist spacing='compact'><listitem><para><ulink <itemizedlist spacing='compact'><listitem><para id="perl-html-tableextract"><ulink
url="http://www.cpan.org/authors/id/M/MS/MSISK/HTML-TableExtract-&HTML-TableExtract-version;.tar.gz"> url="http://www.cpan.org/authors/id/M/MS/MSISK/HTML-TableExtract-&HTML-TableExtract-version;.tar.gz">
HTML-TableExtract-&HTML-TableExtract-version;</ulink></para> HTML-TableExtract-&HTML-TableExtract-version;</ulink></para>
<indexterm zone="perl-modules perl-html-tableextract">
<primary sortas="g-HTML-TableExtract">HTML::TableExtract</primary></indexterm>
</listitem></itemizedlist> </listitem></itemizedlist>
</listitem></itemizedlist> </listitem></itemizedlist>
</sect3> </sect3>
@ -197,8 +252,11 @@ commands:</para>
<screen><userinput><command>perl Makefile.PL &amp;&amp; <screen><userinput><command>perl Makefile.PL &amp;&amp;
make &amp;&amp; make &amp;&amp;
make test &amp;&amp; make test</command></userinput></screen>
make install</command></userinput></screen>
<para>Now, as the root user:</para>
<screen><userinput role='root'><command>make install</command></userinput></screen>
<para>The modules listed below require modifications to the instructions in <para>The modules listed below require modifications to the instructions in
order to install successfully.</para> order to install successfully.</para>
@ -206,8 +264,11 @@ order to install successfully.</para>
<sect3><title>Gtk-Perl-&Gtk-Perl-version;:</title> <sect3><title>Gtk-Perl-&Gtk-Perl-version;:</title>
<screen><userinput><command>perl Makefile.PL --without-guessing &amp;&amp; <screen><userinput><command>perl Makefile.PL --without-guessing &amp;&amp;
make &amp;&amp; make &amp;&amp;
make test &amp;&amp; make test</command></userinput></screen>
make install</command></userinput></screen>
<para>Now, as the root user:</para>
<screen><userinput role='root'><command>make install</command></userinput></screen>
</sect3> </sect3>
<sect3><title>SGMLSpm-&SGMLSpm-version;</title> <sect3><title>SGMLSpm-&SGMLSpm-version;</title>
@ -219,12 +280,15 @@ command below to reflect the version you have installed.</para>
<screen><userinput><command>sed -i -e "s@/usr/local/bin@/usr/bin@" \ <screen><userinput><command>sed -i -e "s@/usr/local/bin@/usr/bin@" \
-e "s@/usr/local/lib/perl5@/usr/lib/perl5/site_perl/&LFS-Perl-version;@" \ -e "s@/usr/local/lib/perl5@/usr/lib/perl5/site_perl/&LFS-Perl-version;@" \
-e "s@/usr/local/lib/www/docs@/usr/share/doc/perl5@" \ -e "s@/usr/local/lib/www/docs@/usr/share/doc/perl5@" \
Makefile &amp;&amp; Makefile</command></userinput></screen>
make install &amp;&amp;
install -d -m 755 /usr/share/doc/perl5 &amp;&amp; <para>Now, as the root user:</para>
<screen><userinput role='root'><command>make install &amp;&amp;
install -v -d -m755 /usr/share/doc/perl5 &amp;&amp;
make install_html &amp;&amp; make install_html &amp;&amp;
rm -f /usr/share/doc/perl5/SGMLSpm/sample.pl &amp;&amp; rm -v -f /usr/share/doc/perl5/SGMLSpm/sample.pl &amp;&amp;
install -m 644 DOC/sample.pl /usr/share/doc/perl5/SGMLSpm</command></userinput></screen> install -v -m644 DOC/sample.pl /usr/share/doc/perl5/SGMLSpm</command></userinput></screen>
</sect3> </sect3>
</sect2> </sect2>
@ -242,13 +306,13 @@ the automated installation method.</para>
<para>The first time you run this command, you'll be prompted to enter some <para>The first time you run this command, you'll be prompted to enter some
information regarding download locations and methods. This information is information regarding download locations and methods. This information is
retained in files located in <filename class='directory'>~/.cpan</filename>. retained in files located in <filename class='directory'>~/.cpan</filename>.
Start the perl shell with the following command:</para> Start the perl shell with the following command as the root user:</para>
<screen><userinput><command>perl -MCPAN -e shell</command></userinput></screen> <screen><userinput role='root'><command>perl -MCPAN -e shell</command></userinput></screen>
<para>Each module may now be installed from this shell with the command:</para> <para>Each module may now be installed from this shell with the command:</para>
<screen><userinput><command>install <replaceable>[ModuleName]</replaceable></command></userinput></screen> <screen><userinput role='root'><command>install <replaceable>[Module::Name]</replaceable></command></userinput></screen>
<para>For additional commands and help, type <command>help</command>.</para> <para>For additional commands and help, type <command>help</command>.</para>