Author: ken Date: Fri Jun 5 22:01:21 2015 New Revision: 16088 Log: Document and index programs, and a library, installed by some of the perl modules.
Modified: trunk/BOOK/general/prog/perl-modules.xml Modified: trunk/BOOK/general/prog/perl-modules.xml ============================================================================== --- trunk/BOOK/general/prog/perl-modules.xml Fri Jun 5 16:21:27 2015 (r16087) +++ trunk/BOOK/general/prog/perl-modules.xml Fri Jun 5 22:01:21 2015 (r16088) @@ -9,6 +9,12 @@ <!ENTITY perl_authors "http://cpan.metacpan.org/authors";> ]> +<!-- FIXME (I only used that so that this gets highlighted by vim ;-) + If you have the misfortune to have to add a new module which puts a program + into /usr/bin/, please document it at the end of the page. 'perldoc' is + sometimes a good place to start, then for scripts look at any comments in the + script, and if you get a package like Text::BibTeX with compiled progs and + library, loook at the comments in the code --> <sect1 id="perl-modules" xreflabel="Perl modules"> <?dbhtml filename="perl-modules.html" ?> @@ -1186,6 +1192,7 @@ </listitem> </itemizedlist> + <!-- Text::Diff <bridgehead renderas="sect3" id="perl-text-diff" xreflabel="Text::Diff-&Text-Diff-version;"> @@ -1767,4 +1774,166 @@ </sect2> + <sect2 role="content"> + <title>Contents</title> + + <para> + Most of these modules only install into the perl directories, but a + few will also install programs (mostly, perl scripts), or even a library, + into <filename class="directory">/usr</filename> + </para> + + <segmentedlist> + <segtitle>Installed Programs</segtitle> + <segtitle>Installed Libraries</segtitle> + + <seglistitem> + <seg> <!-- Use emphasis to highlihght the relevant module name. + Our setup actually uses italic to do this this. --> + <emphasis>Archive::Zip:</emphasis> crc32 + <emphasis>File::Find::Rule:</emphasis> findrule + <emphasis>libwww-perl:</emphasis> lwp-download, lwp-dump, lwp-mirror, lwp-request + <emphasis>Log::Log4perl:</emphasis> l4p-tmpl + <emphasis>Pod::Coverage:</emphasis> pod_cover + <emphasis>Text::BibTeX:</emphasis> biblex, bibparse, dumpnames + </seg> + <seg> + <emphasis>Text::BibTeX:</emphasis> libbtparse.so + </seg> + </seglistitem> + </segmentedlist> + + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> + + <varlistentry id="crc32"> + <term><command>crc32</command></term> + <listitem> + <para>computes and prints to stdout the CRC-32 values of the + given files.</para> + <indexterm zone="perl-modules crc32"> + <primary sortas="b-crc32">crc32</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="findrule"> + <term><command>findrule</command></term> + <listitem> + <para>is a command line wrapper to File:Find:Rule.</para> + <indexterm zone="perl-modules findrule"> + <primary sortas="b-findrule">findrule</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="lwp-download"> + <term><command>lwp-download</command></term> + <listitem> + <para>is a script to fetch a large file from the web.</para> + <indexterm zone="perl-modules lwp-download"> + <primary sortas="b-lwp-download">lwp-download</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="lwp-dump"> + <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-modules lwp-dump"> + <primary sortas="b-lwp-dump">lwp-dump</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="lwp-mirror"> + <term><command>lwp-mirror</command></term> + <listitem> + <para>is a simple mirror utility.</para> + <indexterm zone="perl-modules lwp-mirror"> + <primary sortas="b-lwp-mirror">lwp-mirror</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="lwp-request"> + <term><command>lwp-request</command></term> + <listitem> + <para>is a simple command line user agent.</para> + <indexterm zone="perl-modules lwp-request"> + <primary sortas="b-lwp-request">lwp-request</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="l4p-templ"> + <term><command>l4p-templ</command></term> + <listitem> + <para>prints out the text of a template Log4perl configuration for + starting a new Log4perl configuration file.</para> + <indexterm zone="perl-modules l4p-templ"> + <primary sortas="b-l4p-templ">l4p-templ</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="pod_cover"> + <term><command>pod_cover</command></term> + <listitem> + <para>is used to get a coverage analysis of the embedded documentation + in a perl module.</para> + <indexterm zone="perl-modules pod_cover"> + <primary sortas="b-pod_cover">pod_cover</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="biblex"> + <term><command>biblex</command></term> + <listitem> + <para>performs lexical analysis on a BibTeX file.</para> + <indexterm zone="perl-modules biblex"> + <primary sortas="b-biblex">biblex</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="bibparse"> + <term><command>bibparse</command></term> + <listitem> + <para>parses a series of BibTeX files with command line options to + control the string post-processing behaviour.</para> + <indexterm zone="perl-modules bibparse"> + <primary sortas="b-bibparse">bibparse</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="dumpnames"> + <term><command>dumpnames</command></term> + <listitem> + <para>parses a BibTeX file, splitting 'author' and 'editor' fields + into lists of names, and then dumps everything to stdout.</para> + <indexterm zone="perl-modules dumpnames"> + <primary sortas="b-dumpnames">dumpnames</primary> + </indexterm> + </listitem> + </varlistentry> + + <varlistentry id="libbtparse"> + <term><filename class='libraryfile'>libbtparse.so</filename></term> + <listitem> + <para>is a library for parsing and processing BibTeX data files.</para> + <indexterm zone="perl-modules libbtparse"> + <primary sortas="c-libbtparse">libbtparse.so</primary> + </indexterm> + </listitem> + </varlistentry> + + </variablelist> + </sect2> + </sect1> -- http://lists.linuxfromscratch.org/listinfo/blfs-book FAQ: http://www.linuxfromscratch.org/blfs/faq.html Unsubscribe: See the above information page
