source: multimedia/libdriv/libvorbis.xml@ c330c4c

<!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        "bb764aeabde613d1a424a29b1f15e7e6">
  <!ENTITY libvorbis-size          "1.3 MB">
  <!ENTITY libvorbis-buildsize     "17.1 MB">
  <!ENTITY libvorbis-time          "0.2 SBU">
]>

<sect1 id="libvorbis" xreflabel="libvorbis-&libvorbis-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="libvorbis.html"?>
<title>libvorbis-&libvorbis-version;</title>
<indexterm zone="libvorbis">
<primary sortas="a-Libvorbis">Libvorbis</primary></indexterm>

<sect2>
<title>Introduction to <application>libvorbis</application></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>

<sect3><title>Package information</title>
<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>
</sect3>

<sect3><title><application>libvorbis</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="libogg"/></para>
</sect4>

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

</sect2>

<sect2>
<title>Installation of <application>libvorbis</application></title>

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

<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make</command></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 configure script:</para>

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

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

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

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

</sect2>

<sect2>
<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"?>

<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>