glfs/multimedia/libdriv/libtheora.xml
Ken Moffat bf1b5bf9b7 Add libtheora.
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@7662 af4574ff-66df-0310-9fd7-8a98e5e911e0
2008-12-24 19:20:07 +00:00

149 lines
4.9 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 libtheora-download-http "http://downloads.xiph.org/releases/theora/libtheora-&libtheora-version;.tar.bz2">
<!ENTITY libtheora-download-ftp " ">
<!ENTITY libtheora-md5sum "c963937053f45a7878954bed37ceb182">
<!ENTITY libtheora-size "1.6 MB">
<!ENTITY libtheora-buildsize "9.4 MB (without static libs or API docs and without installing the examples)">
<!ENTITY libtheora-time "0.2 SBU">
]>
<sect1 id="libtheora" xreflabel="libtheora-&libtheora-version;">
<?dbhtml filename="libtheora.html"?>
<sect1info>
<othername>$LastChangedBy: ken $</othername>
<date>$Date: 2008-07-09 20:01:09 +0100 (Wed, 09 Jul 2008) $</date>
</sect1info>
<title>libtheora-&libtheora-version;</title>
<indexterm zone="libtheora">
<primary sortas="a-Libtheora">Libtheora</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to libtheora</title>
<para>Theora is a free and open video compression format.</para>
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&libtheora-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&libtheora-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &libtheora-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &libtheora-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &libtheora-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &libtheora-time;</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">libtheora Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required"><xref linkend="libogg"/></para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="optional"><xref linkend="pkgconfig"/>, and
<xref linkend="libvorbis"/></para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="sdl"/> and
<xref linkend="libpng"/> (both to build the example players),
<xref linkend="doxygen"/>, <xref linkend="tetex"/>,
<ulink url="http://bibtexml.sourceforge.net">BibTex</ulink>, and
<ulink url="http://www.xfig.org/">Transfig</ulink>
(all four to build the API documentation),
<ulink url="http://www.valgrind.org">Valgrind</ulink></para>
<para condition="html" role="usernotes">User Notes:
<ulink url='&blfs-wiki;/Libtheora'/></para>
</sect2>
<sect2 role="installation">
<title>Installation of libtheora</title>
<para>Install <application>libtheora</application> by running the following
commands:</para>
<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>
<para>If you wish to run the tests, issue: <command>make check</command>.</para>
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
<screen role="root"><userinput>make install &amp;&amp;
</userinput></screen>
<para>If you built the examples and wish to install them (so that you can hack on
<literal>theora</literal>):</para>
<screen role="root"><userinput>cd examples/.libs &amp;&amp;
for E in *; do
install -v -m755 $E /usr/bin/theora_${E}; done</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para><option>--disable-static</option>: This switch prevents building static
libraries.</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>None, unless you installed the examples</seg>
<seg>libtheora.{so,a}, libtheoraenc.{so,a}, and
libtheoradec.{so,a}</seg>
<seg>/usr/include/theora and /usr/share/doc/libtheora-&libtheora-version;</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="libtheora-lib">
<term><filename class='libraryfile'>libtheora*.{so,a}</filename></term>
<listitem>
<para>libraries provide the functions to read and write video
files.</para>
<indexterm zone="libtheora libtheora-lib">
<primary sortas="c-libtheora">libtheora*.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>