source: multimedia/libdriv/libvorbis.xml@ f15e274

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libvorbis-download-http "http://downloads.xiph.org/releases/vorbis/libvorbis-&libvorbis-version;.tar.gz">
  <!ENTITY libvorbis-download-ftp  " ">
  <!ENTITY libvorbis-md5sum        "37847626b8e1b53ae79a34714c7b3211">
  <!ENTITY libvorbis-size          "1.3 MB">
  <!ENTITY libvorbis-buildsize     "17.7 MB">
  <!ENTITY libvorbis-time          "0.2 SBU">
]>

<sect1 id="libvorbis" xreflabel="libvorbis-&libvorbis-version;">
  <?dbhtml filename="libvorbis.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">libvorbis-&libvorbis-version;.tar</keyword>
      <keyword role="ftpdir">libvorbis</keyword>
    </keywordset>
  </sect1info>

  <title>libvorbis-&libvorbis-version;</title>

  <indexterm zone="libvorbis">
    <primary sortas="a-Libvorbis">Libvorbis</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libvorbis</title>

    <para>The <application>libvorbis</application> package contains a general
    purpose audio and music encoding format. This is useful for creating
    (encoding) and playing (decoding) sound in an open (patent free)
    format.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&libvorbis-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&libvorbis-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &libvorbis-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &libvorbis-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &libvorbis-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &libvorbis-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libvorbis Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libogg"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="pkgconfig"/>, and
    <xref linkend="libxslt"/> and
    <ulink url="http://www.tei-c.org/Software/passivetex/">PassiveTeX</ulink>
    (to build the PDF documentation)</para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libvorbis</title>

    <para>Install <application>libvorbis</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para><application>libvorbis</application> is known to cause compiler errors
    on certain machines. If you get errors, insert this command after running
    the <command>configure</command> script:</para>

<screen><userinput>sed -i.bak -e 's/-mno-ieee-fp//' lib/Makefile</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
install -v -m644 doc/Vorbis* /usr/share/doc/libvorbis-&libvorbis-version;</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><option>--enable-docs</option>: This switch enables building the
    documentation.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>libvorbis.[so,a], libvorbisenc.[so,a], and
        libvorbisfile.[so,a]</seg>
        <seg>/usr/include/vorbis and /usr/share/doc/libvorbis-&libvorbis-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libvorbis-lib">
        <term><filename class='libraryfile'>libvorbis*.[so,a]</filename></term>
        <listitem>
          <para>libraries provide the functions to read and write sound
          files.</para>
          <indexterm zone="libvorbis libvorbis-lib">
            <primary sortas="c-libvorbis">libvorbis*.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>