source: general/prog/perl-modules/perl-text-bibtex.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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/A/AM/AMBS/Text-BibTeX-&Text-BibTeX-version;.tar.gz">
  <!ENTITY my-md5sum "67fa6d9c03c659627d9fd58bb380c1fe">
]>

  <!-- Begin Text::BibTeX -->
  <sect2 id="perl-text-bibtex" xreflabel="Text-BibTeX-&Text-BibTeX-version;">

    <title>Text::BibTeX-&Text-BibTeX-version;</title>

    <indexterm zone="perl-text-bibtex">
      <primary sortas="a-Text-BibTeX">Text::BibTeX</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Text::BibTeX</title>

      <para>
        Text::BibTeX provides an interface to read and parse
        <application>BibTeX</application> files.
      </para>

      &lfs121_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">Text::BibTeX Dependencies</bridgehead>

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="perl-config-autoconf"/>,
        <xref linkend="perl-extutils-libbuilder"/>
        <!-- perl-module-build is pulled in by perl-extutils-libbuilder -->
      </para>

    </sect3>

    <sect3 role="installation">
      <title>Installation of Text::BibTeX</title>

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

    </sect3>

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

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

        <seglistitem>
          <seg>
            biblex, libparse, dumpnames
          </seg>
          <seg>
            libtparse.so
          </seg>
        </seglistitem>
      </segmentedlist>

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

        <varlistentry id="biblex-prog">
          <term><command>biblex</command></term>
          <listitem>
            <para>
              performs lexical analysis on a BibTeX file
            </para>
            <indexterm zone="perl-text-bibtex biblex-prog">
              <primary sortas="b-biblex">biblex</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="bibparse-prog">
          <term><command>bibparse</command></term>
          <listitem>
            <para>
              parses a series of BibTeX files with command line options to
              control the string post-processing behavior
            </para>
            <indexterm zone="perl-text-bibtex bibparse-prog">
              <primary sortas="b-bibparse">bibparse</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="dumpnames-prog">
          <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-text-bibtex dumpnames-prog">
              <primary sortas="b-dumpnames">dumpnames</primary>
            </indexterm>
          </listitem>
        </varlistentry>

        <varlistentry id="libbtparse-lib">
          <term><filename class="libraryfile">libbtparse.so</filename></term>
          <listitem>
            <para>
              is a library for parsing and processing BibTeX data files
            </para>
            <indexterm zone="perl-text-bibtex libbtparse-lib">
              <primary sortas="c-libbtparse">libbtparse.so</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>