glfs/multimedia/audioutils/lame.xml
Randy McMurchy 0598344244 Added indexing tags to LAME
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3306 af4574ff-66df-0310-9fd7-8a98e5e911e0
2005-01-19 02:54:11 +00:00

146 lines
4.5 KiB
XML

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY lame-download-http "http://prdownloads.sourceforge.net/lame/lame-&lame-version;.tar.gz">
<!ENTITY lame-download-ftp " ">
<!ENTITY lame-size "1.3 MB">
<!ENTITY lame-buildsize "15 MB">
<!ENTITY lame-time "0.39 SBU">
]>
<sect1 id="lame-package" xreflabel="LAME-&lame-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="lame.html"?>
<title>LAME-&lame-version;</title>
<indexterm zone="lame-package">
<primary sortas="a-LAME">LAME</primary></indexterm>
<sect2>
<title>Introduction to <application><acronym>LAME</acronym></application>
</title>
<para>The <application><acronym>LAME</acronym></application> package contains
an <acronym>MP3</acronym> encoder and optionally, an <acronym>MP3</acronym>
frame analyzer. This is useful for creating and analyzing compressed
audio files.</para>
<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink
url="&lame-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink
url="&lame-download-ftp;"/></para></listitem>
<listitem><para>Download size: &lame-size;</para></listitem>
<listitem><para>Estimated disk space required:
&lame-buildsize;</para></listitem>
<listitem><para>Estimated build time:
&lame-time;</para></listitem></itemizedlist>
</sect3>
<sect3><title><application>LAME</application> dependencies</title>
<sect4><title>Optional</title>
<para><xref linkend="GTK"/>,
<xref linkend="NASM"/>,
<ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink>,
<ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink> and
<ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
</sect4>
</sect3>
</sect2>
<sect2>
<title>Installation of
<application><acronym>LAME</acronym></application></title>
<para>Install <application><acronym>LAME</acronym></application> by running
the following commands:</para>
<screen><userinput><command>./configure --prefix=/usr --enable-mp3rtp &amp;&amp;
make</command></userinput></screen>
<para>Now, as the root user:</para>
<screen><userinput role='root'><command>make install</command></userinput></screen>
</sect2>
<sect2>
<title>Command explanations</title>
<para><parameter>--enable-mp3rtp</parameter>: Builds the encode-to-RTP program.</para>
<!-- <para><option>-enable-mptx</option>: Builds the mp3x program.</para>
<para><option>-enable-nasm</option>: Enables use of nasm.</para> -->
</sect2>
<sect2>
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>lame, mp3rtp and optionally, mp3x</seg>
<seg>libmp3lame.[so,a]</seg>
<seg>/usr/include/lame and /usr/share/doc/lame</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<varlistentry id="lame">
<term><command>lame</command></term>
<listitem><para>creates <acronym>MP3</acronym> audio files from raw
<acronym>PCM</acronym> or <filename>.wav</filename> data.</para>
<indexterm zone="lame-package lame">
<primary sortas="b-lame">lame</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="mp3rtp">
<term><command>mp3rtp</command></term>
<listitem><para>is used to encode <acronym>MP3</acronym> with
<acronym>RTP</acronym> streaming of the output.</para>
<indexterm zone="lame-package mp3rtp">
<primary sortas="b-mp3rtp">mp3rtp</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="mp3x">
<term><command>mp3x</command></term>
<listitem><para>is a <application><acronym>GTK</acronym></application> based
graphical <acronym>MP3</acronym> frame analyzer used for debugging,
development and studying <acronym>MP3</acronym> frames produced by any
encoder.</para>
<indexterm zone="lame-package mp3x">
<primary sortas="b-mp3x">mp3x</primary></indexterm>
</listitem>
</varlistentry>
<varlistentry id="libmp3lame">
<term><filename class='libraryfile'>libmp3lame.[so,a]</filename></term>
<listitem><para>libraries provide the functions necessary to convert
raw <acronym>PCM</acronym> and <acronym>WAV</acronym> files to
<acronym>MP3</acronym> files.</para>
<indexterm zone="lame-package libmp3lame">
<primary sortas="c-libmp3lame">libmp3lame.[so,a]</primary></indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>